Function decodeHdKey

  • Decode an HD key as defined by BIP32, returning a node and a network. Decoding errors are returned as strings.

    If the type of the key is known, use decodeHdPrivateKey or decodeHdPublicKey. For a variant with less strict validation, use decodeHdKeyUnchecked.

    Parameters

    • hdKey: string

      A BIP32 HD private key or HD public key.

    • __namedParameters: {
          crypto?: {
              secp256k1: {
                  validatePublicKey: ((publicKey) => boolean);
              };
              sha256: {
                  hash: ((input) => Uint8Array) & ((input) => Uint8Array);
              };
          };
      } = {}
      • Optional crypto?: {
            secp256k1: {
                validatePublicKey: ((publicKey) => boolean);
            };
            sha256: {
                hash: ((input) => Uint8Array) & ((input) => Uint8Array);
            };
        }

        An optional object containing an implementation of sha256 and a Secp256k1 validatePublicKey to use.

        • secp256k1: {
              validatePublicKey: ((publicKey) => boolean);
          }
          • validatePublicKey: ((publicKey) => boolean)
              • (publicKey): boolean
              • Parameters

                • publicKey: Uint8Array

                Returns boolean

        • sha256: {
              hash: ((input) => Uint8Array) & ((input) => Uint8Array);
          }
          • hash: ((input) => Uint8Array) & ((input) => Uint8Array)

    Returns string | DecodedHdKey<HdPrivateNodeValid | HdPublicNodeValid>

Generated using TypeDoc