permissionless 0.0.1 → 0.0.3

package/_types/clients/pimlico.d.ts

@@ -0,0 +1,75 @@
+import type { Account, Chain, Client, PublicClientConfig, Transport } from "viem";
+import type { BundlerActions } from "../actions/bundler";
+import { type PimlicoBundlerActions, type PimlicoPaymasterClientActions } from "../actions/pimlico";
+import type { PimlicoBundlerRpcSchema, PimlicoPaymasterRpcSchema } from "../types/pimlico";
+export type PimlicoBundlerClient = Client<Transport, Chain | undefined, Account | undefined, PimlicoBundlerRpcSchema, PimlicoBundlerActions & BundlerActions>;
+export type PimlicoPaymasterClient = Client<Transport, Chain | undefined, Account | undefined, PimlicoPaymasterRpcSchema, PimlicoPaymasterClientActions>;
+/**
+ * Creates a pimlico specific Bundler Client with a given [Transport](https://viem.sh/docs/clients/intro.html) configured for a [Chain](https://viem.sh/docs/clients/chains.html).
+ *
+ * - Docs: [TODO://add link]
+ * - Example: [TODO://add link]
+ *
+ * A Pimlico Client is an interface to "pimlico endpoints" [JSON-RPC API](https://docs.pimlico.io/reference/bundler/endpoints) methods such as getting current blockchain gas prices, getting user operation status, etc through [Pimlico Bundler Actions](TODO://Add bundler action documentation link).
+ *
+ * @param config - {@link PublicClientConfig}
+ * @returns A Pimlico Bundler Client. {@link PimlicoBundlerClient}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ *
+ * const pimlicoBundlerClient = createPimlicoBundlerClient({
+ *   chain: mainnet,
+ *   transport: http("https://api.pimlico.io/v1/goerli/rpc?apikey=YOUR_API_KEY_HERE"),
+ * })
+ */
+export declare const createPimlicoBundlerClient: <transport extends Transport, chain extends Chain | undefined = undefined>(parameters: {
+    name?: string | undefined;
+    pollingInterval?: number | undefined;
+    chain?: Chain | chain | undefined;
+    key?: string | undefined;
+    batch?: {
+        multicall?: boolean | {
+            batchSize?: number | undefined;
+            wait?: number | undefined;
+        } | undefined;
+    } | undefined;
+    cacheTime?: number | undefined;
+    transport: transport;
+}) => PimlicoBundlerClient;
+/**
+ * Creates a pimlico specific Paymaster Client with a given [Transport](https://viem.sh/docs/clients/intro.html) configured for a [Chain](https://viem.sh/docs/clients/chains.html).
+ *
+ * - Docs: [TODO://add link]
+ * - Example: [TODO://add link]
+ *
+ * A Pimlico Paymaster Client is an interface to "pimlico paymaster endpoints" [JSON-RPC API](https://docs.pimlico.io/reference/verifying-paymaster/endpoints) methods such as sponsoring user operation, etc through [Pimlico Paymaster Actions](TODO://Add bundler action documentation link).
+ *
+ * @param config - {@link PublicClientConfig}
+ * @returns A Pimlico Paymaster Client. {@link PimlicoPaymasterClient}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ *
+ * const pimlicoPaymasterClient = createPimlicoPaymasterClient({
+ *   chain: mainnet,
+ *   transport: http("https://api.pimlico.io/v2/goerli/rpc?apikey=YOUR_API_KEY_HERE"),
+ * })
+ */
+export declare const createPimlicoPaymasterClient: <transport extends Transport, chain extends Chain | undefined = undefined>(parameters: {
+    name?: string | undefined;
+    pollingInterval?: number | undefined;
+    chain?: Chain | chain | undefined;
+    key?: string | undefined;
+    batch?: {
+        multicall?: boolean | {
+            batchSize?: number | undefined;
+            wait?: number | undefined;
+        } | undefined;
+    } | undefined;
+    cacheTime?: number | undefined;
+    transport: transport;
+}) => PimlicoPaymasterClient;
+//# sourceMappingURL=pimlico.d.ts.map

