permissionless 0.1.3 → 0.1.5

package/accounts/toSmartAccount.ts

@@ -0,0 +1,167 @@
+import {
+    type Abi,
+    type Address,
+    type Chain,
+    type Client,
+    type CustomSource,
+    type EncodeDeployDataParameters,
+    type Hex,
+    type SignableMessage,
+    type Transport,
+    type TypedDataDefinition,
+    concat,
+    encodeAbiParameters
+} from "viem"
+import { toAccount } from "viem/accounts"
+import type { UserOperation } from "../types"
+import type { EntryPoint, GetEntryPointVersion } from "../types/entrypoint"
+import { isSmartAccountDeployed } from "../utils"
+import {
+    SignTransactionNotSupportedBySmartAccount,
+    type SmartAccount
+} from "./types"
+
+const MAGIC_BYTES =
+    "0x6492649264926492649264926492649264926492649264926492649264926492"
+
+export function toSmartAccount<
+    TAccountSource extends CustomSource,
+    TEntryPoint extends EntryPoint,
+    TSource extends string = string,
+    transport extends Transport = Transport,
+    chain extends Chain | undefined = Chain | undefined,
+    TAbi extends Abi | readonly unknown[] = Abi
+>({
+    address,
+    client,
+    source,
+    entryPoint,
+    getNonce,
+    getInitCode,
+    getFactory,
+    getFactoryData,
+    encodeCallData,
+    getDummySignature,
+    encodeDeployCallData,
+    signUserOperation,
+    signMessage,
+    signTypedData
+}: TAccountSource & {
+    source: TSource
+    client: Client<transport, chain>
+    entryPoint: TEntryPoint
+    getNonce: () => Promise<bigint>
+    getInitCode: () => Promise<Hex>
+    getFactory: () => Promise<Address | undefined>
+    getFactoryData: () => Promise<Hex | undefined>
+    encodeCallData: (
+        args:
+            | {
+                  to: Address
+                  value: bigint
+                  data: Hex
+              }
+            | {
+                  to: Address
+                  value: bigint
+                  data: Hex
+              }[]
+    ) => Promise<Hex>
+    getDummySignature(
+        userOperation: UserOperation<GetEntryPointVersion<TEntryPoint>>
+    ): Promise<Hex>
+    encodeDeployCallData: ({
+        abi,
+        args,
+        bytecode
+    }: EncodeDeployDataParameters<TAbi>) => Promise<Hex>
+    signUserOperation: (
+        userOperation: UserOperation<GetEntryPointVersion<TEntryPoint>>
+    ) => Promise<Hex>
+}): SmartAccount<TEntryPoint, TSource, transport, chain, TAbi> {
+    const account = toAccount({
+        address: address,
+        signMessage: async ({ message }: { message: SignableMessage }) => {
+            const isDeployed = await isSmartAccountDeployed(client, address)
+            const signature = await signMessage({ message })
+
+            if (isDeployed) return signature
+
+            const abiEncodedMessage = encodeAbiParameters(
+                [
+                    {
+                        type: "address",
+                        name: "create2Factory"
+                    },
+                    {
+                        type: "bytes",
+                        name: "factoryCalldata"
+                    },
+                    {
+                        type: "bytes",
+                        name: "originalERC1271Signature"
+                    }
+                ],
+                [
+                    (await getFactory()) ?? "0x", // "0x should never happen if it's deployed"
+                    (await getFactoryData()) ?? "0x", // "0x should never happen if it's deployed"
+                    signature
+                ]
+            )
+
+            return concat([abiEncodedMessage, MAGIC_BYTES])
+        },
+        signTypedData: async (typedData) => {
+            const isDeployed = await isSmartAccountDeployed(client, address)
+            const signature = await signTypedData(
+                typedData as TypedDataDefinition
+            )
+
+            if (isDeployed) return signature
+
+            const abiEncodedMessage = encodeAbiParameters(
+                [
+                    {
+                        type: "address",
+                        name: "create2Factory"
+                    },
+                    {
+                        type: "bytes",
+                        name: "factoryCalldata"
+                    },
+                    {
+                        type: "bytes",
+                        name: "originalERC1271Signature"
+                    }
+                ],
+                [
+                    (await getFactory()) ?? "0x", // "0x should never happen if it's deployed"
+                    (await getFactoryData()) ?? "0x", // "0x should never happen if it's deployed"
+                    signature
+                ]
+            )
+
+            return concat([abiEncodedMessage, MAGIC_BYTES])
+        },
+        async signTransaction(_, __) {
+            throw new SignTransactionNotSupportedBySmartAccount()
+        }
+    })
+
+    return {
+        ...account,
+        source,
+        client,
+        type: "local",
+        entryPoint,
+        publicKey: address,
+        getNonce,
+        getInitCode,
+        getFactory,
+        getFactoryData,
+        encodeCallData,
+        getDummySignature,
+        encodeDeployCallData,
+        signUserOperation
+    } as SmartAccount<TEntryPoint, TSource, transport, chain, TAbi>
+}

