viem 0.0.0-main.20240402T193906 → 0.0.0-main.20240402T203246

package/experimental/decorators/eip5792.ts

@@ -0,0 +1,139 @@
+import type { Client } from '../../clients/createClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { Account } from '../../types/account.js'
+import type { Chain } from '../../types/chain.js'
+import {
+  type GetCallsStatusParameters,
+  type GetCallsStatusReturnType,
+  getCallsStatus,
+} from '../actions/getCallsStatus.js'
+import {
+  type GetCapabilitiesReturnType,
+  getCapabilities,
+} from '../actions/getCapabilities.js'
+import {
+  type SendCallsParameters,
+  type SendCallsReturnType,
+  sendCalls,
+} from '../actions/sendCalls.js'
+
+export type WalletActionsEip5792<
+  chain extends Chain | undefined = Chain | undefined,
+  account extends Account | undefined = Account | undefined,
+> = {
+  /**
+   * Returns the status of a call batch that was sent via `sendCalls`.
+   *
+   * - Docs: https://viem.sh/eip5792/actions/getCallsStatus
+   * - JSON-RPC Methods: [`wallet_getCallsStatus`](https://eips.ethereum.org/EIPS/eip-5792)
+   *
+   * @param client - Client to use
+   * @returns Status of the calls. {@link GetCallsStatusReturnType}
+   *
+   * @example
+   * import { createWalletClient, custom } from 'viem'
+   * import { mainnet } from 'viem/chains'
+   * import { walletActionsEip5792 } from 'viem/experimental'
+   *
+   * const client = createWalletClient({
+   *   chain: mainnet,
+   *   transport: custom(window.ethereum),
+   * }).extend(walletActionsEip5792())
+   *
+   * const { receipts, status } = await client.getCallsStatus({ id: '0xdeadbeef' })
+   */
+  getCallsStatus: (
+    parameters: GetCallsStatusParameters,
+  ) => Promise<GetCallsStatusReturnType>
+  /**
+   * Extract capabilities that a connected wallet supports (e.g. paymasters, session keys, etc).
+   *
+   * - Docs: https://viem.sh/eip5792/actions/getCapabilities
+   * - JSON-RPC Methods: [`wallet_getCapabilities`](https://eips.ethereum.org/EIPS/eip-5792)
+   *
+   * @param client - Client to use
+   * @returns The wallet's capabilities. {@link GetCapabilitiesReturnType}
+   *
+   * @example
+   * import { createWalletClient, custom } from 'viem'
+   * import { mainnet } from 'viem/chains'
+   * import { walletActionsEip5792 } from 'viem/experimental'
+   *
+   * const client = createWalletClient({
+   *   chain: mainnet,
+   *   transport: custom(window.ethereum),
+   * }).extend(walletActionsEip5792())
+   *
+   * const capabilities = await client.getCapabilities()
+   */
+  getCapabilities: () => Promise<GetCapabilitiesReturnType>
+  /**
+   * Requests the connected wallet to send a batch of calls.
+   *
+   * - Docs: https://viem.sh/eip5792/actions/sendCalls
+   * - JSON-RPC Methods: [`wallet_sendCalls`](https://eips.ethereum.org/EIPS/eip-5792)
+   *
+   * @param client - Client to use
+   * @returns Transaction identifier. {@link SendCallsReturnType}
+   *
+   * @example
+   * import { createWalletClient, custom } from 'viem'
+   * import { mainnet } from 'viem/chains'
+   * import { walletActionsEip5792 } from 'viem/experimental'
+   *
+   * const client = createWalletClient({
+   *   chain: mainnet,
+   *   transport: custom(window.ethereum),
+   * }).extend(walletActionsEip5792())
+   *
+   * const id = await client.sendCalls({
+   *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
+   *   calls: [
+   *     {
+   *       data: '0xdeadbeef',
+   *       to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+   *     },
+   *     {
+   *       to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+   *       value: 69420n,
+   *     },
+   *   ],
+   * })
+   */
+  sendCalls: <chainOverride extends Chain | undefined = undefined>(
+    parameters: SendCallsParameters<chain, account, chainOverride>,
+  ) => Promise<SendCallsReturnType>
+}
+
+/**
+ * A suite of EIP-5792 Wallet Actions.
+ *
+ * - Docs: https://viem.sh/eip5792
+ *
+ * @example
+ * import { createPublicClient, createWalletClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { walletActionsEip5792 } from 'viem/experimental'
+ *
+ * const walletClient = createWalletClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * }).extend(walletActionsEip5792())
+ *
+ * const hash = await walletClient.sendCalls({...})
+ */
+export function walletActionsEip5792() {
+  return <
+    transport extends Transport,
+    chain extends Chain | undefined = Chain | undefined,
+    account extends Account | undefined = Account | undefined,
+  >(
+    client: Client<transport, chain, account>,
+  ): WalletActionsEip5792<chain, account> => {
+    return {
+      getCallsStatus: (parameters) => getCallsStatus(client, parameters),
+      getCapabilities: () => getCapabilities(client),
+      sendCalls: (parameters) => sendCalls(client, parameters),
+    }
+  }
+}

package/experimental/index.ts

@@ -0,0 +1,22 @@
+export {
+  type GetCapabilitiesErrorType,
+  type GetCapabilitiesReturnType,
+  getCapabilities,
+} from './actions/getCapabilities.js'
+export {
+  type SendCallsErrorType,
+  type SendCallsParameters,
+  type SendCallsReturnType,
+  sendCalls,
+} from './actions/sendCalls.js'
+export {
+  type GetCallsStatusErrorType,
+  type GetCallsStatusParameters,
+  type GetCallsStatusReturnType,
+  getCallsStatus,
+} from './actions/getCallsStatus.js'
+
+export {
+  type WalletActionsEip5792,
+  walletActionsEip5792,
+} from './decorators/eip5792.js'

