permissionless 0.0.2 → 0.0.4

package/types/bundler.ts

@@ -1,10 +1,8 @@
-import type { Account, Address, Chain, Client, Hash, Hex, Transport } from "viem"
+import type { Address, Hash, Hex } from "viem"
 import type { PartialBy } from "viem/types/utils"
 import type { UserOperationWithBigIntAsHex } from "./userOperation"
 
-export type BundlerClient = Client<Transport, Chain | undefined, Account | undefined, BundlerRpcSchema>
-
-type BundlerRpcSchema = [
+export type BundlerRpcSchema = [
     {
         Method: "eth_sendUserOperation"
         Parameters: [userOperation: UserOperationWithBigIntAsHex, entryPoint: Address]
@@ -53,39 +51,6 @@ type BundlerRpcSchema = [
     }
 ]
 
-export type UserOperationReceipt = {
-    userOpHash: Hash
-    sender: Address
-    nonce: bigint
-    actualGasUsed: bigint
-    actualGasCost: bigint
-    success: boolean
-    receipt: {
-        transactionHash: Hex
-        transactionIndex: bigint
-        blockHash: Hash
-        blockNumber: bigint
-        from: Address
-        to: Address | null
-        cumulativeGasUsed: bigint
-        status: bigint | null
-        gasUsed: bigint
-        contractAddress: Address | null
-        logsBloom: string
-        effectiveGasPrice: bigint
-    }
-    logs: {
-        data: Hex
-        blockNumber: bigint
-        blockHash: Hash
-        transactionHash: Hash
-        logIndex: bigint
-        transactionIndex: bigint
-        address: Address
-        topics: Hex[]
-    }[]
-}
-
 type UserOperationReceiptWithBigIntAsHex = {
     userOpHash: Hash
     sender: Address
@@ -101,10 +66,10 @@ type UserOperationReceiptWithBigIntAsHex = {
         from: Address
         to: Address | null
         cumulativeGasUsed: Hex
-        status: Hex | null
+        status: "0x0" | "0x1"
         gasUsed: Hex
         contractAddress: Address | null
-        logsBloom: string
+        logsBloom: Hex
         effectiveGasPrice: Hex
     }
     logs: {

package/types/index.ts

@@ -1,4 +1,3 @@
-import type { UserOperationReceipt } from "./bundler"
 import type { UserOperation } from "./userOperation"
 
-export type { UserOperationReceipt, UserOperation }
+export type { UserOperation }

package/types/pimlico.ts

@@ -0,0 +1,55 @@
+import type { Address, Hash, Hex } from "viem"
+import type { PartialBy } from "viem/types/utils"
+import type { UserOperationWithBigIntAsHex } from "./userOperation"
+
+type PimlicoUserOperationGasPriceWithBigIntAsHex = {
+    slow: {
+        maxFeePerGas: Hex
+        maxPriorityFeePerGas: Hex
+    }
+    standard: {
+        maxFeePerGas: Hex
+        maxPriorityFeePerGas: Hex
+    }
+    fast: {
+        maxFeePerGas: Hex
+        maxPriorityFeePerGas: Hex
+    }
+}
+
+export type PimlicoUserOperationStatus = {
+    status: "not_found" | "not_submitted" | "submitted" | "rejected" | "reverted" | "included" | "failed"
+    transactionHash: Hash | null
+}
+
+export type PimlicoBundlerRpcSchema = [
+    {
+        Method: "pimlico_getUserOperationGasPrice"
+        Parameters: []
+        ReturnType: PimlicoUserOperationGasPriceWithBigIntAsHex
+    },
+    {
+        Method: "pimlico_getUserOperationStatus"
+        Parameters: [hash: Hash]
+        ReturnType: PimlicoUserOperationStatus
+    }
+]
+
+export type PimlicoPaymasterRpcSchema = [
+    {
+        Method: "pm_sponsorUserOperation"
+        Parameters: [
+            userOperation: PartialBy<
+                UserOperationWithBigIntAsHex,
+                "callGasLimit" | "preVerificationGas" | "verificationGasLimit" | "paymasterAndData"
+            >,
+            entryPoint: Address
+        ]
+        ReturnType: {
+            paymasterAndData: Hex
+            preVerificationGas: Hex
+            verificationGasLimit: Hex
+            callGasLimit: Hex
+        }
+    }
+]

package/types/userOperation.ts

@@ -1,6 +1,8 @@
 import type { Address } from "abitype"
 import type { Hex } from "viem"
 
+export type TStatus = "success" | "reverted"
+
 export type UserOperationWithBigIntAsHex = {
     sender: Address
     nonce: Hex

package/utils/index.ts

@@ -0,0 +1,70 @@
+import type { Address, Hash, Hex } from "viem"
+import { encodeAbiParameters, keccak256 } from "viem"
+import type { UserOperation } from "../types"
+
+function packUserOp({ userOperation }: { userOperation: UserOperation }): Hex {
+    const hashedInitCode = keccak256(userOperation.initCode)
+    const hashedCallData = keccak256(userOperation.callData)
+    const hashedPaymasterAndData = keccak256(userOperation.paymasterAndData)
+
+    return encodeAbiParameters(
+        [
+            { type: "address" },
+            { type: "uint256" },
+            { type: "bytes32" },
+            { type: "bytes32" },
+            { type: "uint256" },
+            { type: "uint256" },
+            { type: "uint256" },
+            { type: "uint256" },
+            { type: "uint256" },
+            { type: "bytes32" }
+        ],
+        [
+            userOperation.sender as Address,
+            userOperation.nonce,
+            hashedInitCode,
+            hashedCallData,
+            userOperation.callGasLimit,
+            userOperation.verificationGasLimit,
+            userOperation.preVerificationGas,
+            userOperation.maxFeePerGas,
+            userOperation.maxPriorityFeePerGas,
+            hashedPaymasterAndData
+        ]
+    )
+}
+
+export type GetUserOperationHashParams = { userOperation: UserOperation; entryPoint: Address; chainId: number }
+
+/**
+ *
+ * Returns user operation hash that is a unique identifier of the user operation.
+ *
+ * - Docs: https://docs.pimlico.io/permissionless/reference/utils/getUserOperationHash
+ *
+ * @param args: userOperation, entryPoint, chainId as {@link GetUserOperationHashParams}
+ * @returns userOperationHash as {@link Hash}
+ *
+ * @example
+ * import { getUserOperationHash } from "permissionless/utils"
+ *
+ * const userOperationHash = getUserOperationHash({
+ *      userOperation,
+ *      entryPoint,
+ *      chainId
+ * })
+ *
+ * // Returns "0xe9fad2cd67f9ca1d0b7a6513b2a42066784c8df938518da2b51bb8cc9a89ea34"
+ *
+ */
+const getUserOperationHash = ({ userOperation, entryPoint, chainId }: GetUserOperationHashParams): Hash => {
+    const encoded = encodeAbiParameters(
+        [{ type: "bytes32" }, { type: "address" }, { type: "uint256" }],
+        [keccak256(packUserOp({ userOperation })), entryPoint, BigInt(chainId)]
+    ) as `0x${string}`
+
+    return keccak256(encoded)
+}
+
+export { getUserOperationHash }