permissionless 0.2.3 → 0.2.5

package/actions/erc7579/uninstallModules.ts

@@ -1,35 +1,42 @@
+import type { Address, Chain, Client, Hex, Narrow, Transport } from "viem"
 import {
-    type Address,
-    type Chain,
-    type Client,
-    type Hex,
-    type Transport,
-    encodeFunctionData,
-    getAddress
-} from "viem"
-import {
-    type GetSmartAccountParameter,
+    type PaymasterActions,
     type SmartAccount,
+    type UserOperationCalls,
     sendUserOperation
 } from "viem/account-abstraction"
 import { getAction } from "viem/utils"
 import { parseAccount } from "viem/utils"
 import { AccountNotFoundError } from "../../errors"
-import { type ModuleType, parseModuleTypeId } from "./supportsModule"
+import {
+    type EncodeUninstallModuleParameters,
+    encodeUninstallModule
+} from "../../utils/encodeUninstallModule"
 
 export type UninstallModulesParameters<
-    TSmartAccount extends SmartAccount | undefined
-> = GetSmartAccountParameter<TSmartAccount> & {
-    modules: [
-        {
-            type: ModuleType
-            address: Address
-            context: Hex
-        }
-    ]
+    TSmartAccount extends SmartAccount | undefined,
+    calls extends readonly unknown[] = readonly unknown[]
+> = EncodeUninstallModuleParameters<TSmartAccount> & {
     maxFeePerGas?: bigint
     maxPriorityFeePerGas?: bigint
     nonce?: bigint
+    calls?: UserOperationCalls<Narrow<calls>>
+    paymaster?:
+        | Address
+        | true
+        | {
+              /** Retrieves paymaster-related User Operation properties to be used for sending the User Operation. */
+              getPaymasterData?:
+                  | PaymasterActions["getPaymasterData"]
+                  | undefined
+              /** Retrieves paymaster-related User Operation properties to be used for gas estimation. */
+              getPaymasterStubData?:
+                  | PaymasterActions["getPaymasterStubData"]
+                  | undefined
+          }
+        | undefined
+    /** Paymaster context to pass to `getPaymasterData` and `getPaymasterStubData` calls. */
+    paymasterContext?: unknown | undefined
 }
 
 export async function uninstallModules<
@@ -43,7 +50,10 @@ export async function uninstallModules<
         maxFeePerGas,
         maxPriorityFeePerGas,
         nonce,
-        modules
+        modules,
+        calls,
+        paymaster,
+        paymasterContext
     } = parameters
 
     if (!account_) {
@@ -59,36 +69,15 @@ export async function uninstallModules<
         sendUserOperation,
         "sendUserOperation"
     )({
-        calls: modules.map(({ type, address, context }) => ({
-            to: account.address,
-            value: BigInt(0),
-            data: encodeFunctionData({
-                abi: [
-                    {
-                        name: "uninstallModule",
-                        type: "function",
-                        stateMutability: "nonpayable",
-                        inputs: [
-                            {
-                                type: "uint256",
-                                name: "moduleTypeId"
-                            },
-                            {
-                                type: "address",
-                                name: "module"
-                            },
-                            {
-                                type: "bytes",
-                                name: "deInitData"
-                            }
-                        ],
-                        outputs: []
-                    }
-                ],
-                functionName: "uninstallModule",
-                args: [parseModuleTypeId(type), getAddress(address), context]
-            })
-        })),
+        calls: [
+            ...encodeUninstallModule({
+                account,
+                modules
+            }),
+            ...(calls ?? [])
+        ],
+        paymaster,
+        paymasterContext,
         maxFeePerGas,
         maxPriorityFeePerGas,
         nonce,

package/clients/createSmartAccountClient.ts

@@ -136,6 +136,7 @@ export function createSmartAccountClient(
 
     const client = createBundlerClient({
         ...parameters,
+        client: client_,
         chain: parameters.chain ?? client_?.chain,
         key,
         name,

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "permissionless",
-    "version": "0.2.3",
+    "version": "0.2.5",
     "author": "Pimlico",
     "homepage": "https://docs.pimlico.io/permissionless",
     "repository": "github:pimlicolabs/permissionless.js",

package/utils/encodeInstallModule.ts

@@ -0,0 +1,85 @@
+import {
+    type Address,
+    type Hex,
+    type OneOf,
+    encodeFunctionData,
+    getAddress
+} from "viem"
+import type {
+    GetSmartAccountParameter,
+    SmartAccount
+} from "viem/account-abstraction"
+import {
+    type ModuleType,
+    parseModuleTypeId
+} from "../actions/erc7579/supportsModule"
+import { AccountNotFoundError } from "../errors"
+
+export type EncodeInstallModuleParameter = {
+    type: ModuleType
+    address: Address
+} & OneOf<
+    | {
+          context: Hex
+      }
+    | {
+          initData: Hex
+      }
+>
+
+export type EncodeInstallModuleParameters<
+    TSmartAccount extends SmartAccount | undefined
+> = GetSmartAccountParameter<TSmartAccount> & {
+    modules: EncodeInstallModuleParameter[] | EncodeInstallModuleParameter
+}
+
+export function encodeInstallModule<
+    TSmartAccount extends SmartAccount | undefined
+>(parameters: EncodeInstallModuleParameters<TSmartAccount>) {
+    const account = parameters.account as SmartAccount
+
+    if (!account) {
+        throw new AccountNotFoundError({
+            docsPath: "/docs/actions/wallet/sendTransaction"
+        })
+    }
+
+    const modules = Array.isArray(parameters.modules)
+        ? parameters.modules
+        : [parameters.modules]
+
+    return modules.map(({ type, address, context, initData }) => ({
+        to: account.address,
+        value: BigInt(0),
+        data: encodeFunctionData({
+            abi: [
+                {
+                    name: "installModule",
+                    type: "function",
+                    stateMutability: "nonpayable",
+                    inputs: [
+                        {
+                            type: "uint256",
+                            name: "moduleTypeId"
+                        },
+                        {
+                            type: "address",
+                            name: "module"
+                        },
+                        {
+                            type: "bytes",
+                            name: "initData"
+                        }
+                    ],
+                    outputs: []
+                }
+            ],
+            functionName: "installModule",
+            args: [
+                parseModuleTypeId(type),
+                getAddress(address),
+                context ?? initData
+            ]
+        })
+    }))
+}

package/utils/encodeUninstallModule.ts

@@ -0,0 +1,85 @@
+import {
+    type Address,
+    type Hex,
+    type OneOf,
+    encodeFunctionData,
+    getAddress
+} from "viem"
+import type {
+    GetSmartAccountParameter,
+    SmartAccount
+} from "viem/account-abstraction"
+import {
+    type ModuleType,
+    parseModuleTypeId
+} from "../actions/erc7579/supportsModule"
+import { AccountNotFoundError } from "../errors"
+
+export type EncodeUninstallModuleParameter = {
+    type: ModuleType
+    address: Address
+} & OneOf<
+    | {
+          context: Hex
+      }
+    | {
+          deInitData: Hex
+      }
+>
+
+export type EncodeUninstallModuleParameters<
+    TSmartAccount extends SmartAccount | undefined
+> = GetSmartAccountParameter<TSmartAccount> & {
+    modules: EncodeUninstallModuleParameter[] | EncodeUninstallModuleParameter
+}
+
+export function encodeUninstallModule<
+    TSmartAccount extends SmartAccount | undefined
+>(parameters: EncodeUninstallModuleParameters<TSmartAccount>) {
+    const account = parameters.account as SmartAccount
+
+    if (!account) {
+        throw new AccountNotFoundError({
+            docsPath: "/docs/actions/wallet/sendTransaction"
+        })
+    }
+
+    const modules = Array.isArray(parameters.modules)
+        ? parameters.modules
+        : [parameters.modules]
+
+    return modules.map(({ type, address, context, deInitData }) => ({
+        to: account.address,
+        value: BigInt(0),
+        data: encodeFunctionData({
+            abi: [
+                {
+                    name: "uninstallModule",
+                    type: "function",
+                    stateMutability: "nonpayable",
+                    inputs: [
+                        {
+                            type: "uint256",
+                            name: "moduleTypeId"
+                        },
+                        {
+                            type: "address",
+                            name: "module"
+                        },
+                        {
+                            type: "bytes",
+                            name: "deInitData"
+                        }
+                    ],
+                    outputs: []
+                }
+            ],
+            functionName: "uninstallModule",
+            args: [
+                parseModuleTypeId(type),
+                getAddress(address),
+                context ?? deInitData
+            ]
+        })
+    }))
+}

package/utils/index.ts

@@ -10,8 +10,14 @@ import { toOwner } from "./toOwner"
 import { decodeNonce } from "./decodeNonce"
 import { encodeNonce } from "./encodeNonce"
 
+import {
+    type EncodeInstallModuleParameters,
+    encodeInstallModule
+} from "./encodeInstallModule"
 import { getPackedUserOperation } from "./getPackedUserOperation"
 
+import { type EncodeCallDataParams, encode7579Calls } from "./encode7579Calls"
+
 export {
     transactionReceiptStatus,
     deepHexlify,
@@ -22,5 +28,9 @@ export {
     getAddressFromInitCodeOrPaymasterAndData,
     getPackedUserOperation,
     encodeNonce,
-    decodeNonce
+    decodeNonce,
+    type EncodeInstallModuleParameters,
+    encodeInstallModule,
+    type EncodeCallDataParams,
+    encode7579Calls
 }