index

Enumerations

Classes

Interfaces

Type aliases

DerivationPath

Variables

Functions

Type aliases

DerivationPath

DerivationPath: RegularDerivationPath | HardenedDerivationPath

Variables

Const ALL_DERIVATION_PATHS

ALL_DERIVATION_PATHS: DerivationPath[] = ...

All available (regular) derivation paths.

Const DEFAULT_AKA

DEFAULT_AKA: DerivationPath = ...

Const DEFAULT_ASK

DEFAULT_ASK: DerivationPath = ...

Const DEFAULT_ATH

DEFAULT_ATH: DerivationPath = ...

Const DEFAULT_AUX

DEFAULT_AUX: DerivationPath = ...

Const DEFAULT_CLO

DEFAULT_CLO: DerivationPath = ...

Const DEFAULT_DEXON

DEFAULT_DEXON: DerivationPath = ...

Const DEFAULT_EGEM

DEFAULT_EGEM: DerivationPath = ...

Const DEFAULT_ELLA

DEFAULT_ELLA: DerivationPath = ...

Const DEFAULT_EOSC

DEFAULT_EOSC: DerivationPath = ...

Const DEFAULT_ERE

DEFAULT_ERE: DerivationPath = ...

Const DEFAULT_ESN

DEFAULT_ESN: DerivationPath = ...

Const DEFAULT_ETC

DEFAULT_ETC: DerivationPath = ...

Const DEFAULT_ETH

DEFAULT_ETH: DerivationPath = ...

Const DEFAULT_ETHO

DEFAULT_ETHO: DerivationPath = ...

Const DEFAULT_ETSC

DEFAULT_ETSC: DerivationPath = ...

Const DEFAULT_EWC

DEFAULT_EWC: DerivationPath = ...

Const DEFAULT_EXP

DEFAULT_EXP: DerivationPath = ...

Const DEFAULT_GO

DEFAULT_GO: DerivationPath = ...

Const DEFAULT_METADIUM

DEFAULT_METADIUM: DerivationPath = ...

Const DEFAULT_MIX

DEFAULT_MIX: DerivationPath = ...

Const DEFAULT_MUSIC

DEFAULT_MUSIC: DerivationPath = ...

Const DEFAULT_PIRL

DEFAULT_PIRL: DerivationPath = ...

Const DEFAULT_REOSC

DEFAULT_REOSC: DerivationPath = ...

Const DEFAULT_SOLIDUM

DEFAULT_SOLIDUM: DerivationPath = ...

Const DEFAULT_THUNDERCORE

DEFAULT_THUNDERCORE: DerivationPath = ...

Const DEFAULT_TOMO

DEFAULT_TOMO: DerivationPath = ...

Const DEFAULT_UBQ

DEFAULT_UBQ: DerivationPath = ...

Const DEFAULT_VOLTA

DEFAULT_VOLTA: DerivationPath = ...

Const DEFAULT_WEB

DEFAULT_WEB: DerivationPath = ...

Const EXTENDED_KEY_CHILDREN

EXTENDED_KEY_CHILDREN: DerivationPath = ...

Const HARDENED_OFFSET

HARDENED_OFFSET: 2147483648 = 0x80000000

Const LEDGER_DERIVATION_PATHS

LEDGER_DERIVATION_PATHS: DerivationPath[] = ...

Due to limitations in the Ledger ETH application, only derivation paths starting with m/44'/60' and m/44'/1' can be checked.

Const LEDGER_ETC

LEDGER_ETC: DerivationPath = ...

Const LEDGER_ETH

LEDGER_ETH: DerivationPath = ...

Const LEDGER_LIVE_ETC

LEDGER_LIVE_ETC: DerivationPath = ...

Const LEDGER_LIVE_ETH

LEDGER_LIVE_ETH: DerivationPath = ...

Const MAINNET_RSK

MAINNET_RSK: DerivationPath = ...

Const TESTNET_ETH

TESTNET_ETH: DerivationPath = ...

Const TESTNET_RSK

TESTNET_RSK: DerivationPath = ...

Const TREZOR_DERIVATION_PATHS

