Class Credential

The credential contains information which are used to create presentations. It must be kept secret.

Hierarchy

WasmData
- Credential

Index

Constructors

constructor

Methods

Constructors

constructor

new Credential(wasmData: string): Credential

Inherited from WasmData.constructor
- Defined in src/types/Wasm.ts:53
Parameters
- wasmData: string
Returns Credential

Methods

getDate

getDate(): Date

- Defined in src/claim/Credential.ts:123
Returns the date when this Credential has been updated the last time.

throws

Invalid credential If the credential does not have an Updated field.

Returns Date

The date of the Credential's last update as ISO string.

getUpdateCounter

getUpdateCounter(): number

- Defined in src/claim/Credential.ts:103
Returns the number of updates done. Combining this method with getLatestAccumulator in updateFromChain, it shows how many updates of this Credential would be required to be up to date.

throws

Invalid credential If the credential does not have an updateCounter field.

Returns number

The number of accumulator updates done with this credential.

parse

parse<T>(): ICredential<T>

Overrides WasmData.parse
- Defined in src/claim/Credential.ts:136
Type parameters
- T
Returns ICredential<T>

toString

toString(): string

Inherited from WasmData.toString
- Defined in src/types/Wasm.ts:73
Getter for string of WASM data.

Returns string

A string of the WASM data which can be serialized.

update

update(__namedParameters: { accumulators: Accumulator[]; attesterPubKey: AttesterPublicKey }): Promise<Credential>

- Defined in src/claim/Credential.ts:48
This methods updates a Credential using a list of new Accumulators. After an Attester revoked an Attestation all Credentials need to be updated.

Parameters
- __namedParameters: { accumulators: Accumulator[]; attesterPubKey: AttesterPublicKey }
  - accumulators: Accumulator[]
  - attesterPubKey: AttesterPublicKey
Returns Promise<Credential>

An updated Credential.

updateFromChain

updateFromChain(__namedParameters: { attesterChainAddress: string; attesterPubKey: AttesterPublicKey; endIndex: undefined | number }): Promise<Credential>

- Defined in src/claim/Credential.ts:74
This methods updates a Credential. For that it pulls all Accumulators up to endIndex from the chain.

Parameters
- __namedParameters: { attesterChainAddress: string; attesterPubKey: AttesterPublicKey; endIndex: undefined | number }
  - attesterChainAddress: string
  - attesterPubKey: AttesterPublicKey
  - endIndex: undefined | number
Returns Promise<Credential>

An updated Credential.

updateSingle

updateSingle(__namedParameters: { accumulator: Accumulator; attesterPubKey: AttesterPublicKey }): Promise<Credential>

- Defined in src/claim/Credential.ts:23
This methods updates a Credential using a new Accumulator. After an attester revoked an attestation all credentials need to be updated.

Parameters
- __namedParameters: { accumulator: Accumulator; attesterPubKey: AttesterPublicKey }
  - accumulator: Accumulator
  - attesterPubKey: AttesterPublicKey
Returns Promise<Credential>

An updated Credential.

Generated using TypeDoc