@rango-dev/widget-embedded 0.17.1-next.25 → 0.17.1-next.27

package/src/store/slices/settings.ts

@@ -0,0 +1,168 @@
+import type { ConfigSlice } from './config';
+import type { WidgetConfig } from '../../types';
+import type { SwapperMeta } from 'rango-sdk';
+import type { StateCreator } from 'zustand';
+
+import { type Language } from '@rango-dev/ui';
+
+import { BLOCKCHAIN_LIST_SIZE } from '../../constants/configs';
+import { DEFAULT_LANGUAGE } from '../../constants/languages';
+import { DEFAULT_SLIPPAGE } from '../../constants/swapSettings';
+import { removeDuplicateFrom } from '../../utils/common';
+import { isFeatureHidden } from '../../utils/settings';
+
+export type ThemeMode = 'auto' | 'dark' | 'light';
+
+export interface SettingsSlice {
+  theme: ThemeMode;
+  language: Language;
+  disabledLiquiditySources: string[];
+  /** Keeping a history of blockchains that user has selected (in Swap process) */
+  preferredBlockchains: string[];
+  slippage: number;
+  customSlippage: number | null;
+  infiniteApprove: boolean;
+  affiliateRef: string | null;
+  affiliatePercent: number | null;
+  affiliateWallets: { [key: string]: string } | null;
+
+  setSlippage: (slippage: number) => void;
+  setCustomSlippage: (customSlippage: number | null) => void;
+  toggleInfiniteApprove: () => void;
+  toggleLiquiditySource: (name: string) => void;
+  setTheme: (theme: ThemeMode) => void;
+  setLanguage: (language: Language) => void;
+  toggleAllLiquiditySources: (
+    swappers: SwapperMeta[],
+    shouldReset?: boolean
+  ) => void;
+  setAffiliateRef: (affiliateRef: string | null) => void;
+  setAffiliatePercent: (affiliatePercent: number | null) => void;
+  setAffiliateWallets: (
+    affiliateWallets: { [key: string]: string } | null
+  ) => void;
+  addPreferredBlockchain: (blockchain: string) => void;
+  updateSettings: (config: WidgetConfig) => void;
+}
+
+export const createSettingsSlice: StateCreator<
+  SettingsSlice & ConfigSlice,
+  [],
+  [],
+  SettingsSlice
+> = (set, get) => ({
+  disabledLiquiditySources: [],
+  theme: 'auto',
+  language: DEFAULT_LANGUAGE,
+  preferredBlockchains: [],
+  slippage: DEFAULT_SLIPPAGE,
+  customSlippage: null,
+  infiniteApprove: false,
+  affiliateRef: null,
+  affiliatePercent: null,
+  affiliateWallets: null,
+
+  addPreferredBlockchain: (blockchain) => {
+    const currentPreferredBlockchains = get().preferredBlockchains;
+
+    const noNeedToDoAnything = currentPreferredBlockchains.find(
+      (preferredBlockchain, index) => {
+        const isSameBlockchain = preferredBlockchain === blockchain;
+        const isInVisibleList = index <= BLOCKCHAIN_LIST_SIZE - 1;
+
+        return isSameBlockchain && isInVisibleList;
+      }
+    );
+
+    if (noNeedToDoAnything) {
+      return;
+    }
+
+    const nextPreferredBlockchains: string[] =
+      currentPreferredBlockchains.filter((preferredBlockchain) => {
+        const isSameBlockchain = preferredBlockchain === blockchain;
+
+        return !isSameBlockchain;
+      });
+
+    set(() => ({
+      preferredBlockchains: [blockchain, ...nextPreferredBlockchains],
+    }));
+  },
+  setSlippage: (slippage) =>
+    set(() => ({
+      slippage: slippage,
+    })),
+  setCustomSlippage: (customSlippage) =>
+    set(() => ({
+      customSlippage: customSlippage,
+    })),
+  setAffiliateRef: (affiliateRef) =>
+    set(() => ({
+      affiliateRef,
+    })),
+  setAffiliatePercent: (affiliatePercent) =>
+    set(() => ({
+      affiliatePercent,
+    })),
+
+  setAffiliateWallets: (affiliateWallets) =>
+    set(() => ({
+      affiliateWallets,
+    })),
+  toggleAllLiquiditySources: (swappers, shouldReset) =>
+    set((state) => {
+      if (shouldReset) {
+        return { disabledLiquiditySources: [] };
+      }
+      const swappersGroup = removeDuplicateFrom(
+        swappers.map((swapper) => swapper.swapperGroup)
+      );
+
+      if (swappersGroup.length === state.disabledLiquiditySources.length) {
+        return { disabledLiquiditySources: [] };
+      }
+
+      return {
+        disabledLiquiditySources: swappersGroup,
+      };
+    }),
+  toggleInfiniteApprove: () =>
+    set((state) => ({
+      infiniteApprove: !state.infiniteApprove,
+    })),
+  toggleLiquiditySource: (name) =>
+    set((state) => {
+      if (state.disabledLiquiditySources.includes(name)) {
+        return {
+          disabledLiquiditySources: state.disabledLiquiditySources.filter(
+            (liquiditySource) => liquiditySource != name
+          ),
+        };
+      }
+      return {
+        disabledLiquiditySources: state.disabledLiquiditySources.concat(name),
+      };
+    }),
+  setTheme: (theme) =>
+    set(() => ({
+      theme,
+    })),
+  setLanguage: (language) =>
+    set(() => ({
+      language,
+    })),
+  updateSettings: (nextConfig: WidgetConfig) => {
+    const { features } = nextConfig;
+
+    const isThemeHidden = isFeatureHidden('theme', features);
+    const isLanguageHidden = isFeatureHidden('language', features);
+    const isLiquidityHidden = isFeatureHidden('liquiditySource', features);
+
+    set({
+      ...(isThemeHidden && { theme: 'auto' }),
+      ...(isLanguageHidden && { language: DEFAULT_LANGUAGE }),
+      ...(isLiquidityHidden && { disabledLiquiditySources: [] }),
+    });
+  },
+});

