Class: WalletKey

wallet~WalletKey(optionsnullable)

Wallet Key Represents a key ring which amounts to an address.

Constructor

new WalletKey(optionsnullable)

Create a wallet key.

Extends:
  • KeyRing
Parameters:
Name Type Attributes Description
options Object <nullable>
Source:

Extends

  • KeyRing

Methods

(static) fromHD(account, key, branch, index) → {WalletKey}

Instantiate a wallet key from hd key.

Parameters:
Name Type Description
account Account
key HDPrivateKey | HDPublicKey
branch Number
index Number
Source:
Returns:
Type
WalletKey

(static) fromImport(account, data) → {WalletKey}

Instantiate a wallet key from imported data.

Parameters:
Name Type Description
account Account
data Buffer
Source:
Returns:
Type
WalletKey

(static) fromRing(account, ring) → {WalletKey}

Instantiate a wallet key from regular key.

Parameters:
Name Type Description
account Account
ring KeyRing
Source:
Returns:
Type
WalletKey

(static) isWalletKey(obj) → {Boolean}

Test whether an object is a WalletKey.

Parameters:
Name Type Description
obj Object
Source:
Returns:
Type
Boolean

(private) fromHD(account, key, branch, index) → {WalletKey}

Inject properties from hd key.

Parameters:
Name Type Description
account Account
key HDPrivateKey | HDPublicKey
branch Number
index Number
Source:
Returns:
Type
WalletKey

(private) fromImport(account, data) → {WalletKey}

Inject properties from imported data.

Parameters:
Name Type Description
account Account
data Buffer
Source:
Returns:
Type
WalletKey

(private) fromRing(account, ring) → {WalletKey}

Inject properties from key.

Parameters:
Name Type Description
account Account
ring KeyRing
Source:
Returns:
Type
WalletKey

getJSON() → {Object}

Convert an WalletKey to a more json-friendly object.

Source:
Returns:
Type
Object

toPath() → {Path}

Convert wallet key to a path.

Source:
Returns:
Type
Path