diff --git a/content/api-reference/websockets/subscription-api.mdx b/content/api-reference/websockets/subscription-api.mdx index ed302b664..e42967d4f 100644 --- a/content/api-reference/websockets/subscription-api.mdx +++ b/content/api-reference/websockets/subscription-api.mdx @@ -100,4 +100,4 @@ The following limits apply for WebSocket connections: | `1008` | `"WebSocket connection limit reached for this app. Please close existing connections and try again."` | Triggered when the number of open WebSocket connections for the app reaches the allowed limit. Close unused connections to restore access. | | `1008` | `"This app has exceeded its limit of open WebSockets. Please close some other connections first."` | Triggered when the team previously exceeded the limit and tries to reconnect again before the backoff interval expires. Close existing connections and wait. | | `1008` | `"You have exceeded the maximum number of concurrent requests on a single WebSocket. At most 200 concurrent requests are allowed per WebSocket."` | Triggered when a client has too many pending JSON-RPC requests on a single WebSocket. Ensure each request completes before sending more. | -| `32603` | `"You have exceeded the maximum number of subscriptions on a single WebSocket."` | Triggered when a client has too many subscriptions on a single WebSocket. Unsubscribe before creating new subscriptions. | \ No newline at end of file +| `32603` | `"You have exceeded the maximum number of subscriptions on a single WebSocket."` | Triggered when a client has too many subscriptions on a single WebSocket. Unsubscribe before creating new subscriptions. | diff --git a/content/docs.yml b/content/docs.yml index dd879a116..f72d047cd 100644 --- a/content/docs.yml +++ b/content/docs.yml @@ -863,7 +863,7 @@ navigation: path: wallets/pages/core/overview.mdx - page: Quickstart path: wallets/pages/core/quickstart.mdx - - section: Wallet APIs + - section: Transaction APIs contents: - page: Quickstart path: wallets/pages/smart-wallets/quickstart/index.mdx @@ -988,8 +988,6 @@ navigation: path: wallets/pages/authentication/login-methods/passkey-signup.mdx - page: Passkey login path: wallets/pages/react/login-methods/passkey-login.mdx - - page: Add passkey - path: wallets/pages/react/add-passkey.mdx - page: SMS login path: wallets/pages/authentication/login-methods/sms-login.mdx - page: "On-chain passkeys" @@ -1036,8 +1034,6 @@ navigation: path: wallets/pages/signer/authentication/server-wallets.mdx - section: Account management contents: - - page: Pregenerate wallets - path: wallets/pages/react/pregenerate-wallets.mdx - page: User sessions path: wallets/pages/signer/user-sessions.mdx - page: Manage account ownership @@ -1050,7 +1046,7 @@ navigation: path: wallets/pages/third-party/signers/privy.mdx - page: Turnkey path: wallets/pages/third-party/signers/turnkey.mdx - - page: Custom integration + - page: Other signers path: wallets/pages/third-party/signers/custom-integration.mdx - page: What is a signer? path: wallets/pages/authentication/what-is-a-signer.mdx @@ -1183,6 +1179,9 @@ navigation: - page: Migrating to 4.x.x slug: migration-guide path: wallets/pages/migration-guide.mdx + - page: Migrating to 5.x.x + slug: resources/migration-v5 + path: wallets/pages/resources/migration-v5.mdx - page: Terms slug: resources/terms path: wallets/pages/resources/terms.mdx diff --git a/content/tutorials/understanding-the-evm/blockchain-101.mdx b/content/tutorials/understanding-the-evm/blockchain-101.mdx index a7f7cd8f0..ff6d7e8d2 100644 --- a/content/tutorials/understanding-the-evm/blockchain-101.mdx +++ b/content/tutorials/understanding-the-evm/blockchain-101.mdx @@ -62,4 +62,4 @@ For block details and blockchain mechanics, here are a few important concepts to The blockchain space has seen a lot increasingly more action. We, Alchemy API, act as as blockchain infrastructure provider amongst other things, and work with a lot of cool projects that are built on top of the Ethereum blockchain. Here are some of our [customers](https://alchemy.com/customers) and links to their platforms. -We want to keep this as current as possible. Please reach out with suggestions and follow us on Twitter [@Alchemy](https://twitter.com/Alchemy)! \ No newline at end of file +We want to keep this as current as possible. Please reach out with suggestions and follow us on Twitter [@Alchemy](https://twitter.com/Alchemy)! diff --git a/content/wallets/pages/authentication/what-is-a-signer.mdx b/content/wallets/pages/authentication/what-is-a-signer.mdx index 066204b64..d22fe0972 100644 --- a/content/wallets/pages/authentication/what-is-a-signer.mdx +++ b/content/wallets/pages/authentication/what-is-a-signer.mdx @@ -5,15 +5,15 @@ description: Explore Smart Wallets integration guides for signers including Magi slug: wallets/signer/what-is-a-signer --- -A **Signer** is a service (e.g. Alchemy Signer) or application (e.g. MetaMask) that manages the private key and signs operations. Most web3 users today use an [Externally Owned Account (EOA)](https://ethereum.org/en/developers/docs/accounts/#externally-owned-accounts-and-key-pairs) with a self-custodial Signer such as MetaMask to manage the private key. +A **Signer** is a service or application that manages a private key and signs operations. Most web3 users today use an [Externally Owned Account (EOA)](https://ethereum.org/en/developers/docs/accounts/#externally-owned-accounts-and-key-pairs) with a self-custodial Signer such as MetaMask to manage the private key. With Smart Wallets, you will deploy a **smart account** for each user instead of an EOA wallet. This smart account stores the user's assets (e.g. tokens or NFTs). -The signer connected to the `SmartAccountClient` is used to sign messages, data including user operations and transactions. The signatures for the user operation will be only valid and execute if the signer is the owner or one of the owners of the account. +The signer connected to the `SmartWalletClient` is used to sign messages, data including user operations and transactions. The signatures for the user operation will be only valid and execute if the signer is the owner or one of the owners of the account. Using Smart Wallets, you can secure your user's account with an email, social login, or passkeys. You can also use a self-custodial wallet like MetaMask as the Signer. You can choose any Signer service or application to manage the Owner private key for the user. -This doc provides a basic introduction to signers and the criteria you should consider when choosing which Signer to use with Smart Wallets in your application. +This doc provides a basic introduction to signers, the criteria you should consider when choosing a Signer, and how signers integrate with the Smart Wallets SDK. ## Role of a Signer @@ -25,12 +25,6 @@ The Signer plays a crucial role in your app because it controls the user's smart * Signing user operations requested by the user, if and only if the user has authenticated * Optionally offering account recovery methods -## Alchemy Signer - -User security is our top priority. Alchemy Signer is a non-custodial signer service where private keys are securely generated inside a [secure enclave](https://docs.turnkey.com/security/secure-enclaves). Only the end user can access their keys, not Alchemy nor your app. Read more about Turnkey's [security model](https://docs.turnkey.com/security/our-approach) that powers Alchemy Signer. - -Alchemy Signer is supported out of the box with Smart Wallets via easy to use [React Hooks](/docs/wallets/react/quickstart) and lower-lever [SDKs](/docs/wallets/signer/quickstart). Using Smart Wallets with the Alchemy Signer, you can secure your user's account with an email, social login, or passkeys. - ## Criteria to consider Here are some important criteria to consider when choosing a Signer. @@ -38,27 +32,17 @@ Here are some important criteria to consider when choosing a Signer. * **Custody model:** Who has access to the private key? * Self-Custodial: the end user controls the private key and manually approves signature requests * Non-Custodial: a third-party service manages the private key or a subset of the key shares, but cannot sign transactions without the user’s involvement - * Custodial: a third-party service manages the private key and can sign transactions without the user’s involvement - * **Alchemy Signer** is a fully non-custodial provider - only the end user can access their keys, not Alchemy, not your app, and not Turnkey. + * Custodial: a third-party service manages the private key and can sign transactions without the user's involvement * **Security model**: Assess the security model of the provider. Where is the private key stored? (on a device? in the cloud? on what cloud provider?) Is the private key encrypted? What encryption algorithm is used? Who has access to the decryption keys? This is a non-exhaustive list and we recommend doing further research. - * **Alchemy Signer**: Private keys are secured by Turnkey. Turnkey runs all secure workloads in “Secure Enclaves,” a type of Trusted Execution Environment. Read about the security approach [here](https://docs.turnkey.com/security/our-approach). * **Authentication methods:** What authentication method delivers the right balance of security, self-sovereignty, and ease-of-use for your target users? - * **Alchemy Signer:** See full support [here](/docs/wallets/react/ui-components#customize-authentication-ui). - * Email magic-link and OTP - * Social logins: OAuth providers (google, github, facebook and custom providers via Auth0) - * Passkey sign up and login * **Availability:** If the Signer service provider goes down, will users be able to sign transactions? - * **Alchemy signer:** The private key export method does not rely on Alchemy's infrastructure, so even if Alchemy is down, a user can still export their private key. Private key export doesn't rely on Alchemy being up, but on Turnkey being up. For full availability if Turnkey goes down the user should export their private key at some point. - * **Key export:** Does the Signer allow the end user to export their private key? Can the user initiate an export even if the service provider has gone down? This is an important factor to ensure the user retains control of their assets no matter what happens to the service provider. - * **Alchemy Signer** allows user's to easily [export their private key](/docs/wallets/reference/account-kit/react/hooks/useExportAccount), allowing them a right to exit at any time. * **Key recovery**: If the user forgets their password or loses their passkey, what recovery methods does the Signer provide? If the provider stores a backup copy of the private key or MPC key shares, where are those backups stored and who has access to them? - * **Alchemy signer:** You can add an additional backup login method with a passkey so that users can recover their key with either their email/social or passkey login. Additionally, if using an account that supports more than one owner, you can add multiple owners to an accounts making it recoverable by any owner. ## Types of Signers @@ -110,28 +94,14 @@ Custodial wallet providers have full control over the user’s private key and s **Example**: Coinbase Custody, Bitgo -## Supported signers - - - When using the [React](/docs/wallets/react/overview) or - [Core](/docs/wallets/core/overview) libraries, all of the account instances are - created with the `AlchemyWebSigner` as an owner on the accounts. - - -The Smart Account Signer interface is used to define an owner for [Smart Contract Accounts](/docs/wallets/resources/types#smartcontractaccount). -The interface takes two forms: +## Signer interfaces -1. `SmartAccountSigner` -- This is the base interface for all signer. It defines methods for signing messages and typed data, as well as getting the address of the signer. -2. `SmartAccountAuthenticator` -- This is an extension of the `SmartAccountSigner` that exposes additional methods for Signers that require authentication before signing. +The `SmartWalletClient` accepts any signer that conforms to standard [viem](https://viem.sh/) account interfaces. The `signer` parameter of `createSmartWalletClient` accepts: -Within Smart Wallets and `@aa-sdk/core`, we provide a number of implementations for `SmartAccountSigner` and `SmartAccountAuthenticator`: +1. [**`LocalAccount`**](https://viem.sh/docs/accounts/local) — A viem local account, such as one created with [`privateKeyToAccount`](https://viem.sh/docs/accounts/local/privateKeyToAccount) or [`toAccount`](https://viem.sh/docs/accounts/local/toAccount). Useful for private key signers, hardware wallets, or custom account implementations. +2. [**Viem `WalletClient`**](https://viem.sh/docs/clients/wallet) — A viem wallet client with a mounted account. Since a wallet client can wrap any [EIP-1193](https://eips.ethereum.org/EIPS/eip-1193) compliant provider, this is useful for connecting third-party embedded wallet providers or browser extension wallets. -1. [`AlchemyWebSigner`](/docs/wallets/reference/account-kit/signer/classes/AlchemyWebSigner) - This is an implementation of the `SmartAccountAuthenticator` that uses the our signer service to provision private keys securely - for end users. It allows you to authenticate your users with methods more familiar to them, such as email or social login. -2. [`LocalAccountSigner`](/docs/wallets/reference/aa-sdk/core/classes/LocalAccountSigner) - This signer is useful if you have a mnemonic or private key locally that you want to use as an - owner of a smart contract account. This is useful for testing and development purposes. -3. [`WalletClientSigner`](/docs/wallets/reference/aa-sdk/core/classes/WalletClientSigner) - This signer is useful if you want to use a [wallet client](https://viem.sh/docs/clients/wallet) as an owner. - Since a wallet client can wrap any [EIP-1193](https://eips.ethereum.org/EIPS/eip-1193) compliant provider, this is useful if you want to use EOA extensions or 3rd party signer service SDKs. +For [EIP-7702](/docs/wallets/transactions/using-eip-7702) delegation, the signer must support `signAuthorization`. See the [third-party signer integration guide](/docs/wallets/third-party/signers/custom-integration) for details on bringing your own signer. *** diff --git a/content/wallets/pages/concepts/smart-account-client.mdx b/content/wallets/pages/concepts/smart-account-client.mdx index 1003b4a88..d30d4c53e 100644 --- a/content/wallets/pages/concepts/smart-account-client.mdx +++ b/content/wallets/pages/concepts/smart-account-client.mdx @@ -4,171 +4,117 @@ description: Configure smart wallet client slug: wallets/concepts/smart-account-client --- +`@alchemy/wallet-apis` (v5.x.x) is currently in beta but is the recommended replacement for `@account-kit/wallet-client` (v4.x.x). If you run into any issues, please [reach out](mailto:support@alchemy.com). + A smart wallet client is the main interface used to interact with smart wallets and take actions like sending transactions, batching transactions, swapping, sponsoring gas, and more. ## How It Works -The [`SmartWalletClient`](https://github.com/alchemyplatform/aa-sdk/blob/b8dad097dc537985334efe0c1cc2af4e79dc0050/account-kit/wallet-client/src/client/index.ts#L34) is a EIP-1193 compatible extension of `viem`'s [Client](https://viem.sh/docs/clients/custom#build-your-own-client) which allows you to interact with smart wallets. +The `SmartWalletClient` extends viem's [Client](https://viem.sh/docs/clients/custom#build-your-own-client). By default, it uses [EIP-7702](/docs/wallets/transactions/using-eip-7702) to delegate the signer's EOA to a smart account, so the account address is the same as the signer address. No separate account deployment or address mapping is needed. ## Prerequisites * [API key](https://dashboard.alchemy.com/apps) * (Optional) [A gas policyID](https://dashboard.alchemy.com/gas-manager/policy/create) -* [Smart wallets installed and configured in your project](/docs/wallets/react/setup) +* `@alchemy/wallet-apis` and `viem` installed (see the [quickstart](/docs/wallets/reference/smart-wallet-quickstart)) ## Implementation - Use the [`createSmartWalletClient`](/docs/wallets/reference/account-kit/wallet-client/functions/createSmartWalletClient) function to create a smart wallet client. + {/* TODO: update SDK reference link */} + Use the `createSmartWalletClient` function to create a smart wallet client. - 1. Replace the placeholders - a. API key from your Alchemy dashboard - b. Policy ID from your gas policy - c. Signer from [authentication](/docs/wallets/authentication/login-methods/email-otp#step-4-check-authentication-status) or your own signer - 2. Create the initial client using [`createSmartWalletClient`](/docs/wallets/reference/account-kit/wallet-client/functions/createSmartWalletClient) - 3. Generate your smart account by calling `requestAccount()` - 4. Create the final client with your account attached + 1. Replace the placeholders: + * API key from your [Alchemy dashboard](https://dashboard.alchemy.com/apps) + * Policy ID from your [gas policy](https://dashboard.alchemy.com/gas-manager/policy/create) + * Signer from [authentication](/docs/wallets/authentication/login-methods/email-otp#step-4-check-authentication-status) or your own signer + 2. Create the client using `createSmartWalletClient` — the client defaults to EIP-7702 using the signer's address ```ts twoslash title="client.ts" - import { LocalAccountSigner } from "@aa-sdk/core"; - import { alchemy, sepolia } from "@account-kit/infra"; + import { privateKeyToAccount } from "viem/accounts"; + import { arbitrumSepolia } from "viem/chains"; import { createSmartWalletClient, - type SmartWalletClientParams, - } from "@account-kit/wallet-client"; - - const clientParams: SmartWalletClientParams = { - transport: alchemy({ apiKey: "your-alchemy-api-key"}), - chain: sepolia, - signer: LocalAccountSigner.privateKeyToAccountSigner("0x-your-wallet-private-key"), - policyId: "your-policy-id", - }; - - const clientWithoutAccount = createSmartWalletClient(clientParams); - - const account = await clientWithoutAccount.requestAccount(); + alchemyWalletTransport, + } from "@alchemy/wallet-apis"; export const client = createSmartWalletClient({ - ...clientParams, - account: account.address, + transport: alchemyWalletTransport({ apiKey: "your-alchemy-api-key" }), + chain: arbitrumSepolia, + signer: privateKeyToAccount("0x-your-wallet-private-key"), + paymaster: { policyId: "your-policy-id" }, }); ``` - When using the wallet [API](/docs/wallets/smart-wallet-quickstart/api), you don't need to define a client - send requests directly to the API endpoints. + When using the wallet [API](/docs/wallets/reference/smart-wallet-quickstart), you don't need to define a client - send requests directly to the API endpoints. + + ## Advanced - - By default, the Smart Wallet Client will use [ModularAccountV2](/docs/wallets/smart-contracts/modular-account-v2/overview)(MAv2). This is the cheapest and most advanced Smart Account, but you can specify other smart contract account types as needed. Learn more about the different smart accounts [here](/docs/wallets/smart-contracts/choosing-a-smart-account). + + By default, the client uses EIP-7702 with the signer's address. If you need to use a standalone smart contract account instead, see the [non-7702 mode guide](/docs/wallets/transactions/using-eip-7702#how-to-use-non-7702-mode). - - Changing the account type will deploy a different account. If you've already - deployed an account for a user and want to change the underlying account type, - you'll need to upgrade it. Learn how to upgrade - [here](/docs/wallets/smart-contracts/other-accounts/modular-account/upgrading-to-modular-account). - + Learn more about the different smart account types [here](/docs/wallets/smart-contracts/choosing-a-smart-account). + - **Javascript** + + By default, the client uses the signer's address with EIP-7702. If you already know a [non-7702 smart contract account](/docs/wallets/transactions/using-eip-7702#how-to-use-non-7702-mode) address your signer owns (either from calling `requestAccount` or stored from a previous session), you can pass it when creating the client or on each action. - Specify the account type when calling `requestAccount` using the `creationHint` parameter. See all parameter [options](/docs/wallets/api-reference/smart-wallets/wallet-api-endpoints/wallet-api-endpoints/wallet-request-account#request.body.requestAccountRequest.creationHint). + **On the client:** ```ts - const account = await clientWithoutAccount.requestAccount( - creationHint: { - accountType: "sma-b" - }, - ); - - export const client = createSmartWalletClient({ - ...clientParams, - account: account.address, + const client = createSmartWalletClient({ + // ... your config + account: "0xYOUR_SCA_ADDRESS", }); ``` - **API** - - Pass an [`accountType`](/docs/wallets/api-reference/smart-wallets/wallet-api-endpoints/wallet-api-endpoints/wallet-request-account) to `creationHint` when calling `wallet_requestAccount`. - - **Using 7702** - - To use EIP-7702, please see [this guide](https://www.alchemy.com/docs/wallets/transactions/using-eip-7702). You'll need to set additional parameters on the client. - - - - By default, account addresses are deterministically generated from the signer address. To connect to an existing account that doesn't match the deterministic address of your signer, specify the account address when creating the client. - - **Javascript** - - Pass the address to the `createSmartWalletClient` directly rather than calling `requestAccount`. + **Per action:** ```ts - export const client = createSmartWalletClient({ - ...clientParams, - account: "0xYOUR_SMART_ACCOUNT_ADDR", + await client.sendCalls({ + account: "0xYOUR_SCA_ADDRESS", + calls: [...], }); ``` - - **API** - - Pass the account address directly when preparing calls instead of calling wallet\_requestAccount. See this [guide](/docs/wallets/transactions/send-transactions#API) and skip step 2. - Because the Smart Wallet Clients are extensions of viem's clients, they support extensions via the `.extend` method. The base client already includes a [number of actions](https://github.com/alchemyplatform/aa-sdk/tree/v4.x.x/aa-sdk/core/src/actions/smartAccount) by default. You can find additional details about these actions in the [`@aa-sdk/core` documentation](/docs/wallets/reference/aa-sdk/core). + The `SmartWalletClient` is a viem client extension, so it supports the `.extend` method for adding custom actions. For example, experimental swap actions are added this way: + + ```ts + import { swapActions } from "@alchemy/wallet-apis/experimental"; + + const swapClient = client.extend(swapActions); + ``` - Typically, the smart account client uses the default account or the account passed into the client constructor for all of the actions you perform with the client - also known as **account hositing**. - - If you want to manage multiple instances of an account but want to use one client for all of them, you can pass an account to the client on every action. + If the same signer owns multiple [non-7702 smart contract accounts](/docs/wallets/transactions/using-eip-7702#how-to-use-non-7702-mode), you can use a single client to interact with any of them by passing `account` on each action: ```ts - import { - createAlchemySmartAccountClient, - sepolia, - alchemy, - } from "@account-kit/infra"; - import { createLightAccount } from "@account-kit/smart-contracts"; - import { LocalAccountSigner } from "@aa-sdk/core"; - import { http } from "viem"; - import { generatePrivateKey } from "viem/accounts"; - - // with account hoisting - const transport = alchemy({ apiKey: "your-api-key" }); - const hoistedClient = createAlchemySmartAccountClient({ - transport, - chain: sepolia, - account: await createLightAccount({ - signer: LocalAccountSigner.privateKeyToAccountSigner(generatePrivateKey()), - chain: sepolia, - transport, - }), - }); - - const signature = await hoistedClient.signMessage({ message: "Hello world! " }); + // Two SCAs owned by the same signer, created via requestAccount + const treasuryAccount = "0xaaa...111"; + const operationsAccount = "0xbbb...222"; - // without account hoisting - const nonHoistedClient = createAlchemySmartAccountClient({ - transport, - chain: sepolia, + await client.sendCalls({ + account: treasuryAccount, + calls: [{ to: "0x...", data: "0x", value: BigInt(0) }], }); - const lightAccount = await createLightAccount({ - signer: LocalAccountSigner.privateKeyToAccountSigner(generatePrivateKey()), - chain: sepolia, - transport, - }); - - const signature2 = await nonHoistedClient.signMessage({ - message: "Hello world! ", - account: lightAccount, + await client.sendCalls({ + account: operationsAccount, + calls: [{ to: "0x...", data: "0x", value: BigInt(0) }], }); ``` + + If different signers are involved, use the prepare/sign/send flow with separate clients per signer instead. ## Next Steps diff --git a/content/wallets/pages/index.mdx b/content/wallets/pages/index.mdx index aa321b136..c6b7cfaa9 100644 --- a/content/wallets/pages/index.mdx +++ b/content/wallets/pages/index.mdx @@ -23,14 +23,9 @@ hide-toc: true className="hero-image-desktop" /> - - - Send transactions using the SDK with React, React Native, or Node.js. - - - Send transactions directly via the JSON-RPC APIs. - - + + Send your first transaction using the SDK or API. + ## Everything You Need for Onchain Applications diff --git a/content/wallets/pages/react/add-passkey.mdx b/content/wallets/pages/react/add-passkey.mdx deleted file mode 100644 index 0df6e56ea..000000000 --- a/content/wallets/pages/react/add-passkey.mdx +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: Add Passkey -description: Learn how to add a passkey to your users' accounts with Smart Wallets. -slug: wallets/react/add-passkey ---- - -Smart Wallets allows you to let a user log in with an existing passkey, but there's no way to sign-up with a passkey. This guide will outline -how to add a passkey to a user's account after they've signed up. - -If you're not sure how to authenticate your users, see [this guide](/docs/wallets/react/quickstart). - -## Add a passkey on sign up - -The easiest way to add a passkey to users is right when they signup! This can be done by updating your `ui` config in the `createConfig` call to enable the UI components to prompt the user for a passkey. - -```ts twoslash config.ts -// @noErrors -import { createConfig } from "@account-kit/react"; -import { sepolia } from "@account-kit/infra"; - -export const config = createConfig( - { - chain: sepolia, - apiKey: "ALCHEMY_API_KEY", - }, - { - illustrationStyle: "outline", - auth: { - sections: [[{ type: "email" }], [{ type: "passkey" }]], - addPasskeyOnSignup: true, // [!code ++] - }, - }, -); -``` - -Now, when a user signs up, they will be prompted to create a passkey. - -## Add a passkey later - -With the above config, the user will only be prompted when they first create their account in your app. If you want to add the ability to add a passkey elsewhere in your app, for example in a settings page, you can use the [`useAddPasskey`](/docs/wallets/reference/account-kit/react/hooks/useAddPasskey) hook. - - - This hook requires that the user already be authenticated or else it will - throw an error! - - -```tsx twoslash -import React from "react"; -import { useAddPasskey } from "@account-kit/react"; - -export default function MyComponent() { - const { addPasskey, isAddingPasskey } = useAddPasskey(); - - return ( - - ); -} -``` diff --git a/content/wallets/pages/react/pay-gas-with-any-token.mdx b/content/wallets/pages/react/pay-gas-with-any-token.mdx deleted file mode 100644 index 7d92308f0..000000000 --- a/content/wallets/pages/react/pay-gas-with-any-token.mdx +++ /dev/null @@ -1,101 +0,0 @@ ---- -title: Pay gas with any token -description: Enable your users to pay gas with ERC-20 tokens like USDC via Gas Manager -slug: wallets/react/pay-gas-with-any-token ---- - -Gas fees paid in the native gas token can feel foreign to users that primarily hold stablecoins or your app's own token. With our smart wallet, you can enable your users to pay for gas with ERC-20 tokens beyond the native gas token, like USDC or your own custom tokens, streamlining the user experience. - - - -## Prerequisites - - - -## 1. Create a Gas Manager policy - - - - - - ## 2. Create a smart Account Client - - Now you can create a Smart Account Client which is configured to sponsor gas. - - ```tsx - import { - alchemy, - createAlchemySmartAccountClient, - sepolia, - } from "@account-kit/infra"; - import { createLightAccount } from "@account-kit/smart-contracts"; - // You can replace this with any signer you'd like - // We're using a LocalAccountSigner to generate a local key to sign with - import { LocalAccountSigner } from "@aa-sdk/core"; - import { generatePrivateKey } from "viem/accounts"; - - const alchemyTransport = alchemy({ - apiKey: "YOUR_API_KEY", - }); - - export const client = createAlchemySmartAccountClient({ - transport: alchemyTransport, - policyId: "YOUR_POLICY_ID", - policyToken: { - address: tokenAddress, - maxTokenAmount: 10_000_000n, - }, - chain: sepolia, - account: await createLightAccount({ - chain: sepolia, - transport: alchemyTransport, - signer: LocalAccountSigner.privateKeyToAccountSigner(generatePrivateKey()), - }), - }); - ``` - - ## 3. Send a sponsored UserOperation - - ```tsx - import { client } from "./client"; - import { encodeFunctionData, parseAbi } from "viem"; - - const erc20Abi = parseAbi([ - "function approve(address spender, uint256 amount) public returns (bool)", - ]); - - const { hash } = await client.sendUserOperation({ - uo: [ - { - // approve call - target: tokenAddress, - data: encodeFunctionData({ - abi: erc20Abi, - functionName: "approve", - args: [paymasterAddress, maxTokenAmount], - }) as `0x${string}`, - }, - { - // actual call - target: "0xTARGET_ADDRESS", - data: "0x", - value: 0n, - }, - ], - }); - ``` - - ## 4. Estimate ERC20 token amount of a UO - - - - ## 5. Simulate a ERC20 UO - - - - - - -## Done - -Your dApp now sponsors gas with the chosen ERC-20 token! diff --git a/content/wallets/pages/react/pregenerate-wallets.mdx b/content/wallets/pages/react/pregenerate-wallets.mdx deleted file mode 100644 index 6fa328c49..000000000 --- a/content/wallets/pages/react/pregenerate-wallets.mdx +++ /dev/null @@ -1,140 +0,0 @@ ---- -title: Pregenerate Wallets -description: Learn how to pre-generate Smart Wallet addresses for your users with nothing more than an email address. -slug: wallets/react/pregenerate-wallets ---- - -> **Objective** Generate a wallet owner (signer) and the smart-account address *before* a user ever logs in, using only their email. - -## Prerequisites - -* Alchemy **API Key** with Smart Wallets enabled - * If starting from scratch, follow the [quickstart](/docs/wallets/react/quickstart/existing-project#2-get-your-api-key) to get your API key - * Existing api keys can be found in the Alchemy Dashboard by viewing your config in the [Smart wallets configuration page](https://dashboard.alchemy.com/services/smart-wallets/configuration) -* Node ≥ 18 (or cURL / any HTTP client) -* The `@account-kit/smart-contracts` package (for step 4) - -You can generate a wallet address on both EVM and Solana before a user ever authenticates or logs in using only their email. This could enable use cases such as: - -* airdropping assets or seed balances to users who signed up for a waitlist with their email before they ever open your app -* allowing users to send assets to another user with just their email even if the recipient has not logged in before. When that recipient logs in, they'll be able to claim their balance. -* migrating assets to smart wallets to enable gas sponsorship, batching, etc. -* and more! - -With Alchemy you can do this entirely from your server using the **Signer API** – no UI, hooks, or user interaction required. - -**Note:** Smart contract addresses are deterministic. The deployment address is a function of the address of owner/signer address, the account implementation (e.g. latest version of Modular Account), and the salt (optionally specified). If all three of those remain the same, then the smart account will be consistent across chains and for users. We will handle generating a consistent signer address for email. - -## 1. Create the owner signer - -First, you need to generate the signer address. This will be generated using the [`Create Wallet` API endpoint](https://www.alchemy.com/docs/wallets/api/smart-wallets/signer-api-endpoints/signer-api-endpoints/create-account). The signer address will be used as the owner of the new smart account and enable the user to sign transactions after authenticating with their email. - - - - ```ts twoslash - const res = await fetch("https://api.g.alchemy.com/signer/v1/signup", { - method: "POST", - headers: { - "Content-Type": "application/json", - // The API key is sent in the Authorization header - Authorization: `Bearer ${process.env.ALCHEMY_API_KEY}`, - }, - body: JSON.stringify({ - email: "[email protected]", - }), - }); - - if (!res.ok) throw new Error(await res.text()); - - const { address, solanaAddress, userId } = await res.json(); - console.log({ address, solanaAddress, userId }); - ``` - - - - ```ts - import request from "request"; - - request.post( - { - url: "https://api.g.alchemy.com/signer/v1/signup", - json: { email: "[email protected]" }, - headers: { - Authorization: `Bearer ${process.env.ALCHEMY_API_KEY}`, - "Content-Type": "application/json", - }, - }, - (err, _resp, body) => { - if (err) throw err; - console.log(body); // ➜ { orgId, userId, address, solanaAddress, otpId } - }, - ); - ``` - - - - ```bash - curl -X POST https://api.g.alchemy.com/signer/v1/signup \ - -H "Authorization: Bearer $ALCHEMY_API_KEY" \ - -H "Content-Type: application/json" \ - -d '{ "email": "[email protected]" }' - ``` - - - -| Field | Description | -| --------------- | ------------------------------------------------------------------------------------------------------------------ | -| `address` | The **signer (EOA)** address that will **own** your user's smart account (this is *not* the smart account itself). | -| `solanaAddress` | The **Solana** wallet address associated with the same user. | -| `orgId` | Your organisation ID – useful if you operate multiple orgs. | - - - The address you receive here is the **owner key**. Your user's Smart Contract - Account (ModularAccountV2) will be deployed at a different address – but we - can deterministically calculate it ahead of time using - `predictModularAccountV2Address`. - - -## 2. Predict the smart-account address - -Using the signer address you generated in step 2, you can now generate the counter-factual (future) address of the smart account before it is even deployed. - -The `predictModularAccountV2Address` method will generate the address for a new Modular Account v2 and mirrors the CREATE2 logic used by the MAv2 factory. - -```ts twoslash -import { predictModularAccountV2Address } from "@account-kit/smart-contracts"; - -// Factory & implementation addresses vary by chain – you can grab them from -// the Deployed addresses page. -// https://www.alchemy.com/docs/wallets/smart-contracts/deployed-addresses - -const mav2FactoryAddress = "0x00000000000017c61b5bEe81050EC8eFc9c6fecd"; -const implementationAddress = "0x000000000000c5A9089039570Dd36455b5C07383"; - -const smartAccountAddress = predictModularAccountV2Address({ - factoryAddress: mav2FactoryAddress, - implementationAddress, - salt: 0n, // use 0 unless you have a custom salt scheme - type: "SMA", - ownerAddress: address, // signer address from Step 2 -}); - -console.log({ smartAccountAddress }); -``` - -Now you have **both** the owner key (`address`) and the eventual smart account -address (`smartAccountAddress`). When the user finally authenticates, their -smart account will be deployed at exactly this counter-factual address. - - - If your application is still using the older **Light Account** contracts (v1 or v2) instead of Modular Account V2, use the corresponding helpers from `@account-kit/smart-contracts`: - - * `predictLightAccountAddress` – single-owner Light Account - * `predictMultiOwnerLightAccountAddress` – multi-owner Light Account - - These functions take the same factory/owner/salt pattern shown above and work for all historical Light-Account factory versions. Everything else in this guide (steps 1-3) remains the same. - - -*** - -That's it! You now hold the future Smart Contract Account address. You can fund it immediately or store it for later onboarding. diff --git a/content/wallets/pages/recipes/programmatic-wallet-creation.mdx b/content/wallets/pages/recipes/programmatic-wallet-creation.mdx index 2692c9dec..12214c67f 100644 --- a/content/wallets/pages/recipes/programmatic-wallet-creation.mdx +++ b/content/wallets/pages/recipes/programmatic-wallet-creation.mdx @@ -4,6 +4,8 @@ description: Generate a signer, initialize a Smart Wallet Client, sponsor gas wi slug: wallets/recipes/programmatic-wallet-creation --- +`@alchemy/wallet-apis` (v5.x.x) is currently in beta but is the recommended replacement for `@account-kit/wallet-client` (v4.x.x). If you run into any issues, please [reach out](mailto:support@alchemy.com). + This recipe shows how to programmatically create a smart wallet: you’ll generate a signer, spin up a Smart Wallet Client, read the counterfactual address before deployment and deploy the wallet by sending your first gas sponsored `UserOperation` (prepared → signed → sent). @@ -11,13 +13,13 @@ This recipe shows how to programmatically create a smart wallet: you’ll genera You'll need the following packages for this recipe: * **@account-kit/signer**: Server wallet signer and access key generation - * **@account-kit/infra**: Alchemy transport & chain constants (e.g., `arbitrumSepolia`) - * **@account-kit/wallet-client**: Smart Wallet Client (prepare/sign/send flows) + * **@alchemy/wallet-apis**: Smart Wallet Client (prepare/sign/send flows) + * **viem**: Chain definitions and utilities * **dotenv**: Read .env for your API key & policy id * **typescript + tsx + @types/node**: Run TypeScript files directly ```bash - npm i @account-kit/signer @account-kit/infra @account-kit/wallet-client dotenv + npm i @account-kit/signer @alchemy/wallet-apis viem dotenv npm i -D typescript tsx @types/node ``` @@ -81,13 +83,11 @@ This recipe shows how to programmatically create a smart wallet: you’ll genera ```ts - import { createSmartWalletClient } from "@account-kit/wallet-client"; - import { alchemy, arbitrumSepolia } from "@account-kit/infra"; - - const transport = alchemy({ apiKey: process.env.ALCHEMY_API_KEY! }); + import { createSmartWalletClient, alchemyWalletTransport } from "@alchemy/wallet-apis"; + import { arbitrumSepolia } from "viem/chains"; const client = createSmartWalletClient({ - transport, + transport: alchemyWalletTransport({ apiKey: process.env.ALCHEMY_API_KEY! }), chain: arbitrumSepolia, signer, }); @@ -105,24 +105,24 @@ This recipe shows how to programmatically create a smart wallet: you’ll genera - Use the **capabilities** pipeline with `paymasterService` to sponsor gas via your policy and deploy the account contract by sending a gas sponsored UserOperation. + Use the **capabilities** pipeline with `paymaster` to sponsor gas via your policy and deploy the account contract by sending a gas sponsored UserOperation. ```ts const prepared = await client.prepareCalls({ - from: address, + account: address, calls: [ { to: "0x0000000000000000000000000000000000000000", data: "0x", - value: "0x0", + value: BigInt(0), }, ], // minimal call to deploy the account contract capabilities: { - paymasterService: { policyId: process.env.ALCHEMY_POLICY_ID! }, + paymaster: { policyId: process.env.ALCHEMY_POLICY_ID! }, }, }); - const signed = await client.signPreparedCalls(prepared); + const signed = await client.signPreparedCalls(prepared); // signed by the signer on the client const sent = await client.sendPreparedCalls(signed); const txHash = await client.waitForCallsStatus({ id: sent.id }); @@ -131,7 +131,7 @@ This recipe shows how to programmatically create a smart wallet: you’ll genera ``` - For non-sponsored path, remove the `paymasterService` capability in + For non-sponsored path, remove the `paymaster` capability in `prepareCalls` and **fund the account** to pay gas. The rest of the flow is unchanged. @@ -141,8 +141,8 @@ This recipe shows how to programmatically create a smart wallet: you’ll genera ```ts provision.ts import "dotenv/config"; import { createServerSigner } from "@account-kit/signer"; - import { createSmartWalletClient } from "@account-kit/wallet-client"; - import { alchemy, arbitrumSepolia } from "@account-kit/infra"; + import { createSmartWalletClient, alchemyWalletTransport } from "@alchemy/wallet-apis"; + import { arbitrumSepolia } from "viem/chains"; const ALCHEMY_API_KEY = process.env.ALCHEMY_API_KEY!; const ALCHEMY_POLICY_ID = process.env.ALCHEMY_POLICY_ID!; @@ -163,10 +163,9 @@ This recipe shows how to programmatically create a smart wallet: you’ll genera }, }); - // 2) Transport + Smart Wallet Client - const transport = alchemy({ apiKey: ALCHEMY_API_KEY }); + // 2) Smart Wallet Client const client = createSmartWalletClient({ - transport, + transport: alchemyWalletTransport({ apiKey: ALCHEMY_API_KEY }), chain: arbitrumSepolia, signer, }); @@ -178,20 +177,20 @@ This recipe shows how to programmatically create a smart wallet: you’ll genera // 4) Prepare → sign → send (sponsored) to trigger deployment const prepared = await client.prepareCalls({ - from: address, + account: address, calls: [ { to: "0x0000000000000000000000000000000000000000", data: "0x", - value: "0x0", + value: BigInt(0), }, ], // minimal call to deploy the account contract capabilities: { - paymasterService: { policyId: ALCHEMY_POLICY_ID }, + paymaster: { policyId: ALCHEMY_POLICY_ID }, }, }); - const signed = await client.signPreparedCalls(prepared); + const signed = await client.signPreparedCalls(prepared); // signed by the signer on the client const sent = await client.sendPreparedCalls(signed); // 5) Wait for inclusion → tx hash @@ -221,7 +220,7 @@ This recipe shows how to programmatically create a smart wallet: you’ll genera ```bash # one-time per project - npm i @account-kit/signer @account-kit/infra @account-kit/wallet-client dotenv + npm i @account-kit/signer @alchemy/wallet-apis viem dotenv npm i -D typescript tsx @types/node # then run diff --git a/content/wallets/pages/recipes/smart-wallets-aave.mdx b/content/wallets/pages/recipes/smart-wallets-aave.mdx index 5f8f559ab..83d05d7b1 100644 --- a/content/wallets/pages/recipes/smart-wallets-aave.mdx +++ b/content/wallets/pages/recipes/smart-wallets-aave.mdx @@ -7,6 +7,8 @@ description: >- slug: wallets/recipes/smart-wallets-aave --- +`@alchemy/wallet-apis` (v5.x.x) is currently in beta but is the recommended replacement for `@account-kit/wallet-client` (v4.x.x). If you run into any issues, please [reach out](mailto:support@alchemy.com). + Learn how to build DeFi applications that interact with Aave using Alchemy Smart Wallets. This recipe covers supplying and withdrawing assets with both [our Core library](/docs/wallets/reference/aa-sdk/core) and our [Wallet APIs](/docs/wallets/api-reference/smart-wallets/wallet-api-endpoints/wallet-api-endpoints/wallet-request-account) for seamless user experiences. ## Prerequisites @@ -251,23 +253,21 @@ Check out this video walkthrough, and follow along with the quick start below: ``` - + This approach uses the higher-level wallet-client API with explicit prepare/sign/send workflow for Aave interactions. ```typescript - import { createSmartWalletClient } from "@account-kit/wallet-client"; - import { alchemy, arbitrum } from "@account-kit/infra"; - import { LocalAccountSigner } from "@aa-sdk/core"; + import { createSmartWalletClient, alchemyWalletTransport } from "@alchemy/wallet-apis"; + import { arbitrum } from "viem/chains"; + import { privateKeyToAccount } from "viem/accounts"; // Setup smart wallet client const smartWalletClient = createSmartWalletClient({ - signer: LocalAccountSigner.privateKeyToAccountSigner(privateKey), + signer: privateKeyToAccount(privateKey), chain: arbitrum, - transport: alchemy({ apiKey: alchemyApiKey }), + transport: alchemyWalletTransport({ apiKey: alchemyApiKey }), }); - const account = await smartWalletClient.requestAccount(); - // Get Aave operation data (supply/withdraw) const aaveData = await getAaveOperationData(); // implementation same as Core approach @@ -282,29 +282,28 @@ Check out this video walkthrough, and follow along with the quick start below: calls.push({ to: aaveData.originalTransaction.to, data: aaveData.originalTransaction.data, - value: toHex(BigInt(aaveData.originalTransaction.value)), + value: BigInt(aaveData.originalTransaction.value), }); } else if (aaveData.__typename === "TransactionRequest") { // For direct operations (withdrawals, approved supplies) calls.push({ to: aaveData.to, data: aaveData.data, - value: toHex(BigInt(aaveData.value)), + value: BigInt(aaveData.value), }); } // Prepare, sign, and send with gas sponsorship const preparedCalls = await smartWalletClient.prepareCalls({ calls, - from: account.address, capabilities: { - paymasterService: { + paymaster: { policyId: policyId, // Gas sponsorship }, }, }); - const signedCalls = await smartWalletClient.signPreparedCalls(preparedCalls); + const signedCalls = await smartWalletClient.signPreparedCalls(preparedCalls); // signed by the signer on the client const result = await smartWalletClient.sendPreparedCalls(signedCalls); console.log( diff --git a/content/wallets/pages/resources/migration-v5.mdx b/content/wallets/pages/resources/migration-v5.mdx new file mode 100644 index 000000000..d792b6f52 --- /dev/null +++ b/content/wallets/pages/resources/migration-v5.mdx @@ -0,0 +1,114 @@ +--- +title: Migrating to 5.x.x +description: Migration guide from @account-kit/wallet-client (v4) to @alchemy/wallet-apis (v5) +slug: wallets/resources/migration-v5 +--- + +`@alchemy/wallet-apis` (v5.x.x) is currently in beta but is the recommended replacement for `@account-kit/wallet-client` (v4.x.x). If you run into any issues, please [reach out](mailto:support@alchemy.com). + +`@account-kit/wallet-client` is now `@alchemy/wallet-apis`. This guide covers what changed and how to migrate. + +## Installation + +```bash +npm install @alchemy/wallet-apis viem +``` + +Replaces `@account-kit/wallet-client`, `@account-kit/infra`, and `@aa-sdk/core`. + +## Key changes + +* **Chains** come from `viem/chains` +* **Signers** use viem-native types (`LocalAccount` or `WalletClient`) +* **Values** are bigints instead of hex strings (`BigInt(0)` instead of `"0x00"`) + +## EIP-7702 by default + +The client defaults to EIP-7702. For 7702 accounts, you no longer need to call `requestAccount()` before sending transactions. + +**Before:** + +```ts +const clientWithoutAccount = createSmartWalletClient({ + transport: alchemy({ apiKey }), + chain: sepolia, + signer, +}); + +const account = await clientWithoutAccount.requestAccount({accountType: "7702"}); + +const client = createSmartWalletClient({ + transport: alchemy({ apiKey }), + chain: sepolia, + signer, + account: account.address, +}); + +await client.sendCalls({ + from: account.address, + calls: [{ to: "0x...", value: "0x0" }], +}); +``` + +**After:** + +```ts +const client = createSmartWalletClient({ + transport: alchemyWalletTransport({ apiKey }), + chain: sepolia, + signer: privateKeyToAccount(PRIVATE_KEY), +}); + +await client.sendCalls({ + calls: [{ to: "0x...", value: BigInt(0) }], +}); +``` + +* No `requestAccount()` needed — call `sendCalls` / `prepareCalls` directly +* No `from` or `account` params needed — defaults to signer address +* No `eip7702Auth: true` capability — 7702 is the default +* `requestAccount()` is still available for [non-7702 smart contract accounts](/docs/wallets/transactions/using-eip-7702#how-to-use-non-7702-mode) + + + Values are now bigints instead of hex strings (`BigInt(0)` instead of `"0x00"`). You can also use the `0n` literal syntax if your TypeScript config targets ES2020 or later. + + +## Paymaster configuration + +`paymasterService` → `paymaster`, `policyId` (top-level) → `paymaster: { policyId }`: + +```ts +const client = createSmartWalletClient({ + // ... + paymaster: { policyId: "your-policy-id" }, +}); +``` + +Can also be passed per-call via `capabilities.paymaster`. Supports both `policyId` and `policyIds`. + +## Third-party signers + +The `WalletClientSigner` wrapper is removed. Pass a viem `WalletClient` or `LocalAccount` directly: + +```ts +// Before (v4) +const signer = new WalletClientSigner(walletClient, "my-wallet"); +const client = createSmartWalletClient({ signer, ... }); + +// After (v5) — no wrapper needed +const client = createSmartWalletClient({ + signer: walletClient, // viem WalletClient or LocalAccount + ... +}); +``` + +## Import changes + +| Before | After | +|---|---| +| `import { createSmartWalletClient } from "@account-kit/wallet-client"` | `import { createSmartWalletClient } from "@alchemy/wallet-apis"` | +| `import { alchemy, sepolia } from "@account-kit/infra"` | `import { alchemyWalletTransport } from "@alchemy/wallet-apis"` + `import { sepolia } from "viem/chains"` | +| `import { LocalAccountSigner } from "@aa-sdk/core"` | `import { privateKeyToAccount } from "viem/accounts"` | +| `import { WalletClientSigner } from "@aa-sdk/core"` | *(remove — pass `WalletClient` directly as signer)* | +| `import { swapActions } from "@account-kit/wallet-client/experimental"` | `import { swapActions } from "@alchemy/wallet-apis/experimental"` | +| `import { type SmartWalletClientParams } from "@account-kit/wallet-client"` | `import { type CreateSmartWalletClientParams } from "@alchemy/wallet-apis"` | diff --git a/content/wallets/pages/signer/authentication/server-wallets.mdx b/content/wallets/pages/signer/authentication/server-wallets.mdx index 3ad8aed7a..fc05ade3b 100644 --- a/content/wallets/pages/signer/authentication/server-wallets.mdx +++ b/content/wallets/pages/signer/authentication/server-wallets.mdx @@ -4,6 +4,8 @@ description: Control wallets programmatically using access keys slug: wallets/authentication/login-methods/server-wallets --- +`@alchemy/wallet-apis` (v5.x.x) is currently in beta but is the recommended replacement for `@account-kit/wallet-client` (v4.x.x). If you run into any issues, please [reach out](mailto:support@alchemy.com). + Server wallets are in early access and we'd love to hear how you're using them! Contact us at wallets@alchemy.com - we'd love to help you get up and @@ -111,33 +113,28 @@ We can now send transactions using the Smart Account Client: ```ts twoslash evm.ts -import { createSmartWalletClient } from "@account-kit/wallet-client"; -import { alchemy, baseSepolia } from "@account-kit/infra"; +import { createSmartWalletClient, alchemyWalletTransport } from "@alchemy/wallet-apis"; +import { baseSepolia } from "viem/chains"; -// Create Smart Account Client using the signer from Step 2 +// Create Smart Wallet Client using the signer from Step 2 const client = createSmartWalletClient({ - transport: alchemy({ + transport: alchemyWalletTransport({ apiKey: "your-alchemy-api-key", }), chain: baseSepolia, signer, - policyId: "your-sponsor-gas-policy-id", // Make sure enabled on Base Sepolia + paymaster: { policyId: "your-sponsor-gas-policy-id" }, // Make sure enabled on Base Sepolia }); -// Retrieve account -const account = await client.requestAccount(); -console.log("Smart account address:", account.address); - -// Send a transaction +// Send a sponsored transaction const { id } = await client.sendCalls({ calls: [ { to: "0x1234567890123456789012345678901234567890", - value: "0x0", + value: BigInt(0), data: "0x", }, ], - from: account.address, }); console.log("Transaction sent:", id); ``` diff --git a/content/wallets/pages/smart-wallets/quickstart/api.mdx b/content/wallets/pages/smart-wallets/quickstart/api.mdx index 91ed7dbc5..abe29a99b 100644 --- a/content/wallets/pages/smart-wallets/quickstart/api.mdx +++ b/content/wallets/pages/smart-wallets/quickstart/api.mdx @@ -1,10 +1,3 @@ ---- -title: Wallets API Quickstart (API) -subtitle: Learn to interact with Wallet APIs using any RPC client -url: https://www.alchemy.com/docs/wallets/smart-wallet-quickstart/api -slug: wallets/smart-wallet-quickstart/api ---- - We'll demonstrate how to use the [`wallet_prepareCalls`](/docs/wallets/api/smart-wallets/wallet-api-endpoints/wallet-api-endpoints/wallet-prepare-calls), [`wallet_sendPreparedCalls`](/docs/wallets/api/smart-wallets/wallet-api-endpoints/wallet-api-endpoints/wallet-send-prepared-calls), and [`wallet_getCallsStatus`](/docs/wallets/api/smart-wallets/wallet-api-endpoints/wallet-api-endpoints/wallet-get-calls-status) endpoints. diff --git a/content/wallets/pages/smart-wallets/quickstart/index.mdx b/content/wallets/pages/smart-wallets/quickstart/index.mdx index 8ad22826d..655445606 100644 --- a/content/wallets/pages/smart-wallets/quickstart/index.mdx +++ b/content/wallets/pages/smart-wallets/quickstart/index.mdx @@ -1,5 +1,5 @@ --- -title: Wallets API Quickstart +title: Transaction SDK Quickstart description: How to go from zero to hero with Wallet APIs subtitle: Learn to interact with Wallet APIs url: https://alchemy.com/docs/wallets/reference/smart-wallet-quickstart @@ -11,27 +11,20 @@ This quickstart shows you how to prepare and send a User Operation (UO) in minut To use this guide, you'll need: * An account you can sign with (e.g. an [Alchemy Signer](/docs/wallets/signer/what-is-a-signer#alchemy-signer) or an EOA) -* An Alchemy API key -* A [gas manager policy ID](/docs/wallets/transactions/sponsor-gas) if sponsoring gas +* An Alchemy API key — [create an app](https://dashboard.alchemy.com/apps) to get one +* A [gas manager policy ID](https://dashboard.alchemy.com/gas-manager/policy/create) if sponsoring gas Start using the Alchemy Wallets API today! [Get started for free](https://dashboard.alchemy.com/signup/?a=f8afc2202c). -You can complete this tutorial using either the [TypeScript SDK](/docs/wallets/smart-wallet-quickstart/sdk) or raw [JSON-RPC APIs](/docs/wallets/smart-wallet-quickstart/api). + + + + - - - Start building in minutes using the TypeScript SDK. - - - - Integrate with any RPC client using the JSON-RPC APIs. - - - - - Want to use EIP-7702? Check out the [7702 - Quickstart](/docs/wallets/transactions/using-eip-7702) instead. - + + + + diff --git a/content/wallets/pages/smart-wallets/quickstart/sdk.mdx b/content/wallets/pages/smart-wallets/quickstart/sdk.mdx index 1107f0d5b..cc787d8fe 100644 --- a/content/wallets/pages/smart-wallets/quickstart/sdk.mdx +++ b/content/wallets/pages/smart-wallets/quickstart/sdk.mdx @@ -1,115 +1,77 @@ ---- -title: Wallets API Quickstart (SDK) -subtitle: Learn to interact with Wallet APIs using the Wallet Client SDK -url: https://www.alchemy.com/docs/wallets/smart-wallet-quickstart/sdk -slug: wallets/smart-wallet-quickstart/sdk ---- + + [`@alchemy/wallet-apis`](https://github.com/alchemyplatform/aa-sdk/tree/v5.x.x/packages/wallet-apis) (v5.x.x) is the recommended SDK and is currently in beta. If you're still on v4.x.x, see the [migration guide](/docs/wallets/resources/migration-v5). + -### 1. Install Prerequisities +### 1. Install -You're going to need `@account-kit/wallet-client`, `@account-kit/infra`, optionally `@aa-sdk/core` if you use a `LocalAccountSigner`, and optionally `viem` if you want to verify a signed message. +You're going to need `@alchemy/wallet-apis` and `viem`. ```shell npm -npm install @account-kit/wallet-client @account-kit/infra @aa-sdk/core +npm install @alchemy/wallet-apis viem ``` ```shell bun -bun add @account-kit/wallet-client @account-kit/infra @aa-sdk/core +bun add @alchemy/wallet-apis viem ``` ```shell yarn -yarn add @account-kit/wallet-client @account-kit/infra @aa-sdk/core +yarn add @alchemy/wallet-apis viem +``` + +```shell pnpm +pnpm add @alchemy/wallet-apis viem ``` -### 2. Create A Smart Account Client +### 2. Create a client -Given a signer (e.g. a `LocalAccountSigner` imported from `@aa-sdk/core` or an [Alchemy Signer](/docs/wallets/signer/what-is-a-signer#alchemy-signer)), all you need to do is follow a few simple steps to start sending user ops with Wallet APIs! +This quickstart uses a local private key signer as an example. You can use any [viem-compatible signer](/docs/wallets/third-party/signers/custom-integration), including providers like [Privy](/docs/wallets/third-party/signers/privy) and [Turnkey](/docs/wallets/third-party/signers/turnkey). ```ts -import { createSmartWalletClient } from "@account-kit/wallet-client"; -import { alchemy, arbitrumSepolia } from "@account-kit/infra"; -import { LocalAccountSigner } from "@aa-sdk/core"; - -const signer = LocalAccountSigner.privateKeyToAccountSigner(PRIVATE_KEY); // we use a private key signer as an example here - -const transport = alchemy({ - apiKey: ALCHEMY_API_KEY, // use your Alchemy app api key here! -}); +import { createSmartWalletClient, alchemyWalletTransport } from "@alchemy/wallet-apis"; +import { arbitrumSepolia } from "viem/chains"; +import { privateKeyToAccount } from "viem/accounts"; const client = createSmartWalletClient({ - transport, - chain: arbitrumSepolia, // use any chain imported from @account-kit/infra here! - signer, + transport: alchemyWalletTransport({ + apiKey: "YOUR_API_KEY", + }), + chain: arbitrumSepolia, + signer: privateKeyToAccount("0xYOUR_PRIVATE_KEY" as const), + paymaster: { + policyId: "YOUR_POLICY_ID", + }, }); ``` -### 3. Send A UserOp +### 3. Send a sponsored transaction -Use your signer address directly as the `from` field to enable [EIP-7702](/docs/wallets/transactions/using-eip-7702) by default. This first transaction will delegate your account. +The client defaults to [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. ```ts import { zeroAddress } from "viem"; -const signerAddress = await signer.getAddress(); - -const preparedCalls = await client.prepareCalls({ - calls: [{ to: zeroAddress, value: "0x0" }], // callData is optional in a "data" parameter - from: signerAddress, - // "capabilities" is a data structure that hold gas manager data (as seen below) or permission data - capabilities: { - paymasterService: { - policyId: GAS_MANAGER_POLICY_ID, // put your gas manager policy ID here - }, - }, +const { id } = await client.sendCalls({ + calls: [{ to: zeroAddress, value: BigInt(0) }], }); - -// Sign the calls (handles both authorization and user operation if account isn't delegated yet) -const signedCalls = await client.signPreparedCalls(preparedCalls); - -// Send the userOp -const result = await client.sendPreparedCalls(signedCalls); - -// Check calls status. -const status = await client.getCallsStatus(result.id); ``` -### 4. Sign A Message - -Once your account is delegated, you can sign messages. +### 4. Wait for the transaction to be confirmed ```ts -import { createPublicClient } from "viem"; - -const signerAddress = await signer.getAddress(); - -const message = "we are so back"; - -const signature = await client.signMessage({ message, account: signerAddress }); - -const publicClient = createPublicClient({ - chain: arbitrumSepolia, - transport: transport, -}); - -const isValid = await publicClient.verifyMessage({ - address: signerAddress, - message, - signature, -}); +const status = await client.waitForCallsStatus({ id }); +const txHash = status.receipts?.[0]?.transactionHash; +console.log(`Explorer: https://sepolia.arbiscan.io/tx/${txHash}`); ``` -### 5. Sign Typed Data + -```ts -// assuming you have a typedData variable -const signature = await client.signTypedData({ typedData, account: signerAddress }); +### Next steps -const isValid = await publicClient.verifyTypedData({ - address: signerAddress, - ...typedData, - signature, -}); -``` +* [Bring your own signer](/docs/wallets/third-party/signers/custom-integration) +* [Refine your gas sponsorship rules](/docs/wallets/transactions/sponsor-gas/conditional-sponsorship-rules) +* [Sign messages](/docs/wallets/transactions/signing/sign-messages) +* [Sign typed data](/docs/wallets/transactions/signing/sign-typed-data) +* [Batch transactions](/docs/wallets/transactions/send-batch-transactions) diff --git a/content/wallets/pages/smart-wallets/session-keys/index.mdx b/content/wallets/pages/smart-wallets/session-keys/index.mdx index 7da2b5580..a90cdd9f2 100644 --- a/content/wallets/pages/smart-wallets/session-keys/index.mdx +++ b/content/wallets/pages/smart-wallets/session-keys/index.mdx @@ -37,16 +37,16 @@ We'll demonstrate how to create and use session keys [using the SDK client](/doc To specify permissions during a session key installation, include them in the `permissions` array when calling `client.grantPermission()` via the SDK or `wallet_createSession` via the API. ```ts -const signerAddress = await signer.getAddress(); - +// See the SDK or API guide above for full client and session key setup const permissions = await client.grantPermissions({ - account: signerAddress, expirySec: Math.floor(Date.now() / 1000) + 60 * 60, key: { - publicKey: await sessionKey.getAddress(), + publicKey: sessionKey.address, type: "secp256k1", }, - permissions: [{ PERMISSION_ONE }, { PERMISSION_TWO }], + permissions: [ + // Add one or more permission types (see below) + ], }); ``` diff --git a/content/wallets/pages/smart-wallets/session-keys/sdk.mdx b/content/wallets/pages/smart-wallets/session-keys/sdk.mdx index 51444acd2..2a55e7e9f 100644 --- a/content/wallets/pages/smart-wallets/session-keys/sdk.mdx +++ b/content/wallets/pages/smart-wallets/session-keys/sdk.mdx @@ -5,48 +5,46 @@ url: https://alchemy.com/docs/wallets/reference/wallet-apis-session-keys/sdk slug: wallets/reference/wallet-apis-session-keys/sdk --- -### 1. Install Prerequisites +`@alchemy/wallet-apis` (v5.x.x) is currently in beta but is the recommended replacement for `@account-kit/wallet-client` (v4.x.x). If you run into any issues, please [reach out](mailto:support@alchemy.com). -You're going to need the `@account-kit/wallet-client` and `@account-kit/infra`. We'll also be using `LocalAccountSigner` from `@aa-sdk/core` as the signer for demonstration purposes. +### 1. Install + +You're going to need `@alchemy/wallet-apis` and `viem`. We'll use `privateKeyToAccount` from `viem/accounts` as the signer for demonstration purposes. ```shell npm -npm install @account-kit/wallet-client @account-kit/infra @aa-sdk/core +npm install @alchemy/wallet-apis viem ``` ```shell bun -bun add @account-kit/wallet-client @account-kit/infra @aa-sdk/core +bun add @alchemy/wallet-apis viem ``` ```shell yarn -yarn add @account-kit/wallet-client @account-kit/infra @aa-sdk/core +yarn add @alchemy/wallet-apis viem ``` ```shell pnpm -pnpm install @account-kit/wallet-client @account-kit/infra @aa-sdk/core +pnpm install @alchemy/wallet-apis viem ``` ### 2. Create A Smart Wallet Client -Create a client for a given signer (e.g. a `LocalAccountSigner` imported from `@aa-sdk/core` or an [Alchemy Signer](/docs/wallets/signer/what-is-a-signer#alchemy-signer)). +Create a client for a given signer (e.g. using `privateKeyToAccount` from `viem/accounts`). ```ts -import { createSmartWalletClient } from "@account-kit/wallet-client"; -import { alchemy, arbitrumSepolia } from "@account-kit/infra"; -import { LocalAccountSigner } from "@aa-sdk/core"; - -const signer = LocalAccountSigner.privateKeyToAccountSigner(PRIVATE_KEY); // we use a private key signer as an example here - -const transport = alchemy({ - apiKey: ALCHEMY_API_KEY, // use your Alchemy app api key here -}); +import { privateKeyToAccount } from "viem/accounts"; +import { arbitrumSepolia } from "viem/chains"; +import { createSmartWalletClient, alchemyWalletTransport } from "@alchemy/wallet-apis"; const client = createSmartWalletClient({ - transport, - chain: arbitrumSepolia, // use any chain imported from @account-kit/infra here - signer, + transport: alchemyWalletTransport({ + apiKey: "YOUR_API_KEY", + }), + chain: arbitrumSepolia, + signer: privateKeyToAccount("0xYOUR_PRIVATE_KEY" as const), }); ``` @@ -60,23 +58,11 @@ any calls before creating the session key, you can delegate it by sending an empty call as the owner: ```ts -const signerAddress = await signer.getAddress(); - -const preparedCalls = await client.prepareCalls({ - calls: [], // empty array since you don't want to send any calls - from: signerAddress, - capabilities: { - paymasterService: { - policyId: GAS_MANAGER_POLICY_ID, // put your gas manager policy ID here - }, - }, +const { id } = await client.sendCalls({ + calls: [], // empty array since you just want to delegate }); -const signedCalls = await client.signPreparedCalls(preparedCalls); - -const { id } = await client.sendPreparedCalls(signedCalls); - -const status = await client.getCallsStatus(id); +await client.waitForCallsStatus({ id }); ``` Now you can continue to create the session key as described below. @@ -84,16 +70,16 @@ Now you can continue to create the session key as described below. ```ts -const signerAddress = await signer.getAddress(); +import { generatePrivateKey, privateKeyToAccount } from "viem/accounts"; -// This is where you would use your session key signer! -const sessionKey = LocalAccountSigner.generatePrivateKeySigner(); +// This is where you would use your session key signer +const sessionKeyPrivateKey = generatePrivateKey(); +const sessionKey = privateKeyToAccount(sessionKeyPrivateKey); const permissions = await client.grantPermissions({ - account: signerAddress, expirySec: Math.floor(Date.now() / 1000) + 60 * 60, key: { - publicKey: await sessionKey.getAddress(), + publicKey: sessionKey.address, type: "secp256k1", }, permissions: [{ type: "root" }], // Here we grant root permissions as an example, but this is not advised in production! @@ -103,31 +89,26 @@ const permissions = await client.grantPermissions({ ### 4. Send calls using the session key ```ts -import { signPreparedCalls } from "@account-kit/wallet-client"; - -const preparedCalls = await client.prepareCalls({ - calls: [{ to: "0x0000000000000000000000000000000000000000", value: "0x0" }], - from: signerAddress, - capabilities: { - paymasterService: { - policyId: GAS_MANAGER_POLICY_ID, // put your gas manager policy ID here - }, - permissions, - }, +import { createSmartWalletClient, alchemyWalletTransport } from "@alchemy/wallet-apis"; + +// Create a client with the session key as signer +const sessionKeyClient = createSmartWalletClient({ + transport: alchemyWalletTransport({ + apiKey: "YOUR_API_KEY", + }), + chain: arbitrumSepolia, + signer: sessionKey, // Use the session key as signer + account: client.account.address, // The original account that granted permissions }); -const signedCalls = await signPreparedCalls( - sessionKey, // Note that we now sign with the session key! - preparedCalls, -); - -const { id } = await client.sendPreparedCalls({ - ...signedCalls, +const { id } = await sessionKeyClient.sendCalls({ + calls: [{ to: "0x0000000000000000000000000000000000000000", value: BigInt(0) }], capabilities: { permissions, }, }); -// Check calls status. -const status = await client.getCallsStatus(id); +await sessionKeyClient.waitForCallsStatus({ id }); ``` + + diff --git a/content/wallets/pages/third-party/signers/custom-integration.mdx b/content/wallets/pages/third-party/signers/custom-integration.mdx index fffbdd31b..89e560d1b 100644 --- a/content/wallets/pages/third-party/signers/custom-integration.mdx +++ b/content/wallets/pages/third-party/signers/custom-integration.mdx @@ -1,185 +1,133 @@ --- -title: Custom Integration -description: Bring your own signer to Alchemy Smart Wallets via EIP-7702 +title: Bring your own signer +description: Use any viem-compatible signer with Alchemy Smart Wallets slug: wallets/third-party/signers/custom-integration --- -If you have an existing custom signer or another third-party embedded wallet provider, you can upgrade your embedded EOAs to smart wallets by connecting your existing signer. -This will allow you to use EIP-7702 to get features like gas sponsorship, batching, and more. - - - **Requirement:** Your signer or embedded wallet provider must support signing - EIP-7702 authorizations in order to delegate to a smart account. - - -To bring your own signer, you create a `SmartAccountSigner` that implements `signAuthorization`. See the details for the interface requirements [here](/docs/wallets/resources/types#smartaccountsigner). - - - - For example, you can upgrade an existing embedded EOA by extending a viem `WalletClient` to use your provider's EIP-7702 authorization signing. - - The bulk of the logic happens in a function that returns a client. Your embedded wallet is wrapped in a `WalletClientSigner` that supports `signAuthorization`, then passed to `createSmartWalletClient` to construct a client for sending transactions. - - Steps: - - 1. Wrap your embedded wallet with `WalletClientSigner` that implements `signAuthorization`. - 2. Create a `SmartWalletClient` with your signer and Alchemy API key (optionally a gas `policyId`). - 3. Send calls with `eip7702Auth: true` (and optional `paymasterService.policyId`). - - - -```ts twoslash title="create-smart-embedded-wallet-client.ts" -import { - type Address, - type Authorization, - createWalletClient, - custom, - type EIP1193Provider, -} from "viem"; -import { type AuthorizationRequest, WalletClientSigner } from "@aa-sdk/core"; -import { baseSepolia, alchemy } from "@account-kit/infra"; -import { - createSmartWalletClient, - type SmartWalletClient, -} from "@account-kit/wallet-client"; - -export type EmbeddedWallet = { - address: string; - getEthereumProvider: () => Promise; -}; - -export type SignAuthorizationFn = ( - req: AuthorizationRequest & { contractAddress?: string }, -) => Promise<{ r: string; s: string; yParity: number }>; - -export type CreateSmartWalletParams = { - embeddedWallet: EmbeddedWallet; - signAuthorization: SignAuthorizationFn; - apiKey: string; - policyId?: string; -}; - -/** - * Creates an Alchemy Smart Wallet client for a generic embedded wallet using EIP-7702. - */ -export async function createSmartEmbeddedWalletClient({ - embeddedWallet, - signAuthorization, - apiKey, - policyId, -}: CreateSmartWalletParams): Promise { - if (!apiKey) { - throw new Error("Missing Alchemy API key"); - } - const provider = await embeddedWallet.getEthereumProvider(); - - const baseSigner = new WalletClientSigner( - createWalletClient({ - account: embeddedWallet.address as Address, - chain: baseSepolia, - transport: custom(provider), - }), - "custom", - ); - - const signer = { - ...baseSigner, - async signAuthorization( - unsignedAuth: AuthorizationRequest, - ): Promise> { - const { address, ...rest } = unsignedAuth; - const signature = await signAuthorization({ - ...rest, - contractAddress: (address ?? rest.contractAddress) as `0x${string}`, - }); - - return { - ...unsignedAuth, - ...signature, - } as Authorization; - }, - }; - - return createSmartWalletClient({ - chain: baseSepolia, - transport: alchemy({ apiKey }), - signer, - policyId, - }); -} +`@alchemy/wallet-apis` (v5.x.x) is currently in beta but is the recommended replacement for `@account-kit/wallet-client` (v4.x.x). If you run into any issues, please [reach out](mailto:support@alchemy.com). + +Any signer that provides a viem `LocalAccount` or `WalletClient` works with `createSmartWalletClient`. This guide covers the requirements and how to set up each type. + +## Signer requirements + +Your signer must implement: + +| Property | Required | Purpose | +|---|---|---| +| `address` | Yes | The signer's Ethereum address | +| `signMessage` | Yes | Signs plaintext and raw messages (EIP-191) | +| `signTypedData` | Yes | Signs structured data (EIP-712) | +| `signAuthorization` | Yes (for EIP-7702) | Signs the EIP-7702 delegation authorization | + +`signAuthorization` is required for [EIP-7702](/docs/wallets/transactions/using-eip-7702), which is the default mode. If your signer doesn't support it, you can use [non-7702 mode](/docs/wallets/transactions/using-eip-7702#how-to-use-non-7702-mode) instead. + +## Option 1: `LocalAccount` (recommended) + +Use a `LocalAccount` when your signer gives you direct access to a private key or a signing function. This is the recommended approach because it provides the `signAuthorization` interface needed for EIP-7702 delegation. + +```ts +import { toAccount } from "viem/accounts"; +import { arbitrumSepolia } from "viem/chains"; +import { createSmartWalletClient, alchemyWalletTransport } from "@alchemy/wallet-apis"; + +const account = toAccount({ + address: "0xYOUR_SIGNER_ADDRESS", + + async signMessage({ message }) { + // delegate to your signer + }, + + async signTypedData(typedData) { + // delegate to your signer + }, + + async signTransaction(transaction) { + // unused by the Smart Wallet client + throw new Error("signTransaction is not implemented"); + }, + + async signAuthorization(unsignedAuth) { + // required for EIP-7702 delegation + // delegate to your signer and return { ...unsignedAuth, r, s, yParity } + }, +}); + +const client = createSmartWalletClient({ + signer: account, + transport: alchemyWalletTransport({ apiKey: "YOUR_ALCHEMY_API_KEY" }), + chain: arbitrumSepolia, +}); ``` - - - When using the `SmartWalletClient` you must set the `eip7702Auth` capability to `true`: - - - -```ts twoslash title="send-with-eip7702.ts" -import type { Address, EIP1193Provider } from "viem"; -import { - createSmartEmbeddedWalletClient, - type SignAuthorizationFn, -} from "./getClient"; - -async function main() { - const embeddedWallet = - /* your embedded wallet instance */ null as unknown as { - address: string; - getEthereumProvider: () => Promise; - }; - const signAuthorization: SignAuthorizationFn = - /* your EIP-7702 sign function */ async () => { - return { r: "0x", s: "0x", yParity: 1 }; - }; - - const client = await createSmartEmbeddedWalletClient({ - embeddedWallet, - signAuthorization, - apiKey: "YOUR_ALCHEMY_API_KEY", - policyId: "YOUR_GAS_POLICY_ID", // Optional: for gas sponsorship - }); - - // Send transaction with EIP-7702 and optional gas sponsorship - const result = await client.sendCalls({ - from: embeddedWallet.address as Address, - calls: [ - { - to: "0x0000000000000000000000000000000000000000", - value: "0x0", - data: "0x", - }, - ], - capabilities: { - eip7702Auth: true, - paymasterService: { - policyId: "YOUR_GAS_POLICY_ID", - }, - }, - }); +For a private key signer, you can use viem's built-in helper which implements all methods automatically: + +```ts +import { privateKeyToAccount } from "viem/accounts"; + +const client = createSmartWalletClient({ + signer: privateKeyToAccount("0x..."), + transport: alchemyWalletTransport({ apiKey: "YOUR_ALCHEMY_API_KEY" }), + chain: arbitrumSepolia, +}); +``` + +## Option 2: `WalletClient` + +Use a `WalletClient` when your signer is a browser wallet or embedded wallet that exposes an EIP-1193 provider (e.g. `window.ethereum`). + +```ts +import { createWalletClient, custom } from "viem"; +import { arbitrumSepolia } from "viem/chains"; +import { createSmartWalletClient, alchemyWalletTransport } from "@alchemy/wallet-apis"; - if (!result.id) { - throw new Error("No call ID returned"); - } +// Create a WalletClient from the browser wallet +const [address] = await window.ethereum.request({ method: "eth_requestAccounts" }); - // Wait for transaction confirmation - const txStatus = await client.waitForCallsStatus({ - id: result.id, - timeout: 60_000, - }); +const walletClient = createWalletClient({ + account: address, + chain: arbitrumSepolia, + transport: custom(window.ethereum), +}); - const txnHash = txStatus.receipts?.[0]?.transactionHash; - if (!txnHash) { - throw new Error("Transaction hash not found in receipt"); - } +// Pass the WalletClient as the signer +const client = createSmartWalletClient({ + signer: walletClient, + transport: alchemyWalletTransport({ apiKey: "YOUR_ALCHEMY_API_KEY" }), + chain: arbitrumSepolia, + paymaster: { policyId: "YOUR_GAS_POLICY_ID" }, // optional +}); +``` + + + EIP-7702 authorization signing requires a `LocalAccount` with `signAuthorization` implemented. If your wallet doesn't support this, you may need to use [non-7702 mode](/docs/wallets/transactions/using-eip-7702#how-to-use-non-7702-mode) instead. + - console.log("Transaction confirmed:", txnHash); -} +## Sending transactions -main(); +Once you have a client, usage is the same regardless of signer type: + +```ts +const result = await client.sendCalls({ + calls: [ + { + to: "0x0000000000000000000000000000000000000000", + value: BigInt(0), + data: "0x", + }, + ], +}); + +const txStatus = await client.waitForCallsStatus({ + id: result.id, + timeout: 60_000, +}); + +console.log("Transaction confirmed:", txStatus.receipts?.[0]?.transactionHash); ``` - +## Integrations + +See full integration guides for supported providers: - - +* [Privy](/docs/wallets/third-party/signers/privy) +* [Turnkey](/docs/wallets/third-party/signers/turnkey) diff --git a/content/wallets/pages/third-party/signers/privy.mdx b/content/wallets/pages/third-party/signers/privy.mdx index 88d726cb1..d28df6bc0 100644 --- a/content/wallets/pages/third-party/signers/privy.mdx +++ b/content/wallets/pages/third-party/signers/privy.mdx @@ -1,42 +1,43 @@ --- title: Privy -description: Use Privy with Alchemy Smart Wallets for EIP-7702, sponsorship, swaps, and batching +description: Use Privy with Alchemy Smart Wallets for EIP-7702, sponsorship, and batching slug: wallets/third-party/signers/privy --- -Upgrade existing Privy wallets to Smart Wallets to enable gasless transactions (EVM & Solana), batching, token swaps, and more in under 10 minutes. Keep Privy for authentication, no wallet migration needed. Add our battle-tested transaction infrastructure using EIP-7702 to upgrade your wallets to Smart Wallets: +`@alchemy/wallet-apis` (v5.x.x) is currently in beta but is the recommended replacement for `@account-kit/wallet-client` (v4.x.x). If you run into any issues, please [reach out](mailto:support@alchemy.com). + +Upgrade existing Privy wallets to Smart Wallets to enable gasless transactions, batching, and more in under 10 minutes. Keep Privy for authentication, no wallet migration needed. Add our battle-tested transaction infrastructure using EIP-7702 to upgrade your wallets to Smart Wallets: * [#1 gas abstraction infrastructure](https://www.bundlebear.com/erc4337-bundlers/all) on the market * [370M+](https://www.bundlebear.com/erc4337-paymasters/all) sponsored transactions * 99.9% SLAs * Trusted by Worldcoin, JP Morgan, Gensyn, and more -* Solana gas sponsorship support - - - Don't have social login or a wallet set up yet? Start with the - Smart Wallet Quickstart to create one in - minutes. - ## Setup - Follow these steps to integrate Privy with Smart Wallets. + Follow these steps to use Privy signers with the Wallet Client SDK. ### Installation - ```bash - npm install @account-kit/privy-integration - # or - yarn add @account-kit/privy-integration - # or - pnpm add @account-kit/privy-integration + + ```shell npm + npm install @alchemy/wallet-apis @privy-io/react-auth viem + ``` + + ```shell bun + bun add @alchemy/wallet-apis @privy-io/react-auth viem + ``` + + ```shell yarn + yarn add @alchemy/wallet-apis @privy-io/react-auth viem ``` - - **Solana Support (Optional):** To use `useAlchemySolanaTransaction`, install `@solana/web3.js` and import from `@account-kit/privy-integration/solana`. This dependency is optional—skip it if you only need EVM features. - + ```shell pnpm + pnpm add @alchemy/wallet-apis @privy-io/react-auth viem + ``` + ### Prerequisites: Get your keys (API key, Policy ID, Privy App ID) @@ -50,571 +51,227 @@ Upgrade existing Privy wallets to Smart Wallets to enable gasless transactions ( * Create or select an app and copy the App ID - Both the Smart Wallets configuration and the gas sponsorship policy must be - linked to the application behind your Alchemy API key for sponsorship to work. + The gas sponsorship policy must be linked to the application behind your Alchemy API key for sponsorship to work. - ### 1. Add AlchemyProvider + ### 1. Configure PrivyProvider + + Wrap your app with `PrivyProvider` from `@privy-io/react-auth`: ```tsx import { PrivyProvider } from "@privy-io/react-auth"; - import { AlchemyProvider } from "@account-kit/privy-integration"; - function App() { + export function App() { return ( - - - - + + ); } ``` - Props for `AlchemyProvider`: + ### 2. Get a signer from Privy - * `apiKey` | `jwt` | `rpcUrl` (pick a valid transport config) - * `policyId` (optional) for EVM gas sponsorship - * `solanaPolicyId` (optional) for Solana gas sponsorship - * `solanaRpcUrl` (optional) for Solana RPC URL (separate from EVM) - * `disableSponsorship` (optional) to opt-out per default - * `accountAuthMode` (optional) - `'eip7702'` (default, recommended) or `'owner'` for a traditional smart account - * `walletAddress` (optional) - specify which wallet address to use if user has multiple wallets (defaults to first wallet) - - ### 2. Send Gasless Transactions + Use `toViemAccount` and `useWallets` from `@privy-io/react-auth` to convert a Privy embedded wallet into a viem `LocalAccount`: ```tsx - import { useAlchemySendTransaction } from "@account-kit/privy-integration"; + import { toViemAccount, useWallets } from "@privy-io/react-auth"; + import { useEffect, useState } from "react"; + import type { LocalAccount } from "viem"; - function SendButtons() { - const { sendTransaction, isLoading } = useAlchemySendTransaction(); + const usePrivySigner = () => { + const { + wallets: [wallet], + } = useWallets(); - const single = async () => - await sendTransaction({ to: "0x...", data: "0x...", value: "0x0" }); + const [signer, setSigner] = useState(); - const batch = async () => - await sendTransaction([ - { to: "0x...", data: "0x..." }, - { to: "0x...", data: "0x..." }, - ]); + useEffect(() => { + if (!wallet || signer) return; + toViemAccount({ wallet }).then(setSigner); + }, [wallet, signer]); - return ( - <> - - - - ); - } + return signer; + }; ``` - Control sponsorship per call: - - ```tsx - await sendTransaction({ to: "0x...", data: "0x..." }); - await sendTransaction({ to: "0x...", data: "0x..." }, { disableSponsorship: true }); - ``` + ### 3. Handle login - ### 3. Execute Token Swaps + Use `usePrivy` to manage authentication state and conditionally render your wallet UI once the user is logged in: ```tsx - import { useAlchemyPrepareSwap, useAlchemySubmitSwap } from "@account-kit/privy-integration"; + import { usePrivy } from "@privy-io/react-auth"; - function SwapButton() { - const { prepareSwap } = useAlchemyPrepareSwap(); - const { submitSwap, isLoading } = useAlchemySubmitSwap(); + function PrivyWallet() { + const { ready, authenticated, login, logout } = usePrivy(); + const signer = usePrivySigner(); - const handleSwap = async () => { - const prepared = await prepareSwap({ - fromToken: "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE", - toToken: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", // USDC on Ethereum mainnet - fromAmount: "0xde0b6b3a7640000", - }); - await submitSwap(prepared); - }; + if (!ready) return

Loading...

; - return ; - } - ``` + if (!authenticated) { + return ; + } - ### 4. Send Solana Transactions - - ```tsx - import { useAlchemySolanaTransaction } from "@account-kit/privy-integration/solana"; - - function SolanaButton() { - const { sendTransactionAsync, isPending } = useAlchemySolanaTransaction({ - rpcUrl: "https://solana-mainnet.g.alchemy.com/v2/your-api-key", - policyId: "your-solana-policy-id", // optional - }); - - const handleTransfer = async () => { - const result = await sendTransactionAsync({ - transfer: { - amount: 1_000_000_000, // 1 SOL in lamports - toAddress: "recipient-base58-address", - }, - }); - console.log("Transaction hash:", result.hash); - }; - - return ; - } - ``` - - ### Advanced: Access the Smart Wallet Client - - ```tsx - import { useAlchemyClient } from "@account-kit/privy-integration"; - - function Advanced() { - const { getClient } = useAlchemyClient(); - - const doOp = async () => { - const { client, account } = await getClient(); - await client.sendCalls({ - from: account.address, - calls: [{ to: "0x...", data: "0x" }], - capabilities: { eip7702Auth: true, paymasterService: { policyId: "your-policy-id" } }, - }); - }; - - return ; + return ( +
+ + {signer ? :

Loading signer...

} +
+ ); } ``` - ### Authorization Modes + ### 4. Create the client and send a transaction - The integration supports two modes via `accountAuthMode`: - - * **`'eip7702'` (default, recommended)**: Uses EIP-7702 to delegate the Privy wallet to a smart account. No deployment needed, funds stay at the wallet address. - * **`'owner'`**: Uses a traditional smart account with Privy wallet as owner. The smart account has a separate address. Use for environments without EIP-7702 support. + Pass the Privy signer to `createSmartWalletClient` and use it to send transactions: ```tsx - // Default (EIP-7702) - recommended - - - - - // Traditional smart account mode - - - - ``` - - **Getting the Smart Account Address (owner mode):** - - When using `owner` mode, access the smart account address (different from the Privy signer address): + import { useMemo, useCallback } from "react"; + import { zeroAddress } from "viem"; + import { createSmartWalletClient, alchemyWalletTransport } from "@alchemy/wallet-apis"; + import { arbitrumSepolia } from "viem/chains"; + + function SendTransaction({ signer }: { signer: LocalAccount }) { + const client = useMemo( + () => + createSmartWalletClient({ + signer, + transport: alchemyWalletTransport({ + apiKey: "YOUR_ALCHEMY_API_KEY", + }), + chain: arbitrumSepolia, + paymaster: { + policyId: "YOUR_GAS_MANAGER_POLICY_ID", + }, + }), + [signer], + ); - ```tsx - import { useAlchemyClient } from "@account-kit/privy-integration"; + const handleSend = useCallback(async () => { + // Send the transaction + const { id } = await client.sendCalls({ + calls: [{ to: zeroAddress, value: BigInt(0), data: "0x" }], + }); - function MyComponent() { - const { getClient } = useAlchemyClient(); + // Wait for the transaction to be confirmed + const result = await client.waitForCallsStatus({ id }); + console.log(`Transaction hash: ${result.receipts?.[0]?.transactionHash}`); + }, [client]); - const getAddress = async () => { - const { account } = await getClient(); - console.log("Smart account:", account.address); - // Different from Privy signer address in owner mode - }; + return ; } ``` ### Notes - * **EVM**: EIP-7702 (default) delegates your wallet to a smart account at send time. Alternatively, use `accountAuthMode="owner"` for a traditional smart account. - * **Solana**: Gas sponsorship via Alchemy's fee payer service for Privy's embedded Solana wallets. - * The hooks API mirrors Privy's transaction hooks for easy migration. + * The client defaults to [EIP-7702](/wallets/transactions/using-eip-7702), which delegates the Privy wallet to a smart account at send time. No deployment or wallet migration needed. See the [EIP-7702 guide](/wallets/transactions/using-eip-7702) for non-7702 mode. + * See the [Sponsor gas](/wallets/transactions/sponsor-gas) guide for more on gas sponsorship configuration. - + ## Setup - Follow these steps to integrate Privy with Smart Wallets in React Native using Expo. + Use the `@privy-io/node` package with the Wallet Client SDK in a server environment. ### Installation - ```bash - npm install @account-kit/privy-integration @privy-io/expo - # or - yarn add @account-kit/privy-integration @privy-io/expo - # or - pnpm add @account-kit/privy-integration @privy-io/expo - ``` - - ### Prerequisites: Get your keys (API key, Policy ID, Privy App ID & Client ID) - - * Alchemy API Key: - * Go to the [Alchemy Dashboard](https://dashboard.alchemy.com/) - * Create or select an app and copy the API key - * Gas sponsorship Policy ID (Gas Manager): - * Create a gas sponsorship policy in the [dashboard](https://dashboard.alchemy.com/services/gas-manager/configuration) and copy its Policy ID - * Privy App ID & Client ID: - * Go to the [Privy Dashboard](https://dashboard.privy.io/) - * Create or select an app and copy both the App ID and Client ID (needed for Expo) - - - Both the Smart Wallets configuration and the gas sponsorship policy must be - linked to the application behind your Alchemy API key for sponsorship to work. - - - ### 1. Add AlchemyProvider - - **Important:** Import from `@account-kit/privy-integration/react-native` for React Native apps. - - ```tsx - import { PrivyProvider } from "@privy-io/expo"; - import { AlchemyProvider } from "@account-kit/privy-integration/react-native"; - - function App() { - return ( - - - - - - ); - } - ``` - - Props for `AlchemyProvider`: - - * `apiKey` | `jwt` | `rpcUrl` (pick a valid transport config) - * `policyId` (optional) for EVM gas sponsorship - * `disableSponsorship` (optional) to opt-out by default - * `accountAuthMode` (optional) - `'eip7702'` (default, recommended) or `'owner'` for a traditional smart account - * `walletAddress` (optional) - specify which wallet address to use if user has multiple wallets (defaults to first wallet) - - ### 2. Send Gasless Transactions - - ```tsx - import { useAlchemySendTransaction } from "@account-kit/privy-integration/react-native"; - - function SendButtons() { - const { sendTransaction, isLoading } = useAlchemySendTransaction(); - - const single = async () => - await sendTransaction({ to: "0x...", data: "0x...", value: "0x0" }); - - const batch = async () => - await sendTransaction([ - { to: "0x...", data: "0x..." }, - { to: "0x...", data: "0x..." }, - ]); - - return ( - <> - ; + } + + return ( +
+ + {signer ? :

Loading signer...

} +
+ ); } ``` - ### Send Transactions with EIP-7702 + ### 4. Create the client and send a transaction + + Pass the Turnkey signer to `createSmartWalletClient` and use it to send transactions: + + ```tsx + import { useMemo, useCallback } from "react"; + import { zeroAddress } from "viem"; + import { createSmartWalletClient, alchemyWalletTransport } from "@alchemy/wallet-apis"; + import { arbitrumSepolia } from "viem/chains"; + + function SendTransaction({ signer }: { signer: LocalAccount }) { + const client = useMemo( + () => + createSmartWalletClient({ + signer, + transport: alchemyWalletTransport({ + apiKey: "YOUR_ALCHEMY_API_KEY", + }), + chain: arbitrumSepolia, + paymaster: { + policyId: "YOUR_GAS_MANAGER_POLICY_ID", + }, + }), + [signer], + ); + + const handleSend = useCallback(async () => { + // Send the transaction + const { id } = await client.sendCalls({ + calls: [{ to: zeroAddress, value: BigInt(0), data: "0x" }], + }); + + // Wait for the transaction to be confirmed + const result = await client.waitForCallsStatus({ id }); + console.log(`Transaction hash: ${result.receipts?.[0]?.transactionHash}`); + }, [client]); + + return ; + } + ``` - Send gasless transactions using EIP-7702 to upgrade the Turnkey wallet to a smart wallet: + ### Notes - ```ts twoslash - const TURNKEY_PRIVATE_KEY_ID = "your-private-key-uuid"; - const TURNKEY_WALLET_ADDRESS = "0x..."; + * The client defaults to [EIP-7702](/wallets/transactions/using-eip-7702), which delegates the Turnkey wallet to a smart account at send time. No deployment or wallet migration needed. See the [EIP-7702 guide](/wallets/transactions/using-eip-7702) for non-7702 mode. + * See the [Sponsor gas](/wallets/transactions/sponsor-gas) guide for more on gas sponsorship configuration. + - async function sendTransaction() { - console.log("Wallet address:", TURNKEY_WALLET_ADDRESS); + + ## Setup - // Create Smart Wallet client from Turnkey wallet - const client = await createTurnkeySmartWalletClient({ - privateKeyId: TURNKEY_PRIVATE_KEY_ID, - walletAddress: TURNKEY_WALLET_ADDRESS, - }); + Use Turnkey's `@turnkey/sdk-server` package with the Wallet Client SDK in a server environment. - // Send a gasless transaction with EIP-7702 - const result = await client.sendCalls({ - from: TURNKEY_WALLET_ADDRESS, - calls: [ - { - to: "0x0000000000000000000000000000000000000000", - value: "0x0", - data: "0x", - }, - ], - capabilities: { - eip7702Auth: true, - paymasterService: { - policyId: ALCHEMY_GAS_POLICY_ID, - }, - }, - }); + ### Installation - console.log("Transaction sent:", result.id); - } + + ```shell npm + npm install @turnkey/sdk-server @turnkey/viem @alchemy/wallet-apis viem ``` - ### Wait for Transaction Confirmation + ```shell bun + bun add @turnkey/sdk-server @turnkey/viem @alchemy/wallet-apis viem + ``` - Wait for the transaction to be confirmed onchain: + ```shell yarn + yarn add @turnkey/sdk-server @turnkey/viem @alchemy/wallet-apis viem + ``` - ```ts twoslash - async function sendAndWaitForTransaction() { - const client = await createTurnkeySmartWalletClient({ - privateKeyId: TURNKEY_PRIVATE_KEY_ID, - walletAddress: TURNKEY_WALLET_ADDRESS, - }); + ```shell pnpm + pnpm add @turnkey/sdk-server @turnkey/viem @alchemy/wallet-apis viem + ``` + - const result = await client.sendCalls({ - from: TURNKEY_WALLET_ADDRESS, - calls: [ - { - to: "0x0000000000000000000000000000000000000000", - value: "0x0", - data: "0x", - }, - ], - capabilities: { - eip7702Auth: true, - paymasterService: { - policyId: ALCHEMY_GAS_POLICY_ID, - }, - }, - }); + ### Prerequisites: Get your keys - console.log("Waiting for confirmation..."); + * Alchemy API Key: + * Go to the [Alchemy Dashboard](https://dashboard.alchemy.com/) + * Create or select an app and copy the API key + * Gas sponsorship Policy ID (Gas Manager): + * Create a gas sponsorship policy in the [dashboard](https://dashboard.alchemy.com/services/gas-manager/configuration) and copy its Policy ID + * Turnkey Credentials: + * Go to the [Turnkey Dashboard](https://app.turnkey.com/) + * Create or select an organization and copy the Organization ID + * Create an API key pair and copy the API Public Key and Private Key - // Wait for the transaction to be confirmed - const txStatus = await client.waitForCallsStatus({ - id: result.id, - timeout: 60_000, // 60 seconds - }); + + The gas sponsorship policy must be linked to the application behind your Alchemy API key for sponsorship to work. + + + ### Send a transaction + + ```ts + import { Turnkey } from "@turnkey/sdk-server"; + import { createAccount } from "@turnkey/viem"; + import { createSmartWalletClient, alchemyWalletTransport } from "@alchemy/wallet-apis"; + import { arbitrumSepolia } from "viem/chains"; + + const turnkeySdk = new Turnkey({ + apiBaseUrl: "https://api.turnkey.com", + apiPublicKey: process.env.TURNKEY_API_PUBLIC_KEY!, + apiPrivateKey: process.env.TURNKEY_API_PRIVATE_KEY!, + defaultOrganizationId: process.env.TURNKEY_ORGANIZATION_ID!, + }); + + const turnkeyClient = turnkeySdk.apiClient(); - const txnHash = txStatus.receipts?.[0]?.transactionHash; + // Get or create a wallet + const { wallets } = await turnkeyClient.getWallets(); + let address: string; - console.log("Transaction confirmed!"); - console.log("Transaction hash:", txnHash); + if (wallets.length > 0) { + // Reuse existing wallet — get its first Ethereum account + const { accounts } = await turnkeyClient.getWalletAccounts({ + walletId: wallets[0]!.walletId, + }); + address = accounts[0]!.address; + } else { + // No wallets yet — create one + const { addresses } = await turnkeyClient.createWallet({ + walletName: "Smart Wallet", + accounts: [ + { + curve: "CURVE_SECP256K1", + pathFormat: "PATH_FORMAT_BIP32", + path: "m/44'/60'/0'/0/0", + addressFormat: "ADDRESS_FORMAT_ETHEREUM", + }, + ], + }); + address = addresses[0]!; } - ``` - ### Batch Multiple Transactions + // Get a viem-compatible signer from Turnkey + const signer = await createAccount({ + client: turnkeyClient, + organizationId: process.env.TURNKEY_ORGANIZATION_ID!, + signWith: address, + }); - Send multiple transactions in a single batch: + // Create the Smart Wallet client + const client = createSmartWalletClient({ + signer, + transport: alchemyWalletTransport({ apiKey: process.env.ALCHEMY_API_KEY! }), + chain: arbitrumSepolia, + paymaster: { policyId: process.env.ALCHEMY_POLICY_ID! }, + }); - ```ts twoslash - const result = await client.sendCalls({ - from: TURNKEY_WALLET_ADDRESS, + // Send the transaction + const { id } = await client.sendCalls({ calls: [ - { to: "0x...", data: "0x...", value: "0x0" }, - { to: "0x...", data: "0x...", value: "0x0" }, - { to: "0x...", data: "0x...", value: "0x0" }, - ], - capabilities: { - eip7702Auth: true, - paymasterService: { - policyId: ALCHEMY_GAS_POLICY_ID, + { + to: "0x0000000000000000000000000000000000000000", + value: BigInt(0), + data: "0x", }, - }, + ], }); + + // Wait for the transaction to be confirmed + const result = await client.waitForCallsStatus({ id }); + console.log(`Transaction hash: ${result.receipts?.[0]?.transactionHash}`); ``` ### Notes - * **EIP-7702**: Upgrades the Turnkey wallet to a smart wallet at transaction time without migration - * **Gas Sponsorship**: Use `paymasterService` with your policy ID for gasless transactions - * **Server-Side**: This example uses Turnkey's `@turnkey/sdk-server` package which is designed for server environments. However, the `@account-kit` packages (`@account-kit/wallet-client`, `@account-kit/infra`, etc.) can be used in any JavaScript environment including browsers, React Native, and Node.js + * The client defaults to [EIP-7702](/wallets/transactions/using-eip-7702), which upgrades the Turnkey wallet to a smart wallet at transaction time without migration or separate deployment. See the [EIP-7702 guide](/wallets/transactions/using-eip-7702) for non-7702 mode. + * See the [Sponsor gas](/wallets/transactions/sponsor-gas) guide for more on gas sponsorship configuration. + * This example uses Turnkey's `@turnkey/sdk-server` package which is designed for server environments. `@alchemy/wallet-apis` can be used in any JavaScript environment. diff --git a/content/wallets/pages/transactions/cross-chain-swap-tokens/client.mdx b/content/wallets/pages/transactions/cross-chain-swap-tokens/client.mdx index 1d52abfbf..aa24f0ff4 100644 --- a/content/wallets/pages/transactions/cross-chain-swap-tokens/client.mdx +++ b/content/wallets/pages/transactions/cross-chain-swap-tokens/client.mdx @@ -1,4 +1,4 @@ -Required SDK version: ^v4.70.0 +`@alchemy/wallet-apis` (v5.x.x) is currently in beta but is the recommended replacement for `@account-kit/wallet-client` (v4.x.x). If you run into any issues, please [reach out](mailto:support@alchemy.com). **Important**: Cross-chain swaps do not support `postCalls`. You cannot batch @@ -13,8 +13,8 @@ You'll need the following env variables: ```ts title="requestCrossChainQuote.ts" - import { swapActions } from "@account-kit/wallet-client/experimental"; - import { client, signer } from "./client"; + import { swapActions } from "@alchemy/wallet-apis/experimental"; + import { client } from "./client"; // Add the swap actions to the client const swapClient = client.extend(swapActions); @@ -22,7 +22,6 @@ You'll need the following env variables: // Request the cross-chain swap quote // Note: toChainId specifies the destination chain for the swap const { quote, callId, ...calls } = await swapClient.requestQuoteV0({ - from: await signer.getAddress(), // Your wallet address toChainId: "0x...", // Destination chain ID fromToken: "0x...", toToken: "0x...", @@ -40,7 +39,7 @@ You'll need the following env variables: throw new Error("Expected user operation calls"); } - // Sign the quote, getting back prepared and signed calls + // Sign the quote using the signer on the client // The callId is automatically included in the signed calls const signedCalls = await swapClient.signPreparedCalls(calls); @@ -75,23 +74,18 @@ You'll need the following env variables: ``` ```ts title="client.ts" - import "dotenv/config"; import type { Hex } from "viem"; - import { LocalAccountSigner } from "@aa-sdk/core"; - import { alchemy, sepolia } from "@account-kit/infra"; - import { createSmartWalletClient } from "@account-kit/wallet-client"; - - export const signer = LocalAccountSigner.privateKeyToAccountSigner( - process.env.PRIVATE_KEY! as Hex, - ) + import { privateKeyToAccount } from "viem/accounts"; + import { base } from "viem/chains"; + import { createSmartWalletClient, alchemyWalletTransport } from "@alchemy/wallet-apis"; export const client = createSmartWalletClient({ - transport: alchemy({ - apiKey: process.env.ALCHEMY_API_KEY!, + transport: alchemyWalletTransport({ + apiKey: "YOUR_API_KEY", }), - chain: sepolia, - signer, - policyId: process.env.ALCHEMY_POLICY_ID!, // Optional: If you're using a gas manager policy + chain: base, + signer: privateKeyToAccount("0xYOUR_PRIVATE_KEY" as const), + paymaster: { policyId: "YOUR_POLICY_ID" }, // Optional: If you're using a gas manager policy }); ``` diff --git a/content/wallets/pages/transactions/cross-chain-swap-tokens/index.mdx b/content/wallets/pages/transactions/cross-chain-swap-tokens/index.mdx index 98d94c28f..47d61970f 100644 --- a/content/wallets/pages/transactions/cross-chain-swap-tokens/index.mdx +++ b/content/wallets/pages/transactions/cross-chain-swap-tokens/index.mdx @@ -65,6 +65,8 @@ Before you begin, ensure you have: + + # FAQs ## What chains are supported for cross-chain swaps? diff --git a/content/wallets/pages/transactions/pay-gas-with-any-token/client.mdx b/content/wallets/pages/transactions/pay-gas-with-any-token/client.mdx index bb2270e89..6f3a7e5df 100644 --- a/content/wallets/pages/transactions/pay-gas-with-any-token/client.mdx +++ b/content/wallets/pages/transactions/pay-gas-with-any-token/client.mdx @@ -1,20 +1,20 @@ -Required SDK version: ^v4.84.1 +`@alchemy/wallet-apis` (v5.x.x) is currently in beta but is the recommended replacement for `@account-kit/wallet-client` (v4.x.x). If you run into any issues, please [reach out](mailto:support@alchemy.com). -See the [`sendCalls` SDK -reference](/docs/wallets/reference/account-kit/wallet-client/functions/sendCalls) -for full descriptions of the parameters used in the following example. +{/* TODO: Add SDK reference link once @alchemy/wallet-apis reference docs are published */} +{/* See the [`sendCalls` SDK +reference](/wallets/reference/account-kit/wallet-client/functions/sendCalls) +for full descriptions of the parameters used in the following example. */} -Use the `paymasterService` capability on the smart wallet client `sendCalls` or `prepareCalls` actions. Set `autoApprove: true` in `postOpSettings` to automatically handle token approvals — the exact amount needed for gas is calculated and approved in the same operation. +Use the `paymaster` capability on the smart wallet client `sendCalls` or `prepareCalls` actions. Set `autoApprove: true` in `postOpSettings` to automatically handle token approvals — the exact amount needed for gas is calculated and approved in the same operation. ```ts title="sendCalls.ts" -import { client, config, signer } from "./client.ts"; +import { client, config } from "./client.ts"; const { id } = await client.sendCalls({ - from: await signer.getAddress(), capabilities: { - paymasterService: { + paymaster: { policyId: config.policyId, erc20: { tokenAddress: config.gasToken, @@ -27,7 +27,7 @@ const { id } = await client.sendCalls({ calls: [ { to: "0x0000000000000000000000000000000000000000", - value: "0x00", + value: BigInt(0), data: "0x", }, ], @@ -35,27 +35,22 @@ const { id } = await client.sendCalls({ ``` ```ts title="client.ts" -import "dotenv/config"; import type { Hex } from "viem"; -import { LocalAccountSigner } from "@aa-sdk/core"; -import { alchemy, sepolia } from "@account-kit/infra"; -import { createSmartWalletClient } from "@account-kit/wallet-client"; +import { privateKeyToAccount } from "viem/accounts"; +import { arbitrumSepolia } from "viem/chains"; +import { createSmartWalletClient, alchemyWalletTransport } from "@alchemy/wallet-apis"; export const config = { - policyId: process.env.ALCHEMY_POLICY_ID!, - gasToken: "0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238", // USDC on sepolia + policyId: "YOUR_POLICY_ID", + gasToken: "0x75faf114eafb1BDbe2F0316DF893fd58CE46AA4d", // USDC on Arbitrum Sepolia } as const; -export const signer = LocalAccountSigner.privateKeyToAccountSigner( - process.env.PRIVATE_KEY! as Hex, -); - export const client = createSmartWalletClient({ - transport: alchemy({ - apiKey: process.env.ALCHEMY_API_KEY!, + transport: alchemyWalletTransport({ + apiKey: "YOUR_API_KEY", }), - chain: sepolia, - signer, + chain: arbitrumSepolia, + signer: privateKeyToAccount("0xYOUR_PRIVATE_KEY" as const), }); ``` @@ -67,12 +62,11 @@ export const client = createSmartWalletClient({ ```ts title="sendCalls.ts" - import { client, config, signer } from "./client.ts"; + import { client, config } from "./client.ts"; const { id } = await client.sendCalls({ - from: await signer.getAddress(), capabilities: { - paymasterService: { + paymaster: { policyId: config.policyId, erc20: { tokenAddress: config.gasToken, @@ -88,7 +82,7 @@ export const client = createSmartWalletClient({ calls: [ { to: "0x0000000000000000000000000000000000000000", - value: "0x00", + value: BigInt(0), data: "0x", }, ], @@ -96,29 +90,24 @@ export const client = createSmartWalletClient({ ``` ```ts title="client.ts" - import "dotenv/config"; - import { type Hex, toHex } from "viem"; - import { LocalAccountSigner } from "@aa-sdk/core"; - import { alchemy, sepolia } from "@account-kit/infra"; - import { createSmartWalletClient } from "@account-kit/wallet-client"; + import type { Address, Hex } from "viem"; + import { privateKeyToAccount } from "viem/accounts"; + import { arbitrumSepolia } from "viem/chains"; + import { createSmartWalletClient, alchemyWalletTransport } from "@alchemy/wallet-apis"; export const config = { - policyId: process.env.ALCHEMY_POLICY_ID!, - gasToken: "0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238", // USDC on sepolia - approveBelow: toHex(1000000n), // 1 USDC - approveAmount: toHex(10000000n), // 10 USDC - } as const; - - export const signer = LocalAccountSigner.privateKeyToAccountSigner( - process.env.PRIVATE_KEY! as Hex, - ); + policyId: "YOUR_POLICY_ID", + gasToken: "0x75faf114eafb1BDbe2F0316DF893fd58CE46AA4d" as const, // USDC on Arbitrum Sepolia + approveBelow: BigInt(1_000_000), // 1 USDC + approveAmount: BigInt(10_000_000), // 10 USDC + }; export const client = createSmartWalletClient({ - transport: alchemy({ - apiKey: process.env.ALCHEMY_API_KEY!, + transport: alchemyWalletTransport({ + apiKey: "YOUR_API_KEY", }), - chain: sepolia, - signer, + chain: arbitrumSepolia, + signer: privateKeyToAccount("0xYOUR_PRIVATE_KEY" as const), }); ``` diff --git a/content/wallets/pages/transactions/pay-gas-with-any-token/index.mdx b/content/wallets/pages/transactions/pay-gas-with-any-token/index.mdx index 855d517d4..e102d90fd 100644 --- a/content/wallets/pages/transactions/pay-gas-with-any-token/index.mdx +++ b/content/wallets/pages/transactions/pay-gas-with-any-token/index.mdx @@ -31,6 +31,8 @@ Post-operation mode is recommended. This mode requires users to hold enough of t + + ## Advanced @@ -38,8 +40,9 @@ Post-operation mode is recommended. This mode requires users to hold enough of t - See the [`prepareCalls` SDK - reference](/docs/wallets/reference/account-kit/wallet-client/functions/prepareCalls) + {/* TODO: Add SDK reference link once @alchemy/wallet-apis reference docs are published */} + {/* See the [`prepareCalls` SDK + reference](/docs/wallets/reference/wallet-apis/functions/prepareCalls) */} diff --git a/content/wallets/pages/transactions/retry-transactions/client.mdx b/content/wallets/pages/transactions/retry-transactions/client.mdx index 9e037ce2f..82b08ae62 100644 --- a/content/wallets/pages/transactions/retry-transactions/client.mdx +++ b/content/wallets/pages/transactions/retry-transactions/client.mdx @@ -1,8 +1,6 @@ -Required SDK version: ^v4.61.0 +`@alchemy/wallet-apis` (v5.x.x) is currently in beta but is the recommended replacement for `@account-kit/wallet-client` (v4.x.x). If you run into any issues, please [reach out](mailto:support@alchemy.com). -See the [`sendCalls` SDK -reference](/docs/wallets/reference/account-kit/wallet-client/functions/sendCalls) -for full descriptions of the parameters used in the following example. +{/* TODO: Add SDK reference link once @alchemy/wallet-apis reference docs are published */} When re-sending calls without a `nonceOverride`, the client automatically uses the same nonce as the pending transaction, replacing it. @@ -14,20 +12,19 @@ You'll need the following env variables: ```ts title="retryTransaction.ts" - import { client, config, signer } from "./client.ts"; + import { client, config } from "./client.ts"; // Send initial transaction const { id } = await client.sendCalls({ - from: await signer.getAddress(), capabilities: { - paymasterService: { + paymaster: { policyId: config.policyId, }, }, calls: [ { to: "0x0000000000000000000000000000000000000000", - value: "0x00", + value: BigInt(0), data: "0x", }, ], @@ -46,16 +43,15 @@ You'll need the following env variables: // Re-send without nonceOverride to replace stuck transaction const { id: replacementId } = await client.sendCalls({ - from: await signer.getAddress(), capabilities: { - paymasterService: { + paymaster: { policyId: config.policyId, }, }, calls: [ { to: "0x0000000000000000000000000000000000000000", - value: "0x00", + value: BigInt(0), data: "0x", }, ], @@ -71,26 +67,21 @@ You'll need the following env variables: ``` ```ts title="client.ts" - import "dotenv/config"; import type { Hex } from "viem"; - import { LocalAccountSigner } from "@aa-sdk/core"; - import { alchemy, sepolia } from "@account-kit/infra"; - import { createSmartWalletClient } from "@account-kit/wallet-client"; + import { sepolia } from "viem/chains"; + import { privateKeyToAccount } from "viem/accounts"; + import { createSmartWalletClient, alchemyWalletTransport } from "@alchemy/wallet-apis"; export const config = { - policyId: process.env.ALCHEMY_POLICY_ID!, + policyId: "YOUR_POLICY_ID", }; - export const signer = LocalAccountSigner.privateKeyToAccountSigner( - process.env.PRIVATE_KEY! as Hex, - ); - export const client = createSmartWalletClient({ - transport: alchemy({ - apiKey: process.env.ALCHEMY_API_KEY!, + transport: alchemyWalletTransport({ + apiKey: "YOUR_API_KEY", }), chain: sepolia, - signer, + signer: privateKeyToAccount("0xYOUR_PRIVATE_KEY" as const), }); ``` diff --git a/content/wallets/pages/transactions/retry-transactions/index.mdx b/content/wallets/pages/transactions/retry-transactions/index.mdx index 4085fdd50..9bfa7c23b 100644 --- a/content/wallets/pages/transactions/retry-transactions/index.mdx +++ b/content/wallets/pages/transactions/retry-transactions/index.mdx @@ -43,3 +43,5 @@ Key use cases: + + diff --git a/content/wallets/pages/transactions/send-batch-transactions/client.mdx b/content/wallets/pages/transactions/send-batch-transactions/client.mdx index 0809c73ea..1a20bf91f 100644 --- a/content/wallets/pages/transactions/send-batch-transactions/client.mdx +++ b/content/wallets/pages/transactions/send-batch-transactions/client.mdx @@ -1,156 +1,154 @@ -Required SDK version: ^v4.59.1 +`@alchemy/wallet-apis` (v5.x.x) is currently in beta but is the recommended replacement for `@account-kit/wallet-client` (v4.x.x). If you run into any issues, please [reach out](mailto:support@alchemy.com). -See the [`sendCalls` SDK -reference](/docs/wallets/reference/account-kit/wallet-client/functions/sendCalls) -for full descriptions of the parameters used in the following example. +{/* TODO: Add SDK reference link once @alchemy/wallet-apis reference docs are published */} You can batch transactions using either the smart wallet client `sendCalls` or `prepareCalls` actions. + ```ts title="sendCalls.ts" + import { type Address, erc20Abi, encodeFunctionData, parseUnits } from "viem"; + import { client } from "./client"; + import { swapAbi } from "./swapAbi"; -```ts title="sendCalls.ts" -import { type Address, erc20Abi, encodeFunctionData, parseUnits } from "viem"; -import { client, signer } from "./client"; -import { swapAbi } from "./swapAbi"; + const DEMO_USDC_ADDRESS: Address = "0xCFf7C6dA719408113DFcb5e36182c6d5aa491443"; -const DEMO_USDC_ADDRESS: Address = "0xCFf7C6dA719408113DFcb5e36182c6d5aa491443"; + const DEMO_SWAP_ADDRESS: Address = "0xB0AEC4c25E8332256A91bBaf169E3C32dfC3C33C"; -const DEMO_SWAP_ADDRESS: Address = "0xB0AEC4c25E8332256A91bBaf169E3C32dfC3C33C"; - -const { id } = await client.sendCalls({ - from: await signer.getAddress(), - calls: [ - // To batch, simply specify multiple calls in the calls array - { - // approve 5000 USDC to the swap contract - to: DEMO_USDC_ADDRESS, - data: encodeFunctionData({ - abi: erc20Abi, - functionName: "approve", - args: [DEMO_SWAP_ADDRESS, parseUnits("5000", 6)], - }), - }, - { - // swap 5000 USDC to 1 WETH - to: DEMO_SWAP_ADDRESS, - data: encodeFunctionData({ - abi: swapAbi, - functionName: "swapUSDCtoWETH", - args: [parseUnits("5000", 6), parseUnits("1", 18)], - }), - }, - ], -}); -``` - -```ts title="client.ts" -import "dotenv/config"; -import type { Hex } from "viem"; -import { LocalAccountSigner } from "@aa-sdk/core"; -import { alchemy, sepolia } from "@account-kit/infra"; -import { createSmartWalletClient } from "@account-kit/wallet-client"; - -export const signer = LocalAccountSigner.privateKeyToAccountSigner( - process.env.PRIVATE_KEY! as Hex, -); - -export const client = createSmartWalletClient({ - transport: alchemy({ - apiKey: process.env.ALCHEMY_API_KEY!, - }), - chain: sepolia, - signer, -}); -``` - -```ts title="swapAbi.ts" -export const swapAbi = [ - { - type: "constructor", - inputs: [], - stateMutability: "nonpayable", - }, - { - type: "function", - name: "mint", - inputs: [ + // Send a batch of calls — approve + swap in a single transaction + const { id } = await client.sendCalls({ + calls: [ + // To batch, simply specify multiple calls in the calls array { - name: "amount1", - type: "uint256", - internalType: "uint256", + // approve 5000 USDC to the swap contract + to: DEMO_USDC_ADDRESS, + data: encodeFunctionData({ + abi: erc20Abi, + functionName: "approve", + args: [DEMO_SWAP_ADDRESS, parseUnits("5000", 6)], + }), }, { - name: "amount2", - type: "uint256", - internalType: "uint256", + // swap 5000 USDC to 1 WETH + to: DEMO_SWAP_ADDRESS, + data: encodeFunctionData({ + abi: swapAbi, + functionName: "swapUSDCtoWETH", + args: [parseUnits("5000", 6), parseUnits("1", 18)], + }), }, ], - outputs: [], - stateMutability: "nonpayable", - }, - { - type: "function", - name: "swapUSDCtoWETH", - inputs: [ - { - name: "amountIn", - type: "uint256", - internalType: "uint256", - }, - { - name: "amountOut", - type: "uint256", - internalType: "uint256", - }, - ], - outputs: [], - stateMutability: "nonpayable", - }, - { - type: "function", - name: "swapWETHtoUSDC", - inputs: [ - { - name: "amountIn", - type: "uint256", - internalType: "uint256", - }, - { - name: "amountOut", - type: "uint256", - internalType: "uint256", - }, - ], - outputs: [], - stateMutability: "nonpayable", - }, - { - type: "function", - name: "usdc", - inputs: [], - outputs: [ - { - name: "", - type: "address", - internalType: "contract ERC20Mintable", - }, - ], - stateMutability: "view", - }, - { - type: "function", - name: "weth", - inputs: [], - outputs: [ - { - name: "", - type: "address", - internalType: "contract ERC20Mintable", - }, - ], - stateMutability: "view", - }, -] as const; -``` + }); + + // Wait for the transaction to be confirmed + const result = await client.waitForCallsStatus({ id }); + console.log(result); + ``` + + ```ts title="client.ts" + import type { Hex } from "viem"; + import { arbitrumSepolia } from "viem/chains"; + import { privateKeyToAccount } from "viem/accounts"; + import { createSmartWalletClient, alchemyWalletTransport } from "@alchemy/wallet-apis"; + + export const client = createSmartWalletClient({ + transport: alchemyWalletTransport({ + apiKey: "YOUR_API_KEY", + }), + chain: arbitrumSepolia, + signer: privateKeyToAccount("0xYOUR_PRIVATE_KEY" as const), + // Optional: sponsor gas for your users (see "Sponsor gas" guide) + // paymaster: { policyId: "YOUR_POLICY_ID" }, + }); + ``` + + ```ts title="swapAbi.ts" + export const swapAbi = [ + { + type: "constructor", + inputs: [], + stateMutability: "nonpayable", + }, + { + type: "function", + name: "mint", + inputs: [ + { + name: "amount1", + type: "uint256", + internalType: "uint256", + }, + { + name: "amount2", + type: "uint256", + internalType: "uint256", + }, + ], + outputs: [], + stateMutability: "nonpayable", + }, + { + type: "function", + name: "swapUSDCtoWETH", + inputs: [ + { + name: "amountIn", + type: "uint256", + internalType: "uint256", + }, + { + name: "amountOut", + type: "uint256", + internalType: "uint256", + }, + ], + outputs: [], + stateMutability: "nonpayable", + }, + { + type: "function", + name: "swapWETHtoUSDC", + inputs: [ + { + name: "amountIn", + type: "uint256", + internalType: "uint256", + }, + { + name: "amountOut", + type: "uint256", + internalType: "uint256", + }, + ], + outputs: [], + stateMutability: "nonpayable", + }, + { + type: "function", + name: "usdc", + inputs: [], + outputs: [ + { + name: "", + type: "address", + internalType: "contract ERC20Mintable", + }, + ], + stateMutability: "view", + }, + { + type: "function", + name: "weth", + inputs: [], + outputs: [ + { + name: "", + type: "address", + internalType: "contract ERC20Mintable", + }, + ], + stateMutability: "view", + }, + ] as const; + ``` diff --git a/content/wallets/pages/transactions/send-batch-transactions/index.mdx b/content/wallets/pages/transactions/send-batch-transactions/index.mdx index 81e1d414d..b2d770fb7 100644 --- a/content/wallets/pages/transactions/send-batch-transactions/index.mdx +++ b/content/wallets/pages/transactions/send-batch-transactions/index.mdx @@ -28,6 +28,8 @@ To use this feature, you just need to specify multiple calls to make. The parame + + ## Next steps Build more: diff --git a/content/wallets/pages/transactions/send-parallel-transactions/client.mdx b/content/wallets/pages/transactions/send-parallel-transactions/client.mdx index 982a1053c..1b48238c5 100644 --- a/content/wallets/pages/transactions/send-parallel-transactions/client.mdx +++ b/content/wallets/pages/transactions/send-parallel-transactions/client.mdx @@ -1,8 +1,6 @@ -Required SDK version: ^v4.61.0 +`@alchemy/wallet-apis` (v5.x.x) is currently in beta but is the recommended replacement for `@account-kit/wallet-client` (v4.x.x). If you run into any issues, please [reach out](mailto:support@alchemy.com). -See the [`sendCalls` SDK -reference](/docs/wallets/reference/account-kit/wallet-client/functions/sendCalls) -for full descriptions of the parameters used in the following example. +{/* TODO: Add SDK reference link once @alchemy/wallet-apis reference docs are published */} Use the `nonceOverride` capability on the smart wallet client's `sendCalls` or `prepareCalls` action. @@ -14,18 +12,15 @@ You'll need the following env variables: ```ts title="sendParallelCalls.ts" - import { client, config, signer } from "./client.ts"; - - const signerAddress = await signer.getAddress(); + import { client, config } from "./client.ts"; const [ { id: idOne }, { id: idTwo }, ] = await Promise.all([ client.sendCalls({ - from: signerAddress, capabilities: { - paymasterService: { + paymaster: { policyId: config.policyId, }, nonceOverride: { @@ -35,15 +30,14 @@ You'll need the following env variables: calls: [ { to: "0x0000000000000000000000000000000000000000", - value: "0x00", + value: BigInt(0), data: "0x", }, ], }), client.sendCalls({ - from: signerAddress, capabilities: { - paymasterService: { + paymaster: { policyId: config.policyId, }, nonceOverride: { @@ -53,7 +47,7 @@ You'll need the following env variables: calls: [ { to: "0x0000000000000000000000000000000000000000", - value: "0x00", + value: BigInt(0), data: "0x", }, ], @@ -71,26 +65,21 @@ You'll need the following env variables: ``` ```ts title="client.ts" - import "dotenv/config"; import type { Hex } from "viem"; - import { LocalAccountSigner } from "@aa-sdk/core"; - import { alchemy, sepolia } from "@account-kit/infra"; - import { createSmartWalletClient } from "@account-kit/wallet-client"; + import { sepolia } from "viem/chains"; + import { privateKeyToAccount } from "viem/accounts"; + import { createSmartWalletClient, alchemyWalletTransport } from "@alchemy/wallet-apis"; export const config = { - policyId: process.env.ALCHEMY_POLICY_ID!, + policyId: "YOUR_POLICY_ID", }; - export const signer = LocalAccountSigner.privateKeyToAccountSigner( - process.env.PRIVATE_KEY! as Hex, - ); - export const client = createSmartWalletClient({ - transport: alchemy({ - apiKey: process.env.ALCHEMY_API_KEY!, + transport: alchemyWalletTransport({ + apiKey: "YOUR_API_KEY", }), chain: sepolia, - signer, + signer: privateKeyToAccount("0xYOUR_PRIVATE_KEY" as const), }); ``` diff --git a/content/wallets/pages/transactions/send-parallel-transactions/index.mdx b/content/wallets/pages/transactions/send-parallel-transactions/index.mdx index bd9ac55d4..40368eaf3 100644 --- a/content/wallets/pages/transactions/send-parallel-transactions/index.mdx +++ b/content/wallets/pages/transactions/send-parallel-transactions/index.mdx @@ -24,3 +24,5 @@ This quide explains how to send multiple parallel transactions. Note that you do + + diff --git a/content/wallets/pages/transactions/send-transactions/client.mdx b/content/wallets/pages/transactions/send-transactions/client.mdx index 83cbafdea..1aad1d7d3 100644 --- a/content/wallets/pages/transactions/send-transactions/client.mdx +++ b/content/wallets/pages/transactions/send-transactions/client.mdx @@ -1,50 +1,46 @@ -Required SDK version: ^v4.54.0 +`@alchemy/wallet-apis` (v5.x.x) is currently in beta but is the recommended replacement for `@account-kit/wallet-client` (v4.x.x). If you run into any issues, please [reach out](mailto:support@alchemy.com). -See the [`sendCalls` SDK reference](/docs/wallets/reference/account-kit/wallet-client/functions/sendCalls) for full descriptions of the parameters used in the following example. +{/* TODO: Add SDK reference link once @alchemy/wallet-apis reference docs are published. */} You can send transactions using the smart wallet client `sendCalls` action. - -```ts title="sendCalls.ts" -import { parseEther, toHex } from "viem"; -import { client, signer } from "./client.ts"; - -const { id } = await client.sendCalls({ - from: await signer.getAddress(), - calls: [ - { - to: "0x0000000000000000000000000000000000000000", - value: toHex(parseEther("0")), - data: "0x", - }, - ], -}); - -console.log({ id }); - -const result = await client.waitForCallsStatus({ id }); - -console.log(result); -``` - -```ts title="client.ts" -import type { Hex } from "viem"; -import { LocalAccountSigner } from "@aa-sdk/core"; -import { alchemy, sepolia } from "@account-kit/infra"; -import { createSmartWalletClient } from "@account-kit/wallet-client"; - -export const signer = LocalAccountSigner.privateKeyToAccountSigner( - process.env.PRIVATE_KEY! as Hex, -); - -export const client = createSmartWalletClient({ - transport: alchemy({ - apiKey: process.env.ALCHEMY_API_KEY!, - }), - chain: sepolia, - signer, -}); -``` - + ```ts title="sendCalls.ts" + import { client } from "./client.ts"; + + // Send the transaction + const { id } = await client.sendCalls({ + calls: [ + { + to: "0x0000000000000000000000000000000000000000", + value: BigInt(0), + data: "0x", + }, + ], + }); + + console.log({ id }); // the Call ID + + // Wait for the transaction to be confirmed + const result = await client.waitForCallsStatus({ id }); + + console.log(result); + ``` + + ```ts title="client.ts" + import type { Hex } from "viem"; + import { arbitrumSepolia } from "viem/chains"; + import { privateKeyToAccount } from "viem/accounts"; + import { createSmartWalletClient, alchemyWalletTransport } from "@alchemy/wallet-apis"; + + export const client = createSmartWalletClient({ + transport: alchemyWalletTransport({ + apiKey: "YOUR_API_KEY", + }), + chain: arbitrumSepolia, + signer: privateKeyToAccount("0xYOUR_PRIVATE_KEY" as const), + // Optional: sponsor gas for your users (see "Sponsor gas" guide) + // paymaster: { policyId: "YOUR_POLICY_ID" }, + }); + ``` diff --git a/content/wallets/pages/transactions/send-transactions/encoding-function-data/client.mdx b/content/wallets/pages/transactions/send-transactions/encoding-function-data/client.mdx index 116d54228..b85e3f370 100644 --- a/content/wallets/pages/transactions/send-transactions/encoding-function-data/client.mdx +++ b/content/wallets/pages/transactions/send-transactions/encoding-function-data/client.mdx @@ -1,56 +1,49 @@ In JavaScript, you can use [Viem](https://viem.sh/docs/contract/encodeFunctionData) to encode function call data. - -```ts title="sendCalls.ts" focus={9-14} -import { encodeFunctionData } from "viem"; -import { client, signer } from "./client.ts"; -import { exampleAbi } from "./abi.ts"; - -await client.sendCalls({ - from: await signer.getAddress(), - calls: [ + ```ts title="sendCalls.ts" focus={9-14} + import { encodeFunctionData } from "viem"; + import { client } from "./client.ts"; + import { exampleAbi } from "./abi.ts"; + + await client.sendCalls({ + calls: [ + { + to: "0x0000000000000000000000000000000000000000", + data: encodeFunctionData({ + abi: exampleAbi, + functionName: "mintTo", + args: ["0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"], + }), + }, + ], + }); + ``` + + ```ts title="abi.ts" + export const exampleAbi = [ { - to: "0x0000000000000000000000000000000000000000", - data: encodeFunctionData({ - abi: exampleAbi, - functionName: "mintTo", - args: ["0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"], - }), + inputs: [{ name: "recipient", type: "address" }], + name: "mintTo", + outputs: [{ name: "", type: "uint256" }], + stateMutability: "nonpayable", + type: "function", }, - ], -}); -``` - -```ts title="abi.ts" -export const exampleAbi = [ - { - inputs: [{ name: "recipient", type: "address" }], - name: "mintTo", - outputs: [{ name: "", type: "uint256" }], - stateMutability: "nonpayable", - type: "function", - }, -] as const; -``` - -```ts title="client.ts" -import type { Hex } from "viem"; -import { LocalAccountSigner } from "@aa-sdk/core"; -import { alchemy, sepolia } from "@account-kit/infra"; -import { createSmartWalletClient } from "@account-kit/wallet-client"; - -export const signer = LocalAccountSigner.privateKeyToAccountSigner( - process.env.PRIVATE_KEY! as Hex, -); - -export const client = createSmartWalletClient({ - transport: alchemy({ - apiKey: process.env.ALCHEMY_API_KEY!, - }), - chain: sepolia, - signer, -}); -``` - + ] as const; + ``` + + ```ts title="client.ts" + import type { Hex } from "viem"; + import { arbitrumSepolia } from "viem/chains"; + import { privateKeyToAccount } from "viem/accounts"; + import { createSmartWalletClient, alchemyWalletTransport } from "@alchemy/wallet-apis"; + + export const client = createSmartWalletClient({ + transport: alchemyWalletTransport({ + apiKey: "YOUR_API_KEY", + }), + chain: arbitrumSepolia, + signer: privateKeyToAccount("0xYOUR_PRIVATE_KEY" as const), + }); + ``` diff --git a/content/wallets/pages/transactions/send-transactions/index.mdx b/content/wallets/pages/transactions/send-transactions/index.mdx index 8c1ad101e..3cc91e52a 100644 --- a/content/wallets/pages/transactions/send-transactions/index.mdx +++ b/content/wallets/pages/transactions/send-transactions/index.mdx @@ -6,6 +6,8 @@ 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) @@ -16,6 +18,7 @@ This guide will teach you how to send a single EVM transaction. Smart Wallets ma + diff --git a/content/wallets/pages/transactions/send-transactions/prepare-calls/client.mdx b/content/wallets/pages/transactions/send-transactions/prepare-calls/client.mdx index ba6f20201..8d2d7a5c7 100644 --- a/content/wallets/pages/transactions/send-transactions/prepare-calls/client.mdx +++ b/content/wallets/pages/transactions/send-transactions/prepare-calls/client.mdx @@ -1,55 +1,48 @@ -Required SDK version: ^v4.54.0 +`@alchemy/wallet-apis` (v5.x.x) is currently in beta but is the recommended replacement for `@account-kit/wallet-client` (v4.x.x). If you run into any issues, please [reach out](mailto:support@alchemy.com). You can use smart wallet client actions to prepare, sign, and send transactions. - -```ts title="sendCalls.ts" focus={4-21} -import { parseEther, toHex } from "viem"; -import { client, signer } from "./client.ts"; - -const preparedCalls = await client.prepareCalls({ - from: await signer.getAddress(), - calls: [ - { - to: "0x0000000000000000000000000000000000000000", - value: toHex(parseEther("0")), - data: "0x", - }, - ], -}); - -console.log({ preparedCalls }); // Here you can inspect the prepared calls before signing. - -const signedCalls = await client.signPreparedCalls(preparedCalls); - -const sentCalls = await client.sendPreparedCalls(signedCalls); - -console.log({ sentCalls }); -``` - -```ts title="client.ts" -import type { Hex } from "viem"; -import { LocalAccountSigner } from "@aa-sdk/core"; -import { alchemy, sepolia } from "@account-kit/infra"; -import { createSmartWalletClient } from "@account-kit/wallet-client"; - -export const signer = LocalAccountSigner.privateKeyToAccountSigner( - process.env.PRIVATE_KEY! as Hex, -); - -export const client = createSmartWalletClient({ - transport: alchemy({ - apiKey: process.env.ALCHEMY_API_KEY!, - }), - chain: sepolia, - signer, -}); -``` - + ```ts title="sendCalls.ts" focus={4-21} + import { client } from "./client.ts"; + + // Prepare the calls + const preparedCalls = await client.prepareCalls({ + calls: [ + { + to: "0x0000000000000000000000000000000000000000", + value: BigInt(0), + data: "0x", + }, + ], + }); + + // Inspect the prepared calls before signing + console.log({ preparedCalls }); + + // Sign the prepared calls + const signedCalls = await client.signPreparedCalls(preparedCalls); + + // Send the signed calls + const sentCalls = await client.sendPreparedCalls(signedCalls); + + console.log({ sentCalls }); + ``` + + ```ts title="client.ts" + import type { Hex } from "viem"; + import { arbitrumSepolia } from "viem/chains"; + import { privateKeyToAccount } from "viem/accounts"; + import { createSmartWalletClient, alchemyWalletTransport } from "@alchemy/wallet-apis"; + + export const client = createSmartWalletClient({ + transport: alchemyWalletTransport({ + apiKey: "YOUR_API_KEY", + }), + chain: arbitrumSepolia, + signer: privateKeyToAccount("0xYOUR_PRIVATE_KEY" as const), + }); + ``` -See the [`prepareCalls`](/docs/wallets/reference/account-kit/wallet-client/functions/prepareCalls), -[`signPreparedCalls`](/docs/wallets/reference/account-kit/wallet-client/functions/signPreparedCalls), -and [`sendPreparedCalls`](/docs/wallets/reference/account-kit/wallet-client/functions/sendPreparedCalls) -SDK reference for full descriptions of the parameters used in the above example. +{/* TODO: Add SDK reference link once @alchemy/wallet-apis reference docs are published */} diff --git a/content/wallets/pages/transactions/signing/sign-messages/client-raw.mdx b/content/wallets/pages/transactions/signing/sign-messages/client-raw.mdx index 3e9286bbd..8d34a944d 100644 --- a/content/wallets/pages/transactions/signing/sign-messages/client-raw.mdx +++ b/content/wallets/pages/transactions/signing/sign-messages/client-raw.mdx @@ -1,42 +1,52 @@ -Required SDK version: ^v4.59.1 +`@alchemy/wallet-apis` (v5.x.x) is currently in beta but is the recommended replacement for `@account-kit/wallet-client` (v4.x.x). If you run into any issues, please [reach out](mailto:support@alchemy.com). -See the [`signMessage` SDK -reference](/docs/wallets/reference/account-kit/wallet-client/functions/signMessage) -for full descriptions of the parameters used in the following example. +{/* TODO: Add SDK reference link once @alchemy/wallet-apis reference docs are published */} +{/* See the [`signMessage` SDK +reference](/wallets/reference/account-kit/wallet-client/functions/signMessage) +for full descriptions of the parameters used in the following example. */} ```ts title="signRawMessage.ts" -import { client, signer } from "./client"; +import { createPublicClient, http } from "viem"; +import { arbitrumSepolia } from "viem/chains"; +import { client } from "./client"; // Sign a raw hex message -const rawSignature = await client.signMessage({ - message: { - raw: "0x48656c6c6f2c20776f726c6421", // "Hello, world!" in hex - }, - account: await signer.getAddress(), +const message = { + raw: "0x48656c6c6f2c20776f726c6421" as const, // "Hello, world!" in hex +}; +const signature = await client.signMessage({ message }); + +console.log("Signature:", signature); + +// Verify the signature +const publicClient = createPublicClient({ + chain: arbitrumSepolia, + transport: http(), }); -console.log("Signature over raw data:", rawSignature); +const isValid = await publicClient.verifyMessage({ + address: client.account.address, + message, + signature, +}); + +console.log("Valid:", isValid); // true ``` ```ts title="client.ts" -import "dotenv/config"; import type { Hex } from "viem"; -import { LocalAccountSigner } from "@aa-sdk/core"; -import { alchemy, sepolia } from "@account-kit/infra"; -import { createSmartWalletClient } from "@account-kit/wallet-client"; - -export const signer = LocalAccountSigner.privateKeyToAccountSigner( - process.env.PRIVATE_KEY! as Hex, -); +import { privateKeyToAccount } from "viem/accounts"; +import { arbitrumSepolia } from "viem/chains"; +import { createSmartWalletClient, alchemyWalletTransport } from "@alchemy/wallet-apis"; export const client = createSmartWalletClient({ - transport: alchemy({ - apiKey: process.env.ALCHEMY_API_KEY!, + transport: alchemyWalletTransport({ + apiKey: "YOUR_API_KEY", }), - chain: sepolia, - signer, + chain: arbitrumSepolia, + signer: privateKeyToAccount("0xYOUR_PRIVATE_KEY" as const), }); ``` diff --git a/content/wallets/pages/transactions/signing/sign-messages/client-text.mdx b/content/wallets/pages/transactions/signing/sign-messages/client-text.mdx index 5c38e0a4e..877814fc6 100644 --- a/content/wallets/pages/transactions/signing/sign-messages/client-text.mdx +++ b/content/wallets/pages/transactions/signing/sign-messages/client-text.mdx @@ -1,40 +1,50 @@ -Required SDK version: ^v4.59.1 +`@alchemy/wallet-apis` (v5.x.x) is currently in beta but is the recommended replacement for `@account-kit/wallet-client` (v4.x.x). If you run into any issues, please [reach out](mailto:support@alchemy.com). -See the [`signMessage` SDK -reference](/docs/wallets/reference/account-kit/wallet-client/functions/signMessage) -for full descriptions of the parameters used in the following example. +{/* TODO: Add SDK reference link once @alchemy/wallet-apis reference docs are published */} +{/* See the [`signMessage` SDK +reference](/wallets/reference/account-kit/wallet-client/functions/signMessage) +for full descriptions of the parameters used in the following example. */} ```ts title="signTextMessage.ts" -import { client, signer } from "./client"; +import { createPublicClient, http } from "viem"; +import { arbitrumSepolia } from "viem/chains"; +import { client } from "./client"; // Sign a simple text message -const textSignature = await client.signMessage({ - message: "Hello, world!", - account: await signer.getAddress(), +const message = "Hello, world!"; +const signature = await client.signMessage({ message }); + +console.log("Signature:", signature); + +// Verify the signature +const publicClient = createPublicClient({ + chain: arbitrumSepolia, + transport: http(), }); -console.log("Signature over text:", textSignature); +const isValid = await publicClient.verifyMessage({ + address: client.account.address, + message, + signature, +}); + +console.log("Valid:", isValid); // true ``` ```ts title="client.ts" -import "dotenv/config"; import type { Hex } from "viem"; -import { LocalAccountSigner } from "@aa-sdk/core"; -import { alchemy, sepolia } from "@account-kit/infra"; -import { createSmartWalletClient } from "@account-kit/wallet-client"; - -export const signer = LocalAccountSigner.privateKeyToAccountSigner( - process.env.PRIVATE_KEY! as Hex, -); +import { privateKeyToAccount } from "viem/accounts"; +import { arbitrumSepolia } from "viem/chains"; +import { createSmartWalletClient, alchemyWalletTransport } from "@alchemy/wallet-apis"; export const client = createSmartWalletClient({ - transport: alchemy({ - apiKey: process.env.ALCHEMY_API_KEY!, + transport: alchemyWalletTransport({ + apiKey: "YOUR_API_KEY", }), - chain: sepolia, - signer, + chain: arbitrumSepolia, + signer: privateKeyToAccount("0xYOUR_PRIVATE_KEY" as const), }); ``` diff --git a/content/wallets/pages/transactions/signing/sign-messages/index.mdx b/content/wallets/pages/transactions/signing/sign-messages/index.mdx index 9fe9be2c8..794a3f25f 100644 --- a/content/wallets/pages/transactions/signing/sign-messages/index.mdx +++ b/content/wallets/pages/transactions/signing/sign-messages/index.mdx @@ -44,6 +44,8 @@ Smart Wallets support EIP-191 message signing, which is the standard for Ethereu + + ## Next steps Build more: diff --git a/content/wallets/pages/transactions/signing/sign-typed-data/client.mdx b/content/wallets/pages/transactions/signing/sign-typed-data/client.mdx index e25a3f3a8..d74187b06 100644 --- a/content/wallets/pages/transactions/signing/sign-typed-data/client.mdx +++ b/content/wallets/pages/transactions/signing/sign-typed-data/client.mdx @@ -1,15 +1,18 @@ -Required SDK version: ^v4.59.1 +`@alchemy/wallet-apis` (v5.x.x) is currently in beta but is the recommended replacement for `@account-kit/wallet-client` (v4.x.x). If you run into any issues, please [reach out](mailto:support@alchemy.com). -See the [`signTypedData` SDK +{/* TODO: Add SDK reference link once @alchemy/wallet-apis reference docs are published */} +{/* See the [`signTypedData` SDK reference](/docs/wallets/reference/account-kit/wallet-client/functions/signTypedData) -for full descriptions of the parameters used in the following example. +for full descriptions of the parameters used in the following example. */} ```ts title="signTypedData.ts" -import { client, signer } from "./client"; +import { createPublicClient, http } from "viem"; +import { arbitrumSepolia } from "viem/chains"; +import { client } from "./client"; -const signerAddress = await signer.getAddress(); +const signerAddress = client.account.address; // Sign typed data const typedData = { @@ -36,29 +39,37 @@ const typedData = { const signature = await client.signTypedData({ ...typedData, - account: signerAddress, }); -console.log("Typed data signature:", signature); +console.log("Signature:", signature); + +// Verify the signature +const publicClient = createPublicClient({ + chain: arbitrumSepolia, + transport: http(), +}); + +const isValid = await publicClient.verifyTypedData({ + address: client.account.address, + ...typedData, + signature, +}); + +console.log("Valid:", isValid); // true ``` ```ts title="client.ts" -import "dotenv/config"; import type { Hex } from "viem"; -import { LocalAccountSigner } from "@aa-sdk/core"; -import { alchemy, sepolia } from "@account-kit/infra"; -import { createSmartWalletClient } from "@account-kit/wallet-client"; - -export const signer = LocalAccountSigner.privateKeyToAccountSigner( - process.env.PRIVATE_KEY! as Hex, -); +import { privateKeyToAccount } from "viem/accounts"; +import { arbitrumSepolia } from "viem/chains"; +import { createSmartWalletClient, alchemyWalletTransport } from "@alchemy/wallet-apis"; export const client = createSmartWalletClient({ - transport: alchemy({ - apiKey: process.env.ALCHEMY_API_KEY!, + transport: alchemyWalletTransport({ + apiKey: "YOUR_API_KEY", }), - chain: sepolia, - signer, + chain: arbitrumSepolia, + signer: privateKeyToAccount("0xYOUR_PRIVATE_KEY" as const), }); ``` diff --git a/content/wallets/pages/transactions/signing/sign-typed-data/index.mdx b/content/wallets/pages/transactions/signing/sign-typed-data/index.mdx index de741d237..7af740000 100644 --- a/content/wallets/pages/transactions/signing/sign-typed-data/index.mdx +++ b/content/wallets/pages/transactions/signing/sign-typed-data/index.mdx @@ -33,6 +33,8 @@ Typed data follows the [EIP-712](https://eips.ethereum.org/EIPS/eip-712) standar + + ## Typed data structure EIP-712 typed data consists of four main components: diff --git a/content/wallets/pages/transactions/sponsor-gas/client.mdx b/content/wallets/pages/transactions/sponsor-gas/client.mdx index 8195a7e50..d3f760223 100644 --- a/content/wallets/pages/transactions/sponsor-gas/client.mdx +++ b/content/wallets/pages/transactions/sponsor-gas/client.mdx @@ -1,28 +1,29 @@ -Required SDK version: ^v4.61.0 +`@alchemy/wallet-apis` (v5.x.x) is currently in beta but is the recommended replacement for `@account-kit/wallet-client` (v4.x.x). If you run into any issues, please [reach out](mailto:support@alchemy.com). -See the [`sendCalls` SDK -reference](/docs/wallets/reference/account-kit/wallet-client/functions/sendCalls) -for full descriptions of the parameters used in the following example. +{/* TODO: Add SDK reference link once @alchemy/wallet-apis reference docs are published */} +{/* See the [`sendCalls` SDK +reference](/wallets/reference/account-kit/wallet-client/functions/sendCalls) +for full descriptions of the parameters used in the following example. */} -Use the `paymasterService` capability on the smart wallet client `sendCalls` or `prepareCalls` actions. +Use the `paymaster` capability on the smart wallet client `sendCalls` or `prepareCalls` actions. ```ts title="sendCalls.ts" -import { client, config, signer } from "./client.ts"; +import { client, config } from "./client.ts"; try { + // Send a sponsored transaction const { id } = await client.sendCalls({ - from: await signer.getAddress(), capabilities: { - paymasterService: { + paymaster: { policyId: config.policyId, }, }, calls: [ { to: "0x0000000000000000000000000000000000000000", - value: "0x00", + value: BigInt(0), data: "0x", }, ], @@ -35,26 +36,21 @@ try { ``` ```ts title="client.ts" -import "dotenv/config"; import type { Hex } from "viem"; -import { LocalAccountSigner } from "@aa-sdk/core"; -import { alchemy, sepolia } from "@account-kit/infra"; -import { createSmartWalletClient } from "@account-kit/wallet-client"; +import { privateKeyToAccount } from "viem/accounts"; +import { arbitrumSepolia } from "viem/chains"; +import { createSmartWalletClient, alchemyWalletTransport } from "@alchemy/wallet-apis"; export const config = { - policyId: process.env.ALCHEMY_POLICY_ID!, + policyId: "YOUR_POLICY_ID", }; -export const signer = LocalAccountSigner.privateKeyToAccountSigner( - process.env.PRIVATE_KEY! as Hex, -); - export const client = createSmartWalletClient({ - transport: alchemy({ - apiKey: process.env.ALCHEMY_API_KEY!, + transport: alchemyWalletTransport({ + apiKey: "YOUR_API_KEY", }), - chain: sepolia, - signer, + chain: arbitrumSepolia, + signer: privateKeyToAccount("0xYOUR_PRIVATE_KEY" as const), }); ``` diff --git a/content/wallets/pages/transactions/sponsor-gas/index.mdx b/content/wallets/pages/transactions/sponsor-gas/index.mdx index 902607937..bcc031f80 100644 --- a/content/wallets/pages/transactions/sponsor-gas/index.mdx +++ b/content/wallets/pages/transactions/sponsor-gas/index.mdx @@ -29,6 +29,8 @@ and bill the sponsoring developer in fiat. + + ## Advanced @@ -36,8 +38,9 @@ and bill the sponsoring developer in fiat. - See the [`prepareCalls` SDK - reference](/docs/wallets/reference/account-kit/wallet-client/functions/prepareCalls) + {/* TODO: Add SDK reference link once @alchemy/wallet-apis reference docs are published */} + {/* See the [`prepareCalls` SDK + reference](/docs/wallets/reference/wallet-apis/functions/prepareCalls) */} diff --git a/content/wallets/pages/transactions/swap-tokens/client.mdx b/content/wallets/pages/transactions/swap-tokens/client.mdx index 5b73f8917..84f3a3990 100644 --- a/content/wallets/pages/transactions/swap-tokens/client.mdx +++ b/content/wallets/pages/transactions/swap-tokens/client.mdx @@ -1,4 +1,4 @@ -Required SDK version: ^v4.65.0 +`@alchemy/wallet-apis` (v5.x.x) is currently in beta but is the recommended replacement for `@account-kit/wallet-client` (v4.x.x). If you run into any issues, please [reach out](mailto:support@alchemy.com). You'll need the following env variables: @@ -8,15 +8,14 @@ You'll need the following env variables: ```ts title="requestQuote.ts" - import { swapActions } from "@account-kit/wallet-client/experimental"; - import { client, signer } from "./client"; + import { swapActions } from "@alchemy/wallet-apis/experimental"; + import { client } from "./client"; // Add the swap actions to the client const swapClient = client.extend(swapActions); // Request the swap quote const { quote, ...calls } = await swapClient.requestQuoteV0({ - from: await signer.getAddress(), // Your wallet address fromToken: "0x...", toToken: "0x...", minimumToAmount: "0x...", @@ -32,7 +31,7 @@ You'll need the following env variables: throw new Error("Expected user operation calls"); } - // Sign the quote, getting back prepared and signed calls + // Sign the quote using the signer on the client const signedCalls = await swapClient.signPreparedCalls(calls); // Send the prepared calls @@ -61,23 +60,18 @@ You'll need the following env variables: ``` ```ts title="client.ts" - import "dotenv/config"; import type { Hex } from "viem"; - import { LocalAccountSigner } from "@aa-sdk/core"; - import { alchemy, sepolia } from "@account-kit/infra"; - import { createSmartWalletClient } from "@account-kit/wallet-client"; - - export const signer = LocalAccountSigner.privateKeyToAccountSigner( - process.env.PRIVATE_KEY! as Hex, - ); + import { privateKeyToAccount } from "viem/accounts"; + import { base } from "viem/chains"; + import { createSmartWalletClient, alchemyWalletTransport } from "@alchemy/wallet-apis"; export const client = createSmartWalletClient({ - transport: alchemy({ - apiKey: process.env.ALCHEMY_API_KEY!, + transport: alchemyWalletTransport({ + apiKey: "YOUR_API_KEY", }), - chain: sepolia, - signer, - policyId: process.env.ALCHEMY_POLICY_ID!, // Optional: If you're using a gas manager policy + chain: base, + signer: privateKeyToAccount("0xYOUR_PRIVATE_KEY" as const), + paymaster: { policyId: "YOUR_POLICY_ID" }, // Optional: If you're using a gas manager policy }); ``` diff --git a/content/wallets/pages/transactions/swap-tokens/index.mdx b/content/wallets/pages/transactions/swap-tokens/index.mdx index ab49c8cfb..3efb70fec 100644 --- a/content/wallets/pages/transactions/swap-tokens/index.mdx +++ b/content/wallets/pages/transactions/swap-tokens/index.mdx @@ -62,6 +62,8 @@ Before you begin, ensure you have: + + # FAQs ## What chains are supported? diff --git a/content/wallets/pages/transactions/using-eip-7702/client.mdx b/content/wallets/pages/transactions/using-eip-7702/client.mdx index 65947b0f4..2bfeaa027 100644 --- a/content/wallets/pages/transactions/using-eip-7702/client.mdx +++ b/content/wallets/pages/transactions/using-eip-7702/client.mdx @@ -1,4 +1,4 @@ -Required SDK version: ^v4.61.0 +`@alchemy/wallet-apis` (v5.x.x) is currently in beta but is the recommended replacement for `@account-kit/wallet-client` (v4.x.x). If you run into any issues, please [reach out](mailto:support@alchemy.com). EIP-7702 is the default mode for Smart Wallets. Simply create a client with your signer and use `sendCalls` - the SDK will automatically handle authorization requests to delegate the EOA to Modular Account v2 when needed. @@ -8,27 +8,27 @@ EIP-7702 is the default mode for Smart Wallets. Simply create a client with your delegation. -See the [`sendCalls` SDK -reference](/docs/wallets/reference/account-kit/wallet-client/functions/sendCalls) -for full descriptions of the parameters used in the following example. +{/* TODO: Add SDK reference link once @alchemy/wallet-apis reference docs are published */} +{/* See the [`sendCalls` SDK +reference](/wallets/reference/account-kit/wallet-client/functions/sendCalls) +for full descriptions of the parameters used in the following example. */} ```tsx title="sendCalls.ts" -import { client, config, signer } from "./client.ts"; +import { client, config } from "./client.ts"; try { const { id } = await client.sendCalls({ - from: await signer.getAddress(), capabilities: { - paymasterService: { + paymaster: { policyId: config.policyId, }, }, calls: [ { to: "0x0000000000000000000000000000000000000000", - value: "0x00", + value: BigInt(0), data: "0x", }, ], @@ -41,26 +41,21 @@ try { ``` ```ts title="client.ts" -import "dotenv/config"; import type { Hex } from "viem"; -import { LocalAccountSigner } from "@aa-sdk/core"; -import { alchemy, sepolia } from "@account-kit/infra"; -import { createSmartWalletClient } from "@account-kit/wallet-client"; +import { privateKeyToAccount } from "viem/accounts"; +import { sepolia } from "viem/chains"; +import { createSmartWalletClient, alchemyWalletTransport } from "@alchemy/wallet-apis"; export const config = { - policyId: process.env.ALCHEMY_POLICY_ID!, + policyId: "YOUR_POLICY_ID", }; -export const signer = LocalAccountSigner.privateKeyToAccountSigner( - process.env.PRIVATE_KEY! as Hex, -); - export const client = createSmartWalletClient({ - transport: alchemy({ - apiKey: process.env.ALCHEMY_API_KEY!, + transport: alchemyWalletTransport({ + apiKey: "YOUR_API_KEY", }), chain: sepolia, - signer, + signer: privateKeyToAccount("0xYOUR_PRIVATE_KEY" as const), }); ``` diff --git a/content/wallets/pages/transactions/using-eip-7702/index.mdx b/content/wallets/pages/transactions/using-eip-7702/index.mdx index fa8eeb00d..ab5ba8ca5 100644 --- a/content/wallets/pages/transactions/using-eip-7702/index.mdx +++ b/content/wallets/pages/transactions/using-eip-7702/index.mdx @@ -26,6 +26,10 @@ If you need to use a traditional Smart Contract Account instead of EIP-7702, you When you call `wallet_requestAccount` with a signer address, it creates a dedicated Smart Contract Account address. Using this SCA address (instead of your signer address) in subsequent API calls will bypass 7702 mode. + +If you've already used a signer address in 7702 mode (e.g. by calling `wallet_prepareCalls` with the signer address), you'll need to specify `creationHint: { accountType: "sma-b" }` when calling `wallet_requestAccount` to create a separate Smart Contract Account for that signer. + + **When to use SCA mode:** * Backwards compatibility with existing Smart Contract Accounts * Using chains that don't yet support EIP-7702 @@ -35,26 +39,23 @@ When you call `wallet_requestAccount` with a signer address, it creates a dedica ```ts - import { createSmartWalletClient } from "@account-kit/wallet-client"; - import { LocalAccountSigner } from "@aa-sdk/core"; - import { alchemy, sepolia } from "@account-kit/infra"; - - const signer = LocalAccountSigner.privateKeyToAccountSigner( - process.env.PRIVATE_KEY!, - ); + import type { Hex } from "viem"; + import { privateKeyToAccount } from "viem/accounts"; + import { sepolia } from "viem/chains"; + import { createSmartWalletClient, alchemyWalletTransport } from "@alchemy/wallet-apis"; const client = createSmartWalletClient({ - transport: alchemy({ apiKey: process.env.ALCHEMY_API_KEY! }), + transport: alchemyWalletTransport({ apiKey: "YOUR_API_KEY" }), chain: sepolia, - signer, + signer: privateKeyToAccount("0xYOUR_PRIVATE_KEY" as const), }); // Request a Smart Contract Account - const account = await client.requestAccount(); + const { address } = await client.requestAccount({ creationHint: { accountType: "sma-b" } }); - // Use the SCA address as the `from` param to bypass 7702 mode + // Pass the SCA address as the account to use non-7702 mode await client.sendCalls({ - from: account.address, + account: address, calls: [...], }); ``` @@ -70,7 +71,7 @@ When you call `wallet_requestAccount` with a signer address, it creates a dedica "id": 1, "jsonrpc": "2.0", "method": "wallet_requestAccount", - "params": [{ "signerAddress": "'$SIGNER_ADDRESS'" }] + "params": [{ "signerAddress": "'$SIGNER_ADDRESS'", "creationHint": { "accountType": "sma-b" } }] }' | jq -r '.result.accountAddress') # Use the SCA address (not the signer address) in subsequent calls @@ -173,9 +174,9 @@ When you call `wallet_requestAccount` with a signer address, it creates a dedica To reset an account back to a pure EOA, delegate to `0x0000000000000000000000000000000000000000` as defined in [EIP-7702](https://eips.ethereum.org/EIPS/eip-7702#behavior). + - **Undelegating (returning to a pure EOA)** - + To remove a delegation and return an account to a pure EOA, you must **re-delegate to the zero address**: `0x0000000000000000000000000000000000000000`. @@ -191,9 +192,7 @@ When you call `wallet_requestAccount` with a signer address, it creates a dedica [Viem signAuthorization](https://viem.sh/docs/eip7702/signAuthorization). - - - + ## Next steps diff --git a/content/wallets/pages/transactions/using-eip-7702/third-party.mdx b/content/wallets/pages/transactions/using-eip-7702/third-party.mdx deleted file mode 100644 index 2a90c7a8c..000000000 --- a/content/wallets/pages/transactions/using-eip-7702/third-party.mdx +++ /dev/null @@ -1,220 +0,0 @@ -If you have an existing custom signer or another third-party embedded wallet provider, you can upgrade your embedded EOAs to smart wallets by connecting your existing signer. -This will allow you to use EIP-7702 to get features like gas sponsorship, batching, and more. - - - **Requirement:** Your signer or embedded wallet provider must support signing - EIP-7702 authorizations in order to delegate to a smart account. - - -To bring your own signer, you create a `SmartAccountSigner` that implements `signAuthorization`. See the details for the interface requirements [here](/docs/wallets/resources/types#smartaccountsigner). - -For example, you can upgrade an existing Privy embedded EOA by extending a Wallet Client to use the `sign7702Authorization` action exposed by Privy. -See full example code [here](https://github.com/alchemyplatform/alchemy-wallets-7702-thirdparty-example). - -The bulk of the logic happens in [`use-embedded-smart-wallet.ts`](https://github.com/alchemyplatform/alchemy-wallets-7702-thirdparty-example/blob/main/hooks/use-smart-embedded-wallet.ts). -In this react hook, a Privy embedded wallet is wrapped in a `WalletClientSigner` that supports `signAuthorization`. -This signer is then passed to `createSmartWalletClient` to construct a client for sending transactions. - - - -```ts twoslash title="use-smart-embedded-wallet.ts" -import { Address, Authorization, createWalletClient, custom } from "viem"; -import { useSign7702Authorization } from "@privy-io/react-auth"; -import { AuthorizationRequest, WalletClientSigner } from "@aa-sdk/core"; -import { sepolia, alchemy } from "@account-kit/infra"; -import { useEffect, useState } from "react"; -import { - createSmartWalletClient, - SmartWalletClient, -} from "@account-kit/wallet-client"; -import { ConnectedWallet as PrivyWallet } from "@privy-io/react-auth"; - -/\*_ Creates an Alchemy Smart Wallet client for an embedded Privy wallet using EIP-7702. _/; -export const useSmartEmbeddedWallet = ({ - embeddedWallet, -}: { - embeddedWallet: PrivyWallet; -}) => { - const { signAuthorization } = useSign7702Authorization(); - const [client, setClient] = useState(); - - useEffect(() => { - const apiKey = process.env.NEXT_PUBLIC_ALCHEMY_API_KEY; - if (!apiKey) { - throw new Error("Missing NEXT_PUBLIC_ALCHEMY_API_KEY"); - } - (async () => { - const provider = await embeddedWallet.getEthereumProvider(); - - const baseSigner = new WalletClientSigner( - createWalletClient({ - account: embeddedWallet.address as Address, - chain: sepolia, - transport: custom(provider), - }), - "privy", - ); - - const signer = { - ...baseSigner, - signAuthorization: async ( - unsignedAuth: AuthorizationRequest, - ): Promise> => { - const signature = await signAuthorization({ - ...unsignedAuth, - contractAddress: - unsignedAuth.address ?? unsignedAuth.contractAddress, - }); - - return { - ...unsignedAuth, - ...signature, - }; - }, - }; - - const client = createSmartWalletClient({ - chain: sepolia, - transport: alchemy({ - apiKey, - }), - signer, - policyId: process.env.NEXT_PUBLIC_ALCHEMY_POLICY_ID, - }); - - setClient(client); - })(); - }, [embeddedWallet, signAuthorization]); - - return { client }; -}; -``` - - - -When using the `SmartWalletClient` you must set the `eip7702Auth` capability to `true`, as shown in [`smart-wallet-demo.tsx`](https://github.com/alchemyplatform/alchemy-wallets-7702-thirdparty-example/blob/main/components/smart-wallet-demo.tsx) - - - -```tsx twoslash title="smart-wallet-demo.tsx" focus={11, 27-30} -import { ConnectedWallet as PrivyWallet } from "@privy-io/react-auth"; -import { useSmartEmbeddedWallet } from "../hooks/use-smart-embedded-wallet"; -import { useCallback, useState } from "react"; -import type { Address, Hex } from "viem"; - -export const SmartWalletDemo = ({ - embeddedWallet, -}: { - embeddedWallet: PrivyWallet; -}) => { - const { client } = useSmartEmbeddedWallet({ embeddedWallet }); - - const [status, setStatus] = useState< - | { status: "idle" | "error" | "sending" } - | { status: "success"; txHash: Hex } - >({ status: "idle" }); - - const delegateAndSend = useCallback(async () => { - if (!client) { - return; - } - - setStatus({ status: "sending" }); - try { - const { - id: callId, - } = await client.sendCalls({ - capabilities: { - eip7702Auth: true, - }, - from: embeddedWallet.address as Address, - calls: [ - { - to: "0x0000000000000000000000000000000000000000", - data: "0x", - }, - ], - }); - if (!callId) { - throw new Error("Missing call id"); - } - - const { receipts } = await client.waitForCallsStatus({ id: callId }); - if (!receipts?.length) { - throw new Error("Missing transaction receipts"); - } - const [receipt] = receipts; - if (receipt?.status !== "success") { - throw new Error("Transaction failed"); - } - setStatus({ status: "success", txHash: receipt.transactionHash }); - } catch (err) { - console.error("Transaction failed:", err); - setStatus({ status: "error" }); - } - }, [client, embeddedWallet]); - - return ( -
-
-

- Embedded EOA Address -

-

- {embeddedWallet.address} -

-
- - {status.status === "success" && ( -
-

- Congrats! Sponsored transaction successful! -

-

- You've successfully upgraded your EOA to a smart account and sent - your first sponsored transaction.{" "} - - Keep building - - . -

-

- Transaction Hash:{" "} - {status.txHash} -

-
- )} - {status.status === "error" && ( -
-

- Transaction Failed -

-

- There was an error sending your sponsored transaction. Please try - again. -

-
- )} -
- ); -}; -``` - - diff --git a/content/wallets/pages/troubleshooting/wallet-apis-errors.mdx b/content/wallets/pages/troubleshooting/wallet-apis-errors.mdx index 61ad3ee88..11e318ebd 100644 --- a/content/wallets/pages/troubleshooting/wallet-apis-errors.mdx +++ b/content/wallets/pages/troubleshooting/wallet-apis-errors.mdx @@ -120,7 +120,7 @@ When working with Wallet APIs, you may encounter various errors. Here are some c The call was rejected because it contains an invalid signature from the sender. Be sure that you are correctly signing the signature request(s). Refer to the [Wallet API - quickstart](/docs/wallets/smart-wallet-quickstart/api#3-sign-the-userop) for + quickstart](/docs/wallets/reference/smart-wallet-quickstart#2-sign-the-signature-requests) for more info. diff --git a/content/wallets/shared/v4-accordion.mdx b/content/wallets/shared/v4-accordion.mdx new file mode 100644 index 000000000..711f70956 --- /dev/null +++ b/content/wallets/shared/v4-accordion.mdx @@ -0,0 +1,29 @@ + +The examples on this page use `@alchemy/wallet-apis` (v5.x.x). If you're using `@account-kit/wallet-client` (v4.x.x), the client setup looks like this: + +```ts title="client.ts (v4.x.x)" +import { LocalAccountSigner } from "@aa-sdk/core"; +import { createSmartWalletClient } from "@account-kit/wallet-client"; +import { alchemy, sepolia } from "@account-kit/infra"; + +const signer = LocalAccountSigner.privateKeyToAccountSigner("0xYOUR_PRIVATE_KEY" as const); + +export const client = createSmartWalletClient({ + transport: alchemy({ apiKey: "YOUR_API_KEY" }), + chain: sepolia, + signer, + account: signer.address, // can also be passed per action as `from` or `account` + // Optional: sponsor gas for your users (see "Sponsor gas" guide) + policyId: "YOUR_POLICY_ID", +}); +``` + +Key v4.x.x differences: +* **Account address** must be specified on the client or per action (`from` or `account`). In v5.x.x, the client automatically uses the signer's address as the account address via [EIP-7702](/docs/wallets/transactions/using-eip-7702). +* **Chain imports** come directly from `@account-kit/infra` instead of `viem/chains`. +* **Numeric values** use hex strings: `value: "0x0"` instead of `value: BigInt(0)`. +* In v4.x.x, the **paymaster capability** on `prepareCalls` or `sendCalls` is called `paymasterService` instead of `paymaster`, or you can set the `policyId` directly on the client. +* **Signers** use `LocalAccountSigner` / `WalletClientSigner` from `@aa-sdk/core`. In v5.x.x, a viem `LocalAccount` or `WalletClient` is used directly. + +See the [full migration guide](/docs/wallets/resources/migration-v5) for a complete cheat sheet. + diff --git a/scripts/link-check-comment.js b/scripts/link-check-comment.js index bce578d4d..82b23df7f 100644 --- a/scripts/link-check-comment.js +++ b/scripts/link-check-comment.js @@ -15,12 +15,10 @@ const formatSummaryTable = (stats) => { ["⛔ Unsupported", stats.unsupported ?? 0], ]; - const body = rows.map(([label, value]) => `| ${label} | ${value} |`).join("\n"); - return [ - "| Status | Count |", - "|---|---:|", - body, - ].join("\n"); + const body = rows + .map(([label, value]) => `| ${label} | ${value} |`) + .join("\n"); + return ["| Status | Count |", "|---|---:|", body].join("\n"); }; const formatErrorsSection = (errorMap = {}) => { @@ -67,7 +65,8 @@ const getCommentBody = ({ reportJsonContent, runUrl, }) => { - const { summary, errorsSection, errorCount } = parseJsonReport(reportJsonContent); + const { summary, errorsSection, errorCount } = + parseJsonReport(reportJsonContent); const status = getStatusDisplay({ hasContentChanges, lycheeStatus, diff --git a/src/content-indexer/utils/__tests__/normalization.test.ts b/src/content-indexer/utils/__tests__/normalization.test.ts index 145fd47a2..b8d65d121 100644 --- a/src/content-indexer/utils/__tests__/normalization.test.ts +++ b/src/content-indexer/utils/__tests__/normalization.test.ts @@ -42,7 +42,10 @@ describe("normalization utils", () => { describe("normalizeFilePath", () => { test("should remove stripPathPrefix", () => { - const result = normalizeFilePath("content/guides/quickstart.mdx", "content/"); + const result = normalizeFilePath( + "content/guides/quickstart.mdx", + "content/", + ); expect(result).toBe("guides/quickstart.mdx"); });