Merge pull request #43 from nabla-studio/DavideSegullo/refactor-utils

Refactor Utils

package.json

@@ -104,7 +104,6 @@
     "react": "18.2.0",
     "react-dom": "18.2.0",
     "react-qr-code": "^2.0.12",
-    "semver": "^7.5.4",
     "stargazejs": "^0.14.1",
     "utf-8-validate": "^6.0.3",
     "vue": "^3.3.4",

packages/core/src/types/suggest-chains.ts

@@ -3,5 +3,5 @@ import type { AssetLists, Chain } from '@nabla-studio/chain-registry';
 export interface SuggestChain {
   name: string;
   chain: Chain;
-  assetList?: AssetLists;
+  assetList: AssetLists;
 }

packages/store/src/slices/connect.ts

@@ -101,7 +101,7 @@ export const createConnectSlice: StateCreator<
         name: chain.chain_name,
         assetList: get().assetsLists.find(
           (list) => list.chain_name === chain.chain_name,
-        ),
+        )!,
       }));
 
       return suggestChains(wallet.options.name, chains);

packages/wallets/package.json

@@ -23,7 +23,6 @@
     "@cosmjs/proto-signing": "^0.31.3",
     "cosmjs-types": "^0.8.0",
     "@keplr-wallet/types": "^0.12.38",
-    "semver": "^7.5.4",
     "long": "^5.2.3",
     "@cosmostation/extension-client": "^0.1.15"
   },

packages/wallets/src/index.ts

@@ -4,3 +4,5 @@ export * from './cosmostation';
 export * from './xdefi';
 export * from './station';
 export * from './wallet-connect';
+export * from './utils';
+export * from './types';

packages/wallets/src/keplr/extension.ts

@@ -19,7 +19,7 @@ import { ExtensionWallet, assertIsDefined } from '@quirks/core';
 import type { SignDoc } from 'cosmjs-types/cosmos/tx/v1beta1/tx';
 import type { Keplr } from '@keplr-wallet/types';
 import Long from 'long';
