permissionless 0.0.26 → 0.0.27

package/actions/smartAccount/writeContract.ts

@@ -5,9 +5,9 @@ import {
     type ContractFunctionArgs,
     type ContractFunctionName,
     type EncodeFunctionDataParameters,
+    type Hash,
     type Transport,
     type WriteContractParameters,
-    type WriteContractReturnType,
     encodeFunctionData
 } from "viem"
 import { type SmartAccount } from "../../accounts/types.js"
@@ -33,7 +33,7 @@ import {
  *
  * @param client - Client to use
  * @param parameters - {@link WriteContractParameters}
- * @returns A [Transaction Hash](https://viem.sh/docs/glossary/terms.html#hash). {@link WriteContractReturnType}
+ * @returns A [Transaction Hash](https://viem.sh/docs/glossary/terms.html#hash).
  *
  * @example
  * import { createWalletClient, custom, parseAbi } from 'viem'
@@ -124,7 +124,7 @@ export async function writeContract<
         TArgs,
         TChainOverride
     >
-): Promise<WriteContractReturnType> {
+): Promise<Hash> {
     const data = encodeFunctionData<TAbi, TFunctionName>({
         abi,
         args,

package/actions/smartAccount.ts

@@ -17,7 +17,6 @@ import {
 
 import {
     type SendUserOperationParameters,
-    type SendUserOperationReturnType,
     sendUserOperation
 } from "./smartAccount/sendUserOperation.js"
 
@@ -44,7 +43,6 @@ export {
     sendTransaction,
     sendUserOperation,
     type SendUserOperationParameters,
-    type SendUserOperationReturnType,
     signMessage,
     signTypedData,
     type SendTransactionWithPaymasterParameters,

package/clients/createSmartAccountClient.ts

@@ -2,7 +2,6 @@ import type {
     Chain,
     Client,
     ClientConfig,
-    ParseAccount,
     Transport,
     WalletClientConfig
 } from "viem"
@@ -38,20 +37,15 @@ export type SmartAccountClient<
 export type SmartAccountClientConfig<
     transport extends Transport = Transport,
     chain extends Chain | undefined = Chain | undefined,
-    TAccount extends SmartAccount | undefined = SmartAccount | undefined
+    account extends SmartAccount | undefined = SmartAccount | undefined
 > = Prettify<
     Pick<
-        ClientConfig<transport, chain, TAccount>,
-        | "account"
-        | "cacheTime"
-        | "chain"
-        | "key"
-        | "name"
-        | "pollingInterval"
-        | "transport"
-    >
-> &
-    SponsorUserOperationMiddleware
+        ClientConfig<transport, chain, account>,
+        "cacheTime" | "chain" | "key" | "name" | "pollingInterval" | "transport"
+    > & {
+        account?: account
+    } & SponsorUserOperationMiddleware
+>
 
 /**
  * Creates a EIP-4337 compliant Bundler Client with a given [Transport](https://viem.sh/docs/clients/intro.html) configured for a [Chain](https://viem.sh/docs/clients/chains.html).
@@ -75,11 +69,11 @@ export type SmartAccountClientConfig<
 
 export function createSmartAccountClient<
     TTransport extends Transport,
-    TChain extends Chain | undefined = Chain | undefined,
-    TSmartAccount extends SmartAccount | undefined = SmartAccount | undefined
+    TChain extends Chain | undefined = undefined,
+    TSmartAccount extends SmartAccount | undefined = undefined
 >(
     parameters: SmartAccountClientConfig<TTransport, TChain, TSmartAccount>
-): SmartAccountClient<TTransport, TChain, ParseAccount<TSmartAccount>>
+): SmartAccountClient<TTransport, TChain, TSmartAccount>
 
 export function createSmartAccountClient(
     parameters: SmartAccountClientConfig

package/clients/decorators/bundler.ts

@@ -25,6 +25,7 @@ import {
     type WaitForUserOperationReceiptParameters,
     waitForUserOperationReceipt
 } from "../../actions/bundler/waitForUserOperationReceipt.js"
+import type { Prettify } from "../../types/index.js"
 import type { BundlerClient } from "../createBundlerClient.js"
 
 export type BundlerActions = {
@@ -53,7 +54,9 @@ export type BundlerActions = {
      *
      * // Return '0xe9fad2cd67f9ca1d0b7a6513b2a42066784c8df938518da2b51bb8cc9a89ea34'
      */
-    sendUserOperation: (args: SendUserOperationParameters) => Promise<Hash>
+    sendUserOperation: (
+        args: Prettify<SendUserOperationParameters>
+    ) => Promise<Hash>
     /**
      *
      * Estimates preVerificationGas, verificationGasLimit and callGasLimit for user operation
@@ -80,8 +83,8 @@ export type BundlerActions = {
      * // Return {preVerificationGas: 43492n, verificationGasLimit: 59436n, callGasLimit: 9000n}
      */
     estimateUserOperationGas: (
-        args: EstimateUserOperationGasParameters
-    ) => Promise<EstimateUserOperationGasReturnType>
+        args: Prettify<EstimateUserOperationGasParameters>
+    ) => Promise<Prettify<EstimateUserOperationGasReturnType>>
     /**
      *
      * Returns the supported entrypoints by the bundler service
@@ -147,8 +150,8 @@ export type BundlerActions = {
      *
      */
     getUserOperationByHash: (
-        args: GetUserOperationByHashParameters
-    ) => Promise<GetUserOperationByHashReturnType>
+        args: Prettify<GetUserOperationByHashParameters>
+    ) => Promise<Prettify<GetUserOperationByHashReturnType> | null>
     /**
      *
      * Returns the user operation receipt from userOpHash
@@ -171,8 +174,8 @@ export type BundlerActions = {
      *
      */
     getUserOperationReceipt: (
-        args: GetUserOperationReceiptParameters
-    ) => Promise<GetUserOperationReceiptReturnType | null>
+        args: Prettify<GetUserOperationReceiptParameters>
+    ) => Promise<Prettify<GetUserOperationReceiptReturnType> | null>
 
     /**
      * Waits for the User Operation to be included on a [Block](https://viem.sh/docs/glossary/terms.html#block) (one confirmation), and then returns the [User Operation Receipt](https://docs.pimlico.io/permissionless/reference/bundler-actions/getUserOperationReceipt).
@@ -196,8 +199,8 @@ export type BundlerActions = {
      * })
      */
     waitForUserOperationReceipt: (
-        args: WaitForUserOperationReceiptParameters
-    ) => Promise<GetUserOperationReceiptReturnType>
+        args: Prettify<WaitForUserOperationReceiptParameters>
+    ) => Promise<Prettify<GetUserOperationReceiptReturnType>>
 }
 
 const bundlerActions = (client: Client): BundlerActions => ({

package/clients/decorators/pimlico.ts

@@ -1,7 +1,7 @@
 import type { Client, Hash } from "viem"
 import {
+    type ValidateSponsorshipPolicies,
     type ValidateSponsorshipPoliciesParameters,
-    type ValidateSponsorshipPoliciesReturnType,
     validateSponsorshipPolicies
 } from "../../actions/pimlico.js"
 import {
@@ -18,6 +18,7 @@ import {
     type SponsorUserOperationReturnType,
     sponsorUserOperation
 } from "../../actions/pimlico/sponsorUserOperation.js"
+import type { Prettify } from "../../types/index.js"
 import type {
     PimlicoBundlerClient,
     PimlicoPaymasterClient
@@ -43,7 +44,9 @@ export type PimlicoBundlerActions = {
      *
      * await bundlerClient.getUserOperationGasPrice()
      */
-    getUserOperationGasPrice: () => Promise<GetUserOperationGasPriceReturnType>
+    getUserOperationGasPrice: () => Promise<
+        Prettify<GetUserOperationGasPriceReturnType>
+    >
     /**
      * Returns the status of the userOperation that is pending in the mempool.
      *
@@ -64,8 +67,8 @@ export type PimlicoBundlerActions = {
      * await bundlerClient.getUserOperationStatus({ hash: userOpHash })
      */
     getUserOperationStatus: (
-        args: GetUserOperationStatusParameters
-    ) => Promise<GetUserOperationStatusReturnType>
+        args: Prettify<GetUserOperationStatusParameters>
+    ) => Promise<Prettify<GetUserOperationStatusReturnType>>
 }
 
 export const pimlicoBundlerActions = (
@@ -102,12 +105,12 @@ export type PimlicoPaymasterClientActions = {
      *
      */
     sponsorUserOperation: (
-        args: PimlicoSponsorUserOperationParameters
-    ) => Promise<SponsorUserOperationReturnType>
+        args: Prettify<PimlicoSponsorUserOperationParameters>
+    ) => Promise<Prettify<SponsorUserOperationReturnType>>
 
     validateSponsorshipPolicies: (
-        args: ValidateSponsorshipPoliciesParameters
-    ) => Promise<ValidateSponsorshipPoliciesReturnType>
+        args: Prettify<ValidateSponsorshipPoliciesParameters>
+    ) => Promise<Prettify<ValidateSponsorshipPolicies>[]>
 }
 
 /**
@@ -115,7 +118,7 @@ export type PimlicoPaymasterClientActions = {
  * - Docs: https://docs.pimlico.io/permissionless/reference/pimlico-paymaster-actions/ValidateSponsorshipPolicies
  *
  * @param args {@link ValidateSponsorshipPoliciesParameters} UserOperation you want to sponsor & entryPoint.
- * @returns valid sponsorship policies, see {@link ValidateSponsorshipPoliciesReturnType}
+ * @returns valid sponsorship policies, see {@link ValidateSponsorshipPolicies}
  *
  * @example
  * import { createClient } from "viem"

package/clients/decorators/smartAccount.ts

@@ -5,6 +5,7 @@ import type {
     ContractFunctionArgs,
     ContractFunctionName,
     DeployContractParameters,
+    Hash,
     SendTransactionParameters,
     Transport,
     TypedData,
@@ -30,7 +31,6 @@ import {
 } from "../../actions/smartAccount/sendTransaction.js"
 import {
     type SendUserOperationParameters,
-    type SendUserOperationReturnType,
     sendUserOperation
 } from "../../actions/smartAccount/sendUserOperation.js"
 import { signMessage } from "../../actions/smartAccount/signMessage.js"
@@ -39,6 +39,7 @@ import {
     type WriteContractWithPaymasterParameters,
     writeContract
 } from "../../actions/smartAccount/writeContract.js"
+import type { Prettify } from "../../types/index.js"
 
 export type SmartAccountActions<
     TChain extends Chain | undefined = Chain | undefined,
@@ -279,11 +280,13 @@ export type SmartAccountActions<
         const TAbi extends Abi | readonly unknown[],
         TChainOverride extends Chain | undefined = undefined
     >(
-        args: DeployContractParameters<
-            TAbi,
-            TChain,
-            TSmartAccount,
-            TChainOverride
+        args: Prettify<
+            DeployContractParameters<
+                TAbi,
+                TChain,
+                TSmartAccount,
+                TChainOverride
+            >
         >
     ) => ReturnType<typeof deployContract<TChain, TSmartAccount>>
     /**
@@ -366,19 +369,23 @@ export type SmartAccountActions<
         >
     >
     prepareUserOperationRequest: <TTransport extends Transport>(
-        args: Parameters<
-            typeof prepareUserOperationRequest<
-                TTransport,
-                TChain,
-                TSmartAccount
-            >
-        >[1]
-    ) => Promise<PrepareUserOperationRequestReturnType>
+        args: Prettify<
+            Parameters<
+                typeof prepareUserOperationRequest<
+                    TTransport,
+                    TChain,
+                    TSmartAccount
+                >
+            >[1]
+        >
+    ) => Promise<Prettify<PrepareUserOperationRequestReturnType>>
     sendUserOperation: <TTransport extends Transport>(
-        args: Parameters<
-            typeof sendUserOperation<TTransport, TChain, TSmartAccount>
-        >[1]
-    ) => Promise<SendUserOperationReturnType>
+        args: Prettify<
+            Parameters<
+                typeof sendUserOperation<TTransport, TChain, TSmartAccount>
+            >[1]
+        >
+    ) => Promise<Hash>
     /**
      * Creates, signs, and sends a new transaction to the network.
      * This function also allows you to sponsor this transaction if sender is a smartAccount
@@ -429,13 +436,14 @@ export type SmartAccountActions<
      * }])
      */
     sendTransactions: (
-        args: SendTransactionsWithPaymasterParameters<TSmartAccount>
+        args: Prettify<SendTransactionsWithPaymasterParameters<TSmartAccount>>
     ) => ReturnType<typeof sendTransactions<TChain, TSmartAccount>>
 }
 
-export const smartAccountActions =
-    ({ sponsorUserOperation }: SponsorUserOperationMiddleware) =>
-    <
+export function smartAccountActions({
+    sponsorUserOperation
+}: SponsorUserOperationMiddleware) {
+    return <
         TTransport extends Transport,
         TChain extends Chain | undefined = Chain | undefined,
         TSmartAccount extends SmartAccount | undefined =
@@ -458,17 +466,17 @@ export const smartAccountActions =
             sendTransaction(client, {
                 ...args,
                 sponsorUserOperation
-            } as SendTransactionWithPaymasterParameters),
+            } as SendTransactionWithPaymasterParameters<TChain, TSmartAccount>),
         sendTransactions: (args) =>
             sendTransactions(client, {
                 ...args,
                 sponsorUserOperation
-            } as SendTransactionsWithPaymasterParameters),
+            } as SendTransactionsWithPaymasterParameters<TSmartAccount>),
         sendUserOperation: (args) =>
             sendUserOperation(client, {
                 ...args,
                 sponsorUserOperation
-            } as SendUserOperationParameters),
+            } as SendUserOperationParameters<TSmartAccount>),
         signMessage: (args) => signMessage(client, args),
         signTypedData: (args) => signTypedData(client, args),
         writeContract: (args) =>
@@ -477,3 +485,4 @@ export const smartAccountActions =
                 sponsorUserOperation
             } as WriteContractWithPaymasterParameters<TChain, TSmartAccount>)
     })
+}

package/package.json

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