feat: support caching for anoncreds resolving (#2550)

Signed-off-by: Timo Glastra <[email protected]>

Author: TimoGlastra

packages/anoncreds/src/AnonCredsApi.ts

@@ -47,7 +47,7 @@ import {
   AnonCredsIssuerServiceSymbol,
 } from './services'
 import { AnonCredsRegistryService } from './services/registry/AnonCredsRegistryService'
-import type { Extensible } from './services/registry/base'
+import type { AnonCredsResolutionOptions, Extensible } from './services/registry/base'
 import { dateToTimestamp, storeLinkSecret } from './utils'
 
 @injectable()
@@ -126,30 +126,8 @@ export class AnonCredsApi {
    * Retrieve a {@link AnonCredsSchema} from the registry associated
    * with the {@link schemaId}
    */
-  public async getSchema(schemaId: string): Promise<GetSchemaReturn> {
-    const failedReturnBase = {
-      resolutionMetadata: {
-        error: 'error',
-        message: `Unable to resolve schema ${schemaId}`,
-      },
-      schemaId,
-      schemaMetadata: {},
-    }
-
-    const registry = this.findRegistryForIdentifier(schemaId)
-    if (!registry) {
-      failedReturnBase.resolutionMetadata.error = 'unsupportedAnonCredsMethod'
-      failedReturnBase.resolutionMetadata.message = `Unable to resolve schema ${schemaId}: No registry found for identifier ${schemaId}`
-      return failedReturnBase
-    }
-
-    try {
-      const result = await registry.getSchema(this.agentContext, schemaId)
-      return result
-    } catch (error) {
-      failedReturnBase.resolutionMetadata.message = `Unable to resolve schema ${schemaId}: ${error.message}`
-      return failedReturnBase
-    }
+  public async getSchema(schemaId: string, options: AnonCredsResolutionOptions = {}): Promise<GetSchemaReturn> {
+    return this.anonCredsRegistryService.getSchema(this.agentContext, schemaId, options)
   }
 
   public async registerSchema<T extends Extensible = Extensible>(
@@ -199,30 +177,11 @@ export class AnonCredsApi {
    * Retrieve a {@link GetCredentialDefinitionReturn} from the registry associated
    * with the {@link credentialDefinitionId}
    */
-  public async getCredentialDefinition(credentialDefinitionId: string): Promise<GetCredentialDefinitionReturn> {
-    const failedReturnBase = {
-      resolutionMetadata: {
-        error: 'error',
-        message: `Unable to resolve credential definition ${credentialDefinitionId}`,
-      },
-      credentialDefinitionId,
-      credentialDefinitionMetadata: {},
-    }
-
-    const registry = this.findRegistryForIdentifier(credentialDefinitionId)
-    if (!registry) {
-      failedReturnBase.resolutionMetadata.error = 'unsupportedAnonCredsMethod'
-      failedReturnBase.resolutionMetadata.message = `Unable to resolve credential definition ${credentialDefinitionId}: No registry found for identifier ${credentialDefinitionId}`
-      return failedReturnBase
-    }
-
-    try {
-      const result = await registry.getCredentialDefinition(this.agentContext, credentialDefinitionId)
-      return result
-    } catch (error) {
-      failedReturnBase.resolutionMetadata.message = `Unable to resolve credential definition ${credentialDefinitionId}: ${error.message}`
-      return failedReturnBase
-    }
+  public async getCredentialDefinition(
+    credentialDefinitionId: string,
+    options: AnonCredsResolutionOptions = {}
+  ): Promise<GetCredentialDefinitionReturn> {
+    return this.anonCredsRegistryService.getCredentialDefinition(this.agentContext, credentialDefinitionId, options)
   }
 
   public async registerCredentialDefinition<T extends Extensible>(
@@ -251,17 +210,7 @@ export class AnonCredsApi {
       if (isFullCredentialDefinitionInput(options.credentialDefinition)) {
         credentialDefinition = options.credentialDefinition
       } else {
-        // If the input credential definition is not a full credential definition, we need to create one first
-        // There's a caveat to when the input contains a full credential, that the credential definition private
-        // and key correctness proof must already be stored in the wallet
-        const schemaRegistry = this.findRegistryForIdentifier(options.credentialDefinition.schemaId)
-        if (!schemaRegistry) {
-          failedReturnBase.credentialDefinitionState.reason = `Unable to register credential definition. No registry found for schemaId ${options.credentialDefinition.schemaId}`
-          return failedReturnBase
-        }
-
-        const schemaResult = await schemaRegistry.getSchema(this.agentContext, options.credentialDefinition.schemaId)
-
+        const schemaResult = await this.getSchema(options.credentialDefinition.schemaId)
         if (!schemaResult.schema) {
           failedReturnBase.credentialDefinitionState.reason = `error resolving schema with id ${options.credentialDefinition.schemaId}: ${schemaResult.resolutionMetadata.error} ${schemaResult.resolutionMetadata.message}`
           return failedReturnBase
@@ -275,12 +224,6 @@ export class AnonCredsApi {
             tag: options.credentialDefinition.tag,
             supportRevocation: options.options.supportRevocation,
             schema: schemaResult.schema,
-          },
-          // NOTE: indy-sdk support has been removed from main repo, but keeping
-          // this in place to allow the indy-sdk to still be used as a custom package for some time
-          // FIXME: Indy SDK requires the schema seq no to be passed in here. This is not ideal.
-          {
-            indyLedgerSchemaSeqNo: schemaResult.schemaMetadata.indyLedgerSeqNo,
           }
         )
 
@@ -328,31 +271,14 @@ export class AnonCredsApi {
    * with the {@link revocationRegistryDefinitionId}
    */
   public async getRevocationRegistryDefinition(
-    revocationRegistryDefinitionId: string
+    revocationRegistryDefinitionId: string,
+    options: AnonCredsResolutionOptions = {}
   ): Promise<GetRevocationRegistryDefinitionReturn> {
-    const failedReturnBase = {
-      resolutionMetadata: {
-        error: 'error',
-        message: `Unable to resolve revocation registry ${revocationRegistryDefinitionId}`,
-      },
+    return this.anonCredsRegistryService.getRevocationRegistryDefinition(
+      this.agentContext,
       revocationRegistryDefinitionId,
-      revocationRegistryDefinitionMetadata: {},
-    }
-
-    const registry = this.findRegistryForIdentifier(revocationRegistryDefinitionId)
-    if (!registry) {
-      failedReturnBase.resolutionMetadata.error = 'unsupportedAnonCredsMethod'
-      failedReturnBase.resolutionMetadata.message = `Unable to resolve revocation registry ${revocationRegistryDefinitionId}: No registry found for identifier ${revocationRegistryDefinitionId}`
-      return failedReturnBase
-    }
-
-    try {
-      const result = await registry.getRevocationRegistryDefinition(this.agentContext, revocationRegistryDefinitionId)
-      return result
-    } catch (error) {
-      failedReturnBase.resolutionMetadata.message = `Unable to resolve revocation registry ${revocationRegistryDefinitionId}: ${error.message}`
-      return failedReturnBase
-    }
+      options
+    )
   }
 
   public async registerRevocationRegistryDefinition<T extends Extensible = Extensible>(
@@ -379,7 +305,7 @@ export class AnonCredsApi {
       return failedReturnBase
     }
 
-    const { credentialDefinition } = await registry.getCredentialDefinition(this.agentContext, credentialDefinitionId)
+    const { credentialDefinition } = await this.getCredentialDefinition(credentialDefinitionId)
 
     if (!credentialDefinition) {
       failedReturnBase.revocationRegistryDefinitionState.reason = `Unable to register revocation registry definition. No credential definition found for id ${credentialDefinitionId}`
@@ -436,34 +362,15 @@ export class AnonCredsApi {
    */
   public async getRevocationStatusList(
     revocationRegistryDefinitionId: string,
-    timestamp: number
+    timestamp: number,
+    options: Omit<AnonCredsResolutionOptions, 'useLocalRecord'> = {}
   ): Promise<GetRevocationStatusListReturn> {
-    const failedReturnBase = {
-      resolutionMetadata: {
-        error: 'error',
-        message: `Unable to resolve revocation status list for revocation registry ${revocationRegistryDefinitionId}`,
-      },
-      revocationStatusListMetadata: {},
-    }
-
-    const registry = this.findRegistryForIdentifier(revocationRegistryDefinitionId)
-    if (!registry) {
-      failedReturnBase.resolutionMetadata.error = 'unsupportedAnonCredsMethod'
-      failedReturnBase.resolutionMetadata.message = `Unable to resolve revocation status list for revocation registry ${revocationRegistryDefinitionId}: No registry found for identifier ${revocationRegistryDefinitionId}`
-      return failedReturnBase
-    }
-
-    try {
-      const result = await registry.getRevocationStatusList(
-        this.agentContext,
-        revocationRegistryDefinitionId,
-        timestamp
-      )
-      return result
-    } catch (error) {
-      failedReturnBase.resolutionMetadata.message = `Unable to resolve revocation status list for revocation registry ${revocationRegistryDefinitionId}: ${error.message}`
-      return failedReturnBase
-    }
+    return this.anonCredsRegistryService.getRevocationStatusList(
+      this.agentContext,
+      revocationRegistryDefinitionId,
+      timestamp,
+      options
+    )
   }
 
   public async registerRevocationStatusList<T extends Extensible = Extensible>(
@@ -486,10 +393,7 @@ export class AnonCredsApi {
       return failedReturnBase
     }
 
-    const { revocationRegistryDefinition } = await registry.getRevocationRegistryDefinition(
-      this.agentContext,
-      revocationRegistryDefinitionId
-    )
+    const { revocationRegistryDefinition } = await this.getRevocationRegistryDefinition(revocationRegistryDefinitionId)
 
     if (!revocationRegistryDefinition) {
       failedReturnBase.revocationStatusListState.reason = `Unable to register revocation status list. No revocation registry definition found for ${revocationRegistryDefinitionId}`
@@ -547,10 +451,7 @@ export class AnonCredsApi {
       return failedReturnBase
     }
 
-    const { revocationRegistryDefinition } = await registry.getRevocationRegistryDefinition(
-      this.agentContext,
-      revocationRegistryDefinitionId
-    )
+    const { revocationRegistryDefinition } = await this.getRevocationRegistryDefinition(revocationRegistryDefinitionId)
 
     if (!revocationRegistryDefinition) {
       failedReturnBase.revocationStatusListState.reason = `Unable to update revocation status list. No revocation registry definition found for ${revocationRegistryDefinitionId}`
@@ -559,7 +460,11 @@ export class AnonCredsApi {
 
     const { revocationStatusList: previousRevocationStatusList } = await this.getRevocationStatusList(
       revocationRegistryDefinitionId,
-      dateToTimestamp(new Date())
+      dateToTimestamp(new Date()),
+      // We want the latest state here.
+      {
+        useCache: false,
+      }
     )
 
     if (!previousRevocationStatusList) {

packages/anoncreds/src/services/registry/AnonCredsRegistry.ts

@@ -21,14 +21,28 @@ import type { GetSchemaReturn, RegisterSchemaOptions, RegisterSchemaReturn } fro
  */
 export interface AnonCredsRegistry {
   /**
-   * A name to identify the registry. This will be stored as part of the reigstered anoncreds objects to allow querying
-   * for created objects using a specific registry. Multilpe implementations can use the same name, but they should in that
+   * A name to identify the registry. This will be stored as part of the registered anoncreds objects to allow querying
+   * for created objects using a specific registry. Multiple implementations can use the same name, but they should in that
    * case also reference objects on the same networks.
    */
   methodName: string
 
   supportedIdentifier: RegExp
 
+  /**
+   * Whether this registry allows caching of resolved objects (as well as caching
+   * just created objects).
+   */
+  readonly allowsCaching?: boolean
+
+  /**
+   * Whether the resolver allows using a local created object from
+   * a record to resolve the object.
+   *
+   * @default false
+   */
+  readonly allowsLocalRecord?: boolean
+
   getSchema(agentContext: AgentContext, schemaId: string): Promise<GetSchemaReturn>
   registerSchema(agentContext: AgentContext, options: RegisterSchemaOptions): Promise<RegisterSchemaReturn>