fix(bugs): index.mjs and added IPFS gateway

Author: bitbeckers

contracts/RELEASE.md

@@ -1,3 +1,11 @@
+# 1.1.1
+
+- Improve ESM support by exporting `index.mjs` instead of `index.js`. @baumstern
+
+## New contributors
+
+Welcoming @baumstern as a new contributor to the hypercerts codebase!
+
 # 1.1.0
 
 - Added Sepolia marketplace deployment

contracts/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hypercerts-org/contracts",
   "description": "EVM compatible protocol for managing impact claims",
-  "version": "1.1.0",
+  "version": "1.1.1-alpha.0",
   "author": {
     "name": "Hypercerts Foundation",
     "url": "https://github.com/hypercerts-org/hypercerts"
@@ -18,9 +18,9 @@
   "types": "./dist/index.d.ts",
   "exports": {
     ".": {
+      "types": "./dist/index.d.ts",
       "require": "./dist/cjs/index.js",
-      "import": "./dist/esm/index.mjs",
-      "types": "./dist/index.d.ts"
+      "import": "./dist/esm/index.mjs"
     }
   },
   "files": [

pnpm-lock.yaml

@@ -1,5 +1,14 @@
 # Release notes
 
+## 1.4.2
+
+- Improve ESM support by exporting `index.mjs` instead of `index.js`. @baumstern
+- Added dweb IPFS gateway links and use `Promise.any` call to try and fetch data from multiple gateways.
+
+## New contributors
+
+Welcoming @baumstern as a new contributor to the hypercerts codebase!
+
 ## 1.4.0
 
 - Added all deployments from `@hypercerts-org/contracts` to the SDK under deploments.

sdk/RELEASE.md

@@ -1,6 +1,6 @@
 {
   "name": "@hypercerts-org/sdk",
-  "version": "1.4.1",
+  "version": "1.4.2-alpha.0",
   "description": "SDK for hypercerts protocol",
   "repository": "[email protected]:hypercerts-org/hypercerts.git",
   "author": "Hypercerts team",
@@ -11,9 +11,9 @@
   "module": "./dist/esm/index.mjs",
   "types": "./dist/index.d.ts",
   "exports": {
+    "types": "./dist/index.d.ts",
     "require": "./dist/cjs/index.js",
-    "import": "./dist/esm/index.mjs",
-    "types": "./dist/index.d.ts"
+    "import": "./dist/esm/index.mjs"
   },
   "files": [
     "dist",
@@ -24,7 +24,7 @@
     "@ethereum-attestation-service/eas-sdk": "1.3.7",
     "@ethersproject/abstract-signer": "^5.7.0",
     "@graphql-typed-document-node/core": "^3.2.0",
-    "@hypercerts-org/contracts": "1.1.0",
+    "@hypercerts-org/contracts": "1.1.1-alpha.0",
     "@openzeppelin/merkle-tree": "^1.0.5",
     "@urql/core": "^4.2.0",
     "@whatwg-node/fetch": "^0.9.13",

sdk/package.json

@@ -3,10 +3,10 @@ import { logger } from "./logger";
 import axios from "axios";
 
 /**
- * Fetches data from IPFS using either the NFT Storage gateway or the Web3Up gateway.
+ * Fetches data from IPFS using either the DWeb IPFS, NFT Storage, or the Web3Up gateway.
  *
- * This function attempts to fetch data from the NFT Storage gateway first. If the request times out, it then tries to fetch the data from the Web3Up  gateway.
- * If the data cannot be fetched from either gateway, it throws a `StorageError`.
+ * This function attempts to fetch data from all gateways at the same time and returns on the first on to resolve.
+ * If the data cannot be fetched from any gateway, it throws a `StorageError`.
  *
  * @param {string} cidOrIpfsUri - The CID or IPFS URI of the data to fetch.
  * @param {number} [timeout=10000] - The timeout for the fetch request in milliseconds. Defaults to 10000ms.
@@ -15,15 +15,20 @@ import axios from "axios";
  * @async
  */
 const getFromIPFS = async (cidOrIpfsUri: string, timeout: number = 10000): Promise<unknown> => {
-  const nftStorageGatewayLink = getNftStorageGatewayUri(cidOrIpfsUri);
-  const web3upGatewayLink = getWeb3UpGatewayUri(cidOrIpfsUri);
-  logger.debug(`Getting metadata ${cidOrIpfsUri} at ${nftStorageGatewayLink}`);
+  const requests = [
+    axios.get(getDwebLinkGatewayUri(cidOrIpfsUri), { timeout }),
+    axios.get(getNftStorageGatewayUri(cidOrIpfsUri), { timeout }),
+    axios.get(getWeb3UpGatewayUri(cidOrIpfsUri), { timeout }),
+  ];
 
-  const res = await axios.get(nftStorageGatewayLink, { timeout }).catch(() => {
-    logger.debug(`${nftStorageGatewayLink} timed out.`);
-    logger.debug(`Getting metadata ${cidOrIpfsUri} at ${web3upGatewayLink}`);
-    return axios.get(web3upGatewayLink, { timeout });
-  });
+  logger.debug(`Getting metadata for ${cidOrIpfsUri}`);
+
+  const res = await Promise.any(requests)
+    .then()
+    .catch((err) => {
+      logger.error(err);
+      throw new StorageError(`Failed to get ${cidOrIpfsUri}`, { error: err });
+    });
 
   if (!res || !res.data) {
     throw new StorageError(`Failed to get ${cidOrIpfsUri}`);
@@ -34,6 +39,11 @@ const getFromIPFS = async (cidOrIpfsUri: string, timeout: number = 10000): Promi
 
 const getCid = (cidOrIpfsUri: string) => cidOrIpfsUri.replace("ipfs://", "");
 
+const getDwebLinkGatewayUri = (cidOrIpfsUri: string) => {
+  const DWEB_LINK_IPFS_GATEWAY = "https://{cid}.ipfs.dweb.link/";
+  return DWEB_LINK_IPFS_GATEWAY.replace("{cid}", getCid(cidOrIpfsUri));
+};
+
 const getNftStorageGatewayUri = (cidOrIpfsUri: string) => {
   const NFT_STORAGE_IPFS_GATEWAY = "https://nftstorage.link/ipfs/{cid}";
   return NFT_STORAGE_IPFS_GATEWAY.replace("{cid}", getCid(cidOrIpfsUri));

sdk/src/utils/fetchers.ts

@@ -47,6 +47,6 @@ describe("Fetchers", () => {
 
     expect(res?.proof).to.deep.equal(tree.getProof(0));
     expect(res?.root).to.deep.equal(tree.root);
-    expect(stub.calledOnce).to.be.true;
+    expect(stub.calledThrice).to.be.true;
   });
 });

sdk/test/utils/allowlist.test.ts

@@ -20,20 +20,22 @@ describe("Fetchers", () => {
 
     const res = await getFromIPFS("test");
     expect(res).to.equal(validResponse.data);
-    expect(axiosStub.calledOnce).to.be.true;
+    expect(axiosStub.calledThrice).to.be.true;
   });
 
-  it("IPFS: should try another endpoint after the first fails", async () => {
+  it("IPFS: should try multiple endpoint and resolves when a valid response is returned from any", async () => {
     const validResponse = { data: "TEST_PASSED" };
     const axiosStub = sinon
       .stub(axios, "get")
       .onFirstCall()
       .rejects()
       .onSecondCall()
-      .resolves(Promise.resolve(validResponse));
+      .resolves(Promise.resolve(validResponse))
+      .onThirdCall()
+      .rejects();
 
     const res = await getFromIPFS("test");
     expect(res).to.equal(validResponse.data);
-    expect(axiosStub.calledTwice).to.be.true;
+    expect(axiosStub.calledThrice).to.be.true;
   });
 });