Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: updating chain details and adding instructions for using a different chain #5

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: updating chain details and adding instructions for using a different chain #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ The quickstart documentation is available at [Alchemy's Account Kit docs](https:

It leverages Alchemy Embedded Accounts using [Account Kit](https://accountkit.alchemy.com/) and the [Alchemy Signer](https://accountkit.alchemy.com/packages/aa-alchemy/signer/overview.html), [Modular Smart Contract Account](https://github.com/alchemyplatform/modular-account), [Rundler](https://github.com/alchemyplatform/rundler) and [Gas Manager](https://docs.alchemy.com/docs/gas-manager-services).

Before running this application, copy the `.env.sample` file to a new `.env`, and follow the steps below to configure your environment variables.
Before running this application, copy the `.env.sample` file to a new `.env`, and follow the steps below to configure your environment variables.

This demo currently uses Arbitrum Sepolia.

## Configure Your Embedded Accounts

Expand All @@ -16,10 +18,17 @@ Create an Alchemy API key, an Embedded Accounts Config, and a Gas Manager Policy

The Alchemy API Key will allow you to read and write to blockchains through Alchemy’s reliable infrastructure. In this context, the API Key will let you created Embedded Accounts onchain for your users, and send UserOperations on behalf of those accounts.

To create an API Key, go to [https://dashboard.alchemy.com](https://dashboard.alchemy.com), sign up for an account, and go through the onboarding. Then on the [apps](https://dashboard.alchemy.com/apps) page, create an Alchemy app for the Optimism Sepolia network.
To create an API Key, go to [https://dashboard.alchemy.com](https://dashboard.alchemy.com), sign up for an account, and go through the onboarding. Then on the [apps](https://dashboard.alchemy.com/apps) page, create an Alchemy app for the **Arbitrum Sepolia network**.

Click the API Key button in the top right corner and copy-paste it into the `.env` file of your application as an environment variable called `ALCHEMY_API_KEY`.

> ❗️ Chain configuration
>
> This demo currently uses Arbitrum Sepolia. If you would like to use a different chain please select the chain in the app creation step above AND update the chain imports and reference in 3 places (the chain must be imported from the @alchemy/aa-core package):
> 1. [src/app/providers.tsx](https://github.com/alchemyplatform/embedded-accounts-quickstart/blob/3258d95067389e80d42a200a6c84cbf64e44672c/src/app/providers.tsx#L13)
> 2. [src/components/SendUOButton.tsx](https://github.com/alchemyplatform/embedded-accounts-quickstart/blob/3258d95067389e80d42a200a6c84cbf64e44672c/src/components/SendUOButton.tsx#L62)
> 3. [src/app/api/rpc/route.ts](https://github.com/alchemyplatform/embedded-accounts-quickstart/blob/3258d95067389e80d42a200a6c84cbf64e44672c/src/app/api/rpc/route.ts#L6)
Comment on lines +28 to +30
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

these links should point to the blob on main rather than to a specific commit


### Alchemy Embedded Accounts Config

The Embedded Accounts Config enables magic auth on your app’s domain by configuring the Alchemy Signer, which securely stores the user’s private key in a non-custodial [secure enclave](https://docs.turnkey.com/security/our-approach). It is responsible for authenticating a user via email or passkey using this config, managing a user’s, and signing messages to send UserOperations. Check out the [AlchemySigner docs](https://accountkit.alchemy.com/packages/aa-alchemy/signer/overview.html) for more details.
Expand Down