viem 2.16.1 → 2.16.2

package/experimental/erc7715/actions/{issuePermissions.ts → grantPermissions.ts}

@@ -2,14 +2,14 @@ import type { Address } from 'abitype'
 import type { Client } from '../../../clients/createClient.js'
 import type { Transport } from '../../../clients/transports/createTransport.js'
 import type { Account } from '../../../types/account.js'
-import type { WalletIssuePermissionsReturnType } from '../../../types/eip1193.js'
+import type { WalletGrantPermissionsReturnType } from '../../../types/eip1193.js'
 import type { Hex } from '../../../types/misc.js'
 import type { OneOf } from '../../../types/utils.js'
-import { numberToHex } from '../../../utils/encoding/toHex.js'
+import { numberToHex, parseAccount } from '../../../utils/index.js'
 import type { Permission } from '../types/permission.js'
 import type { Signer } from '../types/signer.js'
 
-export type IssuePermissionsParameters = {
+export type GrantPermissionsParameters = {
   /** Timestamp (in seconds) that specifies the time by which this session MUST expire. */
   expiry: number
   /** Set of permissions to grant to the user. */
@@ -25,7 +25,7 @@ export type IssuePermissionsParameters = {
     }
 >
 
-export type IssuePermissionsReturnType = {
+export type GrantPermissionsReturnType = {
   /** Timestamp (in seconds) that specifies the time by which this session MUST expire. */
   expiry: number
   /** ERC-4337 Factory to deploy smart contract account. */
@@ -33,7 +33,7 @@ export type IssuePermissionsReturnType = {
   /** Calldata to use when calling the ERC-4337 Factory. */
   factoryData?: string | undefined
   /** Set of granted permissions. */
-  grantedPermissions: Omit<Permission, 'required'>[]
+  grantedPermissions: readonly Permission[]
   /** Permissions identifier. */
   permissionsContext: string
   /** Signer attached to the permissions. */
@@ -48,76 +48,80 @@ export type IssuePermissionsReturnType = {
 /**
  * Request permissions from a wallet to perform actions on behalf of a user.
  *
- * - Docs: https://viem.sh/experimental/erc7715/issuePermissions
+ * - Docs: https://viem.sh/experimental/erc7715/grantPermissions
  *
  * @example
  * import { createWalletClient, custom } from 'viem'
  * import { mainnet } from 'viem/chains'
- * import { issuePermissions } from 'viem/experimental'
+ * import { grantPermissions } from 'viem/experimental'
  *
  * const client = createWalletClient({
  *   chain: mainnet,
  *   transport: custom(window.ethereum),
  * })
  *
- * const result = await issuePermissions(client, {
+ * const result = await grantPermissions(client, {
  *   expiry: 1716846083638,
  *   permissions: [
  *     {
- *       type: 'contract-call',
+ *       type: 'native-token-transfer',
  *       data: {
- *         address: '0x0000000000000000000000000000000000000000',
- *       },
- *     },
- *     {
- *       type: 'native-token-limit',
- *       data: {
- *         amount: 69420n,
+ *         ticker: 'ETH',
  *       },
+ *       policies: [
+ *         {
+ *           type: 'token-allowance',
+ *           data: {
+ *             allowance: parseEther('1'),
+ *           },
+ *         }
+ *       ],
  *       required: true,
  *     },
  *   ],
  * })
  */
-export async function issuePermissions(
+export async function grantPermissions(
   client: Client<Transport>,
-  parameters: IssuePermissionsParameters,
-): Promise<IssuePermissionsReturnType> {
-  const { expiry, permissions, signer } = parameters
+  parameters: GrantPermissionsParameters,
+): Promise<GrantPermissionsReturnType> {
+  const { account, expiry, permissions, signer } = parameters
   const result = await client.request(
     {
-      method: 'wallet_issuePermissions',
-      params: [parseParameters({ expiry, permissions, signer })],
+      method: 'wallet_grantPermissions',
+      params: [
+        formatParameters({ account, expiry, permissions, signer } as any),
+      ],
     },
     { retryCount: 0 },
   )
-  return parseResult(result) as IssuePermissionsReturnType
+  return formatRequest(result) as GrantPermissionsReturnType
 }
 
-function parseParameters(parameters: IssuePermissionsParameters) {
-  const { account, expiry, permissions, signer: signer_ } = parameters
+function formatParameters(parameters: GrantPermissionsParameters) {
+  const { expiry, permissions, signer: signer_ } = parameters
+
+  const account = parameters.account
+    ? parseAccount(parameters.account)
+    : undefined
 
   const signer = (() => {
     if (!account && !signer_) return undefined
 
-    if (account) {
-      // Address as signer.
-      if (typeof account === 'string')
-        return {
-          type: 'account',
-          data: {
-            id: account,
-          },
-        }
+    // JSON-RPC Account as signer.
+    if (account?.type === 'json-rpc')
+      return {
+        type: 'wallet',
+      }
 
-      // Viem Account as signer.
+    // Local Account as signer.
+    if (account?.type === 'local')
       return {
         type: 'account',
         data: {
           id: account.address,
         },
       }
-    }
 
     // ERC-7715 Signer as signer.
     return signer_
@@ -127,36 +131,60 @@ function parseParameters(parameters: IssuePermissionsParameters) {
     expiry,
     permissions: permissions.map((permission) => ({
       ...permission,
-      ...(permission.data && typeof permission.data === 'object'
-        ? {
-            data: {
-              ...permission.data,
-              ...('amount' in permission.data &&
-              typeof permission.data.amount === 'bigint'
-                ? { amount: numberToHex(permission.data.amount) }
-                : {}),
-            },
-          }
-        : {}),
+      policies: permission.policies.map((policy) => {
+        const data = (() => {
+          if (policy.type === 'token-allowance')
+            return {
+              allowance: numberToHex(policy.data.allowance),
+            }
+          if (policy.type === 'gas-limit')
+            return {
+              limit: numberToHex(policy.data.limit),
+            }
+          return policy.data
+        })()
+
+        return {
+          data,
+          type:
+            typeof policy.type === 'string' ? policy.type : policy.type.custom,
+        }
+      }),
       required: permission.required ?? false,
+      type:
+        typeof permission.type === 'string'
+          ? permission.type
+          : permission.type.custom,
     })),
     ...(signer ? { signer } : {}),
   }
 }
 
-function parseResult(result: WalletIssuePermissionsReturnType) {
+function formatRequest(result: WalletGrantPermissionsReturnType) {
   return {
     expiry: result.expiry,
     ...(result.factory ? { factory: result.factory } : {}),
     ...(result.factoryData ? { factoryData: result.factoryData } : {}),
     grantedPermissions: result.grantedPermissions.map((permission) => ({
       ...permission,
-      data: {
-        ...permission.data,
-        ...('amount' in permission.data
-          ? { amount: BigInt(permission.data.amount) }
-          : {}),
-      },
+      policies: permission.policies.map((policy) => {
+        const data = (() => {
+          if (policy.type === 'token-allowance')
+            return {
+              allowance: BigInt((policy.data as any).allowance),
+            }
+          if (policy.type === 'gas-limit')
+            return {
+              limit: BigInt((policy.data as any).limit),
+            }
+          return policy.data
+        })()
+
+        return {
+          data,
+          type: policy.type,
+        }
+      }),
     })),
     permissionsContext: result.permissionsContext,
     ...(result.signerData ? { signerData: result.signerData } : {}),

package/experimental/erc7715/decorators/erc7715.ts

@@ -3,16 +3,16 @@ import type { Transport } from '../../../clients/transports/createTransport.js'
 import type { Account } from '../../../types/account.js'
 import type { Chain } from '../../../types/chain.js'
 import {
-  type IssuePermissionsParameters,
-  type IssuePermissionsReturnType,
-  issuePermissions,
-} from '../actions/issuePermissions.js'
+  type GrantPermissionsParameters,
+  type GrantPermissionsReturnType,
+  grantPermissions,
+} from '../actions/grantPermissions.js'
 
 export type WalletActionsErc7715 = {
   /**
    * Request permissions from a wallet to perform actions on behalf of a user.
    *
-   * - Docs: https://viem.sh/experimental/erc7715/issuePermissions
+   * - Docs: https://viem.sh/experimental/erc7715/grantPermissions
    *
    * @example
    * import { createWalletClient, custom } from 'viem'
@@ -24,7 +24,7 @@ export type WalletActionsErc7715 = {
    *   transport: custom(window.ethereum),
    * }).extend(walletActionsErc7715())
    *
-   * const result = await client.issuePermissions({
+   * const result = await client.grantPermissions({
    *   expiry: 1716846083638,
    *   permissions: [
    *     {
@@ -43,9 +43,9 @@ export type WalletActionsErc7715 = {
    *   ],
    * })
    */
-  issuePermissions: (
-    parameters: IssuePermissionsParameters,
-  ) => Promise<IssuePermissionsReturnType>
+  grantPermissions: (
+    parameters: GrantPermissionsParameters,
+  ) => Promise<GrantPermissionsReturnType>
 }
 
 /**
@@ -63,7 +63,7 @@ export type WalletActionsErc7715 = {
  *   transport: http(),
  * }).extend(walletActionsErc7715())
  *
- * const result = await walletClient.issuePermissions({...})
+ * const result = await walletClient.grantPermissions({...})
  */
 export function walletActionsErc7715() {
   return <
@@ -74,7 +74,7 @@ export function walletActionsErc7715() {
     client: Client<transport, chain, account>,
   ): WalletActionsErc7715 => {
     return {
-      issuePermissions: (parameters) => issuePermissions(client, parameters),
+      grantPermissions: (parameters) => grantPermissions(client, parameters),
     }
   }
 }

package/experimental/erc7715/types/permission.ts

@@ -1,51 +1,53 @@
 import type { Address } from 'abitype'
 
 import type { OneOf } from '../../../types/utils.js'
+import type { Policy } from './policy.js'
 
 /** @internal */
-export type NativeTokenLimitPermission<amount = bigint> = {
-  type: 'native-token-limit'
-  data: {
-    amount: amount
-  }
+export type CustomPermission<data = unknown, type = { custom: string }> = {
+  data: data
+  type: type
 }
 
 /** @internal */
-export type Erc20LimitPermission<amount = bigint> = {
-  type: 'erc20-limit'
+export type NativeTokenTransferPermission = {
+  type: 'native-token-transfer'
   data: {
-    erc20Address: Address
-    amount: amount
+    /** Native token ticker (e.g. ETH). */
+    ticker: string
   }
 }
 
 /** @internal */
-export type GasLimitPermission<amount = bigint> = {
-  type: 'gas-limit'
+export type Erc20TokenTransferPermission = {
+  type: 'erc20-token-transfer'
   data: {
-    amount: amount
+    /** ERC20 address. */
+    address: Address
+    /** Native token ticker (e.g. ETH). */
+    ticker: string
   }
 }
 
 /** @internal */
 export type ContractCallPermission = {
   type: 'contract-call'
-  data: unknown
-}
-
-/** @internal */
-export type RateLimitPermission = {
-  type: 'rate-limit'
   data: {
-    count: number
-    interval: number
+    /** Contract address. */
+    address: Address
+    /** Set of contract signatures to permit. */
+    calls: string[]
   }
 }
 
-export type Permission<amount = bigint> = OneOf<
-  | NativeTokenLimitPermission<amount>
-  | Erc20LimitPermission<amount>
-  | GasLimitPermission<amount>
+export type Permission<uint256 = bigint> = OneOf<
+  | NativeTokenTransferPermission
+  | Erc20TokenTransferPermission
   | ContractCallPermission
-  | RateLimitPermission
-> & { required?: boolean | undefined }
+  | CustomPermission
+> & {
+  /** Set of policies for the permission. */
+  policies: readonly Policy<uint256>[]
+  /** Whether or not the wallet must grant the permission. */
+  required?: boolean | undefined
+}

package/experimental/erc7715/types/policy.ts

@@ -0,0 +1,43 @@
+import type { OneOf } from '../../../types/utils.js'
+
+/** @internal */
+export type CustomPolicy<data = unknown> = {
+  data: data
+  type: { custom: string }
+}
+
+/** @internal */
+export type TokenAllowancePolicy<uint256 = bigint> = {
+  type: 'token-allowance'
+  data: {
+    /** Token allowance (in wei). */
+    allowance: uint256
+  }
+}
+
+/** @internal */
+export type GasLimitPolicy<uint256 = bigint> = {
+  type: 'gas-limit'
+  data: {
+    /** Gas limit (in wei). */
+    limit: uint256
+  }
+}
+
+/** @internal */
+export type RateLimitPolicy = {
+  type: 'rate-limit'
+  data: {
+    /** Number of times during each interval. */
+    count: number
+    /** Interval (in seconds). */
+    interval: number
+  }
+}
+
+export type Policy<amount = bigint> = OneOf<
+  | TokenAllowancePolicy<amount>
+  | GasLimitPolicy<amount>
+  | RateLimitPolicy
+  | CustomPolicy
+>

package/experimental/erc7715/types/signer.ts

@@ -25,4 +25,11 @@ export type MultiKeySigner = {
   }
 }
 
-export type Signer = OneOf<AccountSigner | KeySigner | MultiKeySigner>
+/** @internal */
+export type WalletSigner = {
+  type: 'wallet'
+}
+
+export type Signer = OneOf<
+  AccountSigner | KeySigner | MultiKeySigner | WalletSigner
+>

package/experimental/index.ts

@@ -67,10 +67,10 @@ export {
 } from '../utils/signature/serializeErc6492Signature.js'
 
 export {
-  type IssuePermissionsParameters,
-  type IssuePermissionsReturnType,
-  issuePermissions,
-} from './erc7715/actions/issuePermissions.js'
+  type GrantPermissionsParameters,
+  type GrantPermissionsReturnType,
+  grantPermissions,
+} from './erc7715/actions/grantPermissions.js'
 export {
   type WalletActionsErc7715,
   walletActionsErc7715,

package/index.ts

@@ -1021,8 +1021,8 @@ export type {
   WalletCapabilitiesRecord,
   WalletCallReceipt,
   WalletGetCallsStatusReturnType,
-  WalletIssuePermissionsParameters,
-  WalletIssuePermissionsReturnType,
+  WalletGrantPermissionsParameters,
+  WalletGrantPermissionsReturnType,
   WalletSendCallsParameters,
   WalletPermissionCaveat,
   WalletPermission,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "viem",
   "description": "TypeScript Interface for Ethereum",
-  "version": "2.16.1",
+  "version": "2.16.2",
   "main": "./_cjs/index.js",
   "module": "./_esm/index.js",
   "types": "./_types/index.d.ts",

package/types/eip1193.ts

@@ -131,28 +131,37 @@ export type WalletCallReceipt<quantity = Hex, status = Hex> = {
   transactionHash: Hex
 }
 
-export type WalletIssuePermissionsParameters = {
+export type WalletGrantPermissionsParameters = {
   signer?:
     | {
         type: string
-        data: unknown
+        data?: unknown | undefined
       }
     | undefined
   permissions: readonly {
-    type: string
     data: unknown
-    required: boolean
+    policies: readonly {
+      data: unknown
+      type: string
+    }[]
+    required?: boolean | undefined
+    type: string
   }[]
   expiry: number
 }
 
-export type WalletIssuePermissionsReturnType = {
+export type WalletGrantPermissionsReturnType = {
   expiry: number
   factory?: `0x${string}` | undefined
   factoryData?: string | undefined
   grantedPermissions: readonly {
+    data: unknown
+    policies: readonly {
+      data: unknown
+      type: string
+    }[]
+    required?: boolean | undefined
     type: string
-    data: any
   }[]
   permissionsContext: string
   signerData?:
@@ -1404,13 +1413,13 @@ export type WalletRpcSchema = [
    * @description Requests permissions from a wallet
    * @link https://eips.ethereum.org/EIPS/eip-7715
    * @example
-   * provider.request({ method: 'wallet_issuePermissions', params: [{ ... }] })
+   * provider.request({ method: 'wallet_grantPermissions', params: [{ ... }] })
    * // => { ... }
    */
   {
-    Method: 'wallet_issuePermissions'
-    Parameters?: [WalletIssuePermissionsParameters]
-    ReturnType: Prettify<WalletIssuePermissionsReturnType>
+    Method: 'wallet_grantPermissions'
+    Parameters?: [WalletGrantPermissionsParameters]
+    ReturnType: Prettify<WalletGrantPermissionsReturnType>
   },
   /**
    * @description Requests the given permissions from the user.

package/_cjs/experimental/erc7715/actions/issuePermissions.js

@@ -1,73 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.issuePermissions = issuePermissions;
-const toHex_js_1 = require("../../../utils/encoding/toHex.js");
-async function issuePermissions(client, parameters) {
-    const { expiry, permissions, signer } = parameters;
-    const result = await client.request({
-        method: 'wallet_issuePermissions',
-        params: [parseParameters({ expiry, permissions, signer })],
-    }, { retryCount: 0 });
-    return parseResult(result);
-}
-function parseParameters(parameters) {
-    const { account, expiry, permissions, signer: signer_ } = parameters;
-    const signer = (() => {
-        if (!account && !signer_)
-            return undefined;
-        if (account) {
-            if (typeof account === 'string')
-                return {
-                    type: 'account',
-                    data: {
-                        id: account,
-                    },
-                };
-            return {
-                type: 'account',
-                data: {
-                    id: account.address,
-                },
-            };
-        }
-        return signer_;
-    })();
-    return {
-        expiry,
-        permissions: permissions.map((permission) => ({
-            ...permission,
-            ...(permission.data && typeof permission.data === 'object'
-                ? {
-                    data: {
-                        ...permission.data,
-                        ...('amount' in permission.data &&
-                            typeof permission.data.amount === 'bigint'
-                            ? { amount: (0, toHex_js_1.numberToHex)(permission.data.amount) }
-                            : {}),
-                    },
-                }
-                : {}),
-            required: permission.required ?? false,
-        })),
-        ...(signer ? { signer } : {}),
-    };
-}
-function parseResult(result) {
-    return {
-        expiry: result.expiry,
-        ...(result.factory ? { factory: result.factory } : {}),
-        ...(result.factoryData ? { factoryData: result.factoryData } : {}),
-        grantedPermissions: result.grantedPermissions.map((permission) => ({
-            ...permission,
-            data: {
-                ...permission.data,
-                ...('amount' in permission.data
-                    ? { amount: BigInt(permission.data.amount) }
-                    : {}),
-            },
-        })),
-        permissionsContext: result.permissionsContext,
-        ...(result.signerData ? { signerData: result.signerData } : {}),
-    };
-}
-//# sourceMappingURL=issuePermissions.js.map

package/_cjs/experimental/erc7715/actions/issuePermissions.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"issuePermissions.js","sourceRoot":"","sources":["../../../../experimental/erc7715/actions/issuePermissions.ts"],"names":[],"mappings":";;AAiFA,4CAaC;AAvFD,+DAA8D;AA0EvD,KAAK,UAAU,gBAAgB,CACpC,MAAyB,EACzB,UAAsC;IAEtC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,UAAU,CAAA;IAClD,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,OAAO,CACjC;QACE,MAAM,EAAE,yBAAyB;QACjC,MAAM,EAAE,CAAC,eAAe,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC,CAAC;KAC3D,EACD,EAAE,UAAU,EAAE,CAAC,EAAE,CAClB,CAAA;IACD,OAAO,WAAW,CAAC,MAAM,CAA+B,CAAA;AAC1D,CAAC;AAED,SAAS,eAAe,CAAC,UAAsC;IAC7D,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,UAAU,CAAA;IAEpE,MAAM,MAAM,GAAG,CAAC,GAAG,EAAE;QACnB,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO;YAAE,OAAO,SAAS,CAAA;QAE1C,IAAI,OAAO,EAAE,CAAC;YAEZ,IAAI,OAAO,OAAO,KAAK,QAAQ;gBAC7B,OAAO;oBACL,IAAI,EAAE,SAAS;oBACf,IAAI,EAAE;wBACJ,EAAE,EAAE,OAAO;qBACZ;iBACF,CAAA;YAGH,OAAO;gBACL,IAAI,EAAE,SAAS;gBACf,IAAI,EAAE;oBACJ,EAAE,EAAE,OAAO,CAAC,OAAO;iBACpB;aACF,CAAA;QACH,CAAC;QAGD,OAAO,OAAO,CAAA;IAChB,CAAC,CAAC,EAAE,CAAA;IAEJ,OAAO;QACL,MAAM;QACN,WAAW,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;YAC5C,GAAG,UAAU;YACb,GAAG,CAAC,UAAU,CAAC,IAAI,IAAI,OAAO,UAAU,CAAC,IAAI,KAAK,QAAQ;gBACxD,CAAC,CAAC;oBACE,IAAI,EAAE;wBACJ,GAAG,UAAU,CAAC,IAAI;wBAClB,GAAG,CAAC,QAAQ,IAAI,UAAU,CAAC,IAAI;4BAC/B,OAAO,UAAU,CAAC,IAAI,CAAC,MAAM,KAAK,QAAQ;4BACxC,CAAC,CAAC,EAAE,MAAM,EAAE,IAAA,sBAAW,EAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;4BACjD,CAAC,CAAC,EAAE,CAAC;qBACR;iBACF;gBACH,CAAC,CAAC,EAAE,CAAC;YACP,QAAQ,EAAE,UAAU,CAAC,QAAQ,IAAI,KAAK;SACvC,CAAC,CAAC;QACH,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC9B,CAAA;AACH,CAAC;AAED,SAAS,WAAW,CAAC,MAAwC;IAC3D,OAAO;QACL,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACtD,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAClE,kBAAkB,EAAE,MAAM,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;YACjE,GAAG,UAAU;YACb,IAAI,EAAE;gBACJ,GAAG,UAAU,CAAC,IAAI;gBAClB,GAAG,CAAC,QAAQ,IAAI,UAAU,CAAC,IAAI;oBAC7B,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;oBAC5C,CAAC,CAAC,EAAE,CAAC;aACR;SACF,CAAC,CAAC;QACH,kBAAkB,EAAE,MAAM,CAAC,kBAAkB;QAC7C,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAChE,CAAA;AACH,CAAC"}