Skip to content

Commit

Permalink
docs: legacy cleanup (#1631)
Browse files Browse the repository at this point in the history 
* docs: fix yourapp usage

* docs: fix legacy wagmiClient naming
  • Loading branch information
@DanielSinclair
DanielSinclair authored Nov 22, 2023
1 parent 0d0f861 commit 57f1087
Show file tree
Hide file tree
Showing 31 changed files with 41 additions and 39 deletions.
4 changes: 2 additions & 2 deletions examples/with-next-rainbow-button/pages/_app.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ const { chains, publicClient, webSocketPublicClient } = configureChains(

const projectId = "YOUR_PROJECT_ID";

const wagmiClient = createConfig({
const config = createConfig({
autoConnect: true,
connectors: [new RainbowConnector({ chains, projectId })],
publicClient,
Expand All @@ -22,7 +22,7 @@ const wagmiClient = createConfig({

function MyApp({ Component, pageProps }: AppProps) {
return (
<WagmiConfig config={wagmiClient}>
<WagmiConfig config={config}>
<RainbowButtonProvider>
<Component {...pageProps} />
</RainbowButtonProvider>
Expand Down
4 changes: 2 additions & 2 deletions examples/with-next-wallet-button/pages/_app.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ const connectors = connectorsForWallets([
metaMaskWallet({ projectId, chains }),
]);

const wagmiClient = createConfig({
const config = createConfig({
autoConnect: true,
connectors: [
...connectors,
Expand All @@ -46,7 +46,7 @@ const wagmiClient = createConfig({

function MyApp({ Component, pageProps }: AppProps) {
return (
<WagmiConfig config={wagmiClient}>
<WagmiConfig config={config}>
<RainbowKitProvider chains={chains}>
<Component {...pageProps} />
</RainbowKitProvider>
Expand Down
8 changes: 5 additions & 3 deletions packages/rainbow-button/CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,17 @@
RainbowConnector,
} from "@rainbow-me/rainbow-button";

const wagmiClient = createConfig({
const config = createConfig({
connectors: [new RainbowConnector({ chains, projectId })],
publicClient,
});

function MyApp({ Component, pageProps }: AppProps) {
return (
<WagmiConfig config={wagmiClient}>
<RainbowButtonProvider>{/* Your App */}</RainbowButtonProvider>
<WagmiConfig config={config}>
<RainbowButtonProvider>
{/* Your App */}
</RainbowButtonProvider>
</WagmiConfig>
);
}
Expand Down
8 changes: 4 additions & 4 deletions packages/rainbowkit/CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2083,7 +2083,7 @@
return (
<WagmiProvider autoConnect connectors={connectors} provider={provider}>
<RainbowKitProvider chains={chains}>
<YourApp />
{/* Your App */}
</RainbowKitProvider>
</WagmiProvider>
);
Expand All @@ -2105,7 +2105,7 @@
return (
<WagmiProvider client={wagmiClient}>
<RainbowKitProvider chains={chains}>
<YourApp />
{/* Your App */}
</RainbowKitProvider>
</WagmiProvider>
);
Expand Down Expand Up @@ -2270,7 +2270,7 @@
return (
<WagmiProvider client={wagmiClient}>
<RainbowKitProvider chains={chains}>
<YourApp />
{/* Your App */}
</RainbowKitProvider>
</WagmiProvider>
);
Expand Down Expand Up @@ -2310,7 +2310,7 @@
return (
<WagmiProvider client={wagmiClient}>
<RainbowKitProvider chains={chains}>
<YourApp />
{/* Your App */}
</RainbowKitProvider>
</WagmiProvider>
);
Expand Down
2 changes: 1 addition & 1 deletion site/data/ar/docs/custom-chains.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ const App = () => {
return (
<WagmiConfig config={wagmiConfig}>
<RainbowKitProvider chains={chains}>
<YourApp />
{/* Your App */}
</RainbowKitProvider>
</WagmiConfig>
);
Expand Down
2 changes: 1 addition & 1 deletion site/data/ar/docs/installation.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ const App = () => {
return (
<WagmiConfig config={wagmiConfig}>
<RainbowKitProvider chains={chains}>
<YourApp />
{/* Your App */}
</RainbowKitProvider>
</WagmiConfig>
);
Expand Down
2 changes: 1 addition & 1 deletion site/data/en-US/docs/custom-chains.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ const App = () => {
return (
<WagmiConfig config={wagmiConfig}>
<RainbowKitProvider chains={chains}>
<YourApp />
{/* Your App */}
</RainbowKitProvider>
</WagmiConfig>
);
Expand Down
2 changes: 1 addition & 1 deletion site/data/en-US/docs/installation.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ const App = () => {
return (
<WagmiConfig config={wagmiConfig}>
<RainbowKitProvider chains={chains}>
<YourApp />
{/* Your App */}
</RainbowKitProvider>
</WagmiConfig>
);
Expand Down
4 changes: 2 additions & 2 deletions site/data/en-US/guides/rainbow-button.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,14 @@ Pass an instance of the `RainbowConnector` to your Wagmi connector list, and wra
import '@rainbow-me/rainbow-button/styles.css';
import { RainbowButtonProvider, RainbowConnector } from "@rainbow-me/rainbow-button";

const wagmiClient = createConfig({
const config = createConfig({
connectors: [new RainbowConnector({ chains, projectId })],
publicClient
});

function MyApp({ Component, pageProps }: AppProps) {
return (
<WagmiConfig config={wagmiClient}>
<WagmiConfig config={config}>
<RainbowButtonProvider>
{/* Your App */}
</RainbowButtonProvider>
Expand Down
2 changes: 1 addition & 1 deletion site/data/es-419/docs/custom-chains.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ const App = () => {
return (
<WagmiConfig config={wagmiConfig}>
<RainbowKitProvider chains={chains}>
<YourApp />
{/* Your App */}
</RainbowKitProvider>
</WagmiConfig>
);
Expand Down
2 changes: 1 addition & 1 deletion site/data/es-419/docs/installation.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ const App = () => {
return (
<WagmiConfig config={wagmiConfig}>
<RainbowKitProvider chains={chains}>
<YourApp />
{/* Your App */}
</RainbowKitProvider>
</WagmiConfig>
);
Expand Down
2 changes: 1 addition & 1 deletion site/data/fr/docs/custom-chains.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ const App = () => {
return (
<WagmiConfig config={wagmiConfig}>
<RainbowKitProvider chains={chains}>
<YourApp />
{/* Your App */}
</RainbowKitProvider>
</WagmiConfig>
);
Expand Down
2 changes: 1 addition & 1 deletion site/data/fr/docs/installation.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ const App = () => {
return (
<WagmiConfig config={wagmiConfig}>
<RainbowKitProvider chains={chains}>
<YourApp />
{/* Your App */}
</RainbowKitProvider>
</WagmiConfig>
);
Expand Down
2 changes: 1 addition & 1 deletion site/data/hi/docs/custom-chains.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ const App = () => {
return (
<WagmiConfig config={wagmiConfig}>
<RainbowKitProvider chains={chains}>
<YourApp />
{/* Your App */}
</RainbowKitProvider>
</WagmiConfig>
);
Expand Down
2 changes: 1 addition & 1 deletion site/data/hi/docs/installation.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ const App = () => {
return (
<WagmiConfig config={wagmiConfig}>
<RainbowKitProvider chains={chains}>
<YourApp />
{/* Your App */}
</RainbowKitProvider>
</WagmiConfig>
);
Expand Down
2 changes: 1 addition & 1 deletion site/data/id/docs/custom-chains.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ const App = () => {
return (
<WagmiConfig config={wagmiConfig}>
<RainbowKitProvider chains={chains}>
<YourApp />
{/* Your App */}
</RainbowKitProvider>
</WagmiConfig>
);
Expand Down
2 changes: 1 addition & 1 deletion site/data/id/docs/installation.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ const App = () => {
return (
<WagmiConfig config={wagmiConfig}>
<RainbowKitProvider chains={chains}>
<YourApp />
{/* Your App */}
</RainbowKitProvider>
</WagmiConfig>
);
Expand Down
2 changes: 1 addition & 1 deletion site/data/ja/docs/custom-chains.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ const App = () => {
return (
<WagmiConfig config={wagmiConfig}>
<RainbowKitProvider chains={chains}>
<YourApp />
{/* Your App */}
</RainbowKitProvider>
</WagmiConfig>
);
Expand Down
2 changes: 1 addition & 1 deletion site/data/ja/docs/installation.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ const App = () => {
return (
<WagmiConfig config={wagmiConfig}>
<RainbowKitProvider chains={chains}>
<YourApp />
{/* Your App */}
</RainbowKitProvider>
</WagmiConfig>
);
Expand Down
2 changes: 1 addition & 1 deletion site/data/ko/docs/custom-chains.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ const App = () => {
return (
<WagmiConfig config={wagmiConfig}>
<RainbowKitProvider chains={chains}>
<YourApp />
{/* Your App */}
</RainbowKitProvider>
</WagmiConfig>
);
Expand Down
2 changes: 1 addition & 1 deletion site/data/ko/docs/installation.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ const App = () => {
return (
<WagmiConfig config={wagmiConfig}>
<RainbowKitProvider chains={chains}>
<YourApp />
{/* Your App */}
</RainbowKitProvider>
</WagmiConfig>
);
Expand Down
2 changes: 1 addition & 1 deletion site/data/pt-BR/docs/custom-chains.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ const App = () => {
return (
<WagmiConfig config={wagmiConfig}>
<RainbowKitProvider chains={chains}>
<YourApp />
{/* Your App */}
</RainbowKitProvider>
</WagmiConfig>
);
Expand Down
2 changes: 1 addition & 1 deletion site/data/pt-BR/docs/installation.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ const App = () => {
return (
<WagmiConfig config={wagmiConfig}>
<RainbowKitProvider chains={chains}>
<YourApp />
{/* Your App */}
</RainbowKitProvider>
</WagmiConfig>
);
Expand Down
2 changes: 1 addition & 1 deletion site/data/ru/docs/custom-chains.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ const App = () => {
return (
<WagmiConfig config={wagmiConfig}>
<RainbowKitProvider chains={chains}>
<YourApp />
{/* Your App */}
</RainbowKitProvider>
</WagmiConfig>
);
Expand Down
2 changes: 1 addition & 1 deletion site/data/ru/docs/installation.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ const App = () => {
return (
<WagmiConfig config={wagmiConfig}>
<RainbowKitProvider chains={chains}>
<YourApp />
{/* Your App */}
</RainbowKitProvider>
</WagmiConfig>
);
Expand Down
2 changes: 1 addition & 1 deletion site/data/th/docs/custom-chains.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ const App = () => {
return (
<WagmiConfig config={wagmiConfig}>
<RainbowKitProvider chains={chains}>
<YourApp />
{/* Your App */}
</RainbowKitProvider>
</WagmiConfig>
);
Expand Down
2 changes: 1 addition & 1 deletion site/data/th/docs/installation.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ const App = () => {
return (
<WagmiConfig config={wagmiConfig}>
<RainbowKitProvider chains={chains}>
<YourApp />
{/* Your App */}
</RainbowKitProvider>
</WagmiConfig>
);
Expand Down
2 changes: 1 addition & 1 deletion site/data/tr/docs/custom-chains.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ const App = () => {
return (
<WagmiConfig config={wagmiConfig}>
<RainbowKitProvider chains={chains}>
<YourApp />
{/* Your App */}
</RainbowKitProvider>
</WagmiConfig>
);
Expand Down
2 changes: 1 addition & 1 deletion site/data/tr/docs/installation.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ const App = () => {
return (
<WagmiConfig config={wagmiConfig}>
<RainbowKitProvider chains={chains}>
<YourApp />
{/* Your App */}
</RainbowKitProvider>
</WagmiConfig>
);
Expand Down
2 changes: 1 addition & 1 deletion site/data/zh-CN/docs/custom-chains.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ const App = () => {
return (
<WagmiConfig config={wagmiConfig}>
<RainbowKitProvider chains={chains}>
<YourApp />
{/* Your App */}
</RainbowKitProvider>
</WagmiConfig>
);
Expand Down
2 changes: 1 addition & 1 deletion site/data/zh-CN/docs/installation.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ const App = () => {
return (
<WagmiConfig config={wagmiConfig}>
<RainbowKitProvider chains={chains}>
<YourApp />
{/* Your App */}
</RainbowKitProvider>
</WagmiConfig>
);
Expand Down

2 comments on commit 57f1087

@vercel
Copy link

@vercel vercel bot commented on 57f1087 Nov 22, 2023

Choose a reason for hiding this comment

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

Successfully deployed to the following URLs:

rainbowkit-example – ./

rainbowkit-example-rainbowdotme.vercel.app
rainbowkit-example.vercel.app
rainbowkit-example-git-main-rainbowdotme.vercel.app

@vercel
Copy link

@vercel vercel bot commented on 57f1087 Nov 22, 2023

Choose a reason for hiding this comment

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

Successfully deployed to the following URLs:

rainbowkit-site – ./

rainbowkit-site-rainbowdotme.vercel.app
v1-rainbowkit.vercel.app
rainbowkit-site-git-main-rainbowdotme.vercel.app
www.rainbowkit.com
rainbowkit.vercel.app
v2-rainbowkit.vercel.app
rainbowkit.com

Please sign in to comment.