Merge pull request #19 from blockchain-certificates/feat/support-mocknet

Feat/support mocknet

package.json

@@ -8,7 +8,7 @@
   "dependencies": {
     "@blockcerts/explorer-lookup": "^1.3.0",
     "@trust/keyto": "^1.0.1",
-    "@vaultie/lds-merkle-proof-2019": "^0.0.9",
+    "@vaultie/lds-merkle-proof-2019": "^0.0.10",
     "bitcoinjs-lib": "^6.0.2",
     "bs58": "^4.0.1",
     "core-js": "^3.7.0",

src/index.ts

@@ -4,6 +4,7 @@ import { lookForTx, ExplorerAPI, TransactionData } from '@blockcerts/explorer-lo
 import { DecodedProof, VCProof } from './models/Proof';
 import getTransactionId from './helpers/getTransactionId';
 import getChain from './helpers/getChain';
+import { removeEntry } from './utils/array';
 import {
   isTransactionIdValid,
   computeLocalHash,
@@ -44,6 +45,7 @@ export interface MerkleProof2019VerificationResult {
 export interface MerkleProof2019VerifyProofAPI {
   documentLoader?: (url: string) => any; // jsonld document loader hook
   verifyIdentity?: boolean; // allow splitting verification process for more control
+  isMocknet?: boolean; // limit amount of checks for mocknet specificity
 }
 
 export class LDMerkleProof2019 extends LinkedDataProof {
@@ -115,13 +117,17 @@ export class LDMerkleProof2019 extends LinkedDataProof {
     this.proofValue = base58Decoder.decode();
   }
 
-  async verifyProof ({ documentLoader, verifyIdentity }: MerkleProof2019VerifyProofAPI = {
+  async verifyProof ({ documentLoader, verifyIdentity, isMocknet }: MerkleProof2019VerifyProofAPI = {
     documentLoader: (url): any => {},
-    verifyIdentity: true
+    verifyIdentity: true,
+    isMocknet: false
   }): Promise<MerkleProof2019VerificationResult> {
     this.documentLoader = documentLoader;
     let verified: boolean;
     let error: string = '';
+    if (isMocknet) {
+      this.adaptProofVerificationProcessToMocknet();
+    }
     try {
       await this.verifyProcess(this.proofVerificationProcess);
       if (verifyIdentity) {
@@ -180,6 +186,12 @@ export class LDMerkleProof2019 extends LinkedDataProof {
     this.chain = getChain(this.proofValue);
   }
 
+  private adaptProofVerificationProcessToMocknet (): void {
+    removeEntry(this.proofVerificationProcess, 'getTransactionId');
+    removeEntry(this.proofVerificationProcess, 'fetchRemoteHash');
+    removeEntry(this.proofVerificationProcess, 'checkMerkleRoot');
+  }
+
   private setOptions (options: MerkleProof2019Options): void {
     this.explorerAPIs = options.explorerAPIs ?? [];
     if (options.executeStepMethod && typeof options.executeStepMethod === 'function') {

src/utils/array.ts

@@ -0,0 +1,7 @@
+export function removeEntry (map: any[], key: any): void {
+  const stepIndex = map.findIndex(entry => entry === key);
+  if (stepIndex > -1) {
+    // delete by reference
+    map.splice(stepIndex, 1);
+  }
+}

tests/fixtures/mocknet-v3.ts

@@ -0,0 +1,40 @@
+export default {
+  '@context': ['https://www.w3.org/2018/credentials/v1', 'https://w3id.org/blockcerts/v3.1'],
+  id: 'urn:uuid:e3351aa6-61e2-4d13-bd96-e848aa0c75cd',
+  type: ['VerifiableCredential', 'BlockcertsCredential'],
+  issuer: 'https://issuer.dev.hylandcredentials.com/93d02af5-8683-452a-a79c-959deae72495/issuer_profile.json',
+  issuanceDate: '2022-11-03T17:08:34Z',
+  credentialSubject: {
+    type: 'email',
+    name: 'Piotr Nalewajka',
+    publicKey: '[email protected]',
+    id: 'urn:uuid:7d3d512e-ba58-4d7c-886e-acb5f4ee20d9',
+    email: '[email protected]'
+  },
+  metadata: '{}',
+  display: {
+    contentMediaType: 'text/html',
+    content: '<div style="background-color:transparent;padding:6px;display:inline-flex;align-items:center;flex-direction:column"><style>*{line-height:initial}</style><div style="background-color:#FFFFFF;margin-top:0px;height:842px;width:595px;overflow:hidden;box-sizing:border-box;box-shadow:0 0 6px rgba(0,0,0,0.08);border:1px solid #eee"><div style="height:100%;position:relative;width:100%;box-sizing:border-box"><section class="image" style="align-items:flex-end;clear:both;display:flex;flex-direction:column;flex-wrap:wrap;justify-content:flex-start;width:100%"><img src="data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAA0JCgsKCA0LCgsODg0PEyAVExISEyccHhcgLikxMC4pLSwzOko+MzZGNywtQFdBRkxOUlNSMj5aYVpQYEpRUk//2wBDAQ4ODhMREyYVFSZPNS01T09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT0//wAARCABhAGQDASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSExBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwD0qkNLTc15xZyuvuU1fcP4VUiuXvdQH2pjMhQHGGA4NdH4jbbqsmeyj+VclNdF8hBhffmppr3m2Z0KblOV0WoGV2DIwI9jXR26jyl4/hFefRs/2orE5DE5BzjNWTdXL8tNLkerHitauHc7amtTBuUr3O/VQBTxXntvrtzpk3lo5CMMncMirsHjWSI7J7dZsH74bbn9MVhLA1fs6mMsLKO2p2bD5qaRVLSdZtNWiZ7YsGTG9GGCtaA57VxTThLlluc0o2dmQYwW+tIRUzLzTdvtUXMWiEqPSipQo9KK2WwuU6vBpCSKXNNJFdp6yOM8TBn1SdVOCQv5YGa4i6kXe0UTMSGwMDrXZ+KJfKv7uT0C4+u0CsrwfpUd7rH2qUZS2AfHYt/D/In8KITUE5M0w2nM2XNI8ECSAT6s7BnGfJTjb9T61T1vw2+lxCaGbzYC4UAjBXPTPb8a9AL5bAaq95bJdW0kMgJVh+R6g/nWccRUcrt6G3O3qeOarBPHOVkRhs6gj7prPwTXoviPTw9o90keJoxk9tw9PrXBSW0sbJvjK7/u5Nexh6imiFJSVyO0vrmwn860maKQcZH9R3rtvDPik6hMtlfKq3BB2SLwH9sdjXAXC7JcEEHuKS3uJLW6iuIm2yROHU9eRWWJoQqpprXuc1WKlue0mkxUdlKtzaxXCtuWVA4OMcEVPgelfOWs7M4LEJOCRRUpVe4orZN2Fys6LNMZsHHel59aa4zzXY2z1UjgPGVwn2+aJWBYsCRnoABVzwNcWkdrcb7mFZJJAAhcbiAPTr3rC8WQI+qzyuCS1yFA7YC96oh3t7Ezx2fnIH2u5XKqO1X7JVIct9zWEVyNI9S3qhJ4x6mq8t/GD8jjGOeK4nQptWvoZ3sRAttEflW4J4OMlVI7f41M0Bkh865UTTMMsG5UewB4AFSsO4Ss2YVJunubOtXcK6e8YdWeTACg81yfkRz3CJIAQGB/Ko5bRAW/0flTyY15H0xz+VRaTaXl7p0jw3IDpMVDSAnKgf8A167oJQjuEpaXuZmvWvk3MjYJQcBiKxq6jVbW/isZhci3ddudyM2fyIrJsdDvr1YpIox5Mh/1hYYABwfetedct7kuaaTuel+HUaPw/YK3B8lT+YzWnUdqIxAgiGEVQq+wFS4zXzcrubZw7sSinbaKsdmbmaaTSU1utdh6VjznxiM6iwUYHmMfqeK09Alsv7BeGS3knErsXj8okN+J47DvVDxYpa5kf+7MR/n8qn8LTF9MliX70cmcex6fqDU1f4V+zKg/3dzat7COw04RxosW6RpGRegJ7D6DA/Cs26i8tWHOCcrjp9KvXk1wsixnBOM80m7IGRg960g7q9znqtTZkIpYhUBJPYVZs9NGnWSoHLMWLOfVjya0l2gcAA/SmSupBU8+1bNaGbgktzB1yMNZcgFS2Gz6Gp7OFbe0ihVQoRQMVna7drII7YcHzMsewH+TXSWlozOHkBCjkA96mpLkpq4pRcYK5btIzHbqrdepqcUUDoa8te9K5ktwzRSE0VLbuBr5PrTSeaN1ITXoHonnviK6DzXsRjz+9YA59Gqn4WvRBqoiY4WcbPx6j/D8aXW3H2u6/wBqZsf99VjxxzeYJIlIKsCD0rf2cZQcTalTXI0eiXjN5gZ4xtXgMKhWUE/dNaVxCk0CujAEgHbng1nOpRWwMEVy0Je7Y4KkXF6jhIhBw1VZ3O04Pamk8FiapXN4WRkskM8h43KflU+56fhXQryMU3Ixrxgbg7+SXzXWWvibRrpmVL6NGXqJcpn6Z61zrabsti00gMvXcOn0ArkdQs3t5DIOY2PB9Pat6lCFdLXY6pctSK5eh61/a+m/9BC1/wC/q0o1TTv+f+1/7/L/AI15Fa3OBskb6E1bVgwypB+lZLARXUqGFhJXTPV1njkUPGyuh5DKcg0V5lBqV9bxiOC6lRB0UNwKKweXTvpIh4KV9Gey5prusaM7sFVQSSewpa5nxvqDW+mLaxthrh8HHXaOv64rNe9JR7m0FzSUTl7jEt5NMfmMkjMD6Amo5CQvy9aqrPIFxuz70RvggGu/2bR6ipNI17TX7mwiKsvnpxgMxyv0NOPiGe9cQw2ywl2wHd8gfhismRd67c4qKAiOcJMNy9eOMinGnG17anNVpQmnpqb8VgrM0l7J9olb14UD0A6VcG1VCqAFHYDAFVRf23l5D8Y6YOarHUmlcRwxgZP3mPakqc5niyp1Zv3iXUZVWLIbnoBXIazcg7bdDnBy39BWjrOpReaRbSLI2MbhyF/xrm2yWJJySeTXTCPLE6ILlppIToKfDIY5Ac8d6jOaSqFezujbNvODzDJ/3yaKt6d4tmtbNILiDz2TgPvwcds0Vg51b/D+Jf1qp/L+J6/XC+Pf+Puz/wBxv5iiivOof7xH5nRhv4qOYTpTj0oor1Xuex0J0+4KbJ1X60UVBwv4icf6v8KhPSiiuqhscrOaX/V1HRRUvoc7GmkooqCGFFFFAj//2Q==" style="max-width:100%;height:auto;width:inherit;display:block;box-sizing:border-box;display:block;margin:10px;width:80px"/></section><section class="text" style="align-items:center;clear:both;display:flex;flex-direction:column;flex-wrap:wrap;justify-content:flex-start;width:100%"><div style="box-sizing:border-box;text-transform:none;color:#3A3A3A;font-family:Helvetica, sans-serif;font-size:15px;font-weight:normal;line-height:normal;margin:10px;overflow-wrap:break-word;text-align:left;white-space:normal;width:calc(100% - 20px)"><div>This is a me, Piotr Nalewajka</div></div></section><section class="text" style="align-items:center;clear:both;display:flex;flex-direction:column;flex-wrap:wrap;justify-content:flex-start;width:100%"><div style="box-sizing:border-box;text-transform:none;color:#3A3A3A;font-family:Helvetica, sans-serif;font-size:13px;font-weight:normal;line-height:normal;margin:10px;overflow-wrap:break-word;text-align:left;white-space:normal;width:calc(100% - 20px)">Miskatonic University, Department of Ancient History<br></div></section></div></div></div>'
+  },
+  proof: [{
+    type: 'EcdsaSecp256k1Signature2019',
+    created: '2022-11-03T17:12:32Z',
+    verificationMethod: 'https://issuer.dev.hylandcredentials.com/93d02af5-8683-452a-a79c-959deae72495/issuer_profile.json#ckKpEaMGujwETK7Zpp8Rw6w9gTjmSbR5pZomLdxStq6j',
+    proofPurpose: 'assertionMethod',
+    jws: 'eyJhbGciOiJFUzI1NksiLCJiNjQiOmZhbHNlLCJjcml0IjpbImI2NCJdfQ..d3Eh5cX2WyoW8dYR8eiD7iCnAKdqAntLgA_sdrC3Op9wCdw7toC3USbf5YdEDJnFXivnWX05cSJxE0atzLYItw'
+  }, {
+    type: 'ChainedProof2021',
+    verificationMethod: 'https://issuer.dev.hylandcredentials.com/61e6c3fc-5779-4a6d-b05f-fdd10fdac5f0/issuer_profile.json#mocknet-public-key',
+    chainedProofType: 'MerkleProof2019',
+    created: '2022-11-15T13:57:49.216Z',
+    proofPurpose: 'assertionMethod',
+    proofValue: 'z52dKXiCeigz15WBp2vdftTWVgPqc33rrZDc7iVhzfhYh4y5irhV8AVPpGyP9BGZGCx7GDQKVBk8Lqj69tZKMHVGAmLtQ8qHkRBkxZsy8w4qBXgirTtNt56QWAJ7yzMmCDmtyWrbjvhZWd1fZn6SAtLbd5xn858tC3hvxLsrbnPhvtpCK1jiSCLfX2pBrqpLLNuKaP6PUVnEN2AkXwqv2gvkp35c',
+    previousProof: {
+      type: 'EcdsaSecp256k1Signature2019',
+      created: '2022-11-03T17:12:32Z',
+      verificationMethod: 'https://issuer.dev.hylandcredentials.com/93d02af5-8683-452a-a79c-959deae72495/issuer_profile.json#ckKpEaMGujwETK7Zpp8Rw6w9gTjmSbR5pZomLdxStq6j',
+      proofPurpose: 'assertionMethod',
+      jws: 'eyJhbGciOiJFUzI1NksiLCJiNjQiOmZhbHNlLCJjcml0IjpbImI2NCJdfQ..d3Eh5cX2WyoW8dYR8eiD7iCnAKdqAntLgA_sdrC3Op9wCdw7toC3USbf5YdEDJnFXivnWX05cSJxE0atzLYItw'
+    }
+  }]
+};

tests/verification/mocknet-v3.test.ts

@@ -0,0 +1,19 @@
+import fixture from '../fixtures/mocknet-v3';
+import { LDMerkleProof2019 } from '../../src';
+
+describe('Given the test chain is Mocknet', function () {
+  describe('when the certificate is valid', function () {
+    it('should verify successfully', async function () {
+      const instance = new LDMerkleProof2019({
+        document: fixture,
+        proof: fixture.proof[1] // merkle proof
+      });
+      const result = await instance.verifyProof({ isMocknet: true });
+      expect(result).toEqual({
+        verified: true,
+        verificationMethod: null,
+        error: ''
+      });
+    });
+  });
+});