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

    Class BitcoinStampsEncoder

    Encoder for creating Bitcoin Stamps protocol-compliant transactions

    BitcoinStampsEncoder handles the encoding of data for Bitcoin Stamps, which store data directly on-chain using multi-signature outputs. This makes the data pruning-resistant and permanently stored on the Bitcoin blockchain.

    Features:

    • Automatic data compression (gzip, brotli)
    • Base64 encoding for binary data
    • Protocol prefix handling ('stamp:' prefix)
    • Multi-signature script generation
    • P2WSH output creation
    • Chunk size optimization for efficiency
    const encoder = new BitcoinStampsEncoder();
    const result = await encoder.encode({
      data: imageBuffer,
      encoding: 'gzip',
      pubkeys: [pubkey1, pubkey2, pubkey3]
    });

    // result.outputs contains the P2WSH outputs for the transaction
    Index

    Constructors

    constructor

    Methods

    decode encode encodeSync getMaxDataSize getType validate extractStampFromTransaction fromBase64 fromBuffer

    Constructors

    Methods

    • Create a Bitcoin Stamp from base64 image data

      Parameters

      • base64Data: string
      • options: { creator?: string; description?: string; filename?: string; title?: string } = {}

      Returns BitcoinStampData

    • Create a Bitcoin Stamp from file buffer

      Parameters

      • imageBuffer: Buffer
      • options: { creator?: string; description?: string; filename?: string; title?: string } = {}

      Returns BitcoinStampData

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods