Class UnwrapTransaction

Unwrap transaction UnwrapTransaction

Hierarchy (view full)

SharedInteractionTransaction<WBTC_UNWRAP>
- UnwrapTransaction

Index

Constructors

Methods

addInput addInputsFromUTXO addOptionalOutputsAndGetAmount addOutput addRefundOutput address addValueToToOutput buildTransaction calculateNumEmptyWitnesses calculateNumInputs calculateNumSignatures calculateTotalUTXOAmount calculateTotalVOutAmount customFinalizer debug debugBright disable disableRBF enable error estimateTransactionFees fail fancyLog generateKeyPairFromSeed generatePsbtInputExtended generateScriptAddress generateSecret generateTapData generateTapDataForInput generateTransactionMinimalSignatures getContractSecret getFeeLossOrRefund getFundingTransactionParameters getInputs getOutputs getRefund getRndBytes getScriptAddress getScriptSolution getSignerKey getStartPrefix getTapAddress getTapOutput getTransaction getTransactionOPNetFee getWitness ignoreSignatureError important info internalBuildTransaction internalInit internalPubKeyToXOnly lightOrangeLog log mergeVaults panic preEstimateTransactionFees rebuildFromBase64 scriptSignerXOnlyPubKey securityNotice setDestinationAddress setFeeOutput setLogPrefix setMaximumFeeRate setPSBT signInput signInputs signPSBT signTransaction splitArray success toAddress traceLog tweakSigner updateInput verifyUTXOValidity warn calculateSignHash getFrom preEstimateTaprootTransactionFees readScriptWitnessToWitnessStack signInput witnessStackToScriptWitness

Constructors

constructor

new UnwrapTransaction(parameters): UnwrapTransaction
Parameters
- parameters: IUnwrapParameters
Returns UnwrapTransaction
Overrides SharedInteractionTransaction.constructor
- Defined in src/transaction/builders/UnwrapTransaction.ts:87

Properties

`Protected`_maximumFeeRate

_maximumFeeRate: number = 100000000

Description

The maximum fee rate of the transaction

`Protected` `Readonly`calldata

calldata: Buffer

Calldata for the interaction

`Protected`calldataGenerator

calldataGenerator: CalldataGenerator

`Protected` `Readonly`chalk

chalk: ChalkInstance

`Protected` `Readonly`compiledTargetScript

compiledTargetScript: Buffer

The compiled target script

`Protected` `Readonly`contractSecret

contractSecret: Buffer

Contract secret for the interaction

`Protected` `Readonly`disableAutoRefund

disableAutoRefund: boolean

Disable auto refund

`Protected`enableLogs

enableLogs: boolean

`Protected` `Readonly`estimatedFeeLoss

estimatedFeeLoss: bigint = 0n

Estimated unwrap loss due to bitcoin fees in satoshis.

estimatedFees

estimatedFees: bigint = 0n

Description

The estimated fees of the transaction

`Protected`feeOutput

feeOutput: null | PsbtOutputExtended = null

Description

Output that will be used to pay the fees

`Protected` `Readonly`feeRate

feeRate: number

Description

The fee rate of the transaction

finalized

finalized: boolean = false

`Protected`from

from: string

Description

The address where the transaction is sent from

`Protected`hideLogs

hideLogs: boolean

`Protected`ignoreSignatureErrors

ignoreSignatureErrors: boolean = false

`Protected` `Readonly`inputs

inputs: PsbtInputExtended[] = []

Description

The inputs of the transaction

`Protected` `Readonly`isBrowser

isBrowser: boolean = false

Is the transaction being generated inside a browser?

`Protected`isPubKeyDestination

isPubKeyDestination: boolean

Description

Is the destionation P2PK

`Protected`leftOverFundsScriptRedeem

leftOverFundsScriptRedeem: null | Payment = null

`Readonly`logColor

logColor: string = '#785def'

`Readonly`moduleName

moduleName: string

`Protected` `Readonly`network

network: Network

Description

The network where the transaction will be broadcasted

`Protected` `Optional`nonWitnessUtxo

nonWitnessUtxo?: Buffer

Add a non-witness utxo to the transaction

optionalOutputs

optionalOutputs: undefined | PsbtOutputExtended[]

Param: parameters

The transaction parameters

`Protected` `Readonly`outputs

outputs: PsbtOutputExtended[] = []

Description

The outputs of the transaction

