Ed25519KeyIdentity

Defined in: packages/identity/src/identity/ed25519.ts:109

Ed25519KeyIdentity is an implementation of SignIdentity that uses Ed25519 keys. This class is used to sign and verify messages for an agent.

Extends

• SignIdentity

Constructors

Constructor

protected new Ed25519KeyIdentity(publicKey, privateKey): Ed25519KeyIdentity

Defined in: packages/identity/src/identity/ed25519.ts:168

Parameters

publicKey

PublicKey

privateKey

Uint8Array

Returns

Ed25519KeyIdentity

Overrides

SignIdentity.constructor

Properties

_principal

protected _principal: undefined | Principal

Defined in: packages/agent/lib/esm/auth.d.ts:52

Inherited from

SignIdentity._principal

Methods

getKeyPair()

getKeyPair(): KeyPair

Defined in: packages/identity/src/identity/ed25519.ts:184

Return a copy of the key pair.

Returns

KeyPair

---

getPrincipal()

getPrincipal(): Principal

Defined in: packages/agent/lib/esm/auth.d.ts:65

Get the principal represented by this identity. Normally should be a Principal.selfAuthenticating().

Returns

Principal

Inherited from

SignIdentity.getPrincipal

---

getPublicKey()

getPublicKey(): Required<PublicKey>

Defined in: packages/identity/src/identity/ed25519.ts:194

Return the public key.

Returns

Required<PublicKey>

Overrides

SignIdentity.getPublicKey

---

sign()

sign(challenge): Promise<Signature>

Defined in: packages/identity/src/identity/ed25519.ts:202

Signs a blob of data, with this identity’s private key.

Parameters

challenge

Uint8Array

challenge to sign with this identity’s secretKey, producing a signature

Returns

Promise<Signature>

Overrides

SignIdentity.sign

---

toJSON()

toJSON(): JsonnableEd25519KeyIdentity

Defined in: packages/identity/src/identity/ed25519.ts:177

Serialize this key to JSON.

Returns

JsonnableEd25519KeyIdentity

---

transformRequest()

transformRequest(request): Promise<unknown>

Defined in: packages/agent/lib/esm/auth.d.ts:72

Transform a request into a signed version of the request. This is done last after the transforms on the body of a request. The returned object can be anything, but must be serializable to CBOR.

Parameters

request

HttpAgentRequest

internet computer request to transform

Returns

Promise<unknown>

Inherited from

SignIdentity.transformRequest

---

fromJSON()

static fromJSON(json): Ed25519KeyIdentity

Defined in: packages/identity/src/identity/ed25519.ts:143

Parameters

json

string

Returns

Ed25519KeyIdentity

---

fromKeyPair()

static fromKeyPair(publicKey, privateKey): Ed25519KeyIdentity

Defined in: packages/identity/src/identity/ed25519.ts:155

Parameters

publicKey

Uint8Array

privateKey

Uint8Array

Returns

Ed25519KeyIdentity

---

fromParsedJson()

static fromParsedJson(obj): Ed25519KeyIdentity

Defined in: packages/identity/src/identity/ed25519.ts:135

Parameters

obj

JsonnableEd25519KeyIdentity

Returns

Ed25519KeyIdentity

---

fromSecretKey()

static fromSecretKey(secretKey): Ed25519KeyIdentity

Defined in: packages/identity/src/identity/ed25519.ts:159

Parameters

secretKey

Uint8Array

Returns

Ed25519KeyIdentity

---

generate()

static generate(seed?): Ed25519KeyIdentity

Defined in: packages/identity/src/identity/ed25519.ts:115

Generate a new Ed25519KeyIdentity.

Parameters

seed?

Uint8Array<ArrayBufferLike>

a 32-byte seed for the private key. If not provided, a random seed will be generated.

Returns

Ed25519KeyIdentity

Ed25519KeyIdentity

---

verify()

static verify(sig, msg, pk): boolean

Defined in: packages/identity/src/identity/ed25519.ts:222

Verify

Parameters

sig

signature to verify

string | ArrayBuffer | Uint8Array<ArrayBufferLike>

msg

message to verify

string | ArrayBuffer | Uint8Array<ArrayBufferLike>

pk

public key

string | ArrayBuffer | Uint8Array<ArrayBufferLike>

Returns

boolean

• true if the signature is valid, false otherwise