add subdomain support

Author: Metroxe

.github/workflows/npmRelease.yml

@@ -15,6 +15,7 @@ jobs:
           node-version: '18.x'
           registry-url: 'https://registry.npmjs.org'
       - run: npm install
+      - run: npm run test
       - run: npm run build
       - run: npm publish
         env:

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ipfs-race",
-  "version": "0.1.7",
+  "version": "0.2.0",
   "description": "Resolve an IPFS path using multiple gateways and methods to get data the fastest.",
   "main": "dist/index.js",
   "scripts": {

src/resolve.ts

@@ -32,18 +32,13 @@ interface ResolveOutput {
  * @param {string} uri - the uri on ipfs that needs to be resolved, it can follow any of the following formats...
  *      - <CID>
  *      - <CID>/<path>
- *      - ipfs/<CID>
- *      - ipfs/<CID>/path
- *      - ipns/<CID>
- *      - ipns/<CID>/path
- *      - http(s)://<gateway domain>/ipfs/<CID>
- *      - http(s)://<gateway domain>/ipfs/<CID>/<path>
- *      - http(s)://<gateway domain>/ipns/<CID>
- *      - http(s)://<gateway domain>/ipns/<CID>/<path>
- *      - ipfs://<CID>
- *      - ipfs://<CID>/<path>
- *      - ipns://<CID>
- *      - ipns://<CID>/<path>
+ *      - ip(f|n)s/<CID>
+ *      - ip(f|n)s/<CID>/path
+ *      - http(s)://<gateway domain>/ip(f|n)s/<CID>
+ *      - http(s)://<gateway domain>/ip(f|n)s/<CID>/<path>
+ *      - ip(f|n)s://<CID>
+ *      - ip(f|n)s://<CID>/<path>
+ *      - http(s)://<CID>.ip(f|n)s.<gateway domain>/<path>
  *      - https(s)://<regular url> - this will resolve a http request for a generic url
  * @param options
  */
@@ -110,6 +105,36 @@ async function resolve(uri: string, options?: ResolveOptions): Promise<ResolveOu
         gatewaySuffix = `/${protocol}/${uri}`;
     }
 
+    // check to see if a subdomain uri
+    else if (isIPFS.ipfsSubdomain(uri) || isIPFS.ipnsSubdomain(uri)) {
+
+        // check to see if ipfs or ipns
+        if (isIPFS.ipfsSubdomain(uri)) {
+            protocol = "ipfs";
+        } else if (isIPFS.ipnsSubdomain(uri)) {
+            protocol = "ipns";
+        }
+
+        // get everything to the left of the protocol for the CID
+        let tmp = uri.split(`.${protocol}.`);
+        let cid = tmp[0];
+
+        // remove the http or https if it exists
+        if (cid.startsWith("https://")) {
+            cid = cid.replace("https://", "");
+        } else if ("http://") {
+            cid = cid.replace("http://", "");
+        }
+
+        // get everything to the right of the domain, this will be the path
+        tmp = tmp[1].split("/");
+        tmp.shift();
+        const path = tmp.join("/");
+
+        // compile into the suffix
+        gatewaySuffix = `/${protocol}/${cid}/${path}`;
+    }
+
     // check to see if uri is a link to a gateway and ipfs
     else if (isIPFS.ipfsUrl(uri) || isIPFS.ipnsUrl(uri)) {
 
@@ -128,22 +153,7 @@ async function resolve(uri: string, options?: ResolveOptions): Promise<ResolveOu
             protocol = "ipns";
         }
 
-        if (isIPFS.path(cid)) {
-            gatewaySuffix = cid
-        } else {
-            const response: Response = await _options.fetchOverride(uri, {
-                method: "get",
-            });
-
-            if (response.status >= 300 || response.status < 200) {
-                throw new Error(`Url (${uri}) did not return a 2xx response and did not match a valid IPFS/IPNS format.`);
-            }
-
-            return {
-                response,
-                urlResolvedFrom: uri,
-            };
-        }
+        gatewaySuffix = cid
     }
 
     // check to see if the link has the ipfs:// or ipns:// protocol/scheme
