Class: KeyPairEd25519

utils/key_pair.KeyPairEd25519

This class provides key pair functionality for Ed25519 curve: generating key pairs, encoding key pairs, signing and verifying.

Hierarchy

• KeyPair

  ↳ KeyPairEd25519

Constructors

constructor

new KeyPairEd25519(secretKey)

Construct an instance of key pair given a secret key. It's generally assumed that these are encoded in base58.

Parameters

Name	Type
secretKey	string

Overrides

KeyPair.constructor

Defined in

utils/key_pair.ts:113

Properties

publicKey

Readonly publicKey: PublicKey

Defined in

utils/key_pair.ts:105

---

secretKey

Readonly secretKey: string

Defined in

utils/key_pair.ts:106

Methods

getPublicKey

getPublicKey(): PublicKey

Returns

PublicKey

Overrides

KeyPair.getPublicKey

Defined in

utils/key_pair.ts:148

---

sign

sign(message): Signature

Parameters

Name	Type
message	Uint8Array

Returns

Signature

Overrides

KeyPair.sign

Defined in

utils/key_pair.ts:135

---

toString

toString(): string

Returns

string

Overrides

KeyPair.toString

Defined in

utils/key_pair.ts:144

---

verify

verify(message, signature): boolean

Parameters

Name	Type
message	Uint8Array
signature	Uint8Array

Returns

boolean

Overrides

KeyPair.verify

Defined in

utils/key_pair.ts:140

---

fromRandom

Static fromRandom(): KeyPairEd25519

Generate a new random keypair.

Example

const keyRandom = KeyPair.fromRandom();
keyRandom.publicKey
// returns [PUBLIC_KEY]

keyRandom.secretKey
// returns [SECRET_KEY]

Returns

KeyPairEd25519

Overrides

KeyPair.fromRandom

Defined in

utils/key_pair.ts:130

---

fromString

Static fromString(encodedKey): KeyPair

Parameters

Name	Type
encodedKey	string

Returns

KeyPair

Inherited from

KeyPair.fromString

Defined in

utils/key_pair.ts:85