遷移到 RainbowKit 和 Wagmi v2

wagmi 和 viem 的對等依賴已經達到 2.x.x 版本，並且有重大更改。

請遵循以下步驟進行遷移。

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

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

2. 安裝 @tanstack/react-query 等級的依賴項

使用 Wagmi v2 時，TanStack Query 現在是一個必要的對等依賴。

使用以下命令安裝它：

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 和更多）將自動出現在錢包連接體驗的已安裝部分中。這確保用戶能隨時找到其喜愛的錢包並無衝突地連接到 dApp。

開發者繼續對自定義錢包列表擁有完全控制，以強調針對終端用戶的偏好錢包。建議您繼續在列表中包含 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. RainbowKitProvider

您不再需要將 chains 傳遞給 <RainbowKitProvider>。

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

4. 自定義鏈

根據 Wagmi v2 的變更，Chain 類型已經更改，但仍然支援 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 中的任何自定義錢包連接器。

錢包連接器現在還通過 rdns prop 支援 EIP-6963 標準。確保已填充此信息，以防止在您的錢包列表中重複引用支援 EIP-6963 的錢包。

請在 GitHub 上這裡報告任何針對 RainbowKit v2 的問題或反饋。