Module utils

Index

References

Variables

HARDENED_OFFSET

Functions

References

ExtendedKeyVersion

Re-exports ExtendedKeyVersion

getExtendedKeyVersion

Re-exports getExtendedKeyVersion

isExtendedKey

Re-exports isExtendedKey

isValidMnemonic

Re-exports isValidMnemonic

Variables

Const HARDENED_OFFSET

HARDENED_OFFSET: 2147483648 = 0x80000000

Functions

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

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 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 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[]

Generated using TypeDoc