BitcoinerLab Descriptors API - v3.1.5
    Preparing search index...

    Function wpkhBIP32

    • Computes the standard descriptor based on given parameters.

      You can define the output location either by:

      • Providing the full keyPath (e.g., "/0/2"). OR
      • Specifying the change and index values separately (e.g., {change:0, index:2}).

      For ranged indexing, the index can be set as a wildcard '*'. For example:

      • keyPath="/0/*" OR
      • {change:0, index:'*'}.

      Parameters

      • params: {
            masterNode: BIP32InterfaceLike | ScureHDKeyLike;
            network?: Network;
            account: number;
            change?: number;
            index?: number | "*";
            keyPath?: string;
            isPublic?: boolean;
        }

        The parameters object.

        • masterNode: BIP32InterfaceLike | ScureHDKeyLike

          Root HD node. Pass a bitcoinjs BIP32 node or a scure HDKey.

        • Optionalnetwork?: Network
          networks.bitcoin
        • account: number

          BIP32 account index.

        • Optionalchange?: number

          Branch index (0 receive / 1 change).

        • Optionalindex?: number | "*"

          Address index or wildcard for ranged descriptors.

        • OptionalkeyPath?: string

          Full path suffix (/change/index) alternative.

        • OptionalisPublic?: boolean

          Compute an xpub or xprv

          true

      Returns string

    Settings

    Member Visibility