Update return values, add additional test scenarios

axiom-crypto · Mar 3, 2024 · 34972ff · 34972ff
1 parent 0fdd385
commit 34972ff
Show file tree

Hide file tree

Showing 8 changed files with 467 additions and 318 deletions.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@axiom-crypto/tools",
-  "version": "2.0.3-alpha.0",
+  "version": "2.0.3-rc.0",
   "description": "Useful data, field, and byte manipulation tools for Axiom.",
   "author": "Intrinsic Technologies",
   "license": "MIT",

diff --git a/src/ipfs/ipfsClient.ts b/src/ipfs/ipfsClient.ts
@@ -1,5 +1,10 @@
 import bs58 from 'bs58';
 
+export interface IpfsResult {
+  status: number;
+  value: string | number | boolean | null;
+}
+
 export abstract class IpfsClient {
   protected name: string;
 
@@ -10,22 +15,22 @@ export abstract class IpfsClient {
   // Get the character length of the file
   // @param hashOrCid - IPFS hash in bytes32 or CIDv0
   // @returns - File size in character length
-  abstract getSize(hashOrCid: string): Promise<number | null>;
+  abstract getSize(hashOrCid: string): Promise<IpfsResult>;
 
   // Read a file from IPFS
   // @param hashOrCid - IPFS hash in bytes32 or CIDv0
   // @returns - File content as a string
-  abstract read(hashOrCid: string): Promise<string | null>;
+  abstract read(hashOrCid: string): Promise<IpfsResult>;
 
   // Write a file and pin it to IPFS
   // @param data - File content as a string
   // @returns - IPFS hash in bytes32
-  abstract pin(data: string): Promise<string | null>;
+  abstract pin(data: string): Promise<IpfsResult>;
 
   // Unpin a file from IPFS
   // @param hashOrCid - IPFS hash in bytes32 or CIDv0
   // @returns - Whether the unpinning was successful
-  abstract unpin(hashOrCid: string): Promise<boolean>;
+  abstract unpin(hashOrCid: string): Promise<IpfsResult>;
 
   // Convert bytes32 to CIDv0
   // @param bytes32Hex - IPFS hash in bytes32

diff --git a/src/ipfs/pinataIpfsClient.ts b/src/ipfs/pinataIpfsClient.ts
@@ -1,5 +1,5 @@
 import axios from 'axios';
-import { IpfsClient } from "./ipfsClient";
+import { IpfsClient, IpfsResult } from "./ipfsClient";
 
 export class PinataIpfsClient extends IpfsClient {
   private pinataJwt: string;
@@ -29,22 +29,34 @@ export class PinataIpfsClient extends IpfsClient {
     return `https://gateway.pinata.cloud/ipfs`;
   }
 
-  async getSize(hashOrCid: string): Promise<number | null> {
+  async getSize(hashOrCid: string): Promise<IpfsResult> {
     try {
       if (hashOrCid.startsWith("0x")) {
         hashOrCid = this.convertBytes32ToIpfsCid(hashOrCid);
       }
       // Pinata gateway will not return data size on a head request, so we need to use 
       // the public ipfs.io gateway instead.
       const res = await axios.head(`https://ipfs.io/ipfs/${hashOrCid}`);
-      return res.headers["x-ipfs-datasize"] ?? null;
-    } catch (e) {
-      console.error(e);
-      return null;
+      const size = res.headers["x-ipfs-datasize"];
+      if (!size) {
+        return {
+          status: res.status,
+          value: null,
+        }
+      }
+      return {
+        status: res.status,
+        value: size,
+      };
+    } catch (e: any) {
+      return {
+        status: e.response?.status ?? 500,
+        value: e.message,
+      };
     }
   }
 
-  async read(hashOrCid: string): Promise<string | null> {
+  async read(hashOrCid: string): Promise<IpfsResult> {
     try {
       if (hashOrCid.startsWith("0x")) {
         hashOrCid = this.convertBytes32ToIpfsCid(hashOrCid);
@@ -55,14 +67,25 @@ export class PinataIpfsClient extends IpfsClient {
           Authorization: `Bearer ${this.pinataJwt}`,
         }
       });
-      return res.data.data ?? null;
-    } catch (e) {
-      console.error(e);
-      return null;
+      if (!(res.data.data || res.data)) {
+        return {
+          status: res.status,
+          value: null,
+        };
+      }
+      return {
+        status: res.status,
+        value: res.data.data ?? res.data,
+      };
+    } catch (e: any) {
+      return {
+        status: e.response?.status ?? 500,
+        value: e.message,
+      }
     }
   }
 
-  async pin(data: string): Promise<string | null> {
+  async pin(data: string): Promise<IpfsResult> {
     const dataObj = {
       "pinataContent": {
         "data": data,
@@ -83,15 +106,20 @@ export class PinataIpfsClient extends IpfsClient {
           }
         }
       );
-      const hash = res.data.IpfsHash
-      return this.convertIpfsCidToBytes32(hash);
-    } catch (e) {
-      console.error(e);
-      return null;
+      const cid = res.data.IpfsHash
+      return {
+        status: res.status,
+        value: this.convertIpfsCidToBytes32(cid),
+      };
+    } catch (e: any) {
+      return {
+        status: e.response?.status ?? 500,
+        value: null,
+      };
     }
   }
 
-  async unpin(hashOrCid: string): Promise<boolean> {
+  async unpin(hashOrCid: string): Promise<IpfsResult> {
     try {
       if (hashOrCid.startsWith("0x")) {
         hashOrCid = this.convertBytes32ToIpfsCid(hashOrCid);
@@ -101,10 +129,15 @@ export class PinataIpfsClient extends IpfsClient {
           Authorization: `Bearer ${this.pinataJwt}`,
         }
       });
-      return res.status === 200;
+      return {
+        status: res.status,
+        value: true,
+      };
     } catch (e: any) {
-      console.error(e);
-      return false;
+      return {
+        status: e.response?.status ?? 500,
+        value: false,
+      };
     }
   }
 }
diff --git a/src/ipfs/quicknodeIpfsClient.ts b/src/ipfs/quicknodeIpfsClient.ts
@@ -1,6 +1,9 @@
 import axios from 'axios';
 import FormData from 'form-data';
-import { IpfsClient } from "./ipfsClient";
+import { IpfsClient, IpfsResult } from "./ipfsClient";
+
+// Maximum number of pages to get all pinned objects
+const MAX_PAGES = 1000;
 
 export class QuicknodeIpfsClient extends IpfsClient {
   private gatewayUrl: string;
@@ -18,20 +21,32 @@ export class QuicknodeIpfsClient extends IpfsClient {
     this.apiKey = apiKey;
   }
 
-  async getSize(hashOrCid: string): Promise<number | null> {
+  async getSize(hashOrCid: string): Promise<IpfsResult> {
     try {
       if (hashOrCid.startsWith("0x")) {
         hashOrCid = this.convertBytes32ToIpfsCid(hashOrCid);
       }
       const res = await axios.head(`${this.gatewayUrl}/${hashOrCid}`);
-      return res.headers["content-length"] ?? null;
+      const size = res.headers["content-length"];
+      if (!size) {
+        return {
+          status: res.status,
+          value: null,
+        }
+      }
+      return {
+        status: res.status,
+        value: size,
+      };
     } catch (e: any) {
-      console.error(e?.message);
-      return null;
+      return {
+        status: e.response?.status ?? 500,
+        value: e.message,
+      };
     }
   }
 
-  async read(hashOrCid: string): Promise<string | null> {
+  async read(hashOrCid: string): Promise<IpfsResult> {
     try {
       if (hashOrCid.startsWith("0x")) {
         hashOrCid = this.convertBytes32ToIpfsCid(hashOrCid);
@@ -41,17 +56,25 @@ export class QuicknodeIpfsClient extends IpfsClient {
           "x-api-key": this.apiKey,
         },
       });
-      if (res.data.data) {
-        return res.data.data;
+      if (!(res.data.data || res.data)) {
+        return {
+          status: res.status,
+          value: null,
+        };
       }
-      return res.data ?? null;
+      return {
+        status: res.status,
+        value: res.data.data ?? res.data,
+      };
     } catch (e: any) {
-      console.error(e?.message);
-      return null;
+      return {
+        status: e.response?.status ?? 500,
+        value: e.message,
+      }
     }
   }
 
-  async pin(data: string): Promise<string | null> {
+  async pin(data: string): Promise<IpfsResult> {
     const path = Date.now().toString();
     const formdata = new FormData();
     formdata.append("Body", data, path);
@@ -70,14 +93,19 @@ export class QuicknodeIpfsClient extends IpfsClient {
         }
       );
       const cid = res.data.pin.cid;
-      return this.convertIpfsCidToBytes32(cid);
+      return {
+        status: res.status,
+        value: this.convertIpfsCidToBytes32(cid),
+      };
     } catch (e: any) {
-      console.error(e);
-      return null;
+      return {
+        status: e.response?.status ?? 500,
+        value: null,
+      };
     }
   }
 
-  async unpin(hashOrCid: string): Promise<boolean> {
+  async unpin(hashOrCid: string): Promise<IpfsResult> {
     try {
       if (hashOrCid.startsWith("0x")) {
         hashOrCid = this.convertBytes32ToIpfsCid(hashOrCid);
@@ -98,7 +126,7 @@ export class QuicknodeIpfsClient extends IpfsClient {
         res.data.data.forEach((pinnedObject: any) => {
           pinnedCidRequestIds[pinnedObject.cid] = pinnedObject.requestId;
         });
-        if (pageNumber === res.data.totalPages || pageNumber > 1000) {
+        if (pageNumber === res.data.totalPages || pageNumber > MAX_PAGES) {
           break;
         }
         pageNumber++;
@@ -110,10 +138,16 @@ export class QuicknodeIpfsClient extends IpfsClient {
           "x-api-key": this.apiKey,
         },
       });
-      return res.status === 200;
+
+      return {
+        status: res.status,
+        value: true,
+      };
     } catch (e: any) {
-      console.error(e);
-      return false;
+      return {
+        status: e.response?.status ?? 500,
+        value: false,
+      };
     }
   }
 }
diff --git a/test/ipfs/basic.test.ts b/test/ipfs/basic.test.ts
@@ -0,0 +1,68 @@
+import { PinataIpfsClient, QuicknodeIpfsClient } from "../../src";
+import { SIZE_DIFF_THRESHOLD, calculatePercentageDiff } from "./ipfsTest";
+
+describe("IPFS client tests", () => {
+  const encodedQuery =
+    "0x0200000001000000010007000100ed14f200000002000100ed14f300000009000200ed14f2c02aaa39b223fe8d0a0e5c4f27ead9083c756cc200000003000300ed14f2c02aaa39b223fe8d0a0e5c4f27ead9083c756cc200000000000000000000000000000000000000000000000000000000000000010004255910aca2752f3c05fcb4a54d3d8d93bb809a9c8cc215d5eed2504d44cbd865000000050005255910aca2752f3c05fcb4a54d3d8d93bb809a9c8cc215d5eed2504d44cbd8650000000000000000255910aca2752f3c05fcb4a54d3d8d93bb809a9c8cc215d5eed2504d44cbd865000600ed14f21f98431c8ad98523631ae4a59f267346ea31f984000000000000000000000000000000000000000000000000000000000000000503000000000000000000000000c02aaa39b223fe8d0a0e5c4f27ead9083c756cc2000000000000000000000000d31a59c85ae9d8edefec411d448f90841571b89c00000000000000000000000000000000000000000000000000000000000027100e1b0000000e0000000609bddd9050d5cb871ead4831773e485d445bde72a636efda1a1ce29363a95e142250c9b1df9fcc375c0b71f470588fa27fd57ad62b8cc3b8aca6c8e6e65a5225833d35582dfe7f9fbdb28598e7d87261505ac67a26951b63452351ddad76be162d068b32017323fa42cdbeb8882e6b9582277860c70eb6c48c39a3fa19ab7624b1c084dc9fcca92697d8d41620b2393d75f44573da6be049cc79594db2d33d0b2adb2b256c968b17fc485d2105d46f7221d936f975fce7fda5b28db43392ab162e3fee98ae4b3b5935b6a8cd2b4cc8fc26d319b8cca11b05b683ec6275cd9c146fc386defa21b217f145d3d8bff96a5ef1d2530dddeb53fdd228c6a0da9844082e3fee98ae4b3b5935b6a8cd2b4cc8fc26d319b8cca11b05b683ec6275cd9c146fc386defa21b217f145d3d8bff96a5ef1d2530dddeb53fdd228c6a0da984408fcdcb0effeaf608e158bad39e70072d125e5b5ea83955ffb519a816dfc19e1224006758437d363765499910d51df557f567e3d629fbd79676cd5aa11f6bcaf2e28e51fedd5bb63a14f5eb83b2ce83646742b81b1d31c9c27a8642cfe25252a2f3ce91b8b813227e1249646be944066164de6bdca2160993f647e99067fdcb308aa083ca60fd005a3426f1cdae3f61cd9cbf99a325dd10b9d8bdf8050a2bf9e1925024beceabdb4b4911d011231b05c11cbea9de0a296a9a7ff37223fa4521324822bb6371579ee4d87fc23254bb027e326c7a60c83989daafb5d7cdca6f47902548b714abc5c49468e138847d3fd35a200d1c5240b1fb352c8f988d6dadf7c12c9c899f8dfcd1b01a8497ee582027bdc6ad9995e6c6836d419ee3efcb9fc3908d65b2e0e1f1afb07e7f35cbfea5f0649c5e0fa2e508252544fabda276bdae80dc2d10c313afdca472b8d45c6c98872fb8d8b09bc88a77455a4995ef6767e9b079e0425b2f369b67d1bdf0cba3a2681fd12b690922d42547ee5d9d4dea6af9615aec2751eaac88b4bcf7969cca3e547bebd893d3f751abc058af761b646abf21daef711c3949c6f59999cf8d0b12c7c256700e6ec673504970bbab076c2dad81f826c6e91fed65b76616d54dfb63bd4c854b8e774554f2d5cfa80f45234bb7103758da87d898e257c4bede49ce5365c6d7436b466a5c7f6550e10dcf28e54332300000000000000000000000000000000000000000000000007e0f08a9fbf6aa1f3fb27851ff707d578c63969e8fc30499e992459e14105e03720d93c948001512f47a1f4ee4e1302363d88c5df5d52a507ae9ecdd6043bb4cc2e4819463c40c44377be16a3bc55f2a05308657483d6b19261fe180229a0cbc503b90ca2c55f2dab164337f7503f109f617a3f914481761ef706fdfc42a78839155230666db2fcc516076061538fd01d7869b30567881cc34e05ecd123fb7d7999894f3f36d1d5cd76a41dd27ac0098a844757515b9fd0a16b0a3a8e67947ac7808189020b1c13c38731ad46af4699500e23ec90b77977669064b50500a77eec059e9c8f90974b04f35fcdc714509ca9a38abe8df61753cc4aefc61564331e8b166df183079bbf659093c8334e1a6bae21a719ba17b29d94ec7f1277fd27013f81a20fb5ae56418e81ed9dedf3e708429fd5ad703cd7d49d6dabe947092bf12f87823c310561b7f55a17a657aa87203eedf580b6fee639019fd23e36279b091b20632debc513cf2897c18f4776d76d502333c8df622ff06a097ff2522eff34aa9b09f19aac148f0b1169901ace4dc7d5924b436a9413ae16d3f67d6471e51571a4ac5dc971463c1e82b9368b0a80215ace2ee1a0494c59eec646e80f03b0db65923fd8d858a40199f75dbfa182bb9f0c880ca7942fdb2df30fe0119730442bf42f18d483768799f9892f761ee6a046b5c6b984a173c5f5474b5a49dd3e9a0d3bab6b033b106f8c6d51ce72616d71e041e54ea3da3ce7a5d2f075313ac1be439f025fffc0cf07ac33893ddf94fc1b25a4b8b073f15dcd95fc3484fe473e1072b205dd6a2cb891ee443ecabbb84caee02cfca08870e5bb07cf096201ae9d0112b1091ebb396036f43391ff39ff40c08acb10933891285b057d8672229af992ab7c08e5cbd8a1a206897374a425297eac18e4087b26c0b5cfc9901c64dc2e016ae30d220b6a7f35d58659fbb2038ca155d343f12d34ed35d8f6f3f0bdf78f297a1228779822e0786a139fe3bcca766302847155bc8dec5f445a95e3da3b3d5ffd03235033c66364e6b862be706a082a294814dc3d2b7a808cc04527d22ec292d77716e85decacc284a06bff5b45679379b7d9d85d26090209a80da085555df6ee1302ea1ffd2c0578cb5727984a3a5c77075546fd75931e04d7e44db3c3ea0f5b152fffb162acdf5c846bd9bc331025e4854856e4e8d68b7d2f9d5b395ef8b5fc9c08dea5e6df32bc9c0d4b71ee3437efebaf0ba11a29fa241350f25225cbf6b8ef1286f1680c12dee6efbf00443a6071e33964adbb4373c071efeb5835ec8e1efd1d2214f8adbf1ace46fb88b7b47d175654bf45b7f861fbcd485c8b8e32303a2118c52832a6739b9974a7aa78f3eab172fcedb13237a79da05916242b1dfdd2f40c777a97b11164c244e875b1a7fccebff66f92d05726994ae0e868cbd70c675712bb230940f96174495d3ab4b871a27d56f9510bc5a00594e8d24a2d033f420612e7535e736b4318db5bef5942fe66054f7b99f475e5fede5a589014785306071decc0a65b07b4b274ccfc64f417b6c7a10604f34195c19b0926d322a2c826ce05b8d8c157037f3373536938aecff1d4392f48b29c16d0b499127f17cb675ed7010000000000000000000000000000000000000000000000000000000000000000c160b2e978e1037bcc2034e366cfed4f6532c014319ab40602cf93d3fefcec22c8a84807085c69fbebac778605aa0d2fd610f840ac32b248d1c2f4c00cb4b400d0579274b1e406c16b250704b8e1683019611adc878370956584c1a5f784ea0fa68b6973d41090b360a8dd0a151761115af8da30c688b25ecc6dad64854f2211429934b81bcdeb2a4be0bfdf278bd7c2894f8550b1e504995e310752db33a1088219d0029b2760dfbf2f231846de8b042e2a0be9f28dcaab2e4a34a82c841f2b564688c793dee27c7f89735f2bef9bf87ecbf53976f46b4286d01fe6f35edd236ae147ae4f898b9c227e40b46713edbc07b5ac0686ed33e14d286da575ebbe0913e378b9ce62a3d367ba89cded15b9c485de4af9d8db711b7eecc9d43a915720762a767e01cc602b1c76037defdd8890f2a77f2a90ff1d14a49d9f639e45f5057e4bdec786615fe2cb6883b08b59f385fc6cc8f7aba6965053b18c60a6098e04dc83c16b9ffb6bf683d714b35c8fa5ab25950482fb7757a6c6ca7085f523482c98ef52da04bc13491ae2e874851c647f778f141681651a1d3b0c88db1c77c40346f091d16f7d8ca0dad3d971a5348e038134294467067c515956983d61685c1e17fd52ac8fe6ce1f8b6c03516fabebaa16bfcb18c66ebdd2e3c3a22ab0f5c22d72a7a090e6642273203457e9eb7db25bbf26418d144edac0c305a7bbf235182e417bda7622cac6f173a9e47c5a3626bd2b641e354b9b868fddee7802821ec020b463641aaa099f23202001b793dc978a89da2c24fa0ab4964f7fb0cccc772b15d2edda42535bea2201fdbe28d6aee35154fd4df0a82d09f14193a38404502005fffe392c999ef8065909de4aa427c8d02dfff8793f12582829f4efba645af524a51e7832f5c1970d29c1d3304c7f5c2cc199c7d7b4a6be3a518dd4adde247c1b3616e8bb8c735878faf1d00f7fe8d159d16917724df5e99d752c58812d484d2f0a402861a2d79ae8ebb9287c67a37c5fbab5ef17c428f4ef1b62c23f738fd423706b5e2d8b8e8550391b9d10fd8ac4462cb71677e2dc12aab4d4514daad0d512de7b9d73817e10ca37b5f2cab8ab5bcb549127d90229e0533bf97cb80252f709d902d285a5395f96ea452bd4a4053df580879c9ce50c3a14f06e2ed43ffe6ba1b392448932f6ef430555631f765df0dfae34eff3e3d670d7020002123400000005d21dba0000030d40";
+
+  // Different CIDs based on the service for the same encoded query
+  const CIDS: {[key: string]: string} = {
+    "Pinata": "QmP1gv3pkhS16zuP7riLL2Lr9yVxN4CLBGjyWcnRn8AxkK",
+    "Quicknode": "QmTmHavh9Xms4HUuKpwhEaw9aWth6Ya2W6APWey1XZcEkq",
+  }
+  const CIDS_B32: {[key: string]: string} = {
+    "Pinata": "0x0a002552373dd861ecafa476341e768dd496a10fc1ee3f18753434d33adc1404",
+    "Quicknode": "0x509a11f294da7373652beefeaeefcfbd70810b10224a185adbcaf97050efe5fa",
+  }
+
+  const pinata = new PinataIpfsClient(process.env.PINATA_JWT);
+  const quicknode = new QuicknodeIpfsClient(process.env.QUICKNODE_API_KEY as string, process.env.QUICKNODE_IPFS_URL as string);
+  const ipfsClients = [
+    pinata, 
+    quicknode,
+  ];
+
+  // Run pin tests first
+  for (const client of ipfsClients) {
+    test(`${client.getName()} Pin encodedQuery to IPFS`, async () => {
+      const res = await client.pin(encodedQuery);
+      expect(res.value as string).toEqual(client.convertIpfsCidToBytes32(CIDS[client.getName() as string]));
+    });
+  }
+
+  for (const client of ipfsClients) {
+    test(`${client.getName()} Read from IPFS`, async () => {
+      const res = await client.read(CIDS[client.getName() as string]);
+      expect(res.value as string).toEqual(encodedQuery);
+    });
+
+    for (const cid of Object.values(CIDS)) {
+      test(`${client.getName()} Get pinned object size for CID ${cid}`, async () => {
+        const size = await client.getSize(cid);
+        if (size.status - 200 > 99) {
+          throw new Error("Unable to get file size");
+        }
+        const diff = calculatePercentageDiff(size.value as number, encodedQuery.length);
+        expect(diff).toBeLessThan(SIZE_DIFF_THRESHOLD);
+      });
+    }
+
+    test(`${client.getName()} Convert CID to bytes32`, async () => {
+      const cidBytes32 = client.convertIpfsCidToBytes32(CIDS[client.getName() as string]);
+      expect(cidBytes32).toEqual(CIDS_B32[client.getName() as string]);
+    });
+
+    test(`${client.getName()} Convert bytes32 to CID`, async () => {
+      const cid = client.convertBytes32ToIpfsCid(CIDS_B32[client.getName() as string]);
+      expect(cid).toEqual(CIDS[client.getName() as string]);
+    });
+  }
+
+  // Run unpin tests last
+  for (const client of ipfsClients) {
+    test(`${client.getName()} Unpin CID from IPFS`, async () => {
+      const res = await client.unpin(CIDS[client.getName() as string]);
+      expect(res.value as boolean).toEqual(true);
+    });
+  }
+});