package/src/store/wallets.ts

@@ -1,4 +1,4 @@
-import type { Wallet } from '../types';
+import type { Balance, TokensBalance, Wallet } from '../types';
 import type { WalletType } from '@rango-dev/wallets-shared';
 import type { Token } from 'rango-sdk';
 
@@ -7,8 +7,10 @@ import { subscribeWithSelector } from 'zustand/middleware';
 
 import { httpService } from '../services/httpService';
 import {
+  createTokenHash,
   isAccountAndWalletMatched,
   makeBalanceFor,
+  makeTokensBalance,
   resetConnectedWalletState,
 } from '../utils/wallets';
 
@@ -33,9 +35,9 @@ export interface ConnectedWallet extends Wallet {
   loading: boolean;
   error: boolean;
 }
-
 interface WalletsStore {
   connectedWallets: ConnectedWallet[];
+  balances: TokensBalance;
   customDestination: string;
   loading: boolean;
   connectWallet: (accounts: Wallet[], tokens: Token[]) => void;
@@ -47,12 +49,14 @@ interface WalletsStore {
     tokens: Token[],
     shouldRetry?: boolean
   ) => void;
+  getBalanceFor: (token: Token) => Balance | null;
 }
 
 export const useWalletsStore = createSelectors(
   create<WalletsStore>()(
     subscribeWithSelector((set, get) => ({
       connectedWallets: [],
+      balances: {},
       customDestination: '',
       loading: false,
       connectWallet: (accounts, tokens) => {
@@ -92,21 +96,27 @@ export const useWalletsStore = createSelectors(
                 connectedWallet.walletType !== walletType
             )
             .map((selectedWallet) => selectedWallet.chain);
+
+          const connectedWallets = state.connectedWallets
+            .filter(
+              (connectedWallet) => connectedWallet.walletType !== walletType
+            )
+            .map((connectedWallet) => {
+              const anyWalletSelectedForBlockchain = selectedWallets.includes(
+                connectedWallet.chain
+              );
+              if (anyWalletSelectedForBlockchain) {
+                return connectedWallet;
+              }
+              selectedWallets.push(connectedWallet.chain);
+              return { ...connectedWallet, selected: true };
+            });
+
+          const balances = makeTokensBalance(connectedWallets);
+
           return {
-            connectedWallets: state.connectedWallets
-              .filter(
-                (connectedWallet) => connectedWallet.walletType !== walletType
-              )
-              .map((connectedWallet) => {
-                const anyWalletSelectedForBlockchain = selectedWallets.includes(
-                  connectedWallet.chain
-                );
-                if (anyWalletSelectedForBlockchain) {
-                  return connectedWallet;
-                }
-                selectedWallets.push(connectedWallet.chain);
-                return { ...connectedWallet, selected: true };
-              }),
+            balances,
+            connectedWallets,
           };
         });
       },
@@ -159,9 +169,8 @@ export const useWalletsStore = createSelectors(
           const response = await httpService().getWalletsDetails(data);
           const retrievedBalance = response.wallets;
           if (retrievedBalance) {
-            set((state) => ({
-              loading: false,
-              connectedWallets: state.connectedWallets.map(
+            set((state) => {
+              const connectedWallets = state.connectedWallets.map(
                 (connectedWallet) => {
                   const matchedAccount = accounts.find((account) =>
                     isAccountAndWalletMatched(account, connectedWallet)
@@ -190,27 +199,45 @@ export const useWalletsStore = createSelectors(
                       }
                     : connectedWallet;
                 }
-              ),
-            }));
+              );
+
+              const balances = makeTokensBalance(connectedWallets);
+
+              return {
+                loading: false,
+                balances,
+                connectedWallets,
+              };
+            });
           } else {
             throw new Error('Wallet not found');
           }
         } catch (error) {
-          set((state) => ({
-            loading: false,
-            connectedWallets: state.connectedWallets.map((balance) => {
+          set((state) => {
+            const connectedWallets = state.connectedWallets.map((balance) => {
               return accounts.find((account) =>
                 isAccountAndWalletMatched(account, balance)
               )
                 ? resetConnectedWalletState(balance)
                 : balance;
-            }),
-          }));
+            });
+
+            const balances = makeTokensBalance(connectedWallets);
+
+            return {
+              loading: false,
+              balances,
+              connectedWallets,
+            };
+          });
         }
       },
+      getBalanceFor: (token) => {
+        const { balances } = get();
+        const tokenHash = createTokenHash(token);
+        const balance = balances[tokenHash];
+        return balance ?? null;
+      },
     }))
   )
 );
