Class HDWallet

Hierarchy (View Summary)

Implements

Constructors

constructor

Properties

_node _previousHash? neuter node _addressMap _protectedConstructorKey previousHashStore uniqueName

Accessors

address addressBytes base58 bytes chainCode depth extendedKey fingerprint hex index keccak256 length mnemonic parentFingerprint path previousHash previousHashBytes private privateKey public publicKey

Methods

derivePath initialize loadPreviousHash sign verify verifyUniqueAddress create createFromNode createFromNodeInternal from fromExtendedKey fromMnemonic fromPhrase fromPrivateKey fromSeed generateMnemonic getCachedWalletOrCacheNewWallet is isAddress random

Constructors

constructor

Properties

Protected_node

_node: undefined | HDNodeWallet

Protected Optional_previousHash

_previousHash?: ArrayBufferLike

neuter

neuter: () => HDWallet

Protected Readonlynode

node: HDNodeWallet

Protected Static_addressMap

_addressMap: Record<Lowercase<string>, WeakRef<WalletInstance>>

Protected Static_protectedConstructorKey

_protectedConstructorKey: symbol

StaticpreviousHashStore

previousHashStore: undefined | PreviousHashStore

Static ReadonlyuniqueName

uniqueName: string

Accessors

address

  • get address(): Lowercase<string>

  • Returns Lowercase<string>

addressBytes

  • get addressBytes(): ArrayBufferLike

  • Returns ArrayBufferLike

base58

  • get base58(): string

  • Returns string

bytes

  • get bytes(): ArrayBuffer | SharedArrayBuffer

  • Returns ArrayBuffer | SharedArrayBuffer

chainCode

  • get chainCode(): string

  • Returns string

depth

  • get depth(): number

  • Returns number

extendedKey

  • get extendedKey(): string

  • Returns string

fingerprint

  • get fingerprint(): string

  • Returns string

hex

  • get hex(): Lowercase<string>

  • Returns Lowercase<string>

index

  • get index(): number

  • Returns number

keccak256

  • get keccak256(): ArrayBufferLike

  • Returns ArrayBufferLike

length

  • get length(): 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

previousHash

  • get previousHash(): undefined | Lowercase<string>

  • Returns undefined | Lowercase<string>

previousHashBytes

  • get previousHashBytes(): undefined | ArrayBufferLike

  • Returns undefined | ArrayBufferLike

private

privateKey

  • get privateKey(): Lowercase<string>

  • Returns Lowercase<string>

public

publicKey

  • get publicKey(): Lowercase<string>

  • Returns Lowercase<string>

Methods

derivePath

initialize

loadPreviousHash

  • loadPreviousHash(previousHash?: string | ArrayBufferLike): Promise<HDWallet>

  • Parameters

    • OptionalpreviousHash: string | ArrayBufferLike

    Returns Promise<HDWallet>

sign

  • sign(
        hash: ArrayBufferLike,
        previousHash: undefined | ArrayBufferLike,
    ): Promise<[ArrayBufferLike, Lowercase<string>?]>

  • Parameters

    • hash: ArrayBufferLike
    • previousHash: undefined | ArrayBufferLike

    Returns Promise<[ArrayBufferLike, Lowercase<string>?]>

verify

  • verify(msg: ArrayBufferLike, signature: ArrayBufferLike): Promise<boolean>

  • Parameters

    • msg: ArrayBufferLike
    • signature: ArrayBufferLike

    Returns Promise<boolean>

verifyUniqueAddress

Staticcreate

StaticcreateFromNode

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

  • Parameters

    • node: HDNodeWallet
    • OptionalpreviousHash: string

    Returns Promise<WalletInstance>

Protected StaticcreateFromNodeInternal

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

  • Parameters

    • node: HDNodeWallet
    • OptionalpreviousHash: string

    Returns Promise<WalletInstance>

Staticfrom

  • from(data: undefined | ArrayBuffer): undefined | Data

  • Parameters

    • data: undefined | ArrayBuffer

    Returns undefined | Data

StaticfromExtendedKey

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

  • Parameters

    • key: string

    Returns Promise<WalletInstance>

StaticfromMnemonic

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

  • Parameters

    • mnemonic: Mnemonic
    • Optionalpath: string

    Returns Promise<WalletInstance>

StaticfromPhrase

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

  • Parameters

    • phrase: string
    • Optionalpath: string

    Returns Promise<WalletInstance>

StaticfromPrivateKey

  • fromPrivateKey(key: string | bigint | ArrayBufferLike): Promise<AccountInstance>

  • Parameters

    • key: string | bigint | ArrayBufferLike

    Returns Promise<AccountInstance>

StaticfromSeed

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

  • Parameters

    • seed: string | ArrayBufferLike

    Returns Promise<WalletInstance>

StaticgenerateMnemonic

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

  • Parameters

    • Optionalwordlist: string[]
    • Optionalstrength: number

    Returns string

Protected StaticgetCachedWalletOrCacheNewWallet

Staticis

  • is(value: unknown): value is AbstractData

  • Parameters

    • value: unknown

    Returns value is AbstractData

StaticisAddress

  • isAddress(address: Lowercase<string>): boolean

  • Parameters

    • address: Lowercase<string>

    Returns boolean

Staticrandom

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods