Class MultiSignTransaction

Create a multi sign p2tr transaction MultiSignTransaction

Hierarchy (view full)

TransactionBuilder<MULTI_SIG>
- MultiSignTransaction

Index

Constructors

Methods

addInput addInputsFromUTXO addOptionalOutputsAndGetAmount addOutput addRefundOutput address addValueToToOutput buildTransaction calculateTotalUTXOAmount calculateTotalVOutAmount debug debugBright disable disableRBF enable error estimateTransactionFees fail fancyLog finalizeTransactionInputs generatePsbtInputExtended generateScriptAddress generateTapData generateTransactionMinimalSignatures getFundingTransactionParameters getInputs getOutputs getScriptAddress getScriptSolution getSignerKey getStartPrefix getTapAddress getTapOutput getTransaction getTransactionOPNetFee getWitness ignoreSignatureError important info internalBuildTransaction internalInit internalPubKeyToXOnly lightOrangeLog log panic preEstimateTransactionFees rebuildFromBase64 securityNotice setDestinationAddress setFeeOutput setLogPrefix setMaximumFeeRate setPSBT signInput signInputs signPSBT signTransaction splitArray success toAddress traceLog tweakSigner updateInput verifyUTXOValidity warn attemptFinalizeInputs calculateSignHash dedupeSignatures fromBase64 getFrom partialFinalizer preEstimateTaprootTransactionFees readScriptWitnessToWitnessStack signInput signPartial verifyIfSigned witnessStackToScriptWitness

Constructors

constructor

new MultiSignTransaction(parameters): MultiSignTransaction
Parameters
- parameters: MultiSignParameters
Returns MultiSignTransaction
Overrides TransactionBuilder.constructor
- Defined in src/transaction/builders/MultiSignTransaction.ts:72

Properties

`Protected`_maximumFeeRate

_maximumFeeRate: number = 100000000

Description

The maximum fee rate of the transaction

`Protected` `Readonly`chalk

chalk: ChalkInstance

`Protected` `Readonly`compiledTargetScript

compiledTargetScript: Buffer

`Protected`enableLogs

enableLogs: boolean

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'

`Protected` `Readonly`minimumSignatures

minimumSignatures: number

`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`originalInputCount

originalInputCount: number = 0

`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

`Protected` `Readonly`publicKeys

publicKeys: Buffer[]

`Protected` `Readonly`receiver

receiver: string

`Protected` `Readonly`refundVault

refundVault: string

`Protected`regenerated

regenerated: boolean = false

`Protected` `Readonly`requestedAmount

requestedAmount: bigint

`Protected`scriptData

scriptData: null | Payment = null

Description

The script data of the transaction

`Protected` `Readonly`scriptTree

scriptTree: Taptree

`Protected`sequence

sequence: number = TransactionSequence.REPLACE_BY_FEE

Description

The sequence of the transaction

`Protected` `Readonly`sighashTypes

sighashTypes: number[] = MultiSignTransaction.signHashTypesArray

Description

Sign hash types

`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: MULTI_SIG = TransactionType.MULTI_SIG

`Protected` `Readonly`updateInputs

updateInputs: UpdateInput[] = []

Description

Inputs to update later on.

`Protected`utxos

utxos: UTXO[]

Description

The utxos used in the transaction

`Static` `Readonly`LOCK_LEAF_SCRIPT

LOCK_LEAF_SCRIPT: Buffer = ...

`Static` `Readonly`MINIMUM_DUST

MINIMUM_DUST: bigint = 330n

`Static` `Readonly`numsPoint

numsPoint: Buffer = ...

`Static` `Readonly`signHashTypesArray

signHashTypesArray: number[] = []

Methods

addInput

addInput(input): void
Add an input to the transaction.
Parameters
- input: PsbtInputExtended
  The input to add
Returns void
Inherited from TransactionBuilder.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 TransactionBuilder.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 TransactionBuilder.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 TransactionBuilder.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 TransactionBuilder.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 TransactionBuilder.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 TransactionBuilder.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
Overrides TransactionBuilder.buildTransaction
- Defined in src/transaction/builders/MultiSignTransaction.ts:455

`Protected`calculateTotalUTXOAmount

calculateTotalUTXOAmount(): bigint
Protected
Returns bigint
Description
Returns the total amount of satoshis in the inputs
Inherited from TransactionBuilder.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 TransactionBuilder.calculateTotalVOutAmount
- Defined in src/transaction/builders/TransactionBuilder.ts:522

debug

debug(...args): void
Parameters
- Rest...args: string[]
Returns void
Inherited from TransactionBuilder.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 TransactionBuilder.debugBright
- Defined in node_modules/@btc-vision/logger/build/logger/shared/SharedLogger.d.ts:24

disable

disable(): void
Returns void
Inherited from TransactionBuilder.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 TransactionBuilder.disableRBF
- Defined in src/transaction/shared/TweakedTransaction.ts:260

enable

enable(): void
Returns void
Inherited from TransactionBuilder.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 TransactionBuilder.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 TransactionBuilder.estimateTransactionFees
- Defined in src/transaction/builders/TransactionBuilder.ts:375

fail

fail(...args): void
Parameters
- Rest...args: string[]
Returns void
Inherited from TransactionBuilder.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 TransactionBuilder.fancyLog
- Defined in node_modules/@btc-vision/logger/build/logger/shared/SharedLogger.d.ts:16

finalizeTransactionInputs

finalizeTransactionInputs(): boolean
Finalize the psbt multisig transaction

Returns boolean
- Defined in src/transaction/builders/MultiSignTransaction.ts:417

