viem 2.33.3 → 2.33.4-canary-20250807091217

package/experimental/erc7811/decorators/erc7811.ts

@@ -0,0 +1,80 @@
+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 Asset,
+  type GetAssetsParameters,
+  type GetAssetsReturnType,
+  getAssets,
+} from '../actions/getAssets.js'
+
+export type Erc7811Actions<
+  account extends Account | undefined = Account | undefined,
+> = {
+  /**
+   * Requests to get assets for an account from a wallet.
+   *
+   * - Docs: https://viem.sh/experimental/erc7811/getAssets
+   *
+   * @param client - Client to use
+   * @param parameters - {@link GetAssetsParameters}
+   * @returns List of assets for the given account {@link GetAssetsReturnType}
+   *
+   * @example
+   * import { createWalletClient, custom } from 'viem'
+   * import { mainnet } from 'viem/chains'
+   * import { erc7811Actions } from 'viem/experimental/erc7811'
+   *
+   * const client = createWalletClient({
+   *   chain: mainnet,
+   *   transport: custom(window.ethereum),
+   * }).extend(erc7811Actions())
+   *
+   * const response = await client.getAssets({
+   *   account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
+   * })
+   */
+  getAssets: <
+    aggregate extends
+      | boolean
+      | ((asset: Asset) => string)
+      | undefined = undefined,
+  >(
+    ...[parameters]: account extends Account
+      ? [GetAssetsParameters<aggregate, account>] | []
+      : [GetAssetsParameters<aggregate, account>]
+  ) => Promise<GetAssetsReturnType<aggregate>>
+}
+
+/**
+ * A suite of ERC-7811 Wallet Actions.
+ *
+ * @example
+ * import { createPublicClient, createWalletClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { erc7811Actions } from 'viem/experimental/erc7811'
+ *
+ * const client = createWalletClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * }).extend(erc7811Actions())
+ *
+ * const response = await client.getAssets({
+ *   account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
+ * })
+ */
+export function erc7811Actions() {
+  return <
+    transport extends Transport,
+    chain extends Chain | undefined = Chain | undefined,
+    account extends Account | undefined = Account | undefined,
+  >(
+    client: Client<transport, chain, account>,
+  ): Erc7811Actions<account> => {
+    return {
+      // @ts-expect-error
+      getAssets: (...[parameters]) => getAssets(client, parameters),
+    }
+  }
+}

package/experimental/erc7811/index.ts

@@ -0,0 +1,9 @@
+// biome-ignore lint/performance/noBarrelFile: entrypoint
+export {
+  type GetAssetsErrorType,
+  type GetAssetsParameters,
+  type GetAssetsReturnType,
+  getAssets,
+} from './actions/getAssets.js'
+
+export { type Erc7811Actions, erc7811Actions } from './decorators/erc7811.js'

package/experimental/erc7811/package.json

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

package/experimental/index.ts

@@ -181,6 +181,11 @@ export {
   erc7846Actions,
 } from './erc7846/decorators/erc7846.js'
 
+export {
+  type Erc7811Actions,
+  erc7811Actions,
+} from './erc7811/decorators/erc7811.js'
+
 export {
   type Erc7895Actions,
   erc7895Actions,

package/index.ts

@@ -1156,6 +1156,8 @@ export type {
   RpcSchema,
   RpcSchemaOverride,
   TestRpcSchema,
+  WalletGetAssetsParameters,
+  WalletGetAssetsReturnType,
   WalletCallReceipt,
   WalletGetCallsStatusReturnType,
   WalletGrantPermissionsParameters,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "viem",
   "description": "TypeScript Interface for Ethereum",
-  "version": "2.33.3",
+  "version": "2.33.4-canary-20250807091217",
   "main": "./_cjs/index.js",
   "module": "./_esm/index.js",
   "types": "./_types/index.d.ts",
@@ -74,6 +74,11 @@
       "import": "./_esm/experimental/erc7821/index.js",
       "default": "./_cjs/experimental/erc7821/index.js"
     },
+    "./experimental/erc7811": {
+      "types": "./_types/experimental/erc7811/index.d.ts",
+      "import": "./_esm/experimental/erc7811/index.js",
+      "default": "./_cjs/experimental/erc7811/index.js"
+    },
     "./experimental/erc7846": {
       "types": "./_types/experimental/erc7846/index.d.ts",
       "import": "./_esm/experimental/erc7846/index.js",

package/types/eip1193.ts

@@ -176,6 +176,31 @@ export type WalletGrantPermissionsReturnType = {
     | undefined
 }
 
+export type WalletGetAssetsParameters = {
+  account: Address
+  assetFilter?:
+    | {
+        [chainId: Hex]: readonly {
+          address: Address
+          type: 'native' | 'erc20' | 'erc721' | (string & {})
+        }[]
+      }
+    | undefined
+  assetTypeFilter?:
+    | readonly ('native' | 'erc20' | 'erc721' | (string & {}))[]
+    | undefined
+  chainFilter?: readonly Hex[] | undefined
+}
+
+export type WalletGetAssetsReturnType = {
+  [chainId: Hex]: readonly {
+    address: Address | 'native'
+    balance: Hex
+    metadata?: unknown | undefined
+    type: 'native' | 'erc20' | 'erc721' | (string & {})
+  }[]
+}
+
 export type WalletGetCallsStatusReturnType<
   capabilities extends Capabilities = Capabilities,
   numberType = Hex,
@@ -1843,6 +1868,18 @@ export type WalletRpcSchema = [
     Parameters?: undefined
     ReturnType: void
   },
+  /**
+   * @description Returns the assets owned by the wallet.
+   * @link https://github.com/ethereum/ERCs/blob/master/ERCS/erc-7811.md
+   * @example
+   * provider.request({ method: 'wallet_getAssets', params: [...] })
+   * // => { ... }
+   */
+  {
+    Method: 'wallet_getAssets'
+    Parameters?: [WalletGetAssetsParameters]
+    ReturnType: WalletGetAssetsReturnType
+  },
   /**
    * @description Returns the status of a call batch that was sent via `wallet_sendCalls`.
    * @link https://eips.ethereum.org/EIPS/eip-5792