Class HDWallet

Hierarchy (View Summary)

Account
- HDWallet

Implements

WalletInstance

Constructors

constructor

new HDWallet(
    key: unknown,
    node: HDNodeWallet,
    privateKey: PrivateKeyInstance,
): HDWallet
Parameters
- key: unknown
- node: HDNodeWallet
- privateKey: PrivateKeyInstance
Returns HDWallet
Overrides Account.constructor
- Defined in packages/protocol/packages/account/dist/types/HDWallet.d.ts:11

Properties

`Protected`_node

_node: undefined | HDNodeWallet

`Protected` `Optional`_previousHash

_previousHash?: ArrayBufferLike

neuter

neuter: () => HDWallet

`Protected` `Readonly`node

node: HDNodeWallet

`Protected` `Static`_addressMap

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

`Protected` `Static`_protectedConstructorKey

_protectedConstructorKey: symbol

`Static`previousHashStore

previousHashStore: undefined | PreviousHashStore

`Static` `Readonly`uniqueName

uniqueName: string

Accessors

address

get address(): Lowercase<string>
Returns Lowercase<string>
Implementation of WalletInstance.address
Overrides Account.address
- Defined in packages/protocol/packages/account/dist/types/HDWallet.d.ts:12

addressBytes

get addressBytes(): ArrayBufferLike
Returns ArrayBufferLike
Implementation of WalletInstance.addressBytes
Overrides Account.addressBytes
- Defined in packages/protocol/packages/account/dist/types/HDWallet.d.ts:13

base58

get base58(): string
Returns string
Inherited from Account.base58
- Defined in packages/protocol/packages/core/packages/data/dist/types/Data.d.ts:7

bytes

get bytes(): ArrayBuffer | SharedArrayBuffer
Returns ArrayBuffer | SharedArrayBuffer
Inherited from Account.bytes
- Defined in packages/protocol/packages/core/packages/data/dist/types/Data.d.ts:8

chainCode

get chainCode(): string
Returns string
Implementation of WalletInstance.chainCode
- Defined in packages/protocol/packages/account/dist/types/HDWallet.d.ts:14

depth

get depth(): number
Returns number
Implementation of WalletInstance.depth
- Defined in packages/protocol/packages/account/dist/types/HDWallet.d.ts:15

extendedKey

get extendedKey(): string
Returns string
Implementation of WalletInstance.extendedKey
- Defined in packages/protocol/packages/account/dist/types/HDWallet.d.ts:16

fingerprint

get fingerprint(): string
Returns string
Implementation of WalletInstance.fingerprint
- Defined in packages/protocol/packages/account/dist/types/HDWallet.d.ts:17

hex

get hex(): Lowercase<string>
Returns Lowercase<string>
Inherited from Account.hex
- Defined in packages/protocol/packages/core/packages/data/dist/types/Data.d.ts:9

index

get index(): number
Returns number
Implementation of WalletInstance.index
- Defined in packages/protocol/packages/account/dist/types/HDWallet.d.ts:18

keccak256

get keccak256(): ArrayBufferLike
Returns ArrayBufferLike
Inherited from Account.keccak256
- Defined in packages/protocol/packages/core/packages/data/dist/types/Data.d.ts:10

length

get length(): number
Returns number
Inherited from Account.length
- Defined in packages/protocol/packages/core/packages/data/dist/types/AbstractData.d.ts:9

mnemonic

get mnemonic(): null | Mnemonic
Returns null | Mnemonic
Implementation of WalletInstance.mnemonic
- Defined in packages/protocol/packages/account/dist/types/HDWallet.d.ts:19

parentFingerprint

get parentFingerprint(): string
Returns string
Implementation of WalletInstance.parentFingerprint
- Defined in packages/protocol/packages/account/dist/types/HDWallet.d.ts:20

path

get path(): null | string
Returns null | string
Implementation of WalletInstance.path
- Defined in packages/protocol/packages/account/dist/types/HDWallet.d.ts:21

previousHash

get previousHash(): undefined | Lowercase<string>
Returns undefined | Lowercase<string>
Implementation of WalletInstance.previousHash
Inherited from Account.previousHash
- Defined in packages/protocol/packages/account/dist/types/Account.d.ts:19

previousHashBytes

get previousHashBytes(): undefined | ArrayBufferLike
Returns undefined | ArrayBufferLike
Implementation of WalletInstance.previousHashBytes
Inherited from Account.previousHashBytes
- Defined in packages/protocol/packages/account/dist/types/Account.d.ts:20