`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 TransactionBuilder.generatePsbtInputExtended
- Defined in src/transaction/shared/TweakedTransaction.ts:538

`Protected`generateScriptAddress

generateScriptAddress(): Payment
Protected
Generates the script address.

Returns Payment
Overrides TransactionBuilder.generateScriptAddress
- Defined in src/transaction/builders/MultiSignTransaction.ts:538

`Protected`generateTapData

generateTapData(): Payment
Returns Payment
Overrides TransactionBuilder.generateTapData
- Defined in src/transaction/builders/MultiSignTransaction.ts:547

generateTransactionMinimalSignatures

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

getScriptAddress

getScriptAddress(): string
Returns string
Description
Returns the script address
Inherited from TransactionBuilder.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
- Defined in src/transaction/builders/MultiSignTransaction.ts:572

`Protected`getSignerKey

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

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

getStartPrefix

getStartPrefix(): string
Returns string
Inherited from TransactionBuilder.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 TransactionBuilder.getTapAddress
- Defined in src/transaction/shared/TweakedTransaction.ts:249

`Protected`getTapOutput

getTapOutput(): Buffer
Protected
Returns the tap output.

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

getTransaction

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

`Protected`getTransactionOPNetFee

getTransactionOPNetFee(): bigint
Protected
Returns bigint
Description
Returns the transaction opnet fee
Inherited from TransactionBuilder.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 TransactionBuilder.getWitness
- Defined in src/transaction/builders/TransactionBuilder.ts:604

ignoreSignatureError

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

important

important(...args): void
Parameters
- Rest...args: string[]
Returns void
Inherited from TransactionBuilder.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 TransactionBuilder.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 TransactionBuilder.internalBuildTransaction
- Defined in src/transaction/builders/MultiSignTransaction.ts:501

`Protected`internalInit

internalInit(): void
Protected
Internal init.

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

`Protected`internalPubKeyToXOnly

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

Returns Buffer
Inherited from TransactionBuilder.internalPubKeyToXOnly
- Defined in src/transaction/shared/TweakedTransaction.ts:483

lightOrangeLog

lightOrangeLog(...args): void
Parameters
- Rest...args: string[]
Returns void
Inherited from TransactionBuilder.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 TransactionBuilder.log
- Defined in node_modules/@btc-vision/logger/build/logger/shared/SharedLogger.d.ts:17

panic

panic(...args): void
Parameters
- Rest...args: string[]
Returns void
Inherited from TransactionBuilder.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 TransactionBuilder.preEstimateTransactionFees
- Defined in src/transaction/shared/TweakedTransaction.ts:289

rebuildFromBase64

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

securityNotice

securityNotice(...args): void
Parameters
- Rest...args: string[]
Returns void
Inherited from TransactionBuilder.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 TransactionBuilder.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 TransactionBuilder.setFeeOutput
- Defined in src/transaction/builders/TransactionBuilder.ts:647

setLogPrefix

setLogPrefix(prefix): void
Parameters
- prefix: string
Returns void
Inherited from TransactionBuilder.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 TransactionBuilder.setMaximumFeeRate
- Defined in src/transaction/builders/TransactionBuilder.ts:236

setPSBT

setPSBT(psbt): void
Parameters
- psbt: Psbt
Returns void
Inherited from TransactionBuilder.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 TransactionBuilder.signInput
- Defined in src/transaction/shared/TweakedTransaction.ts:353

`Protected`signInputs

signInputs(_transaction): Promise<void>
Protected
Sign the inputs
Parameters
- _transaction: Psbt
Returns Promise<void>
Overrides TransactionBuilder.signInputs
- Defined in src/transaction/builders/MultiSignTransaction.ts:536

signPSBT

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

signTransaction

signTransaction(): Promise<Transaction>
Returns Promise<Transaction>
- The signed transaction in hex format
Description
Signs the transaction
Throws
- If something went wrong
Inherited from TransactionBuilder.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 TransactionBuilder.splitArray
- Defined in src/transaction/shared/TweakedTransaction.ts:424

success

success(...args): void
Parameters
- Rest...args: string[]
Returns void
Inherited from TransactionBuilder.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 TransactionBuilder.toAddress
- Defined in src/transaction/builders/TransactionBuilder.ts:358

traceLog

traceLog(...args): void
Parameters
- Rest...args: string[]
Returns void
Inherited from TransactionBuilder.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 TransactionBuilder.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 TransactionBuilder.updateInput
- Defined in src/transaction/builders/TransactionBuilder.ts:595

`Protected`verifyUTXOValidity

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

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

warn

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

`Static`attemptFinalizeInputs

attemptFinalizeInputs(psbt, startIndex, orderedPubKeys, isFinal): boolean
Attempt to finalize the inputs
Parameters
- psbt: Psbt
  The psbt
- startIndex: number
  The start index
- orderedPubKeys: Buffer[][]
  The ordered public keys
- isFinal: boolean
  If the transaction is final
Returns boolean
True if the inputs were finalized
- Defined in src/transaction/builders/MultiSignTransaction.ts:343

`Protected` `Static`calculateSignHash

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

`Static`dedupeSignatures

dedupeSignatures(original, partial): TapScriptSig[]
Dedupe signatures
Parameters
- original: TapScriptSig[]
  The original signatures
- partial: TapScriptSig[]
  The partial signatures
Returns TapScriptSig[]
The deduped signatures
- Defined in src/transaction/builders/MultiSignTransaction.ts:317

`Static`fromBase64

fromBase64(params): MultiSignTransaction
Generate a multisig transaction from a base64 psbt.
Parameters
- params: MultiSignFromBase64Params
  The parameters
Returns MultiSignTransaction
The multisig transaction
- Defined in src/transaction/builders/MultiSignTransaction.ts:125

`Static`getFrom

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

`Static`partialFinalizer

partialFinalizer(inputIndex, input, partialSignatures, orderedPubKeys, isFinal): {
finalScriptWitness: Buffer;
}
Partially finalize a P2TR MS transaction
Parameters
- inputIndex: number
  The input index
- input: PsbtInput
  The input
- partialSignatures: Buffer[]
  The partial signatures
- orderedPubKeys: Buffer[]
  The ordered public keys
- isFinal: boolean
  If the transaction is final
Returns {
finalScriptWitness: Buffer;
}
- finalScriptWitness: Buffer
- Defined in src/transaction/builders/MultiSignTransaction.ts:253

`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 TransactionBuilder.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 TransactionBuilder.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 TransactionBuilder.signInput
- Defined in src/transaction/shared/TweakedTransaction.ts:189

