Class BIP322

constructor

• new BIP322(): BIP322

  Returns BIP322

StaticTAG

StaticbuildToSignTx

• buildToSignTx(
      toSpendTxId: string,
      witnessScript: Buffer,
      isRedeemScript?: boolean,
      tapInternalKey?: Buffer,
  ): Psbt

  Build a to_sign transaction using simple signature in accordance to the BIP-322.

  Parameters

  • toSpendTxId: string

    Transaction ID of the to_spend transaction as constructed by buildToSpendTx

  • witnessScript: Buffer

    The script public key for the signing wallet, or the redeemScript for P2SH-P2WPKH address

  • isRedeemScript: boolean = false

    Set to true if the provided witnessScript is a redeemScript for P2SH-P2WPKH address, default to false

  • tapInternalKey: Buffer = undefined

    Used to set the taproot internal public key of a taproot signing address when provided, default to undefined

  Returns Psbt

  Ready-to-be-signed bitcoinjs.Psbt transaction

StaticbuildToSpendTx

• buildToSpendTx(
      message: string | Buffer<ArrayBufferLike>,
      scriptPublicKey: Buffer,
  ): Transaction

  Build a to_spend transaction using simple signature in accordance to the BIP-322.

  Parameters

  • message: string | Buffer<ArrayBufferLike>

    Message to be signed using BIP-322

  • scriptPublicKey: Buffer

    The script public key for the signing wallet

  Returns Transaction

  Bitcoin transaction that correspond to the to_spend transaction

StaticencodeWitness

• encodeWitness(signedPsbt: Psbt): string

  Encode witness stack in a signed BIP-322 PSBT into its base-64 encoded format.

  Parameters

  • signedPsbt: Psbt

    Signed PSBT

  Returns string

  Base-64 encoded witness data

StatichashMessage

• hashMessage(
      message: string | Buffer<ArrayBufferLike>,
  ): Uint8Array<ArrayBufferLike>

  Compute the message hash as specified in the BIP-322. The standard is specified in BIP-340 as: The function hashtag(x) where tag is a UTF-8 encoded tag name and x is a byte array returns the 32-byte hash SHA256(SHA256(tag) || SHA256(tag) || x).

  Parameters

  • message: string | Buffer<ArrayBufferLike>

    Message to be hashed

  Returns Uint8Array<ArrayBufferLike>

  Hashed message