diff --git a/src/domain/buildingBlocks/Pluto.ts b/src/domain/buildingBlocks/Pluto.ts index 28281b7e3..1c0b33c29 100644 --- a/src/domain/buildingBlocks/Pluto.ts +++ b/src/domain/buildingBlocks/Pluto.ts @@ -15,15 +15,24 @@ import { Anoncreds } from "../models/Anoncreds"; * */ export interface Pluto { + /** + * Store the AnonCreds Credential Metadata referencing its linkSecret name + */ storeCredentialMetadata( metadata: Anoncreds.CredentialRequestMeta, linkSecret: Anoncreds.LinkSecret ): Promise; + /** + * Fetch the AnonCreds Credential Metadata by its linkSecret name + */ fetchCredentialMetadata( linkSecretName: string ): Promise; + /** + * Pluto initialise function + */ start(): Promise; /** @@ -72,6 +81,9 @@ export interface Pluto { */ storeMediator(mediator: DID, host: DID, routing: DID): Promise; + /** + * Store a Credential into the Database + */ storeCredential(credential: Credential): Promise; /** @@ -184,10 +196,19 @@ export interface Pluto { */ getAllMediators(): Promise>; + /** + * Retrieve all the stored credentials + */ getAllCredentials(): Promise>; + /** + * Retrieve the anoncreds stored link secret by its name + */ getLinkSecret(linkSecretName?: string): Promise; + /** + * Store a new anoncreds linkSecret + */ storeLinkSecret( linkSecret: Anoncreds.LinkSecret, linkSecretName: string