-
Notifications
You must be signed in to change notification settings - Fork 696
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Migration Guide Chinese Documentation Content Format Modification (#2059
- Loading branch information
Showing
1 changed file
with
25 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,7 +6,7 @@ title: 迁移指南 | |
|
||
## 迁移 RainbowKit | ||
|
||
### 1.x.x 破坏性更改 | ||
### 2.x.x 破坏性更改 | ||
|
||
[wagmi](https://wagmi.sh)和[viem](https://viem.sh)的对等依赖已升级到`2.x.x`版本,带来了重大变更。 | ||
|
||
|
@@ -18,7 +18,7 @@ title: 迁移指南 | |
npm i @rainbow-me/rainbowkit@2 wagmi@2 [email protected] | ||
``` | ||
|
||
**2. 安装 `viem` 对等依赖项** | ||
**2. 安装 `@tanstack/react-query` 对等依赖项** | ||
|
||
在 Wagmi v2 中,[TanStack Query](https://tanstack.com/query/v5/docs/react/overview) 现在是一个必需的同级依赖。 | ||
|
||
|
@@ -28,7 +28,7 @@ npm i @rainbow-me/rainbowkit@2 wagmi@2 [email protected] | |
npm i @tanstack/react-query | ||
``` | ||
|
||
\*\*1. RainbowKitProvider\*\* | ||
**3. 升级 RainbowKit 和 Wagmi 配置** | ||
|
||
```diff | ||
import '@rainbow-me/rainbowkit/styles.css' | ||
|
@@ -91,7 +91,7 @@ npm i @tanstack/react-query | |
} | ||
``` | ||
|
||
\*\*2. 检查`wagmi`中的破坏性变化\*\* | ||
**4. 检查 `wagmi` 和 `viem` 中的重大更改** | ||
|
||
如果您在 dApp 中使用 `wagmi` 钩子和 `viem` 操作,您将需要遵循 v2 的迁移指南: | ||
|
||
|
@@ -100,13 +100,13 @@ npm i @tanstack/react-query | |
|
||
#### RainbowKit更新 | ||
|
||
\*\*1. 改进了对EIP-6963钱包的支持\*\* | ||
**1. 改进了对EIP-6963钱包的支持** | ||
|
||
现在支持新的EIP-6963连接标准的钱包(包括Rainbow、MetaMask等)将自动显示在连接钱包体验的`Installed`部分。 这确保用户始终可以找到他们喜欢的钱包,并且在不发生冲突或需要后备按钮的情况下连接到dApps。 这确保用户始终可以找到他们喜欢的钱包,并且在不发生冲突或需要后备按钮的情况下连接到dApps。 | ||
|
||
开发者仍然可以完全控制自定义钱包列表,以强调终端用户首选的钱包。 建议您继续在列表中包含`injectedWallet`和`walletConnectWallet`,以支持所有平台。 建议您继续在列表中包含`injectedWallet`和`walletConnectWallet`,以支持所有平台。 | ||
|
||
**2. 安装 `viem` 对等依赖项** | ||
**2. 使用 getDefaultConfig 进行 Wagmi 配置** | ||
|
||
这个新的API简化了配置体验,取代了直接使用Wagmi的`createConfig`的需求。 链配置被简化,包括为`transports`推断出的公共提供者。 链配置被简化,包括为`transports`推断出的公共提供者。 链配置被简化,包括为`transports`推断出的公共提供者。 链配置被简化,包括为`transports`推断出的公共提供者。 链配置被简化,包括为`transports`推断出的公共提供者。 | ||
|
||
|
@@ -124,7 +124,7 @@ const config = getDefaultConfig({ | |
}) | ||
``` | ||
|
||
\*\*2. RainbowKitProvider\*\* | ||
**3. RainbowKitProvider** | ||
|
||
您不再需要将`chains`传递给`<RainbowKitProvider>`。 | ||
|
||
|
@@ -133,7 +133,7 @@ const config = getDefaultConfig({ | |
+ <RainbowKitProvider> | ||
``` | ||
|
||
\*\*2. 自定义链条\*\* | ||
**4. 自定义链条** | ||
|
||
与Wagmi v2一致,`Chain`类型已经改变,并继续支持 RainbowKit 的`iconUrl`和`iconBackground`元数据。 | ||
|
||
|
@@ -195,7 +195,7 @@ const config = getDefaultConfig({ | |
}) | ||
``` | ||
|
||
**4. 自定义钱包** | ||
**5. 自定义钱包** | ||
|
||
RainbowKit已采用`wagmi`中的`WalletConnectLegacyConnector`连接器,以便继续支持WalletConnect v1。 将很快提供对WalletConnect v2和`WalletConnectConnector`的支持,作为补丁版本发布,不会有破坏性的更改。 将很快提供对WalletConnect v2和`WalletConnectConnector`的支持,作为补丁版本发布,不会有破坏性的更改。 | ||
|
||
|
@@ -209,13 +209,13 @@ wagmi 的同级依赖项已更新为 `0.10.x`。 | |
|
||
按照以下步骤进行迁移。 | ||
|
||
\*\*1. 将RainbowKit和`wagmi`升级到最新版本 | ||
**1. 将RainbowKit和`wagmi`升级到最新版本** | ||
|
||
```bash | ||
npm i @rainbow-me/rainbowkit@^1 wagmi@^1 | ||
``` | ||
|
||
\*\*2. 安装 `viem` 对等依赖项\*\* | ||
**2. 安装 `viem` 对等依赖项** | ||
|
||
wagmi v1 需要 `viem` 对等依赖项。 使用以下命令安装: 使用以下命令安装: 使用以下命令安装: 使用以下命令安装: | ||
|
||
|
@@ -225,23 +225,23 @@ npm i viem | |
|
||
注意:wagmi 不再内部使用 `ethers` 包。 注意:wagmi 不再内部使用 `ethers` 包。 但如果你依赖 [Authentication](https://www.rainbowkit.com/docs/authentication) API,`siwe` 仍将需要 `ethers` 作为对等依赖。 | ||
|
||
\*\*3. 确保捆绑器和 polyfill 兼容性\*\* | ||
**3. 确保捆绑器和 polyfill 兼容性** | ||
|
||
在依赖 [ethers](https://docs.ethers.org/v5/) 的早期 wagmi 版本中,WalletConnect 需要的 `fs`,`net` 和 `tls` 模块会自动进行 polyfill。 这在基于 [viem](https://viem.sh/) 构建的 RainbowKit v1 + wagmi v1 中已不再是这样。 在依赖 [ethers](https://docs.ethers.org/v5/) 的早期 wagmi 版本中,WalletConnect 需要的 `fs`,`net` 和 `tls` 模块会自动进行 polyfill。 这在基于 [viem](https://viem.sh/) 构建的 RainbowKit v1 + wagmi v1 中已不再是这样。 在基于 [viem](https://viem.sh/) 的 RainbowKit v1 + wagmi v1 中,情况不再如此。 | ||
|
||
参考我们的 [Next.js Webpack Config](https://github.com/rainbow-me/rainbowkit/blob/main/examples/with-next/next.config.js) 和 [Create React App polyfills](https://github.com/rainbow-me/rainbowkit/blob/main/examples/with-create-react-app/src/polyfills.ts) 示例,以获得你的项目配置指导。 | ||
|
||
Vite和Remix的附加框架指南可在此处获取 [here](https://www.rainbowkit.com/docs/installation#additional-build-tooling-setup). | ||
|
||
\*\*2. 检查`wagmi`中的破坏性变化 | ||
**4. 检查`wagmi`中的破坏性变化** | ||
|
||
如果您在应用程序中使用`wagmi`钩子,您将需要按照`wagmi`的迁移指南进行升级到v1. | ||
|
||
[你可以在这里查看他们的迁移指南](https://wagmi.sh/react/migration-guide#09x-breaking-changes)。 | ||
|
||
### 0.8.x 版本破坏性更改 | ||
### 0.12.x 版本破坏性更改 | ||
|
||
wagmi的同级依赖性已更新至`0.8.x`。 | ||
wagmi的同级依赖性已更新至`0.12.x`。 | ||
|
||
RainbowKit已采用`wagmi`中的`WalletConnectLegacyConnector`连接器,以便继续支持WalletConnect v1. 将很快提供对WalletConnect v2和`WalletConnectConnector`的支持,作为补丁版本发布,不会有破坏性的更改。 | ||
|
||
|
@@ -291,13 +291,13 @@ wagmi 的同级依赖项已更新为 `0.11.x`。 | |
|
||
按照以下步骤进行迁移。 | ||
|
||
#### **1. 将 RainbowKit 和 `wagmi` 更新到最新版本** | ||
#### 1. 将 RainbowKit 和 `wagmi` 更新到最新版本 | ||
|
||
```bash | ||
npm i @rainbow-me/rainbowkit@^0.11.0 wagmi@^0.11.0 | ||
``` | ||
|
||
#### 4. 重命名 wagmi 的提供者 | ||
#### 2. 重命名 wagmi 的提供者 | ||
|
||
如果你在应用程序中使用 `wagmi` 钩子,你需要查看你的应用程序是否受到 `wagmi` 中的重大变动的影响。 | ||
|
||
|
@@ -315,7 +315,7 @@ wagmi 的同级依赖项已更新为 `0.10.x`。 | |
npm i @rainbow-me/rainbowkit@^0.10.0 wagmi@^0.10.0 | ||
``` | ||
|
||
#### 4. 重命名 wagmi 的提供者 | ||
#### 2. 重命名 wagmi 的提供者 | ||
|
||
如果你在应用中使用了`wagmi`的钩子,你需要检查你的应用是否受到了`wagmi`破坏性更改的影响。 | ||
|
||
|
@@ -333,15 +333,15 @@ wagmi的对等依赖已更新为`0.9.x`。 | |
npm i @rainbow-me/rainbowkit@^0.9.0 wagmi@^0.9.0 | ||
``` | ||
|
||
#### 4. 重命名 wagmi 的提供者 | ||
#### 2. 重命名 wagmi 的提供者 | ||
|
||
如果你在应用中使用了`wagmi`的钩子,你需要检查你的应用是否受到了`wagmi`破坏性更改的影响。 | ||
|
||
[您可以在此处查看他们的迁移指南](https://wagmi.sh/react/migration-guide). | ||
|
||
### 0.12.x版的重大更改 | ||
### 0.8.x版的重大更改 | ||
|
||
wagmi的同级依赖项已更新为`0.12.x`. | ||
wagmi的同级依赖项已更新为`0.8.x`. | ||
|
||
按以下步骤迁移。 | ||
|
||
|
@@ -351,7 +351,7 @@ wagmi的同级依赖项已更新为`0.12.x`. | |
npm i @rainbow-me/rainbowkit@^0.8.0 wagmi@^0.8.0 | ||
``` | ||
|
||
#### 4. 重命名 wagmi 的提供者 | ||
#### 2. 重命名 wagmi 的提供者 | ||
|
||
如果您在应用程序中使用`wagmi`钩子,您需要检查您的应用程序是否受到了`wagmi`的破坏性变化的影响。 | ||
|
||
|
@@ -412,7 +412,7 @@ RainbowKit 已将 `wagmi` 对等依赖项更新到 `0.5.x`。 | |
npm i @rainbow-me/rainbowkit@^0.4.0 wagmi@^0.5.0 | ||
``` | ||
|
||
#### 4. 重命名 wagmi 的提供者 | ||
#### 2. 重命名 wagmi 的提供者 | ||
|
||
如果您在应用中使用`wagmi`钩子,您需要检查您的应用是否受到`wagmi`中破坏性更改的影响。 | ||
|
||
|
@@ -492,7 +492,7 @@ RainbowKit已将`wagmi`对等依赖更新至`^0.4`。 | |
npm i @rainbow-me/rainbowkit@^0.2.0 wagmi@^0.4.2 | ||
``` | ||
|
||
#### 2. 2。 替换configureChains导入 | ||
#### 2. 替换configureChains导入 | ||
|
||
从wagmi导入`configureChains`而不是从RainbowKit: | ||
|
||
|
@@ -501,7 +501,7 @@ npm i @rainbow-me/rainbowkit@^0.2.0 wagmi@^0.4.2 | |
+ import { configureChains } from 'wagmi'; | ||
``` | ||
|
||
#### 4. 重命名 wagmi 的提供者 | ||
#### 3. 重命名 wagmi 的提供者 | ||
|
||
RainbowKit不再导出`apiProvider` API。 将其替换为您从wagmi选择的所需的提供商。 将其替换为您从wagmi选择的所需的提供商。 将其替换为您从wagmi选择的所需的提供商。 将其替换为您从wagmi选择的所需的提供商。 将其替换为您从wagmi选择的所需的提供商。 将其替换为您从wagmi选择的所需的提供商。 将其替换为您从wagmi选择的所需的提供商。 | ||
|
||
|