overflowFees

overflowFees: bigint = 0n

Description

The overflow fees of the transaction

`Protected`priorityFee

priorityFee: bigint

Description

The opnet priority fee of the transaction

`Readonly`randomBytes

randomBytes: Buffer

Random salt for the interaction

`Protected`regenerated

regenerated: boolean = false

`Protected`scriptData

scriptData: null | Payment = null

Description

The script data of the transaction

`Protected` `Readonly`scriptSigner

scriptSigner: ECPairInterface | Signer

Script signer for the interaction

`Protected` `Readonly`scriptTree

scriptTree: Taptree

The script tree

`Protected`sequence

sequence: number = TransactionSequence.REPLACE_BY_FEE

Description

The sequence of the transaction

`Protected`sighashTypes

sighashTypes: number[] = []

The sighash types for the transaction

`Protected`signed

signed: boolean = false

Description

Was the transaction signed?

`Protected` `Readonly`signer

signer: ECPairInterface | Signer

Description

The signer of the transaction

`Protected`tapData

tapData: null | Payment = null

Description

The tap data of the transaction

`Protected`tapLeafScript

tapLeafScript: null | TapLeafScript = null

The tap leaf script

`Protected`targetScriptRedeem

targetScriptRedeem: null | Payment = null

`Protected`to

to: undefined | string

Description

The address where the transaction is sent to

`Protected`totalInputAmount

totalInputAmount: bigint

Description

The total amount of satoshis in the inputs

`Protected`transaction

transaction: Psbt

Description

The transaction itself.

transactionFee

transactionFee: bigint = 0n

Description

Cost in satoshis of the transaction fee

`Protected` `Optional`tweakedSigner

tweakedSigner?: ECPairInterface

Description

Tweaked signer

type

type: WBTC_UNWRAP = TransactionType.WBTC_UNWRAP

`Protected` `Readonly`updateInputs

updateInputs: UpdateInput[] = []

Description

Inputs to update later on.

`Protected`utxos

utxos: UTXO[]

Description

The utxos used in the transaction

`Protected` `Readonly`vaultUTXOs

vaultUTXOs: VaultUTXOs[]

The vault UTXOs

`Static` `Readonly`LOCK_LEAF_SCRIPT

LOCK_LEAF_SCRIPT: Buffer = ...

`Static` `Readonly`MAXIMUM_CALLDATA_SIZE

MAXIMUM_CALLDATA_SIZE: number = ...

`Static` `Readonly`MINIMUM_DUST

MINIMUM_DUST: bigint = 330n

Methods

addInput

addInput(input): void
Add an input to the transaction.
Parameters
- input: PsbtInputExtended
  The input to add
Returns void
Inherited from SharedInteractionTransaction.addInput
- Defined in src/transaction/builders/TransactionBuilder.ts:332

`Protected`addInputsFromUTXO

addInputsFromUTXO(): void
Protected
Returns void
Description
Adds the inputs from the utxos
Inherited from SharedInteractionTransaction.addInputsFromUTXO
- Defined in src/transaction/builders/TransactionBuilder.ts:553

`Protected`addOptionalOutputsAndGetAmount

addOptionalOutputsAndGetAmount(): bigint
Protected
Returns bigint
Description
Adds optional outputs to transaction and returns their total value in satoshi to calculate refund transaction
Inherited from SharedInteractionTransaction.addOptionalOutputsAndGetAmount
- Defined in src/transaction/builders/TransactionBuilder.ts:536

addOutput

addOutput(output): void
Add an output to the transaction.
Parameters
- output: PsbtOutputExtended
  The output to add
Returns void
Inherited from SharedInteractionTransaction.addOutput
- Defined in src/transaction/builders/TransactionBuilder.ts:342

`Protected`addRefundOutput

addRefundOutput(amountSpent): Promise<void>
Protected
Parameters
- amountSpent: bigint
  The amount spent
Returns Promise<void>
Description
Adds the refund output to the transaction
Inherited from SharedInteractionTransaction.addRefundOutput
- Defined in src/transaction/builders/TransactionBuilder.ts:442

address

address(): undefined | string
Returns undefined | string
- The script address
Description
Returns the script address
Inherited from SharedInteractionTransaction.address
- Defined in src/transaction/builders/TransactionBuilder.ts:366

`Protected`addValueToToOutput

addValueToToOutput(value): void
Protected
Parameters
- value: number | bigint
  The value to add
