Calls /api/rpc with x-chain header.
{err ? (Error: {err}
) : (All token balances on Ethereum Mainnet. Precise balances with BigInt math. USD prices shown when available.
Called on the server at /api/tokens with your secret{" "} ALCHEMY_API_KEY. Paginates with pageKey.
Use this for raw RPC like eth_getBalance. Keys never leave the server.
| Token | Network | Balance | Price (USD) | Value (USD) | Weight |
|---|---|---|---|---|---|
|
{p.logo ? (
// eslint-disable-next-line @next/next/no-img-element
{p.symbol}
{p.name || ""}
|
{p.network} | {balanceDisplay} | {p.priceUsd != null ? usd(p.priceUsd) : "—"} | {p.valueUsd != null ? usd(p.valueUsd) : "—"} | {weight.toFixed(1)}% |
Block Number: {{ block_num }}
Gitcoin Akita Balance: {{ bal }}
Akita Rescued: {{ total_burn }}
Gitcoin AKITA Rescue Statistics
Block Number: {{ block_num }}
Gitcoin Akita Balance: {{ bal }}
Akita Rescued: {{ total_burn }}
Connect your wallet and ping your on-chain Hello World program on{" "} devnet using Alchemy RPC.
{!walletAddress ? ( ) : ( <>{status}
)} {txSignature && (Tx Signature:{" "} View on Solana Explorer
)}
Success!
You're logged in as {user.email ?? "anon"}.Please connect your wallet to buy crypto.
Purchase Complete!
Your transaction has been processed successfully.
Error: {error}
Purchase cryptocurrency directly to your wallet using Coinbase Onramp.
Next, navigate to your `page.tsx`, and get the embedded EOA address using [useSigner()](https://www.alchemy.com/docs/wallets/reference/account-kit/react/hooks/useSigner). This new embedded EOA, also known as a signer, will be where users assets live and will sign transactions.
```tsx
const signer = useSigner();
```
Note: in order access your embedded EOA created by Alchemy Signer, you need to have finished authentication. To check your authentication status, you can check [useSignerStatus()](https://www.alchemy.com/docs/wallets/reference/account-kit/react/hooks/useSignerStatus). For example:
```tsx
...
if (signerStatus.isConnected && signer) {
const address = signer.getAddress();
console.log("Connected signer address:", address);
}
...
```
#### Not Working With React?
That’s okay! We have lower level methods we can leverage here to access your signer!
You can follow this [Quickstart](https://www.alchemy.com/docs/wallets/signer/quickstart), to use our '@account-kit/signer' package directly to create and use our wallets.
#### Create a Signer Instance
```tsx
import { AlchemyWebSigner } from "@account-kit/signer";
export const signer = new AlchemyWebSigner({
client: {
connection: {
apiKey: "API_KEY",
},
iframeConfig: {
iframeContainerId: "alchemy-signer-iframe-container",
},
},
});
```
#### Authenticate a User
Next, you’ll need to authenticate your user before you can use the signer. In this example, we use email auth, but we support a number of other auth methods. Check out our [guides](https://www.alchemy.com/docs/wallets/react/react-hooks) to complete authentication.
```tsx
import { signer } from "./signer";
const result = await signer.authenticate({
type: "email",
email: "example@mail.com",
});
...
```
Once you finish authenticating, you can access your signer!
## 3. Send Transactions
Got your signer/embedded EOA address? Now you are ready to send transactions! Alchemy signer supports signing messages as raw hashes. You can use methods including `signMessage`, `signTypedData`, and `signTransaction`.
```tsx
const signedTx = await signer.signTransaction(txRequest);
```
Then you can use a generic wallet client to send transactions! For example, if you are using viem, then you can use the `toViemAccount` method which will allow you to use the signer with a [WalletClient](https://viem.sh/docs/clients/wallet#local-accounts-private-key-mnemonic-etc).
```tsx
import { createWalletClient, http, custom, parseEther } from "viem";
export const walletClient = createWalletClient({
transport: http("https://hyperliquid-mainnet.g.alchemy.com/v2/{API_KEY}"),
chain: Hype,
account: signer.toViemAccount(),
});
const txRequest = await walletClient.prepareTransactionRequest({
account: acct,
to: "0x0000000000000000000000000000000000000000",
value: parseEther("0.0001"),
});
// Sign transaction
const txHash = await walletClient.sendRawTransaction({
serializedTransaction: signedTx,
});
```
## 4. Sponsoring User Operations
Alchemy gas sponsorship lets your users send transactions on HyperEVM without holding the native token for gas. To start, make sure you have a gas policy ID configured in your app dashboard and pass it to your client initialization. Learn more in [Sponsor Gas](https://www.alchemy.com/docs/wallets/transactions/sponsor-gas).
As an example, we will be sponsoring a HyperEVM user operation opening a limit order, using the HyperCore Writer contract. Start by creating some helpers to encode the call.
```ts
// hyperliquidOrder.ts
import {
encodeAbiParameters,
encodeFunctionData,
hexToBytes,
toHex,
} from "viem";
export const CORE_WRITER_ADDRESS =
"0x3333333333333333333333333333333333333333" as const;
export const HYPERLIQUID_CALLDATA = (() => {
const asset = 0; // BTC
const isBuy = true;
const limitPx = 100000000000n; // $100,000
const sz = 100000n; // 0.001 BTC
const reduceOnly = false;
const encodedTif = 2; // GTC
const cloid = 0n;
const payloadHex = encodeAbiParameters(
[
{ type: "uint32" },
{ type: "bool" },
{ type: "uint64" },
{ type: "uint64" },
{ type: "bool" },
{ type: "uint8" },
{ type: "uint128" },
],
[asset, isBuy, limitPx, sz, reduceOnly, encodedTif, cloid],
);
// encoding version (1 byte) + action ID (3 bytes)
const prefix = new Uint8Array([0x01, 0x00, 0x00, 0x01]);
const payload = hexToBytes(payloadHex);
const actionBytes = new Uint8Array(prefix.length + payload.length);
actionBytes.set(prefix, 0);
actionBytes.set(payload, prefix.length);
const coreWriterAbi = [
{
type: "function",
name: "sendRawAction",
stateMutability: "nonpayable",
inputs: [{ name: "data", type: "bytes", internalType: "bytes" }],
outputs: [],
},
] as const;
return encodeFunctionData({
abi: coreWriterAbi,
functionName: "sendRawAction",
args: [toHex(actionBytes)],
});
})();
```
### Using React
If you are working in React, you can use the [useSendUserOperation](https://www.alchemy.com/docs/wallets/reference/account-kit/react/hooks/useSendUserOperation) hook. Make sure you have set up your config from step 1.
```tsx
import React from "react";
import {
useSendUserOperation,
useSmartAccountClient,
} from "@account-kit/react";
import { CORE_WRITER_ADDRESS, HYPERLIQUID_CALLDATA } from "./hyperliquidOrder";
function ComponentWithSendUserOperation() {
const { client } = useSmartAccountClient({});
const { sendUserOperation, isSendingUserOperation } = useSendUserOperation({
client,
waitForTxn: true,
onSuccess: ({ hash, request }) => {
// [optional] handle success
},
onError: (error) => {
// [optional] handle error
},
});
return (
Current chain: {chain.name}
{inputError}
)}Tip: For human-readable amounts and prices, join with token metadata and a prices source later.
When a user sends a transaction, Smart Wallets handle every step. In this section, you’ll learn how to execute steps 2–5 to enable capabilities (ex: gas sponsorship) for your users:
1. Authenticate: User verifies their identity and accesses your app (see [Authentication](/docs/wallets/authentication/overview))
2. Prepare: Prepare a transaction for submission
3. Sign: User signs the transaction
4. Send: Submit the transaction for inclusion onchain
5. Track & display data: Track the status of the transaction and display it to the user
# Everything you need for onchain applications
| Capability | Description |
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
| [Send transactions](/docs/wallets/transactions/send-transactions) | Execute a single transaction |
| [EIP-7702](/docs/wallets/transactions/using-eip-7702) | Upgrade embedded EOA users to smart wallets |
| [Batch transactions](/docs/wallets/transactions/send-batch-transactions) | Execute multiple transactions atomically in a single step (ex: approve & swap) |
| [Sponsor gas](/docs/wallets/transactions/sponsor-gas) | Make gas disappear and say goodbye to “insufficient gas” |
| [Pay gas with any token](/docs/wallets/transactions/pay-gas-with-any-token) | Pay gas with stablecoins or the sell-side token |
| [Swap tokens](/docs/wallets/transactions/swap-tokens) | Swap across networks, seamlessly |
| [Retry transactions](/docs/wallets/transactions/retry-transactions) | Retry transactions stuck in mempool |
| [Send parallel transactions](/docs/wallets/transactions/send-parallel-transactions) | Send multiple transactions in parallel |
| [Sponsor gas on Solana](/docs/wallets/transactions/solana/sponsor-gas) | Sponsor fees & rent and say goodbye to “insufficient fees" |
| [Track status](/docs/wallets/transactions/send-transactions) | Track the status of the transaction |
# SDK vs. APIs
Use the SDK if you’re building with React, React Native, or other JavaScript frameworks. It provides ready-to-use hooks and utilities. Use the APIs directly if you’re building in other environments (ex: python, flutter) or want lower-level control.
------
---
title: Send transactions
description: Execute a single transaction
slug: wallets/transactions/send-transactions
---
This guide will teach you how to send a single EVM transaction. Smart Wallets make it easy!
The client defaults to using [EIP-7702](/docs/wallets/transactions/using-eip-7702), so your EOA will be delegated to a smart account to enable gas sponsorship, batching, and more. The SDK handles delegation automatically on the first transaction.
## Prerequisites
* API key from your [dashboard](https://dashboard.alchemy.com/apps)
* A funded Smart Wallet to cover gas fees ([or a gas manager policy to sponsor gas](/docs/wallets/transactions/sponsor-gas))
## Implementation
## Key features
Click on any step to expand it and inspect the full request and response payloads.
### Transaction statuses
| Status | Description |
| --- | --- |
| **Confirmed** | Transaction successfully included onchain |
| **Pending** | Transaction submitted and awaiting confirmation |
| **Preconfirmed** | Transaction detected but not yet finalized |
| **Prepared** | Transaction prepared but not yet sent |
| **Sent** | Transaction sent and awaiting status |
| **Cross Chain Pending** | Cross-chain transaction in progress |
| **Prepare Failed** | Transaction failed during preparation (e.g., validation error) |
| **Send Failed** | Transaction failed during submission |
| **Status Failed** | Failed to retrieve transaction status |
| **Offchain Failure** | Transaction failed offchain before reaching the network |
| **Onchain Failure** | Transaction was included onchain but reverted |
| **Partial Failure** | Some calls in the batch succeeded while others failed |
| **Cross Chain Refunded** | Cross-chain transaction was refunded |
| **Unknown** | Transaction status could not be determined |
## Debug errors with AI
When a transaction step fails, the detail panel displays the error message and an **Explain this error** button.
Clicking the button sends the error context to an AI model that analyzes the failure and returns:
* **Error category** — A classification such as Validation Error, Sponsorship Failure, Session Key Error, Signing Error, or Contract Error
* **What happened** — A plain-language description of the root cause
* **How to fix** — Specific steps to resolve the issue
* Click the **Save Changes** button
### Send a One-Time Password (OTP) to a User
To send an OTP to a user's email, use the `authenticate()` function from the `useAuthenticate()` hook with the `type` set to `email` and the `emailMode` set to `otp`.
```tsx twoslash sign-in-with-otp.tsx
import { useAuthenticate } from "@account-kit/react-native";
import React, { useState } from "react";
import { Alert, View, Text, TextInput, Button, Pressable } from "react-native";
function SignInWithOtp() {
const { authenticate } = useAuthenticate();
const [email, setEmail] = useState("");
const handleUserSignInWithOtp = () => {
try {
authenticate({
email,
type: "email",
});
// OTP sent to the user's email. Prompt the user to enter the OTP into your app.
} catch (e) {
Alert.alert("Error sending OTP Code. Check logs for more details.");
console.log("Error seding OTP CODE: ", e);
}
};
return (
* Click the **Save Changes** button
### Send an Email Magic Link to a User
To send an email magic link to a user, you can use the `authenticate()` function from the `useAuthenticate()` hook with the `type` set to `email` and the `emailMode` set to `magicLink`.
```tsx twoslash sign-in-with-magic-link.tsx
import { useAuthenticate } from "@account-kit/react-native";
import React, { useState } from "react";
import { Alert, View, Text, TextInput, Button, Pressable } from "react-native";
function SignInWithOtp() {
const { authenticate } = useAuthenticate();
const [email, setEmail] = useState("");
const handleUserSignInWithMagicLink = () => {
try {
authenticate({
email,
type: "email",
});
// Magic link sent to the user's email. Prompt the user to click the link in their email.
} catch (e) {
Alert.alert("Error sending Magic Link. Check logs for more details.");
console.log("Error sending Magic Link: ", e);
}
};
return (
4. You can either use Auth0's dev keys for testing or add your own credentials. If you want to add your own, click the link that says "How to obtain a Client ID" and follow the directions.
5. Select the attributes and permissions you'll be requesting. It's recommended to at least request the user's email address as it can be useful for merging accounts from different providers later. Note that your users will be prompted for consent to share whatever information you request.
6. Note the "Name" field (e.g., "github") - you'll need this later for the `auth0Connection` parameter
7. Enable the connection for your Auth0 application
8. From your Auth0 dashboard, go to "Applications → Applications" in the sidebar
9. Select your application and note the "Domain", "Client ID", and "Client Secret"
10. Add these to your Smart Wallets dashboard in the embedded accounts auth config
In addition to the "Client ID" and "Client Secret" fields, you must also fill in the "Auth0 Domain" field from the Auth0 dashboard.
### Step 3: Configure Custom Social Providers in UI Components
After adding the components and setting up Auth0, configure the custom social providers in your application config:
```tsx twoslash
import { AlchemyAccountsUIConfig, createConfig } from "@account-kit/react";
import { sepolia, alchemy } from "@account-kit/infra";
const uiConfig: AlchemyAccountsUIConfig = {
auth: {
sections: [
[
// Standard social providers
{ type: "social", authProviderId: "google", mode: "popup" },
// Custom social providers via Auth0
{
type: "social",
authProviderId: "auth0",
// Specify the Auth0 connection to use directly
auth0Connection: "github",
displayName: "GitHub",
// Custom logo URL for the provider
logoUrl:
"https://github.githubassets.com/assets/GitHub-Mark-ea2971cee799.png",
// Optional dark mode logo
logoUrlDark:
"https://github.githubassets.com/assets/GitHub-Mark-Light-ea2971cee799.png",
mode: "popup",
},
{
type: "social",
authProviderId: "auth0",
auth0Connection: "twitter",
displayName: "Twitter",
logoUrl: "https://path-to-twitter-logo.png",
mode: "popup",
},
],
],
},
};
export const config = createConfig(
{
transport: alchemy({ apiKey: "your-api-key" }),
chain: sepolia,
// Required for popup flow
enablePopupOauth: true,
},
uiConfig,
);
```
Auth0 custom providers accept the following configuration:
```ts twoslash
type SocialAuthType = {
type: "social";
// For Auth0 custom providers
authProviderId: "auth0";
// Auth0-specific connection string (e.g., "github", "twitter")
auth0Connection?: string;
// Display name for the provider button
displayName?: string;
// URL for the provider's logo
logoUrl: string;
// URL for the provider's logo in dark mode (optional, `logoUrl` is used for both light & dark mode if not provided)
logoUrlDark?: string;
// Authentication mode (popup or redirect)
mode: "popup" | "redirect";
// Optional: Specifies the requested OAuth scope
scope?: string;
// Optional: Specifies additional claims to be included in the authentication token
claims?: string;
};
```
You can find the full type definition in the [Account Kit source code](https://github.com/alchemyplatform/aa-sdk/blob/main/account-kit/react/src/components/auth/types.ts).
For more details on UI component customization, see the [UI Components](/docs/wallets/react/ui-components) documentation.
## Custom UI
If you need complete control over the user experience, you can implement your own custom UI for custom social providers using Smart Wallets hooks.
### Step 1: Set Up Auth0
Before implementing in your React app, you need to configure Auth0 as described in the [Setting Up Auth0](#setting-up-auth0) section above.
### Step 2: Implement Authentication in Your React App
Use the `useAuthenticate` hook to implement Auth0 authentication:
```tsx twoslash
import { useAuthenticate } from "@account-kit/react";
// Inside your component
const { authenticate } = useAuthenticate();
// Option 1: Generic Auth0 login (shows Auth0 provider selection screen)
const handleAuth0Login = () => {
authenticate(
{
type: "oauth",
authProviderId: "auth0",
mode: "popup", // or "redirect"
},
{
onSuccess: () => {
// Authentication successful!
},
onError: (error) => {
// Handle error
},
},
);
};
// Option 2: Direct provider login (bypasses Auth0 selection screen)
const handleGitHubLogin = () => {
authenticate(
{
type: "oauth",
authProviderId: "auth0",
auth0Connection: "github", // Use the connection name from Auth0
mode: "popup", // or "redirect"
},
{
onSuccess: () => {
// Authentication successful!
},
onError: (error) => {
// Handle error
},
},
);
};
```
Option 1 will take users to an Auth0 login page where they can choose the authentication method they want. Option 2 sends users directly to the specific provider's login (like GitHub) without showing the Auth0 selection screen, which usually provides a better user experience.
The value passed to `auth0Connection` should match the string that appeared in the "Name" field of your auth provider connection in the Auth0 dashboard.
### Step 3: Track Authentication Status
Use the `useSignerStatus` hook to determine if the user is authenticated:
```tsx twoslash
import { useSignerStatus } from "@account-kit/react";
// Inside your component
const { isConnected } = useSignerStatus();
// You can use isConnected to conditionally render UI
```
------
---
title: Bring Your Own Authentication
description: Integrate your existing authentication system with Alchemy Smart Wallets using JWT tokens
slug: wallets/authentication/login-methods/bring-your-own-auth
---
Integrate your existing authentication provider and add smart wallet functionality to your app without changing your users' login experience. We support JWT-based and OIDC-compliant authentication providers.
## Prerequisites
Before implementing JWT authentication, verify that your authentication system meets these requirements:
### 1. OIDC Compliance
Your authentication system must be [**OpenID Connect (OIDC) compliant**](https://auth0.com/docs/authenticate/protocols/openid-connect-protocol#openid-and-jwts) and capable of issuing **JWT tokens**.
### 2. Required Endpoints
#### OpenID Connect Discovery Endpoint
Host a discovery endpoint at: `
## Implementation Guide
Welcome, {user.email}!
Wallet Address: {user.address}
## Need More Control?
If you need complete control over the user experience, you can implement your own custom UI using Smart Wallets hooks. See the [Authentication with React Hooks](/docs/wallets/react/react-hooks) page and the individual authentication method pages for detailed implementations.
------
---
title: Custom theme
description: Customize the theme of your Smart Wallets app
slug: wallets/react/customization/theme
---
UI components are fully customizable so you can match your app's branding.
What you can customize in the pre-built authentication component:
* Overall theme: colors, radius, illustrations, custom css
* Header: text, logo, custom component
* External wallet connectors: featured wallets, specify order, chain filtering (EVM/Solana), WalletConnect, and more via `configForExternalWallets()`. See [EOA connectors](/docs/wallets/react/login-methods/eoa-login) for more details.
, // [!code ++]
},
},
);
```
------
---
title: Tailwind CSS Setup
description: Complete guide to setting up Tailwind CSS with UI components
slug: wallets/react/tailwind-setup
---
To use pre-built UI components for user login Tailwind CSS must be configured in your project. This guide walks you through the complete setup process for both new and existing Tailwind installations.
## Prerequisites
* React 18+
* TypeScript 5+
* Node.js 16+
## Quick Setup (New Tailwind Installation)
If you don't have Tailwind CSS in your project yet, follow these steps:
### 1. Install Dependencies
User address: {user.address}
Account type: {user.type}
{/* "eoa" or "sca" */}Smart contract account address: {address}
{/* Now you can use the account instance for transactions */}After scanning, enter the 6-digit code from your authenticator app to complete setup.
No authenticator apps configured.
) : (Loading...
; if (!authenticated) { return ; } return (Loading signer...
}Loading...
; if (authState !== AuthState.Authenticated) { return ; } return (Loading signer...
}| Property | Type | Default value |
|---|---|---|
| `name` | `string` | `"AccountNotFoundError"` |
| `version` | `string` | `VERSION` |
| Parameter | Type | Description |
|---|---|---|
| `accountType` | `string` | The type of account that requires an owner |
| Property | Type | Default value |
|---|---|---|
| `name` | `string` | `"AccountRequiresOwnerError"` |
| `version` | `string` | `VERSION` |
| Parameter | Type |
|---|---|
| `shortMessage` | `string` |
| `args` | `BaseErrorParameters` |
| Property | Type | Default value |
|---|---|---|
| `name` | `string` | `"AASDKError"` |
| `version` | `string` | `VERSION` |
| Parameter | Type | Description |
|---|---|---|
| `accountType` | `string` | the type of account that does not support batch execution |
| Property | Type | Default value |
|---|---|---|
| `name` | `string` | `"BatchExecutionNotSupportedError"` |
| `version` | `string` | `VERSION` |
| Property | Type | Default value |
|---|---|---|
| `name` | `string` | `"ChainNotFoundError"` |
| `version` | `string` | `VERSION` |
| Parameter | Type | Description |
|---|---|---|
| `accountType` | `string` | the type of account |
| `chain` | [`Chain`](https://viem.sh) | the blockchain chain |
| `version` | keyof [`EntryPointRegistryBase`](../interfaces/EntryPointRegistryBase)\<`unknown`> | the entry point version |
| Property | Type | Default value |
|---|---|---|
| `name` | `string` | `"DefaultFactoryNotDefinedError"` |
| `version` | `string` | `VERSION` |
| Property | Type | Default value |
|---|---|---|
| `name` | `string` | `"EntityIdOverrideError"` |
| `version` | `string` | `VERSION` |
| Parameter | Type | Description |
|---|---|---|
| `chain` | [`Chain`](https://viem.sh) | The blockchain network for which the entry point is being queried |
| `entryPointVersion` | `any` | The version of the entry point for which no default exists |
| Property | Type | Default value |
|---|---|---|
| `name` | `string` | `"EntryPointNotFoundError"` |
| `version` | `string` | `VERSION` |
| Parameter | Type | Description |
|---|---|---|
| `hash` | `` `0x${string}` `` | The hexadecimal value representing the user operation hash. |
| Property | Type | Default value |
|---|---|---|
| `name` | `string` | `"FailedToFindTransactionError"` |
| `version` | `string` | `VERSION` |
| Parameter | Type | Description |
|---|---|---|
| `slot` | `string` | The storage slot that failed to be accessed or retrieved |
| `slotDescriptor` | `string` | A description of the storage slot, for additional context in the error message |
| Property | Type | Default value |
|---|---|---|
| `name` | `string` | `"FailedToGetStorageSlotError"` |
| `version` | `string` | `VERSION` |
| Property | Type | Default value |
|---|---|---|
| `name` | `string` | `"GetCounterFactualAddressError"` |
| `version` | `string` | `VERSION` |
| Parameter | Type | Description |
|---|---|---|
| `expectedClient` | `string` | The expected type of the client. |
| `method` | `string` | The method that was called. |
| `client` | [`Client`](https://viem.sh) | The client instance. |
| Property | Type | Default value |
|---|---|---|
| `name` | `string` | `"IncompatibleClientError"` |
| `version` | `string` | `VERSION` |
| Parameter | Type | Description |
|---|---|---|
| `expected` | `string` | the expected account type |
| `actual` | `string` | the actual account type that was received |
| Property | Type | Default value |
|---|---|---|
| `name` | `string` | `"IncorrectAccountTypeError"` |
| `version` | `string` | `VERSION` |
| Property | Type | Default value |
|---|---|---|
| `name` | `string` | `"InvalidDeferredActionNonce"` |
| `version` | `string` | `VERSION` |
| Parameter | Type | Description |
|---|---|---|
| `entityId` | `number` | the invalid entityId used |
| Property | Type | Default value |
|---|---|---|
| `name` | `string` | `"InvalidEntityIdError"` |
| `version` | `string` | `VERSION` |
| Parameter | Type | Description |
|---|---|---|
| `chain` | [`Chain`](https://viem.sh) | The chain object containing information about the blockchain |
| `entryPointVersion` | `any` | The entry point version that is invalid |
| Property | Type | Default value |
|---|---|---|
| `name` | `string` | `"InvalidEntryPointError"` |
| `version` | `string` | `VERSION` |
| Property | Type | Default value |
|---|---|---|
| `name` | `string` | `"InvalidModularAccountV2Mode"` |
| `version` | `string` | `VERSION` |
| Parameter | Type | Description |
|---|---|---|
| `nonceKey` | `bigint` | the invalid nonceKey used |
| Property | Type | Default value |
|---|---|---|
| `name` | `string` | `"InvalidNonceKeyError"` |
| `version` | `string` | `VERSION` |
| Parameter | Type | Description |
|---|---|---|
| `rpcUrl?` | `string` | The invalid RPC URL that caused the error |
| Property | Type | Default value |
|---|---|---|
| `name` | `string` | `"InvalidRpcUrlError"` |
| `version` | `string` | `VERSION` |
| Parameter | Type | Description |
|---|---|---|
| `signerType?` | `string` | An optional parameter specifying the signer type. If not provided, a default error message will be used. |
| Property | Type | Default value |
|---|---|---|
| `name` | `string` | `"InvalidSignerTypeError"` |
| `version` | `string` | `VERSION` |
| Parameter | Type | Description |
|---|---|---|
| `uo` | [`UserOperationStruct`](../type-aliases/UserOperationStruct) | the invalid user operation struct |
| Property | Type | Default value | Description |
|---|---|---|---|
| `name` | `string` | `"InvalidUserOperationError"` | **Inherit Doc** |
| `version` | `string` | `VERSION` | ‐ |
| Type Parameter |
|---|
| `T` *extends* | [`HDAccount`](https://viem.sh) | [`PrivateKeyAccount`](https://viem.sh) | [`LocalAccount`](https://viem.sh) |
| Parameter | Type | Description |
|---|---|---|
| `inner` | `T` | The inner parameter containing the necessary data |
| Parameter | Type | Description |
|---|---|---|
| `this` | `LocalAccountSigner`\<\{ }> | ‐ |
| `unsignedAuthorization` | [`AuthorizationRequest`](../type-aliases/AuthorizationRequest)\<`number`> | The unsigned authorization to be signed. |
| Type Parameter | Default type |
|---|---|
| `TTypedData` *extends* | \{ \[`key`: `string`]: readonly [`TypedDataParameter`](https://abitype.dev)\[]; \[`key`: `` `string[${string}]` ``]: `undefined`; \[`key`: `` `function[${string}]` ``]: `undefined`; \[`key`: `` `address[${string}]` ``]: `undefined`; \[`key`: `` `bool[${string}]` ``]: `undefined`; \[`key`: `` `bytes[${string}]` ``]: `undefined`; \[`key`: `` `bytes1[${string}]` ``]: `undefined`; \[`key`: `` `bytes2[${string}]` ``]: `undefined`; \[`key`: `` `bytes3[${string}]` ``]: `undefined`; \[`key`: `` `bytes4[${string}]` ``]: `undefined`; \[`key`: `` `bytes5[${string}]` ``]: `undefined`; \[`key`: `` `bytes6[${string}]` ``]: `undefined`; \[`key`: `` `bytes7[${string}]` ``]: `undefined`; \[`key`: `` `bytes8[${string}]` ``]: `undefined`; \[`key`: `` `bytes9[${string}]` ``]: `undefined`; \[`key`: `` `bytes10[${string}]` ``]: `undefined`; \[`key`: `` `bytes11[${string}]` ``]: `undefined`; \[`key`: `` `bytes12[${string}]` ``]: `undefined`; \[`key`: `` `bytes13[${string}]` ``]: `undefined`; \[`key`: `` `bytes14[${string}]` ``]: `undefined`; \[`key`: `` `bytes15[${string}]` ``]: `undefined`; \[`key`: `` `bytes16[${string}]` ``]: `undefined`; \[`key`: `` `bytes17[${string}]` ``]: `undefined`; \[`key`: `` `bytes18[${string}]` ``]: `undefined`; \[`key`: `` `bytes19[${string}]` ``]: `undefined`; \[`key`: `` `bytes20[${string}]` ``]: `undefined`; \[`key`: `` `bytes21[${string}]` ``]: `undefined`; \[`key`: `` `bytes22[${string}]` ``]: `undefined`; \[`key`: `` `bytes23[${string}]` ``]: `undefined`; \[`key`: `` `bytes24[${string}]` ``]: `undefined`; \[`key`: `` `bytes25[${string}]` ``]: `undefined`; \[`key`: `` `bytes26[${string}]` ``]: `undefined`; \[`key`: `` `bytes27[${string}]` ``]: `undefined`; \[`key`: `` `bytes28[${string}]` ``]: `undefined`; \[`key`: `` `bytes29[${string}]` ``]: `undefined`; \[`key`: `` `bytes30[${string}]` ``]: `undefined`; \[`key`: `` `bytes31[${string}]` ``]: `undefined`; \[`key`: `` `bytes32[${string}]` ``]: `undefined`; \[`key`: `` `int[${string}]` ``]: `undefined`; \[`key`: `` `int8[${string}]` ``]: `undefined`; \[`key`: `` `int16[${string}]` ``]: `undefined`; \[`key`: `` `int24[${string}]` ``]: `undefined`; \[`key`: `` `int32[${string}]` ``]: `undefined`; \[`key`: `` `int40[${string}]` ``]: `undefined`; \[`key`: `` `int48[${string}]` ``]: `undefined`; \[`key`: `` `int56[${string}]` ``]: `undefined`; \[`key`: `` `int64[${string}]` ``]: `undefined`; \[`key`: `` `int72[${string}]` ``]: `undefined`; \[`key`: `` `int80[${string}]` ``]: `undefined`; \[`key`: `` `int88[${string}]` ``]: `undefined`; \[`key`: `` `int96[${string}]` ``]: `undefined`; \[`key`: `` `int104[${string}]` ``]: `undefined`; \[`key`: `` `int112[${string}]` ``]: `undefined`; \[`key`: `` `int120[${string}]` ``]: `undefined`; \[`key`: `` `int128[${string}]` ``]: `undefined`; \[`key`: `` `int136[${string}]` ``]: `undefined`; \[`key`: `` `int144[${string}]` ``]: `undefined`; \[`key`: `` `int152[${string}]` ``]: `undefined`; \[`key`: `` `int160[${string}]` ``]: `undefined`; \[`key`: `` `int168[${string}]` ``]: `undefined`; \[`key`: `` `int176[${string}]` ``]: `undefined`; \[`key`: `` `int184[${string}]` ``]: `undefined`; \[`key`: `` `int192[${string}]` ``]: `undefined`; \[`key`: `` `int200[${string}]` ``]: `undefined`; \[`key`: `` `int208[${string}]` ``]: `undefined`; \[`key`: `` `int216[${string}]` ``]: `undefined`; \[`key`: `` `int224[${string}]` ``]: `undefined`; \[`key`: `` `int232[${string}]` ``]: `undefined`; \[`key`: `` `int240[${string}]` ``]: `undefined`; \[`key`: `` `int248[${string}]` ``]: `undefined`; \[`key`: `` `int256[${string}]` ``]: `undefined`; \[`key`: `` `uint[${string}]` ``]: `undefined`; \[`key`: `` `uint8[${string}]` ``]: `undefined`; \[`key`: `` `uint16[${string}]` ``]: `undefined`; \[`key`: `` `uint24[${string}]` ``]: `undefined`; \[`key`: `` `uint32[${string}]` ``]: `undefined`; \[`key`: `` `uint40[${string}]` ``]: `undefined`; \[`key`: `` `uint48[${string}]` ``]: `undefined`; \[`key`: `` `uint56[${string}]` ``]: `undefined`; \[`key`: `` `uint64[${string}]` ``]: `undefined`; \[`key`: `` `uint72[${string}]` ``]: `undefined`; \[`key`: `` `uint80[${string}]` ``]: `undefined`; \[`key`: `` `uint88[${string}]` ``]: `undefined`; \[`key`: `` `uint96[${string}]` ``]: `undefined`; \[`key`: `` `uint104[${string}]` ``]: `undefined`; \[`key`: `` `uint112[${string}]` ``]: `undefined`; \[`key`: `` `uint120[${string}]` ``]: `undefined`; \[`key`: `` `uint128[${string}]` ``]: `undefined`; \[`key`: `` `uint136[${string}]` ``]: `undefined`; \[`key`: `` `uint144[${string}]` ``]: `undefined`; \[`key`: `` `uint152[${string}]` ``]: `undefined`; \[`key`: `` `uint160[${string}]` ``]: `undefined`; \[`key`: `` `uint168[${string}]` ``]: `undefined`; \[`key`: `` `uint176[${string}]` ``]: `undefined`; \[`key`: `` `uint184[${string}]` ``]: `undefined`; \[`key`: `` `uint192[${string}]` ``]: `undefined`; \[`key`: `` `uint200[${string}]` ``]: `undefined`; \[`key`: `` `uint208[${string}]` ``]: `undefined`; \[`key`: `` `uint216[${string}]` ``]: `undefined`; \[`key`: `` `uint224[${string}]` ``]: `undefined`; \[`key`: `` `uint232[${string}]` ``]: `undefined`; \[`key`: `` `uint240[${string}]` ``]: `undefined`; \[`key`: `` `uint248[${string}]` ``]: `undefined`; \[`key`: `` `uint256[${string}]` ``]: `undefined`; `string?`: `undefined`; `address?`: `undefined`; `bool?`: `undefined`; `bytes?`: `undefined`; `bytes1?`: `undefined`; `bytes2?`: `undefined`; `bytes3?`: `undefined`; `bytes4?`: `undefined`; `bytes5?`: `undefined`; `bytes6?`: `undefined`; `bytes7?`: `undefined`; `bytes8?`: `undefined`; `bytes9?`: `undefined`; `bytes10?`: `undefined`; `bytes11?`: `undefined`; `bytes12?`: `undefined`; `bytes13?`: `undefined`; `bytes14?`: `undefined`; `bytes15?`: `undefined`; `bytes16?`: `undefined`; `bytes17?`: `undefined`; `bytes18?`: `undefined`; `bytes19?`: `undefined`; `bytes20?`: `undefined`; `bytes21?`: `undefined`; `bytes22?`: `undefined`; `bytes23?`: `undefined`; `bytes24?`: `undefined`; `bytes25?`: `undefined`; `bytes26?`: `undefined`; `bytes27?`: `undefined`; `bytes28?`: `undefined`; `bytes29?`: `undefined`; `bytes30?`: `undefined`; `bytes31?`: `undefined`; `bytes32?`: `undefined`; `int8?`: `undefined`; `int16?`: `undefined`; `int24?`: `undefined`; `int32?`: `undefined`; `int40?`: `undefined`; `int48?`: `undefined`; `int56?`: `undefined`; `int64?`: `undefined`; `int72?`: `undefined`; `int80?`: `undefined`; `int88?`: `undefined`; `int96?`: `undefined`; `int104?`: `undefined`; `int112?`: `undefined`; `int120?`: `undefined`; `int128?`: `undefined`; `int136?`: `undefined`; `int144?`: `undefined`; `int152?`: `undefined`; `int160?`: `undefined`; `int168?`: `undefined`; `int176?`: `undefined`; `int184?`: `undefined`; `int192?`: `undefined`; `int200?`: `undefined`; `int208?`: `undefined`; `int216?`: `undefined`; `int224?`: `undefined`; `int232?`: `undefined`; `int240?`: `undefined`; `int248?`: `undefined`; `int256?`: `undefined`; `uint8?`: `undefined`; `uint16?`: `undefined`; `uint24?`: `undefined`; `uint32?`: `undefined`; `uint40?`: `undefined`; `uint48?`: `undefined`; `uint56?`: `undefined`; `uint64?`: `undefined`; `uint72?`: `undefined`; `uint80?`: `undefined`; `uint88?`: `undefined`; `uint96?`: `undefined`; `uint104?`: `undefined`; `uint112?`: `undefined`; `uint120?`: `undefined`; `uint128?`: `undefined`; `uint136?`: `undefined`; `uint144?`: `undefined`; `uint152?`: `undefined`; `uint160?`: `undefined`; `uint168?`: `undefined`; `uint176?`: `undefined`; `uint184?`: `undefined`; `uint192?`: `undefined`; `uint200?`: `undefined`; `uint208?`: `undefined`; `uint216?`: `undefined`; `uint224?`: `undefined`; `uint232?`: `undefined`; `uint240?`: `undefined`; `uint248?`: `undefined`; `uint256?`: `undefined`; } | `Record`\<`string`, `unknown`> | ‐ |
| `TPrimaryType` *extends* `string` | `number` | `symbol` | keyof `TTypedData` |
| Parameter | Type | Description |
|---|---|---|
| `params` | [`TypedDataDefinition`](https://viem.sh)\<`TTypedData`, `TPrimaryType`> | The parameters defining the typed data and primary type |
| Parameter | Type | Description |
|---|---|---|
| `key` | `string` | The mnemonic key to derive the account from. |
| `opts?` | [`HDOptions`](https://viem.sh) | Optional HD options for deriving the account. |
| Parameter | Type | Description |
|---|---|---|
| `key` | `` `0x${string}` `` | The private key in hexadecimal format |
| Property | Type | Default value |
|---|---|---|
| `logFilter?` | `string` | `undefined` |
| `logLevel` | [`LogLevel`](../enumerations/LogLevel) | `LogLevel.INFO` |
| Parameter | Type | Description |
|---|---|---|
| `msg` | `string` | The message to log |
| ...`args` | `any`\[] | Additional arguments to pass to the console.debug method |
| Parameter | Type | Description |
|---|---|---|
| `msg` | `string` | The primary error message to be logged |
| ...`args` | `any`\[] | Additional arguments to be logged along with the error message |
| Parameter | Type | Description |
|---|---|---|
| `msg` | `string` | the message to log |
| ...`args` | `any`\[] | additional arguments to log alongside the message |
| Parameter | Type | Description |
|---|---|---|
| `pattern` | `string` | The pattern to set as the log filter |
| Parameter | Type | Description |
|---|---|---|
| `logLevel` | [`LogLevel`](../enumerations/LogLevel) | The desired log level |
| Parameter | Type | Description |
|---|---|---|
| `msg` | `string` | The message to log |
| ...`args` | `any`\[] | Additional arguments to be logged |
| Parameter | Type | Description |
|---|---|---|
| `msg` | `string` | The message to log as a warning |
| ...`args` | `any`\[] | Additional parameters to log along with the message |
| Property | Type | Default value |
|---|---|---|
| `name` | `string` | `"NotAModularAccountV2Error"` |
| `version` | `string` | `VERSION` |
| Property | Type | Default value |
|---|---|---|
| `name` | `string` | `"SignTransactionNotSupported"` |
| `version` | `string` | `VERSION` |
| Property | Type | Default value |
|---|---|---|
| `name` | `string` | `"SmartAccountWithSignerRequiredError"` |
| `version` | `string` | `VERSION` |
| Parameter | Type | Description |
|---|---|---|
| `traceId` | `string` | The unique identifier for the trace |
| `parentId` | `string` | The identifier of the parent trace |
| `traceFlags` | `string` | Flags containing trace-related options |
| `traceState` | `Record`\<`string`, `string`> | The trace state information for additional trace context |
| Property | Type |
|---|---|
| `parentId` | `string` |
| `traceFlags` | `string` |
| `traceId` | `string` |
| `traceState` | `Record`\<`string`, `string`> |
| Name | Type |
|---|---|
| `traceparent` | `` `00-${string}-${string}-${string}` `` |
| `tracestate` | `string` |
| Parameter | Type | Description |
|---|---|---|
| `eventName` | `string` | The key of the new event |
| Parameter | Type | Description |
|---|---|---|
| `headers` | `Record`\<`string`, `string`> | The headers from the http request |
| Property | Type | Default value |
|---|---|---|
| `name` | `string` | `"TransactionMissingToParamError"` |
| `version` | `string` | `VERSION` |
| Parameter | Type | Description |
|---|---|---|
| `accountType` | `string` | The type of account that does not support `UpgradeToAndCall` |
| Property | Type | Default value |
|---|---|---|
| `name` | `string` | `"UpgradeToAndCallNotSupportedError"` |
| `version` | `string` | `VERSION` |
| Parameter | Type | Description |
|---|---|---|
| `accountType` | `string` | The type of account that does not support upgrades |
| Property | Type | Default value |
|---|---|---|
| `name` | `string` | `"UpgradesNotSupported"` |
| `version` | `string` | `VERSION` |
| Parameter | Type | Description |
|---|---|---|
| `request` | [`UserOperationRequest`](../type-aliases/UserOperationRequest) | the user operation request that failed |
| `error` | `Error` | the underlying error that caused the failure |
| Parameter | Type | Description |
|---|---|---|
| `client` | `Object` | The wallet client to interact with |
| `signerType` | `string` | The type of signer; must be a valid signer type, otherwise an error will be thrown |
| Parameter | Type | Description |
|---|---|---|
| `unsignedAuthorization` | `AuthorizationRequest`\<`number`> | the authorization to be signed |
| Type Parameter | Default type |
|---|---|
| `TTypedData` *extends* | \{ \[`key`: `string`]: readonly [`TypedDataParameter`](https://abitype.dev)\[]; \[`key`: `` `string[${string}]` ``]: `undefined`; \[`key`: `` `function[${string}]` ``]: `undefined`; \[`key`: `` `address[${string}]` ``]: `undefined`; \[`key`: `` `bool[${string}]` ``]: `undefined`; \[`key`: `` `bytes[${string}]` ``]: `undefined`; \[`key`: `` `bytes1[${string}]` ``]: `undefined`; \[`key`: `` `bytes2[${string}]` ``]: `undefined`; \[`key`: `` `bytes3[${string}]` ``]: `undefined`; \[`key`: `` `bytes4[${string}]` ``]: `undefined`; \[`key`: `` `bytes5[${string}]` ``]: `undefined`; \[`key`: `` `bytes6[${string}]` ``]: `undefined`; \[`key`: `` `bytes7[${string}]` ``]: `undefined`; \[`key`: `` `bytes8[${string}]` ``]: `undefined`; \[`key`: `` `bytes9[${string}]` ``]: `undefined`; \[`key`: `` `bytes10[${string}]` ``]: `undefined`; \[`key`: `` `bytes11[${string}]` ``]: `undefined`; \[`key`: `` `bytes12[${string}]` ``]: `undefined`; \[`key`: `` `bytes13[${string}]` ``]: `undefined`; \[`key`: `` `bytes14[${string}]` ``]: `undefined`; \[`key`: `` `bytes15[${string}]` ``]: `undefined`; \[`key`: `` `bytes16[${string}]` ``]: `undefined`; \[`key`: `` `bytes17[${string}]` ``]: `undefined`; \[`key`: `` `bytes18[${string}]` ``]: `undefined`; \[`key`: `` `bytes19[${string}]` ``]: `undefined`; \[`key`: `` `bytes20[${string}]` ``]: `undefined`; \[`key`: `` `bytes21[${string}]` ``]: `undefined`; \[`key`: `` `bytes22[${string}]` ``]: `undefined`; \[`key`: `` `bytes23[${string}]` ``]: `undefined`; \[`key`: `` `bytes24[${string}]` ``]: `undefined`; \[`key`: `` `bytes25[${string}]` ``]: `undefined`; \[`key`: `` `bytes26[${string}]` ``]: `undefined`; \[`key`: `` `bytes27[${string}]` ``]: `undefined`; \[`key`: `` `bytes28[${string}]` ``]: `undefined`; \[`key`: `` `bytes29[${string}]` ``]: `undefined`; \[`key`: `` `bytes30[${string}]` ``]: `undefined`; \[`key`: `` `bytes31[${string}]` ``]: `undefined`; \[`key`: `` `bytes32[${string}]` ``]: `undefined`; \[`key`: `` `int[${string}]` ``]: `undefined`; \[`key`: `` `int8[${string}]` ``]: `undefined`; \[`key`: `` `int16[${string}]` ``]: `undefined`; \[`key`: `` `int24[${string}]` ``]: `undefined`; \[`key`: `` `int32[${string}]` ``]: `undefined`; \[`key`: `` `int40[${string}]` ``]: `undefined`; \[`key`: `` `int48[${string}]` ``]: `undefined`; \[`key`: `` `int56[${string}]` ``]: `undefined`; \[`key`: `` `int64[${string}]` ``]: `undefined`; \[`key`: `` `int72[${string}]` ``]: `undefined`; \[`key`: `` `int80[${string}]` ``]: `undefined`; \[`key`: `` `int88[${string}]` ``]: `undefined`; \[`key`: `` `int96[${string}]` ``]: `undefined`; \[`key`: `` `int104[${string}]` ``]: `undefined`; \[`key`: `` `int112[${string}]` ``]: `undefined`; \[`key`: `` `int120[${string}]` ``]: `undefined`; \[`key`: `` `int128[${string}]` ``]: `undefined`; \[`key`: `` `int136[${string}]` ``]: `undefined`; \[`key`: `` `int144[${string}]` ``]: `undefined`; \[`key`: `` `int152[${string}]` ``]: `undefined`; \[`key`: `` `int160[${string}]` ``]: `undefined`; \[`key`: `` `int168[${string}]` ``]: `undefined`; \[`key`: `` `int176[${string}]` ``]: `undefined`; \[`key`: `` `int184[${string}]` ``]: `undefined`; \[`key`: `` `int192[${string}]` ``]: `undefined`; \[`key`: `` `int200[${string}]` ``]: `undefined`; \[`key`: `` `int208[${string}]` ``]: `undefined`; \[`key`: `` `int216[${string}]` ``]: `undefined`; \[`key`: `` `int224[${string}]` ``]: `undefined`; \[`key`: `` `int232[${string}]` ``]: `undefined`; \[`key`: `` `int240[${string}]` ``]: `undefined`; \[`key`: `` `int248[${string}]` ``]: `undefined`; \[`key`: `` `int256[${string}]` ``]: `undefined`; \[`key`: `` `uint[${string}]` ``]: `undefined`; \[`key`: `` `uint8[${string}]` ``]: `undefined`; \[`key`: `` `uint16[${string}]` ``]: `undefined`; \[`key`: `` `uint24[${string}]` ``]: `undefined`; \[`key`: `` `uint32[${string}]` ``]: `undefined`; \[`key`: `` `uint40[${string}]` ``]: `undefined`; \[`key`: `` `uint48[${string}]` ``]: `undefined`; \[`key`: `` `uint56[${string}]` ``]: `undefined`; \[`key`: `` `uint64[${string}]` ``]: `undefined`; \[`key`: `` `uint72[${string}]` ``]: `undefined`; \[`key`: `` `uint80[${string}]` ``]: `undefined`; \[`key`: `` `uint88[${string}]` ``]: `undefined`; \[`key`: `` `uint96[${string}]` ``]: `undefined`; \[`key`: `` `uint104[${string}]` ``]: `undefined`; \[`key`: `` `uint112[${string}]` ``]: `undefined`; \[`key`: `` `uint120[${string}]` ``]: `undefined`; \[`key`: `` `uint128[${string}]` ``]: `undefined`; \[`key`: `` `uint136[${string}]` ``]: `undefined`; \[`key`: `` `uint144[${string}]` ``]: `undefined`; \[`key`: `` `uint152[${string}]` ``]: `undefined`; \[`key`: `` `uint160[${string}]` ``]: `undefined`; \[`key`: `` `uint168[${string}]` ``]: `undefined`; \[`key`: `` `uint176[${string}]` ``]: `undefined`; \[`key`: `` `uint184[${string}]` ``]: `undefined`; \[`key`: `` `uint192[${string}]` ``]: `undefined`; \[`key`: `` `uint200[${string}]` ``]: `undefined`; \[`key`: `` `uint208[${string}]` ``]: `undefined`; \[`key`: `` `uint216[${string}]` ``]: `undefined`; \[`key`: `` `uint224[${string}]` ``]: `undefined`; \[`key`: `` `uint232[${string}]` ``]: `undefined`; \[`key`: `` `uint240[${string}]` ``]: `undefined`; \[`key`: `` `uint248[${string}]` ``]: `undefined`; \[`key`: `` `uint256[${string}]` ``]: `undefined`; `string?`: `undefined`; `address?`: `undefined`; `bool?`: `undefined`; `bytes?`: `undefined`; `bytes1?`: `undefined`; `bytes2?`: `undefined`; `bytes3?`: `undefined`; `bytes4?`: `undefined`; `bytes5?`: `undefined`; `bytes6?`: `undefined`; `bytes7?`: `undefined`; `bytes8?`: `undefined`; `bytes9?`: `undefined`; `bytes10?`: `undefined`; `bytes11?`: `undefined`; `bytes12?`: `undefined`; `bytes13?`: `undefined`; `bytes14?`: `undefined`; `bytes15?`: `undefined`; `bytes16?`: `undefined`; `bytes17?`: `undefined`; `bytes18?`: `undefined`; `bytes19?`: `undefined`; `bytes20?`: `undefined`; `bytes21?`: `undefined`; `bytes22?`: `undefined`; `bytes23?`: `undefined`; `bytes24?`: `undefined`; `bytes25?`: `undefined`; `bytes26?`: `undefined`; `bytes27?`: `undefined`; `bytes28?`: `undefined`; `bytes29?`: `undefined`; `bytes30?`: `undefined`; `bytes31?`: `undefined`; `bytes32?`: `undefined`; `int8?`: `undefined`; `int16?`: `undefined`; `int24?`: `undefined`; `int32?`: `undefined`; `int40?`: `undefined`; `int48?`: `undefined`; `int56?`: `undefined`; `int64?`: `undefined`; `int72?`: `undefined`; `int80?`: `undefined`; `int88?`: `undefined`; `int96?`: `undefined`; `int104?`: `undefined`; `int112?`: `undefined`; `int120?`: `undefined`; `int128?`: `undefined`; `int136?`: `undefined`; `int144?`: `undefined`; `int152?`: `undefined`; `int160?`: `undefined`; `int168?`: `undefined`; `int176?`: `undefined`; `int184?`: `undefined`; `int192?`: `undefined`; `int200?`: `undefined`; `int208?`: `undefined`; `int216?`: `undefined`; `int224?`: `undefined`; `int232?`: `undefined`; `int240?`: `undefined`; `int248?`: `undefined`; `int256?`: `undefined`; `uint8?`: `undefined`; `uint16?`: `undefined`; `uint24?`: `undefined`; `uint32?`: `undefined`; `uint40?`: `undefined`; `uint48?`: `undefined`; `uint56?`: `undefined`; `uint64?`: `undefined`; `uint72?`: `undefined`; `uint80?`: `undefined`; `uint88?`: `undefined`; `uint96?`: `undefined`; `uint104?`: `undefined`; `uint112?`: `undefined`; `uint120?`: `undefined`; `uint128?`: `undefined`; `uint136?`: `undefined`; `uint144?`: `undefined`; `uint152?`: `undefined`; `uint160?`: `undefined`; `uint168?`: `undefined`; `uint176?`: `undefined`; `uint184?`: `undefined`; `uint192?`: `undefined`; `uint200?`: `undefined`; `uint208?`: `undefined`; `uint216?`: `undefined`; `uint224?`: `undefined`; `uint232?`: `undefined`; `uint240?`: `undefined`; `uint248?`: `undefined`; `uint256?`: `undefined`; } | `Record`\<`string`, `unknown`> | ‐ |
| `TPrimaryType` *extends* `string` | `number` | `symbol` | `string` |
| Parameter | Type | Description |
|---|---|---|
| `typedData` | [`TypedDataDefinition`](https://viem.sh)\<`TTypedData`, `TPrimaryType`> | The typed data to be signed |
| Enumeration Member | Value |
|---|---|
| `DEPLOYED` | `"0x2"` |
| `NOT_DEPLOYED` | `"0x1"` |
| `UNDEFINED` | `"0x0"` |
| Enumeration Member | Value |
|---|---|
| `DEBUG` | `4` |
| `ERROR` | `1` |
| `INFO` | `3` |
| `NONE` | `0` |
| `VERBOSE` | `5` |
| `WARN` | `2` |
| Enumeration Member | Value |
|---|---|
| `ROUND_DOWN` | `0` |
| `ROUND_UP` | `1` |
| Parameter | Type | Description |
|---|---|---|
| ...`params` | `any`\[] | values to check |
| Type Parameter |
|---|
| `TValue` *extends* `any` |
| Parameter | Type | Description |
|---|---|---|
| `value` | `TValue` | the current value of the field |
| `feeOption?` | `any` | the override value to apply |
| Type Parameter |
|---|
| `TValue` *extends* `any` |
| Parameter | Type | Description |
|---|---|---|
| `value` | `TValue` | the current value of the field |
| `override?` | `any` | the override value to apply |
| Type Parameter |
|---|
| `TValue` *extends* `any` |
| Parameter | Type | Description |
|---|---|---|
| `value` | `TValue` | the current value of the field |
| `override?` | `any` | the override value to apply |
| `feeOption?` | `any` | the fee option field value to apply |
| Type Parameter |
|---|
| `S` |
| `O` |
| `F` |
| Parameter | Type | Description |
|---|---|---|
| ...`fns` | (`s`, `o?`, `f?`) => `Promise`\<`S`>\[] | functions to pipe |
| Parameter | Type |
|---|---|
| `s` | `S` |
| `o?` | `O` |
| `f?` | `F` |
| Parameter | Type | Description |
|---|---|---|
| `value` | `BigNumberish` | a bigint value to clamp |
| `lower` | `any` | lower bound min max tuple value |
| `upper` | `any` | upper bound min max tuple value |
| Parameter | Type | Description |
|---|---|---|
| ...`args` | `bigint`\[] | a list of bigints to get the max of |
| Parameter | Type | Description |
|---|---|---|
| ...`args` | `bigint`\[] | a list of bigints to get the max of |
| Parameter | Type | Default value | Description |
|---|---|---|---|
| `base` | `BigNumberish` | `undefined` | the number to be multiplied |
| `multiplier` | `Multiplier` | `undefined` | the amount to multiply by |
| `roundingMode` | [`RoundingMode`](../enumerations/RoundingMode) | `RoundingMode.ROUND_UP` | the rounding mode to use when calculating the percent. defaults to ROUND\_UP |
| Type Parameter | Default type |
|---|---|
| `TTransport` *extends* [`Transport`](https://viem.sh) | [`Transport`](https://viem.sh) |
| `TChain` *extends* `undefined` | [`Chain`](https://viem.sh) | `undefined` | [`Chain`](https://viem.sh) |
| `TAccount` *extends* | `undefined` | [`SmartContractAccount`](../type-aliases/SmartContractAccount) | | `undefined` | [`SmartContractAccount`](../type-aliases/SmartContractAccount) |
| `TContext` *extends* `any` | `any` |
| `TEntryPointVersion` *extends* keyof [`EntryPointRegistryBase`](../interfaces/EntryPointRegistryBase)\<`unknown`> | [`GetEntryPointFromAccount`](../type-aliases/GetEntryPointFromAccount)\<`TAccount`> |
| Parameter | Type | Description |
|---|---|---|
| `client_` | [`Client`](https://viem.sh)\<`TTransport`, `TChain`, `TAccount`> | the client instance used to build the user operation |
| `args` | `BuildUserOperationParameters`\<`TAccount`, `TContext`, `TEntryPointVersion`> | the parameters required to build the user operation, including account, overrides, and context |
| Type Parameter | Default type |
|---|---|
| `TChain` *extends* `undefined` | [`Chain`](https://viem.sh) | `undefined` | [`Chain`](https://viem.sh) |
| `TAccount` *extends* | `undefined` | [`SmartContractAccount`](../type-aliases/SmartContractAccount) | | `undefined` | [`SmartContractAccount`](../type-aliases/SmartContractAccount) |
| `TChainOverride` *extends* `undefined` | [`Chain`](https://viem.sh) | `undefined` | [`Chain`](https://viem.sh) |
| `TContext` *extends* | `undefined` | [`UserOperationContext`](../type-aliases/UserOperationContext) | | `undefined` | [`UserOperationContext`](../type-aliases/UserOperationContext) |
| `TEntryPointVersion` *extends* keyof [`EntryPointRegistryBase`](../interfaces/EntryPointRegistryBase)\<`unknown`> | [`GetEntryPointFromAccount`](../type-aliases/GetEntryPointFromAccount)\<`TAccount`> |
| Parameter | Type | Description |
|---|---|---|
| `client_` | [`Client`](https://viem.sh)\<[`Transport`](https://viem.sh), `TChain`, `TAccount`> | the smart account client to use for RPC requests |
| `args` | [`SendTransactionParameters`](https://viem.sh)\<`TChain`, `TAccount`, `TChainOverride`> | the send tx parameters |
| `overrides?` | [`UserOperationOverrides`](../type-aliases/UserOperationOverrides)\<`TEntryPointVersion`> | optional overrides to use for any of the fields |
| `context?` | `TContext` | if the smart account client requires additinoal context for building UOs |
| Type Parameter | Default type |
|---|---|
| `TTransport` *extends* [`Transport`](https://viem.sh) | [`Transport`](https://viem.sh) |
| `TChain` *extends* `undefined` | [`Chain`](https://viem.sh) | `undefined` | [`Chain`](https://viem.sh) |
| `TAccount` *extends* `any` | `any` |
| `TEntryPointVersion` *extends* `GetEntryPointFromAccount`\<`TAccount`> | `GetEntryPointFromAccount`\<`TAccount`> |
| `TContext` *extends* `any` | `any` |
| Parameter | Type | Description |
|---|---|---|
| `client_` | [`Client`](https://viem.sh)\<`TTransport`, `TChain`, `TAccount`> | the smart account client to use to make RPC calls |
| `args` | `BuildTransactionParameters`\<`TAccount`, `TContext`, `TEntryPointVersion`> | an object containing the requests to build as well as, the account if not hoisted, the context, the overrides, and optionally a flag to enable signing of the UO via the underlying middleware |
| Type Parameter | Default type |
|---|---|
| `TEntryPointVersion` *extends* `EntryPointVersion` | `EntryPointVersion` |
| Parameter | Type | Description |
|---|---|---|
| `overrides` | `any` | the user operation overrides to check |
| Type Parameter | Default type |
|---|---|
| `TEntryPointVersion` *extends* `EntryPointVersion` | `EntryPointVersion` |
| Parameter | Type | Description |
|---|---|---|
| `overrides` | `any` | the user operation overrides to check |
| Type Parameter | Default type |
|---|---|
| `TTransport` *extends* [`Transport`](https://viem.sh) | [`Transport`](https://viem.sh) |
| `TChain` *extends* `undefined` | [`Chain`](https://viem.sh) | `undefined` | [`Chain`](https://viem.sh) |
| `TAccount` *extends* | `undefined` | [`SmartContractAccount`](../type-aliases/SmartContractAccount) | | `undefined` | [`SmartContractAccount`](../type-aliases/SmartContractAccount) |
| `TContext` *extends* `any` | `any` |
| Parameter | Type | Description |
|---|---|---|
| `client_` | [`Client`](https://viem.sh)\<`TTransport`, `TChain`, `TAccount`> | the smart account client to use for making RPC calls |
| `args` | `SendUserOperationParameters`\<`TAccount`, `TContext`> | containing the user operation, account, context, and overrides |
| Type Parameter |
|---|
| `X` *extends* `object` |
| Parameter | Type | Description |
|---|---|---|
| `client` | `X` | Clients are somethings like viem, that we are adding breadcrumbs to, and could be owning the transport. Usually a alchemy client. |
| `crumb` | `string` | The crumb to add to the breadcrumb |
| Parameter | Type | Description |
|---|---|---|
| `paymasterAndData` | `Pick`\<`UserOperationRequest`\<`"0.7.0"`>, `"paymaster"` | `"paymasterData"`> | the object containing the picked paymaster and paymasterData fields of entrypoint v0.7 user operation request |
| Type Parameter |
|---|
| `T` |
| Parameter | Type | Description |
|---|---|---|
| `condition` | `Promise`\<`boolean`> | condition to check |
| `value` | () => `Promise`\<`T`> | value to return when condition holds true |
| Parameter | Type | Description |
|---|---|---|
| `chainId` | `number` | the blockchain chain ID that you want to convert to a coin type |
| Parameter | Type | Description |
|---|---|---|
| `coinType` | `number` | The numerical identifier for the coin type |
| Parameter | Type | Description |
|---|---|---|
| `coinType` | `number` | the coin type to be converted to a chain ID |
| Type Parameter |
|---|
| `TTransport` *extends* [`Transport`](https://viem.sh) |
| Parameter | Type | Description |
|---|---|---|
| `args` | `object` & `object` | configuration for the client |
| Type Parameter | Default type |
|---|---|
| `TTransport` *extends* [`Transport`](https://viem.sh) | [`Transport`](https://viem.sh) |
| `TChain` *extends* `undefined` | [`Chain`](https://viem.sh) | `undefined` | [`Chain`](https://viem.sh) |
| `TAccount` *extends* | `undefined` | [`SmartContractAccount`](../type-aliases/SmartContractAccount) | | `undefined` | [`SmartContractAccount`](../type-aliases/SmartContractAccount) |
| `TContext` *extends* | `undefined` | [`UserOperationContext`](../type-aliases/UserOperationContext) | | `undefined` | [`UserOperationContext`](../type-aliases/UserOperationContext) |
| Parameter | Type | Description |
|---|---|---|
| `config` | \{ `account?`: `TAccount`; `addBreadCrumb?`: \<`T`>(`crumb`) => `T`; `customMiddleware?`: [`ClientMiddlewareFn`](../type-aliases/ClientMiddlewareFn)\<`TContext`>; `dummyPaymasterAndData?`: [`ClientMiddlewareFn`](../type-aliases/ClientMiddlewareFn)\<`TContext`>; `feeEstimator?`: [`ClientMiddlewareFn`](../type-aliases/ClientMiddlewareFn)\<`TContext`>; `gasEstimator?`: [`ClientMiddlewareFn`](../type-aliases/ClientMiddlewareFn)\<`TContext`>; `opts?`: `Object`; `paymasterAndData?`: [`ClientMiddlewareFn`](../type-aliases/ClientMiddlewareFn)\<`TContext`>; `signUserOperation?`: [`ClientMiddlewareFn`](../type-aliases/ClientMiddlewareFn)\<`TContext`>; `userOperationSimulator?`: [`ClientMiddlewareFn`](../type-aliases/ClientMiddlewareFn)\<`TContext`>; } | The configuration for creating the smart account client |
| `config.account?` | `TAccount` | ‐ |
| `config.addBreadCrumb?` | \<`T`>(`crumb`) => `T` | A function that adds a breadcrumb to the current context Note, most implementations will override the client with the default alchemy transport and this leads to the fact that a transport could be overwritten and not known until later. |
| `config.customMiddleware?` | [`ClientMiddlewareFn`](../type-aliases/ClientMiddlewareFn)\<`TContext`> | ‐ |
| `config.dummyPaymasterAndData?` | [`ClientMiddlewareFn`](../type-aliases/ClientMiddlewareFn)\<`TContext`> | ‐ |
| `config.feeEstimator?` | [`ClientMiddlewareFn`](../type-aliases/ClientMiddlewareFn)\<`TContext`> | ‐ |
| `config.gasEstimator?` | [`ClientMiddlewareFn`](../type-aliases/ClientMiddlewareFn)\<`TContext`> | ‐ |
| `config.opts?` | `Object` | ‐ |
| `config.paymasterAndData?` | [`ClientMiddlewareFn`](../type-aliases/ClientMiddlewareFn)\<`TContext`> | ‐ |
| `config.signUserOperation?` | [`ClientMiddlewareFn`](../type-aliases/ClientMiddlewareFn)\<`TContext`> | ‐ |
| `config.userOperationSimulator?` | [`ClientMiddlewareFn`](../type-aliases/ClientMiddlewareFn)\<`TContext`> | ‐ |
| Type Parameter | Default type |
|---|---|
| `TTransport` *extends* [`Transport`](https://viem.sh) | [`Transport`](https://viem.sh) |
| `TChain` *extends* `undefined` | [`Chain`](https://viem.sh) | `undefined` | [`Chain`](https://viem.sh) |
| `TAccount` *extends* | `undefined` | [`SmartContractAccount`](../type-aliases/SmartContractAccount) | | `undefined` | [`SmartContractAccount`](../type-aliases/SmartContractAccount) |
| `TClient` *extends* [`BundlerClient`](../type-aliases/BundlerClient)\<`TTransport`> | [`BundlerClient`](../type-aliases/BundlerClient)\<`TTransport`> |
| `TActions` *extends* [`SmartAccountClientActions`](../type-aliases/SmartAccountClientActions)\<`TChain`, `TAccount`, `TContext`> | [`SmartAccountClientActions`](../type-aliases/SmartAccountClientActions)\<`TChain`, `TAccount`, | `undefined` | [`UserOperationContext`](../type-aliases/UserOperationContext)> |
| `TRpcSchema` *extends* \[\{ `Method`: `"eth_sendUserOperation"`; `Parameters`: \[[`UserOperationRequest`](../type-aliases/UserOperationRequest), `` `0x${string}` ``]; `ReturnType`: `` `0x${string}` ``; }, \{ `Method`: `"eth_estimateUserOperationGas"`; `Parameters`: \[[`UserOperationRequest`](../type-aliases/UserOperationRequest), `` `0x${string}` ``, [`RpcStateOverride`](https://viem.sh)?]; `ReturnType`: [`UserOperationEstimateGasResponse`](../interfaces/UserOperationEstimateGasResponse); }, \{ `Method`: `"eth_getUserOperationReceipt"`; `Parameters`: \[`` `0x${string}` ``, (`"latest"` | `"pending"`)?]; `ReturnType`: `null` | [`UserOperationReceipt`](../interfaces/UserOperationReceipt); }, \{ `Method`: `"eth_getUserOperationByHash"`; `Parameters`: \[`` `0x${string}` ``]; `ReturnType`: | `null` | [`UserOperationResponse`](../interfaces/UserOperationResponse)\<`EntryPointVersion`>; }] | \[\{ `Method`: `"eth_sendUserOperation"`; `Parameters`: \[[`UserOperationRequest`](../type-aliases/UserOperationRequest), `` `0x${string}` ``]; `ReturnType`: `` `0x${string}` ``; }, \{ `Method`: `"eth_estimateUserOperationGas"`; `Parameters`: \[[`UserOperationRequest`](../type-aliases/UserOperationRequest), `` `0x${string}` ``, [`RpcStateOverride`](https://viem.sh)?]; `ReturnType`: [`UserOperationEstimateGasResponse`](../interfaces/UserOperationEstimateGasResponse); }, \{ `Method`: `"eth_getUserOperationReceipt"`; `Parameters`: \[`` `0x${string}` ``, (`"latest"` | `"pending"`)?]; `ReturnType`: `null` | [`UserOperationReceipt`](../interfaces/UserOperationReceipt); }, \{ `Method`: `"eth_getUserOperationByHash"`; `Parameters`: \[`` `0x${string}` ``]; `ReturnType`: | `null` | [`UserOperationResponse`](../interfaces/UserOperationResponse)\<`EntryPointVersion`>; }] |
| `TContext` *extends* | `undefined` | [`UserOperationContext`](../type-aliases/UserOperationContext) | | `undefined` | [`UserOperationContext`](../type-aliases/UserOperationContext) |
| Parameter | Type | Description |
|---|---|---|
| `config` | `Omit`\<\{ `account?`: `TAccount`; `addBreadCrumb?`: \<`T`>(`crumb`) => `T`; `customMiddleware?`: [`ClientMiddlewareFn`](../type-aliases/ClientMiddlewareFn)\<`TContext`>; `dummyPaymasterAndData?`: [`ClientMiddlewareFn`](../type-aliases/ClientMiddlewareFn)\<`TContext`>; `feeEstimator?`: [`ClientMiddlewareFn`](../type-aliases/ClientMiddlewareFn)\<`TContext`>; `gasEstimator?`: [`ClientMiddlewareFn`](../type-aliases/ClientMiddlewareFn)\<`TContext`>; `opts?`: `Object`; `paymasterAndData?`: [`ClientMiddlewareFn`](../type-aliases/ClientMiddlewareFn)\<`TContext`>; `signUserOperation?`: [`ClientMiddlewareFn`](../type-aliases/ClientMiddlewareFn)\<`TContext`>; `userOperationSimulator?`: [`ClientMiddlewareFn`](../type-aliases/ClientMiddlewareFn)\<`TContext`>; }, `"chain"` | `"transport"`> & `object` | the configuration object which includes the client |
| Parameter | Type | Description |
|---|---|---|
| `obj` | `any` | obj to deep hexlify |
| Type Parameter | Description |
|---|---|
| `C` *extends* `MiddlewareClient` | The type of the client |
| Parameter | Type | Description |
|---|---|---|
| `client` | `C` | The client to perform the fee estimation |
| Type Parameter | Default type |
|---|---|
| `TTransport` *extends* [`Transport`](https://viem.sh) | [`Transport`](https://viem.sh) |
| `TChain` *extends* `undefined` | [`Chain`](https://viem.sh) | `undefined` | [`Chain`](https://viem.sh) |
| `TAccount` *extends* `any` | `any` |
| `TContext` *extends* `any` | `any` |
| `TEntryPointVersion` *extends* `GetEntryPointFromAccount`\<`TAccount`> | `GetEntryPointFromAccount`\<`TAccount`> |
| Parameter | Type | Description |
|---|---|---|
| `client_` | [`Client`](https://viem.sh)\<`TTransport`, `TChain`, `TAccount`> | The client instance with the transport, chain, and account information |
| `args` | `DropAndReplaceUserOperationParameters`\<`TAccount`, `TContext`> | The parameters required for dropping and replacing the user operation including the account, operation to drop, overrides, and context |
| Type Parameter | Default type |
|---|---|
| `TContext` *extends* `undefined` | `Record`\<`string`, `any`> | `undefined` | `Record`\<`string`, `any`> |
| Parameter | Type | Description |
|---|---|---|
| `params?` | [`Erc7677MiddlewareParams`](../type-aliases/Erc7677MiddlewareParams)\<`TContext`, `EntryPointVersion`> | Middleware parameters including context function or object. Context can be resolved dynamically by passing in a function which takes in the context at the time of sending a user op |
| Type Parameter |
|---|
| `T` |
| Parameter | Type | Description |
|---|---|---|
| `obj` | `T` | the object from which to remove properties with undefined or null values |
| Parameter | Type | Description |
|---|---|---|
| `params` | [`GetAccountAddressParams`](../type-aliases/GetAccountAddressParams) | The configuration object |
| Parameter | Type |
|---|---|
| `chain` | [`Chain`](https://viem.sh) |
| Type Parameter | Default type |
|---|---|
| `TEntryPointVersion` *extends* keyof [`EntryPointRegistryBase`](../interfaces/EntryPointRegistryBase)\<`unknown`> | `OneOf`\<`"0.6.0"`, keyof [`EntryPointRegistryBase`](../interfaces/EntryPointRegistryBase)\<`unknown`>> |
| `TChain` *extends* [`Chain`](https://viem.sh) | [`Chain`](https://viem.sh) |
| Parameter | Type |
|---|---|
| `chain` | `TChain` |
| `options` | [`GetEntryPointOptions`](../type-aliases/GetEntryPointOptions)\<`TEntryPointVersion`> |
| Type Parameter | Default type |
|---|---|
| `TEntryPointVersion` *extends* `OneOf`\<`"0.6.0"`, keyof [`EntryPointRegistryBase`](../interfaces/EntryPointRegistryBase)\<`unknown`>> | `OneOf`\<`"0.6.0"`, keyof [`EntryPointRegistryBase`](../interfaces/EntryPointRegistryBase)\<`unknown`>> |
| `TChain` *extends* [`Chain`](https://viem.sh) | [`Chain`](https://viem.sh) |
| Parameter | Type |
|---|---|
| `chain` | `TChain` |
| `options?` | [`GetEntryPointOptions`](../type-aliases/GetEntryPointOptions)\<`TEntryPointVersion`> |
| Type Parameter | Default type |
|---|---|
| `TChain` *extends* [`Chain`](https://viem.sh) | [`Chain`](https://viem.sh) |
| Parameter | Type |
|---|---|
| `chain` | `TChain` |
| `options?` | [`GetEntryPointOptions`](../type-aliases/GetEntryPointOptions)\<`OneOf`\<`"0.6.0"`, keyof [`EntryPointRegistryBase`](../interfaces/EntryPointRegistryBase)\<`unknown`>>> |
| Type Parameter | Default type |
|---|---|
| `TTransport` *extends* [`Transport`](https://viem.sh) | [`Transport`](https://viem.sh) |
| `TChain` *extends* `undefined` | [`Chain`](https://viem.sh) | `undefined` | [`Chain`](https://viem.sh) |
| `TAccount` *extends* | `undefined` | [`SmartContractAccount`](../type-aliases/SmartContractAccount) | | `undefined` | [`SmartContractAccount`](../type-aliases/SmartContractAccount) |
| Parameter | Type | Description |
|---|---|---|
| `client` | `BaseSmartAccountClient`\<`TTransport`, `TChain`, `TAccount`> | the smart account client to use for RPC requests |
| `request` | [`UserOperationRequest`](../type-aliases/UserOperationRequest) | the uo request to get the error for |
| `entryPoint` | [`EntryPointDef`](../type-aliases/EntryPointDef) | the entrypoint instance to send the uo to |
| Parameter | Type |
|---|---|
| `x` | `any` |
| Parameter | Type | Description |
|---|---|---|
| `value` | `any` | The value to be checked |
| Parameter | Type |
|---|---|
| `x` | `any` |
| Parameter | Type | Description |
|---|---|---|
| `signer` | `any` | the object to check |
| Type Parameter | Default type |
|---|---|
| `TTransport` *extends* [`Transport`](https://viem.sh) | [`Transport`](https://viem.sh) |
| `TChain` *extends* `undefined` | [`Chain`](https://viem.sh) | `undefined` | [`Chain`](https://viem.sh) |
| `TAccount` *extends* `any` | `any` |
| Parameter | Type | Description |
|---|---|---|
| `client` | [`Client`](https://viem.sh)\<`TTransport`, `TChain`, `TAccount`> | a viem client |
| Parameter | Type | Description |
|---|---|---|
| `account` | [`SmartContractAccount`](../type-aliases/SmartContractAccount) | The account to check. |
| Type Parameter | Default type |
|---|---|
| `TEntryPointVersion` *extends* `EntryPointVersion` | `EntryPointVersion` |
| Parameter | Type | Description |
|---|---|---|
| `request` | `UserOperationStruct`\<`TEntryPointVersion`> | a UserOperationRequest to validate |
| Type Parameter | Default type |
|---|---|
| `TEntryPointVersion` *extends* `EntryPointVersion` | `EntryPointVersion` |
| Parameter | Type | Description |
|---|---|---|
| `request` | `UserOperationStruct`\<`TEntryPointVersion`> | a UserOperationRequest to validate |
| Type Parameter | Default type |
|---|---|
| `TEntryPointVersion` *extends* `EntryPointVersion` | `EntryPointVersion` |
| Parameter | Type | Description |
|---|---|---|
| `request` | `UserOperationStruct`\<`TEntryPointVersion`> | a UserOperationStruct to validate |
| Parameter | Type | Description |
|---|---|---|
| `overrides` | [`ClientMiddlewareConfig`](../type-aliases/ClientMiddlewareConfig) | config used during client initiation for overriding default middlewares |
| Type Parameter | Default type |
|---|---|
| `TTransport` *extends* [`Transport`](https://viem.sh) | [`Transport`](https://viem.sh) |
| `TChain` *extends* `undefined` | [`Chain`](https://viem.sh) | `undefined` | [`Chain`](https://viem.sh) |
| `TAccount` *extends* | `undefined` | [`SmartContractAccount`](../type-aliases/SmartContractAccount) | | `undefined` | [`SmartContractAccount`](../type-aliases/SmartContractAccount) |
| Parameter | Type |
|---|---|
| `client` | [`MiddlewareClient`](../type-aliases/MiddlewareClient)\<`TTransport`, `TChain`, `TAccount`> |
| Name | Type |
|---|---|
| `middleware` | [`ClientMiddleware`](../type-aliases/ClientMiddleware) |
| Parameter | Type | Description |
|---|---|---|
| `initCode` | `` `0x${string}` `` | The initialization code from which to parse the factory address and calldata |
| Parameter | Type | Description |
|---|---|---|
| `paymasterAndData` | `` `0x${string}` `` | the paymaster and data hex string to parse. The hex string refers to the paymasterAndData field of entrypoint v0.6 user operation request |
| Parameter | Type | Description |
|---|---|---|
| `obj` | `Record`\<`string`, `unknown`> | The object from which to pick keys |
| `keys` | `string` | `string`\[] | A single key or an array of keys to pick from the object |
| Type Parameter |
|---|
| `T` |
| Parameter | Type | Description |
|---|---|---|
| `object` | [`Deferrable`](../type-aliases/Deferrable)\<`T`> | a Deferrable object |
| Type Parameter | Default type |
|---|---|
| `TChain` *extends* `undefined` | [`Chain`](https://viem.sh) | `undefined` | [`Chain`](https://viem.sh) |
| `TAccount` *extends* | `undefined` | [`SmartContractAccount`](../type-aliases/SmartContractAccount) | | `undefined` | [`SmartContractAccount`](../type-aliases/SmartContractAccount) |
| `TChainOverride` *extends* `undefined` | [`Chain`](https://viem.sh) | `undefined` | [`Chain`](https://viem.sh) |
| `TContext` *extends* | `undefined` | [`UserOperationContext`](../type-aliases/UserOperationContext) | | `undefined` | [`UserOperationContext`](../type-aliases/UserOperationContext) |
| `TEntryPointVersion` *extends* keyof [`EntryPointRegistryBase`](../interfaces/EntryPointRegistryBase)\<`unknown`> | [`GetEntryPointFromAccount`](../type-aliases/GetEntryPointFromAccount)\<`TAccount`> |
| Parameter | Type | Description |
|---|---|---|
| `client_` | [`Client`](https://viem.sh)\<[`Transport`](https://viem.sh), `TChain`, `TAccount`> | The client to send the transaction through |
| `args` | [`SendTransactionParameters`](https://viem.sh)\<`TChain`, `TAccount`, `TChainOverride`> | The parameters required to send the transaction |
| `overrides?` | [`UserOperationOverrides`](../type-aliases/UserOperationOverrides)\<`TEntryPointVersion`> | Optional overrides for the user operation |
| `context?` | `TContext` | Optional context for the user operation |
| Type Parameter | Default type |
|---|---|
| `TTransport` *extends* [`Transport`](https://viem.sh) | [`Transport`](https://viem.sh) |
| `TChain` *extends* `undefined` | [`Chain`](https://viem.sh) | `undefined` | [`Chain`](https://viem.sh) |
| `TAccount` *extends* | `undefined` | [`SmartContractAccount`](../type-aliases/SmartContractAccount) | | `undefined` | [`SmartContractAccount`](../type-aliases/SmartContractAccount) |
| `TContext` *extends* `any` | `UserOperationContext` |
| Parameter | Type | Description |
|---|---|---|
| `client_` | [`Client`](https://viem.sh)\<`TTransport`, `TChain`, `TAccount`> | The client used to send the transactions |
| `args` | `SendTransactionsParameters`\<`TAccount`, `TContext`> | The parameters for sending the transactions, including requests, overrides, account, and context |
| Type Parameter | Default type |
|---|---|
| `TTransport` *extends* [`Transport`](https://viem.sh) | [`Transport`](https://viem.sh) |
| `TChain` *extends* `undefined` | [`Chain`](https://viem.sh) | `undefined` | [`Chain`](https://viem.sh) |
| `TAccount` *extends* | `undefined` | [`SmartContractAccount`](../type-aliases/SmartContractAccount) | | `undefined` | [`SmartContractAccount`](../type-aliases/SmartContractAccount) |
| `TContext` *extends* | `undefined` | [`UserOperationContext`](../type-aliases/UserOperationContext) | | `undefined` | [`UserOperationContext`](../type-aliases/UserOperationContext) |
| `TEntryPointVersion` *extends* keyof [`EntryPointRegistryBase`](../interfaces/EntryPointRegistryBase)\<`unknown`> | [`GetEntryPointFromAccount`](../type-aliases/GetEntryPointFromAccount)\<`TAccount`> |
| Parameter | Type | Description |
|---|---|---|
| `client_` | [`Client`](https://viem.sh)\<`TTransport`, `TChain`, `TAccount`> | the smart account client to use for RPC requests |
| `args` | `any` | contains the UO or batch to send, context, overrides, and account if not hoisted on the client |
| Parameter | Type | Description |
|---|---|---|
| `params` | [`SplitTransportParams`](../interfaces/SplitTransportParams) | split transport configuration containing the methods overrides and fallback transport |
| Parameter | Type | Description |
|---|---|---|
| `phrase` | `string` | any string value. |
| Parameter | Type | Description |
|---|---|---|
| `bytes` | `` `0x${string}` `` | the hex string representing bytes |
| `opts` | `TakeBytesOpts` | optional parameters for slicing the bytes |
| Type Parameter |
|---|
| `T` *extends* \{ \[K in string | number | symbol]: string | number | symbol } |
| `K` *extends* `string` | `number` | `symbol` |
| `V` |
| Parameter | Type | Description |
|---|---|---|
| `array` | `T`\[] | The array of objects to convert to a record |
| `selector` | `K` | The key used to select the property that will become the record's key |
| `fn` | (`item`) => `V` | The function that transforms each item in the array into the record's value |
| Type Parameter | Default type |
|---|---|
| `Name` *extends* `string` | `string` |
| `TTransport` *extends* [`Transport`](https://viem.sh) | [`Transport`](https://viem.sh) |
| `TChain` *extends* [`Chain`](https://viem.sh) | [`Chain`](https://viem.sh) |
| `TEntryPointVersion` *extends* keyof [`EntryPointRegistryBase`](../interfaces/EntryPointRegistryBase)\<`unknown`> | keyof [`EntryPointRegistryBase`](../interfaces/EntryPointRegistryBase)\<`unknown`> |
| Parameter | Type | Description |
|---|---|---|
| `params` | [`ToSmartContractAccountParams`](../type-aliases/ToSmartContractAccountParams)\<`Name`, `TTransport`, `TChain`, `TEntryPointVersion`> | the parameters required for converting to a smart contract account |
| Parameter | Type |
|---|---|
| `hex` | `` `0x${string}` `` |
| Parameter | Type | Description |
|---|---|---|
| `params` | `SignWith6492Params` | The parameters to wrap the signature |
| Type Parameter | Default type |
|---|---|
| `Name` *extends* `string` | `string` |
| Property | Type |
|---|---|
| `0.6.0` | [`SmartContractAccount`](../type-aliases/SmartContractAccount)\<`Name`, `"0.6.0"`> |
| `0.7.0` | [`SmartContractAccount`](../type-aliases/SmartContractAccount)\<`Name`, `"0.7.0"`> |
| Type Parameter | Default type |
|---|---|
| `TChain` *extends* [`Chain`](https://viem.sh) | [`Chain`](https://viem.sh) |
| Property | Type |
|---|---|
| `0.6.0` | [`EntryPointDef`](../type-aliases/EntryPointDef)\<`"0.6.0"`, `TChain`, `any`> |
| `0.7.0` | [`EntryPointDef`](../type-aliases/EntryPointDef)\<`"0.7.0"`, `TChain`, `any`> |
| Type Parameter | Default type |
|---|---|
| `TChain` *extends* [`Chain`](https://viem.sh) | [`Chain`](https://viem.sh) |
| Type Parameter |
|---|
| `T` |
| Property | Type |
|---|---|
| `0.6.0` | `T` |
| `0.7.0` | `T` |
| Type Parameter | Default type | Description |
|---|---|---|
| `AuthParams` | ‐ | the generic type of the authentication parameters |
| `AuthDetails` | ‐ | the generic type of the authentication details |
| `Inner` | `any` | the generic type of the inner client that the signer wraps to provide functionality such as signing, etc. |
| Type Parameter | Default type | Description |
|---|---|---|
| `Inner` | `any` | the generic type of the inner client that the signer wraps to provide functionality such as signing, etc. |
| Property | Type |
|---|---|
| `fallback` | [`Transport`](https://viem.sh) |
| `overrides` | `object`\[] |
| Type Parameter | Default type |
|---|---|
| `TEntryPointVersion` *extends* `EntryPointVersion` | `EntryPointVersion` |
| Property | Type |
|---|---|
| `callGasLimit` | `any` |
| `paymasterVerificationGasLimit` | `TEntryPointVersion` *extends* `"0.7.0"` ? `any` : `never` |
| `preVerificationGas` | `any` |
| `verificationGasLimit` | `any` |
| Type Parameter | Default type |
|---|---|
| `TEntryPointVersion` *extends* `EntryPointVersion` | `EntryPointVersion` |
| Property | Type |
|---|---|
| `data` | [`Hex`](https://viem.sh) | `"0x"` |
| `target` | [`Address`](https://abitype.dev) |
| `value?` | `bigint` |
| Name | Type | Description |
|---|---|---|
| `chainId` | `uint32` | Chain ID. |
| `nonce` | `uint32` | Nonce of the EOA to delegate to. |
| Type Parameter | Default type |
|---|---|
| `uint32` | `number` |
| Type Parameter | Default type |
|---|---|
| `transport` *extends* [`Transport`](https://viem.sh) | [`Transport`](https://viem.sh) |
| `chain` *extends* [`Chain`](https://viem.sh) | `undefined` | [`Chain`](https://viem.sh) | `undefined` |
| `account` *extends* [`SmartContractAccount`](SmartContractAccount) | `undefined` | [`SmartContractAccount`](SmartContractAccount) | `undefined` |
| `context` *extends* [`UserOperationContext`](UserOperationContext) | `undefined` | [`UserOperationContext`](UserOperationContext) | `undefined` |
| Name | Type |
|---|---|
| `buildUserOperation()` | (`args`) => `Promise`\<`UserOperationStruct`\<`TEntryPointVersion`>> |
| `buildUserOperationFromTx()` | (`args`, `overrides?`, `context?`) => `Promise`\<`UserOperationStruct`\<`TEntryPointVersion`>> |
| `buildUserOperationFromTxs()` | (`args`) => `Promise`\<`BuildUserOperationFromTransactionsResult`\<`TEntryPointVersion`>> |
| `checkGasSponsorshipEligibility()` | \<`TContext`, `TEntryPointVersion`>(`args`) => `Promise`\<`CheckGasSponsorshipEligibilityResult`\<`TAccount`, `TEntryPointVersion`>> |
| `dropAndReplaceUserOperation()` | (`args`) => `Promise`\<`SendUserOperationResult`\<`TEntryPointVersion`>> |
| `sendTransaction()` | \<`TChainOverride`>(`args`, `overrides?`, `context?`) => `Promise`\<[`Hex`](https://viem.sh)> |
| `sendTransactions()` | (`args`) => `Promise`\<[`Hex`](https://viem.sh)> |
| `sendUserOperation()` | (`args`) => `Promise`\<`SendUserOperationResult`\<`TEntryPointVersion`>> |
| `signMessage()` | (`args`) => `Promise`\<[`Hex`](https://viem.sh)> |
| `signTypedData()` | \<`TTypedData`, `TPrimaryType`>(`args`) => `Promise`\<[`Hex`](https://viem.sh)> |
| `signUserOperation()` | (`args`) => `Promise`\<`UserOperationRequest`\<`TEntryPointVersion`>> |
| `upgradeAccount()` | (`args`) => `Promise`\<[`Hex`](https://viem.sh)> |
| `waitForUserOperationTransaction()` | (`args`) => `Promise`\<[`Hex`](https://viem.sh)> |
| Type Parameter | Default type |
|---|---|
| `TChain` *extends* [`Chain`](https://viem.sh) | `undefined` | [`Chain`](https://viem.sh) | `undefined` |
| `TAccount` *extends* `SmartContractAccount` | `undefined` | `SmartContractAccount` | `undefined` |
| `TContext` *extends* `UserOperationContext` | `undefined` | `UserOperationContext` | `undefined` |
| `TEntryPointVersion` *extends* `GetEntryPointFromAccount`\<`TAccount`> | `GetEntryPointFromAccount`\<`TAccount`> |
| Type Parameter | Default type |
|---|---|
| `TAccount` *extends* `SmartContractAccount` | `undefined` | ‐ |
| `TContext` *extends* [`UserOperationContext`](UserOperationContext) | `undefined` | [`UserOperationContext`](UserOperationContext) | `undefined` |
| `TEntryPointVersion` *extends* `GetEntryPointFromAccount`\<`TAccount`> | `GetEntryPointFromAccount`\<`TAccount`> |
| Name | Type |
|---|---|
| `batch` | `BatchUserOperationCallData` |
| `uoStruct` | `UserOperationStruct`\<`TEntryPointVersion`> |
| Type Parameter | Default type |
|---|---|
| `TEntryPointVersion` *extends* `EntryPointVersion` | `EntryPointVersion` |
| Type Parameter | Default type |
|---|---|
| `TAccount` *extends* `SmartContractAccount` | `undefined` | ‐ |
| `TContext` *extends* [`UserOperationContext`](UserOperationContext) | `undefined` | [`UserOperationContext`](UserOperationContext) | `undefined` |
| `TEntryPointVersion` *extends* `GetEntryPointFromAccount`\<`TAccount`> | `GetEntryPointFromAccount`\<`TAccount`> |
| Type Parameter | Default type |
|---|---|
| `TEntryPointVersion` *extends* keyof [`EntryPointRegistryBase`](../interfaces/EntryPointRegistryBase)\<`unknown`> | keyof [`EntryPointRegistryBase`](../interfaces/EntryPointRegistryBase)\<`unknown`> |
| Parameter | Type | Description |
|---|---|---|
| `request` | [`UserOperationRequest`](UserOperationRequest)\<`TEntryPointVersion`> | the UserOperationRequest to estimate gas for |
| `entryPoint` | `` `0x${string}` `` | the entry point address the op will be sent to |
| `stateOverride?` | [`StateOverride`](https://viem.sh) | the state override to use for the estimation |
| Parameter | Type | Description |
|---|---|---|
| `hash` | `` `0x${string}` `` | the hash of the UserOperation to fetch |
| Parameter | Type | Description |
|---|---|---|
| `hash` | `` `0x${string}` `` | the hash of the UserOperation to get the receipt for |
| `tag?` | `"latest"` | `"pending"` | if client want to get receipt for different block tag. |
| Type Parameter | Default type |
|---|---|
| `TEntryPointVersion` *extends* keyof [`EntryPointRegistryBase`](../interfaces/EntryPointRegistryBase)\<`unknown`> | keyof [`EntryPointRegistryBase`](../interfaces/EntryPointRegistryBase)\<`unknown`> |
| Parameter | Type | Description |
|---|---|---|
| `request` | [`UserOperationRequest`](UserOperationRequest)\<`TEntryPointVersion`> | the UserOperationRequest to send |
| `entryPoint` | `` `0x${string}` `` | the entry point address the op will be sent to |
| Type Parameter | Default type |
|---|---|
| `T` *extends* [`Transport`](https://viem.sh) | [`Transport`](https://viem.sh) |
| Type Parameter | Default type |
|---|---|
| `TContext` *extends* `UserOperationContext` | `undefined` | `UserOperationContext` | `undefined` |
| Type Parameter | Default type |
|---|---|
| `TAccount` *extends* `SmartContractAccount` | ‐ |
| `C` *extends* `MiddlewareClient` | ‐ |
| `TContext` *extends* `UserOperationContext` | `undefined` | `UserOperationContext` | `undefined` |
| `TEntryPointVersion` *extends* `GetEntryPointFromAccount`\<`TAccount`> | `GetEntryPointFromAccount`\<`TAccount`> |
| Property | Type |
|---|---|
| `account` | `TAccount` |
| `client` | `C` |
| `context?` | `TContext` |
| `feeOptions?` | `UserOperationFeeOptions` |
| `overrides?` | `UserOperationOverrides`\<`TEntryPointVersion`> |
| Type Parameter | Default type |
|---|---|
| `TContext` *extends* [`UserOperationContext`](UserOperationContext) | `undefined` | [`UserOperationContext`](UserOperationContext) | `undefined` |
| Type Parameter | Default type |
|---|---|
| `TContext` *extends* `UserOperationContext` | `undefined` | `UserOperationContext` | `undefined` |
| Type Parameter | Default type |
|---|---|
| `TAccount` *extends* `SmartContractAccount` | ‐ |
| `C` *extends* `MiddlewareClient` | ‐ |
| `TEntryPointVersion` *extends* `GetEntryPointFromAccount`\<`TAccount`> | `GetEntryPointFromAccount`\<`TAccount`> |
| Parameter | Type |
|---|---|
| `struct` | `Deferrable`\<`UserOperationStruct`\<`TEntryPointVersion`>> |
| `args` | [`ClientMiddlewareArgs`](ClientMiddlewareArgs)\<`TAccount`, `C`, `TContext`, `TEntryPointVersion`> |
| Property | Type |
|---|---|
| `chainId?` | [`Hex`](https://viem.sh) |
| Type Parameter |
|---|
| `T` |
| Name | Type |
|---|---|
| `uoToDrop` | `UserOperationRequest`\<`TEntryPointVersion`> |
| Type Parameter | Default type |
|---|---|
| `TAccount` *extends* `SmartContractAccount` | `undefined` | ‐ |
| `TContext` *extends* [`UserOperationContext`](UserOperationContext) | `undefined` | [`UserOperationContext`](UserOperationContext) | `undefined` |
| `TEntryPointVersion` *extends* `GetEntryPointFromAccount`\<`TAccount`> | `GetEntryPointFromAccount`\<`TAccount`> |
| Type Parameter |
|---|
| `A` |
| `B` |
| Type Parameter | Default type |
|---|---|
| `TEntryPointVersion` *extends* [`EntryPointVersion`](EntryPointVersion) | [`EntryPointVersion`](EntryPointVersion) |
| `TChain` *extends* [`Chain`](https://viem.sh) | [`Chain`](https://viem.sh) |
| `TAbi` *extends* [`Abi`](https://abitype.dev) | readonly `unknown`\[] | [`Abi`](https://abitype.dev) |
| Type Parameter | Default type |
|---|---|
| `TEntryPointVersion` *extends* [`EntryPointVersion`](EntryPointVersion) | ‐ |
| `TChain` *extends* [`Chain`](https://viem.sh) | [`Chain`](https://viem.sh) |
| Type Parameter |
|---|
| `T` |
| `Union` |
| Type Parameter | Default type |
|---|---|
| `T` *extends* [`Transport`](https://viem.sh) | [`Transport`](https://viem.sh) |
| `TContext` *extends* `Record`\<`string`, `any`> | `Record`\<`string`, `any`> |
| Type Parameter | Default type |
|---|---|
| `TContext` *extends* `Record`\<`string`, `any`> | `undefined` | `Record`\<`string`, `any`> | `undefined` |
| `TEntryPointVersion` *extends* `EntryPointVersion` | `EntryPointVersion` |
| Property | Type |
|---|---|
| `context?` | (`struct`, `args`) => `Promise`\<`TContext`> | `TContext` |
| Type Parameter | Default type |
|---|---|
| `TContext` *extends* `Record`\<`string`, `any`> | `Record`\<`string`, `any`> |
| Type Parameter | Default type |
|---|---|
| `TAccount` *extends* [`SmartContractAccount`](SmartContractAccount) | `undefined` | [`SmartContractAccount`](SmartContractAccount) | `undefined` |
| `TAccountOverride` *extends* [`SmartContractAccount`](SmartContractAccount) | [`SmartContractAccount`](SmartContractAccount) |
| Type Parameter | Default type |
|---|---|
| `TContext` *extends* [`UserOperationContext`](UserOperationContext) | `undefined` | [`UserOperationContext`](UserOperationContext) | `undefined` |
| Type Parameter | Default type |
|---|---|
| `TAccount` *extends* [`SmartContractAccount`](SmartContractAccount) | `undefined` | ‐ |
| `TAccountOverride` *extends* [`SmartContractAccount`](SmartContractAccount) | [`SmartContractAccount`](SmartContractAccount) |
| Type Parameter | Default type |
|---|---|
| `TEntryPointVersion` *extends* [`EntryPointVersion`](EntryPointVersion) | [`DefaultEntryPointVersion`](DefaultEntryPointVersion) |
| Type Parameter |
|---|
| `T` |
| `Union` |
| `ConjunctionOfExplicitComponentChecks` *extends* `boolean` |
| Type Parameter |
|---|
| `T` |
| `Union` |
| Type Parameter | Description |
|---|---|
| `T` | Type to check |
| Type Parameter | Default type | Description |
|---|---|---|
| `TTransport` *extends* [`Transport`](https://viem.sh) | [`Transport`](https://viem.sh) | |
| `TChain` *extends* [`Chain`](https://viem.sh) | `undefined` | [`Chain`](https://viem.sh) | `undefined` | |
| `TAccount` *extends* [`SmartContractAccount`](SmartContractAccount) | `undefined` | [`SmartContractAccount`](SmartContractAccount) | `undefined` |
| Type Parameter |
|---|
| `T` |
| Type Parameter |
|---|
| `T` |