Class Key

Creates a key object from a base58 encoded key.

Param

A public or secret key in base58 encoding, or a 15 word bip39 english mnemonic string. Not providing a key will import a ledger public key.

Param

The passphrase used if the key provided is an encrypted private key or a fundraiser key

Param

Email used if a fundraiser key is passed

Param

Ledger derivation path

Param

Ledger curve

Param

Ledger transport

Example

import TransportNodeHid from "@ledgerhq/hw-transport-node-hid";
const key = new Key({ ledgerPath: "44'/1729'/0'/1'", ledgerTransport: TransportNodeHid });

const key = new Key({ key: 'edskRv6ZnkLQMVustbYHFPNsABu1Js6pEEWyMUFJQTqEZjVCU2WHh8ckcc7YA4uBzPiJjZCsv3pC1NDdV99AnyLzPjSip4uC3y' });

Hierarchy

Index

Constructors

constructor

new Key(__namedParameters?: { email?: string; key?: string; ledgerCurve?: string; ledgerPath?: string; ledgerTransport?: any; passphrase?: string }): Key
Parameters
- __namedParameters: { email?: string; key?: string; ledgerCurve?: string; ledgerPath?: string; ledgerTransport?: any; passphrase?: string } = {}
  - Optional email?: string
  - Optional key?: string
  - Optional ledgerCurve?: string
  - Optional ledgerPath?: string
  - Optional ledgerTransport?: any
  - Optional passphrase?: string
Returns Key

Properties

_curve

_curve: string

_isLedger

_isLedger: boolean

_isSecret

_isSecret: boolean

_ledgerCurve

_ledgerCurve: string

_ledgerPath

_ledgerPath: string

_ledgerTransport

_ledgerTransport: any

_publicKey

_publicKey: Uint8Array

_salt

_salt: Uint8Array

`Optional` _secretKey

_secretKey?: Uint8Array

ready

ready: Promise<boolean>

Accessors

curve

get curve(): string
Returns string

isLedger

get isLedger(): boolean
Returns boolean
set isLedger(value: boolean): void
Parameters
- value: boolean
Returns void

ledgerCurve

get ledgerCurve(): string
Returns string
set ledgerCurve(value: string): void
Parameters
- value: string
Returns void

ledgerPath

get ledgerPath(): string
Returns string
set ledgerPath(value: string): void
Parameters
- value: string
Returns void

Methods

initialize

initialize(__namedParameters: { email?: string; key?: string; passphrase?: string }, setInit: ((value: boolean) => void)): Promise<void>
Parameters
- __namedParameters: { email?: string; key?: string; passphrase?: string }
  - Optional email?: string
  - Optional key?: string
  - Optional passphrase?: string
- setInit: ((value: boolean) => void)
  - - (value: boolean): void
    - Parameters
      
      value: boolean
      
      Returns void
Returns Promise<void>

publicKey

publicKey(): Promise<string>
Memberof
Key

Description
Returns the public key

Returns
The public key associated with the private key

Returns Promise<string>

publicKeyHash

publicKeyHash(): Promise<string>
Memberof
Key

Description
Returns public key hash for this key

Returns
The public key hash for this key

Returns Promise<string>

secretKey

secretKey(passphrase?: string): Promise<string>
Memberof
Key

Description
Returns the secret key

Returns
The secret key associated with this key, if available
Parameters
- Optional passphrase: string
  
  The password used to encrypt the secret key, if applicable
Returns Promise<string>

sign

sign(bytes: string, magicBytes?: Uint8Array): Promise<{ bytes: string; magicBytes: string; prefixSig: string; sbytes: string; sig: string }>
Memberof
Key

Description
Sign a raw sequence of bytes

Returns
The signature object
Parameters
- bytes: string
  
  Sequence of bytes, raw format or hexadecimal notation
- Optional magicBytes: Uint8Array
  
  The magic bytes for the operation
Returns Promise<{ bytes: string; magicBytes: string; prefixSig: string; sbytes: string; sig: string }>

verify

verify(bytes: string, signature: string, publicKey: string): Promise<boolean>
Memberof
Key

Description
Verify signature

Returns
Whether the signature is valid
Parameters
- bytes: string
  
  Sequance of bytes, raw format or hexadecimal notation
- signature: string
  
  A signature in base58 encoding
- publicKey: string
  
  A public key
Returns Promise<boolean>

Class Key

Param

Param

Param

Param

Param

Param

Param

Example

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

__namedParameters: { email?: string; key?: string; ledgerCurve?: string; ledgerPath?: string; ledgerTransport?: any; passphrase?: string } = {}

Optional email?: string

Optional key?: string

Optional ledgerCurve?: string

Optional ledgerPath?: string

Optional ledgerTransport?: any

Optional passphrase?: string

Returns Key

Properties

_curve

_isLedger

_isSecret

_ledgerCurve

_ledgerPath

_ledgerTransport

_publicKey

_salt

Optional _secretKey

ready

Accessors

curve

Returns string

isLedger

Returns boolean

Parameters

value: boolean

Returns void

ledgerCurve

Returns string

Parameters

value: string

Returns void

ledgerPath

Returns string

Parameters

value: string

Returns void

Methods

initialize

Parameters

__namedParameters: { email?: string; key?: string; passphrase?: string }

Optional email?: string

Optional key?: string

Optional passphrase?: string

setInit: ((value: boolean) => void)

Parameters

value: boolean

Returns void

Returns Promise<void>

publicKey

Memberof

Description

Returns

Returns Promise<string>

publicKeyHash

Memberof

Description

Returns

Returns Promise<string>

secretKey

Memberof

Description

`Optional` email?: string

`Optional` key?: string

`Optional` ledgerCurve?: string

`Optional` ledgerPath?: string

`Optional` ledgerTransport?: any

`Optional` passphrase?: string

`Optional` _secretKey

`Optional` email?: string

`Optional` key?: string

`Optional` passphrase?: string

`Optional` passphrase: string

`Optional` magicBytes: Uint8Array