Returns void
Description
Adds the value to the output
Inherited from SharedInteractionTransaction.addValueToToOutput
- Defined in src/transaction/builders/TransactionBuilder.ts:474

`Protected`buildTransaction

buildTransaction(): Promise<void>
Protected
Build the transaction

Returns Promise<void>
Throws
If the left over funds script redeem is required

Throws
If the left over funds script redeem version is required

Throws
If the left over funds script redeem output is required

Throws
If the to address is required
Inherited from SharedInteractionTransaction.buildTransaction
- Defined in src/transaction/builders/SharedInteractionTransaction.ts:138

`Protected`calculateNumEmptyWitnesses

calculateNumEmptyWitnesses(vault): bigint
Parameters
- vault: VaultUTXOs[]
Returns bigint
- Defined in src/transaction/builders/UnwrapTransaction.ts:269

`Protected`calculateNumInputs

calculateNumInputs(vault): bigint
Parameters
- vault: VaultUTXOs[]
Returns bigint
- Defined in src/transaction/builders/UnwrapTransaction.ts:287

`Protected`calculateNumSignatures

calculateNumSignatures(vault): bigint
Parameters
- vault: VaultUTXOs[]
Returns bigint
- Defined in src/transaction/builders/UnwrapTransaction.ts:278

`Protected`calculateTotalUTXOAmount

calculateTotalUTXOAmount(): bigint
Protected
Returns bigint
Description
Returns the total amount of satoshis in the inputs
Inherited from SharedInteractionTransaction.calculateTotalUTXOAmount
- Defined in src/transaction/builders/TransactionBuilder.ts:509

`Protected`calculateTotalVOutAmount

calculateTotalVOutAmount(): bigint
Protected
Returns bigint
Description
Returns the total amount of satoshis in the outputs
Inherited from SharedInteractionTransaction.calculateTotalVOutAmount
- Defined in src/transaction/builders/TransactionBuilder.ts:522

`Protected`customFinalizer

customFinalizer(_inputIndex, input): {
finalScriptWitness: Buffer;
}
Transaction finalizer
Parameters
- _inputIndex: number
  The input index
- input: PsbtInput
  The input
Returns {
finalScriptWitness: Buffer;
}
- finalScriptWitness: Buffer
Inherited from SharedInteractionTransaction.customFinalizer
- Defined in src/transaction/builders/SharedInteractionTransaction.ts:301

debug

debug(...args): void
Parameters
- Rest...args: string[]
Returns void
Inherited from SharedInteractionTransaction.debug
- Defined in node_modules/@btc-vision/logger/build/logger/shared/SharedLogger.d.ts:21

debugBright

debugBright(...args): void
Parameters
- Rest...args: string[]
Returns void
Inherited from SharedInteractionTransaction.debugBright
- Defined in node_modules/@btc-vision/logger/build/logger/shared/SharedLogger.d.ts:24

disable

disable(): void
Returns void
Inherited from SharedInteractionTransaction.disable
- Defined in node_modules/@btc-vision/logger/build/logger/shared/SharedLogger.d.ts:14

disableRBF

disableRBF(): void
Returns void
Description
Disables replace by fee on the transaction
Inherited from SharedInteractionTransaction.disableRBF
- Defined in src/transaction/shared/TweakedTransaction.ts:260

enable

enable(): void
Returns void
Inherited from SharedInteractionTransaction.enable
- Defined in node_modules/@btc-vision/logger/build/logger/shared/SharedLogger.d.ts:15

error

error(...args): void
Parameters
- Rest...args: string[]
Returns void
Inherited from SharedInteractionTransaction.error
- Defined in node_modules/@btc-vision/logger/build/logger/shared/SharedLogger.d.ts:19

estimateTransactionFees

estimateTransactionFees(): Promise<bigint>
Estimates the transaction fees.

Returns Promise<bigint>
- The estimated transaction fees
Inherited from SharedInteractionTransaction.estimateTransactionFees
- Defined in src/transaction/builders/TransactionBuilder.ts:375

fail

fail(...args): void
Parameters
- Rest...args: string[]
Returns void
Inherited from SharedInteractionTransaction.fail
- Defined in node_modules/@btc-vision/logger/build/logger/shared/SharedLogger.d.ts:23

fancyLog