-
-export const fetchingBalanceSelector = (state: WalletsStore) =>
-  !!state.connectedWallets.find((wallet) => wallet.loading);

package/src/types/config.ts

@@ -86,14 +86,37 @@ export type BlockchainAndTokenConfig = {
 };
 
 /**
- * `ExperimentalFeatures`
+ * `Features`
  *
- * @property {boolean} routing
- *- This property is optional and sets experimental in quote api.
+ * @property {'visible' | 'hidden'} [theme]
+ * - The visibility state for the theme feature. Optional property.
+ *
+ * @property {'visible' | 'hidden'} [language]
+ * - The visibility state for the language feature. Optional property.
+ *
+ * @property {'disabled' | 'enabled'} [experimentalRoute]
+ * - The enablement state for the experimental route feature. Optional property.
+ *
+ * @property {'visible' | 'hidden'} [connectWalletButton]
+ * - The visibility state for the connect wallet button feature. Optional property.
+ *
+ * @property {'visible' | 'hidden'} [notification]
+ * - The visibility state for the notification feature. Optional property.
+ *
+ * @property {'visible' | 'hidden'} [liquiditySource]
+ * - The visibility state for the liquiditySource feature. Optional property.
  */
-type ExperimentalFeatures = {
-  routing?: boolean;
-};
+export type Features = Partial<
+  Record<
+    | 'theme'
+    | 'language'
+    | 'connectWalletButton'
+    | 'notification'
+    | 'liquiditySource',
+    'visible' | 'hidden'
+  >
+> &
+  Partial<Record<'experimentalRoute', 'disabled' | 'enabled'>>;
 
 /**
  * The type WidgetConfig defines the configuration options for a widget, including API key, affiliate
@@ -134,7 +157,14 @@ type ExperimentalFeatures = {
  * you could use to pin tokens of your choice to the top of the token list.
  * @property {boolean} enableNewLiquiditySources - The `enableNewLiquiditySources` property is a boolean value that when you
  * set it to true, whenever a new liquidity source is added, it will be added to your list as well.
- * @property {ExperimentalFeatures} experimental - The `experimental` property is an optional object that specifies some experimental features.
+ * @property {Features} features - An optional object for configuring the visibility or enablement of various features.
+ *   Keys include:
+ *   - 'notification': Visibility state for the notification icon.
+ *   - 'theme': Visibility state for the theme.
+ *   - 'liquiditySource': Visibility state for liquidity source.
+ *   - 'connectWalletButton': Visibility state for the wallet connect icon.
+ *   - 'language': Visibility state for the language.
+ *   - 'experimentalRoute': Enablement state for the experimental route.
  */
 
 export type WidgetConfig = {
@@ -154,5 +184,5 @@ export type WidgetConfig = {
   externalWallets?: boolean;
   pinnedTokens?: Asset[];
   enableNewLiquiditySources?: boolean;
-  experimental?: ExperimentalFeatures;
+  features?: Features;
 };

package/src/types/wallets.ts

@@ -1,7 +1,24 @@
-import { WalletType } from '@rango-dev/wallets-shared';
+import type { WalletType } from '@rango-dev/wallets-shared';
 
 export interface Wallet {
   chain: string;
   address: string;
   walletType: WalletType;
 }
+
+export type Balance = {
+  amount: string;
+  decimals: number;
+  usdValue: string;
+};
+
+type Blockchain = string;
+type TokenSymbol = string;
+type Address = string;
+
+/** `blockchain-symbol-Address` */
+export type TokenHash = `${Blockchain}-${TokenSymbol}-${Address}`;
+
+export type TokensBalance = {
+  [key: TokenHash]: Balance;
+};

package/src/utils/settings.ts

@@ -1,7 +1,6 @@
+import type { Features } from '../types';
 import type { SwapperMeta } from 'rango-sdk';
 
-import { useSettingsStore } from '../store/settings';
-
 import { removeDuplicateFrom } from './common';
 
 export type LiquiditySourceType = 'BRIDGE' | 'AGGREGATOR' | 'DEX';
@@ -15,10 +14,9 @@ export type UniqueSwappersGroupType = {
 };
 
 export function getUniqueSwappersGroups(
-  swappers: SwapperMeta[]
+  swappers: SwapperMeta[],
+  disabledLiquiditySources: string[]
 ): UniqueSwappersGroupType[] {
-  const disabledLiquiditySources =
-    useSettingsStore.use.disabledLiquiditySources();
   const supportedSwappers = swappers.map((swapper) => swapper.swapperGroup);
 
   const uniqueSupportedSwappersGroups: Array<UniqueSwappersGroupType> = [];
@@ -71,3 +69,11 @@ export function sortLiquiditySourcesByGroupTitle(
 
   return 0;
 }
+
+export function isFeatureHidden(feature: keyof Features, features?: Features) {
+  return features?.[feature] === 'hidden';
+}
+
+export function isFeatureEnabled(feature: keyof Features, features?: Features) {
+  return features?.[feature] === 'enabled';
+}