package/_types/clients/pimlico.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pimlico.d.ts","sourceRoot":"","sources":["../../clients/pimlico.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,kBAAkB,EAAE,SAAS,EAAE,MAAM,MAAM,CAAA;AAGjF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AACxD,OAAO,EACH,KAAK,qBAAqB,EAC1B,KAAK,6BAA6B,EAGrC,MAAM,oBAAoB,CAAA;AAC3B,OAAO,KAAK,EAAE,uBAAuB,EAAE,yBAAyB,EAAE,MAAM,kBAAkB,CAAA;AAE1F,MAAM,MAAM,oBAAoB,GAAG,MAAM,CACrC,SAAS,EACT,KAAK,GAAG,SAAS,EACjB,OAAO,GAAG,SAAS,EACnB,uBAAuB,EACvB,qBAAqB,GAAG,cAAc,CACzC,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG,MAAM,CACvC,SAAS,EACT,KAAK,GAAG,SAAS,EACjB,OAAO,GAAG,SAAS,EACnB,yBAAyB,EACzB,6BAA6B,CAChC,CAAA;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;MAEpC,oBASF,CAAA;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;MAEtC,sBASF,CAAA"}

package/_types/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./actions";
+export * from "./clients";
+export * from "./types";
+//# sourceMappingURL=index.d.ts.map

package/_types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA;AACzB,cAAc,WAAW,CAAA;AACzB,cAAc,SAAS,CAAA"}

package/_types/types/bundler.d.ts

@@ -0,0 +1,82 @@
+import type { Address, Hash, Hex } from "viem";
+import type { PartialBy } from "viem/types/utils";
+import type { UserOperationWithBigIntAsHex } from "./userOperation";
+export type BundlerRpcSchema = [
+    {
+        Method: "eth_sendUserOperation";
+        Parameters: [userOperation: UserOperationWithBigIntAsHex, entryPoint: Address];
+        ReturnType: Hash;
+    },
+    {
+        Method: "eth_estimateUserOperationGas";
+        Parameters: [
+            userOperation: PartialBy<UserOperationWithBigIntAsHex, "callGasLimit" | "preVerificationGas" | "verificationGasLimit">,
+            entryPoint: Address
+        ];
+        ReturnType: {
+            preVerificationGas: Hex;
+            verificationGasLimit: Hex;
+            callGasLimit: Hex;
+        };
+    },
+    {
+        Method: "eth_supportedEntryPoints";
+        Parameters: [];
+        ReturnType: Address[];
+    },
+    {
+        Method: "eth_chainId";
+        Parameters: [];
+        ReturnType: Hex;
+    },
+    {
+        Method: "eth_getUserOperationByHash";
+        Parameters: [hash: Hash];
+        ReturnType: {
+            userOperation: UserOperationWithBigIntAsHex;
+            entryPoint: Address;
+            transactionHash: Hash;
+            blockHash: Hash;
+            blockNumber: Hex;
+        };
+    },
+    {
+        Method: "eth_getUserOperationReceipt";
+        Parameters: [hash: Hash];
+        ReturnType: UserOperationReceiptWithBigIntAsHex;
+    }
+];
+type UserOperationReceiptWithBigIntAsHex = {
+    userOpHash: Hash;
+    sender: Address;
+    nonce: Hex;
+    actualGasUsed: Hex;
+    actualGasCost: Hex;
+    success: boolean;
+    receipt: {
+        transactionHash: Hex;
+        transactionIndex: Hex;
+        blockHash: Hash;
+        blockNumber: Hex;
+        from: Address;
+        to: Address | null;
+        cumulativeGasUsed: Hex;
+        status: "0x0" | "0x1";
+        gasUsed: Hex;
+        contractAddress: Address | null;
+        logsBloom: Hex;
+        effectiveGasPrice: Hex;
+    };
+    logs: {
+        data: Hex;
+        blockNumber: Hex;
+        blockHash: Hash;
+        transactionHash: Hash;
+        logIndex: Hex;
+        transactionIndex: Hex;
+        address: Address;
+        topics: Hex[];
+    }[];
+};
+export {};
+//# sourceMappingURL=bundler.d.ts.map

