遷移至RainbowKit和Wagmi v2

wagmi 和 viem 的peer dependencies已升級至 2.x.x，並有重大更改。

請按照以下步驟進行遷移。

1. 升級RainbowKit、wagmi和viem至最新版本

npm i @rainbow-me/rainbowkit wagmi [email protected]

2. 安裝@tanstack/react-query對等依賴

使用Wagmi v2時，TanStack Query現在是必須的peer dependency。

使用以下指令安裝：

npm i @tanstack/react-query

3. 升級您的RainbowKit和Wagmi配置

  import '@rainbow-me/rainbowkit/styles.css'

+ import { QueryClient, QueryClientProvider } from '@tanstack/react-query'
- import { createPublicClient, http } from 'viem'
- import { WagmiConfig } from 'wagmi'
+ import { WagmiProvider, http } from 'wagmi'
- import { configureChains, createConfig } from 'wagmi'
  import { mainnet } from 'wagmi/chains'
  import { RainbowKitProvider } from '@rainbow-me/rainbowkit'
- import { getDefaultWallets, connectorsForWallets } from '@rainbow-me/rainbowkit'
+ import { getDefaultConfig } from '@rainbow-me/rainbowkit'

  /* getDefaultWallets is now optional */
- const { wallets } = getDefaultWallets({
-   appName: 'RainbowKit demo',
-   projectId: 'YOUR_PROJECT_ID',
-   chains,
- })

  /* connectorsForWallets is now optional */
- const connectors = connectorsForWallets([...wallets])

- const { chains, publicClient } = configureChains( 
-   [mainnet, sepolia], 
-   [publicProvider(), publicProvider()],
- )

- const config = createConfig({
-   autoConnect: true,
-   publicClient,
- })

  /* New API that includes Wagmi's createConfig and replaces getDefaultWallets and connectorsForWallets */
+ const config = getDefaultConfig({
+   appName: 'RainbowKit demo',
+   projectId: 'YOUR_PROJECT_ID',
+   chains: [mainnet],
+   transports: {
+     [mainnet.id]: http(),
+   },
+ })

+ const queryClient = new QueryClient()

  const App = () => {
    return (
-     <WagmiConfig config={config}>
+     <WagmiProvider config={config}>
+       <QueryClientProvider client={queryClient}>
-         <RainbowKitProvider chains={chains}>
+         <RainbowKitProvider>
            {/* Your App */}
          </RainbowKitProvider>
+       </QueryClientProvider>
-     </WagmiConfig>
+     </WagmiProvider>
    )
  }

4. 檢查wagmi和viem中的重大變更

如果您在dApp中使用wagmi鉤子和viem行動，您需要遵循v2的遷移指南：

RainbowKit 更新

1. 改善 EIP-6963 錢包的行為

支持新 EIP-6963 連接標準的錢包（包括 Rainbow、MetaMask 及其他）將現在會在連接錢包過程中自動出現在「已安裝」部分。這確保用戶能夠始終找到他們喜愛的錢包，並在沒有沖突或備用按鈕的情況下連接到dApps。

開發者仍可完全控制自訂錢包列表，以突出用戶偏好的錢包。我們鼓勵您繼續在列表中包含injectedWallet和walletConnectWallet，以支持所有平台。

2. 使用getDefaultConfig的Wagmi配置

此新API簡化了配置體驗，替代了直接使用Wagmi的createConfig的需求。鏈配置簡化，包括推斷的公共提供者用於transports。

預設錢包列表將會自動包含，不再需要使用getDefaultWallets和connectorsForWallets。

您可以通過傳遞導入或自訂錢包連接器到wallets來創建自訂錢包列表。不再需要初始化錢包連接器並傳遞projectId和chains。

const config = getDefaultConfig({
  appName: 'RainbowKit demo',
  projectId: 'YOUR_PROJECT_ID',
  chains: [mainnet],
  wallets: [rainbowWallet], /* optional custom wallet list */
  /* Wagmi createConfig options including `transports` are also accepted */
})

3. RainbowKit提供者

您無需再向<RainbowKitProvider>傳遞chains。

- <RainbowKitProvider chains={chains}>
+ <RainbowKitProvider>

4. 自訂鏈

Chain類型按照Wagmi v2進行更改，但仍然支持RainbowKit的iconUrl和iconBackground元數據。

+ import { Chain } from '@rainbow-me/rainbowkit'

  const avalanche = {
    id: 43_114,
    name: 'Avalanche',
    iconUrl: 'https://s2.coinmarketcap.com/static/img/coins/64x64/5805.png',
    iconBackground: '#fff',
    nativeCurrency: { name: 'Avalanche', symbol: 'AVAX', decimals: 18 },
    rpcUrls: {
      default: { http: ['https://api.avax.network/ext/bc/C/rpc'] },
    },
    blockExplorers: {
      default: { name: 'SnowTrace', url: 'https://snowtrace.io' },
    },
    contracts: {
      multicall3: {
        address: '0xca11bde05977b3631167028862be2a173976ca11',
        blockCreated: 11_907_934,
      },
    },
  } as const satisfies Chain

使用getDefaultConfig的示例：

const config = getDefaultConfig({
+ chains: [
+   avalanche, /* custom chain */
+   {
+     ...mainnet,
+     iconBackground: '#000',
+     iconUrl: 'https://example.com/icons/ethereum.png',
+   }, /* metadata overrides */
+ ],
});

使用createConfig的示例：

+ import { Chain } from '@rainbow-me/rainbowkit'
+ const chains: readonly [Chain, ...Chain[]] = [
+   {
+     ...mainnet,
+     iconBackground: '#000',
+     iconUrl: 'https://example.com/icons/ethereum.png',
+   },
+ ];
  const config = createConfig({
    chains,
    transports: {
      [mainnet.id]: http(),
    },
  })

5. 自訂錢包

RainbowKit錢包連接器已做出重大更改以支持Wagmi v2。請參考更新的文檔和一個示例連接器以升級您dApp中的任何自訂錢包連接器。

錢包連接器現在還支持EIP-6963標準，具有rdns屬性。確保填寫此字段以防止在您的錢包列表中對支持EIP-6963的錢包重複引用。

如有任何問題或反饋，請在GitHub上這裡報告RainbowKit v2。