TREZOR_DERIVATION_PATHS: DerivationPath[] = ...

While Trezor does support hardened paths, it'd be very tedious for the user to check all the paths currently, since the user would have to confirm each address individually.

Functions

Const deserialize

deserialize(serializedData: string): ExtendedKey | MnemonicPhrase | Trezor | Ledger<unknown>

- Defined in src/wallet.ts:94
Deserialize a wallet implementation from a string.

Parameters
- serializedData: string
Returns ExtendedKey | MnemonicPhrase | Trezor | Ledger<unknown>

Const fromArray

fromArray(derivationPath: number[]): string

- Defined in src/utils/derivation-paths.ts:55
Get a full derivation path from a number array.

Parameters
- derivationPath: number[]
Returns string

getAddresses

getAddresses(wallet: Wallet, derivationPaths: DerivationPath[], depth: number): AsyncGenerator<DerivationResult>

- Defined in src/addresses.ts:18
Get all addresses from a wallet, based on the derivation paths and depth specified, using a generator.

Parameters
- wallet: Wallet
- derivationPaths: DerivationPath[]
- depth: number
Returns AsyncGenerator<DerivationResult>

Const getDerivationPaths

getDerivationPaths(network: Network): DerivationPath[]

- Defined in src/derivation-paths.ts:271
Get a derivation path from a network. Returns a standard derivation path, and "hardened" version.

Parameters
- network: Network
Returns DerivationPath[]

Const getExtendedKeyVersion

getExtendedKeyVersion(extendedKey: string): ExtendedKeyVersion

- Defined in node_modules/@findeth/hdnode/typings/utils/extended-keys.d.ts:3
Parameters
- extendedKey: string
Returns ExtendedKeyVersion

Const getFullPath

getFullPath(derivationPath: DerivationPath, index: number): string

- Defined in src/utils/derivation-paths.ts:12
Get a full derivation path as string.

Parameters
- derivationPath: DerivationPath
- index: number
Returns string

Const getLedgerTransport

getLedgerTransport(): Promise<LedgerU2F | LedgerWebHID | LedgerWebUSB>

- Defined in src/utils/ledger.ts:12
Returns an instance of a (wired) Ledger transport method. Currently, this will return the WebUSB method if it is supported, with WebHID method as fallback, and U2F method as fallback for WebHID.

If no transport method is supported, this will throw an error.

Returns Promise<LedgerU2F | LedgerWebHID | LedgerWebUSB>

Const getPathPrefix

getPathPrefix(derivationPath: string): string

- Defined in src/utils/derivation-paths.ts:22
Get the prefix segments from a (non-hardened) derivation path.

Parameters
- derivationPath: string
Returns string

Const getTransportImplementation

getTransportImplementation<Type>(type: Type): { U2F: typeof LedgerU2F; WebBLE: typeof LedgerWebBLE; WebHID: typeof LedgerWebHID; WebUSB: typeof LedgerWebUSB }[Type]

- Defined in src/utils/transports.ts:27
Get the transport implementation class for a specific transport type.

Type parameters
- Type: TransportType
Parameters
- type: Type
Returns { U2F: typeof LedgerU2F; WebBLE: typeof LedgerWebBLE; WebHID: typeof LedgerWebHID; WebUSB: typeof LedgerWebUSB }[Type]

Const getWalletImplementation

getWalletImplementation<Type>(type: Type): { ExtendedKey: typeof ExtendedKey; Ledger: typeof Ledger; MnemonicPhrase: typeof MnemonicPhrase; Trezor: typeof Trezor }[Type]

- Defined in src/implementation.ts:18
Get the wallet implemention class for a specific wallet type.

Type parameters
- Type: WalletType
Parameters
- type: Type
Returns { ExtendedKey: typeof ExtendedKey; Ledger: typeof Ledger; MnemonicPhrase: typeof MnemonicPhrase; Trezor: typeof Trezor }[Type]

Const isExtendedKey

isExtendedKey(extendedKey: string): boolean

- Defined in node_modules/@findeth/hdnode/typings/utils/extended-keys.d.ts:2
Parameters
- extendedKey: string
Returns boolean

