replace ethereum plugin with ethereum wrapper

packages/cli/package.json

@@ -47,7 +47,7 @@
     "@polywrap/client-js": "0.10.0-pre.8",
     "@polywrap/core-js": "0.10.0-pre.8",
     "@polywrap/ens-resolver-plugin-js": "0.10.0-pre.8",
-    "@polywrap/ethereum-plugin-js": "0.10.0-pre.8",
+    "ethereum-provider-js": "0.1.7",
     "@polywrap/ipfs-plugin-js": "~0.10.0-pre",
     "@polywrap/logging-js": "0.10.0-pre.8",
     "@polywrap/os-js": "0.10.0-pre.8",
@@ -58,6 +58,9 @@
     "@polywrap/test-env-js": "0.10.0-pre.8",
     "@polywrap/wasm-js": "0.10.0-pre.8",
     "@polywrap/wrap-manifest-types-js": "0.10.0-pre.8",
+    "@polywrap/result": "0.10.0-pre.7",
+    "@polywrap/uri-resolvers-js": "0.10.0-pre.7",
+    "@polywrap/uri-resolver-extensions-js": "0.10.0-pre.7",
     "axios": "0.21.2",
     "chalk": "4.1.0",
     "chokidar": "3.5.1",

packages/cli/src/__tests__/unit/option-parsers/option-parsers.spec.ts