`Static`signPartial

signPartial(psbt, signer, originalInputCount, minimums): {
final: boolean;
signed: boolean;
}
Partially sign the transaction
Parameters
- psbt: Psbt
- signer: ECPairInterface | Signer
- originalInputCount: number
- minimums: number[]
Returns {
final: boolean;
signed: boolean;
}
True if the transaction was signed
- final: boolean
- signed: boolean
- Defined in src/transaction/builders/MultiSignTransaction.ts:173

`Static`verifyIfSigned

verifyIfSigned(psbt, signerPubKey): boolean
Verify if that public key already signed the transaction
Parameters
- psbt: Psbt
  The psbt
- signerPubKey: Buffer
  The signer public key
Returns boolean
True if the public key signed the transaction
- Defined in src/transaction/builders/MultiSignTransaction.ts:139

`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 TransactionBuilder.witnessStackToScriptWitness
- Defined in src/transaction/builders/TransactionBuilder.ts:175

Class MultiSignTransaction

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MultiSignTransaction

Properties

Protected_maximumFeeRate

Description

Protected Readonlychalk

Protected ReadonlycompiledTargetScript

ProtectedenableLogs

estimatedFees

Description

ProtectedfeeOutput

Description

Protected ReadonlyfeeRate

Description

finalized

Protectedfrom

Description

ProtectedhideLogs

ProtectedignoreSignatureErrors

Protected Readonlyinputs

Description

Protected ReadonlyisBrowser

ProtectedisPubKeyDestination

Description

ProtectedleftOverFundsScriptRedeem

ReadonlylogColor

Protected ReadonlyminimumSignatures

ReadonlymoduleName

Protected Readonlynetwork

Description

Protected OptionalnonWitnessUtxo

optionalOutputs

Param: parameters

Protected ReadonlyoriginalInputCount

Protected Readonlyoutputs

Description

overflowFees

Description

ProtectedpriorityFee

Description

Protected ReadonlypublicKeys

Protected Readonlyreceiver

Protected ReadonlyrefundVault

Protectedregenerated

Protected ReadonlyrequestedAmount

ProtectedscriptData

Description

Protected ReadonlyscriptTree

Protectedsequence

Description

Protected ReadonlysighashTypes

Description

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`chalk

`Protected` `Readonly`compiledTargetScript

`Protected`enableLogs

`Protected`feeOutput

`Protected` `Readonly`feeRate

`Protected`from

`Protected`hideLogs

`Protected`ignoreSignatureErrors

`Protected` `Readonly`inputs

`Protected` `Readonly`isBrowser

`Protected`isPubKeyDestination

`Protected`leftOverFundsScriptRedeem

`Readonly`logColor

`Protected` `Readonly`minimumSignatures

`Readonly`moduleName

`Protected` `Readonly`network

`Protected` `Optional`nonWitnessUtxo

`Protected` `Readonly`originalInputCount

`Protected` `Readonly`outputs

`Protected`priorityFee

`Protected` `Readonly`publicKeys

`Protected` `Readonly`receiver

`Protected` `Readonly`refundVault

`Protected`regenerated

`Protected` `Readonly`requestedAmount

`Protected`scriptData

`Protected` `Readonly`scriptTree

`Protected`sequence

`Protected` `Readonly`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

`Static` `Readonly`LOCK_LEAF_SCRIPT

`Static` `Readonly`MINIMUM_DUST

`Static` `Readonly`numsPoint

`Static` `Readonly`signHashTypesArray

`Protected`addInputsFromUTXO

`Protected`addOptionalOutputsAndGetAmount

`Protected`addRefundOutput

`Protected`addValueToToOutput

`Protected`buildTransaction

`Protected`calculateTotalUTXOAmount

`Protected`calculateTotalVOutAmount

`Protected`generatePsbtInputExtended