feat: zealWallet support (#1504)

* Add Zeal wallet

* Remove @ts-expect-error

* fix: migration to i18n, rebase fixes

* fix: changeset

* fix: icon

---------

Co-authored-by: Daniel Sinclair <d@niel.nyc>

.changeset/ten-goats-thank.md

@@ -0,0 +1,23 @@
+---
+'@rainbow-me/rainbowkit': patch
+---
+
+Zeal Support
+
+**Example usage**
+
+```ts
+import {
+  getDefaultWallets,
+  connectorsForWallets,
+} from '@rainbow-me/rainbowkit';
+import { zealWallet } from '@rainbow-me/rainbowkit/wallets';
+const { wallets } = getDefaultWallets({ appName, chains });
+const connectors = connectorsForWallets([
+  ...wallets,
+  {
+    groupName: 'Other',
+    wallets: [zealWallet({ chains })],
+  },
+]);
+```

packages/example/pages/_app.tsx

@@ -43,6 +43,7 @@ import {
   trustWallet,
   uniswapWallet,
   xdefiWallet,
+  zealWallet,
   zerionWallet,
 } from '@rainbow-me/rainbowkit/wallets';
 
@@ -136,6 +137,7 @@ const connectors = connectorsForWallets([
       trustWallet({ chains, projectId }),
       uniswapWallet({ chains, projectId }),
       xdefiWallet({ chains }),
+      zealWallet({ chains }),
       zerionWallet({ chains, projectId }),
     ],
   },

packages/rainbowkit/src/locales/en_US.json

@@ -790,6 +790,23 @@
           "description": "Once you set up your wallet, click below to refresh the browser and load up the extension."
         }
       }
+    },
+
+    "zeal": {
+      "extension": {
+        "step1": {
+          "title": "Install the Zeal extension",
+          "description": "We recommend pinning Zeal to your taskbar for quicker access to your wallet."
+        },
+        "step2": {
+          "title": "Create or Import a Wallet",
+          "description": "Be sure to back up your wallet using a secure method. Never share your secret phrase with anyone."
+        },
+        "step3": {
+          "title": "Refresh your browser",
+          "description": "Once you set up your wallet, click below to refresh the browser and load up the extension."
+        }
+      }
     }
   }
 }

packages/rainbowkit/src/wallets/walletConnectors/index.ts

@@ -31,6 +31,7 @@ import { trustWallet } from './trustWallet/trustWallet';
 import { uniswapWallet } from './uniswapWallet/uniswapWallet';
 import { walletConnectWallet } from './walletConnectWallet/walletConnectWallet';
 import { xdefiWallet } from './xdefiWallet/xdefiWallet';
+import { zealWallet } from './zealWallet/zealWallet';
 import { zerionWallet } from './zerionWallet/zerionWallet';
 
 export {
@@ -68,5 +69,6 @@ export {
   uniswapWallet,
   walletConnectWallet,
   xdefiWallet,
+  zealWallet,
   zerionWallet,
 };

packages/rainbowkit/src/wallets/walletConnectors/metaMaskWallet/metaMaskWallet.ts

@@ -65,6 +65,7 @@ function isMetaMask(ethereum?: typeof window['ethereum']): boolean {
   if (ethereum.isTokenary) return false;
   if (ethereum.isTrust || ethereum.isTrustWallet) return false;
   if (ethereum.isXDEFI) return false;
+  if (ethereum.isZeal) return false;
   if (ethereum.isZerion) return false;
   return true;
 }

packages/rainbowkit/src/wallets/walletConnectors/zealWallet/zealWallet.ts

@@ -0,0 +1,51 @@
+import type { InjectedConnectorOptions } from '@wagmi/core/connectors/injected';
+import { InjectedConnector } from 'wagmi/connectors/injected';
+import { Chain } from '../../../components/RainbowKitProvider/RainbowKitChainContext';
+import { Wallet } from '../../Wallet';
+import { hasInjectedProvider } from '../../getInjectedConnector';
+
+export interface ZealWalletOptions {
+  chains: Chain[];
+}
+
+export const zealWallet = ({
+  chains,
+  ...options
+}: ZealWalletOptions & InjectedConnectorOptions): Wallet => ({
+  id: 'zeal',
+  name: 'Zeal',
+  iconUrl: async () => (await import('./zealWallet.svg')).default,
+  iconBackground: '#fff0',
+  installed: hasInjectedProvider('isZeal'),
+  downloadUrls: {
+    browserExtension: 'https://zeal.app',
+  },
+  createConnector: () => ({
+    connector: new InjectedConnector({
+      chains,
+      options,
+    }),
+    extension: {
+      instructions: {
+        learnMoreUrl: 'https://zeal.app/',
+        steps: [
+          {
+            description: 'wallet_connectors.zeal.extension.step1.description',
+            step: 'install',
+            title: 'wallet_connectors.zeal.extension.step1.title',
+          },
+          {
+            description: 'wallet_connectors.zeal.extension.step2.description',
+            step: 'create',
+            title: 'wallet_connectors.zeal.extension.step2.title',
+          },
+          {
+            description: 'wallet_connectors.zeal.extension.step3.description',
+            step: 'refresh',
+            title: 'wallet_connectors.zeal.extension.step3.title',
+          },
+        ],
+      },
+    },
+  }),
+});

site/data/docs/custom-wallet-list.mdx

@@ -437,6 +437,16 @@ xdefiWallet(options: {
 });
 ```
 
+#### Zeal
+
+```tsx
+import { zealWallet } from '@rainbow-me/rainbowkit/wallets';
+
+zealWallet(options: {
+  chains: Chain[];
+});
+```
+
 #### Zerion
 
 ```tsx