fix: upgrade oa-verify to v3.1.0

OpenCerts · Feb 5, 2020 · aff5d98 · aff5d98
1 parent 3c6ef58
commit aff5d98
Show file tree

Hide file tree

Showing 5 changed files with 119 additions and 55 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -45,8 +45,8 @@
     ]
   },
   "dependencies": {
-    "@govtechsg/oa-verify": "3.0.3",
-    "@govtechsg/open-attestation": "3.1.0",
+    "@govtechsg/oa-verify": "3.1.1",
+    "@govtechsg/open-attestation": "3.1.1",
     "debug": "4.1.1",
     "node-fetch": "2.6.0"
   },

diff --git a/src/verify.ts b/src/verify.ts
@@ -32,6 +32,13 @@ type OpencertsRegistryVerificationFragmentData = Partial<RegistryEntry> & {
 const type = "ISSUER_IDENTITY";
 const name = "OpencertsRegistryVerifier";
 
+// NEVER EVER REPLACE OR CHANGE A VALUE :)
+// code for errors and invalid fragment
+export enum OpencertsRegistryCode {
+  INVALID_IDENTITY = 0,
+  SKIPPED = 1
+}
+
 const storeToFragment = (
   registry: Registry,
   store: string
@@ -58,7 +65,11 @@ const storeToFragment = (
       value: store,
       status: "INVALID" as "INVALID"
     },
-    message: `Document store ${store} not found in the registry`
+    reason: {
+      code: OpencertsRegistryCode.INVALID_IDENTITY,
+      codeString: OpencertsRegistryCode[OpencertsRegistryCode.INVALID_IDENTITY],
+      message: `Document store ${store} not found in the registry`
+    }
   };
 };
 
@@ -80,7 +91,11 @@ export const registryVerifier: Verifier<
       status: "SKIPPED",
       type,
       name,
-      message: `Document issuers doesn't have "documentStore" or "certificateStore" property or ${v3.Method.DocumentStore} method`
+      reason: {
+        code: OpencertsRegistryCode.SKIPPED,
+        codeString: OpencertsRegistryCode[OpencertsRegistryCode.SKIPPED],
+        message: `Document issuers doesn't have "documentStore" or "certificateStore" property or ${v3.Method.DocumentStore} method`
+      }
     });
   },
   verify: async document => {
@@ -104,7 +119,7 @@ export const registryVerifier: Verifier<
       message:
         status === "INVALID"
           ? `Document store ${
-              issuerFragments.find(fragment => fragment.status === "VALID")?.data
+              issuerFragments.find(fragment => fragment.status === "INVALID")?.data
             } not found in the registry`
           : undefined
     };

