@hyperledger/identus-sdk / Exports / SDJWTCredential

Class: SDJWTCredential

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

Hierarchy

• Credential

  ↳ SDJWTCredential

Implements

• ProvableCredential
• StorableCredential
• Storable

Table of contents

Constructors

• constructor

Properties

• claims
• core
• credentialType
• properties
• recoveryId
• uuid

Accessors

• id
• issuer
• revoked
• subject

Methods

• getProperty
• isProvable
• isRevoked
• isStorable
• presentation
• toStorable
• verifiableCredential
• fromJWS

Constructors

constructor

• new SDJWTCredential(object, claims, revoked?): SDJWTCredential

Parameters

Name	Type
object	SDJwt<Record<string, unknown>, Record<string, unknown>, kbHeader, kbPayload>
claims	Record<string, any>[]
revoked?	boolean

Returns

SDJWTCredential

Overrides

Credential.constructor

Defined in

src/pollux/models/SDJWTVerifiableCredential.ts:53

Properties

claims

• claims: Record<string, any>[] = []

Overrides

Credential.claims

Defined in

src/pollux/models/SDJWTVerifiableCredential.ts:50

---

core

• core: SDJwt<Record<string, unknown>, Record<string, unknown>, kbHeader, kbPayload>

Defined in

src/pollux/models/SDJWTVerifiableCredential.ts:51

---

credentialType

• credentialType: CredentialType = CredentialType.SDJWT

Overrides

Credential.credentialType

Defined in

src/pollux/models/SDJWTVerifiableCredential.ts:32

---

properties

• properties: Map<Claims | SDJWT_VP_PROPS, any>

Overrides

Credential.properties

Defined in

src/pollux/models/SDJWTVerifiableCredential.ts:49

---

recoveryId

• recoveryId: string = SDJWTVerifiableCredentialRecoveryId

Overrides

Credential.recoveryId

Defined in

src/pollux/models/SDJWTVerifiableCredential.ts:33

---

uuid

• uuid: string

Universally Unique Identifier. should be unique across all items.

Implementation of

Storable.uuid

Overrides

Credential.uuid

Defined in

src/pollux/models/SDJWTVerifiableCredential.ts:48

Accessors

id

• get id(): any

Returns

any

Overrides

Credential.id

Defined in

src/pollux/models/SDJWTVerifiableCredential.ts:35

---

issuer

• get issuer(): any

Returns

any

Overrides

Credential.issuer

Defined in

src/pollux/models/SDJWTVerifiableCredential.ts:39

---

revoked

• get revoked(): undefined | boolean

Returns

undefined | boolean

Defined in

src/pollux/models/SDJWTVerifiableCredential.ts:151

---

subject

• get subject(): any

Returns

any

Overrides

Credential.subject

Defined in

src/pollux/models/SDJWTVerifiableCredential.ts:43

Methods

getProperty

▸ getProperty(name): any

Parameters

Name	Type
name	string

Returns

any

Inherited from

Credential.getProperty

Defined in

src/domain/models/Credential.ts:17

---

isProvable

▸ isProvable(): this is ProvableCredential

Returns

this is ProvableCredential

Inherited from

Credential.isProvable

Defined in

src/domain/models/Credential.ts:21

---

isRevoked

▸ isRevoked(): boolean

Returns

boolean

Inherited from

Credential.isRevoked

Defined in

src/domain/models/Credential.ts:29

---

isStorable

▸ isStorable(): this is StorableCredential

Returns

this is StorableCredential

Inherited from

Credential.isStorable

Defined in

src/domain/models/Credential.ts:25

---

presentation

▸ presentation(): W3CVerifiablePresentation

Returns

W3CVerifiablePresentation

Implementation of

ProvableCredential.presentation

Defined in

src/pollux/models/SDJWTVerifiableCredential.ts:137

---

toStorable

▸ toStorable(): Object

Returns

Object

Name	Type
availableClaims?	string[]
credentialCreated?	string
credentialData	string
credentialSchema?	string
credentialUpdated?	string
id	string
issuer?	string
recoveryId	string
revoked?	boolean
subject?	string
validUntil?	string

Implementation of

StorableCredential.toStorable

Defined in

src/pollux/models/SDJWTVerifiableCredential.ts:155

---

verifiableCredential

▸ verifiableCredential(): unknown

Returns

unknown

Implementation of

ProvableCredential.verifiableCredential

Defined in

src/pollux/models/SDJWTVerifiableCredential.ts:133

---

fromJWS

▸ fromJWS<E>(jws, revoked?): SDJWTCredential

Type parameters

Name	Type
E	extends Record<string, any> = Record<string, any>

Parameters

Name	Type	Default value
jws	string	undefined
revoked	boolean	false

Returns

SDJWTCredential

Defined in

src/pollux/models/SDJWTVerifiableCredential.ts:171