feat: add optional label field to ConnectedWallet instances

coinhall · Jul 3, 2024 · b76472b · b76472b
1 parent a41a462
commit b76472b
Show file tree

Hide file tree

Showing 18 changed files with 67 additions and 31 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,15 @@
 # Changelog
 
+## `v0.0.71`
+
+### Features
+
+- Add optional `label` field to `ConnectedWallet` instances, which contains the user-defined label of the wallet
+
+### Fixes
+
+- Handle more wallet errors in the `wrap` function
+
 ## `v0.0.70`
 
 ### Features

diff --git a/examples/solid-vite/src/App.tsx b/examples/solid-vite/src/App.tsx
@@ -39,7 +39,7 @@ const CHAINS: Record<string, string> = {
 const WALLETS: Record<WalletName, string> = {
   [WalletName.KEPLR]: "Keplr",
   [WalletName.COSMOSTATION]: "Cosmostation",
-  [WalletName.STATION]: "Terra Station",
+  [WalletName.STATION]: "Station",
   [WalletName.LEAP]: "Leap",
   [WalletName.COMPASS]: "Compass",
   [WalletName.METAMASK_INJECTIVE]: "MetaMask",
@@ -325,13 +325,13 @@ const App: Component = () => {
         Broadcast Tx
       </button>
 
-      <div class="flex flex-col">
-        <code>CONNECTED WALLETS</code>
+      <div class="flex flex-col items-center border py-2 px-4 border-gray-400">
+        <div class="font-semibold">Connected Wallets</div>
         <For each={Object.values(wallets)}>
           {(wallet) => (
             <code>
-              {wallet.address.slice(0, 10)}
-              ...{wallet.address.slice(-5)} | {WALLETS[wallet.id]}
+              {wallet.address.slice(0, 10)}…{wallet.address.slice(-5)} [
+              {WALLETS[wallet.id]}: {wallet.label ?? "-"}]
             </code>
           )}
         </For>

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "cosmes",
-  "version": "0.0.70",
+  "version": "0.0.71",
   "private": false,
   "packageManager": "pnpm@8.3.0",
   "sideEffects": false,

diff --git a/src/wallet/walletconnect/WalletConnectV2.ts b/src/wallet/walletconnect/WalletConnectV2.ts
@@ -14,6 +14,7 @@ type StorageSession = {
 };
 
 type GetAccountResponse = {
+  name?: string | undefined;
   address: string;
   algo: string;
   pubkey: string;

diff --git a/src/wallet/wallets/ConnectedWallet.ts b/src/wallet/wallets/ConnectedWallet.ts
@@ -46,6 +46,8 @@ export abstract class ConnectedWallet {
   public readonly id: WalletName;
   /** The type of connection to the wallet. */
   public readonly type: WalletType;
+  /** The user-defined label for this wallet, if any. */
+  public readonly label: string | undefined;
   /** The chain ID this wallet is connected to. */
   public readonly chainId: string;
   /** The public key. */
@@ -62,6 +64,7 @@ export abstract class ConnectedWallet {
   constructor(
     id: WalletName,
     type: WalletType,
+    label: string | undefined,
     chainId: string,
     pubKey: Secp256k1PubKey,
     address: string,
@@ -70,6 +73,7 @@ export abstract class ConnectedWallet {
   ) {
     this.id = id;
     this.type = type;
+    this.label = label;
     this.chainId = chainId;
     this.pubKey = pubKey;
     this.address = address;

diff --git a/src/wallet/wallets/compass/CompassController.ts b/src/wallet/wallets/compass/CompassController.ts
@@ -38,9 +38,8 @@ export class CompassController extends WalletController {
     }
     await WalletError.wrap(ext.enable(chains.map(({ chainId }) => chainId)));
     for (const { chainId, rpc, gasPrice } of Object.values(chains)) {
-      const { bech32Address, pubKey, isNanoLedger } = await WalletError.wrap(
-        ext.getKey(chainId)
-      );
+      const { name, bech32Address, pubKey, isNanoLedger } =
+        await WalletError.wrap(ext.getKey(chainId));
       const key = new Secp256k1PubKey({
         chainId,
         key: pubKey,
@@ -49,6 +48,7 @@ export class CompassController extends WalletController {
         chainId,
         new CompassExtension(
           this.id,
+          name,
           ext,
           chainId,
           key,

diff --git a/src/wallet/wallets/cosmostation/CosmostationController.ts b/src/wallet/wallets/cosmostation/CosmostationController.ts
@@ -39,7 +39,7 @@ export class CosmostationController extends WalletController {
     );
     for (let i = 0; i < chains.length; i++) {
       const { chainId, rpc, gasPrice } = chains[i];
-      const { pubkey, address } = await WalletError.wrap(
+      const { name, pubkey, address } = await WalletError.wrap(
         this.wc.getAccount(chainId)
       );
       const key = new Secp256k1PubKey({
@@ -50,6 +50,7 @@ export class CosmostationController extends WalletController {
         chainId,
         new CosmostationWalletConnectV2(
           this.id,
+          name,
           this.wc,
           chainId,
           key,
@@ -71,9 +72,8 @@ export class CosmostationController extends WalletController {
     }
     await WalletError.wrap(ext.enable(chains.map(({ chainId }) => chainId)));
     for (const { chainId, rpc, gasPrice } of Object.values(chains)) {
-      const { bech32Address, pubKey, isNanoLedger } = await WalletError.wrap(
-        ext.getKey(chainId)
-      );
+      const { name, bech32Address, pubKey, isNanoLedger } =
+        await WalletError.wrap(ext.getKey(chainId));
       const key = new Secp256k1PubKey({
         chainId,
         key: pubKey,
@@ -82,6 +82,7 @@ export class CosmostationController extends WalletController {
         chainId,
         new CosmostationExtension(
           this.id,
+          name,
           ext,
           chainId,
           key,

diff --git a/src/wallet/wallets/keplr/KeplrController.ts b/src/wallet/wallets/keplr/KeplrController.ts
@@ -39,7 +39,7 @@ export class KeplrController extends WalletController {
     );
     for (let i = 0; i < chains.length; i++) {
       const { chainId, rpc, gasPrice } = chains[i];
-      const { pubkey, address } = await WalletError.wrap(
+      const { name, pubkey, address } = await WalletError.wrap(
         this.wc.getAccount(chainId)
       );
       const key = new Secp256k1PubKey({
@@ -50,6 +50,7 @@ export class KeplrController extends WalletController {
         chainId,
         new KeplrWalletConnectV2(
           this.id,
+          name,
           this.wc,
           chainId,
           key,
@@ -71,9 +72,8 @@ export class KeplrController extends WalletController {
     }
     await WalletError.wrap(ext.enable(chains.map(({ chainId }) => chainId)));
     for (const { chainId, rpc, gasPrice } of Object.values(chains)) {
-      const { bech32Address, pubKey, isNanoLedger } = await WalletError.wrap(
-        ext.getKey(chainId)
-      );
+      const { name, bech32Address, pubKey, isNanoLedger } =
+        await WalletError.wrap(ext.getKey(chainId));
       const key = new Secp256k1PubKey({
         key: pubKey,
         chainId,
@@ -82,6 +82,7 @@ export class KeplrController extends WalletController {
         chainId,
         new KeplrExtension(
           this.id,
+          name,
           ext,
           chainId,
           key,

diff --git a/src/wallet/wallets/keplr/KeplrExtension.ts b/src/wallet/wallets/keplr/KeplrExtension.ts
@@ -28,6 +28,7 @@ export class KeplrExtension extends ConnectedWallet {
 
   constructor(
     walletName: WalletName,
+    label: string | undefined,
     ext: Keplr,
     chainId: string,
     pubKey: Secp256k1PubKey,
@@ -39,6 +40,7 @@ export class KeplrExtension extends ConnectedWallet {
     super(
       walletName,
       WalletType.EXTENSION,
+      label,
       chainId,
       pubKey,
       address,

diff --git a/src/wallet/wallets/keplr/KeplrWalletConnectV2.ts b/src/wallet/wallets/keplr/KeplrWalletConnectV2.ts
@@ -26,6 +26,7 @@ export class KeplrWalletConnectV2 extends ConnectedWallet {
 
   constructor(
     walletName: WalletName,
+    label: string | undefined,
     wc: WalletConnectV2,
     chainId: string,
     pubKey: Secp256k1PubKey,
@@ -37,6 +38,7 @@ export class KeplrWalletConnectV2 extends ConnectedWallet {
     super(
       walletName,
       WalletType.WALLETCONNECT,
+      label,
       chainId,
       pubKey,
       address,

diff --git a/src/wallet/wallets/leap/LeapController.ts b/src/wallet/wallets/leap/LeapController.ts
@@ -38,7 +38,7 @@ export class LeapController extends WalletController {
     );
     for (let i = 0; i < chains.length; i++) {
       const { chainId, rpc, gasPrice } = chains[i];
-      const { pubkey, address } = await WalletError.wrap(
+      const { name, pubkey, address } = await WalletError.wrap(
         this.wc.getAccount(chainId)
       );
       const key = new Secp256k1PubKey({
@@ -49,6 +49,7 @@ export class LeapController extends WalletController {
         chainId,
         new LeapWalletConnectV2(
           this.id,
+          name,
           this.wc,
           chainId,
           key,
@@ -70,9 +71,8 @@ export class LeapController extends WalletController {
     }
     await WalletError.wrap(ext.enable(chains.map(({ chainId }) => chainId)));
     for (const { chainId, rpc, gasPrice } of Object.values(chains)) {
-      const { bech32Address, pubKey, isNanoLedger } = await WalletError.wrap(
-        ext.getKey(chainId)
-      );
+      const { name, bech32Address, pubKey, isNanoLedger } =
+        await WalletError.wrap(ext.getKey(chainId));
       const key = new Secp256k1PubKey({
         chainId,
         key: pubKey,
@@ -81,6 +81,7 @@ export class LeapController extends WalletController {
         chainId,
         new LeapExtension(
           this.id,
+          name,
           ext,
           chainId,
           key,

diff --git a/src/wallet/wallets/metamask-injective/MetamaskInjectiveController.ts b/src/wallet/wallets/metamask-injective/MetamaskInjectiveController.ts
@@ -69,6 +69,7 @@ export class MetamaskInjectiveController extends WalletController {
       chain.chainId,
       new MetamaskInjectiveExtension(
         this.id,
+        undefined,
         ext,
         chain.chainId,
         pubKey,

diff --git a/src/wallet/wallets/metamask-injective/MetamaskInjectiveExtension.ts b/src/wallet/wallets/metamask-injective/MetamaskInjectiveExtension.ts
@@ -25,6 +25,7 @@ export class MetamaskInjectiveExtension extends ConnectedWallet {
 
   constructor(
     walletName: WalletName,
+    label: string | undefined,
     ext: Ethereum,
     chainId: string,
     pubKey: Secp256k1PubKey,
@@ -36,6 +37,7 @@ export class MetamaskInjectiveExtension extends ConnectedWallet {
     super(
       walletName,
       WalletType.EXTENSION,
+      label,
       chainId,
       pubKey,
       bech32Address,

diff --git a/src/wallet/wallets/mnemonic/MnemonicWallet.ts b/src/wallet/wallets/mnemonic/MnemonicWallet.ts
@@ -103,6 +103,7 @@ export class MnemonicWallet extends ConnectedWallet {
       // unlikely to be used by most consumers of CosmES.
       "mnemonic" as WalletName,
       "mnemonic" as WalletType,
+      undefined,
       chainId,
       new Secp256k1PubKey({
         chainId,

diff --git a/src/wallet/wallets/ninji/NinjiController.ts b/src/wallet/wallets/ninji/NinjiController.ts
@@ -37,9 +37,8 @@ export class NinjiController extends WalletController {
     }
     await WalletError.wrap(ext.enable(chains.map(({ chainId }) => chainId)));
     for (const { chainId, rpc, gasPrice } of Object.values(chains)) {
-      const { bech32Address, pubKey, isNanoLedger } = await WalletError.wrap(
-        ext.getKey(chainId)
-      );
+      const { name, bech32Address, pubKey, isNanoLedger } =
+        await WalletError.wrap(ext.getKey(chainId));
       const key = new Secp256k1PubKey({
         chainId,
         key: pubKey,
@@ -48,6 +47,7 @@ export class NinjiController extends WalletController {
         chainId,
         new NinjiExtension(
           this.id,
+          name,
           ext,
           chainId,
           key,

diff --git a/src/wallet/wallets/owallet/OWalletController.ts b/src/wallet/wallets/owallet/OWalletController.ts
@@ -38,9 +38,8 @@ export class OWalletController extends WalletController {
     }
     await WalletError.wrap(ext.enable(chains.map(({ chainId }) => chainId)));
     for (const { chainId, rpc, gasPrice } of Object.values(chains)) {
-      const { bech32Address, pubKey, isNanoLedger } = await WalletError.wrap(
-        ext.getKey(chainId)
-      );
+      const { name, bech32Address, pubKey, isNanoLedger } =
+        await WalletError.wrap(ext.getKey(chainId));
       const key = new Secp256k1PubKey({
         chainId,
         key: pubKey,
@@ -49,6 +48,7 @@ export class OWalletController extends WalletController {
         chainId,
         new OWalletExtension(
           this.id,
+          name,
           ext,
           chainId,
           key,

diff --git a/src/wallet/wallets/station/StationController.ts b/src/wallet/wallets/station/StationController.ts
@@ -72,7 +72,15 @@ export class StationController extends WalletController {
         );
         wallets.set(
           chainId,
-          new StationWalletConnectV1(wc, chainId, key, address, rpc, gasPrice)
+          new StationWalletConnectV1(
+            undefined,
+            wc,
+            chainId,
+            key,
+            address,
+            rpc,
+            gasPrice
+          )
         );
       } catch (err) {
         // We simply log and ignore the error for now
@@ -93,9 +101,8 @@ export class StationController extends WalletController {
     await WalletError.wrap(ext.enable(chains.map(({ chainId }) => chainId)));
     for (const { chainId, rpc, gasPrice } of Object.values(chains)) {
       try {
-        const { bech32Address, pubKey, isNanoLedger } = await WalletError.wrap(
-          ext.getKey(chainId)
-        );
+        const { name, bech32Address, pubKey, isNanoLedger } =
+          await WalletError.wrap(ext.getKey(chainId));
         const key = new Secp256k1PubKey({
           key: pubKey,
           chainId,
@@ -104,6 +111,7 @@ export class StationController extends WalletController {
           chainId,
           new StationExtension(
             this.id,
+            name,
             ext,
             chainId,
             key,

diff --git a/src/wallet/wallets/station/StationWalletConnectV1.ts b/src/wallet/wallets/station/StationWalletConnectV1.ts
@@ -23,6 +23,7 @@ export class StationWalletConnectV1 extends ConnectedWallet {
   private readonly wc: WalletConnect;
 
   constructor(
+    label: string | undefined,
     wc: WalletConnect,
     chainId: string,
     pubKey: Secp256k1PubKey,
@@ -33,6 +34,7 @@ export class StationWalletConnectV1 extends ConnectedWallet {
     super(
       WalletName.STATION,
       WalletType.WALLETCONNECT,
+      label,
       chainId,
       pubKey,
       address,