Class KeyPairController

Collection of functions to work with private keys and seed phrases

Index

Methods

deriveChild derivePath keyToPublicKey keyToWalletId keyToXPrivateKey keyToXPublicKey mnemonicToIdentityKey mnemonicToSeed mnemonicToWallet privateKeyToWif publicKeyToAddress seedToWallet walletToIdentityKey xKeyToHDXKey

Methods

deriveChild

deriveChild(parent: HDKey, index: number, hardened: boolean): Promise<HDKey>
Allows to derive child HD Key
Parameters
- parent: HDKey
  {HDKey} - The HDKey parent instance
- index: number
  {number} - Index of child
- hardened: boolean
  {boolean} - hardened or no
Returns Promise<HDKey>
A promise that resolves child key
- Defined in src/keyPair/index.ts:32

derivePath

derivePath(parent: HDKey, path: string): Promise<HDKey>
Allows to derive HD key by path
Parameters
- parent: HDKey
  {HDKey} - The HDKey parent instance
- path: string
  {string} - Path of children
Returns Promise<HDKey>
A promise that resolves key by path
- Defined in src/keyPair/index.ts:44

keyToPublicKey

keyToPublicKey(
hdKey: HDKey,
opts?: NetworkVersion,
): Promise<Uint8Array<ArrayBufferLike>>
Convert a HDKey to a public key
Parameters
- hdKey: HDKey
  {HDKey} - The HDKey to be converted into a public key
- Optionalopts: NetworkVersion
  {NetworkVersion=} - Network version
Returns Promise<Uint8Array<ArrayBufferLike>>
- converted public key
- Defined in src/keyPair/index.ts:56

keyToWalletId

keyToWalletId(hdKey: HDKey): Promise<string>
Converts a HDKey to a wallet ID
Parameters
- hdKey: HDKey
  {HDKey} - The HDKey to be converted into a wallet id.
Returns Promise<string>
Wallet id from used key
- Defined in src/keyPair/index.ts:67

keyToXPrivateKey

keyToXPrivateKey(hdKey: HDKey, opts?: NetworkVersion): Promise<string>
Converts an HDKey instance to an extended private key (xprv)
Parameters
- hdKey: HDKey
  {HDKey} - The HDKey instance to convert
- Optionalopts: NetworkVersion
  {NetworkVersion=} - Optional, containing the version
Returns Promise<string>
A promise that resolves to the xPrivateKey string
- Defined in src/keyPair/index.ts:79

keyToXPublicKey

keyToXPublicKey(
hdKey: HDKey,
opts?: NetworkVersion,
): Promise<Uint8Array<ArrayBufferLike>>
Convert a HDKey to a xPublicKey
Parameters
- hdKey: HDKey
  {HDKey} - The HDKey instance to convert
- Optionalopts: NetworkVersion
  {NetworkVersion=} - Optional, containing the version
Returns Promise<Uint8Array<ArrayBufferLike>>
- Defined in src/keyPair/index.ts:90

mnemonicToIdentityKey

mnemonicToIdentityKey(
    mnemonic: string,
    identityIndex?: number,
    keyIndex?: number,
    salt?: string,
    verify?: boolean,
    opts?: HDFromSeedOptions & WalletToIdentityKeyOpts,
): Promise<HDKey>
Derives an Identity HDKey from a mnemonic phrase.
Parameters
- mnemonic: string
  {string} - The BIP39 mnemonic phrase.
- OptionalidentityIndex: number
  {number} - The identity index (default: 0).
- OptionalkeyIndex: number
  {number} - The key index within the identity (default: 0).
- Optionalsalt: string
  {string=} - Optional salt for seed derivation.
- Optionalverify: boolean
  {boolean=} - Whether to verify the mnemonic during derivation.
- Optionalopts: HDFromSeedOptions & WalletToIdentityKeyOpts
  {(HDFromSeedOptions & WalletToIdentityKeyOpts)=} - Additional options for HD seed derivation and wallet-to-identity conversion.
Returns Promise<HDKey>
A promise that resolves to the derived identity HDKey.
- Defined in src/keyPair/index.ts:106

mnemonicToSeed

mnemonicToSeed(
    mnemonic: string,
    salt?: string,
    verify?: boolean,
): Promise<Uint8Array<ArrayBufferLike>>
Returns seed from mnemonic phrase
Parameters
- mnemonic: string
  {string} - The BIP39 mnemonic phrase.
- Optionalsalt: string
  {string=} - Optional salt for seed derivation.