package/_types/types/bundler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bundler.d.ts","sourceRoot":"","sources":["../../types/bundler.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,MAAM,CAAA;AAC9C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,iBAAiB,CAAA;AAEnE,MAAM,MAAM,gBAAgB,GAAG;IAC3B;QACI,MAAM,EAAE,uBAAuB,CAAA;QAC/B,UAAU,EAAE,CAAC,aAAa,EAAE,4BAA4B,EAAE,UAAU,EAAE,OAAO,CAAC,CAAA;QAC9E,UAAU,EAAE,IAAI,CAAA;KACnB;IACD;QACI,MAAM,EAAE,8BAA8B,CAAA;QACtC,UAAU,EAAE;YACR,aAAa,EAAE,SAAS,CACpB,4BAA4B,EAC5B,cAAc,GAAG,oBAAoB,GAAG,sBAAsB,CACjE;YACD,UAAU,EAAE,OAAO;SACtB,CAAA;QACD,UAAU,EAAE;YACR,kBAAkB,EAAE,GAAG,CAAA;YACvB,oBAAoB,EAAE,GAAG,CAAA;YACzB,YAAY,EAAE,GAAG,CAAA;SACpB,CAAA;KACJ;IACD;QACI,MAAM,EAAE,0BAA0B,CAAA;QAClC,UAAU,EAAE,EAAE,CAAA;QACd,UAAU,EAAE,OAAO,EAAE,CAAA;KACxB;IACD;QACI,MAAM,EAAE,aAAa,CAAA;QACrB,UAAU,EAAE,EAAE,CAAA;QACd,UAAU,EAAE,GAAG,CAAA;KAClB;IACD;QACI,MAAM,EAAE,4BAA4B,CAAA;QACpC,UAAU,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;QACxB,UAAU,EAAE;YACR,aAAa,EAAE,4BAA4B,CAAA;YAC3C,UAAU,EAAE,OAAO,CAAA;YACnB,eAAe,EAAE,IAAI,CAAA;YACrB,SAAS,EAAE,IAAI,CAAA;YACf,WAAW,EAAE,GAAG,CAAA;SACnB,CAAA;KACJ;IACD;QACI,MAAM,EAAE,6BAA6B,CAAA;QACrC,UAAU,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;QACxB,UAAU,EAAE,mCAAmC,CAAA;KAClD;CACJ,CAAA;AAED,KAAK,mCAAmC,GAAG;IACvC,UAAU,EAAE,IAAI,CAAA;IAChB,MAAM,EAAE,OAAO,CAAA;IACf,KAAK,EAAE,GAAG,CAAA;IACV,aAAa,EAAE,GAAG,CAAA;IAClB,aAAa,EAAE,GAAG,CAAA;IAClB,OAAO,EAAE,OAAO,CAAA;IAChB,OAAO,EAAE;QACL,eAAe,EAAE,GAAG,CAAA;QACpB,gBAAgB,EAAE,GAAG,CAAA;QACrB,SAAS,EAAE,IAAI,CAAA;QACf,WAAW,EAAE,GAAG,CAAA;QAChB,IAAI,EAAE,OAAO,CAAA;QACb,EAAE,EAAE,OAAO,GAAG,IAAI,CAAA;QAClB,iBAAiB,EAAE,GAAG,CAAA;QACtB,MAAM,EAAE,KAAK,GAAG,KAAK,CAAA;QACrB,OAAO,EAAE,GAAG,CAAA;QACZ,eAAe,EAAE,OAAO,GAAG,IAAI,CAAA;QAC/B,SAAS,EAAE,GAAG,CAAA;QACd,iBAAiB,EAAE,GAAG,CAAA;KACzB,CAAA;IACD,IAAI,EAAE;QACF,IAAI,EAAE,GAAG,CAAA;QACT,WAAW,EAAE,GAAG,CAAA;QAChB,SAAS,EAAE,IAAI,CAAA;QACf,eAAe,EAAE,IAAI,CAAA;QACrB,QAAQ,EAAE,GAAG,CAAA;QACb,gBAAgB,EAAE,GAAG,CAAA;QACrB,OAAO,EAAE,OAAO,CAAA;QAChB,MAAM,EAAE,GAAG,EAAE,CAAA;KAChB,EAAE,CAAA;CACN,CAAA"}

package/_types/types/index.d.ts

@@ -0,0 +1,3 @@
+import type { UserOperation } from "./userOperation";
+export type { UserOperation };
+//# sourceMappingURL=index.d.ts.map

package/_types/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../types/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAEpD,YAAY,EAAE,aAAa,EAAE,CAAA"}

package/_types/types/pimlico.d.ts

@@ -0,0 +1,50 @@
+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;
+        };
+    }
+];
+export {};
+//# sourceMappingURL=pimlico.d.ts.map

package/_types/types/pimlico.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pimlico.d.ts","sourceRoot":"","sources":["../../types/pimlico.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,MAAM,CAAA;AAC9C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,iBAAiB,CAAA;AAEnE,KAAK,2CAA2C,GAAG;IAC/C,IAAI,EAAE;QACF,YAAY,EAAE,GAAG,CAAA;QACjB,oBAAoB,EAAE,GAAG,CAAA;KAC5B,CAAA;IACD,QAAQ,EAAE;QACN,YAAY,EAAE,GAAG,CAAA;QACjB,oBAAoB,EAAE,GAAG,CAAA;KAC5B,CAAA;IACD,IAAI,EAAE;QACF,YAAY,EAAE,GAAG,CAAA;QACjB,oBAAoB,EAAE,GAAG,CAAA;KAC5B,CAAA;CACJ,CAAA;AAED,MAAM,MAAM,0BAA0B,GAAG;IACrC,MAAM,EAAE,WAAW,GAAG,eAAe,GAAG,WAAW,GAAG,UAAU,GAAG,UAAU,GAAG,UAAU,GAAG,QAAQ,CAAA;IACrG,eAAe,EAAE,IAAI,GAAG,IAAI,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG;IAClC;QACI,MAAM,EAAE,kCAAkC,CAAA;QAC1C,UAAU,EAAE,EAAE,CAAA;QACd,UAAU,EAAE,2CAA2C,CAAA;KAC1D;IACD;QACI,MAAM,EAAE,gCAAgC,CAAA;QACxC,UAAU,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;QACxB,UAAU,EAAE,0BAA0B,CAAA;KACzC;CACJ,CAAA;AAED,MAAM,MAAM,yBAAyB,GAAG;IACpC;QACI,MAAM,EAAE,yBAAyB,CAAA;QACjC,UAAU,EAAE;YACR,aAAa,EAAE,SAAS,CACpB,4BAA4B,EAC5B,cAAc,GAAG,oBAAoB,GAAG,sBAAsB,GAAG,kBAAkB,CACtF;YACD,UAAU,EAAE,OAAO;SACtB,CAAA;QACD,UAAU,EAAE;YACR,gBAAgB,EAAE,GAAG,CAAA;YACrB,kBAAkB,EAAE,GAAG,CAAA;YACvB,oBAAoB,EAAE,GAAG,CAAA;YACzB,YAAY,EAAE,GAAG,CAAA;SACpB,CAAA;KACJ;CACJ,CAAA"}

package/_types/types/userOperation.d.ts

@@ -0,0 +1,30 @@
+import type { Address } from "abitype";
+import type { Hex } from "viem";
+export type TStatus = "success" | "reverted";
+export type UserOperationWithBigIntAsHex = {
+    sender: Address;
+    nonce: Hex;
+    initCode: Hex;
+    callData: Hex;
+    callGasLimit: Hex;
+    verificationGasLimit: Hex;
+    preVerificationGas: Hex;
+    maxFeePerGas: Hex;
+    maxPriorityFeePerGas: Hex;
+    paymasterAndData: Hex;
+    signature: Hex;
+};
+export type UserOperation = {
+    sender: Address;
+    nonce: bigint;
+    initCode: Hex;
+    callData: Hex;
+    callGasLimit: bigint;
+    verificationGasLimit: bigint;
+    preVerificationGas: bigint;
+    maxFeePerGas: bigint;
+    maxPriorityFeePerGas: bigint;
+    paymasterAndData: Hex;
+    signature: Hex;
+};
+//# sourceMappingURL=userOperation.d.ts.map

package/_types/types/userOperation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"userOperation.d.ts","sourceRoot":"","sources":["../../types/userOperation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAA;AACtC,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,MAAM,CAAA;AAE/B,MAAM,MAAM,OAAO,GAAG,SAAS,GAAG,UAAU,CAAA;AAE5C,MAAM,MAAM,4BAA4B,GAAG;IACvC,MAAM,EAAE,OAAO,CAAA;IACf,KAAK,EAAE,GAAG,CAAA;IACV,QAAQ,EAAE,GAAG,CAAA;IACb,QAAQ,EAAE,GAAG,CAAA;IACb,YAAY,EAAE,GAAG,CAAA;IACjB,oBAAoB,EAAE,GAAG,CAAA;IACzB,kBAAkB,EAAE,GAAG,CAAA;IACvB,YAAY,EAAE,GAAG,CAAA;IACjB,oBAAoB,EAAE,GAAG,CAAA;IACzB,gBAAgB,EAAE,GAAG,CAAA;IACrB,SAAS,EAAE,GAAG,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IACxB,MAAM,EAAE,OAAO,CAAA;IACf,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,GAAG,CAAA;IACb,QAAQ,EAAE,GAAG,CAAA;IACb,YAAY,EAAE,MAAM,CAAA;IACpB,oBAAoB,EAAE,MAAM,CAAA;IAC5B,kBAAkB,EAAE,MAAM,CAAA;IAC1B,YAAY,EAAE,MAAM,CAAA;IACpB,oBAAoB,EAAE,MAAM,CAAA;IAC5B,gBAAgB,EAAE,GAAG,CAAA;IACrB,SAAS,EAAE,GAAG,CAAA;CACjB,CAAA"}