modules_verifiable_credentials.VerifiableCredentialsServiceBase.md

Class: VerifiableCredentialsServiceBase

modules/verifiable-credentials.VerifiableCredentialsServiceBase

Table of contents

Constructors

• constructor

Methods

• createPresentation
• createRoleVC
• createVerifiablePresentation
• initiateExchange
• verify
• create

Constructors

constructor

• new VerifiableCredentialsServiceBase(_signerService, _storage)

Parameters

Name	Type
_signerService	SignerService
_storage	default

Methods

createPresentation

▸ createPresentation(verifiableCredential, options?): Presentation

Parameters

Name	Type
verifiableCredential	VerifiableCredential<RoleCredentialSubject>[]
options?	CreatePresentationParams

Returns

Presentation

---

createRoleVC

▸ createRoleVC(credentialParams, proofOptions?): Promise<VerifiableCredential<RoleCredentialSubject>>

Parameters

Name	Type
credentialParams	RoleCredentialSubjectParams
proofOptions?	ProofOptions

Returns

Promise<VerifiableCredential<RoleCredentialSubject>>

---

createVerifiablePresentation

▸ createVerifiablePresentation(verifiableCredential, options?): Promise<VerifiablePresentation>

Parameters

Name	Type
verifiableCredential	VerifiableCredential<RoleCredentialSubject>[]
options?	ProofOptions

Returns

Promise<VerifiablePresentation>

---

initiateExchange

▸ initiateExchange(__namedParameters): Promise<any[]>

description The type of the exchange. Only vc-api exchanges currently supported.

Parameters

Name	Type
__namedParameters	ExchangeInvitation

Returns

Promise<any[]>

credentials query with matching verifiable presentations

---

verify

▸ verify<T>(vp, options?): any

Type parameters

Name	Type
T	extends ICredentialSubject

Parameters

Name	Type
vp	VerifiablePresentation | VerifiableCredential<T>
options?	ProofOptions

Returns

any

---

create

▸ Static create(signerService, storage): Promise<VerifiableCredentialsServiceBase>

Parameters

Name	Type
signerService	SignerService
storage	default

Returns

Promise<VerifiableCredentialsServiceBase>