package/experimental/package.json

@@ -0,0 +1,6 @@
+{
+  "type": "module",
+  "types": "../_types/experimental/index.d.ts",
+  "module": "../_esm/experimental/index.js",
+  "main": "../_cjs/experimental/index.js"
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "viem",
   "description": "TypeScript Interface for Ethereum",
-  "version": "0.0.0-main.20240402T193906",
+  "version": "0.0.0-main.20240402T203246",
   "type": "module",
   "main": "./_cjs/index.js",
   "module": "./_esm/index.js",
@@ -53,6 +53,11 @@
       "import": "./_esm/ens/index.js",
       "default": "./_cjs/ens/index.js"
     },
+    "./experimental": {
+      "types": "./_types/experimental/index.d.ts",
+      "import": "./_esm/experimental/index.js",
+      "default": "./_cjs/experimental/index.js"
+    },
     "./node": {
       "types": "./_types/node/index.d.ts",
       "import": "./_esm/node/index.js",
@@ -100,6 +105,9 @@
       "ens": [
         "./_types/ens/index.d.ts"
       ],
+      "experimental": [
+        "./_types/experimental/index.d.ts"
+      ],
       "node": [
         "./_types/node/index.d.ts"
       ],

package/types/eip1193.ts

@@ -107,6 +107,35 @@ export type NetworkSync = {
   startingBlock: Quantity
 }
 
+export type WalletCapabilities = {
+  [capability: string]: any
+}
+
+export type WalletCapabilitiesRecord<
+  capabilities extends WalletCapabilities = WalletCapabilities,
+  id extends string | number = Hex,
+> = {
+  [chainId in id]: capabilities
+}
+
+export type WalletGetCallsStatusReceipt<quantity = Hex, status = Hex> = {
+  logs: {
+    address: Hex
+    data: Hex
+    topics: Hex[]
+  }[]
+  status: status
+  blockHash: Hex
+  blockNumber: quantity
+  gasUsed: quantity
+  transactionHash: Hex
+}
+
+export type WalletGetCallsStatusReturnType<quantity = Hex, status = Hex> = {
+  status: 'PENDING' | 'CONFIRMED'
+  receipts?: WalletGetCallsStatusReceipt<quantity, status>[]
+}
+
 export type WalletPermissionCaveat = {
   type: string
   value: any
@@ -120,6 +149,22 @@ export type WalletPermission = {
   parentCapability: 'eth_accounts' | string
 }
 
+export type WalletSendCallsParameters<
+  capabilities extends WalletCapabilities = WalletCapabilities,
+  chainId extends Hex | number = Hex,
+  quantity extends Quantity | bigint = Quantity,
+> = {
+  version: string
+  chainId: chainId
+  from: Address
+  calls: {
+    to: Address
+    data: Hex
+    value: quantity
+  }[]
+  capabilities?: capabilities | undefined
+}
+
 export type WatchAssetParams = {
   /** Token type. */
   type: 'ERC20'
@@ -1270,6 +1315,30 @@ export type WalletRpcSchema = [
     Parameters: [chain: AddEthereumChainParameter]
     ReturnType: null
   },
+  /**
+   * @description Returns the status of a call batch that was sent via `wallet_sendCalls`.
+   * @link https://eips.ethereum.org/EIPS/eip-5792
+   * @example
+   * provider.request({ method: 'wallet_getCallsStatus' })
+   * // => { ... }
+   */
+  {
+    Method: 'wallet_getCallsStatus'
+    Parameters?: string
+    ReturnType: WalletGetCallsStatusReturnType
+  },
+  /**
+   * @description Gets the connected wallet's capabilities.
+   * @link https://eips.ethereum.org/EIPS/eip-5792
+   * @example
+   * provider.request({ method: 'wallet_getCapabilities' })
+   * // => { ... }
+   */
+  {
+    Method: 'wallet_getCapabilities'
+    Parameters?: undefined
+    ReturnType: Prettify<WalletCapabilitiesRecord>
+  },
   /**
    * @description Gets the wallets current permissions.
    * @link https://eips.ethereum.org/EIPS/eip-2255
@@ -1294,6 +1363,18 @@ export type WalletRpcSchema = [
     Parameters: [permissions: { eth_accounts: Record<string, any> }]
     ReturnType: WalletPermission[]
   },
+  /**
+   * @description Requests the connected wallet to send a batch of calls.
+   * @link https://eips.ethereum.org/EIPS/eip-5792
+   * @example
+   * provider.request({ method: 'wallet_sendCalls' })
+   * // => { ... }
+   */
+  {
+    Method: 'wallet_sendCalls'
+    Parameters?: WalletSendCallsParameters
+    ReturnType: string
+  },
   /**
    * @description Switch the wallet to the given Ethereum chain.
    * @link https://eips.ethereum.org/EIPS/eip-3326

package/utils/formatters/transactionReceipt.ts

@@ -20,7 +20,7 @@ export type FormattedTransactionReceipt<
   TransactionReceipt
 >
 
-const statuses = {
+export const receiptStatuses = {
   '0x0': 'reverted',
   '0x1': 'success',
 } as const
@@ -55,7 +55,7 @@ export function formatTransactionReceipt(
       ? hexToNumber(transactionReceipt.transactionIndex)
       : null,
     status: transactionReceipt.status
-      ? statuses[transactionReceipt.status]
+      ? receiptStatuses[transactionReceipt.status]
       : null,
     type: transactionReceipt.type
       ? transactionType[