Class Pollux

Implementation of PolluxInterface and responsible of handling credential related tasks

Export

Hierarchy

Pollux

Implements

Domain.Pollux

Index

Constructors

Properties

_anoncreds api castor

Accessors

Methods

extractAttachment extractCredentialFormatFromMessage extractDomainChallenge fetchCredentialDefinition isAnonCredsBody parseCredential processAnonCredsCredential processJWTCredential start

Constructors

constructor

new Pollux(castor, api?): Pollux
Parameters
- castor: Domain.Castor
- api: Api = ...
Returns Pollux
- Defined in src/pollux/Pollux.ts:31

Properties

`Private` _anoncreds

_anoncreds: undefined | AnoncredsLoader

`Private` api

api: Api = ...

`Private` castor

castor: Domain.Castor

Accessors

anoncreds

get anoncreds(): AnoncredsLoader
Returns AnoncredsLoader
- Defined in src/pollux/Pollux.ts:41

Methods

`Private` extractAttachment

extractAttachment(body, attachments): any
Parameters
- body: any
- attachments: AttachmentDescriptor[]
Returns any
- Defined in src/pollux/Pollux.ts:116

extractCredentialFormatFromMessage

extractCredentialFormatFromMessage(message): JWT | AnonCreds | Unknown
Parameters
- message: Message
Returns JWT | AnonCreds | Unknown
Implementation of Pollux.extractCredentialFormatFromMessage
- Defined in src/pollux/Pollux.ts:51

`Private` extractDomainChallenge

extractDomainChallenge(attachments): {
challenge?: string;
domain?: string;
}
Parameters
- attachments: AttachmentDescriptor[]
Returns {
challenge?: string;
domain?: string;
}
- Optional challenge?: string
- Optional domain?: string
- Defined in src/pollux/Pollux.ts:260

`Private` fetchCredentialDefinition

fetchCredentialDefinition(credentialDefinitionId): Promise<CredentialDefinition>
Parameters
- credentialDefinitionId: string
Returns Promise<CredentialDefinition>
- Defined in src/pollux/Pollux.ts:103

`Private` isAnonCredsBody

isAnonCredsBody(body): body is CredentialOffer
Parameters
- body: any
Returns body is CredentialOffer
- Defined in src/pollux/Pollux.ts:129

parseCredential

parseCredential(credentialBuffer, options?): Promise<AnonCredsCredential | JWTCredential>
Parameters
- credentialBuffer: Uint8Array
- Optional options: {
      credentialMetadata?: CredentialRequestMeta;
      linkSecret?: string;
      type: CredentialType;
      [name: string]: any;
  }
  - [name: string]: any
  - Optional credentialMetadata?: CredentialRequestMeta
  - Optional linkSecret?: string
  - type: CredentialType
Returns Promise<AnonCredsCredential | JWTCredential>
Implementation of Pollux.parseCredential
- Defined in src/pollux/Pollux.ts:200

processAnonCredsCredential

processAnonCredsCredential(offer, options): Promise<[CredentialRequest, CredentialRequestMeta]>
Parameters
- offer: Message
- options: CredentialRequestOptions
Returns Promise<[CredentialRequest, CredentialRequestMeta]>
Implementation of Pollux.processAnonCredsCredential
- Defined in src/pollux/Pollux.ts:167

processJWTCredential

processJWTCredential(offer, options?): Promise<string>
Parameters
- offer: Message
- options: CredentialRequestOptions = {}
Returns Promise<string>
Implementation of Pollux.processJWTCredential
- Defined in src/pollux/Pollux.ts:71

start

start(): Promise<void>
Returns Promise<void>
- Defined in src/pollux/Pollux.ts:36