Class HDKey

Static ReadonlyEXTENDED_PRIVATE_KEY_PREFIX

Static ReadonlyEXTENDED_PUBLIC_KEY_PREFIX

Static ReadonlyVET_DERIVATION_PATH

StaticfromMnemonic

• fromMnemonic(words, path?): HDKey

• Creates a BIP32 Hierarchical Deterministic Key from BIP39 Mnemonic Words and the given derivation path.

  Parameters

  • words: string[]

    An array of words representing the mnemonic.
  • path: string = ...

    The derivation path to derive the child node. Default value is VET_DERIVATION_PATH.

  Returns HDKey

  The derived child hierarchical deterministic key.

  Throws

  If path is not valid to derive a node wallet.

  Throws

  If words is an invalid array mnemonic.

  Remarks

  Security auditable method, depends on

  • s_bip32.HDKey.derive;
  • s_bip32.HDKey.fromMasterSeed;
  • s_bip39.mnemonicToSeedSync.

StaticfromPrivateKey

• fromPrivateKey(privateKey, chainCode): HDKey

• Creates a BIP32 Hierarchical Deterministic Key from a private key and chain code.

  Parameters

  • privateKey: Uint8Array
  • chainCode: Uint8Array

  Returns HDKey

  Returns the hierarchical deterministic key from privateKey and chainCode.

  Throws

  If the privateKey is invalid.

  Remarks

  This method wipes privateKey for security reasons.

StaticfromPublicKey

• fromPublicKey(publicKey, chainCode): HDKey

• Creates a BIP32 Hierarchical Deterministic Key key from a public key and chain code.

  Parameters

  • publicKey: Uint8Array

    The public key bytes.
  • chainCode: Uint8Array

    The chain code bytes.

  Returns HDKey

  Returns the hierarchical deterministic key from public and chainCode.

  Throws

  if the publicKey is invalid.

  Remarks

  Security auditable method, depends on

  • base58.encode;
  • Secp256k1.compressPublicKey;
  • Sha256;
  • HDKey.fromExtendedKey.

StaticisDerivationPathValid

• isDerivationPathValid(derivationPath): boolean

• Checks if BIP32 derivation path is valid.

  Parameters

  • derivationPath: string

    Derivation path to check.

  Returns boolean

  true if derivation path is valid, otherwise false.