private

get private(): PrivateKeyInstance
Returns PrivateKeyInstance
Implementation of WalletInstance.private
Inherited from Account.private
- Defined in packages/protocol/packages/account/dist/types/Account.d.ts:21

privateKey

get privateKey(): Lowercase<string>
Returns Lowercase<string>
Implementation of WalletInstance.privateKey
- Defined in packages/protocol/packages/account/dist/types/HDWallet.d.ts:22

public

get public(): PublicKeyInstance
Returns PublicKeyInstance
Implementation of WalletInstance.public
Inherited from Account.public
- Defined in packages/protocol/packages/account/dist/types/Account.d.ts:22

publicKey

get publicKey(): Lowercase<string>
Returns Lowercase<string>
Implementation of WalletInstance.publicKey
- Defined in packages/protocol/packages/account/dist/types/HDWallet.d.ts:23

Methods

derivePath

derivePath(path: string): Promise<WalletInstance>
Parameters
- path: string
Returns Promise<WalletInstance>
Implementation of WalletInstance.derivePath
- Defined in packages/protocol/packages/account/dist/types/HDWallet.d.ts:34

initialize

initialize(): Promise<HDWallet>
Returns Promise<HDWallet>
Inherited from Account.initialize
- Defined in packages/protocol/packages/account/dist/types/Account.d.ts:27

loadPreviousHash

loadPreviousHash(previousHash?: string | ArrayBufferLike): Promise<HDWallet>
Parameters
- OptionalpreviousHash: string | ArrayBufferLike
Returns Promise<HDWallet>
Inherited from Account.loadPreviousHash
- Defined in packages/protocol/packages/account/dist/types/Account.d.ts:28

sign

sign(
hash: ArrayBufferLike,
previousHash: undefined | ArrayBufferLike,
): Promise<[ArrayBufferLike, Lowercase<string>?]>
Parameters
- hash: ArrayBufferLike
- previousHash: undefined | ArrayBufferLike
Returns Promise<[ArrayBufferLike, Lowercase<string>?]>
Implementation of WalletInstance.sign
Inherited from Account.sign
- Defined in packages/protocol/packages/account/dist/types/Account.d.ts:29

verify

verify(msg: ArrayBufferLike, signature: ArrayBufferLike): Promise<boolean>
Parameters
- msg: ArrayBufferLike
- signature: ArrayBufferLike
Returns Promise<boolean>
Implementation of WalletInstance.verify
Inherited from Account.verify
- Defined in packages/protocol/packages/account/dist/types/Account.d.ts:30

verifyUniqueAddress

verifyUniqueAddress(): AccountInstance | HDWallet
Returns AccountInstance | HDWallet
Inherited from Account.verifyUniqueAddress
- Defined in packages/protocol/packages/account/dist/types/Account.d.ts:31

`Static`create

create(opts?: AccountConfig): Promise<WalletInstance>
Parameters
- Optionalopts: AccountConfig
Returns Promise<WalletInstance>
Overrides Account.create
- Defined in packages/protocol/packages/account/dist/types/HDWallet.d.ts:24

`Static`createFromNode

createFromNode(
node: HDNodeWallet,
previousHash?: string,
): Promise<WalletInstance>
Parameters
- node: HDNodeWallet
- OptionalpreviousHash: string
Returns Promise<WalletInstance>
- Defined in packages/protocol/packages/account/dist/types/HDWallet.d.ts:25

`Protected` `Static`createFromNodeInternal

createFromNodeInternal(
node: HDNodeWallet,
previousHash?: string,
): Promise<WalletInstance>
Parameters
- node: HDNodeWallet
- OptionalpreviousHash: string
Returns Promise<WalletInstance>
- Defined in packages/protocol/packages/account/dist/types/HDWallet.d.ts:32

`Static`from

from(data: undefined | ArrayBuffer): undefined | Data
Parameters
- data: undefined | ArrayBuffer
Returns undefined | Data
Inherited from Account.from
- Defined in packages/protocol/packages/core/packages/data/dist/types/Data.d.ts:11

`Static`fromExtendedKey

fromExtendedKey(key: string): Promise<WalletInstance>
Parameters
- key: string
Returns Promise<WalletInstance>
- Defined in packages/protocol/packages/account/dist/types/HDWallet.d.ts:26

`Static`fromMnemonic

