Class BBSPlusBlindedCredential

A blinded credential created by the signer. Has to be converted to a (unblinded) credential

Hierarchy (view full)

BlindedCredential<BBSPlusBlindSignatureG1>
- BBSPlusBlindedCredential

Index

Constructors

constructor

new BBSPlusBlindedCredential(version, schema, subject, topLevelFields, sig, credStatus?): BBSPlusBlindedCredential
Parameters
- version: string
- schema: CredentialSchema
- subject: object
- topLevelFields: Map<string, unknown>
- sig: BBSPlusBlindSignatureG1
- OptionalcredStatus: object
Returns BBSPlusBlindedCredential
Inherited from BlindedCredential.constructor
- Defined in anonymous-credentials/credential-common.ts:19

Properties

_version

_version: string

`Optional` `Readonly`credentialStatus

credentialStatus?: object

`Readonly`schema

schema: CredentialSchema

Each credential references the schema which is included as an attribute

`Readonly`signature

signature: BBSPlusBlindSignatureG1

`Readonly`subject

subject: object | object[]

`Readonly`topLevelFields

topLevelFields: Map<string, unknown>

Accessors

version

get version(): string
Returns string
Inherited from BlindedCredential.version
- Defined in anonymous-credentials/versioned.ts:11
set version(version): void
Parameters
- version: string
Returns void
Inherited from BlindedCredential.version
- Defined in anonymous-credentials/versioned.ts:15

Methods

getTopLevelField

getTopLevelField(name): unknown
Parameters
- name: string
Returns unknown
Inherited from BlindedCredential.getTopLevelField
- Defined in anonymous-credentials/credential-common.ts:35

`Protected`getUpdatedAttributes

getUpdatedAttributes(proofType, blindedSubject, blindedStatus?, blindedTopLevelFields?): [object | object[], undefined | object, Map<string, unknown>]
Parameters
- proofType: string
- blindedSubject: object | object[]
- OptionalblindedStatus: object
- OptionalblindedTopLevelFields: Map<string, unknown>
Returns [object | object[], undefined | object, Map<string, unknown>]
Inherited from BlindedCredential.getUpdatedAttributes
- Defined in anonymous-credentials/blinded-credential.ts:61

`Protected`getUpdatedStatus

getUpdatedStatus(blindedStatus?): undefined | object
Parameters
- OptionalblindedStatus: object
Returns undefined | object
Inherited from BlindedCredential.getUpdatedStatus
- Defined in anonymous-credentials/blinded-credential.ts:53

`Protected`getUpdatedSubject

getUpdatedSubject(blindedSubject): object | object[]
Merge blinded and unblinded subject to create the subject of the final credential
Parameters
- blindedSubject: object | object[]
Returns object | object[]
Inherited from BlindedCredential.getUpdatedSubject
- Defined in anonymous-credentials/blinded-credential.ts:28

toCredential

toCredential(blindedSubject, blinding, blindedStatus?, blindedTopLevelFields?): BBSPlusCredential
Convert to unblinded credential which can be verified with the public key
Parameters
- blindedSubject: object | object[]
- blinding: BBSPlusBlinding
  blinding used while creating the request
- OptionalblindedStatus: object
- OptionalblindedTopLevelFields: Map<string, unknown>
  Any top level fields that are blinded. Ensure that these are not set by the issuer.
Returns BBSPlusCredential
- Defined in anonymous-credentials/blinded-credential.ts:169

toJSON

toJSON(): object
Returns object
Inherited from BlindedCredential.toJSON
- Defined in anonymous-credentials/credential-common.ts:43

`Protected`updateProofType

updateProofType(newProofType): Map<string, unknown>
Protected
Change the proof type from "blinded" to "unblinded"
Parameters
- newProofType: any
Returns Map<string, unknown>
Inherited from BlindedCredential.updateProofType
- Defined in anonymous-credentials/blinded-credential.ts:92

`Static`applyDefaultProofMetadataIfNeeded

applyDefaultProofMetadataIfNeeded(s): void
A credential will have at least some proof metadata like the type or purpose. This adds those defaults to the given object.
Parameters
- s: object
Returns void
Overrides BlindedCredential.applyDefaultProofMetadataIfNeeded
- Defined in anonymous-credentials/blinded-credential.ts:201

`Static`fromJSON

fromJSON(j, proofValue?): BBSPlusBlindedCredential
Parameters
- j: object
- OptionalproofValue: string
Returns BBSPlusBlindedCredential
- Defined in anonymous-credentials/blinded-credential.ts:185

`Protected` `Static`parseJSON

parseJSON(j, proofValue?): [string, CredentialSchema, object, Map<string, unknown>, Uint8Array, object]
Parameters
- j: object
- OptionalproofValue: string
Returns [string, CredentialSchema, object, Map<string, unknown>, Uint8Array, object]
Inherited from BlindedCredential.parseJSON
- Defined in anonymous-credentials/credential-common.ts:61

`Protected` `Static`validateProofType

validateProofType(typ): void
Parameters
- typ: string
Returns void
Inherited from BlindedCredential.validateProofType
- Defined in anonymous-credentials/blinded-credential.ts:79

Class BBSPlusBlindedCredential

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns BBSPlusBlindedCredential

Properties

_version

Optional ReadonlycredentialStatus

Readonlyschema

Readonlysignature

Readonlysubject

ReadonlytopLevelFields

Accessors

version

Returns string

Parameters

Returns void

Methods

getTopLevelField

Parameters

Returns unknown

ProtectedgetUpdatedAttributes

Parameters

Returns [object | object[], undefined | object, Map<string, unknown>]

ProtectedgetUpdatedStatus

Parameters

Returns undefined | object

ProtectedgetUpdatedSubject

Parameters

Returns object | object[]

toCredential

Parameters

Returns BBSPlusCredential

toJSON

Returns object

ProtectedupdateProofType

Parameters

Returns Map<string, unknown>

StaticapplyDefaultProofMetadataIfNeeded

Parameters

Returns void

StaticfromJSON

Parameters

Returns BBSPlusBlindedCredential

Protected StaticparseJSON

Parameters

Returns [string, CredentialSchema, object, Map<string, unknown>, Uint8Array, object]

Protected StaticvalidateProofType

Parameters

Returns void

Settings

On This Page

`Optional` `Readonly`credentialStatus

`Readonly`schema

`Readonly`signature

`Readonly`subject

`Readonly`topLevelFields

`Protected`getUpdatedAttributes

`Protected`getUpdatedStatus

`Protected`getUpdatedSubject

`Protected`updateProofType

`Static`applyDefaultProofMetadataIfNeeded

`Static`fromJSON

`Protected` `Static`parseJSON

`Protected` `Static`validateProofType