fancyLog(msg1, highlight1, msg2, highlight2, msg3): void
Parameters
- msg1: string
- highlight1: string
- msg2: string
- highlight2: string
- msg3: string
Returns void
Inherited from SharedInteractionTransaction.fancyLog
- Defined in node_modules/@btc-vision/logger/build/logger/shared/SharedLogger.d.ts:16

`Protected`generateKeyPairFromSeed

generateKeyPairFromSeed(): ECPairInterface
Protected
Generate a key pair from the seed

Returns ECPairInterface
The key pair
Inherited from SharedInteractionTransaction.generateKeyPairFromSeed
- Defined in src/transaction/builders/SharedInteractionTransaction.ts:125

`Protected`generatePsbtInputExtended

generatePsbtInputExtended(utxo, i): PsbtInputExtended
Protected
Generate the PSBT input extended
Parameters
- utxo: UTXO
  The UTXO
- i: number
  The index of the input
Returns PsbtInputExtended
The PSBT input extended
Inherited from SharedInteractionTransaction.generatePsbtInputExtended
- Defined in src/transaction/shared/TweakedTransaction.ts:538

`Protected`generateScriptAddress

generateScriptAddress(): Payment
Protected
Generates the script address.

Returns Payment
Inherited from SharedInteractionTransaction.generateScriptAddress
- Defined in src/transaction/builders/SharedInteractionTransaction.ts:222

`Protected`generateSecret

generateSecret(): Buffer
Protected
Generate the secret for the interaction

Returns Buffer
The secret

Throws
If the to address is invalid
Inherited from SharedInteractionTransaction.generateSecret
- Defined in src/transaction/builders/SharedInteractionTransaction.ts:104

`Protected`generateTapData

generateTapData(): Payment
Returns Payment
Inherited from SharedInteractionTransaction.generateTapData
- Defined in src/transaction/builders/SharedInteractionTransaction.ts:230

`Protected`generateTapDataForInput

generateTapDataForInput(pubkeys, minimumSignatures): {
    internalPubkey: Buffer;
    network: Network;
    redeem: Payment;
    scriptTree: Taptree;
}
Protected
Generate an input for a vault UTXO
Parameters
- pubkeys: Buffer[]
  The public keys
- minimumSignatures: number
  The minimum number of signatures
Returns {
    internalPubkey: Buffer;
    network: Network;
    redeem: Payment;
    scriptTree: Taptree;
}
The tap tree
- internalPubkey: Buffer
- network: Network
- redeem: Payment
- scriptTree: Taptree
Throws
If something went wrong
- Defined in src/transaction/builders/UnwrapTransaction.ts:313

generateTransactionMinimalSignatures

generateTransactionMinimalSignatures(checkPartialSigs?): Promise<void>
Parameters
- checkPartialSigs: boolean = false
Returns Promise<void>
Description
Generates the transaction minimal signatures
Inherited from SharedInteractionTransaction.generateTransactionMinimalSignatures
- Defined in src/transaction/builders/TransactionBuilder.ts:282

getContractSecret

getContractSecret(): Buffer
Get the contract secret

Returns Buffer
The contract secret
Inherited from SharedInteractionTransaction.getContractSecret
- Defined in src/transaction/builders/SharedInteractionTransaction.ts:86

getFeeLossOrRefund

getFeeLossOrRefund(): bigint
Returns bigint
- The estimated fee loss or refund
Description
Get the estimated unwrap loss due to bitcoin fees in satoshis.

Description
If the number is negative, it means the user will get a refund.

Description
If the number is positive, it means the user will lose that amount.
- Defined in src/transaction/builders/UnwrapTransaction.ts:194

getRndBytes

getRndBytes(): Buffer
Get the random bytes used for the interaction

Returns Buffer
The random bytes
Inherited from SharedInteractionTransaction.getRndBytes
- Defined in src/transaction/builders/SharedInteractionTransaction.ts:94

getScriptAddress

getScriptAddress(): string
Returns string
Description
Returns the script address
Inherited from SharedInteractionTransaction.getScriptAddress
- Defined in src/transaction/shared/TweakedTransaction.ts:228

`Protected`getScriptSolution

getScriptSolution(input): Buffer[]
Protected
Generate the script solution
Parameters
- input: PsbtInput
  The input
Returns Buffer[]
The script solution
Overrides SharedInteractionTransaction.getScriptSolution
- Defined in src/transaction/builders/UnwrapTransaction.ts:354

`Protected`getSignerKey