package/accounts/types.ts

@@ -28,11 +28,11 @@ export class SignTransactionNotSupportedBySmartAccount extends BaseError {
 
 export type SmartAccount<
     entryPoint extends EntryPoint,
-    Name extends string = string,
+    TSource extends string = string,
     transport extends Transport = Transport,
     chain extends Chain | undefined = Chain | undefined,
     TAbi extends Abi | readonly unknown[] = Abi
-> = LocalAccount<Name> & {
+> = LocalAccount<TSource> & {
     client: Client<transport, chain>
     entryPoint: entryPoint
     getNonce: () => Promise<bigint>

package/actions/bundler/estimateUserOperationGas.ts

@@ -48,8 +48,8 @@ export type EstimateUserOperationGasReturnType<entryPoint extends EntryPoint> =
               preVerificationGas: bigint
               verificationGasLimit: bigint
               callGasLimit: bigint
-              paymasterVerificationGasLimit: bigint | undefined
-              paymasterPostOpGasLimit: bigint | undefined
+              paymasterVerificationGasLimit?: bigint
+              paymasterPostOpGasLimit?: bigint
           }
 
 export type EstimateUserOperationErrorType<entryPoint extends EntryPoint> =
@@ -131,8 +131,8 @@ export const estimateUserOperationGas = async <
             preVerificationGas: Hex
             verificationGasLimit: Hex
             callGasLimit: Hex
-            paymasterVerificationGasLimit: Hex | undefined
-            paymasterPostOpGasLimit: Hex | undefined
+            paymasterVerificationGasLimit?: Hex
+            paymasterPostOpGasLimit?: Hex
         }
 
         return {

package/actions/pimlico/sendCompressedUserOperation.ts

@@ -32,7 +32,7 @@ export type SendCompressedUserOperationParameters = {
  * const bundlerClient = createClient({
  *      chain: goerli,
  *      transport: http("https://api.pimlico.io/v2/goerli/rpc?apikey=YOUR_API_KEY_HERE")
- * }).extend(pimlicoBundlerActions)
+ * }).extend(pimlicoBundlerActions(entryPoint))
  *
  * const userOpHash = await sendCompressedUserOperation(bundlerClient, {
  *     compressedUserOperation,

package/actions/smartAccount/prepareUserOperationRequest.ts

@@ -269,8 +269,8 @@ async function prepareUserOperationRequestEntryPointV07<
     const userOperation: UserOperation<"v0.7"> = {
         sender,
         nonce,
-        factory: factory || undefined,
-        factoryData: factoryData || undefined,
+        factory: factory,
+        factoryData: factoryData,
         callData,
         callGasLimit: partialUserOperation.callGasLimit || 0n,
         verificationGasLimit: partialUserOperation.verificationGasLimit || 0n,
@@ -283,10 +283,6 @@ async function prepareUserOperationRequestEntryPointV07<
             partialUserOperation.maxPriorityFeePerGas ||
             gasEstimation?.maxPriorityFeePerGas ||
             0n,
-        paymaster: undefined,
-        paymasterVerificationGasLimit: undefined,
-        paymasterPostOpGasLimit: undefined,
-        paymasterData: undefined,
         signature: partialUserOperation.signature || "0x"
     }
 

package/clients/decorators/pimlico.ts

@@ -94,28 +94,37 @@ export type PimlicoBundlerActions = {
      * // Return '0xe9fad2cd67f9ca1d0b7a6513b2a42066784c8df938518da2b51bb8cc9a89ea34'
      */
     sendCompressedUserOperation: (
-        args: Prettify<SendCompressedUserOperationParameters>
+        args: Prettify<
+            Omit<SendCompressedUserOperationParameters, "entryPoint">
+        >
     ) => Promise<Hash>
 }
 
-export const pimlicoBundlerActions = <entryPoint extends EntryPoint>(
-    client: Client
-): PimlicoBundlerActions => ({
-    getUserOperationGasPrice: async () =>
-        getUserOperationGasPrice(client as PimlicoBundlerClient<entryPoint>),
-    getUserOperationStatus: async (args: GetUserOperationStatusParameters) =>
-        getUserOperationStatus(
-            client as PimlicoBundlerClient<entryPoint>,
-            args
-        ),
-    sendCompressedUserOperation: async (
-        args: SendCompressedUserOperationParameters
-    ) =>
-        sendCompressedUserOperation(
-            client as PimlicoBundlerClient<entryPoint>,
-            args
-        )
-})
+export const pimlicoBundlerActions =
+    <entryPoint extends EntryPoint>(entryPointAddress: entryPoint) =>
+    (client: Client): PimlicoBundlerActions => ({
+        getUserOperationGasPrice: async () =>
+            getUserOperationGasPrice(
+                client as PimlicoBundlerClient<entryPoint>
+            ),
+        getUserOperationStatus: async (
+            args: GetUserOperationStatusParameters
+        ) =>
+            getUserOperationStatus(
+                client as PimlicoBundlerClient<entryPoint>,
+                args
+            ),
+        sendCompressedUserOperation: async (
+            args: Omit<SendCompressedUserOperationParameters, "entryPoint">
+        ) =>
+            sendCompressedUserOperation(
+                client as PimlicoBundlerClient<entryPoint>,
+                {
+                    ...args,
+                    entryPoint: entryPointAddress
+                }
+            )
+    })
 
 export type PimlicoPaymasterClientActions<entryPoint extends EntryPoint> = {
     /**
@@ -149,7 +158,12 @@ export type PimlicoPaymasterClientActions<entryPoint extends EntryPoint> = {
     ) => Promise<Prettify<SponsorUserOperationReturnType<entryPoint>>>
 
     validateSponsorshipPolicies: (
-        args: Prettify<ValidateSponsorshipPoliciesParameters<entryPoint>>
+        args: Prettify<
+            Omit<
+                ValidateSponsorshipPoliciesParameters<entryPoint>,
+                "entryPoint"
+            >
+        >
     ) => Promise<Prettify<ValidateSponsorshipPolicies>[]>
 }
 
@@ -210,7 +224,7 @@ export const pimlicoPaymasterActions =
                 "entryPoint"
             >
         ) =>
-            validateSponsorshipPolicies<entryPoint>(
+            validateSponsorshipPolicies(
                 client as PimlicoPaymasterClient<entryPoint>,
                 { ...args, entryPoint: entryPointAddress }
             )

package/clients/pimlico.ts

@@ -72,7 +72,7 @@ export const createPimlicoBundlerClient = <
     })
     return client
         .extend(bundlerActions(parameters.entryPoint))
-        .extend(pimlicoBundlerActions)
+        .extend(pimlicoBundlerActions(parameters.entryPoint))
 }
 
 /**

package/package.json

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

package/types/bundler.ts

@@ -44,9 +44,9 @@ export type BundlerRpcSchema<entryPoint extends EntryPoint> = [
             : {
                   preVerificationGas: Hex
                   verificationGasLimit: Hex
-                  callGasLimit: Hex | null | undefined
-                  paymasterVerificationGasLimit: Hex | null | undefined
-                  paymasterPostOpGasLimit: Hex | null | undefined
+                  callGasLimit?: Hex | null
+                  paymasterVerificationGasLimit?: Hex | null
+                  paymasterPostOpGasLimit?: Hex | null
               }
     },
     {

package/types/userOperation.ts

@@ -70,18 +70,18 @@ export type UserOperation<entryPointVersion extends EntryPointVersion> =
         : {
               sender: Address
               nonce: bigint
-              factory: Address | undefined
-              factoryData: Hex | undefined
+              factory?: Address
+              factoryData?: Hex
               callData: Hex
               callGasLimit: bigint
               verificationGasLimit: bigint
               preVerificationGas: bigint
               maxFeePerGas: bigint
               maxPriorityFeePerGas: bigint
-              paymaster: Address | undefined
-              paymasterVerificationGasLimit: bigint | undefined
-              paymasterPostOpGasLimit: bigint | undefined
-              paymasterData: Hex | undefined
+              paymaster?: Address
+              paymasterVerificationGasLimit?: bigint
+              paymasterPostOpGasLimit?: bigint
+              paymasterData?: Hex
               signature: Hex
               initCode?: never
               paymasterAndData?: never