PrivateKey

@hyperledger/identus-sdk v7.0.0

---

@hyperledger/identus-sdk / overview / Domain / PrivateKey

Abstract Class: PrivateKey

Defined in: src/domain/models/keyManagement/PrivateKey.ts:6

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

Extends

• Key

Implements

• Storable

Constructors

Constructor

new PrivateKey(): PrivateKey

Returns

PrivateKey

Inherited from

Key.constructor

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
keySpecification	abstract	Map<string, string>	-	Key.keySpecification	src/domain/models/keyManagement/Key.ts:13
raw	abstract	Uint8Array	-	Key.raw	src/domain/models/keyManagement/Key.ts:15
size	abstract	number	-	Key.size	src/domain/models/keyManagement/Key.ts:14
to	abstract	{ Buffer: () => Buffer; String: (encoding?: BufferEncoding) => string; }	-	Key.to	src/domain/models/keyManagement/Key.ts:16
to.Buffer	public	() => Buffer	-	-	src/domain/models/keyManagement/exportable/ExportableKey.ts:31
to.String	public	(encoding?: BufferEncoding) => string	-	-	src/domain/models/keyManagement/exportable/ExportableKey.ts:32
type	abstract	KeyTypes	-	Key.type	src/domain/models/keyManagement/Key.ts:12
uuid	readonly	string	Universally Unique Identifier. should be unique across all items.	-	src/domain/models/keyManagement/PrivateKey.ts:9

Accessors

alg

Get Signature

get alg(): JWT_ALG

Defined in: src/domain/models/keyManagement/Key.ts:25

Returns

JWT_ALG

Inherited from

Key.alg

---

curve

Get Signature

get curve(): string

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

Returns

string

Overrides

Key.curve

---

index

Get Signature

get index(): number | undefined

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

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

Returns

number | undefined

---

value

Get Signature

get value(): Uint8Array<ArrayBuffer>

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

Returns

Uint8Array<ArrayBuffer>

Methods

canVerify()

canVerify(): this is VerifiableKey

Defined in: src/domain/models/keyManagement/Key.ts:53

Returns

this is VerifiableKey

Inherited from

Key.canVerify

---

getEncoded()

abstract getEncoded(): Uint8Array

Defined in: src/domain/models/keyManagement/Key.ts:18

Returns

Uint8Array

Inherited from

Key.getEncoded

---

getProperty()

getProperty(name: string): string | undefined

Defined in: src/domain/models/keyManagement/Key.ts:57

Parameters

Parameter	Type
name	string

Returns

string | undefined

Inherited from

Key.getProperty

---

isCurve()

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

Defined in: src/domain/models/keyManagement/Key.ts:61

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
curve	string

Returns

this is T

Inherited from

Key.isCurve

---

isDerivable()

isDerivable(): this is DerivableKey

Defined in: src/domain/models/keyManagement/Key.ts:37

Returns

this is DerivableKey

Inherited from

Key.isDerivable

---

isExportable()

isExportable(): this is All

Defined in: src/domain/models/keyManagement/Key.ts:41

Returns

this is All

Inherited from

Key.isExportable

---

isSignable()

isSignable(): this is SignableKey

Defined in: src/domain/models/keyManagement/Key.ts:45

Returns

this is SignableKey

Inherited from

Key.isSignable

---

isStorable()

isStorable(): this is StorableKey

Defined in: src/domain/models/keyManagement/Key.ts:49

Returns

this is StorableKey

Inherited from

Key.isStorable

---

publicKey()

abstract publicKey(): PublicKey

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

Returns

PublicKey