@btc-stamps/tx-builder - v0.1.7
    Preparing search index...

    Class ScriptBuilder

    Builder for creating various types of Bitcoin scripts

    ScriptBuilder provides utilities for creating different Bitcoin script types used in transactions. It abstracts the complexity of script creation and provides a simple interface for common script patterns.

    Supported script types:

    • P2PKH (Pay to Public Key Hash)
    • P2WPKH (Pay to Witness Public Key Hash)
    • P2SH (Pay to Script Hash)
    • P2WSH (Pay to Witness Script Hash)
    • P2TR (Pay to Taproot)
    • Multisig scripts
    • Custom OP_RETURN data scripts
    const scriptBuilder = new ScriptBuilder(networks.bitcoin);

    // Create a P2WPKH script
    const p2wpkhScript = scriptBuilder.createP2WPKH('bc1q...');

    // Create a multisig script
    const multisigScript = scriptBuilder.createMultisig(2, [pubkey1, pubkey2, pubkey3]);
    Index

    Constructors

    constructor

    Methods

    createBareMultisigForStamps createMultisig createOpReturn createP2PKH createP2SH createP2SHMultisig createP2WPKH createP2WSH createTimelocked identifyScript isValidScript

    Constructors

    Methods

    • Create bare multisig for stamps (1-of-2 or 1-of-3)

      Parameters

      • pubkeys: Buffer<ArrayBufferLike>[]
      • _dataChunks: Buffer<ArrayBufferLike>[]

      Returns Buffer

    • Create multisig script

      Parameters

      • m: number
      • pubkeys: Buffer<ArrayBufferLike>[]

      Returns Buffer

    • Create OP_RETURN script

      Parameters

      • data: Buffer<ArrayBufferLike> | Buffer<ArrayBufferLike>[]

      Returns Buffer

    • Create P2PKH (Pay to Public Key Hash) script

      Parameters

      • address: string

      Returns Buffer

    • Create P2SH (Pay to Script Hash) script

      Parameters

      • redeemScript: Buffer

      Returns Buffer

    • Create P2SH-wrapped multisig

      Parameters

      • m: number
      • pubkeys: Buffer<ArrayBufferLike>[]

      Returns { address: string; redeemScript: Buffer; scriptPubKey: Buffer }

    • Create P2WPKH (Pay to Witness Public Key Hash) script

      Parameters

      • address: string

      Returns Buffer

    • Create P2WSH (Pay to Witness Script Hash) script

      Parameters

      • witnessScript: Buffer

      Returns Buffer

    • Create timelocked script

      Parameters

      • locktime: number
      • pubkey: Buffer

      Returns Buffer

    • Parse script to identify type

      Parameters

      • script: Buffer

      Returns string

    • Validate script

      Parameters

      • script: Buffer

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods