feat: walletconnect

examples/sandbox/index.html

@@ -119,6 +119,7 @@ <h4>Select</h4>
       <button id="xdefi">Pair XDEFI</button>
       <button id="keplr">Pair Keplr</button>
       <button id="tallyHo">Pair Tally Ho</button>
+      <button id="walletConnect">Pair WalletConnect</button>
 
       <select id="keyring" style="height: 100px" size="4"></select>
     </div>

examples/sandbox/index.ts

@@ -12,6 +12,7 @@ import * as native from "@shapeshiftoss/hdwallet-native";
 import * as portis from "@shapeshiftoss/hdwallet-portis";
 import * as tallyHo from "@shapeshiftoss/hdwallet-tallyho";
 import * as trezorConnect from "@shapeshiftoss/hdwallet-trezor-connect";
+import * as walletConnect from "@shapeshiftoss/hdwallet-walletconnect";
 import * as xdefi from "@shapeshiftoss/hdwallet-xdefi";
 import $ from "jquery";
 import Web3 from "web3";
@@ -67,6 +68,7 @@ const kkemuAdapter = keepkeyTcp.TCPKeepKeyAdapter.useKeyring(keyring);
 const portisAdapter = portis.PortisAdapter.useKeyring(keyring, { portisAppId });
 const metaMaskAdapter = metaMask.MetaMaskAdapter.useKeyring(keyring);
 const tallyHoAdapter = tallyHo.TallyHoAdapter.useKeyring(keyring);
