Releases: rainbow-me/rainbowkit
@rainbow-me/rainbowkit@2.0.2
Patch Changes
- 524d7a0:
connectModalOpen
state for theuseConnectModal
hook will now also encompass the Web3Modal modal presentation status for users that interact withwalletConnectWallet
- 2f637e4: Fixed a bug where wagmi would throw
ChainNotConfiguredError
ifmainnet
is not configured as a chain. This is happening when fetching ens name and ens avatar. - c021746: Resolved an issue where the Connect Modal wallet list would appear empty for EIP-6963 connectors when using the
WalletButton
component - df572f1: Resolved an issue for Custom Wallets that displayed a "missing translation" error for instructions during connect and installation flows. Now Custom Wallets will display their original strings without attempted translation.
@rainbow-me/rainbowkit@2.0.1
Patch Changes
- bb56562: Fixed a bug where the
showBalance
prop on<ConnectButton />
didn't accept a boolean, and had only accepted responsive modal values. - 5149dbd: Added Ramper Wallet support with
ramperWallet
wallet connector - 1e7d3f4: Added Ronin Wallet support with
roninWallet
wallet connector - c16541a: Added Kresus support with
kresusWallet
wallet connector - dbca966: Added Bloom Wallet support with
bloomWallet
wallet connector - 1a08977: Added EIP-6963 support for
coin98Wallet
wallet connector - f69c0e1: Added support for
ronin
chain
@rainbow-me/rainbowkit@2.0.0
Major Changes
-
aa0269e: Breaking:
The wagmi and viem peer dependencies have reached
2.x.x
with breaking changes.Follow the steps below to migrate.
1. Upgrade RainbowKit,
wagmi
, andviem
to their latest versionsnpm i @rainbow-me/rainbowkit@2 wagmi@2 viem@2.x
2. Install
@tanstack/react-query
peer dependencyWith Wagmi v2, TanStack Query is now a required peer dependency.
Install it with the following command:
npm i @tanstack/react-query
3. Upgrade your RainbowKit and Wagmi configurations
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 bundles 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> ) }
You can read an in-depth migration guide here.
4. Check for breaking changes in
wagmi
andviem
If you use
wagmi
hooks andviem
actions in your dApp, you will need to follow the migration guides for v2:
@rainbow-me/rainbowkit-siwe-next-auth@0.4.0
Minor Changes
-
aa0269e: RainbowKit has reached v2 alongside wagmi, which includes breaking changes.
0.4.x
now requires@rainbow-me/rainbowkit
v2, specifically:2.x.x
.
@rainbow-me/rainbow-button@0.2.0
Minor Changes
-
aa0269e: Breaking:
The wagmi and viem peer dependencies have reached
2.x.x
with breaking changes.Follow the steps below to migrate.
1. Upgrade Rainbow Button,
wagmi
, andviem
to their latest versions**npm i @rainbow-me/rainbow-button@2 wagmi@2 viem@2.x
2. Install
@tanstack/react-query
peer dependencyWith Wagmi v2, TanStack Query is now a required peer dependency.
Install it with the following command:
npm i @tanstack/react-query
3. Upgrade your Rainbow Button and Wagmi configurations
RainbowConnector
is nowrainbowConnector
, and requiresappName
and no longer accepts thechains
parameter.- import { RainbowConnector } from '@rainbow-me/rainbow-button' + import { rainbowConnector } from '@rainbow-me/rainbow-button' import { createConfig } from 'wagmi' const config = createConfig({ - connectors: [new RainbowConnector({ chains, projectId })], + connectors: [ + rainbowConnector({ + appName: "RainbowKit demo", + projectId: "YOUR_PROJECT_ID", + }), + ], })
Follow the Wagmi v2 Migration Guide for additional configuration changes.
4. Check for breaking changes in
wagmi
andviem
If you use
wagmi
hooks andviem
actions in your dApp, you will need to follow the full migration guides for v2:
@rainbow-me/rainbowkit@1.3.5
Patch Changes
- 2b0c7b3: Added missing i18n translations for
Wrong network
errors
@rainbow-me/rainbowkit@1.3.4
Patch Changes
- c0a644a: Fixed an issue that caused components to re-render on every window resize event. Now components will only re-render once the user has finished resizing their window.
- 41616b9: Fixed a bug where the
connectModalOpen
state incorrectly remainedtrue
after a successfulsiwe
authentication. This fix ensures thatconnectModalOpen
shows the correct state. - cf4955f: Fixed a bug where the back button wasn't showing on compact size modal when selecting
DownloadOptions
wallet step. - cf4955f: Removed back button for wide size modal entirely when selecting
DownloadOptions
wallet step to prevent incorrect wallet step switching. - e5f5f03: Removed external
i18n-js
dependency to reduce RainbowKit bundle sizes. - c0bd68e: Fixed a bug in the account modal transactions section where transactions that were not found or cancelled were incorrectly shown as 'pending' instead of 'failed'.
- a79609b: Fixed a bug that allowed users to hold-press or cursor select wallet icons on iOS, which interrupted the connection experience.
@rainbow-me/rainbowkit@1.3.3
Patch Changes
-
7565fb2: Added
uk-UA
andua
locale support for the Ukranian language.Reference our guide to learn more about Localization.
-
24b5a88: Improved support for
NodeNext
module resolution to resolve"@rainbow-me/rainbowkit"' has no exported member 'RainbowKitProvider'
TypeScript warnings -
5a184e9: Fixed a bug where
eth_getBalance
would be called whenshowBalance
was set tofalse
. Optimized additional provider calls to fetch wallet balances only when a user interacts with the Account modal.
@rainbow-me/rainbowkit@1.3.2
Patch Changes
- 7ba94f4: Optimized bundle size for localization feature
@rainbow-me/rainbowkit@1.3.1
Patch Changes
3feab0e: Support for Wagmi 1.4.12
to mitigate a supply-chain attack on the @ledgerhq/connect-kit package. RainbowKit dApp's were not directly impacted, but dApps that used the LedgerConnector connector in earlier versions of Wagmi could have been. This issue has since been resolved by Ledger but the wagmi team is encouraging developers to upgrade Wagmi and RainbowKit out of an abundance of caution.
c9a8e46: Improved Korean localization. Thanks @Hyun2!
dba5177: Added support for arbitrumSepolia, baseSepolia, optimismSepolia, zoraSepolia testnet chains