feat: CAIP Multichain (New)

.circleci/config.yml

@@ -215,6 +215,9 @@ workflows:
       - test-api-specs:
           requires:
             - prep-build-test
+      - test-api-specs-multichain:
+          requires:
+            - prep-build-test
       - test-e2e-chrome-multiple-providers:
           requires:
             - prep-build-test
@@ -870,7 +873,7 @@ jobs:
           at: .
       - run:
           name: Build extension for testing
-          command: yarn build:test
+          command: CHAIN_PERMISSIONS=1 BARAD_DUR=1 yarn build:test
       - run:
           name: Move test build to 'dist-test' to avoid conflict with production build
           command: mv ./dist ./dist-test
@@ -1091,6 +1094,37 @@ jobs:
       - store_test_results:
           path: test/test-results/e2e
 
+  test-api-specs-multichain:
+    executor: node-browsers-medium-plus
+    steps:
+      - run: *shallow-git-clone-and-enable-vnc
+      - run: sudo corepack enable
+      - attach_workspace:
+          at: .
+      - run:
+          name: Move test build to dist
+          command: mv ./dist-test ./dist
+      - run:
+          name: Move test zips to builds
+          command: mv ./builds-test ./builds
+      - gh/install
+      - run:
+          name: test:api-specs-multichain
+          command: .circleci/scripts/test-run-e2e.sh yarn test:api-specs-multichain
+          no_output_timeout: 5m
+      - run:
+          name: Comment on PR
+          command: |
+            if [  -f html-report-multichain/index.html ]; then
+              gh pr comment "${CIRCLE_PR_NUMBER}" --body ":x: Multichain API Spec Test Failed. View the report [here](https://output.circle-artifacts.com/output/job/${CIRCLE_WORKFLOW_JOB_ID}/artifacts/${CIRCLE_NODE_INDEX}/html-report-multichain/index.html)."
+            else
+              echo "Multichain API Spec Report not found!"
+            fi
+          when: on_fail
+      - store_artifacts:
+          path: html-report-multichain
+          destination: html-report-multichain
+
   test-api-specs:
     executor: node-browsers-medium-plus
     steps:

.gitignore

@@ -75,8 +75,11 @@ lavamoat/**/policy-debug.json
 # Attributions
 licenseInfos.json
 
+# Branding
+/app/images/branding
+
 # API Spec tests
 html-report/
+html-report-multichain/
 
-/app/images/branding
 /changed-files

app/scripts/lib/rpc-method-middleware/createMethodMiddleware.js

@@ -27,6 +27,10 @@ export const createEthAccountsMethodMiddleware = makeMethodMiddlewareMaker([
   ethAccountsHandler,
 ]);
 
+// The primary home of RPC method implementations for the MultiChain API.
+export const createMultichainMethodMiddleware =
+  makeMethodMiddlewareMaker(localHandlers);
+
 /**
  * Creates a method middleware factory function given a set of method handlers.
  *

app/scripts/lib/rpc-method-middleware/createMethodMiddleware.test.js

@@ -6,6 +6,7 @@ import {
 import {
   createEip1193MethodMiddleware,
   createEthAccountsMethodMiddleware,
+  createMultichainMethodMiddleware,
 } from '.';
 
 const getHandler = () => ({
@@ -60,6 +61,7 @@ jest.mock('./handlers', () => ({
 describe.each([
   ['createEip1193MethodMiddleware', createEip1193MethodMiddleware],
   ['createEthAccountsMethodMiddleware', createEthAccountsMethodMiddleware],
+  ['createMultichainMethodMiddleware', createMultichainMethodMiddleware],
 ])('%s', (_name, createMiddleware) => {
   const method1 = 'method1';
 

app/scripts/lib/rpc-method-middleware/createUnsupportedMethodMiddleware.test.ts

@@ -10,8 +10,8 @@ describe('createUnsupportedMethodMiddleware', () => {
   });
   const getMockResponse = () => ({ jsonrpc: jsonrpc2, id: 'foo' });
 
-  it('forwards requests whose methods are not on the list of unsupported methods', () => {
-    const middleware = createUnsupportedMethodMiddleware();
+  it('forwards requests whose methods are not in the list of unsupported methods', () => {
+    const middleware = createUnsupportedMethodMiddleware([]);
     const nextMock = jest.fn();
     const endMock = jest.fn();
 
@@ -22,10 +22,12 @@ describe('createUnsupportedMethodMiddleware', () => {
   });
 
   // @ts-expect-error This function is missing from the Mocha type definitions
-  it.each([...UNSUPPORTED_RPC_METHODS.keys()])(
-    'ends requests for methods that are on the list of unsupported methods: %s',
+  it.each(UNSUPPORTED_RPC_METHODS)(
+    'ends requests for methods that are in the list of unsupported methods: %s',
     (method: string) => {
-      const middleware = createUnsupportedMethodMiddleware();
+      const middleware = createUnsupportedMethodMiddleware(
+        UNSUPPORTED_RPC_METHODS,
+      );
       const nextMock = jest.fn();
       const endMock = jest.fn();
 

app/scripts/lib/rpc-method-middleware/createUnsupportedMethodMiddleware.ts

@@ -1,17 +1,17 @@
 import { ethErrors } from 'eth-rpc-errors';
 import type { JsonRpcMiddleware } from 'json-rpc-engine';
-import { UNSUPPORTED_RPC_METHODS } from '../../../../shared/constants/network';
 
 /**
  * Creates a middleware that rejects explicitly unsupported RPC methods with the
  * appropriate error.
+ *
+ * @param methods
  */
-export function createUnsupportedMethodMiddleware(): JsonRpcMiddleware<
-  unknown,
-  void
-> {
+export function createUnsupportedMethodMiddleware(
+  methods: string[],
+): JsonRpcMiddleware<unknown, void> {
   return async function unsupportedMethodMiddleware(req, _res, next, end) {
-    if ((UNSUPPORTED_RPC_METHODS as Set<string>).has(req.method)) {
+    if (methods.includes(req.method)) {
       return end(ethErrors.rpc.methodNotSupported());
     }
     return next();

app/scripts/lib/rpc-method-middleware/handlers/eth-accounts.test.js

@@ -0,0 +1,40 @@
+import ethereumAccounts from './eth-accounts';
+
+const baseRequest = {
+  origin: 'http://test.com',
+};
+
+const createMockedHandler = () => {
+  const next = jest.fn();
+  const end = jest.fn();
+  const getAccounts = jest.fn().mockResolvedValue(['0xdead', '0xbeef']);
+  const response = {};
+  const handler = (request) =>
+    ethereumAccounts.implementation(request, response, next, end, {
+      getAccounts,
+    });
+
+  return {
+    response,
+    next,
+    end,
+    getAccounts,
+    handler,
+  };
+};
+
+describe('ethAccountsHandler', () => {
+  it('gets sorted eth accounts from the CAIP-25 permission via the getAccounts hook', async () => {
+    const { handler, getAccounts } = createMockedHandler();
+
+    await handler(baseRequest);
+    expect(getAccounts).toHaveBeenCalled();
+  });
+
+  it('returns the accounts', async () => {
+    const { handler, response } = createMockedHandler();
+
+    await handler(baseRequest);
+    expect(response.result).toStrictEqual(['0xdead', '0xbeef']);
+  });
+});