Class BBSCredential

Hierarchy (view full)

Credential<BBSPublicKey, BBSSignature, BBSSignatureParams>
- BBSCredential

Index

Constructors

Properties

_version credentialStatus? schema signature subject topLevelFields

Accessors

Methods

getTopLevelField serializeForSigning toJSON toJSONWithJsonLdContext verify applyDefaultProofMetadataIfNeeded fromJSON getSigType parseJSON validateProofType

Constructors

constructor

new BBSCredential(version, schema, subject, topLevelFields, sig, credStatus?): BBSCredential
Parameters
- version: string
- schema: CredentialSchema
- subject: object
- topLevelFields: Map<string, unknown>
- sig: BBSSignature
- OptionalcredStatus: object
Returns BBSCredential
Inherited from Credential.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: BBSSignature

`Readonly`subject

subject: object | object[]

`Readonly`topLevelFields

topLevelFields: Map<string, unknown>

Accessors

version

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

Methods

getTopLevelField

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

serializeForSigning

serializeForSigning(): object
Returns object
Inherited from Credential.serializeForSigning
- Defined in anonymous-credentials/credential.ts:35

toJSON

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

toJSONWithJsonLdContext

toJSONWithJsonLdContext(): object
Returns object
Inherited from Credential.toJSONWithJsonLdContext
- Defined in anonymous-credentials/credential.ts:58

verify

verify(publicKey, signatureParams?): VerifyResult
Parameters
- publicKey: BBSPublicKey
- OptionalsignatureParams: BBSSignatureParams
Returns VerifyResult
Overrides Credential.verify
- Defined in anonymous-credentials/credential.ts:91

`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 Credential.applyDefaultProofMetadataIfNeeded
- Defined in anonymous-credentials/credential.ts:106

`Static`fromJSON

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

`Static`getSigType

getSigType(): SignatureType
Returns SignatureType
Overrides Credential.getSigType
- Defined in anonymous-credentials/credential.ts:130

`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 Credential.parseJSON
- Defined in anonymous-credentials/credential-common.ts:61

`Protected` `Static`validateProofType

validateProofType(typ): void
Protected
Ensure proof type is correct
Parameters
- typ: string
Returns void
Inherited from Credential.validateProofType
- Defined in anonymous-credentials/credential.ts:78