Class Credential<PublicKey, Signature, SignatureParams>`Abstract`

Type Parameters

PublicKey
Signature
SignatureParams

Hierarchy (view full)

CredentialCommon<Signature>
- Credential

Index

Constructors

Properties

_version credentialStatus? schema signature subject topLevelFields

Accessors

Methods

getTopLevelField serializeForSigning toJSON toJSONWithJsonLdContext verify applyDefaultProofMetadataIfNeeded getSigType parseJSON validateProofType

Constructors

constructor

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

`Readonly`subject

subject: object | object[]

`Readonly`topLevelFields

topLevelFields: Map<string, unknown>

Accessors

version

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

Methods

getTopLevelField

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

serializeForSigning

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

toJSON

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

toJSONWithJsonLdContext

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

`Abstract`verify

verify(publicKey, signatureParams?): VerifyResult
Parameters
- publicKey: PublicKey
- OptionalsignatureParams: SignatureParams
Returns VerifyResult
- Defined in anonymous-credentials/credential.ts:33

`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
Inherited from CredentialCommon.applyDefaultProofMetadataIfNeeded
- Defined in anonymous-credentials/credential-common.ts:114

`Static`getSigType

getSigType(): SignatureType
Returns SignatureType
- Defined in anonymous-credentials/credential.ts:85

`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 CredentialCommon.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
Overrides CredentialCommon.validateProofType
- Defined in anonymous-credentials/credential.ts:78