IPFS plugin separation of concerns

packages/core-interfaces/ipfs/README.md

@@ -0,0 +1 @@
+TODO

packages/core-interfaces/ipfs/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "@polywrap/ipfs-interface",
+  "description": "Polywrap Ipfs Interface",
+  "private": true,
+  "version": "0.0.1-prealpha.89",
+  "scripts": {
+    "build": "node ../../../dependencies/node_modules/polywrap/bin/polywrap build",
+    "lint": "eslint --color -c ../../../.eslintrc.js .",
+    "test:env:up": "npx polywrap infra up --modules=eth-ens-ipfs",
+    "test:env:down": "npx polywrap infra down --modules=eth-ens-ipfs",
+    "deploy": "node ../../../dependencies/node_modules/polywrap/bin/polywrap deploy"
+  },
+  "devDependencies": {
+    "polywrap": "0.0.1-prealpha.89"
+  }
+}

packages/core-interfaces/ipfs/polywrap.deploy.yaml

@@ -0,0 +1,5 @@
+format: 0.0.1-prealpha.1
+stages:
+  ipfs_deploy:
+    package: ipfs
+    uri: fs/./build

packages/core-interfaces/ipfs/polywrap.yaml

@@ -0,0 +1,5 @@
+format: 0.0.1-prealpha.9
+name: IPFS
+language: interface
+deploy: ./polywrap.deploy.yaml
+schema: ./src/schema.graphql

packages/core-interfaces/ipfs/src/schema.graphql

@@ -0,0 +1,30 @@
+type Module {
+  cat(cid: String!, options: Options): Bytes!
+
+  resolve(cid: String!, options: Options): ResolveResult
+
+  addFile(data: Bytes!): String!
+}
+
+type ResolveResult {
+  cid: String!
+  provider: String!
+}
+
+type Options {
+  """
+  Timeout (in ms) for the operation.
+  Fallback providers are used if timeout is reached.
+  """
+  timeout: UInt32
+
+  """
+  The IPFS provider to be used
+  """
+  provider: String
+
+  """
+  Disable querying providers in parallel when resolving URIs
+  """
+  disableParallelRequests: Boolean
+}

packages/js/client/package.json

@@ -35,6 +35,7 @@
     "@polywrap/tracing-js": "0.0.1-prealpha.89",
     "@polywrap/uts46-plugin-js": "0.0.1-prealpha.89",
     "@polywrap/fs-resolver-plugin-js": "0.0.1-prealpha.89",
+    "@polywrap/ipfs-resolver-plugin-js": "0.0.1-prealpha.89",
     "graphql": "15.5.0",
     "js-yaml": "3.14.0",
     "uuid": "8.3.2"

packages/js/client/src/__tests__/core/plugin-wrapper.spec.ts

@@ -18,6 +18,7 @@ const defaultPlugins = [
   "wrap://ens/graph-node.polywrap.eth",
   "wrap://ens/fs.polywrap.eth",
   "wrap://ens/fs-resolver.polywrap.eth",
+  "wrap://ens/ipfs-resolver.polywrap.eth",
 ];
 
 describe("plugin-wrapper", () => {

packages/js/client/src/__tests__/core/resolveUri.spec.ts

@@ -331,7 +331,7 @@ describe("resolveUri", () => {
         result: {
           uri: ipfsUri,
           wrapper: true,
-          implementationUri: new Uri("wrap://ens/ipfs.polywrap.eth"),
+          implementationUri: new Uri("wrap://ens/ipfs-resolver.polywrap.eth"),
         },
       },
     ]);
@@ -395,7 +395,7 @@ describe("resolveUri", () => {
         result: {
           uri: ipfsUri,
           wrapper: true,
-          implementationUri: new Uri("wrap://ens/ipfs.polywrap.eth"),
+          implementationUri: new Uri("wrap://ens/ipfs-resolver.polywrap.eth"),
         },
       },
     ]);
@@ -522,7 +522,7 @@ describe("resolveUri", () => {
         result: {
           uri: ipfsUri,
           wrapper: true,
-          implementationUri: new Uri("wrap://ens/ipfs.polywrap.eth"),
+          implementationUri: new Uri("wrap://ens/ipfs-resolver.polywrap.eth"),
         },
       },
     ]);