Const isTransportType

isTransportType(type: string): type is TransportType

- Defined in src/utils/transports.ts:16
Checks if a string is a valid type of TransportType.

Parameters
- type: string
Returns type is TransportType

Const isValidMnemonic

isValidMnemonic(mnemonic: string): boolean

- Defined in node_modules/@findeth/hdnode/typings/mnemonics/mnemonic-phrase.d.ts:45
Check if a mnemonic phrase is valid or not.

Parameters
- mnemonic: string
Returns boolean

Const isWalletType

isWalletType(type: string): type is WalletType

- Defined in src/wallet.ts:84
Checks if a string is a valid type of WalletType.

Parameters
- type: string
Returns type is WalletType

Const memoize

memoize<Argument, Result>(fn: (input: Argument) => Promise<Result>, getIdentifier?: (input: Argument) => string): (input: Argument) => Promise<Result>

- Defined in src/utils/memoize.ts:8
Returns a memoized version of a function.

Type parameters
- Argument
- Result
Parameters
- fn: (input: Argument) => Promise<Result>
  - - (input: Argument): Promise<Result>
    - Parameters
      - input: Argument
      Returns Promise<Result>
- getIdentifier: (input: Argument) => string = ...
  - - (input: Argument): string
    - Parameters
      - input: Argument
      Returns string
Returns (input: Argument) => Promise<Result>
- - (input: Argument): Promise<Result>
  - Parameters
    - input: Argument
    Returns Promise<Result>

Const parseRawData

parseRawData(data: Uint8Array, index?: number): [string, number]

- Defined in src/utils/ledger.ts:36
Parse data received from Transport.send.

Parameters
- data: Uint8Array
- index: number = 0
Returns [string, number]

Const toArray

toArray(derivationPath: string): number[]

- Defined in src/utils/derivation-paths.ts:34
Get the full derivation path as a number array.

Parameters
- derivationPath: string
Returns number[]

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

DerivationPath

Variables

Const ALL_DERIVATION_PATHS

Const DEFAULT_AKA

Const DEFAULT_ASK

Const DEFAULT_ATH

Const DEFAULT_AUX

Const DEFAULT_CLO

Const DEFAULT_DEXON

Const DEFAULT_EGEM

Const DEFAULT_ELLA

Const DEFAULT_EOSC

Const DEFAULT_ERE

Const DEFAULT_ESN

Const DEFAULT_ETC

Const DEFAULT_ETH

Const DEFAULT_ETHO

Const DEFAULT_ETSC

Const DEFAULT_EWC

Const DEFAULT_EXP

Const DEFAULT_GO

Const DEFAULT_METADIUM

Const DEFAULT_MIX

Const DEFAULT_MUSIC

Const DEFAULT_PIRL

Const DEFAULT_REOSC

Const DEFAULT_SOLIDUM

Const DEFAULT_THUNDERCORE

Const DEFAULT_TOMO

Const DEFAULT_UBQ

Const DEFAULT_VOLTA

Const DEFAULT_WEB

Const EXTENDED_KEY_CHILDREN

Const HARDENED_OFFSET

Const LEDGER_DERIVATION_PATHS

Const LEDGER_ETC

Const LEDGER_ETH

Const LEDGER_LIVE_ETC

Const LEDGER_LIVE_ETH

Const MAINNET_RSK

Const TESTNET_ETH

Const TESTNET_RSK

Const TREZOR_DERIVATION_PATHS

Functions

Const deserialize

Parameters

serializedData: string

Returns ExtendedKey | MnemonicPhrase | Trezor | Ledger<unknown>

Const fromArray

Parameters

derivationPath: number[]

Returns string

getAddresses

Parameters

wallet: Wallet

derivationPaths: DerivationPath[]

depth: number

Returns AsyncGenerator<DerivationResult>

Const getDerivationPaths

Parameters

network: Network

Returns DerivationPath[]

Const getExtendedKeyVersion

Parameters

extendedKey: string

Returns ExtendedKeyVersion

Const getFullPath

Parameters

derivationPath: DerivationPath

index: number

Returns string

Const getLedgerTransport