@atala/prism-wallet-sdk / Exports / Domain / PrivateKey

Class: PrivateKey

Domain.PrivateKey

Storable define properties a Domain object must implement to be compatible with Pluto

Hierarchy

• Key

  ↳ PrivateKey

Implements

• Storable

Table of contents

Constructors

• constructor

Properties

• keySpecification
• raw
• size
• to
• type
• uuid

Accessors

• alg
• curve
• index
• value

Methods

• canVerify
• getEncoded
• getProperty
• isCurve
• isDerivable
• isExportable
• isSignable
• isStorable
• publicKey

Constructors

constructor

• new PrivateKey(): PrivateKey

Returns

PrivateKey

Inherited from

Key.constructor

Properties

keySpecification

• Abstract keySpecification: Map<string, string>

Inherited from

Key.keySpecification

Defined in

src/domain/models/keyManagement/Key.ts:146

---

raw

• Abstract raw: Uint8Array

Inherited from

Key.raw

Defined in

src/domain/models/keyManagement/Key.ts:148

---

size

• Abstract size: number

Inherited from

Key.size

Defined in

src/domain/models/keyManagement/Key.ts:147

---

to

• Abstract to: Object

Type declaration

Name	Type
Buffer	() => Buffer
String	(encoding?: BufferEncoding) => string

Inherited from

Key.to

Defined in

src/domain/models/keyManagement/Key.ts:149

---

type

• Abstract type: KeyTypes

Inherited from

Key.type

Defined in

src/domain/models/keyManagement/Key.ts:145

---

uuid

• Readonly uuid: string

Universally Unique Identifier. should be unique across all items.

Implementation of

Storable.uuid

Defined in

src/domain/models/keyManagement/PrivateKey.ts:9

Accessors

alg

• get alg(): JWT_ALG

Returns

JWT_ALG

Inherited from

Key.alg

Defined in

src/domain/models/keyManagement/Key.ts:158

---

curve

• get curve(): string

Returns

string

Overrides

Key.curve

Defined in

src/domain/models/keyManagement/PrivateKey.ts:11

---

index

• get index(): undefined | number

Derivation index. The index of the key in the derivation path. Only applicable for HD keys

Returns

undefined | number

Defined in

src/domain/models/keyManagement/PrivateKey.ts:23

---

value

• get value(): Uint8Array

Returns

Uint8Array

Defined in

src/domain/models/keyManagement/PrivateKey.ts:30

Methods

canVerify

▸ canVerify(): this is VerifiableKey

Returns

this is VerifiableKey

Inherited from

Key.canVerify

Defined in

src/domain/models/keyManagement/Key.ts:180

---

getEncoded

▸ getEncoded(): Uint8Array

Returns

Uint8Array

Inherited from

Key.getEncoded

Defined in

src/domain/models/keyManagement/Key.ts:151

---

getProperty

▸ getProperty(name): undefined | string

Parameters

Name	Type
name	string

Returns

undefined | string

Inherited from

Key.getProperty

Defined in

src/domain/models/keyManagement/Key.ts:184

---

isCurve

▸ isCurve<T>(curve): this is T

Type parameters

Name
T

Parameters

Name	Type
curve	string

Returns

this is T

Inherited from

Key.isCurve

Defined in

src/domain/models/keyManagement/Key.ts:188

---

isDerivable

▸ isDerivable(): this is DerivableKey

Returns

this is DerivableKey

Inherited from

Key.isDerivable

Defined in

src/domain/models/keyManagement/Key.ts:164

---

isExportable

▸ isExportable(): this is All

Returns

this is All

Inherited from

Key.isExportable

Defined in

src/domain/models/keyManagement/Key.ts:168

---

isSignable

▸ isSignable(): this is SignableKey

Returns

this is SignableKey

Inherited from

Key.isSignable

Defined in

src/domain/models/keyManagement/Key.ts:172

---

isStorable

▸ isStorable(): this is StorableKey

Returns

this is StorableKey

Inherited from

Key.isStorable

Defined in

src/domain/models/keyManagement/Key.ts:176

---

publicKey

▸ publicKey(): PublicKey

Returns

PublicKey

Defined in

src/domain/models/keyManagement/PrivateKey.ts:7