@@ -586,7 +586,7 @@ describe("resolveUri", () => {
         result: {
           uri: ipfsUri,
           wrapper: true,
-          implementationUri: new Uri("wrap://ens/ipfs.polywrap.eth"),
+          implementationUri: new Uri("wrap://ens/ipfs-resolver.polywrap.eth"),
         },
       },
     ]);
@@ -650,7 +650,7 @@ describe("resolveUri", () => {
         result: {
           uri: ipfsUri,
           wrapper: true,
-          implementationUri: new Uri("wrap://ens/ipfs.polywrap.eth"),
+          implementationUri: new Uri("wrap://ens/ipfs-resolver.polywrap.eth"),
         },
       },
     ]);
@@ -730,7 +730,7 @@ describe("resolveUri", () => {
         result: {
           uri: ipfsUri,
           wrapper: true,
-          implementationUri: new Uri("wrap://ens/ipfs.polywrap.eth"),
+          implementationUri: new Uri("wrap://ens/ipfs-resolver.polywrap.eth"),
         },
       },
     ]);

packages/js/client/src/__tests__/core/sanity.spec.ts

@@ -26,12 +26,13 @@ describe("sanity", () => {
       new Uri("wrap://ens/graph-node.polywrap.eth"),
       new Uri("wrap://ens/fs.polywrap.eth"),
       new Uri("wrap://ens/fs-resolver.polywrap.eth"),
+      new Uri("wrap://ens/ipfs-resolver.polywrap.eth"),
     ]);
     expect(client.getInterfaces()).toStrictEqual([
       {
         interface: coreInterfaceUris.uriResolver,
         implementations: [
-          new Uri("wrap://ens/ipfs.polywrap.eth"),
+          new Uri("wrap://ens/ipfs-resolver.polywrap.eth"),
           new Uri("wrap://ens/ens.polywrap.eth"),
           new Uri("wrap://ens/fs-resolver.polywrap.eth"),
         ],

packages/js/client/src/default-client-config.ts

@@ -13,6 +13,7 @@ import {
   RedirectsResolver,
 } from "@polywrap/core-js";
 import { ipfsPlugin } from "@polywrap/ipfs-plugin-js";
+import { ipfsResolverPlugin } from "@polywrap/ipfs-resolver-plugin-js";
 import { ethereumPlugin } from "@polywrap/ethereum-plugin-js";
 import { ensPlugin } from "@polywrap/ens-plugin-js";
 import { graphNodePlugin } from "@polywrap/graph-node-plugin-js";
@@ -85,12 +86,19 @@ export const getDefaultClientConfig = Tracer.traceFunc(
           uri: new Uri("wrap://ens/fs-resolver.polywrap.eth"),
           plugin: fileSystemResolverPlugin({}),
         },
+        {
+          uri: new Uri("wrap://ens/ipfs-resolver.polywrap.eth"),
+          plugin: ipfsResolverPlugin({
+            provider: defaultIpfsProviders[0],
+            fallbackProviders: defaultIpfsProviders.slice(1),
+          }),
+        },
       ],
       interfaces: [
         {
           interface: coreInterfaceUris.uriResolver,
           implementations: [
-            new Uri("wrap://ens/ipfs.polywrap.eth"),
+            new Uri("wrap://ens/ipfs-resolver.polywrap.eth"),
             new Uri("wrap://ens/ens.polywrap.eth"),
             new Uri("wrap://ens/fs-resolver.polywrap.eth"),
           ],

packages/js/plugins/ipfs/package.json

@@ -23,8 +23,8 @@
     "@dorgjelli-test/ipfs-http-client-lite": "0.3.1",
     "@polywrap/core-js": "0.0.1-prealpha.89",
     "abort-controller": "3.0.0",
-    "cids": "^1.1.4",
-    "is-ipfs": "1.0.3"
+    "is-ipfs": "1.0.3",
+    "multiformats": "9.7.0"
   },
   "devDependencies": {
     "@types/jest": "26.0.8",
@@ -34,7 +34,8 @@
     "rimraf": "3.0.2",
     "ts-jest": "26.5.4",
     "ts-node": "8.10.2",
-    "typescript": "4.0.7"
+    "typescript": "4.0.7",
+    "@polywrap/test-env-js": "0.0.1-prealpha.89"
   },
   "gitHead": "7346adaf5adb7e6bbb70d9247583e995650d390a",
   "publishConfig": {

packages/js/plugins/ipfs/polywrap.plugin.yaml

@@ -4,5 +4,5 @@ language: plugin/typescript
 module: ./src/index.ts
 schema: ./src/schema.graphql
 import_redirects:
-  - uri: "ens/uri-resolver.core.polywrap.eth"
-    schema: ../../../core-interfaces/uri-resolver/src/schema.graphql
+  - uri: "ens/ipfs.polywrap.eth"
+    schema: ../../../core-interfaces/ipfs/build/schema.graphql

packages/js/plugins/ipfs/src/__tests__/e2e.spec.ts

@@ -1,5 +1,90 @@
-/* eslint-disable @typescript-eslint/no-empty-function */
-// TODO: create client, add plugin, test all the methods
-describe("TODO", () => {
-  it("TODO", () => {});
+import { PolywrapClient } from "@polywrap/client-js";
+import {
+  initTestEnvironment,
+  providers,
+  stopTestEnvironment,
+} from "@polywrap/test-env-js";
+
+import { ipfsPlugin } from "..";
+import { IpfsClient, IpfsFileInfo } from "../utils/IpfsClient";
+import { Ipfs_Module } from "../wrap";
+
+const createIpfsClient = require("@dorgjelli-test/ipfs-http-client-lite");
+
+jest.setTimeout(300000);
+
+describe("IPFS Plugin", () => {
+  let client: PolywrapClient;
+  let ipfs: IpfsClient;
+
+  const sampleFileTextContents = "Hello World!";
+  let sampleFileIpfsInfo: IpfsFileInfo;
+  const sampleFileBuffer = Buffer.from(sampleFileTextContents, "utf-8");
+
+  beforeAll(async () => {
+    await initTestEnvironment();
+    ipfs = createIpfsClient(providers.ipfs);
+
+    client = new PolywrapClient({
+      plugins: [
+        {
+          uri: "wrap://ens/ipfs.polywrap.eth",
+          plugin: ipfsPlugin({
+            provider: providers.ipfs,
+          }),
+        },
+      ],
+    });
+
+    let ipfsAddResult = await ipfs.add(sampleFileBuffer);
+    sampleFileIpfsInfo = ipfsAddResult[0];
+  });
+
+  afterAll(async () => {
+    await stopTestEnvironment();
+  });
+
+  it("Should cat a file successfully", async () => {
+    expect(sampleFileIpfsInfo).toBeDefined();
+
+    let result = await Ipfs_Module.cat(
+      { cid: sampleFileIpfsInfo.hash.toString() },
+      client
+    );
+
+    expect(result.error).toBeFalsy();
+
+    expect(result.data).toEqual(sampleFileBuffer);
+  });
+
+  it("Should resolve a file successfully", async () => {
+    expect(sampleFileIpfsInfo).toBeDefined();
+
+    let result = await Ipfs_Module.resolve(
+      { cid: sampleFileIpfsInfo.hash.toString() },
+      client
+    );
+
+    expect(result.error).toBeFalsy();
+
+    expect(result.data).toEqual({
+      cid: `/ipfs/${sampleFileIpfsInfo.hash.toString()}`,
+      provider: providers.ipfs,
+    });
+  });
+
+  it("Should add a file successfully", async () => {
+    const expectedContents = "A new sample file";
+    const contentsBuffer = Buffer.from(expectedContents, "utf-8");
+
+    let result = await Ipfs_Module.addFile({ data: contentsBuffer }, client);
+
+    expect(result.error).toBeFalsy();
+
+    expect(result.data).toBeTruthy();
+
+    const addedFileBuffer = await ipfs.cat(result.data as string);
+
+    expect(contentsBuffer).toEqual(addedFileBuffer);
+  });
 });