@@ -163,7 +173,6 @@ async function resolve(uri: string, options?: ResolveOptions): Promise<ResolveOu
         }
 
         gatewaySuffix = `/${protocol}/${cidWithOptionalPath}`;
-
     }
 
     // when all other methods fail, it is a regular URL and will be requested like normal

src/test.ts

@@ -12,6 +12,7 @@ describe("Tests the ipfs-race library.", () => {
     const testUrlSubdomainWithPath = "https://bafybeih3dhxuzle4nt2rirdezbssc43vjrws2f7zocbzrsgjqe5zo3b23e.ipfs.nftstorage.link/10896.json";
     const testUrlSubdomainWithResult = {"name":"Iron Pigeon #10896 1st Edition","symbol":"XPTCS","description":"Mike Tyson brings his love for pigeons to the Metaverse by making them the second set in the Ex Populus Trading Card System. Mint your own Iron Pigeon and evolve your way to Legendary in the game Final Form. Learn more about Final Form: https://expopulus.com/games/final-form","seller_fee_basis_points":1000,"image":"https://ipfs.io/ipfs/QmbrCdrecFDeuDKukaC97vb3uZ5ioHiWzzb1VncLDKhFGA","external_url":"https://ironpigeons.expopulus.com","attributes":[{"trait_type":"Rarity","value":"rare"},{"trait_type":"Power","value":"286"},{"trait_type":"Health","value":"healthy"},{"trait_type":"Attack","value":"formidable"},{"trait_type":"Ability 1","value":"Evade"},{"trait_type":"House","value":"Machines"},{"trait_type":"Set Name","value":"Iron Pigeons"},{"trait_type":"Set Number","value":"2"},{"trait_type":"Edition","value":"1st Edition"},{"trait_type":"Card Number","value":"10896"},{"trait_type":"Body","value":"shredded white"},{"trait_type":"Costume","value":"high-top fade"},{"trait_type":"Beak","value":"standard"},{"trait_type":"Eyes","value":"pink"},{"trait_type":"Background","value":"blue"}],"collection":{"name":"Iron Pigeons","family":"Ex Populus Trading Card System"},"properties":{"creators":[{"address":"3NXTh2Bw64a72RGGJ2mh8V7YEW2jERGdESjqxyvBoXo1","share":35},{"address":"39gMkx283UsuKNt5ogETWdHHaGyBwbh8sU5cKAEQjU2w","share":15},{"address":"4MnG71K4EXDHFysnnftV9YLDhnUjfxY5jTE34QAx4Pho","share":50}],"files":[{"uri":"https://ipfs.io/ipfs/QmbrCdrecFDeuDKukaC97vb3uZ5ioHiWzzb1VncLDKhFGA","type":"image/png"},{"uri":"https://ipfs.io/ipfs/QmXT3yXQ6dEZawcGTwXjwQhTaDgKMwuTts6fU9S2jyyPoh","type":"image/png"},{"uri":"https://ipfs.io/ipfs/QmUCSep13eQCrNpAnQSwpadtJDgUW4D1CWUUooFYeUMUGt","type":"image/png"},{"uri":"https://ipfs.io/ipfs/QmY9KQYHTMxGHK7VizvmyqDFxR5LgRfEGjkJmuuax7nvVL","type":"image/png"}],"category":"image"}};
 
+
     it("cid with no path", async () => {
         const {response, urlResolvedFrom} = await resolve(testCidWithNoPath);
         expect(await response.json(), urlResolvedFrom).to.deep.equal(testCidWithNoPathResult);
@@ -47,11 +48,6 @@ describe("Tests the ipfs-race library.", () => {
         expect(await response.json(), urlResolvedFrom).to.deep.equal(testUrlSubdomainWithResult);
     });
 
-    it("test ipfs subdomain with no path", async () => {
-        // const {response, urlResolvedFrom} = await resolve(testUrlSubdomainWithPath);
-        // expect(await response.json(), urlResolvedFrom).to.deep.equal(testUrlSubdomainWithResult);
-    });
-
     it("check that each default ipfs gateway to be a valid url", () => {
         for (const url of defaultIpfsGateways) {
             expect(isValidHttpUrl(url)).to.be.true;