getSignerKey(): ECPairInterface | Signer
Protected
Returns the signer key.

Returns ECPairInterface | Signer
Inherited from SharedInteractionTransaction.getSignerKey
- Defined in src/transaction/shared/TweakedTransaction.ts:341

getStartPrefix

getStartPrefix(): string
Returns string
Inherited from SharedInteractionTransaction.getStartPrefix
- Defined in node_modules/@btc-vision/logger/build/logger/shared/SharedLogger.d.ts:13

getTapAddress

getTapAddress(): string
Returns string
Description
Returns the tap address
Throws
- If tap data is not set
Inherited from SharedInteractionTransaction.getTapAddress
- Defined in src/transaction/shared/TweakedTransaction.ts:249

`Protected`getTapOutput

getTapOutput(): Buffer
Protected
Returns the tap output.

Returns Buffer
Inherited from SharedInteractionTransaction.getTapOutput
- Defined in src/transaction/builders/TransactionBuilder.ts:621

getTransaction

getTransaction(): Transaction
Returns Transaction
Description
Returns the transaction
Inherited from SharedInteractionTransaction.getTransaction
- Defined in src/transaction/shared/TweakedTransaction.ts:240

`Protected`getTransactionOPNetFee

getTransactionOPNetFee(): bigint
Protected
Returns bigint
Description
Returns the transaction opnet fee
Inherited from SharedInteractionTransaction.getTransactionOPNetFee
- Defined in src/transaction/builders/TransactionBuilder.ts:496

`Protected`getWitness

getWitness(): Buffer
Protected
Returns the witness of the tap transaction.

Returns Buffer
Inherited from SharedInteractionTransaction.getWitness
- Defined in src/transaction/builders/TransactionBuilder.ts:604

ignoreSignatureError

ignoreSignatureError(): void
Returns void
Inherited from SharedInteractionTransaction.ignoreSignatureError
- Defined in src/transaction/shared/TweakedTransaction.ts:220

important

important(...args): void
Parameters
- Rest...args: string[]
Returns void
Inherited from SharedInteractionTransaction.important
- Defined in node_modules/@btc-vision/logger/build/logger/shared/SharedLogger.d.ts:25

info

info(...args): void
Parameters
- Rest...args: string[]
Returns void
Inherited from SharedInteractionTransaction.info
- Defined in node_modules/@btc-vision/logger/build/logger/shared/SharedLogger.d.ts:27

`Protected`internalBuildTransaction

internalBuildTransaction(transaction, checkPartialSigs?): Promise<boolean>
Protected
Builds the transaction.
Parameters
- transaction: Psbt
  The transaction to build
- checkPartialSigs: boolean = false
Returns Promise<boolean>
Throws
- If something went wrong while building the transaction
Overrides SharedInteractionTransaction.internalBuildTransaction
- Defined in src/transaction/builders/UnwrapTransaction.ts:375

`Protected`internalInit

internalInit(): void
Protected
Internal init.

Returns void
Inherited from SharedInteractionTransaction.internalInit
- Defined in src/transaction/builders/TransactionBuilder.ts:576

`Protected`internalPubKeyToXOnly

internalPubKeyToXOnly(): Buffer
Protected
Converts the public key to x-only.

Returns Buffer
Overrides SharedInteractionTransaction.internalPubKeyToXOnly
- Defined in src/transaction/builders/UnwrapTransaction.ts:301

lightOrangeLog

lightOrangeLog(...args): void
Parameters
- Rest...args: string[]
Returns void
Inherited from SharedInteractionTransaction.lightOrangeLog
- Defined in node_modules/@btc-vision/logger/build/logger/shared/SharedLogger.d.ts:18

log

log(...args): void
Parameters
- Rest...args: string[]
Returns void
Inherited from SharedInteractionTransaction.log
- Defined in node_modules/@btc-vision/logger/build/logger/shared/SharedLogger.d.ts:17

`Protected`mergeVaults

mergeVaults(): void
Protected
Returns void
Description
Merge vault UTXOs into the transaction
- Defined in src/transaction/builders/UnwrapTransaction.ts:204

panic

panic(...args): void
Parameters
- Rest...args: string[]
Returns void
Inherited from SharedInteractionTransaction.panic
- Defined in node_modules/@btc-vision/logger/build/logger/shared/SharedLogger.d.ts:26

preEstimateTransactionFees

