permissionless 0.0.18 → 0.0.20

package/accounts/types.ts

@@ -48,13 +48,13 @@ export type SmartAccount<
                   data: Hex
               }[]
     ) => Promise<Hex>
-    getDummySignature(): Promise<Hex>
+    getDummySignature(userOperation: UserOperation): Promise<Hex>
     encodeDeployCallData: <TAbi extends Abi | readonly unknown[] = Abi>({
         abi,
         args,
         bytecode
     }: { abi: TAbi; bytecode: Hex } & GetConstructorArgs<TAbi>) => Promise<Hex>
-    signUserOperation: (UserOperation: UserOperation) => Promise<Hex>
+    signUserOperation: (userOperation: UserOperation) => Promise<Hex>
 }
 
 export type SmartAccountSigner<

package/actions/pimlico/sponsorUserOperation.ts

@@ -1,4 +1,4 @@
-import type { Account, Address, Chain, Client, Hex, Transport } from "viem"
+import type { Account, Address, Chain, Client, Transport } from "viem"
 import type { PartialBy } from "viem/types/utils"
 import type { PimlicoPaymasterRpcSchema } from "../../types/pimlico.js"
 import type {
@@ -7,7 +7,7 @@ import type {
 } from "../../types/userOperation.js"
 import { deepHexlify } from "../../utils/deepHexlify.js"
 
-export type PimlocoSponsorUserOperationParameters = {
+export type PimlicoSponsorUserOperationParameters = {
     userOperation: PartialBy<
         UserOperation,
         | "callGasLimit"
@@ -19,12 +19,7 @@ export type PimlocoSponsorUserOperationParameters = {
     sponsorshipPolicyId?: string
 }
 
-export type SponsorUserOperationReturnType = {
-    paymasterAndData: Hex
-    preVerificationGas: bigint
-    verificationGasLimit: bigint
-    callGasLimit: bigint
-}
+export type SponsorUserOperationReturnType = UserOperation
 
 /**
  * Returns paymasterAndData & updated gas parameters required to sponsor a userOperation.
@@ -32,7 +27,7 @@ export type SponsorUserOperationReturnType = {
  * - Docs: https://docs.pimlico.io/permissionless/reference/pimlico-paymaster-actions/sponsorUserOperation
  *
  * @param client {@link PimlicoBundlerClient} that you created using viem's createClient whose transport url is pointing to the Pimlico's bundler.
- * @param args {@link PimlocoSponsorUserOperationParameters} UserOperation you want to sponsor & entryPoint.
+ * @param args {@link PimlicoSponsorUserOperationParameters} UserOperation you want to sponsor & entryPoint.
  * @returns paymasterAndData & updated gas parameters, see {@link SponsorUserOperationReturnType}
  *
  *
@@ -57,7 +52,7 @@ export const sponsorUserOperation = async <
     TAccount extends Account | undefined = Account | undefined
 >(
     client: Client<TTransport, TChain, TAccount, PimlicoPaymasterRpcSchema>,
-    args: PimlocoSponsorUserOperationParameters
+    args: PimlicoSponsorUserOperationParameters
 ): Promise<SponsorUserOperationReturnType> => {
     const response = await client.request({
         method: "pm_sponsorUserOperation",
@@ -79,10 +74,13 @@ export const sponsorUserOperation = async <
               ]
     })
 
-    return {
+    const userOperation: UserOperation = {
+        ...args.userOperation,
         paymasterAndData: response.paymasterAndData,
         preVerificationGas: BigInt(response.preVerificationGas),
         verificationGasLimit: BigInt(response.verificationGasLimit),
         callGasLimit: BigInt(response.callGasLimit)
     }
+
+    return userOperation
 }

package/actions/pimlico.ts

@@ -8,7 +8,7 @@ import {
     getUserOperationStatus
 } from "./pimlico/getUserOperationStatus.js"
 import {
-    type PimlocoSponsorUserOperationParameters,
+    type PimlicoSponsorUserOperationParameters,
     type SponsorUserOperationReturnType,
     sponsorUserOperation
 } from "./pimlico/sponsorUserOperation.js"
@@ -32,7 +32,7 @@ export type {
     GetUserOperationGasPriceReturnType,
     GetUserOperationStatusParameters,
     GetUserOperationStatusReturnType,
-    PimlocoSponsorUserOperationParameters,
+    PimlicoSponsorUserOperationParameters,
     SponsorUserOperationReturnType,
     PimlicoBundlerActions,
     PimlicoPaymasterClientActions,

package/actions/smartAccount/prepareUserOperationRequest.ts

@@ -1,4 +1,4 @@
-import type { Address, Chain, Client, Hex, Transport } from "viem"
+import type { Address, Chain, Client, Transport } from "viem"
 import { estimateFeesPerGas } from "viem/actions"
 import type { SmartAccount } from "../../accounts/types.js"
 import type {
@@ -17,12 +17,7 @@ export type SponsorUserOperationMiddleware = {
     sponsorUserOperation?: (args: {
         userOperation: UserOperation
         entryPoint: Address
-    }) => Promise<{
-        paymasterAndData: Hex
-        preVerificationGas: bigint
-        verificationGasLimit: bigint
-        callGasLimit: bigint
-    }>
+    }) => Promise<UserOperation>
 }
 
 export type PrepareUserOperationRequestParameters<
@@ -63,12 +58,11 @@ export async function prepareUserOperationRequest<
 
     const account = parseAccount(account_) as SmartAccount
 
-    const [sender, nonce, initCode, signature, callData, gasEstimation] =
+    const [sender, nonce, initCode, callData, gasEstimation] =
         await Promise.all([
             partialUserOperation.sender || account.address,
             partialUserOperation.nonce || account.getNonce(),
             partialUserOperation.initCode || account.getInitCode(),
-            partialUserOperation.signature || account.getDummySignature(),
             partialUserOperation.callData,
             !partialUserOperation.maxFeePerGas ||
             !partialUserOperation.maxPriorityFeePerGas
@@ -76,13 +70,13 @@ export async function prepareUserOperationRequest<
                 : undefined
         ])
 
-    const userOperation: UserOperation = {
+    let userOperation: UserOperation = {
         sender,
         nonce,
         initCode,
-        signature,
         callData,
         paymasterAndData: "0x",
+        signature: partialUserOperation.signature || "0x",
         maxFeePerGas:
             partialUserOperation.maxFeePerGas ||
             gasEstimation?.maxFeePerGas ||
@@ -96,22 +90,15 @@ export async function prepareUserOperationRequest<
         preVerificationGas: partialUserOperation.preVerificationGas || 0n
     }
 
+    if (userOperation.signature === "0x") {
+        userOperation.signature = await account.getDummySignature(userOperation)
+    }
+
     if (sponsorUserOperation) {
-        const {
-            callGasLimit,
-            verificationGasLimit,
-            preVerificationGas,
-            paymasterAndData
-        } = await sponsorUserOperation({
+        userOperation = await sponsorUserOperation({
             userOperation,
             entryPoint: account.entryPoint
         })
-        userOperation.paymasterAndData = paymasterAndData
-        userOperation.callGasLimit = userOperation.callGasLimit || callGasLimit
-        userOperation.verificationGasLimit =
-            userOperation.verificationGasLimit || verificationGasLimit
-        userOperation.preVerificationGas =
-            userOperation.preVerificationGas || preVerificationGas
     } else if (
         !userOperation.callGasLimit ||
         !userOperation.verificationGasLimit ||

package/actions/smartAccount.ts

@@ -30,6 +30,11 @@ import {
     sendTransactions
 } from "./smartAccount/sendTransactions.js"
 
+import {
+    type WriteContractWithPaymasterParameters,
+    writeContract
+} from "./smartAccount/writeContract.js"
+
 export {
     deployContract,
     type DeployContractParametersWithPaymaster,
@@ -45,5 +50,7 @@ export {
     type SendTransactionWithPaymasterParameters,
     type SponsorUserOperationMiddleware,
     sendTransactions,
-    type SendTransactionsWithPaymasterParameters
+    type SendTransactionsWithPaymasterParameters,
+    type WriteContractWithPaymasterParameters,
+    writeContract
 }

package/actions/stackup/sponsorUserOperation.ts

@@ -1,4 +1,4 @@
-import type { Address, Hex } from "viem"
+import type { Address } from "viem"
 import type { PartialBy } from "viem/types/utils"
 import { type StackupPaymasterClient } from "../../clients/stackup.js"
 import type { StackupPaymasterContext } from "../../types/stackup.js"
@@ -20,12 +20,7 @@ export type SponsorUserOperationParameters = {
     context: StackupPaymasterContext
 }
 
-export type SponsorUserOperationReturnType = {
-    paymasterAndData: Hex
-    preVerificationGas: bigint
-    verificationGasLimit: bigint
-    callGasLimit: bigint
-}
+export type SponsorUserOperationReturnType = UserOperation
 
 /**
  * Returns paymasterAndData & updated gas parameters required to sponsor a userOperation.
@@ -65,10 +60,13 @@ export const sponsorUserOperation = async (
         ]
     })
 
-    return {
+    const userOperation: UserOperation = {
+        ...args.userOperation,
         paymasterAndData: response.paymasterAndData,
         preVerificationGas: BigInt(response.preVerificationGas),
         verificationGasLimit: BigInt(response.verificationGasLimit),
         callGasLimit: BigInt(response.callGasLimit)
     }
+
+    return userOperation
 }

package/clients/decorators/pimlico.ts

@@ -14,7 +14,7 @@ import {
     getUserOperationStatus
 } from "../../actions/pimlico/getUserOperationStatus.js"
 import {
-    type PimlocoSponsorUserOperationParameters,
+    type PimlicoSponsorUserOperationParameters,
     type SponsorUserOperationReturnType,
     sponsorUserOperation
 } from "../../actions/pimlico/sponsorUserOperation.js"
@@ -83,7 +83,7 @@ export type PimlicoPaymasterClientActions = {
      *
      * https://docs.pimlico.io/permissionless/reference/pimlico-paymaster-actions/sponsorUserOperation
      *
-     * @param args {@link PimlocoSponsorUserOperationParameters} UserOperation you want to sponsor & entryPoint.
+     * @param args {@link PimlicoSponsorUserOperationParameters} UserOperation you want to sponsor & entryPoint.
      * @returns paymasterAndData & updated gas parameters, see {@link SponsorUserOperationReturnType}
      *
      * @example
@@ -102,7 +102,7 @@ export type PimlicoPaymasterClientActions = {
      *
      */
     sponsorUserOperation: (
-        args: PimlocoSponsorUserOperationParameters
+        args: PimlicoSponsorUserOperationParameters
     ) => Promise<SponsorUserOperationReturnType>
 
     validateSponsorshipPolicies: (
@@ -148,7 +148,7 @@ export type PimlicoPaymasterClientActions = {
 export const pimlicoPaymasterActions = (
     client: Client
 ): PimlicoPaymasterClientActions => ({
-    sponsorUserOperation: async (args: PimlocoSponsorUserOperationParameters) =>
+    sponsorUserOperation: async (args: PimlicoSponsorUserOperationParameters) =>
         sponsorUserOperation(client as PimlicoPaymasterClient, args),
     validateSponsorshipPolicies: async (
         args: ValidateSponsorshipPoliciesParameters

package/clients/decorators/smartAccount.ts

@@ -26,6 +26,11 @@ import {
     type SendTransactionWithPaymasterParameters,
     sendTransaction
 } from "../../actions/smartAccount/sendTransaction.js"
+import {
+    type SendUserOperationParameters,
+    type SendUserOperationReturnType,
+    sendUserOperation
+} from "../../actions/smartAccount/sendUserOperation.js"
 import { signMessage } from "../../actions/smartAccount/signMessage.js"
 import { signTypedData } from "../../actions/smartAccount/signTypedData.js"
 import {
@@ -359,6 +364,11 @@ export type SmartAccountActions<
             >
         >[1]
     ) => Promise<PrepareUserOperationRequestReturnType>
+    sendUserOperation: <TTransport extends Transport>(
+        args: Parameters<
+            typeof sendUserOperation<TTransport, TChain, TSmartAccount>
+        >[1]
+    ) => Promise<SendUserOperationReturnType>
     /**
      * Creates, signs, and sends a new transaction to the network.
      * This function also allows you to sponsor this transaction if sender is a smartAccount
@@ -441,6 +451,11 @@ export const smartAccountActions =
                 ...args,
                 sponsorUserOperation
             } as SendTransactionsWithPaymasterParameters),
+        sendUserOperation: (args) =>
+            sendUserOperation(client, {
+                ...args,
+                sponsorUserOperation
+            } as SendUserOperationParameters),
         signMessage: (args) => signMessage(client, args),
         signTypedData: (args) => signTypedData(client, args),
         writeContract: (args) =>

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "permissionless",
-    "version": "0.0.18",
+    "version": "0.0.20",
     "author": "Pimlico",
     "main": "./_cjs/index.js",
     "module": "./_esm/index.js",

package/utils/index.ts

@@ -1,4 +1,6 @@
 import type { Account, Address } from "viem"
+import { deepHexlify, transactionReceiptStatus } from "./deepHexlify.js"
+import { getAction } from "./getAction.js"
 import {
     type GetRequiredPrefundReturnType,
     getRequiredPrefund
@@ -9,6 +11,7 @@ import {
 } from "./getUserOperationHash.js"
 import {
     AccountOrClientNotFoundError,
+    type SignUserOperationHashWithECDSAParams,
     signUserOperationHashWithECDSA
 } from "./signUserOperationHashWithECDSA.js"
 import { walletClientToCustomSigner } from "./walletClientToCustomSigner.js"
@@ -20,11 +23,15 @@ export function parseAccount(account: Address | Account): Account {
 }
 
 export {
+    transactionReceiptStatus,
+    deepHexlify,
+    getAction,
     getUserOperationHash,
     getRequiredPrefund,
     walletClientToCustomSigner,
     type GetRequiredPrefundReturnType,
     type GetUserOperationHashParams,
     signUserOperationHashWithECDSA,
+    type SignUserOperationHashWithECDSAParams,
     AccountOrClientNotFoundError
 }

package/utils/signUserOperationHashWithECDSA.ts

@@ -13,7 +13,7 @@ import type { UserOperation } from "../types/userOperation.js"
 import { getUserOperationHash } from "./getUserOperationHash.js"
 import { parseAccount } from "./index.js"
 
-export type signUserOperationHashWithECDSAParams<
+export type SignUserOperationHashWithECDSAParams<
     TTransport extends Transport = Transport,
     TChain extends Chain | undefined = Chain | undefined,
     TAccount extends Account | undefined = Account | undefined
@@ -83,7 +83,7 @@ export const signUserOperationHashWithECDSA = async <
     userOperation,
     chainId,
     entryPoint
-}: signUserOperationHashWithECDSAParams<
+}: SignUserOperationHashWithECDSAParams<
     TTransport,
     TChain,
     TAccount

package/utils/deepHexlify.test.ts

@@ -1,35 +0,0 @@
-import { beforeAll, expect, test } from "bun:test"
-import dotenv from "dotenv"
-import { deepHexlify } from "./deepHexlify.js"
-
-dotenv.config()
-
-beforeAll(() => {
-    if (!process.env.STACKUP_API_KEY)
-        throw new Error("STACKUP_API_KEY environment variable not set")
-    if (!process.env.FACTORY_ADDRESS)
-        throw new Error("FACTORY_ADDRESS environment variable not set")
-    if (!process.env.TEST_PRIVATE_KEY)
-        throw new Error("TEST_PRIVATE_KEY environment variable not set")
-    if (!process.env.RPC_URL)
-        throw new Error("RPC_URL environment variable not set")
-    if (!process.env.ENTRYPOINT_ADDRESS)
-        throw new Error("ENTRYPOINT_ADDRESS environment variable not set")
-})
-
-test("Test deep Hexlify", async () => {
-    expect(deepHexlify("abcd")).toBe("abcd")
-    expect(deepHexlify(null)).toBe(null)
-    expect(deepHexlify(true)).toBe(true)
-    expect(deepHexlify(false)).toBe(false)
-    expect(deepHexlify(1n)).toBe("0x1")
-    expect(
-        deepHexlify({
-            name: "Garvit",
-            balance: 1n
-        })
-    ).toEqual({
-        name: "Garvit",
-        balance: "0x1"
-    })
-})