@@ -4,7 +4,7 @@ import { parseWrapperEnvsOption } from "../../../lib";
 describe("unit tests for option-parsers", () => {
   describe("wrapper-envs", () => {
     const sampleFileEnvs = {
-      "ens/ethereum.polywrap.eth": {
+      "ens/wraps.eth:ethereum@1.0.0": {
         connection: {
           networkNameOrChainId: "mainnet",
           node: "https://mainnet.infura.io/v3/some_api_key",

packages/cli/src/__tests__/unit/option-parsers/samples/wrapper-envs.json

@@ -2,7 +2,7 @@
   "ens/hello-world.polywrap.eth": {
     "foo": "bar"
   },
-  "ens/ethereum.polywrap.eth": {
+  "ens/wraps.eth:ethereum@1.0.0": {
     "connection": {
       "node": "https://mainnet.infura.io/v3/some_api_key",
       "networkNameOrChainId": "mainnet"

packages/cli/src/__tests__/unit/option-parsers/samples/wrapper-envs.yaml

@@ -1,6 +1,6 @@
 ens/hello-world.polywrap.eth:
   foo: bar
-ens/ethereum.polywrap.eth:
+ens/wraps.eth:ethereum@1.0.0:
   connection:
     node: https://mainnet.infura.io/v3/some_api_key
     networkNameOrChainId: mainnet

packages/cli/src/lib/defaults/deploy-modules/ens-recursive-name-register/index.ts

@@ -1,20 +1,20 @@
 /* eslint-disable @typescript-eslint/no-require-imports */
 /* eslint-disable @typescript-eslint/no-var-requires */
 import { DeployModule } from "../../../deploy";
+import { invokeWithTimeout } from "./invokeWithTimeout";
 
 import { Wallet } from "@ethersproject/wallet";
 import { JsonRpcProvider } from "@ethersproject/providers";
 import { Uri } from "@polywrap/core-js";
 import {
-  ethereumPlugin,
   Connections,
   Connection,
-} from "@polywrap/ethereum-plugin-js";
-import { embeddedWrappers } from "@polywrap/test-env-js";
+  ethereumProviderPlugin,
+} from "ethereum-provider-js";
 import { PolywrapClient } from "@polywrap/client-js";
 import {
-  defaultIpfsProviders,
-  defaultPackages,
+  defaultInterfaces,
+  defaultWrappers,
 } from "@polywrap/client-config-builder-js";
 
 class ENSRecursiveNameRegisterPublisher implements DeployModule {
@@ -52,34 +52,11 @@ class ENSRecursiveNameRegisterPublisher implements DeployModule {
       ? new Wallet(config.privateKey).connect(connectionProvider)
       : undefined;
 
-    const ethereumPluginUri = "wrap://ens/ethereum.polywrap.eth";
-    const ensWrapperUri = embeddedWrappers.ens;
-
     const client = new PolywrapClient({
-      envs: [
-        {
-          uri: defaultPackages.ipfsResolver,
-          env: {
-            provider: defaultIpfsProviders[0],
-            fallbackProviders: defaultIpfsProviders.slice(1),
-            retries: { tryResolveUri: 2, getFile: 2 },
-          },
-        },
-      ],
-      redirects: [
-        {
-          from: "wrap://ens/uts46.polywrap.eth",
-          to: embeddedWrappers.uts46,
-        },
-        {
-          from: "wrap://ens/sha3.polywrap.eth",
-          to: embeddedWrappers.sha3,
-        },
-      ],
       packages: [
         {
-          uri: ethereumPluginUri,
-          package: ethereumPlugin({
+          uri: defaultInterfaces.ethereumProvider,
+          package: ethereumProviderPlugin({
             connections: new Connections({
               networks: {
                 [network]: new Connection({
@@ -96,7 +73,7 @@ class ENSRecursiveNameRegisterPublisher implements DeployModule {
 
     const signerAddress = await client.invoke<string>({
       method: "getSignerAddress",
-      uri: ethereumPluginUri,
+      uri: defaultWrappers.ethereum,
       args: {
         connection: {
           networkNameOrChainId: network,
@@ -108,9 +85,11 @@ class ENSRecursiveNameRegisterPublisher implements DeployModule {
       throw new Error("Could not get signer");
     }
 
-    const registerData = await client.invoke<{ hash: string }>({
+    const registerData = await client.invoke<
+      { tx: { hash: string }; didRegister: boolean }[]
+    >({
       method: "registerDomainAndSubdomainsRecursively",
-      uri: ensWrapperUri,
+      uri: defaultWrappers.ens,
       args: {
         domain: ensDomain,
         owner: signerAddress.value,
@@ -131,18 +110,23 @@ class ENSRecursiveNameRegisterPublisher implements DeployModule {
       );
     }
 
-    await client.invoke({
-      method: "awaitTransaction",
-      uri: ethereumPluginUri,
-      args: {
-        txHash: registerData.value.hash,
-        confirmations: 1,
-        timeout: 15000,
-        connection: {
-          networkNameOrChainId: network,
+    // didRegister can be false if the ens domain is already registered, in which case there is no transaction
+    if (registerData.value[0].didRegister) {
+      await invokeWithTimeout(
+        client,
+        {
+          method: "awaitTransaction",
+          uri: Uri.from(defaultWrappers.ethereum),
+          args: {
+            txHash: registerData.value[0].tx.hash,
+            connection: {
+              networkNameOrChainId: network,
+            },
+          },
         },
-      },
-    });
+        15000
+      );
+    }
 
     return new Uri(`ens/${network}/${ensDomain}`);
   }

packages/cli/src/lib/defaults/deploy-modules/ens-recursive-name-register/invokeWithTimeout.ts

@@ -0,0 +1,56 @@
+import {
+  Invoker,
+  InvokeResult,
+  InvokerOptions,
+  WrapError,
+  WrapErrorCode,
+} from "@polywrap/core-js";
+import { ResultErr } from "@polywrap/result";
+
+/**
+ * Invoke a wrapper; abort the invocation if a timeout expires.
+ *
+ * @param client - a Polywrap Invoker (e.g. CoreClient)
+ * @param options - invocation options
+ * @param timeout - a timeout period (in ms)
+ * */
+export async function invokeWithTimeout<TResult>(
+  client: Invoker,
+  options: InvokerOptions,
+  timeout: number
+): Promise<InvokeResult<TResult>> {
+  const controller = new AbortController();
+
+  const timer = setTimeout(() => {
+    controller.abort();
+  }, timeout);
+
+  return await new Promise<InvokeResult<TResult>>((resolve, reject) => {
+    controller.signal.addEventListener("abort", () => {
+      const wrapError = new WrapError("Timeout has been reached", {
+        code: WrapErrorCode.WRAPPER_INVOKE_ABORTED,
+        uri: options.uri.uri,
+        method: options.method,
+        args: JSON.stringify(options.args, null, 2),
+      });
+      reject(wrapError);
+    });
+    client
+      .invoke<TResult>(options)
+      .then((result) => resolve(result))
+      .catch((error) => {
+        // the client threw an error (this should never happen)
+        const wrapError = new WrapError(error.message, {
+          code: WrapErrorCode.WRAPPER_INVOKE_FAIL,
+          uri: options.uri.uri,
+          method: options.method,
+          args: JSON.stringify(options.args, null, 2),
+        });
+        resolve(ResultErr(wrapError));
+      });
+  })
+    .catch((error) => {
+      return ResultErr<WrapError>(error as WrapError);
+    })
+    .finally(() => timer && clearTimeout(timer));
+}

packages/cli/src/lib/defaults/deploy-modules/ens/index.ts

@@ -1,20 +1,20 @@
 /* eslint-disable @typescript-eslint/no-require-imports */
 /* eslint-disable @typescript-eslint/no-var-requires */
 import { DeployModule } from "../../../deploy";
+import { invokeWithTimeout } from "./invokeWithTimeout";
 
 import { Wallet } from "@ethersproject/wallet";
 import { JsonRpcProvider } from "@ethersproject/providers";
 import { Uri } from "@polywrap/core-js";
 import {
   Connections,
   Connection,
-  ethereumPlugin,
-} from "@polywrap/ethereum-plugin-js";
-import { embeddedWrappers } from "@polywrap/test-env-js";
+  ethereumProviderPlugin,
+} from "ethereum-provider-js";
 import { PolywrapClient } from "@polywrap/client-js";
 import {
-  defaultIpfsProviders,
-  defaultPackages,
+  defaultInterfaces,
+  defaultWrappers,
 } from "@polywrap/client-config-builder-js";
 
 const contentHash = require("content-hash");
@@ -49,34 +49,11 @@ class ENSPublisher implements DeployModule {
       ? new Wallet(config.privateKey).connect(connectionProvider)
       : undefined;
 
-    const ethereumPluginUri = "wrap://ens/ethereum.polywrap.eth";
-    const ensWrapperUri = embeddedWrappers.ens;
-
     const client = new PolywrapClient({
-      envs: [
-        {
-          uri: defaultPackages.ipfsResolver,
-          env: {
-            provider: defaultIpfsProviders[0],
-            fallbackProviders: defaultIpfsProviders.slice(1),
-            retries: { tryResolveUri: 2, getFile: 2 },
-          },
-        },
-      ],
-      redirects: [
-        {
-          from: "wrap://ens/uts46.polywrap.eth",
-          to: embeddedWrappers.uts46,
-        },
-        {
-          from: "wrap://ens/sha3.polywrap.eth",
-          to: embeddedWrappers.sha3,
-        },
-      ],
       packages: [
         {
-          uri: ethereumPluginUri,
-          package: ethereumPlugin({
+          uri: defaultInterfaces.ethereumProvider,
+          package: ethereumProviderPlugin({
             connections: new Connections({
               networks: {
                 [network]: new Connection({
@@ -93,7 +70,7 @@ class ENSPublisher implements DeployModule {
 
     const resolver = await client.invoke<string>({
       method: "getResolver",
-      uri: ensWrapperUri,
+      uri: defaultWrappers.ens,
       args: {
         registryAddress: config.ensRegistryAddress,
         domain: config.domainName,
@@ -115,7 +92,7 @@ class ENSPublisher implements DeployModule {
 
     const setContenthashData = await client.invoke<{ hash: string }>({
       method: "setContentHash",
-      uri: ensWrapperUri,
+      uri: defaultWrappers.ens,
       args: {
         domain: config.domainName,
         cid: hash,
@@ -130,18 +107,20 @@ class ENSPublisher implements DeployModule {
       throw new Error(`Could not set contentHash for '${config.domainName}'`);
     }
 
-    await client.invoke({
-      method: "awaitTransaction",
-      uri: ethereumPluginUri,
-      args: {
-        txHash: setContenthashData.value.hash,
-        confirmations: 1,
-        timeout: 15000,
-        connection: {
-          networkNameOrChainId: network,
+    await invokeWithTimeout(
+      client,
+      {
+        method: "awaitTransaction",
+        uri: Uri.from(defaultWrappers.ethereum),
+        args: {
+          txHash: setContenthashData.value.hash,
+          connection: {
+            networkNameOrChainId: network,
+          },
         },
       },
-    });
+      15000
+    );
 
     return new Uri(`ens/${network}/${config.domainName}`);
   }

packages/cli/src/lib/defaults/deploy-modules/ens/invokeWithTimeout.ts

@@ -0,0 +1,56 @@
+import {
+  Invoker,
+  InvokeResult,
+  InvokerOptions,
+  WrapError,
+  WrapErrorCode,
+} from "@polywrap/core-js";
+import { ResultErr } from "@polywrap/result";
+
+/**
+ * Invoke a wrapper; abort the invocation if a timeout expires.
+ *
+ * @param client - a Polywrap Invoker (e.g. CoreClient)
+ * @param options - invocation options
+ * @param timeout - a timeout period (in ms)
+ * */
+export async function invokeWithTimeout<TResult>(
+  client: Invoker,
+  options: InvokerOptions,
+  timeout: number
+): Promise<InvokeResult<TResult>> {
+  const controller = new AbortController();
+
+  const timer = setTimeout(() => {
+    controller.abort();
+  }, timeout);
+
+  return await new Promise<InvokeResult<TResult>>((resolve, reject) => {
+    controller.signal.addEventListener("abort", () => {
+      const wrapError = new WrapError("Timeout has been reached", {
+        code: WrapErrorCode.WRAPPER_INVOKE_ABORTED,
+        uri: options.uri.uri,
+        method: options.method,
+        args: JSON.stringify(options.args, null, 2),
+      });
+      reject(wrapError);
+    });
+    client
+      .invoke<TResult>(options)
+      .then((result) => resolve(result))
+      .catch((error) => {
+        // the client threw an error (this should never happen)
+        const wrapError = new WrapError(error.message, {
+          code: WrapErrorCode.WRAPPER_INVOKE_FAIL,
+          uri: options.uri.uri,
+          method: options.method,
+          args: JSON.stringify(options.args, null, 2),
+        });
+        resolve(ResultErr(wrapError));
+      });
+  })
+    .catch((error) => {
+      return ResultErr<WrapError>(error as WrapError);
+    })
+    .finally(() => timer && clearTimeout(timer));
+}