feat: add createAlchemyConfig and AlchemyProvider by blakecduncan · Pull Request #2125 · alchemyplatform/aa-sdk

blakecduncan · 2025-09-26T20:38:07Z

Pull Request Checklist

Did you add new tests and confirm existing tests pass? (yarn test)
Did you update relevant docs? (docs are found in the site folder, and guidelines for updating/adding docs can be found in the contribution guide)
Do your commits follow the Conventional Commits standard?
Does your PR title also follow the Conventional Commits standard?
If you have a breaking change, is it correctly reflected in your commit message? (e.g. feat!: breaking change)
Did you run lint (yarn lint:check) and fix any issues? (yarn lint:write)
Did you follow the contribution guidelines?

PR-Codex overview

This PR introduces the AlchemyProvider and a simplified configuration method createAlchemyConfig for React applications, replacing the previous WagmiProvider integration. It aims to streamline the setup for using Alchemy services in React.

Detailed summary

Added @alchemy/connectors-web as a dependency.
Introduced createAlchemyConfig for easier configuration.
Added AlchemyProvider component to replace WagmiProvider.
Updated example app to use AlchemyProvider.
Enhanced type exports for better TypeScript support.
Updated documentation for createAlchemyConfig and AlchemyProvider.

The following files were skipped due to too many changes: yarn.lock

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

vercel · 2025-09-26T20:38:14Z

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment

Project	Deployment	Preview	Comments	Updated (UTC)
aa-sdk-ui-demo	Ignored	Preview		Sep 30, 2025 4:58pm

github-actions · 2025-09-26T20:38:28Z

🌿 Documentation Preview

Name	Status	Preview	Updated (UTC)
Alchemy Docs	✅ Ready	🔗 Visit Preview	Sep 30, 2025, 5:00 PM

blakecduncan · 2025-09-26T20:42:38Z

