Class PSBTBuilder

Builder for creating and manipulating Partially Signed Bitcoin Transactions (PSBTs)

Remarks

PSBTBuilder provides a fluent interface for constructing PSBTs with support for:

Multiple input types (P2PKH, P2WPKH, P2SH, P2WSH)
Witness and non-witness UTXOs
Custom scripts and redeem scripts
Fee calculation and validation
Transaction finalization

Example

const builder = new PSBTBuilder();
const psbt = builder
  .addInput(utxo)
  .addOutput({ address: 'bc1q...', value: 100000 })
  .build();

Hierarchy (View Summary)

PSBTBuilder
- EnhancedPSBTBuilder

Index

Constructors

constructor

new PSBTBuilder(options?: PSBTOptions): PSBTBuilder
Parameters
- options: PSBTOptions = {}
Returns PSBTBuilder
- Defined in core/psbt-builder.ts:42

Properties

`Protected`psbt

psbt: Psbt

Methods

addDataOutput

addDataOutput(data: Buffer): this
Add OP_RETURN output
Parameters
- data: Buffer
Returns this
- Defined in core/psbt-builder.ts:170

addInput

addInput(
    txid: string,
    vout: number,
    options?: {
        nonWitnessUtxo?: Buffer<ArrayBufferLike>;
        redeemScript?: Buffer<ArrayBufferLike>;
        sequence?: number;
        witnessScript?: Buffer<ArrayBufferLike>;
        witnessUtxo?: { script: Buffer; value: number };
    },
): this
Add standard input
Parameters
- txid: string
- vout: number
- options: {
      nonWitnessUtxo?: Buffer<ArrayBufferLike>;
      redeemScript?: Buffer<ArrayBufferLike>;
      sequence?: number;
      witnessScript?: Buffer<ArrayBufferLike>;
      witnessUtxo?: { script: Buffer; value: number };
  } = {}
Returns this
- Defined in core/psbt-builder.ts:98

addOutput

addOutput(
addressOrScript: string | Buffer<ArrayBufferLike>,
value: number,
): this
Add standard output
Parameters
- addressOrScript: string | Buffer<ArrayBufferLike>
- value: number
Returns this
- Defined in core/psbt-builder.ts:152

clone

clone(): PSBTBuilder
Clone PSBT

Returns PSBTBuilder
- Defined in core/psbt-builder.ts:234

combine

combine(...psbts: Psbt[]): this
Combine multiple PSBTs
Parameters
- ...psbts: Psbt[]
Returns this
- Defined in core/psbt-builder.ts:181

extractTransaction

extractTransaction(skipFinalization?: boolean): null | Transaction
Extract transaction without finalizing
Parameters
- skipFinalization: boolean = false
Returns null | Transaction
- Defined in core/psbt-builder.ts:220

getFee

getFee(): number
Get fee amount

Returns number
- Defined in core/psbt-builder.ts:206

getFeeRate

getFeeRate(): number
Get fee rate (sat/vB)

Returns number
- Defined in core/psbt-builder.ts:213

getPSBT

getPSBT(): Psbt & { outputCount: number }
Get underlying PSBT

Returns Psbt & { outputCount: number }
- Defined in core/psbt-builder.ts:265

toBase64

toBase64(): string
Export to base64

Returns string
- Defined in core/psbt-builder.ts:244

toBuffer

toBuffer(): Buffer
Export to buffer

Returns Buffer
- Defined in core/psbt-builder.ts:258

toHex

toHex(): string
Export to hex

Returns string
- Defined in core/psbt-builder.ts:251

validateSignatures

validateSignatures(): boolean
Validate all inputs have signatures

Returns boolean
- Defined in core/psbt-builder.ts:189

`Static`fromBase64

fromBase64(base64: string, network?: Network): PSBTBuilder
Create PSBT from base64 string
Parameters
- base64: string
- Optionalnetwork: Network
Returns PSBTBuilder
- Defined in core/psbt-builder.ts:62

`Static`fromBuffer

fromBuffer(buffer: Buffer, network?: Network): PSBTBuilder
Create PSBT from buffer
Parameters
- buffer: Buffer
- Optionalnetwork: Network
Returns PSBTBuilder
- Defined in core/psbt-builder.ts:86

`Static`fromHex

fromHex(hex: string, network?: Network): PSBTBuilder
Create PSBT from hex string
Parameters
- hex: string
- Optionalnetwork: Network
Returns PSBTBuilder
- Defined in core/psbt-builder.ts:74

Class PSBTBuilder

Remarks

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PSBTBuilder

Properties

Protectedpsbt

Methods

addDataOutput

Parameters

Returns this

addInput

Parameters

Returns this

addOutput

Parameters

Returns this

clone

Returns PSBTBuilder

combine

Parameters

Returns this

extractTransaction

Parameters

Returns null | Transaction

getFee

Returns number

getFeeRate

Returns number

getPSBT

Returns Psbt & { outputCount: number }

toBase64

Returns string

toBuffer

Returns Buffer

toHex

Returns string

validateSignatures

Returns boolean

StaticfromBase64

Parameters

Returns PSBTBuilder

StaticfromBuffer

Parameters

Returns PSBTBuilder

StaticfromHex

Parameters

Returns PSBTBuilder

Settings

On This Page

`Protected`psbt

`Static`fromBase64

`Static`fromBuffer

`Static`fromHex