-import { chainRegistryChainToKeplr } from './utils';
+import { getChainInfo } from '../utils';
 
 export class KeplrWalletExtension extends ExtensionWallet<Keplr> {
   constructor(options: WalletOptions) {
@@ -156,10 +156,7 @@ export class KeplrWalletExtension extends ExtensionWallet<Keplr> {
     assertIsDefined(this.client);
 
     for (const suggestion of suggestions) {
-      const suggestChain = chainRegistryChainToKeplr(
-        suggestion.chain,
-        suggestion.assetList ? [suggestion.assetList] : [],
-      );
+      const suggestChain = getChainInfo(suggestion.chain, suggestion.assetList);
 
       await this.client.experimentalSuggestChain(suggestChain);
     }

packages/wallets/src/leap/extension.ts

@@ -18,8 +18,8 @@ import type {
 import { ExtensionWallet, assertIsDefined } from '@quirks/core';
 import type { SignDoc } from 'cosmjs-types/cosmos/tx/v1beta1/tx';
 import Long from 'long';
-import { chainRegistryChainToKeplr } from '../keplr/utils';
-import { Leap } from './types';
+import { getChainInfo } from '../utils';
+import type { Leap } from './types';
 
 export class LeapWalletExtension extends ExtensionWallet<Leap> {
   constructor(options: WalletOptions) {
@@ -160,10 +160,7 @@ export class LeapWalletExtension extends ExtensionWallet<Leap> {
     assertIsDefined(this.client);
 
     for (const suggestion of suggestions) {
-      const suggestChain = chainRegistryChainToKeplr(
-        suggestion.chain,
-        suggestion.assetList ? [suggestion.assetList] : [],
-      );
+      const suggestChain = getChainInfo(suggestion.chain, suggestion.assetList);
 
       await this.client.experimentalSuggestChain(suggestChain);
     }

packages/wallets/src/station/extension.ts

@@ -19,7 +19,7 @@ import { ExtensionWallet, assertIsDefined } from '@quirks/core';
 import type { SignDoc } from 'cosmjs-types/cosmos/tx/v1beta1/tx';
 import type { Keplr } from '@keplr-wallet/types';
 import Long from 'long';
-import { chainRegistryChainToKeplr } from '../keplr/utils';
+import { getChainInfo } from '../utils';
 
 export class StationWalletExtension extends ExtensionWallet<Keplr> {
   constructor(options: WalletOptions) {
@@ -156,10 +156,7 @@ export class StationWalletExtension extends ExtensionWallet<Keplr> {
     assertIsDefined(this.client);
 
     for (const suggestion of suggestions) {
-      const suggestChain = chainRegistryChainToKeplr(
-        suggestion.chain,
-        suggestion.assetList ? [suggestion.assetList] : [],
-      );
+      const suggestChain = getChainInfo(suggestion.chain, suggestion.assetList);
 
       await this.client.experimentalSuggestChain(suggestChain);
     }

packages/wallets/src/types/index.ts

@@ -0,0 +1 @@
+export * from './keplr';

packages/wallets/src/types/keplr.ts

@@ -0,0 +1,7 @@
+import type { Chain } from '@nabla-studio/chain-registry';
+
+export interface ChainInfoOptions {
+  getRpcEndpoint: (chain: Chain) => string;
+  getRestEndpoint: (chain: Chain) => string;
+  getExplorer: (chain: Chain) => string;
+}

packages/wallets/src/utils/chain.ts

@@ -0,0 +1,32 @@
+import type { Bech32Config } from '@keplr-wallet/types';
+import type { Chain } from '@nabla-studio/chain-registry';
+
+export const getRpc = (chain: Chain): string =>
+  chain.apis?.rpc?.[0]?.address ?? '';
+
+export const getRest = (chain: Chain): string =>
+  chain.apis?.rest?.[0]?.address ?? '';
+
+export const getExplr = (chain: Chain): string =>
+  chain.explorers?.[0]?.url ?? '';
+
+/**
+ * Returns bech32 address format as required by Keplr and other wallets
+ *
+ * @param prefix Chain bech32 prefix
+ * @returns a valid `Bech32Config`
+ */
+export const getBech32Config = (
+  prefix: string,
+  validatorPrefix: string = 'val',
+  consensusPrefix: string = 'cons',
+  publicPrefix: string = 'pub',
+  operatorPrefix: string = 'oper',
+): Bech32Config => ({
+  bech32PrefixAccAddr: prefix,
+  bech32PrefixAccPub: `${prefix}${publicPrefix}`,
+  bech32PrefixValAddr: `${prefix}${validatorPrefix}${operatorPrefix}`,
+  bech32PrefixValPub: `${prefix}${validatorPrefix}${operatorPrefix}${publicPrefix}`,
+  bech32PrefixConsAddr: `${prefix}${validatorPrefix}${consensusPrefix}`,
+  bech32PrefixConsPub: `${prefix}${validatorPrefix}${consensusPrefix}${publicPrefix}`,
+});

packages/wallets/src/utils/index.ts

@@ -0,0 +1,3 @@
+export * from './chain';
+export * from './semver';
+export * from './wallet';

packages/wallets/src/utils/semver.test.ts

@@ -0,0 +1,40 @@
+import { satisfies, extractVer, parseVer } from './semver';
+
+const validVer =
+  'osmosis-labs/[email protected]';
+const validVer2 = 'osmosis-labs/[email protected]';
+const invalidVer = 'osmosis-labs/cosmos-sdk';
+
+const versionToCheck = '0.40.0';
+
+test('extract valid version', () => {
+  expect(extractVer(validVer)).toBe('0.45.0');
+});
+
+test('extract invalid version', () => {
+  expect(extractVer(invalidVer)).toBe(null);
+});
+
+test('parse version', () => {
+  expect(parseVer(validVer)).toBe('0.45.0');
+});
+
+test('parse version with missing padding', () => {
+  expect(parseVer(validVer2)).toBe('0.45.0');
+});
+
+test('satisfies compare gte', () => {
+  expect(satisfies(versionToCheck, '>=0.40.0')).toBeTruthy();
+});
+
+test('satisfies compare lte', () => {
+  expect(satisfies(versionToCheck, '<=0.40.0')).toBeTruthy();
+});
+
+test('satisfies compare lte falsy', () => {
+  expect(satisfies(versionToCheck, '<=0.39.0')).toBeFalsy();
+});
+
+test('satisfies compare gte small version', () => {
+  expect(satisfies(versionToCheck, '>=0.4.0')).toBeTruthy();
+});