Modules

Class KeyPair

Hierarchy

KeyPair
- KeyPairSecp256k1

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new KeyPair(secretKey: Buffer, type?: KeyType): KeyPair

- Defined in src/key_pair.ts:60
Parameters
- secretKey: Buffer
- type: KeyType = ...
Returns KeyPair

Properties

Readonly _keyType

_keyType: KeyType

Readonly _secretKey

_secretKey: Buffer

Accessors

address

get address(): Address

- Defined in src/key_pair.ts:73
Returns Address

Abstract publicKey

get publicKey(): PublicKey

- Defined in src/key_pair.ts:67
Returns PublicKey

type

get type(): KeyType

- Defined in src/key_pair.ts:69
Returns KeyType

Methods

Abstract sign

sign(message: Buffer): Signature

- Defined in src/key_pair.ts:133
Parameters
- message: Buffer
  
  Sha256 hash of message
Returns Signature

toString

toString(): string

- Defined in src/key_pair.ts:142
Returns string

Abstract verify

verify(message: Buffer, signature: Buffer[]): boolean

- Defined in src/key_pair.ts:140
Parameters
- message: Buffer
  
  Buffer Sha256 hash of message
- signature: Buffer[]
  
  Buffer[]
Returns boolean

Static fromRandom

fromRandom(curve?: string): KeyPair

- Defined in src/key_pair.ts:81
Parameters
- curve: string = ...
  
  Name of elliptical curve, case-insensitive
Returns KeyPair

Random KeyPair based on the curve

Static fromString

fromString(secretKey: string): KeyPair

- Defined in src/key_pair.ts:106
Construct an instance of key pair given a secret key. It's generally assumed that these are encoded in base58check.

Parameters
- secretKey: string
Returns KeyPair

Generated using TypeDoc