@hyperledger/identus-edge-agent-sdk / Exports / Pollux

Class: Pollux

Implementation of Pollux

Export

Pollux

Hierarchy

• Controller

  ↳ Pollux

Implements

• Pollux

Table of contents

Constructors

• constructor

Properties

• JWT
• SDJWT
• _anoncreds
• _jwe
• _pako
• api
• apollo
• castor
• state

Accessors

• anoncreds
• jwe

Methods

• _start
• _stop
• createAnoncredsPresentationSubmission
• createJWTPresentationSubmission
• createPresentationDefinitionRequest
• createPresentationProof
• createPresentationSubmission
• encode
• extractEncodedList
• extractVerificationStatusFromCredential
• extractVerificationStatusFromResponse
• fetchCredentialDefinition
• fetchRevocationRegistry
• fetchSchema
• getDescriptorItems
• getSigningKid
• isCredentialRevoked
• isOfferPayload
• isPresentationDefinitionRequestType
• parseCredential
• parsePresentationSubmission
• processCredentialOffer
• revealCredentialFields
• start
• stop
• validPresentationSubmissionOptions
• validateInputDescriptor
• validatePresentationDefinitionOptions
• verifyPresentationSubmission
• verifyPresentationSubmissionAnoncreds
• verifyPresentationSubmissionJWT
• verifyRevocationProof

Constructors

constructor

• new Pollux(apollo, castor, api?, JWT?, SDJWT?): Pollux

Parameters

Name	Type
apollo	Apollo
castor	Castor
api	Api
JWT	JWT
SDJWT	SDJWT

Returns

Pollux

Overrides

Controller.constructor

Defined in

src/pollux/Pollux.ts:83

Properties

JWT

• Private JWT: JWT

Defined in

src/pollux/Pollux.ts:87

---

SDJWT

• Private SDJWT: SDJWT

Defined in

src/pollux/Pollux.ts:88

---

_anoncreds

• Private _anoncreds: undefined | AnoncredsLoader

Defined in

src/pollux/Pollux.ts:79

---

_jwe

• Private _jwe: undefined | __module

Defined in

src/pollux/Pollux.ts:80

---

_pako

• Private _pako: typeof Pako = pako

Defined in

src/pollux/Pollux.ts:81

---

api

• Private api: Api

Defined in

src/pollux/Pollux.ts:86

---

apollo

• Private apollo: Apollo

Defined in

src/pollux/Pollux.ts:84

---

castor

• Private castor: Castor

Defined in

src/pollux/Pollux.ts:85

---

state

• state: State = State.STOPPED

current status of the entity

Inherited from

Controller.state

Defined in

src/domain/protocols/Startable.ts:42

Accessors

anoncreds

• get anoncreds(): AnoncredsLoader

Returns

AnoncredsLoader

Defined in

src/pollux/Pollux.ts:93

---

jwe

• get jwe(): __module

Returns

__module

Defined in

src/pollux/Pollux.ts:100

Methods

_start

▸ _start(): Promise<void>

internal method to define specific startup routine

used by start() internally

implement with protected to keep hidden from class interface

Returns

Promise<void>

Overrides

Controller._start

Defined in

src/pollux/Pollux.ts:107

---

_stop

▸ _stop(): Promise<void>

internal method to define teardown routine

used by stop() internally

implement with protected to keep hidden from class interface

Returns

Promise<void>

Overrides

Controller._stop

Defined in

src/pollux/Pollux.ts:116

---

createAnoncredsPresentationSubmission

▸ createAnoncredsPresentationSubmission(presentationDefinitionRequest, credential, linkSecret): Promise<PresentationType>

Parameters

Name	Type
presentationDefinitionRequest	PresentationRequestType
credential	AnonCredsCredential
linkSecret	LinkSecret

Returns

Promise<PresentationType>

Defined in

src/pollux/Pollux.ts:487

---

createJWTPresentationSubmission

▸ createJWTPresentationSubmission(presentationDefinitionRequest, credential, privateKey, options?): Promise<JWTPresentationSubmission>

Parameters

Name	Type
presentationDefinitionRequest	any
credential	Credential
privateKey	PrivateKey
options?	Object
options.challenge?	string
options.domain?	string
options.presentationFrame?	boolean | Record<number, boolean> |

Returns

Promise<JWTPresentationSubmission>

Defined in

src/pollux/Pollux.ts:390

---

createPresentationDefinitionRequest

▸ createPresentationDefinitionRequest<Type>(type, presentationClaims, presentationOptions): Promise<PresentationDefinitionRequest<Type>>

Creates a PresentationDefinitionRequest object for oob Verifications

Type parameters

Name	Type
Type	extends CredentialType = JWT

Parameters

Name	Type
type	Type
presentationClaims	PresentationClaims<Type>
presentationOptions	PresentationOptions

Returns

Promise<PresentationDefinitionRequest<Type>>

Implementation of

Pollux.createPresentationDefinitionRequest

Defined in

src/pollux/Pollux.ts:598

---

createPresentationProof

▸ createPresentationProof(presentationRequest, credential, options): Promise<string>

