Merge pull request #396 from docknetwork/last-trust-registry

Align with the latest Trust Registry implementation

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docknetwork/sdk",
-  "version": "7.4.0",
+  "version": "7.5.0",
   "main": "index.js",
   "license": "MIT",
   "repository": {

src/modules/trust-registry.js

@@ -1,5 +1,12 @@
 import { BTreeSet, BTreeMap } from '@polkadot/types';
-import { DidMethodKey, DockDid, typedHexDID } from '../utils/did';
+import { u8aToHex } from '@polkadot/util';
+import {
+  DidMethodKey,
+  DockDid,
+  typedHexDID,
+  typedHexDIDFromSubstrate,
+} from '../utils/did';
+import { isHexWithGivenByteSize } from '../utils/codec';
 import { getDidNonce, ensureMatchesPattern } from '../utils/misc';
 
 /**
@@ -18,6 +25,23 @@ export default class TrustRegistryModule {
     this.signAndSend = signAndSend;
   }
 
+  /**
+   * Returns Trust Registries information according to the supplied `by` argument.
+   * @param by
+   */
+  async registriesInfo(by) {
+    ensureMatchesPattern(this.constructor.TrustRegistriesInfoByPattern, by);
+
+    const registriesInfo = await this.api.rpc.trustRegistry.registriesInfoBy(by);
+
+    return Object.fromEntries(
+      [...registriesInfo.entries()].map(([id, info]) => [
+        id.toString(),
+        this.parseRegistryInfo(info),
+      ]),
+    );
+  }
+
   /**
    * Initializes Trust Registry with the supplied parameters.
    * @param convenerDid
@@ -48,11 +72,7 @@ export default class TrustRegistryModule {
       signingKeyRef,
       nonceOrDidModule,
     );
-    return this.signAndSend(
-      tx,
-      waitForFinalization,
-      params,
-    );
+    return this.signAndSend(tx, waitForFinalization, params);
   }
 
   /**
@@ -121,11 +141,7 @@ export default class TrustRegistryModule {
       signingKeyRef,
       nonceOrDidModule,
     );
-    return this.signAndSend(
-      tx,
-      waitForFinalization,
-      params,
-    );
+    return this.signAndSend(tx, waitForFinalization, params);
   }
 
   /**
@@ -149,10 +165,7 @@ export default class TrustRegistryModule {
       nonce,
       didModule,
     });
-    ensureMatchesPattern(
-      this.constructor.SchemasUpdatePattern,
-      schemas,
-    );
+    ensureMatchesPattern(this.constructor.SchemasUpdatePattern, schemas);
 
     return convenerOrIssuerOrVerifierHexDid.changeState(
       this.api,
@@ -190,11 +203,7 @@ export default class TrustRegistryModule {
       signingKeyRef,
       nonceOrDidModule,
     );
-    return this.signAndSend(
-      tx,
-      waitForFinalization,
-      params,
-    );
+    return this.signAndSend(tx, waitForFinalization, params);
   }
 
   /**
@@ -259,11 +268,7 @@ export default class TrustRegistryModule {
       signingKeyRef,
       nonceOrDidModule,
     );
-    return this.signAndSend(
-      tx,
-      waitForFinalization,
-      params,
-    );
+    return this.signAndSend(tx, waitForFinalization, params);
   }
 
   /**
@@ -355,6 +360,21 @@ export default class TrustRegistryModule {
     const lastNonce = nonce ?? (await getDidNonce(hexDID, nonce, didModule));
     return [hexDID, lastNonce];
   }
+
+  /**
+   * Parses Trust Registry information received from the substrate side.
+   * @param registryInfo
+   */
+  parseRegistryInfo({ name, convener, govFramework }) {
+    return {
+      name: name.toString(),
+      convener: typedHexDIDFromSubstrate(
+        this.api,
+        convener,
+      ).toQualifiedEncodedString(),
+      govFramework: u8aToHex(govFramework),
+    };
+  }
 }
 
 const DockDidOrDidMethodKeyPattern = {
@@ -365,6 +385,14 @@ const VerificationPricePattern = {
   $anyOf: [{ $matchType: 'number' }, { $matchType: 'object' }],
 };
 
+const Hex32Pattern = {
+  $ensure: (value) => {
+    if (!isHexWithGivenByteSize(value, 32)) {
+      throw new Error(`Expected 32-byte hex sequence, received: ${value}`);
+    }
+  },
+};
+
 const VerifiersPattern = {
   $instanceOf: BTreeSet,
   $iterableOf: DockDidOrDidMethodKeyPattern,
@@ -426,10 +454,23 @@ const IssuersUpdatePattern = {
   ],
 };
 
-TrustRegistryModule.SchemasUpdatePattern = {
+const SetAllSchemasPattern = {
   $instanceOf: BTreeMap,
   $mapOf: [
-    { $matchType: 'string' },
+    Hex32Pattern,
+    {
+      $matchObject: {
+        issuers: IssuersPattern,
+        verifiers: VerifiersPattern,
+      },
+    },
+  ],
+};
+
+const ModifySchemasPattern = {
+  $instanceOf: BTreeMap,
+  $mapOf: [
+    Hex32Pattern,
     {
       $anyOf: [
         {
@@ -468,3 +509,31 @@ TrustRegistryModule.SchemasUpdatePattern = {
     },
   ],
 };
+
+TrustRegistryModule.SchemasUpdatePattern = {
+  $matchObject: {
+    Set: SetAllSchemasPattern,
+    Modify: ModifySchemasPattern,
+  },
+};
+TrustRegistryModule.TrustRegistriesInfoByPattern = {
+  $matchObject: {
+    Issuer: DockDidOrDidMethodKeyPattern,
+    Verifier: DockDidOrDidMethodKeyPattern,
+    SchemaId: Hex32Pattern,
+    IssuerOrVerifier: DockDidOrDidMethodKeyPattern,
+    IssuerAndVerifier: DockDidOrDidMethodKeyPattern,
+    IssuerAndSchemaId: {
+      $matchIterable: [DockDidOrDidMethodKeyPattern, Hex32Pattern],
+    },
+    VerifierAndSchemaId: {
+      $matchIterable: [DockDidOrDidMethodKeyPattern, Hex32Pattern],
+    },
+    IssuerOrVerifierAndSchemaId: {
+      $matchIterable: [DockDidOrDidMethodKeyPattern, Hex32Pattern],
+    },
+    IssuerAndVerifierAndSchemaId: {
+      $matchIterable: [DockDidOrDidMethodKeyPattern, Hex32Pattern],
+    },
+  },
+};

src/rpc-defs/core-mods-rpc-defs.js

@@ -143,4 +143,108 @@ export default {
       type: 'Vec<Option<AggregatedDidDetailsResponse>>',
     },
   },
+  trustRegistry: {
+    schemaMetadata: {
+      params: [
+        {
+          name: 'id',
+          type: 'TrustRegistrySchemaId',
+        },
+      ],
+      type: 'BTreeMap<TrustRegistryId, AggregatedTrustRegistrySchemaMetadata>',
+    },
+    schemaIssuers: {
+      params: [
+        {
+          name: 'id',
+          type: 'TrustRegistrySchemaId',
+        },
+      ],
+      type: 'BTreeMap<TrustRegistryId, AggregatedTrustRegistrySchemaIssuers>',
+    },
+    schemaVerifiers: {
+      params: [
+        {
+          name: 'id',
+          type: 'TrustRegistrySchemaId',
+        },
+      ],
+      type: 'BTreeMap<TrustRegistryId, TrustRegistrySchemaVerifiers>',
+    },
+    schemaMetadataInRegistry: {
+      params: [
+        {
+          name: 'id',
+          type: 'TrustRegistrySchemaId',
+        },
+        {
+          name: 'registry_id',
+          type: 'TrustRegistryId',
+        },
+      ],
+      type: 'Option<AggregatedTrustRegistrySchemaMetadata>',
+    },
+    schemaIssuersInRegistry: {
+      params: [
+        {
+          name: 'id',
+          type: 'TrustRegistrySchemaId',
+        },
+        {
+          name: 'registry_id',
+          type: 'TrustRegistryId',
+        },
+      ],
+      type: 'Option<AggregatedTrustRegistrySchemaIssuers>',
+    },
+    schemaVerifiersInRegistry: {
+      params: [
+        {
+          name: 'id',
+          type: 'TrustRegistrySchemaId',
+        },
+        {
+          name: 'registry_id',
+          type: 'TrustRegistryId',
+        },
+      ],
+      type: 'Option<TrustRegistrySchemaVerifiers>',
+    },
+    allRegistrySchemaMetadata: {
+      params: [
+        {
+          name: 'registry_id',
+          type: 'TrustRegistryId',
+        },
+      ],
+      type: 'BTreeMap<TrustRegistrySchemaId, AggregatedTrustRegistrySchemaMetadata>',
+    },
+    allRegistrySchemaIssuers: {
+      params: [
+        {
+          name: 'registry_id',
+          type: 'TrustRegistryId',
+        },
+      ],
+      type: 'BTreeMap<TrustRegistrySchemaId, AggregatedTrustRegistrySchemaIssuers>',
+    },
+    allRegistrySchemaVerifiers: {
+      params: [
+        {
+          name: 'registry_id',
+          type: 'TrustRegistryId',
+        },
+      ],
+      type: 'BTreeMap<TrustRegistrySchemaId, TrustRegistrySchemaVerifiers>',
+    },
+    registriesInfoBy: {
+      params: [
+        {
+          name: 'by',
+          type: 'TrustRegistriesInfoBy',
+        },
+      ],
+      type: 'BTreeMap<TrustRegistryId, TrustRegistryInfo>',
+    },
+  },
 };

src/status-list-credential/status-list2021-credential.js

@@ -27,14 +27,14 @@ export default class StatusList2021Credential extends VerifiableCredential {
 
     // Caches decoded status list.
     Object.defineProperty(this, 'decodedStatusList', {
-      value: async function decodedStatusList() {
+      value: function decodedStatusList() {
         if (
           encodedStatusList === this.credentialSubject.encodedList
           && cachedDecodedStatusList !== void 0
         ) {
           return cachedDecodedStatusList;
         } else {
-          cachedDecodedStatusList = await decodeList(this.credentialSubject);
+          cachedDecodedStatusList = decodeList(this.credentialSubject);
           encodedStatusList = this.credentialSubject.encodedList;
 
           return cachedDecodedStatusList;

src/utils/misc.js

@@ -476,6 +476,17 @@ export class PatternMatcher {
 
     this.check(pattern.$objOf[key], value[key], path.concat(key));
   }
+
+  /**
+   * Ensures that supplied value satisfies provided function.
+   *
+   * @param pattern
+   * @param value
+   * @param path
+   */
+  $ensure(pattern, value) {
+    pattern.$ensure(value);
+  }
 }
 
 /**