feat: EIP-5792 Wallet Call API support (#41)

Co-authored-by: Daniel Sinclair <d@niel.nyc>

Author: janek26

.changeset/batch-receipts.md

@@ -0,0 +1,11 @@
+---
+"@rainbow-me/provider": minor
+---
+
+Add [EIP-5792 Wallet Call API](https://eips.ethereum.org/EIPS/eip-5792) support
+
+- Add `wallet_getCapabilities`, `wallet_sendCalls`, `wallet_getCallsStatus`, and `wallet_showCallsStatus` RPC method handlers
+- Add `createProviderError` for typed pass-through errors from EIP-5792 callbacks
+- Export `BatchRecord`, `BatchRecordBase`, `PendingBatchRecord`, `FinalBatchRecord`, `SendCallsParams`, and `RequestCapability` types
+- **Breaking:** `handleProviderRequest` adds `getCapabilities`, `getBatchByKey`, `setBatch`, and `showCallsStatus` callback options and replaces `isSupportedChain` with `getSupportedChainIds`
+  - Batch state and capability resolution are the caller's responsibility so the provider stays stateless

.env.example

@@ -0,0 +1,2 @@
+# Required for `yarn anvil` and `yarn test` (anvil forks mainnet)
+ETH_MAINNET_RPC=https://your-eth-mainnet-rpc-url

package.json

@@ -35,19 +35,18 @@
     "jsdom": "24.0.0",
     "prettier": "3.2.4",
     "typescript": "5.3.3",
+    "viem": "2.47.5",
     "vitest": "1.6.1"
   },
   "dependencies": {
     "@ethersproject/abstract-provider": "5.7.0",
     "@ethersproject/bignumber": "5.7.0",
     "@ethersproject/providers": "5.7.2",
     "@metamask/eth-sig-util": "7.0.1",
-    "eventemitter3": "5.0.1",
-    "viem": "1.21.4"
+    "eventemitter3": "5.0.1"
   },
-  "resolutions": {
-    "vite": "5.1.7",
-    "braces": "3.0.3"
+  "peerDependencies": {
+    "viem": "^2.40.3"
   },
   "packageManager": "yarn@4.2.2"
 }

src/error.ts

@@ -0,0 +1,53 @@
+import type { RequestError } from './references/messengers';
+import { errorCodes } from './references/errorCodes';
+
+export const buildError = ({
+  id,
+  message,
+  errorCode,
+}: {
+  id: number;
+  errorCode: {
+    code: number;
+    name: string;
+  };
+  message?: string;
+}): { id: number; error: RequestError } => ({
+  id,
+  error: {
+    name: errorCode.name,
+    message,
+    code: errorCode.code,
+  },
+});
+
+/** Error shape that callbacks can throw to pass through to the dapp (avoids INTERNAL_ERROR) */
+export const isPassThroughError = (
+  err: unknown,
+): err is { code: number; name: string; message?: string } =>
+  err !== null &&
+  typeof err === 'object' &&
+  typeof (err as { code?: unknown }).code === 'number' &&
+  typeof (err as { name?: unknown }).name === 'string';
+
+export const toPassThroughResponse = (
+  id: number,
+  err: { code: number; name: string; message?: string },
+) =>
+  buildError({
+    id,
+    message: err.message,
+    errorCode: { code: err.code, name: err.name },
+  });
+
+/** Creates an error that will be passed through when thrown from EIP-5792 callbacks. */
+export const createProviderError = (
+  code: keyof typeof errorCodes,
+  message?: string,
+) => {
+  const errorCode = errorCodes[code];
+  return Object.assign(new Error(message ?? errorCode.name), {
+    code: errorCode.code,
+    name: errorCode.name,
+  });
+};