Process a PresentationRequest with Credential to create a Presentation.

Parameters

Name	Type	Description
presentationRequest	PresentationRequest<any, unknown>
credential	Credential
options	options	object containing necessary metadata

Returns

Promise<string>

dependent on the CredentialType

Throws

Implementation of

Pollux.createPresentationProof

Defined in

src/pollux/Pollux.ts:1260

---

createPresentationSubmission

▸ createPresentationSubmission<Type>(presentationDefinitionRequest, credential, privateKey?, options?): Promise<PresentationSubmission<Type>>

Type parameters

Name	Type
Type	extends CredentialType = JWT

Parameters

Name	Type
presentationDefinitionRequest	PresentationDefinitionRequest<Type>
credential	Credential
privateKey?	PrivateKey | LinkSecret
options?	Object
options.challenge?	string
options.domain?	string
options.presentationFrame?	boolean | Record<number, boolean> |

Returns

Promise<PresentationSubmission<Type>>

Implementation of

Pollux.createPresentationSubmission

Defined in

src/pollux/Pollux.ts:507

---

encode

▸ encode(data): Promise<Buffer>

Parameters

Name	Type
data	any

Returns

Promise<Buffer>

Defined in

src/pollux/Pollux.ts:211

---

extractEncodedList

▸ extractEncodedList(body): Uint8Array

Parameters

Name	Type
body	JWTStatusListResponse

Returns

Uint8Array

Defined in

src/pollux/Pollux.ts:201

---

extractVerificationStatusFromCredential

▸ extractVerificationStatusFromCredential(credentialStatus): credentialStatus is JWTRevocationStatus

Parameters

Name	Type
credentialStatus	any

Returns

credentialStatus is JWTRevocationStatus

Defined in

src/pollux/Pollux.ts:194

---

extractVerificationStatusFromResponse

▸ extractVerificationStatusFromResponse(credentialStatus): boolean

Parameters

Name	Type
credentialStatus	any

Returns

boolean

Defined in

src/pollux/Pollux.ts:187

---

fetchCredentialDefinition

▸ fetchCredentialDefinition(credentialDefinitionId): Promise<CredentialDefinitionType>

handle the retrieval of a Credential Definition

Parameters

Name	Type
credentialDefinitionId	string

Returns

Promise<CredentialDefinitionType>

Defined in

src/pollux/Pollux.ts:1182

---

fetchRevocationRegistry

▸ fetchRevocationRegistry(revocationStatus): Promise<JWTStatusListResponse>

Parameters

Name	Type
revocationStatus	JWTRevocationStatus

Returns

Promise<JWTStatusListResponse>

Defined in

src/pollux/Pollux.ts:315

---

fetchSchema

▸ fetchSchema(schemaURI): Promise<CredentialSchemaType>

handle the retrieval of a Schema definition

Parameters

Name	Type	Description
schemaURI	string	URI used to retrieve the Schema definition

Returns

Promise<CredentialSchemaType>

Defined in

src/pollux/Pollux.ts:1199

---

getDescriptorItems

▸ getDescriptorItems(inputDescriptors, credential): DescriptorItem[]

Parameters

Name	Type
inputDescriptors	InputDescriptor[]
credential	Credential

Returns

DescriptorItem[]

Defined in

src/pollux/Pollux.ts:363

---

getSigningKid

▸ getSigningKid(did, privateKey): Promise<undefined | string>

try to match the privateKey with a dids verificationMethod returning the relevant key id

Parameters

Name	Type
did	DID
privateKey	PrivateKey

Returns

Promise<undefined | string>

kid (key identifier) // ??? replaced by CreateJWT task

Defined in

src/pollux/Pollux.ts:1344

---

isCredentialRevoked

▸ isCredentialRevoked(credential): Promise<boolean>

Parameters

Name	Type
credential	Credential

Returns

Promise<boolean>

Implementation of

Pollux.isCredentialRevoked

Defined in

src/pollux/Pollux.ts:329

---

isOfferPayload

▸ isOfferPayload<Type>(offer, type): offer is CredentialOfferJWTBasePayload

Type parameters

Name	Type
Type	extends CredentialType

Parameters

Name	Type
offer	any
type	Type

Returns

offer is CredentialOfferJWTBasePayload

Defined in

src/pollux/Pollux.ts:1047

---

isPresentationDefinitionRequestType

▸ isPresentationDefinitionRequestType<Type>(request, type): request is PresentationDefinitionRequest<Type>

Type parameters

Name	Type
Type	extends CredentialType = JWT

Parameters

Name	Type
request	PresentationDefinitionRequest<Type>
type	Type

Returns

request is PresentationDefinitionRequest<Type>

Defined in

src/pollux/Pollux.ts:355

---

parseCredential

▸ parseCredential(credentialBuffer, options?): Promise<AnonCredsCredential | JWTCredential | SDJWTCredential>

Parameters

Name	Type
credentialBuffer	Uint8Array
options?	Object
options.credentialMetadata?	CredentialRequestMetadataType
options.linkSecret?	string
options.type	CredentialType

Returns

Promise<AnonCredsCredential | JWTCredential | SDJWTCredential>