- Optionalverify: boolean
  {boolean=} - Whether to verify the mnemonic during derivation.
Returns Promise<Uint8Array<ArrayBufferLike>>
Seed bytes
- Defined in src/keyPair/index.ts:119

mnemonicToWallet

mnemonicToWallet(
    mnemonic: string,
    salt?: string,
    verify?: boolean,
    opts?: HDFromSeedOptions,
): Promise<HDKey>
Returns wallet from mnemonic phrase
Parameters
- mnemonic: string
  {string} - The BIP39 mnemonic phrase.
- Optionalsalt: string
  {string=} - Optional salt for seed derivation.
- Optionalverify: boolean
  {boolean=} - Whether to verify the mnemonic during derivation.
- Optionalopts: HDFromSeedOptions
  {HDFromSeedOptions=} - Optional derivation settings
Returns Promise<HDKey>
Wallet from mnemonic
- Defined in src/keyPair/index.ts:133

privateKeyToWif

privateKeyToWif(
privateKeyBytes: Uint8Array,
opts?: NetworkVersion,
): Promise<string>
Convert a private key to WIF
Parameters
- privateKeyBytes: Uint8Array
  {Uint8Array} - Private key bytes
- Optionalopts: NetworkVersion
  {NetworkVersion=} - Optional options with network version
Returns Promise<string>
WIF
- Defined in src/keyPair/index.ts:145

publicKeyToAddress

publicKeyToAddress(
publicKeyBytes: Uint8Array,
opts?: NetworkVersion,
): Promise<string>
Convert public key to address
Parameters
- publicKeyBytes: Uint8Array
  {Uint8Array} - Bytes of public key
- Optionalopts: NetworkVersion
  {NetworkVersion=} - Optional options with network version
Returns Promise<string>
address string
- Defined in src/keyPair/index.ts:157

seedToWallet

seedToWallet(seed: Uint8Array, opts?: HDFromSeedOptions): Promise<HDWallet>
Convert seed bytes to wallet
Parameters
- seed: Uint8Array
  {Uint8Array} - seed bytes
- Optionalopts: HDFromSeedOptions
  {HDFromSeedOptions?} - Optional options with network version
Returns Promise<HDWallet>
- Defined in src/keyPair/index.ts:169

walletToIdentityKey

walletToIdentityKey(
    wallet: HDKey | HDWallet,
    identityIndex: number,
    keyIndex: number,
    opts?: WalletToIdentityKeyOpts,
): Promise<HDKey>
Returns identity key from wallet
Parameters
- wallet: HDKey | HDWallet
  {HDWallet | HDKey} - wallet that will be used
- identityIndex: number
  {number} - index of identity for wallet
- keyIndex: number
  {number} - index of key for identity
- opts: WalletToIdentityKeyOpts = ...
  {WalletToIdentityKeyOpts=} - optional options
Returns Promise<HDKey>
- Defined in src/keyPair/index.ts:183

xKeyToHDXKey

xKeyToHDXKey(xKey: string, opts?: HDFromXKeyOptions): Promise<HDXKey>
Allows to convert xKey to HDXKey
Parameters
- xKey: string
  {string} - String with xKey
- Optionalopts: HDFromXKeyOptions
  {HDFromXKeyOptions=} - Optional options
Returns Promise<HDXKey>
- Defined in src/keyPair/index.ts:194

Class KeyPairController

Index

Methods

Methods

deriveChild

Parameters

Returns Promise<HDKey>

derivePath

Parameters

Returns Promise<HDKey>

keyToPublicKey

Parameters

Returns Promise<Uint8Array<ArrayBufferLike>>

keyToWalletId

Parameters

Returns Promise<string>

keyToXPrivateKey

Parameters

Returns Promise<string>

keyToXPublicKey

Parameters

Returns Promise<Uint8Array<ArrayBufferLike>>

mnemonicToIdentityKey

Parameters

Returns Promise<HDKey>

mnemonicToSeed

Parameters

Returns Promise<Uint8Array<ArrayBufferLike>>

mnemonicToWallet

Parameters

Returns Promise<HDKey>

privateKeyToWif

Parameters

Returns Promise<string>

publicKeyToAddress

Parameters

Returns Promise<string>

seedToWallet

Parameters

Returns Promise<HDWallet>

walletToIdentityKey

Parameters

Returns Promise<HDKey>

xKeyToHDXKey

Parameters

Returns Promise<HDXKey>

Settings

On This Page