preEstimateTransactionFees(feeRate, numInputs, numOutputs, numSignatures, numPubkeys): bigint
Pre-estimate the transaction fees
Parameters
- feeRate: bigint
  The fee rate
- numInputs: bigint
  The number of inputs
- numOutputs: bigint
  The number of outputs
- numSignatures: bigint
  The number of signatures
- numPubkeys: bigint
  The number of public keys
Returns bigint
- The estimated transaction fees
Inherited from SharedInteractionTransaction.preEstimateTransactionFees
- Defined in src/transaction/shared/TweakedTransaction.ts:289

rebuildFromBase64

rebuildFromBase64(base64): Promise<Psbt>
Parameters
- base64: string
Returns Promise<Psbt>
Inherited from SharedInteractionTransaction.rebuildFromBase64
- Defined in src/transaction/builders/TransactionBuilder.ts:402

`Protected`scriptSignerXOnlyPubKey

scriptSignerXOnlyPubKey(): Buffer
Protected
Get the internal pubkey as an x-only key

Returns Buffer
The internal pubkey as an x-only key
Inherited from SharedInteractionTransaction.scriptSignerXOnlyPubKey
- Defined in src/transaction/builders/SharedInteractionTransaction.ts:115

securityNotice

securityNotice(...args): void
Parameters
- Rest...args: string[]
Returns void
Inherited from SharedInteractionTransaction.securityNotice
- Defined in node_modules/@btc-vision/logger/build/logger/shared/SharedLogger.d.ts:28

setDestinationAddress

setDestinationAddress(address): void
Set the destination address of the transaction
Parameters
- address: string
  The address to set
Returns void
Inherited from SharedInteractionTransaction.setDestinationAddress
- Defined in src/transaction/builders/TransactionBuilder.ts:227

`Protected`setFeeOutput

setFeeOutput(output): Promise<void>
Protected
Set transaction fee output.
Parameters
- output: PsbtOutputExtended
  The output to set the fees
Returns Promise<void>
Inherited from SharedInteractionTransaction.setFeeOutput
- Defined in src/transaction/builders/TransactionBuilder.ts:647

setLogPrefix

setLogPrefix(prefix): void
Parameters
- prefix: string
Returns void
Inherited from SharedInteractionTransaction.setLogPrefix
- Defined in node_modules/@btc-vision/logger/build/logger/shared/SharedLogger.d.ts:12

setMaximumFeeRate

setMaximumFeeRate(feeRate): void
Set the maximum fee rate of the transaction in satoshis per byte
Parameters
- feeRate: number
  The fee rate to set
Returns void
Inherited from SharedInteractionTransaction.setMaximumFeeRate
- Defined in src/transaction/builders/TransactionBuilder.ts:236

setPSBT

setPSBT(psbt): void
Parameters
- psbt: Psbt
Returns void
Inherited from SharedInteractionTransaction.setPSBT
- Defined in src/transaction/builders/TransactionBuilder.ts:411

`Protected`signInput

signInput(transaction, input, i, signer?): Promise<void>
Protected
Signs an input of the transaction.
Parameters
- transaction: Psbt
  The transaction to sign
- input: PsbtInput
  The input to sign
- i: number
  The index of the input
- Optionalsigner: ECPairInterface | Signer
  The signer to use
Returns Promise<void>
Inherited from SharedInteractionTransaction.signInput
- Defined in src/transaction/shared/TweakedTransaction.ts:353

`Protected`signInputs

signInputs(transaction): Promise<void>
Protected
Sign the inputs
Parameters
- transaction: Psbt
  The transaction to sign
Returns Promise<void>
Inherited from SharedInteractionTransaction.signInputs
- Defined in src/transaction/builders/SharedInteractionTransaction.ts:183

signPSBT

signPSBT(): Promise<Psbt>
Returns Promise<Psbt>
- The signed transaction in hex format
Description
Signs the transaction
Throws
- If something went wrong
Overrides SharedInteractionTransaction.signPSBT
- Defined in src/transaction/builders/UnwrapTransaction.ts:151

signTransaction

signTransaction(): Promise<Transaction>
Returns Promise<Transaction>
- The signed transaction in hex format
Description
Signs the transaction
Throws
- If something went wrong
Inherited from SharedInteractionTransaction.signTransaction
- Defined in src/transaction/builders/TransactionBuilder.ts:246

`Protected`splitArray

