feat: compassWallet connector (#1837)

* feat: compass wallet * refactor: chrome production link * chore: avoid exposing getInjectedConnector, optimize logo svg, update compassWallet and update docs * chore: update en_US.json * chore: update logo * chore: optimize compassWallet.svg * chore: changeset --------- Co-authored-by: Himanshu Singh <[email protected]> Co-authored-by: MK <[email protected]> Co-authored-by: Daniel Sinclair <[email protected]>
rainbow-me · Apr 23, 2024 · 7ab6e50 · 7ab6e50
1 parent f14120c
commit 7ab6e50
Show file tree

Hide file tree

Showing 7 changed files with 98 additions and 0 deletions.
diff --git a/.changeset/new-zebras-sing.md b/.changeset/new-zebras-sing.md
@@ -0,0 +1,5 @@
+---
+"@rainbow-me/rainbowkit": patch
+---
+
+Added Compass Wallet support with `compassWallet` wallet connector
diff --git a/packages/example/pages/_app.tsx b/packages/example/pages/_app.tsx
@@ -27,6 +27,7 @@ import {
   bybitWallet,
   clvWallet,
   coin98Wallet,
+  compassWallet,
   coreWallet,
   dawnWallet,
   desigWallet,
@@ -126,6 +127,22 @@ const avalanche = {
   },
 } as const satisfies Chain;
 
+const sei = {
+  id: 713715,
+  name: 'Sei',
+  iconUrl:
+    'https://s3.coinmarketcap.com/static-gravity/image/992744cfbd5e40f5920018ee7a830b98.png',
+  iconBackground: '#fff',
+  nativeCurrency: { name: 'Sei', symbol: 'SEI', decimals: 18 },
+  rpcUrls: {
+    default: { http: ['https://evm-rpc.arctic-1.seinetwork.io'] },
+  },
+  blockExplorers: {
+    default: { name: 'Sei Explorer', url: 'https://www.seiscan.app' },
+  },
+  contracts: {},
+} as const satisfies Chain;
+
 const config = getDefaultConfig({
   appName: 'RainbowKit Demo',
   projectId,
@@ -143,6 +160,7 @@ const config = getDefaultConfig({
     zetachain,
     ronin,
     klaytn,
+    sei,
     ...(process.env.NEXT_PUBLIC_ENABLE_TESTNETS === 'true'
       ? [
           sepolia,
@@ -172,6 +190,7 @@ const config = getDefaultConfig({
         bloomWallet,
         bybitWallet,
         clvWallet,
+        compassWallet,
         coin98Wallet,
         coreWallet,
         dawnWallet,

diff --git a/packages/rainbowkit/src/locales/en_US.json b/packages/rainbowkit/src/locales/en_US.json
@@ -453,6 +453,23 @@
       }
     },
 
+    "compass": {
+      "extension": {
+        "step1": {
+          "description": "We recommend pinning Compass Wallet to your taskbar for quicker access to your wallet.",
+          "title": "Install the Compass Wallet extension"
+        },
+        "step2": {
+          "description": "Be sure to back up your wallet using a secure method. Never share your secret phrase with anyone.",
+          "title": "Create or Import a Wallet"
+        },
+        "step3": {
+          "description": "Once you set up your wallet, click below to refresh the browser and load up the extension.",
+          "title": "Refresh your browser"
+        }
+      }
+    },
+
     "core": {
       "qr_code": {
         "step1": {

diff --git a/packages/rainbowkit/src/wallets/walletConnectors/compassWallet/compassWallet.svg b/packages/rainbowkit/src/wallets/walletConnectors/compassWallet/compassWallet.svg
diff --git a/packages/rainbowkit/src/wallets/walletConnectors/compassWallet/compassWallet.ts b/packages/rainbowkit/src/wallets/walletConnectors/compassWallet/compassWallet.ts
@@ -0,0 +1,48 @@
+import { Wallet } from '../../Wallet';
+import {
+  getInjectedConnector,
+  hasInjectedProvider,
+} from '../../getInjectedConnector';
+
+export const compassWallet = (): Wallet => {
+  const isCompassInjected = hasInjectedProvider({ namespace: 'compassEvm' });
+
+  return {
+    id: 'compass',
+    name: 'Compass Wallet',
+    installed: isCompassInjected,
+    iconUrl: async () => (await import('./compassWallet.svg')).default,
+    iconBackground: '#fff',
+    downloadUrls: {
+      chrome:
+        'https://chromewebstore.google.com/detail/compass-wallet-for-sei/anokgmphncpekkhclmingpimjmcooifb',
+      browserExtension: 'https://compasswallet.io/download',
+    },
+    extension: {
+      instructions: {
+        learnMoreUrl: 'https://compasswallet.io/download',
+        steps: [
+          {
+            description:
+              'wallet_connectors.compass.extension.step1.description',
+            step: 'install',
+            title: 'wallet_connectors.compass.extension.step1.title',
+          },
+          {
+            description:
+              'wallet_connectors.compass.extension.step2.description',
+            step: 'create',
+            title: 'wallet_connectors.compass.extension.step2.title',
+          },
+          {
+            description:
+              'wallet_connectors.compass.extension.step3.description',
+            step: 'refresh',
+            title: 'wallet_connectors.compass.extension.step3.title',
+          },
+        ],
+      },
+    },
+    createConnector: getInjectedConnector({ namespace: 'compassEvm' }),
+  };
+};
diff --git a/packages/rainbowkit/src/wallets/walletConnectors/index.ts b/packages/rainbowkit/src/wallets/walletConnectors/index.ts
@@ -9,6 +9,7 @@ import { bybitWallet } from './bybitWallet/bybitWallet';
 import { clvWallet } from './clvWallet/clvWallet';
 import { coin98Wallet } from './coin98Wallet/coin98Wallet';
 import { coinbaseWallet } from './coinbaseWallet/coinbaseWallet';
+import { compassWallet } from './compassWallet/compassWallet';
 import { coreWallet } from './coreWallet/coreWallet';
 import { dawnWallet } from './dawnWallet/dawnWallet';
 import { desigWallet } from './desigWallet/desigWallet';
@@ -61,6 +62,7 @@ export {
   clvWallet,
   coin98Wallet,
   coinbaseWallet,
+  compassWallet,
   coreWallet,
   dawnWallet,
   desigWallet,

diff --git a/site/data/en-US/docs/custom-wallet-list.mdx b/site/data/en-US/docs/custom-wallet-list.mdx
@@ -152,6 +152,12 @@ import { braveWallet } from '@rainbow-me/rainbowkit/wallets';
 import { coinbaseWallet } from '@rainbow-me/rainbowkit/wallets';
 ```
 
+#### Compass Wallet
+
+```tsx
+import { compassWallet } from '@rainbow-me/rainbowkit/compassWallet';
+```
+
 #### Coin98 Wallet
 
 ```tsx