feat: 'getChains' for custom rainbowkit chains with wagmi v2

rainbow-me · Jan 22, 2024 · 4644434 · 4644434
1 parent 0f62e35
commit 4644434
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 10 deletions.
diff --git a/packages/rainbowkit/src/components/RainbowKitProvider/provideRainbowKitChains.ts b/packages/rainbowkit/src/components/RainbowKitProvider/provideRainbowKitChains.ts
@@ -153,13 +153,27 @@ const chainMetadataById = Object.fromEntries(
     .map(({ chainId, ...metadata }) => [chainId, metadata]),
 );
 
-export const provideRainbowKitChains = (chains: readonly [Chain, ...Chain[]]) =>
-  chains.map((chain) => {
-    const defaultMetadata = chainMetadataById[chain.id] ?? {};
-    return {
-      ...chain,
-      name: defaultMetadata.name ?? chain.name, // Favor colloquial names
-      iconUrl: defaultMetadata.iconUrl,
-      iconBackground: defaultMetadata.iconBackground,
-    } as RainbowKitChain;
-  });
+const transformChainMetaData = (chain: RainbowKitChain) => {
+  const defaultMetadata = chainMetadataById[chain.id] ?? {};
+  return {
+    ...chain,
+    name: defaultMetadata.name ?? chain.name, // favor colloquial names
+    iconUrl: chain.iconUrl ?? defaultMetadata.iconUrl,
+    iconBackground: chain.iconBackground ?? defaultMetadata.iconBackground,
+  } as RainbowKitChain;
+};
+
+export const provideRainbowKitChains = (
+  chains: readonly [Chain, ...Chain[]],
+) => {
+  return chains.map(transformChainMetaData);
+};
+
+export const getChains = (
+  chains: readonly [RainbowKitChain, ...RainbowKitChain[]],
+): readonly [Chain, ...Chain[]] => {
+  const rainbowKitChains = provideRainbowKitChains(chains);
+
+  // Construct a tuple from the array as required by wagmi = readonly [Chain, ...Chain[]]
+  return [rainbowKitChains[0], ...rainbowKitChains.slice(1)];
+};
diff --git a/packages/rainbowkit/src/index.ts b/packages/rainbowkit/src/index.ts
@@ -15,6 +15,8 @@ export {
   RainbowKitAuthenticationProvider,
   createAuthenticationAdapter,
 } from './components/RainbowKitProvider/AuthenticationContext';
+export { getChains } from './components/RainbowKitProvider/provideRainbowKitChains';
+export type { RainbowKitChain as Chain } from './components/RainbowKitProvider/RainbowKitChainContext';
 export type {
   Wallet,
   WalletList,