feat(credential-w3c): align verification API between formats

fixes #935 fixes #954 fixes #375
decentralized-identity · Aug 19, 2022 · bd7382c · bd7382c
1 parent 06b3147
commit bd7382c
Show file tree

Hide file tree

Showing 21 changed files with 454 additions and 302 deletions.
diff --git a/__tests__/shared/credentialStatus.ts b/__tests__/shared/credentialStatus.ts
@@ -102,9 +102,9 @@ export default (testContext: {
       })
       expect(vc).toHaveProperty('proof.jwt')
 
-      const verified = await agent.verifyCredential({ credential: vc })
+      const result = await agent.verifyCredential({ credential: vc })
       expect(callsCounter).toHaveBeenCalledTimes(1)
-      expect(verified).toBeTruthy()
+      expect(result.verified).toEqual(true)
     })
 
     it('should check credentialStatus for revoked JWT credential', async () => {
@@ -114,9 +114,9 @@ export default (testContext: {
       })
       expect(vc).toHaveProperty('proof.jwt')
 
-      const verified = await agent.verifyCredential({ credential: vc })
+      const result = await agent.verifyCredential({ credential: vc })
       expect(callsCounter).toHaveBeenCalledTimes(1)
-      expect(verified).toBeFalsy()
+      expect(result.verified).toEqual(false)
     })
 
     it('should fail checking credentialStatus with exception during verification', async () => {
@@ -152,9 +152,9 @@ export default (testContext: {
       })
       expect(vc).toHaveProperty('proof.jws')
 
-      const verified = await agent.verifyCredential({ credential: vc })
+      const result = await agent.verifyCredential({ credential: vc })
       expect(callsCounter).toHaveBeenCalledTimes(1)
-      expect(verified).toBeTruthy()
+      expect(result.verified).toEqual(true)
     })
 
     it('should check credentialStatus for revoked JSON-LD credential', async () => {
@@ -164,9 +164,9 @@ export default (testContext: {
       })
       expect(vc).toHaveProperty('proof.jws')
 
-      const verified = await agent.verifyCredential({ credential: vc })
+      const result = await agent.verifyCredential({ credential: vc })
       expect(callsCounter).toHaveBeenCalledTimes(1)
-      expect(verified).toBeFalsy()
+      expect(result.verified).toEqual(false)
     })
 
     it('should check credentialStatus for EIP712 credential', async () => {
@@ -176,9 +176,9 @@ export default (testContext: {
       })
       expect(vc).toHaveProperty('proof.proofValue')
 
-      const verified = await agent.verifyCredential({ credential: vc })
+      const result = await agent.verifyCredential({ credential: vc })
       expect(callsCounter).toHaveBeenCalledTimes(1)
-      expect(verified).toBeTruthy()
+      expect(result.verified).toEqual(true)
     })
 
     it('should check credentialStatus for revoked EIP712 credential', async () => {
@@ -188,9 +188,9 @@ export default (testContext: {
       })
       expect(vc).toHaveProperty('proof.proofValue')
 
-      const verified = await agent.verifyCredential({ credential: vc })
+      const result = await agent.verifyCredential({ credential: vc })
       expect(callsCounter).toHaveBeenCalledTimes(1)
-      expect(verified).toBeFalsy()
+      expect(result.verified).toEqual(false)
     })
   })
 
@@ -235,7 +235,7 @@ export default (testContext: {
 
       // TODO It`s an exception flow an it'd be better to throw an exception instead of returning false
       await expect(agent.verifyCredential({ credential: vc })).rejects.toThrow(
-        `The credential status can't be verified by the agent`,
+        `invalid_config: The credential status can't be verified because there is no ICredentialStatusVerifier plugin installed.`,
       )
     })
   })

diff --git a/__tests__/shared/verifiableDataLD.ts b/__tests__/shared/verifiableDataLD.ts
@@ -72,7 +72,7 @@ export default (testContext: {
         credential: verifiableCredential,
       })
 
-      expect(result).toEqual(true)
+      expect(result.verified).toEqual(true)
     })
 
     it('should handleMessage with VC (non-JWT)', async () => {
@@ -98,20 +98,19 @@ export default (testContext: {
         hash: storedCredentialHash,
       })
 
+      // tamper with credential
       verifiableCredential.credentialSubject.name = 'Martin, the not so greats'
 
-      try {
-        await agent.handleMessage({
+      await expect(
+        agent.handleMessage({
           raw: JSON.stringify({
             body: verifiableCredential,
             type: 'w3c.vc',
           }),
           save: false,
           metaData: [{ type: 'LDS' }],
-        })
-      } catch (e) {
-        expect(e).toEqual(Error('Error verifying LD Verifiable Credential'))
-      }
+        }),
+      ).rejects.toThrow(/Verification error/)
     })
 
     it('should sign a verifiable presentation in LD', async () => {
@@ -164,7 +163,7 @@ export default (testContext: {
         domain,
       })
 
-      expect(result).toBeTruthy()
+      expect(result.verified).toEqual(true)
     })
 
     it('should handleMessage with VPs (non-JWT)', async () => {
@@ -244,7 +243,7 @@ export default (testContext: {
         credential: verifiableCredential,
       })
 
-      expect(result).toEqual(true)
+      expect(result.verified).toEqual(true)
     })
   })
 }
diff --git a/packages/cli/src/credential.ts b/packages/cli/src/credential.ts
@@ -191,7 +191,7 @@ credential
     }
     try {
       const result = await agent.verifyCredential({ credential: credentialAsJSON })
-      if (result === true) {
+      if (result.verified === true) {
         console.log('Credential was verified successfully.')
       } else {
         console.error('Credential could not be verified.')

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -23,14 +23,14 @@
   },
   "dependencies": {
     "debug": "^4.3.3",
-    "did-jwt-vc": "^2.1.14",
+    "did-jwt-vc": "3.0.1",
     "events": "^3.2.0",
     "z-schema": "^5.0.2"
   },
   "devDependencies": {
     "@types/debug": "4.1.7",
-    "did-resolver": "^4.0.0",
-    "credential-status": "^2.0.5",
+    "credential-status": "2.0.5",
+    "did-resolver": "4.0.0",
     "typescript": "4.7.3"
   },
   "files": [