fromMnemonic(mnemonic: Mnemonic, path?: string): Promise<WalletInstance>
Parameters
- mnemonic: Mnemonic
- Optionalpath: string
Returns Promise<WalletInstance>
- Defined in packages/protocol/packages/account/dist/types/HDWallet.d.ts:27

`Static`fromPhrase

fromPhrase(phrase: string, path?: string): Promise<WalletInstance>
Parameters
- phrase: string
- Optionalpath: string
Returns Promise<WalletInstance>
- Defined in packages/protocol/packages/account/dist/types/HDWallet.d.ts:28

`Static`fromPrivateKey

fromPrivateKey(key: string | bigint | ArrayBufferLike): Promise<AccountInstance>
Parameters
- key: string | bigint | ArrayBufferLike
Returns Promise<AccountInstance>
Inherited from Account.fromPrivateKey
- Defined in packages/protocol/packages/account/dist/types/Account.d.ts:24

`Static`fromSeed

fromSeed(seed: string | ArrayBufferLike): Promise<WalletInstance>
Parameters
- seed: string | ArrayBufferLike
Returns Promise<WalletInstance>
- Defined in packages/protocol/packages/account/dist/types/HDWallet.d.ts:29

`Static`generateMnemonic

generateMnemonic(wordlist?: string[], strength?: number): string
Parameters
- Optionalwordlist: string[]
- Optionalstrength: number
Returns string
- Defined in packages/protocol/packages/account/dist/types/HDWallet.d.ts:30

`Protected` `Static`getCachedWalletOrCacheNewWallet

getCachedWalletOrCacheNewWallet(createdWallet: WalletInstance): WalletInstance
Parameters
- createdWallet: WalletInstance
Returns WalletInstance
- Defined in packages/protocol/packages/account/dist/types/HDWallet.d.ts:33

`Static`is

is(value: unknown): value is AbstractData
Parameters
- value: unknown
Returns value is AbstractData
Inherited from Account.is
- Defined in packages/protocol/packages/core/packages/data/dist/types/AbstractData.d.ts:14

`Static`isAddress

isAddress(address: Lowercase<string>): boolean
Parameters
- address: Lowercase<string>
Returns boolean
Inherited from Account.isAddress
- Defined in packages/protocol/packages/account/dist/types/Account.d.ts:25

`Static`random

random(): Promise<WalletInstance>
Returns Promise<WalletInstance>
Overrides Account.random
- Defined in packages/protocol/packages/account/dist/types/HDWallet.d.ts:31

Class HDWallet

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns HDWallet

Properties

Protected_node

Protected Optional_previousHash

neuter

Protected Readonlynode

Protected Static_addressMap

Protected Static_protectedConstructorKey

StaticpreviousHashStore

Static ReadonlyuniqueName

Accessors

address

Returns Lowercase<string>

addressBytes

Returns ArrayBufferLike

base58

Returns string

bytes

Returns ArrayBuffer | SharedArrayBuffer

chainCode

Returns string

depth

Returns number

extendedKey

Returns string

fingerprint

Returns string

hex

Returns Lowercase<string>

index

Returns number

keccak256

Returns ArrayBufferLike

length

Returns number

mnemonic

Returns null | Mnemonic

parentFingerprint

Returns string

path

Returns null | string

previousHash

Returns undefined | Lowercase<string>

previousHashBytes

Returns undefined | ArrayBufferLike

private

Returns PrivateKeyInstance

privateKey

Returns Lowercase<string>

public

Returns PublicKeyInstance

publicKey

Returns Lowercase<string>

Methods

derivePath

Parameters

Returns Promise<WalletInstance>

initialize

Returns Promise<HDWallet>

loadPreviousHash

Parameters

Returns Promise<HDWallet>

sign

Parameters

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

verify

Parameters

Returns Promise<boolean>

verifyUniqueAddress

`Protected`_node

`Protected` `Optional`_previousHash

`Protected` `Readonly`node

`Protected` `Static`_addressMap

`Protected` `Static`_protectedConstructorKey

`Static`previousHashStore

`Static` `Readonly`uniqueName

`Static`create

`Static`createFromNode

`Protected` `Static`createFromNodeInternal

`Static`from

`Static`fromExtendedKey

`Static`fromMnemonic

`Static`fromPhrase

`Static`fromPrivateKey

`Static`fromSeed

`Static`generateMnemonic

`Protected` `Static`getCachedWalletOrCacheNewWallet

`Static`is

`Static`isAddress

`Static`random