splitArray<T>(arr, chunkSize): T[][]
Type Parameters
- T
Parameters
- arr: T[]
- chunkSize: number
Returns T[][]
Inherited from SharedInteractionTransaction.splitArray
- Defined in src/transaction/shared/TweakedTransaction.ts:424

success

success(...args): void
Parameters
- Rest...args: string[]
Returns void
Inherited from SharedInteractionTransaction.success
- Defined in node_modules/@btc-vision/logger/build/logger/shared/SharedLogger.d.ts:22

toAddress

toAddress(): undefined | string
Receiver address.

Returns undefined | string
- The receiver address
Inherited from SharedInteractionTransaction.toAddress
- Defined in src/transaction/builders/TransactionBuilder.ts:358

traceLog

traceLog(...args): void
Parameters
- Rest...args: string[]
Returns void
Inherited from SharedInteractionTransaction.traceLog
- Defined in node_modules/@btc-vision/logger/build/logger/shared/SharedLogger.d.ts:29

`Protected`tweakSigner

tweakSigner(): void
Protected
Tweak the signer for the interaction

Returns void
Inherited from SharedInteractionTransaction.tweakSigner
- Defined in src/transaction/shared/TweakedTransaction.ts:500

`Protected`updateInput

updateInput(input): void
Protected
Add an input update
Parameters
- input: UpdateInput
  The input to update
Returns void
Inherited from SharedInteractionTransaction.updateInput
- Defined in src/transaction/builders/TransactionBuilder.ts:595

`Protected`verifyUTXOValidity

verifyUTXOValidity(): void
Protected
Verifies that the utxos are valid.

Returns void
Inherited from SharedInteractionTransaction.verifyUTXOValidity
- Defined in src/transaction/builders/TransactionBuilder.ts:633

warn

warn(...args): void
Parameters
- Rest...args: string[]
Returns void
Inherited from SharedInteractionTransaction.warn
- Defined in node_modules/@btc-vision/logger/build/logger/shared/SharedLogger.d.ts:20

`Protected` `Static`calculateSignHash

calculateSignHash(sighashTypes): number
Protected
Calculate the sign hash number
Parameters
- sighashTypes: number[]
Returns number
Description
Calculates the sign hash
Inherited from SharedInteractionTransaction.calculateSignHash
- Defined in src/transaction/shared/TweakedTransaction.ts:207

`Static`getFrom

getFrom(from, keypair, network): string
Parameters
- from: undefined | string
- keypair: ECPairInterface | Signer
- network: Network
Returns string
Inherited from SharedInteractionTransaction.getFrom
- Defined in src/transaction/builders/TransactionBuilder.ts:161

`Static`preEstimateTaprootTransactionFees

preEstimateTaprootTransactionFees(feeRate, numInputs, numOutputs, numWitnessElements, witnessElementSize, emptyWitness, taprootControlWitnessSize?, taprootScriptSize?): bigint
Pre-estimate the transaction fees for a Taproot transaction
Parameters
- feeRate: bigint
  The fee rate in satoshis per virtual byte
- numInputs: bigint
  The number of inputs
- numOutputs: bigint
  The number of outputs
- numWitnessElements: bigint
  The number of witness elements (e.g., number of control blocks and witnesses)
- witnessElementSize: bigint
  The average size of each witness element in bytes
- emptyWitness: bigint
  The amount of empty witnesses
- OptionaltaprootControlWitnessSize: bigint = 32n
  The size of the control block witness in bytes
- OptionaltaprootScriptSize: bigint = 139n
  The size of the taproot script in bytes
Returns bigint
- The estimated transaction fees
Inherited from SharedInteractionTransaction.preEstimateTaprootTransactionFees
- Defined in src/transaction/shared/TweakedTransaction.ts:156

`Protected` `Static`readScriptWitnessToWitnessStack

readScriptWitnessToWitnessStack(Buffer): Buffer[]
Protected
Read witnesses
Parameters
- Buffer: Buffer
Returns Buffer[]
Inherited from SharedInteractionTransaction.readScriptWitnessToWitnessStack
- Defined in src/transaction/shared/TweakedTransaction.ts:112

`Protected` `Static`signInput

signInput(transaction, input, i, signer, sighashTypes): void
Parameters
- transaction: Psbt
- input: PsbtInput
- i: number
- signer: ECPairInterface | Signer
- sighashTypes: number[]
Returns void
Inherited from SharedInteractionTransaction.signInput
- Defined in src/transaction/shared/TweakedTransaction.ts:189