+const walletConnectAdapter = walletConnect.WalletConnectAdapter.useKeyring(keyring);
 const xdefiAdapter = xdefi.XDEFIAdapter.useKeyring(keyring);
 const keplrAdapter = keplr.KeplrAdapter.useKeyring(keyring);
 const nativeAdapter = native.NativeAdapter.useKeyring(keyring, {
@@ -100,6 +102,7 @@ const $portis = $("#portis");
 const $native = $("#native");
 const $metaMask = $("#metaMask");
 const $tallyHo = $("#tallyHo");
+const $walletConnect = $("#walletConnect");
 const $xdefi = $("#xdefi");
 const $keplr = $("#keplr");
 const $keyring = $("#keyring");
@@ -214,6 +217,24 @@ $tallyHo.on("click", async (e) => {
   }
 });
 
+$walletConnect.on("click", async (e) => {
+  e.preventDefault();
+  try {
+    const config = {
+      rpc: {
+        1: "https://mainnet.infura.io/v3/d734c7eebcdf400185d7eb67322a7e57",
+      },
+    };
+    wallet = await walletConnectAdapter.pairDevice(config);
+    window["wallet"] = wallet;
+    let deviceID = "nothing";
+    deviceID = await wallet.getDeviceID();
+    $("#keyring select").val(deviceID);
+  } catch (error) {
+    console.error(error);
+  }
+});
+
 $xdefi.on("click", async (e) => {
   e.preventDefault();
   wallet = await xdefiAdapter.pairDevice("testid");
@@ -314,6 +335,12 @@ async function deviceConnected(deviceId) {
     console.error("Could not initialize TallyHoAdapter", e);
   }
 
+  try {
+    await walletConnectAdapter.initialize();
+  } catch (e) {
+    console.error("Could not initialize WalletConnectAdapter", e);
+  }
+
   for (const deviceID of Object.keys(keyring.wallets)) {
     await deviceConnected(deviceID);
   }

examples/sandbox/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hdwallet-sandbox",
-  "version": "1.23.0",
+  "version": "1.23.1-alpha.4",
   "license": "MIT",
   "private": true,
   "browserslist": "> 0.5%, last 2 versions, not dead",
@@ -21,6 +21,7 @@
     "@shapeshiftoss/hdwallet-portis": "1.23.0",
     "@shapeshiftoss/hdwallet-trezor": "1.23.0",
     "@shapeshiftoss/hdwallet-trezor-connect": "1.23.0",
+    "@shapeshiftoss/hdwallet-walletconnect": "^1.23.1-alpha.3",
     "@shapeshiftoss/hdwallet-xdefi": "1.23.0",
     "bip32": "^2.0.4",
     "jquery": "^3.4.1",

integration/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shapeshiftoss/integration",
-  "version": "1.23.0",
+  "version": "1.23.1-alpha.4",
   "main": "index.js",
   "license": "MIT",
   "private": true,
@@ -10,15 +10,15 @@
     "dev": "lerna run test --scope integration --parallel --include-filtered-dependencies"
   },
   "dependencies": {
-    "@shapeshiftoss/hdwallet-core": "1.23.0",
-    "@shapeshiftoss/hdwallet-keepkey": "1.23.0",
-    "@shapeshiftoss/hdwallet-keepkey-nodewebusb": "1.23.0",
-    "@shapeshiftoss/hdwallet-keepkey-tcp": "1.23.0",
-    "@shapeshiftoss/hdwallet-ledger": "1.23.0",
-    "@shapeshiftoss/hdwallet-native": "1.23.0",
-    "@shapeshiftoss/hdwallet-portis": "1.23.0",
-    "@shapeshiftoss/hdwallet-trezor": "1.23.0",
-    "@shapeshiftoss/hdwallet-xdefi": "1.23.0",
+    "@shapeshiftoss/hdwallet-core": "1.23.1-alpha.4",
+    "@shapeshiftoss/hdwallet-keepkey": "1.23.1-alpha.4",
+    "@shapeshiftoss/hdwallet-keepkey-nodewebusb": "1.23.1-alpha.4",
+    "@shapeshiftoss/hdwallet-keepkey-tcp": "1.23.1-alpha.4",
+    "@shapeshiftoss/hdwallet-ledger": "1.23.1-alpha.4",
+    "@shapeshiftoss/hdwallet-native": "1.23.1-alpha.4",
+    "@shapeshiftoss/hdwallet-portis": "1.23.1-alpha.4",
+    "@shapeshiftoss/hdwallet-trezor": "1.23.1-alpha.4",
+    "@shapeshiftoss/hdwallet-xdefi": "1.23.1-alpha.4",
     "@types/jest": "^26.0.23",
     "fast-json-stable-stringify": "^2.1.0",
     "jest": "^26.6.3",

integration/src/integration.ts

@@ -6,6 +6,7 @@ import * as native from "@shapeshiftoss/hdwallet-native";
 import * as portis from "@shapeshiftoss/hdwallet-portis";
 import * as tallyHo from "@shapeshiftoss/hdwallet-tallyho";
 import * as trezor from "@shapeshiftoss/hdwallet-trezor";
+import * as walletconnect from "@shapeshiftoss/hdwallet-walletconnect";
 import * as xdefi from "@shapeshiftoss/hdwallet-xdefi";
 
 import { binanceTests } from "./binance";
@@ -56,6 +57,7 @@ export function integration(suite: WalletSuite): void {
             (native.isNative(wallet) ? 1 : 0) +
             (metamask.isMetaMask(wallet) ? 1 : 0) +
             (tallyHo.isTallyHo(wallet) ? 1 : 0) +
+            (walletconnect.isWalletConnect(wallet) ? 1 : 0) +
             (xdefi.isXDEFI(wallet) ? 1 : 0)
         ).toEqual(1);
       });

integration/src/walletconnect.test.ts

@@ -0,0 +1,3 @@
+import { integration } from "./integration";
+import * as WalletConnect from "./wallets/walletconnect";
+integration(WalletConnect);

integration/src/wallets/walletconnect.ts

@@ -0,0 +1,216 @@
+import * as core from "@shapeshiftoss/hdwallet-core";
+import * as walletconnect from "@shapeshiftoss/hdwallet-walletconnect";
+
+export function name(): string {
+  return "WalletConnect";
+}
+
+export function createInfo(): core.HDWalletInfo {
+  return new walletconnect.WalletConnectWalletInfo();
+}
+
+export async function createWallet(): Promise<core.HDWallet> {
+  const accounts = [
+    "0x3f2329C9ADFbcCd9A84f52c906E936A42dA18CB8",
+    "0x8CB8864f185f14e8d7da0000e4a55a09e4156ff6",
+    "0x4e8d2E3d5FDe8CB80A917e258548268734973f23",
+  ];
+  const provider = {
+    request: jest.fn(({ method, params }: any) => {
+      switch (method) {
+        case "eth_accounts":
+          return accounts;
+        case "personal_sign": {
+          const [message] = params;
+
+          if (message === "48656c6c6f20576f726c64")
+            return "0x29f7212ecc1c76cea81174af267b67506f754ea8c73f144afa900a0d85b24b21319621aeb062903e856352f38305710190869c3ce5a1425d65ef4fa558d0fc251b";
+
+          throw new Error("unknown message");
+        }
+        case "eth_sendTransaction": {
+          const [{ to }] = params;
+
+          return `txHash-${to}`;
+        }
+        default:
+          throw new Error(`ethereum: Unkown method ${method}`);
+      }
+    }),
+    bridge: "https://bridge.walletconnect.org",
+    qrcode: true,
+    qrcodeModal: {},
+    qrcodeModalOptions: undefined,
+    rpc: null,
+    infuraId: "",
+    http: null,
+    wc: {
+      sendTransaction: jest.fn((msg) => {
+        const { to } = msg;
+        return { hash: `txHash-${to}` };
+      }),
+      signMessage: jest.fn().mockReturnValue({
+        address: "0x3f2329C9ADFbcCd9A84f52c906E936A42dA18CB8",
+        signature:
+          "0x29f7212ecc1c76cea81174af267b67506f754ea8c73f144afa900a0d85b24b21319621aeb062903e856352f38305710190869c3ce5a1425d65ef4fa558d0fc251b",
+      }),
+    }, // connector
+    isConnecting: false,
+    connected: false,
+    connectCallbacks: [],
+    rpcUrl: "",
+    isWalletConnect: true,
+    connector: {
+      chainId: 1,
+      accounts,
+      connected: true,
+    },
+    walletMeta: {
+      // wc.peerMeta
+    },
+    enable: async () => Promise.resolve(accounts),
+    send: jest.fn(),
+    onConnect: jest.fn(),
+    triggerConnect: jest.fn(),
+    disconnect: jest.fn(), // alias for close
+    close: jest.fn(),
+    handleRequest: jest.fn(),
+    handleOtherRequests: jest.fn(),
+    handleReadRequests: jest.fn(),
+    formatResponse: jest.fn(),
+    getWalletConnector: jest.fn(),
+    subscribeWalletConnector: jest.fn(),
+    onDisconnect: jest.fn(),
+    updateState: jest.fn(),
+    updateRpcUrl: jest.fn(),
+    updateHttpConnection: jest.fn(),
+    sendAsyncPromise: jest.fn(),
+  };
+  const wallet = new walletconnect.WalletConnectHDWallet(provider as any);
+  await wallet.initialize();
+  return wallet;
+}
+
+export function selfTest(get: () => core.HDWallet): void {
+  let wallet: walletconnect.WalletConnectHDWallet;
+
+  beforeAll(async () => {
+    const w = get() as walletconnect.WalletConnectHDWallet;
+
+    if (walletconnect.isWalletConnect(w) && !core.supportsBTC(w) && core.supportsETH(w)) {
+      wallet = w;
+    } else {
+      throw new Error("Wallet is not a WalletConnect");
+    }
+  });
+
+  it("supports Ethereum mainnet", async () => {
+    if (!wallet) return;
+    expect(await wallet.ethSupportsNetwork()).toEqual(true);
+  });
+
+  it("does not support BTC", async () => {
+    if (!wallet) return;
+    expect(core.supportsBTC(wallet)).toBe(false);
+  });
+
+  it("does not support Native ShapeShift", async () => {
+    if (!wallet) return;
+    expect(wallet.ethSupportsNativeShapeShift()).toEqual(false);
+  });
+
+  it("does not support EIP1559", async () => {
+    if (!wallet) return;
+    expect(await wallet.ethSupportsEIP1559()).toEqual(false);
+  });
+
+  it("does not support Secure Transfer", async () => {
+    if (!wallet) return;
+    expect(await wallet.ethSupportsSecureTransfer()).toEqual(false);
+  });
+
+  it("uses correct eth bip44 paths", () => {
+    if (!wallet) return;
+    [0, 1, 3, 27].forEach((account) => {
+      const paths = wallet.ethGetAccountPaths({
+        coin: "Ethereum",
+        accountIdx: account,
+      });
+      expect(paths).toEqual([
+        {
+          addressNList: core.bip32ToAddressNList(`m/44'/60'/${account}'/0/0`),
+          hardenedPath: core.bip32ToAddressNList(`m/44'/60'/${account}'`),
+          relPath: [0, 0],
+          description: "WalletConnect",
+        },
+      ]);
+      paths.forEach((path) => {
+        expect(
+          wallet.describePath({
+            coin: "Ethereum",
+            path: path.addressNList,
+          }).isKnown
+        ).toBeTruthy();
+      });
+    });
+  });
+
+  it("can describe ETH paths", () => {
+    if (!wallet) return;
+    expect(
+      wallet.describePath({
+        path: core.bip32ToAddressNList("m/44'/60'/0'/0/0"),
+        coin: "Ethereum",
+      })
+    ).toEqual({
+      verbose: "Ethereum Account #0",
+      coin: "Ethereum",
+      isKnown: true,
+      isPrefork: false,
+      accountIdx: 0,
+      wholeAccount: true,
+    });
+
+    expect(
+      wallet.describePath({
+        path: core.bip32ToAddressNList("m/44'/60'/3'/0/0"),
+        coin: "Ethereum",
+      })
+    ).toEqual({
+      verbose: "Ethereum Account #3",
+      coin: "Ethereum",
+      isKnown: true,
+      isPrefork: false,
+      accountIdx: 3,
+      wholeAccount: true,
+    });
+
+    expect(
+      wallet.describePath({
+        path: core.bip32ToAddressNList("m/44'/60'/0'/0/3"),
+        coin: "Ethereum",
+      })
+    ).toEqual({
+      verbose: "m/44'/60'/0'/0/3",
+      coin: "Ethereum",
+      isKnown: false,
+    });
+  });
+
+  it("should return a valid ETH address", async () => {
+    if (!wallet) return;
+    expect(await wallet.ethGetAddress()).toEqual("0x3f2329C9ADFbcCd9A84f52c906E936A42dA18CB8");
+  });
+
+  it("should sign a message", async () => {
+    if (!wallet) return;
+    const res = await wallet.ethSignMessage({
+      addressNList: core.bip32ToAddressNList("m/44'/60'/0'/0/0"),
+      message: "Hello World",
+    });
+    expect(res?.address).toEqual("0x3f2329C9ADFbcCd9A84f52c906E936A42dA18CB8");
+    expect(res?.signature).toEqual(
+      "0x29f7212ecc1c76cea81174af267b67506f754ea8c73f144afa900a0d85b24b21319621aeb062903e856352f38305710190869c3ce5a1425d65ef4fa558d0fc251b"
+    );
+  });
+}

integration/tsconfig.json

@@ -3,7 +3,8 @@
   "compilerOptions": {
     "rootDir": "src",
     "outDir": "dist",
-    "resolveJsonModule": true
+    "resolveJsonModule": true,
+    "types": ["jest"]
   },
   "include": ["./src/**/*.[ts|json]"],
   "exclude": ["node_modules", "dist"]

lerna.json

@@ -1,6 +1,6 @@
 {
   "lerna": "3.22.1",
-  "version": "1.23.0",
+  "version": "1.23.1-alpha.4",
   "npmClient": "yarn",
   "useWorkspaces": true,
   "command": {

packages/hdwallet-core/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shapeshiftoss/hdwallet-core",
-  "version": "1.23.0",
+  "version": "1.23.1-alpha.4",
   "license": "MIT",
   "publishConfig": {
     "access": "public"