Class HDWallet

constructor

• new HDWallet(
      key: unknown,
      node: HDNodeWallet,
      privateKey: PrivateKeyInstance,
  ): HDWallet

• Parameters

  • key: unknown
  • node: HDNodeWallet
  • privateKey: PrivateKeyInstance

  Returns HDWallet

neuter

Static ReadonlyuniqueName

address

• get address(): Lowercase<string>

• Returns Lowercase<string>

addressBytes

• get addressBytes(): ArrayBufferLike

• Returns ArrayBufferLike

chainCode

• get chainCode(): string

• Returns string

depth

• get depth(): number

• Returns number

extendedKey

• get extendedKey(): string

• Returns string

fingerprint

• get fingerprint(): string

• Returns string

index

• get index(): number

• Returns number

mnemonic

• get mnemonic(): null | Mnemonic

• Returns null | Mnemonic

parentFingerprint

• get parentFingerprint(): string

• Returns string

path

• get path(): null | string

• Returns null | string

privateKey

• get privateKey(): Lowercase<string>

• Returns Lowercase<string>

publicKey

• get publicKey(): Lowercase<string>

• Returns Lowercase<string>

derivePath

• derivePath(path: string): Promise<WalletInstance>

• Parameters

  • path: string

  Returns Promise<WalletInstance>

Staticcreate

• create(opts?: AccountConfig): Promise<WalletInstance>

• Parameters

  • Optionalopts: AccountConfig

  Returns Promise<WalletInstance>

StaticcreateFromNode

• createFromNode(
      node: HDNodeWallet,
      previousHash?: string,
  ): Promise<WalletInstance>

• Parameters

  • node: HDNodeWallet
  • OptionalpreviousHash: string

  Returns Promise<WalletInstance>

StaticfromExtendedKey

• fromExtendedKey(key: string): Promise<WalletInstance>

• Parameters

  • key: string

  Returns Promise<WalletInstance>

StaticfromMnemonic

• fromMnemonic(mnemonic: Mnemonic, path?: string): Promise<WalletInstance>

• Parameters

  • mnemonic: Mnemonic
  • path: string = defaultPath

  Returns Promise<WalletInstance>

StaticfromPhrase

• fromPhrase(phrase: string, path?: string): Promise<WalletInstance>

• Parameters

  • phrase: string
  • path: string = defaultPath

  Returns Promise<WalletInstance>

StaticfromSeed

• fromSeed(seed: string | ArrayBufferLike): Promise<WalletInstance>

• Parameters

  • seed: string | ArrayBufferLike

  Returns Promise<WalletInstance>

StaticgenerateMnemonic

• generateMnemonic(wordlist?: string[], strength?: number): string

• Parameters

  • wordlist: string[] = englishWordlist
  • strength: number = 256

  Returns string

Staticrandom

• random(): Promise<WalletInstance>

• Returns Promise<WalletInstance>