`Protected` `Static`witnessStackToScriptWitness

witnessStackToScriptWitness(witness): Buffer
Protected
Parameters
- witness: Buffer[]
  The witness stack
Returns Buffer
Description
Converts the witness stack to a script witness
Inherited from SharedInteractionTransaction.witnessStackToScriptWitness
- Defined in src/transaction/builders/TransactionBuilder.ts:175

Class UnwrapTransaction

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns UnwrapTransaction

Properties

Protected_maximumFeeRate

Description

Protected Readonlycalldata

ProtectedcalldataGenerator

Protected Readonlychalk

Protected ReadonlycompiledTargetScript

Protected ReadonlycontractSecret

Protected ReadonlydisableAutoRefund

ProtectedenableLogs

Protected ReadonlyestimatedFeeLoss

estimatedFees

Description

ProtectedfeeOutput

Description

Protected ReadonlyfeeRate

Description

finalized

Protectedfrom

Description

ProtectedhideLogs

ProtectedignoreSignatureErrors

Protected Readonlyinputs

Description

Protected ReadonlyisBrowser

ProtectedisPubKeyDestination

Description

ProtectedleftOverFundsScriptRedeem

ReadonlylogColor

ReadonlymoduleName

Protected Readonlynetwork

Description

Protected OptionalnonWitnessUtxo

optionalOutputs

Param: parameters

Protected Readonlyoutputs

Description

overflowFees

Description

ProtectedpriorityFee

Description

ReadonlyrandomBytes

Protectedregenerated

ProtectedscriptData

Description

Protected ReadonlyscriptSigner

Protected ReadonlyscriptTree

Protectedsequence

Description

ProtectedsighashTypes

Protectedsigned

Description

Protected Readonlysigner

Description

ProtectedtapData

Description

ProtectedtapLeafScript

ProtectedtargetScriptRedeem

Protectedto

Description

ProtectedtotalInputAmount

Description

Protectedtransaction

Description

transactionFee

Description

Protected OptionaltweakedSigner

Description

type

Protected ReadonlyupdateInputs

`Protected`_maximumFeeRate

`Protected` `Readonly`calldata

`Protected`calldataGenerator

`Protected` `Readonly`chalk

`Protected` `Readonly`compiledTargetScript

`Protected` `Readonly`contractSecret

`Protected` `Readonly`disableAutoRefund

`Protected`enableLogs

`Protected` `Readonly`estimatedFeeLoss

`Protected`feeOutput

`Protected` `Readonly`feeRate

`Protected`from

`Protected`hideLogs

`Protected`ignoreSignatureErrors

`Protected` `Readonly`inputs

`Protected` `Readonly`isBrowser

`Protected`isPubKeyDestination

`Protected`leftOverFundsScriptRedeem

`Readonly`logColor

`Readonly`moduleName

`Protected` `Readonly`network

`Protected` `Optional`nonWitnessUtxo

`Protected` `Readonly`outputs

`Protected`priorityFee

`Readonly`randomBytes

`Protected`regenerated

`Protected`scriptData

`Protected` `Readonly`scriptSigner

`Protected` `Readonly`scriptTree

`Protected`sequence

`Protected`sighashTypes

`Protected`signed

`Protected` `Readonly`signer

`Protected`tapData

`Protected`tapLeafScript

`Protected`targetScriptRedeem

`Protected`to

`Protected`totalInputAmount

`Protected`transaction

`Protected` `Optional`tweakedSigner

`Protected` `Readonly`updateInputs

`Protected`utxos

`Protected` `Readonly`vaultUTXOs

`Static` `Readonly`LOCK_LEAF_SCRIPT

`Static` `Readonly`MAXIMUM_CALLDATA_SIZE

`Static` `Readonly`MINIMUM_DUST

`Protected`addInputsFromUTXO

`Protected`addOptionalOutputsAndGetAmount

`Protected`addRefundOutput

`Protected`addValueToToOutput

`Protected`buildTransaction

`Protected`calculateNumEmptyWitnesses

`Protected`calculateNumInputs

`Protected`calculateNumSignatures

`Protected`calculateTotalUTXOAmount

`Protected`calculateTotalVOutAmount

`Protected`customFinalizer

Returns {
finalScriptWitness: Buffer;
}