Class TweakedTransaction`Abstract`

Description

PSBT Transaction processor.

Hierarchy (view full)

Logger
- TweakedTransaction
  - TransactionBuilder
  - PsbtTransaction

Constructors

`Protected`constructor

new TweakedTransaction(data): TweakedTransaction
Parameters
- data: ITweakedTransactionData
Returns TweakedTransaction
Overrides Logger.constructor
- Defined in src/transaction/shared/TweakedTransaction.ts:97

Properties

`Protected` `Readonly`chalk

chalk: ChalkInstance

`Protected`enableLogs

enableLogs: boolean

finalized

finalized: boolean = false

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

`Readonly`logColor

logColor: string = '#00ffe1'

`Readonly`moduleName

moduleName: string

`Protected`network

network: Network

Description

The network of the transaction

`Protected` `Optional`nonWitnessUtxo

nonWitnessUtxo?: Buffer

Add a non-witness utxo to the transaction

`Protected`regenerated

regenerated: boolean = false

`Protected`scriptData

scriptData: null | Payment = null

Description

The script data of the transaction

`Protected`sequence

sequence: number = TransactionSequence.REPLACE_BY_FEE

Description

The sequence of the transaction

`Protected`sighashTypes

sighashTypes: undefined | number[]

Description

The sighash types of the transaction

`Protected`signed

signed: boolean = false

Description

Was the transaction signed?

`Protected`signer

signer: ECPairInterface | Signer

Description

Was the transaction signed?

`Protected`tapData

tapData: null | Payment = null

Description

The tap data of the transaction

`Protected`tapLeafScript

tapLeafScript: null | TapLeafScript = null

The tap leaf script

`Protected` `Abstract` `Readonly`transaction

transaction: Psbt

Description

The transaction

`Protected` `Optional`tweakedSigner

tweakedSigner?: ECPairInterface

Description

Tweaked signer

Methods

debug

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

disable

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

enable

enable(): void
Returns void
Inherited from Logger.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 Logger.error
- Defined in node_modules/@btc-vision/logger/build/logger/shared/SharedLogger.d.ts:19

fail

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

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

`Protected`generateScriptAddress

generateScriptAddress(): Payment
Protected
Generates the script address.

Returns Payment
- Defined in src/transaction/shared/TweakedTransaction.ts:329

`Protected`generateTapData

generateTapData(): Payment
Returns Payment
- Defined in src/transaction/shared/TweakedTransaction.ts:317

getScriptAddress

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

`Protected`getSignerKey

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

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

getStartPrefix

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

getTransaction

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

ignoreSignatureError

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

important

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

`Protected`internalInit

internalInit(): void
Protected
Internal init.

Returns void
- Defined in src/transaction/shared/TweakedTransaction.ts:491

`Protected`internalPubKeyToXOnly

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

Returns Buffer
- Defined in src/transaction/shared/TweakedTransaction.ts:483

lightOrangeLog

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

securityNotice

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

setLogPrefix

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

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

`Protected`signInputs

signInputs(transaction): Promise<void>
Protected
Signs all the inputs of the transaction.
Parameters
- transaction: Psbt
  The transaction to sign
Returns Promise<void>
- Defined in src/transaction/shared/TweakedTransaction.ts:444

`Protected`splitArray

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

success

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

traceLog

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

warn

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

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

`Protected` `Static`readScriptWitnessToWitnessStack

readScriptWitnessToWitnessStack(Buffer): Buffer[]
Protected
Read witnesses
Parameters
- Buffer: Buffer
Returns Buffer[]
- 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
- Defined in src/transaction/shared/TweakedTransaction.ts:189

Class TweakedTransactionAbstract

Description

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

Protectedconstructor

Parameters

Returns TweakedTransaction

Properties

Protected Readonlychalk

ProtectedenableLogs

finalized

ProtectedhideLogs

ProtectedignoreSignatureErrors

Protected Readonlyinputs

Description

Protected ReadonlyisBrowser

ReadonlylogColor

ReadonlymoduleName

Protectednetwork

Description

Protected OptionalnonWitnessUtxo

Protectedregenerated

ProtectedscriptData

Description

Protectedsequence

Description

ProtectedsighashTypes

Description

Protectedsigned

Description

Protectedsigner

Description

ProtectedtapData

Description

ProtectedtapLeafScript

Protected Abstract Readonlytransaction

Description

Protected OptionaltweakedSigner

Description

Methods

debug

Parameters

Returns void

debugBright

Parameters

Returns void

disable

Returns void

disableRBF

Returns void

Description

enable

Returns void

error

Parameters

Returns void

fail

Parameters

Returns void

fancyLog

Parameters

Returns void

ProtectedgeneratePsbtInputExtended

Parameters

Returns PsbtInputExtended

ProtectedgenerateScriptAddress

Returns Payment

ProtectedgenerateTapData

Returns Payment

getScriptAddress

Returns string

Description

ProtectedgetSignerKey

Returns ECPairInterface | Signer

getStartPrefix

Returns string

Class TweakedTransaction`Abstract`

`Protected`constructor

`Protected` `Readonly`chalk

`Protected`enableLogs

`Protected`hideLogs

`Protected`ignoreSignatureErrors

`Protected` `Readonly`inputs

`Protected` `Readonly`isBrowser

`Readonly`logColor

`Readonly`moduleName

`Protected`network

`Protected` `Optional`nonWitnessUtxo

`Protected`regenerated

`Protected`scriptData

`Protected`sequence

`Protected`sighashTypes

`Protected`signed

`Protected`signer

`Protected`tapData

`Protected`tapLeafScript

`Protected` `Abstract` `Readonly`transaction

`Protected` `Optional`tweakedSigner

`Protected`generatePsbtInputExtended

`Protected`generateScriptAddress

`Protected`generateTapData

`Protected`getSignerKey

`Protected`internalInit

`Protected`internalPubKeyToXOnly

`Protected`signInput

`Protected`signInputs

`Protected`splitArray

`Protected`tweakSigner

`Protected` `Static`calculateSignHash

`Static`preEstimateTaprootTransactionFees

`Protected` `Static`readScriptWitnessToWitnessStack

`Protected` `Static`signInput