Class HDWallet

constructor

• new HDWallet(config): HDWallet

• HDWallet is a implementation of the BIP-0044 and BIP-0032, Multi-Account Hierarchy for Deterministic Wallets

  Parameters

  • config: HDWalletConfig

    Wallet configurations

  Returns HDWallet

chainCode

depth

fingerprint

index

parentFingerprint

OptionalprivateKey

publicKey

extendedKey

• get extendedKey(): string

• Returns string

deriveIndex

• deriveIndex(index): HDWallet

• Derive the current HDWallet instance navigating only on the index. Ex.: m/44'/0 -> Ex.: m/44'/1 -> m/44'/2. Learn more

  Parameters

  • index: number

    Index of the child HDWallet.

  Returns HDWallet

  A new instance of HDWallet on the derived index

derivePath

• derivePath(path): HDWallet

• Derive the current HDWallet instance to the path. Learn more

  Parameters

  • path: string

    The string representation of the child HDWallet. Ex.: m/44'/0'/0'/0/0

  Returns HDWallet

  A new instance of HDWallet on the derived path

toExtendedKey

• toExtendedKey(isPublic?, testnet?): string

• Get the extendKey as defined on BIP-32 from the provided seed

  Parameters

  • isPublic: boolean = false

    enable to export public extendedKey, it not required when HDWallet didn't have the privateKey.
  • testnet: boolean = false

    Inform if should use testnet or mainnet prefix, default value is true (mainnet).

  Returns string

  BIP-32 extended private key

StaticfromExtendedKey

• fromExtendedKey(extendedKey): HDWallet

• Parameters

  • extendedKey: string

  Returns HDWallet

StaticfromSeed

• fromSeed(seed): HDWallet

• Create HDWallet instance from seed

  Parameters

  • seed: string

    Seed

  Returns HDWallet

  A new instance of HDWallet