Implementation of

Pollux.parseCredential

Defined in

src/pollux/Pollux.ts:1208

---

parsePresentationSubmission

▸ parsePresentationSubmission<Type>(data, type): data is PresentationSubmission<Type>

Type parameters

Name	Type
Type	extends CredentialType = JWT

Parameters

Name	Type
data	any
type	Type

Returns

data is PresentationSubmission<Type>

Defined in

src/pollux/Pollux.ts:558

---

processCredentialOffer

▸ processCredentialOffer<Types>(offer, options): Promise<ProcessedCredentialOfferPayloads[Types]>

Type parameters

Name	Type
Types	extends CredentialOfferTypes

Parameters

Name	Type
offer	CredentialOfferPayloads[Types]
options	CredentialRequestOptions

Returns

Promise<ProcessedCredentialOfferPayloads[Types]>

Implementation of

Pollux.processCredentialOffer

Defined in

src/pollux/Pollux.ts:1095

---

revealCredentialFields

▸ revealCredentialFields(credential, fields, linkSecret?): Promise<Record<string, any>>

Parameters

Name	Type
credential	Credential
fields	string[]
linkSecret?	string

Returns

Promise<Record<string, any>>

Implementation of

Pollux.revealCredentialFields

Defined in

src/pollux/Pollux.ts:118

---

start

▸ start(): Promise<State>

handle the startup of an entity

updates state according to lifecycle

Returns

Promise<State>

Inherited from

Controller.start

Defined in

src/domain/protocols/Startable.ts:62

---

stop

▸ stop(): Promise<State>

handle the teardown of an entity

updates state according to lifecycle

Returns

Promise<State>

Inherited from

Controller.stop

Defined in

src/domain/protocols/Startable.ts:72

---

validPresentationSubmissionOptions

▸ validPresentationSubmissionOptions<Response, Type>(options, type): options is Response

Type parameters

Name	Type
Response	extends options
Type	extends CredentialType = JWT

Parameters

Name	Type
options	any
type	Type

Returns

options is Response

Defined in

src/pollux/Pollux.ts:747

---

validateInputDescriptor

▸ validateInputDescriptor(vc, descriptorMapper, inputDescriptor): void

Parameters

Name	Type
vc	any
descriptorMapper	DescriptorPath
inputDescriptor	undefined | InputDescriptor

Returns

void

Defined in

src/pollux/Pollux.ts:775

---

validatePresentationDefinitionOptions

▸ validatePresentationDefinitionOptions(type, options): PresentationJWTOptions

Parameters

Name	Type
type	CredentialType
options	AnoncredsPresentationOptions | JWTPresentationOptions | SDJWPresentationOptions

Returns

PresentationJWTOptions

Defined in

src/pollux/Pollux.ts:565

---

verifyPresentationSubmission

▸ verifyPresentationSubmission(presentationSubmission, options): Promise<boolean>

Process a PresentationSubmission, resolve the issuer did and verify the credential and the holder signature

Parameters

Name	Type	Description
presentationSubmission	PresentationType	-
options	Anoncreds	object containing necessary metadata

Returns

Promise<boolean>

true if the submission is valid or false if it is not

Implementation of

Pollux.verifyPresentationSubmission

Defined in

src/pollux/Pollux.ts:1002

▸ verifyPresentationSubmission(presentationSubmission, options): Promise<boolean>

Parameters

Name	Type
presentationSubmission	JWTPresentationSubmission
options	JWT

Returns

Promise<boolean>

Implementation of

Pollux.verifyPresentationSubmission

Defined in

src/pollux/Pollux.ts:1003

▸ verifyPresentationSubmission(presentationSubmission, options): Promise<boolean>

Parameters

Name	Type
presentationSubmission	JWTPresentationSubmission
options	SDJWT

Returns

Promise<boolean>

Implementation of

Pollux.verifyPresentationSubmission

Defined in

src/pollux/Pollux.ts:1004

---

verifyPresentationSubmissionAnoncreds

▸ verifyPresentationSubmissionAnoncreds(presentationSubmission, options): Promise<boolean>

Parameters

Name	Type
presentationSubmission	PresentationType
options	Anoncreds

Returns

Promise<boolean>

Defined in

src/pollux/Pollux.ts:971

---

verifyPresentationSubmissionJWT

▸ verifyPresentationSubmissionJWT(presentationSubmission, options): Promise<boolean>

Parameters

Name	Type
presentationSubmission	JWTPresentationSubmission
options	JWT

Returns

Promise<boolean>

Defined in

src/pollux/Pollux.ts:836

▸ verifyPresentationSubmissionJWT(presentationSubmission, options): Promise<boolean>

Parameters

Name	Type
presentationSubmission	JWTPresentationSubmission
options	SDJWT

Returns

Promise<boolean>

Defined in

src/pollux/Pollux.ts:837

---

verifyRevocationProof

▸ verifyRevocationProof(revocation, statusListIndex): Promise<boolean>

Parameters

Name	Type
revocation	JWTStatusListResponse
statusListIndex	number

Returns

Promise<boolean>

Defined in

src/pollux/Pollux.ts:243