viem 2.33.2 → 2.33.4-canary-20250807091217

package/experimental/erc7811/actions/getAssets.ts

@@ -0,0 +1,249 @@
+import type { Address } from 'abitype'
+import {
+  type ParseAccountErrorType,
+  parseAccount,
+} from '../../../accounts/utils/parseAccount.js'
+import type { Client } from '../../../clients/createClient.js'
+import type { Transport } from '../../../clients/transports/createTransport.js'
+import { ethAddress } from '../../../constants/address.js'
+import { AccountNotFoundError } from '../../../errors/account.js'
+import type { ErrorType } from '../../../errors/utils.js'
+import type { Account, GetAccountParameter } from '../../../types/account.js'
+import type { Chain } from '../../../types/chain.js'
+import type {
+  WalletGetAssetsParameters,
+  WalletGetAssetsReturnType,
+} from '../../../types/eip1193.js'
+import type { Hex } from '../../../types/misc.js'
+import type { OneOf, Prettify } from '../../../types/utils.js'
+import {
+  type HexToBigIntErrorType,
+  hexToBigInt,
+} from '../../../utils/encoding/fromHex.js'
+import {
+  type NumberToHexErrorType,
+  numberToHex,
+} from '../../../utils/encoding/toHex.js'
+
+export type Asset<chainIds extends boolean = false> = OneOf<
+  CustomAsset | Erc20Asset | Erc721Asset | NativeAsset
+> &
+  (chainIds extends true ? { chainIds: readonly number[] } : {})
+
+export type GetAssetsParameters<
+  aggregate extends
+    | boolean
+    | ((asset: Asset) => string)
+    | undefined = undefined,
+  account extends Account | undefined = Account | undefined,
+> = GetAccountParameter<account> & {
+  /**
+   * Whether or not to aggregate assets across multiple chains,
+   * and assign them to a '0' key.
+   * @default true
+   */
+  aggregate?: aggregate | boolean | ((asset: Asset) => string) | undefined
+  /** Filter by assets. */
+  assets?:
+    | {
+        [chainId: number]: readonly (
+          | {
+              address: 'native'
+              type: 'native'
+            }
+          | {
+              address: Address
+              type: AssetType
+            }
+        )[]
+      }
+    | undefined
+  /** Filter by asset types. */
+  assetTypes?: readonly AssetType[] | undefined
+  /** Filter by chain IDs. */
+  chainIds?: readonly number[] | undefined
+}
+
+export type GetAssetsReturnType<
+  aggregate extends
+    | boolean
+    | ((asset: Asset) => string)
+    | undefined = undefined,
+> = {
+  [chainId: number]: readonly Asset<false>[]
+} & (aggregate extends false ? {} : { 0: readonly Asset<true>[] })
+
+export type GetAssetsErrorType =
+  | HexToBigIntErrorType
+  | NumberToHexErrorType
+  | ParseAccountErrorType
+  | ErrorType
+
+/**
+ * Retrieves assets for a given account from the target Wallet.
+ *
+ * @example
+ * import { createWalletClient, custom } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { getAssets } from 'viem/experimental'
+ *
+ * const client = createWalletClient({
+ *   chain: mainnet,
+ *   transport: custom(window.ethereum),
+ * })
+ *
+ * const result = await getAssets(client, {
+ *   account: '0xdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef',
+ * })
+ *
+ * @param client - Client to use to make the request.
+ * @param parameters - Parameters.
+ * @returns Assets for the given account.
+ */
+export async function getAssets<
+  chain extends Chain | undefined,
+  account extends Account | undefined = Account | undefined,
+  aggregate extends
+    | boolean
+    | ((asset: Asset) => string)
+    | undefined = undefined,
+>(
+  client: Client<Transport, chain, account>,
+  ...[parameters]: account extends Account
+    ? [GetAssetsParameters<aggregate, account>] | []
+    : [GetAssetsParameters<aggregate, account>]
+): Promise<Prettify<GetAssetsReturnType<aggregate>>> {
+  const { aggregate = true } = parameters ?? {}
+
+  const result = await client.request({
+    method: 'wallet_getAssets',
+    params: [formatRequest(parameters)],
+  })
+  const response = formatResponse(result)
+
+  const aggregated = (() => {
+    if (!aggregate) return undefined
+    const aggregated = {} as Record<string, Asset<boolean>>
+    for (const [chainId, assets] of Object.entries(response)) {
+      if (chainId === '0') continue
+      for (const asset of assets) {
+        const key =
+          typeof aggregate === 'function'
+            ? aggregate(asset)
+            : (asset.address ?? ethAddress)
+        const item = (aggregated[key] ?? {}) as Asset<true>
+        aggregated[key] = {
+          ...asset,
+          balance: asset.balance + (item?.balance ?? 0n),
+          chainIds: [...(item?.chainIds ?? []), Number(chainId)],
+        }
+      }
+    }
+    return Object.values(aggregated)
+  })()
+
+  if (aggregated) return { 0: aggregated, ...response } as never
+  return response as never
+}
+
+/** @internal */
+type AssetType = 'native' | 'erc20' | 'erc721' | (string & {})
+
+/** @internal */
+type CustomAsset = {
+  address: Address
+  balance: bigint
+  metadata: {
+    [key: string]: unknown
+  }
+  type: { custom: string }
+}
+
+/** @internal */
+type Erc20Asset = {
+  address: Address
+  balance: bigint
+  metadata: {
+    name: string
+    symbol: string
+    decimals: number
+  }
+  type: 'erc20'
+}
+
+/** @internal */
+type Erc721Asset = {
+  address: Address
+  balance: bigint
+  metadata: {
+    name: string
+    symbol: string
+    tokenId: bigint
+    tokenUri?: string | undefined
+  }
+  type: 'erc721'
+}
+
+/** @internal */
+type NativeAsset = {
+  balance: bigint
+  type: 'native'
+}
+
+/** @internal */
+function formatRequest(
+  parameters: GetAssetsParameters<undefined, Account> | undefined = {},
+): WalletGetAssetsParameters {
+  const { account: account_, assets, assetTypes, chainIds } = parameters
+
+  if (typeof account_ === 'undefined')
+    throw new AccountNotFoundError({
+      docsPath: '/experimental/erc7811/getAssets',
+    })
+  const account = parseAccount(account_)
+
+  return {
+    account: account.address,
+    assetFilter: assets,
+    assetTypeFilter: assetTypes,
+    chainFilter: chainIds?.map((chainId) => numberToHex(chainId)),
+  }
+}
+
+/** @internal */
+function formatResponse(
+  response: WalletGetAssetsReturnType,
+): GetAssetsReturnType<false> {
+  return Object.fromEntries(
+    Object.entries(response).map(([chainId, assets]) => [
+      Number(chainId),
+      assets.map((asset) => {
+        const balance = hexToBigInt(asset.balance)
+        const metadata = asset.metadata as Asset['metadata']
+        const type = (() => {
+          if (asset.type === 'native') return 'native'
+          if (asset.type === 'erc20') return 'erc20'
+          if (asset.type === 'erc721') return 'erc721'
+          return { custom: asset.type }
+        })()
+        const address = type === 'native' ? undefined : asset.address
+
+        return {
+          balance,
+          type,
+          ...(address ? { address } : {}),
+          ...(metadata
+            ? {
+                metadata: {
+                  ...metadata,
+                  ...('tokenId' in metadata
+                    ? { tokenId: hexToBigInt(metadata.tokenId as Hex) }
+                    : {}),
+                },
+              }
+            : {}),
+        }
+      }),
+    ]),
+  ) as GetAssetsReturnType<false>
+}

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.2",
+  "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

package/utils/transaction/parseTransaction.ts

@@ -581,8 +581,8 @@ function parseAuthorizationList(
 
     authorizationList.push({
       address,
-      chainId: hexToNumber(chainId),
-      nonce: hexToNumber(nonce),
+      chainId: chainId === '0x' ? 0 : hexToNumber(chainId),
+      nonce: nonce === '0x' ? 0 : hexToNumber(nonce),
       ...parseEIP155Signature([yParity, r, s]),
     })
   }