Class PrivateKey

ECDSA (secp256k1) private key.

Hierarchy

PrivateKey

Index

Constructors

Methods

createPublic inspect sign toString from fromLogin fromSeed fromString

Constructors

constructor

new PrivateKey(key: Buffer): PrivateKey
Parameters
- key: Buffer
Returns PrivateKey
- Defined in crypto.ts:202

Methods

createPublic

createPublic(prefix?: string): PublicKey
Derive the public key for this private key.
Parameters
- Optional prefix: string
Returns PublicKey
- Defined in crypto.ts:258

inspect

inspect(): string
Used by utils.inspect and console.log in node.js. Does not show the full key to get the full encoded key you need to explicitly call toString.

Returns string
- Defined in crypto.ts:273

sign

sign(message: Buffer): Signature
Sign message.
Parameters
- message: Buffer
  
  32-byte message.
Returns Signature
- Defined in crypto.ts:243

toString

toString(): string
Return a WIF-encoded representation of the key.

Returns string
- Defined in crypto.ts:265

`Static` from

from(value: string | Buffer): PrivateKey
Convenience to create a new instance from WIF string or buffer.
Parameters
- value: string | Buffer
Returns PrivateKey
- Defined in crypto.ts:209

`Static` fromLogin

fromLogin(username: string, password: string, role?: KeyRole): PrivateKey
Create key from username and password.
Parameters
- username: string
- password: string
- role: KeyRole = 'active'
Returns PrivateKey
- Defined in crypto.ts:234

`Static` fromSeed

fromSeed(seed: string): PrivateKey
Create a new instance from a seed.
Parameters
- seed: string
Returns PrivateKey
- Defined in crypto.ts:227

`Static` fromString

fromString(wif: string): PrivateKey
Create a new instance from a WIF-encoded key.
Parameters
- wif: string
Returns PrivateKey
- Defined in crypto.ts:220

Generated using TypeDoc