feat: bitKeepWallet support (#1365)

* feat(bitkeep): add bitkeep wallect connector

* chore: update icon with minified/resized svg

* chore: changeset

* fix: downloadurls changes, icon url fix, injected cleanup

* docs: fix

* chore: amend changeset

* fix: example support

* fix: isBitKeep

---------

Co-authored-by: kean <kean.yang@bitget.comkean.yang@bitget.com>
Co-authored-by: Daniel Sinclair <d@niel.nyc>

.changeset/swift-news-behave.md

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

packages/example/pages/_app.tsx

@@ -12,6 +12,7 @@ import {
 } from '@rainbow-me/rainbowkit';
 import {
   argentWallet,
+  bitKeepWallet,
   bitskiWallet,
   dawnWallet,
   imTokenWallet,
@@ -91,6 +92,7 @@ const connectors = connectorsForWallets([
     groupName: 'Other',
     wallets: [
       argentWallet({ chains, projectId }),
+      bitKeepWallet({ chains, projectId }),
       bitskiWallet({ chains }),
       dawnWallet({ chains }),
       imTokenWallet({ chains, projectId }),

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

@@ -0,0 +1,151 @@
+/* eslint-disable sort-keys-fix/sort-keys-fix */
+import type { InjectedConnectorOptions } from '@wagmi/core/connectors/injected';
+import { InjectedConnector } from 'wagmi/connectors/injected';
+import { Chain } from '../../../components/RainbowKitProvider/RainbowKitChainContext';
+import { getWalletConnectUri } from '../../../utils/getWalletConnectUri';
+import { isAndroid } from '../../../utils/isMobile';
+import { Wallet } from '../../Wallet';
+import { getWalletConnectConnector } from '../../getWalletConnectConnector';
+import type {
+  WalletConnectConnectorOptions,
+  WalletConnectLegacyConnectorOptions,
+} from '../../getWalletConnectConnector';
+
+export interface BitKeepWalletLegacyOptions {
+  projectId?: string;
+  chains: Chain[];
+  walletConnectVersion: '1';
+  walletConnectOptions?: WalletConnectLegacyConnectorOptions;
+}
+
+export interface BitKeepWalletOptions {
+  projectId: string;
+  chains: Chain[];
+  walletConnectVersion?: '2';
+  walletConnectOptions?: WalletConnectConnectorOptions;
+}
+
+export const bitKeepWallet = ({
+  chains,
+  projectId,
+  walletConnectOptions,
+  walletConnectVersion = '2',
+  ...options
+}: (BitKeepWalletLegacyOptions | BitKeepWalletOptions) &
+  InjectedConnectorOptions): Wallet => {
+  const isBitKeepInjected =
+    typeof window !== 'undefined' &&
+    // @ts-expect-error
+    window.bitkeep !== undefined &&
+    // @ts-expect-error
+    window.bitkeep.ethereum !== undefined &&
+    // @ts-expect-error
+    window.bitkeep.ethereum.isBitKeep === true;
+
+  const shouldUseWalletConnect = !isBitKeepInjected;
+
+  return {
+    id: 'bitKeep',
+    name: 'BitKeep',
+    iconUrl: async () => (await import('./bitKeepWallet.svg')).default,
+    iconAccent: '#f6851a',
+    iconBackground: '#fff',
+    installed: !shouldUseWalletConnect ? isBitKeepInjected : undefined,
+    downloadUrls: {
+      android: 'https://bitkeep.com/en/download?type=2',
+      ios: 'https://apps.apple.com/app/bitkeep/id1395301115',
+      mobile: 'https://bitkeep.com/en/download?type=2',
+      qrCode: 'https://bitkeep.com/en/download',
+      chrome:
+        'https://chrome.google.com/webstore/detail/bitkeep-crypto-nft-wallet/jiidiaalihmmhddjgbnbgdfflelocpak',
+      browserExtension: 'https://bitkeep.com/en/download',
+    },
+
+    createConnector: () => {
+      const connector = shouldUseWalletConnect
+        ? getWalletConnectConnector({
+            chains,
+            options: walletConnectOptions,
+            projectId,
+            version: walletConnectVersion,
+          })
+        : new InjectedConnector({
+            chains,
+            options: {
+              // @ts-expect-error
+              getProvider: () => window.bitkeep.ethereum,
+              ...options,
+            },
+          });
+
+      const getUri = async () => {
+        const uri = await getWalletConnectUri(connector, walletConnectVersion);
+
+        return isAndroid()
+          ? uri
+          : `bitkeep://wc?uri=${encodeURIComponent(uri)}`;
+      };
+
+      return {
+        connector,
+        extension: {
+          instructions: {
+            learnMoreUrl: 'https://study.bitkeep.com',
+            steps: [
+              {
+                description:
+                  'We recommend pinning BitKeep to your taskbar for quicker access to your wallet.',
+                step: 'install',
+                title: 'Install the BitKeep extension',
+              },
+              {
+                description:
+                  'Be sure to back up your wallet using a secure method. Never share your secret phrase with anyone.',
+                step: 'create',
+                title: 'Create or Import a Wallet',
+              },
+              {
+                description:
+                  'Once you set up your wallet, click below to refresh the browser and load up the extension.',
+                step: 'refresh',
+                title: 'Refresh your browser',
+              },
+            ],
+          },
+        },
+        mobile: {
+          getUri: shouldUseWalletConnect ? getUri : undefined,
+        },
+        qrCode: shouldUseWalletConnect
+          ? {
+              getUri: async () =>
+                getWalletConnectUri(connector, walletConnectVersion),
+              instructions: {
+                learnMoreUrl: 'https://study.bitkeep.com',
+                steps: [
+                  {
+                    description:
+                      'We recommend putting BitKeep on your home screen for quicker access.',
+                    step: 'install',
+                    title: 'Open the BitKeep app',
+                  },
+                  {
+                    description:
+                      'Be sure to back up your wallet using a secure method. Never share your secret phrase with anyone.',
+                    step: 'create',
+                    title: 'Create or Import a Wallet',
+                  },
+                  {
+                    description:
+                      'After you scan, a connection prompt will appear for you to connect your wallet.',
+                    step: 'scan',
+                    title: 'Tap the scan button',
+                  },
+                ],
+              },
+            }
+          : undefined,
+      };
+    },
+  };
+};

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

@@ -1,4 +1,5 @@
 import { argentWallet } from './argentWallet/argentWallet';
+import { bitKeepWallet } from './bitKeepWallet/bitKeepWallet';
 import { bitskiWallet } from './bitskiWallet/bitskiWallet';
 import { braveWallet } from './braveWallet/braveWallet';
 import { coinbaseWallet } from './coinbaseWallet/coinbaseWallet';
@@ -22,6 +23,7 @@ import { zerionWallet } from './zerionWallet/zerionWallet';
 
 export {
   argentWallet,
+  bitKeepWallet,
   bitskiWallet,
   braveWallet,
   coinbaseWallet,

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

@@ -126,6 +126,17 @@ argentWallet(options: {
 });
 ```
 
+#### BitKeep
+
+```tsx
+import { bitKeepWallet } from '@rainbow-me/rainbowkit/wallets';
+
+bitKeepWallet(options: {
+  projectId: string;
+  chains: Chain[];
+});
+```
+
 #### Bitski
 
 ```tsx