+    ...(apiKey ? [alchemyAuth({ apiKey })] : []),
+  ];
+
+  const wagmiConfig = createConfig({


I ended up not implementing the wagmiOverrides option in this PR. I wanted to get some opinions on it. I struggled getting the types to work for some reason, I kept getting a type error when doing a shallow copy into the params.

It got me thinking, I wonder if we should just try to expose options that we see fit (rather than a full wagmiOverrides option. And if anyone needs a bunch of wagmi overrides, we just recommend they build the wagmi config themselves.

jakehobbs · 2025-09-26T20:51:01Z

@@ -77,6 +77,64 @@
  resolved "https://registry.yarnpkg.com/@adraffy/ens-normalize/-/ens-normalize-1.11.0.tgz#42cc67c5baa407ac25059fcd7d405cc5ecdb0c33"
  integrity sha512-/3DDPKHqqIqxUULp8yP4zODUY1i+2xvVWsv8A79xGWdCAG+8sb0hRh0Rk2QyOJUnnbyPUAZYcpBuRe3nS2OIUg==

+"@alchemy/aa-accounts@3.14.1":


do you need this many lockfile changes?

I added @alchemy/connectors-web as a dependency in the @alchemy/react package and yarn updated all these dependencies.

I typically trust the lock updates when I add a package, is there a different way I should be adding packages? right now I just did

yarn add @alchemy/connectors-web

gotcha, should be fine then! was just a little surprised that would change so much.

yeah strange, i ran it locally too and verified this causes a bunch of changes

jakehobbs · 2025-09-26T23:09:33Z

-      apiKey: process.env.NEXT_PUBLIC_ALCHEMY_API_KEY,
-    }),
-  ],
+export const config = createAlchemyConfig({


jakehobbs · 2025-09-29T17:06:26Z

Sign in to view

+export function AlchemyProvider({ config, children }: AlchemyProviderProps) {
+  return (
+    <WagmiProvider config={config.wagmi}>
+      {children as any}


Sign in to view

+    return perChain;
+  })();
+
+  // Note: Currently using alchemyAuth; swap to alchemySmartWallet when ready.


Sign in to view

+
+  const wagmiConfig = createConfig({
+    chains,
+    transports: transports!,


thebrianchen

this is beautiful. loving the devEx here

thebrianchen · 2025-09-29T22:13:40Z

@@ -77,6 +77,64 @@
  resolved "https://registry.yarnpkg.com/@adraffy/ens-normalize/-/ens-normalize-1.11.0.tgz#42cc67c5baa407ac25059fcd7d405cc5ecdb0c33"
  integrity sha512-/3DDPKHqqIqxUULp8yP4zODUY1i+2xvVWsv8A79xGWdCAG+8sb0hRh0Rk2QyOJUnnbyPUAZYcpBuRe3nS2OIUg==

+"@alchemy/aa-accounts@3.14.1":


yeah strange, i ran it locally too and verified this causes a bunch of changes

Copilot

Pull Request Overview

This PR introduces new React components and configuration utilities for the Alchemy SDK, providing a simplified way to set up Alchemy in React applications. The main goal is to reduce boilerplate code by automatically configuring wagmi with Alchemy-specific defaults.

Adds createAlchemyConfig function to simplify wagmi configuration with Alchemy services
Introduces AlchemyProvider component as a wrapper around wagmi providers
Updates example application to demonstrate the new simplified configuration approach

Reviewed Changes

Copilot reviewed 8 out of 9 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
packages/react/src/index.ts	Exports new configuration and provider components
packages/react/src/createAlchemyConfig.ts	New configuration function that sets up wagmi with Alchemy defaults
packages/react/src/AlchemyProvider.tsx	New provider component wrapping wagmi with future extensibility
packages/react/package.json	Adds dependency on @alchemy/connectors-web
examples/react-v5-example/src/app/providers.tsx	Updates to use AlchemyProvider instead of WagmiProvider
examples/react-v5-example/src/app/config.ts	Simplifies configuration using createAlchemyConfig
docs/pages/reference/alchemy/react/functions/createAlchemyConfig.mdx	Documentation for new configuration function
docs/pages/reference/alchemy/react/components/AlchemyProvider.mdx	Documentation for new provider component

Copilot · 2025-09-30T16:58:20Z

+    ssr = false,
+  } = options;
+
+  if (!chains?.length) {


The optional chaining ?. is unnecessary here since chains is a required parameter with type [Chain, ...Chain[]]. This will always be defined and have at least one element due to the type constraint.

Suggested change

if (!chains?.length) {

if (!chains.length) {

Copilot · 2025-09-30T16:58:21Z

+---
+# This file is autogenerated
+title: createAlchemyConfig
+description: Overview of the createAlchemyConfig method


The description refers to createAlchemyConfig as a 'method' but it's actually a function. Should be 'Overview of the createAlchemyConfig function' to be technically accurate.

Copilot · 2025-09-30T16:58:21Z

+---
+# This file is autogenerated
+title: AlchemyProvider
+description: Overview of the AlchemyProvider method


The description refers to AlchemyProvider as a 'method' but it's actually a React component. Should be 'Overview of the AlchemyProvider component' to be technically accurate.

blakecduncan added 2 commits September 26, 2025 15:03

feat: add creatAlchemyConfig and AlchemyProvider

2a8be0c

feat: clean up interface and update example

482d5ff

github-actions Bot temporarily deployed to docs-preview September 26, 2025 20:38 Inactive

blakecduncan commented Sep 26, 2025

View reviewed changes

jakehobbs reviewed Sep 26, 2025

View reviewed changes

fix: remove unnecessary readonly

750fd0e

vercel Bot deployed to Preview September 26, 2025 21:12 View deployment

jakehobbs reviewed Sep 26, 2025

View reviewed changes

fix: pr comments

51c0f74

vercel Bot deployed to Preview September 29, 2025 15:03 View deployment

blakecduncan requested a review from jakehobbs September 29, 2025 17:01

jakehobbs approved these changes Sep 29, 2025

View reviewed changes

blakecduncan added 2 commits September 29, 2025 15:46

Merge branch 'moldy/v5-base' into blake/create-alchemy-config

1de77b7

fix: yarn.lock from merge

9ea5c19

github-actions Bot temporarily deployed to docs-preview September 29, 2025 19:50 Inactive

vercel Bot deployed to Preview September 29, 2025 19:54 View deployment

thebrianchen approved these changes Sep 29, 2025

View reviewed changes

Merge branch 'moldy/v5-base' into blake/create-alchemy-config

89713d6

Copilot AI review requested due to automatic review settings September 30, 2025 16:57

Copilot AI reviewed Sep 30, 2025

View reviewed changes

github-actions Bot temporarily deployed to docs-preview September 30, 2025 16:58 Inactive

dphilipson approved these changes Oct 1, 2025

View reviewed changes

blakecduncan closed this Mar 5, 2026

Conversation

blakecduncan commented Sep 26, 2025 • edited by pr-codex Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Checklist

PR-Codex overview

Detailed summary

Uh oh!

vercel Bot commented Sep 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Sep 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🌿 Documentation Preview

Uh oh!

blakecduncan Sep 26, 2025

Choose a reason for hiding this comment

Uh oh!

jakehobbs Sep 26, 2025

Choose a reason for hiding this comment

Uh oh!

blakecduncan Sep 29, 2025

Choose a reason for hiding this comment

Uh oh!

jakehobbs Sep 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

thebrianchen Sep 29, 2025

Choose a reason for hiding this comment

Uh oh!

jakehobbs Sep 26, 2025

Choose a reason for hiding this comment

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

jakehobbs Sep 29, 2025

Choose a reason for hiding this comment

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

thebrianchen left a comment

Choose a reason for hiding this comment

Uh oh!

thebrianchen Sep 29, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Sep 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 30, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

blakecduncan commented Sep 26, 2025 •

edited by pr-codex Bot

Loading

vercel Bot commented Sep 26, 2025 •

edited

Loading

github-actions Bot commented Sep 26, 2025 •

edited

Loading

jakehobbs Sep 29, 2025 •

edited

Loading