Class TransactionFactory

Index

Constructors

Methods

createBTCTransfer createCustomScriptTransaction getAllNewUTXOs signDeployment signInteraction unwrap unwrapSegwit wrap

Constructors

constructor

new TransactionFactory(): TransactionFactory
Returns TransactionFactory

Methods

createBTCTransfer

createBTCTransfer(parameters): Promise<BitcoinTransferResponse>
Parameters
- parameters: IFundingTransactionParameters
  The funding transaction parameters
Returns Promise<BitcoinTransferResponse>
- The signed transaction
Description
Creates a funding transaction.
- Defined in src/transaction/TransactionFactory.ts:505

createCustomScriptTransaction

createCustomScriptTransaction(interactionParameters): Promise<[string, string, UTXO[]]>
Parameters
- interactionParameters: ICustomTransactionParameters
Returns Promise<[string, string, UTXO[]]>
- The signed transaction
Description
Generate a transaction with a custom script.
- Defined in src/transaction/TransactionFactory.ts:81

getAllNewUTXOs

getAllNewUTXOs(original, tx, to): UTXO[]
Get all new UTXOs of a generated transaction.
Parameters
- original: TransactionBuilder<TransactionType>
  The original transaction
- tx: Transaction
  The transaction
- to: string
  The address to filter
Returns UTXO[]
- Defined in src/transaction/TransactionFactory.ts:528

signDeployment

signDeployment(deploymentParameters): Promise<DeploymentResult>
Parameters
- deploymentParameters: IDeploymentParameters
  The deployment parameters
Returns Promise<DeploymentResult>
- The signed transaction
Description
Generates the required transactions.
- Defined in src/transaction/TransactionFactory.ts:220

signInteraction

signInteraction(interactionParameters): Promise<[string, string, UTXO[]]>
Parameters
- interactionParameters: IInteractionParameters
Returns Promise<[string, string, UTXO[]]>
- The signed transaction
Description
Generates the required transactions.
- Defined in src/transaction/TransactionFactory.ts:150

unwrap

unwrap(unwrapParameters): Promise<UnwrapResult>
Unwrap bitcoin via taproot.
Parameters
- unwrapParameters: IUnwrapParameters
  The unwrap parameters
Returns Promise<UnwrapResult>
- The signed transaction
Throws
- If the transaction could not be signed
- Defined in src/transaction/TransactionFactory.ts:435

unwrapSegwit

unwrapSegwit(unwrapParameters): Promise<UnwrapResult>
Unwrap bitcoin.
Parameters
- unwrapParameters: IUnwrapParameters
  The unwrap parameters
Returns Promise<UnwrapResult>
- The signed transaction
Throws
- If the transaction could not be signed
Deprecated
- Defined in src/transaction/TransactionFactory.ts:360

wrap

wrap(wrapParameters): Promise<WrapResult>
Basically it's fun to manage UTXOs.
Parameters
- wrapParameters: Omit<IWrapParameters, "calldata">
  The wrap parameters
Returns Promise<WrapResult>
- The signed transaction
Throws
- If the transaction could not be signed
- Defined in src/transaction/TransactionFactory.ts:293