diff --git a/test/verify.v2.test.ts b/test/verify.v2.test.ts
@@ -43,10 +43,14 @@ describe("verify", () => {
         type: "DOCUMENT_STATUS"
       },
       {
-        message: 'Document issuers doesn\'t have "tokenRegistry" property or TOKEN_REGISTRY method',
         name: "OpenAttestationEthereumTokenRegistryMinted",
         status: "SKIPPED",
-        type: "DOCUMENT_STATUS"
+        type: "DOCUMENT_STATUS",
+        reason: {
+          code: 4,
+          codeString: "SKIPPED",
+          message: 'Document issuers doesn\'t have "tokenRegistry" property or TOKEN_REGISTRY method'
+        }
       },
       {
         data: {
@@ -63,10 +67,15 @@ describe("verify", () => {
         type: "DOCUMENT_STATUS"
       },
       {
-        message: `Document issuers doesn't have "documentStore" / "tokenRegistry" property or doesn't use DNS-TXT type`,
         status: "SKIPPED",
         name: "OpenAttestationDnsTxt",
-        type: "ISSUER_IDENTITY"
+        type: "ISSUER_IDENTITY",
+        reason: {
+          code: 2,
+          codeString: "SKIPPED",
+          message:
+            'Document issuers doesn\'t have "documentStore" / "tokenRegistry" property or doesn\'t use DNS-TXT type'
+        }
       },
       {
         data: [

diff --git a/test/verify.v3.test.ts b/test/verify.v3.test.ts
@@ -22,32 +22,32 @@ describe("verify", () => {
       },
       {
         data: {
-          details: [
-            {
-              address: "0x8Fc57204c35fb9317D91285eF52D6b892EC08cD3",
-              issued: true
-            }
-          ],
+          details: {
+            address: "0x8Fc57204c35fb9317D91285eF52D6b892EC08cD3",
+            issued: true
+          },
           issuedOnAll: true
         },
         status: "VALID",
         name: "OpenAttestationEthereumDocumentStoreIssued",
         type: "DOCUMENT_STATUS"
       },
       {
-        message: 'Document issuers doesn\'t have "tokenRegistry" property or TOKEN_REGISTRY method',
+        reason: {
+          code: 4,
+          codeString: "SKIPPED",
+          message: 'Document issuers doesn\'t have "tokenRegistry" property or TOKEN_REGISTRY method'
+        },
         name: "OpenAttestationEthereumTokenRegistryMinted",
         status: "SKIPPED",
         type: "DOCUMENT_STATUS"
       },
       {
         data: {
-          details: [
-            {
-              address: "0x8Fc57204c35fb9317D91285eF52D6b892EC08cD3",
-              revoked: false
-            }
-          ],
+          details: {
+            address: "0x8Fc57204c35fb9317D91285eF52D6b892EC08cD3",
+            revoked: false
+          },
           revokedOnAny: false
         },
         status: "VALID",
@@ -60,7 +60,11 @@ describe("verify", () => {
           status: "INVALID",
           value: "0x8Fc57204c35fb9317D91285eF52D6b892EC08cD3"
         },
-        message: "Certificate issuer identity is invalid",
+        reason: {
+          code: 1,
+          codeString: "INVALID_IDENTITY",
+          message: "Certificate issuer identity is invalid"
+        },
         name: "OpenAttestationDnsTxt",
         status: "INVALID",
         type: "ISSUER_IDENTITY"
@@ -84,46 +88,64 @@ describe("verify", () => {
       {
         data: false,
         status: "INVALID",
-        message: "Certificate has been tampered with",
+        reason: {
+          code: 0,
+          codeString: "DOCUMENT_TAMPERED",
+          message: "Certificate has been tampered with"
+        },
         name: "OpenAttestationHash",
         type: "DOCUMENT_INTEGRITY"
       },
       {
         data: {
-          details: [
-            {
-              issued: false,
-              address: "0x532C9Ff853CA54370D7492cD84040F9f8099f11B",
-              error:
-                'invalid input argument (arg="document", reason="invalid bytes32 value", value="0xabcd", version=4.0.42)'
+          details: {
+            issued: false,
+            address: "0x532C9Ff853CA54370D7492cD84040F9f8099f11B",
+            reason: {
+              code: 3,
+              codeString: "ETHERS_UNHANDLED_ERROR",
+              message: "Error with smart contract 0x532C9Ff853CA54370D7492cD84040F9f8099f11B: invalid bytes32 value"
             }
-          ],
+          },
           issuedOnAll: false
         },
-        message: "Certificate has not been issued",
+        reason: {
+          code: 3,
+          codeString: "ETHERS_UNHANDLED_ERROR",
+          message: "Error with smart contract 0x532C9Ff853CA54370D7492cD84040F9f8099f11B: invalid bytes32 value"
+        },
         status: "INVALID",
         name: "OpenAttestationEthereumDocumentStoreIssued",
         type: "DOCUMENT_STATUS"
       },
       {
-        message: 'Document issuers doesn\'t have "tokenRegistry" property or TOKEN_REGISTRY method',
+        reason: {
+          code: 4,
+          codeString: "SKIPPED",
+          message: 'Document issuers doesn\'t have "tokenRegistry" property or TOKEN_REGISTRY method'
+        },
         name: "OpenAttestationEthereumTokenRegistryMinted",
         status: "SKIPPED",
         type: "DOCUMENT_STATUS"
       },
       {
         data: {
-          details: [
-            {
-              address: "0x532C9Ff853CA54370D7492cD84040F9f8099f11B",
-              error:
-                'invalid input argument (arg="document", reason="invalid bytes32 value", value="0xabcd", version=4.0.42)',
-              revoked: true
-            }
-          ],
+          details: {
+            address: "0x532C9Ff853CA54370D7492cD84040F9f8099f11B",
+            reason: {
+              code: 3,
+              codeString: "ETHERS_UNHANDLED_ERROR",
+              message: "Error with smart contract 0x532C9Ff853CA54370D7492cD84040F9f8099f11B: invalid bytes32 value"
+            },
+            revoked: true
+          },
           revokedOnAny: true
         },
-        message: "Certificate has been revoked",
+        reason: {
+          code: 3,
+          codeString: "ETHERS_UNHANDLED_ERROR",
+          message: "Error with smart contract 0x532C9Ff853CA54370D7492cD84040F9f8099f11B: invalid bytes32 value"
+        },
         status: "INVALID",
         name: "OpenAttestationEthereumDocumentStoreRevoked",
         type: "DOCUMENT_STATUS"