modules_verifiable_credentials.md

Module: modules/verifiable-credentials

Table of contents

Classes

• VerifiableCredentialsServiceBase

Interfaces

• CreatePresentationParams
• InitiateExchangeResults
• IssuerFields
• ProofOptions
• RoleCredentialSubject
• RoleCredentialSubjectParams
• VerifyVerifiableCredentialResults

Variables

• verifiableCredentialEIP712Types
• verifiablePresentationEIP712Types
• verifiablePresentationWithCredentialEIP712Types

Functions

• getVerifiableCredentialsService
• isRoleCredential

Variables

verifiableCredentialEIP712Types

• Const verifiableCredentialEIP712Types: Object

Type declaration

Name	Type
CredentialSubject	{ name: string = 'id'; type: string = 'string' }[]
EIP712Domain	never[]
EWFRole	{ name: string = 'namespace'; type: string = 'string' }[]
IssuerFields	{ name: string = 'key'; type: string = 'string' }[]
Proof	{ name: string = '@context'; type: string = 'string' }[]
VerifiableCredential	{ name: string = '@context'; type: string = 'string[]' }[]

---

verifiablePresentationEIP712Types

• Const verifiablePresentationEIP712Types: Object

Type declaration

Name	Type
EIP712Domain	never[]
Proof	{ name: string = '@context'; type: string = 'string' }[]
VerifiablePresentation	{ name: string = '@context'; type: string = 'string[]' }[]

---

verifiablePresentationWithCredentialEIP712Types

• Const verifiablePresentationWithCredentialEIP712Types: Object

Type declaration

Name	Type
CredentialSubject	{ name: string = 'id'; type: string = 'string' }[]
EIP712Domain	never[]
EWFRole	{ name: string = 'namespace'; type: string = 'string' }[]
IssuerFields	{ name: string = 'key'; type: string = 'string' }[]
Proof	{ name: string = '@context'; type: string = 'string' }[]
VC712Domain	{ name: string = 'domain'; type: string = 'VC712DomainData' }[]
VC712DomainData	never[]
VC712DomainSchema	{ name: string = 'CredentialSubject'; type: string = 'VC712DomainTypedDataField[]' }[]
VC712DomainTypedDataField	{ name: string = 'name'; type: string = 'string' }[]
VCProof	{ name: string = '@context'; type: string = 'string' }[]
VerifiableCredential	{ name: string = '@context'; type: string = 'string[]' }[]
VerifiablePresentation	{ name: string = '@context'; type: string = 'string[]' }[]

Functions

getVerifiableCredentialsService

▸ getVerifiableCredentialsService(signerService, cacheClient): Promise<VerifiableCredentialsServiceBase>

Parameters

Name	Type
signerService	SignerService
cacheClient	CacheClient

Returns

Promise<VerifiableCredentialsServiceBase>

---

isRoleCredential

▸ isRoleCredential(credential): credential is VerifiableCredential<RoleCredentialSubject>

Parameters

Name	Type
credential	VerifiableCredential<ICredentialSubject>

Returns

credential is VerifiableCredential<RoleCredentialSubject>