@rango-dev/widget-embedded 0.17.1-next.2 → 0.17.1-next.21

package/src/store/{bestRoute.ts → quote.ts}

@@ -1,7 +1,12 @@
 import type { TokenWithBalance } from '../components/TokenList';
 import type { Wallet } from '../types';
 import type { PendingSwap } from '@rango-dev/queue-manager-rango-preset/dist/shared';
-import type { BestRouteResponse, BlockchainMeta, Token } from 'rango-sdk';
+import type {
+  BestRouteResponse,
+  BlockchainMeta,
+  MetaResponse,
+  Token,
+} from 'rango-sdk';
 
 import BigNumber from 'bignumber.js';
 import { create } from 'zustand';
@@ -9,21 +14,24 @@ import { subscribeWithSelector } from 'zustand/middleware';
 
 import { ZERO } from '../constants/numbers';
 import { isPositiveNumber } from '../utils/numbers';
-import {
-  createRetryRoute,
-  getBestRouteToTokenUsdPrice,
-} from '../utils/routing';
+import { createRetryQuote, getQuoteToTokenUsdPrice } from '../utils/quote';
 import { calcOutputUsdValue } from '../utils/swap';
 
-import { useMetaStore } from './meta';
 import createSelectors from './selectors';
 
-const getUsdValue = (token: Token | null, amount: string): BigNumber | null =>
+export const getUsdValue = (
+  token: Token | null,
+  amount: string
+): BigNumber | null =>
   token?.usdPrice
     ? new BigNumber(amount || ZERO).multipliedBy(token?.usdPrice || 0)
     : null;
 
-export interface RouteState {
+export type Meta = Pick<MetaResponse, 'blockchains' | 'tokens'>;
+
+export type SetTokenParams = { token: Token; meta: Meta } | { token: null };
+
+export interface QuoteState {
   fromBlockchain: BlockchainMeta | null;
   toBlockchain: BlockchainMeta | null;
   inputAmount: string;
@@ -32,30 +40,32 @@ export interface RouteState {
   outputUsdValue: BigNumber | null;
   fromToken: TokenWithBalance | null;
   toToken: TokenWithBalance | null;
-  routeWalletsConfirmed: boolean;
+  quoteWalletsConfirmed: boolean;
   selectedWallets: Wallet[];
-  resetRoute: () => void;
+  quoteWarningsConfirmed: boolean;
+  resetQuote: () => void;
   resetToBlockchain: () => void;
   resetFromBlockchain: () => void;
   setFromBlockchain: (chain: BlockchainMeta | null) => void;
   setToBlockchain: (chian: BlockchainMeta | null) => void;
 
-  setFromToken: (token: Token | null) => void;
-  setToToken: (token: Token | null) => void;
+  setFromToken: (params: SetTokenParams) => void;
+  setToToken: (params: SetTokenParams) => void;
   setInputAmount: (amount: string) => void;
-  bestRoute: BestRouteResponse | null;
-  setRoute: (bestRoute: BestRouteResponse | null) => void;
-  retry: (pendingSwap: PendingSwap) => void;
+  quote: BestRouteResponse | null;
+  setQuote: (quote: BestRouteResponse | null) => void;
+  retry: (pendingSwap: PendingSwap, meta: Meta) => void;
   switchFromAndTo: () => void;
-  setRouteWalletConfirmed: (flag: boolean) => void;
+  setQuoteWalletConfirmed: (flag: boolean) => void;
   setSelectedWallets: (wallets: Wallet[]) => void;
   customDestination: string;
   setCustomDestination: (address: string) => void;
-  resetRouteWallets: () => void;
+  resetQuoteWallets: () => void;
+  setQuoteWarningsConfirmed: (flag: boolean) => void;
 }
 
-export const useBestRouteStore = createSelectors(
-  create<RouteState>()(
+export const useQuoteStore = createSelectors(
+  create<QuoteState>()(
     subscribeWithSelector((set) => ({
       fromBlockchain: null,
       fromToken: null,
@@ -65,37 +75,38 @@ export const useBestRouteStore = createSelectors(
       outputUsdValue: new BigNumber(0),
       toBlockchain: null,
       toToken: null,
-      bestRoute: null,
-      routeWalletsConfirmed: false,
+      quote: null,
+      quoteWalletsConfirmed: false,
       selectedWallets: [],
       customDestination: '',
-      setRoute: (bestRoute) =>
+      quoteWarningsConfirmed: false,
+      setQuote: (quote) =>
         set((state) => {
           let outputAmount: BigNumber | null = null;
           let outputUsdValue: BigNumber = ZERO;
           if (!isPositiveNumber(state.inputAmount)) {
             return {};
           }
-          if (!!bestRoute) {
-            outputAmount = !!bestRoute.result?.outputAmount
-              ? new BigNumber(bestRoute.result?.outputAmount)
+          if (!!quote) {
+            outputAmount = !!quote.result?.outputAmount
+              ? new BigNumber(quote.result?.outputAmount)
               : null;
             outputUsdValue = calcOutputUsdValue(
-              bestRoute.result?.outputAmount,
-              getBestRouteToTokenUsdPrice(bestRoute) || state.toToken?.usdPrice
+              quote.result?.outputAmount,
+              getQuoteToTokenUsdPrice(quote) || state.toToken?.usdPrice
             );
           }
           return {
-            bestRoute,
-            ...(!!bestRoute && {
+            quote: quote,
+            ...(!!quote && {
               outputAmount,
               outputUsdValue,
             }),
           };
         }),
-      resetRoute: () =>
+      resetQuote: () =>
         set(() => ({
-          bestRoute: null,
+          quote: null,
           outputAmount: null,
           outputUsdValue: new BigNumber(0),
         })),
@@ -108,7 +119,7 @@ export const useBestRouteStore = createSelectors(
           return {
             fromBlockchain: chain,
             ...(state.fromToken && {
-              bestRoute: null,
+              quote: null,
               fromToken: null,
               outputAmount: null,
               outputUsdValue: null,
@@ -116,18 +127,17 @@ export const useBestRouteStore = createSelectors(
           };
         });
       },
-      setFromToken: (token) => {
-        const { blockchains } = useMetaStore.getState().meta;
+      setFromToken: (params) => {
         return set((state) => ({
-          fromToken: token,
-          ...(token && {
+          fromToken: params.token,
+          ...(params.token && {
             fromBlockchain:
-              blockchains.find(
-                (blockchain) => blockchain.name === token.blockchain
+              params.meta.blockchains.find(
+                (blockchain) => blockchain.name === params.token.blockchain
               ) ?? null,
           }),
           ...(!!state.inputAmount && {
-            inputUsdValue: getUsdValue(token, state.inputAmount),
+            inputUsdValue: getUsdValue(params.token, state.inputAmount),
           }),
         }));
       },
@@ -140,7 +150,7 @@ export const useBestRouteStore = createSelectors(
           return {
             toBlockchain: chain,
             ...(state.toToken && {
-              bestRoute: null,
+              quote: null,
               toToken: null,
               outputAmount: null,
               outputUsdValue: null,
@@ -148,14 +158,13 @@ export const useBestRouteStore = createSelectors(
           };
         });
       },
-      setToToken: (token) => {
-        const { blockchains } = useMetaStore.getState().meta;
+      setToToken: (params) => {
         return set(() => ({
-          toToken: token,
-          ...(token && {
+          toToken: params.token,
+          ...(params.token && {
             toBlockchain:
-              blockchains.find(
-                (blockchain) => blockchain.name === token.blockchain
+              params.meta.blockchains.find(
+                (blockchain) => blockchain.name === params.token.blockchain
               ) ?? null,
           }),
         }));
@@ -166,24 +175,22 @@ export const useBestRouteStore = createSelectors(
           ...(!amount && {
             outputAmount: new BigNumber(0),
             outputUsdValue: new BigNumber(0),
-            bestRoute: null,
+            quote: null,
           }),
           ...(!!state.fromToken && {
             inputUsdValue: getUsdValue(state.fromToken, amount),
           }),
         }));
       },
-      retry: (pendingSwap) => {
-        const { tokens, blockchains } = useMetaStore.getState().meta;
-
+      retry: (pendingSwap, meta) => {
+        const { tokens, blockchains } = meta;
         const {
           fromBlockchain,
           fromToken,
           toBlockchain,
           toToken,
           inputAmount,
-        } = createRetryRoute(pendingSwap, blockchains, tokens);
-
+        } = createRetryQuote(pendingSwap, blockchains, tokens);
         set({
           fromBlockchain,
           fromToken,
@@ -193,7 +200,7 @@ export const useBestRouteStore = createSelectors(
           outputUsdValue: new BigNumber(0),
           toBlockchain,
           toToken,
-          bestRoute: null,
+          quote: null,
         });
       },
       switchFromAndTo: () =>
@@ -208,14 +215,13 @@ export const useBestRouteStore = createSelectors(
             state.outputAmount?.toString() || ''
           ),
         })),
-
       resetFromBlockchain: () =>
         set(() => ({
           fromToken: null,
           fromBlockchain: null,
           outputAmount: null,
           outputUsdValue: null,
-          bestRoute: null,
+          quote: null,
         })),
       resetToBlockchain: () =>
         set(() => ({
@@ -223,20 +229,22 @@ export const useBestRouteStore = createSelectors(
           toBlockchain: null,
           outputAmount: null,
           outputUsdValue: null,
-          bestRoute: null,
+          quote: null,
         })),
-      setRouteWalletConfirmed: (flag) =>
+      setQuoteWalletConfirmed: (flag) =>
         set({
-          routeWalletsConfirmed: flag,
+          quoteWalletsConfirmed: flag,
         }),
       setSelectedWallets: (wallets) => set({ selectedWallets: wallets }),
       setCustomDestination: (address) => set({ customDestination: address }),
-      resetRouteWallets: () =>
+      resetQuoteWallets: () =>
         set({
-          routeWalletsConfirmed: false,
+          quoteWalletsConfirmed: false,
           selectedWallets: [],
           customDestination: '',
         }),
+      setQuoteWarningsConfirmed: (flag) =>
+        set({ quoteWarningsConfirmed: flag }),
     }))
   )
 );

package/src/store/settings.ts

@@ -1,3 +1,5 @@
+import type { SwapperMeta } from 'rango-sdk';
+
 import { type Language } from '@rango-dev/ui';
 import { create } from 'zustand';
 import { persist, subscribeWithSelector } from 'zustand/middleware';
@@ -7,7 +9,6 @@ import { DEFAULT_LANGUAGE } from '../constants/languages';
 import { DEFAULT_SLIPPAGE } from '../constants/swapSettings';
 import { removeDuplicateFrom } from '../utils/common';
 
-import { useMetaStore } from './meta';
 import createSelectors from './selectors';
 
 export type ThemeMode = 'auto' | 'dark' | 'light';
@@ -31,7 +32,10 @@ export interface SettingsState {
   toggleLiquiditySource: (name: string) => void;
   setTheme: (theme: ThemeMode) => void;
   setLanguage: (language: Language) => void;
-  toggleAllLiquiditySources: (shouldReset?: boolean) => void;
+  toggleAllLiquiditySources: (
+    swappers: SwapperMeta[],
+    shouldReset?: boolean
+  ) => void;
   setAffiliateRef: (affiliateRef: string | null) => void;
   setAffiliatePercent: (affiliatePercent: number | null) => void;
   setAffiliateWallets: (
@@ -102,12 +106,11 @@ export const useSettingsStore = createSelectors(
           set(() => ({
             affiliateWallets,
           })),
-        toggleAllLiquiditySources: (shouldReset?: boolean) =>
+        toggleAllLiquiditySources: (swappers, shouldReset) =>
           set((state) => {
             if (shouldReset) {
               return { disabledLiquiditySources: [] };
             }
-            const { swappers } = useMetaStore.getState().meta;
             const swappersGroup = removeDuplicateFrom(
               swappers.map((swapper) => swapper.swapperGroup)
             );

package/src/store/slices/config.ts

@@ -1,7 +1,11 @@
 import type { WidgetConfig } from '../../types';
-import type { StateCreator } from 'zustand';
+import type { StateCreatorWithInitialData } from '../app';
 
-const initConfig: WidgetConfig = { apiKey: '' };
+export const DEFAULT_CONFIG: WidgetConfig = {
+  apiKey: '',
+  multiWallets: true,
+  enableNewLiquiditySources: true,
+};
 
 export type ConfigSlice = {
   config: WidgetConfig;
@@ -9,18 +13,24 @@ export type ConfigSlice = {
   updateConfig: (config: WidgetConfig) => void;
 };
 
-export const createConfigSlice: StateCreator<ConfigSlice> = (set, get) => ({
-  config: initConfig,
+export const createConfigSlice: StateCreatorWithInitialData<
+  WidgetConfig,
+  ConfigSlice,
+  ConfigSlice
+> = (initialData, set, get) => {
+  return {
+    config: { ...DEFAULT_CONFIG, ...initialData },
 
-  // Actions
-  updateConfig: (nextConfig: WidgetConfig) => {
-    const currentConfig = get().config;
+    // Actions
+    updateConfig: (nextConfig: WidgetConfig) => {
+      const currentConfig = get().config;
 
-    set({
-      config: {
-        ...currentConfig,
-        ...nextConfig,
-      },
-    });
-  },
-});
+      set({
+        config: {
+          ...currentConfig,
+          ...nextConfig,
+        },
+      });
+    },
+  };
+};

package/src/store/slices/data.ts

@@ -6,6 +6,7 @@ import type { StateCreator } from 'zustand';
 
 import { httpService as sdk } from '../../services/httpService';
 import { containsText } from '../../utils/common';
+import { sortLiquiditySourcesByGroupTitle } from '../../utils/settings';
 import { tokensAreEqual } from '../../utils/wallets';
 
 type BlockchainOptions = {
@@ -18,15 +19,16 @@ type TokenOptions = {
   blockchain?: string;
   searchFor?: string;
 };
-
+export type FetchStatus = 'loading' | 'success' | 'failed';
 export interface DataSlice {
   _blockchains: BlockchainMeta[];
   _tokens: Token[];
   _popularTokens: Token[];
   _swappers: SwapperMeta[];
-
+  fetchStatus: FetchStatus;
   blockchains: (options?: BlockchainOptions) => BlockchainMeta[];
   tokens: (options?: TokenOptions) => Token[];
+  swappers: () => SwapperMeta[];
   isTokenPinned: (token: Token) => boolean;
 
   fetch: () => Promise<void>;
@@ -43,7 +45,7 @@ export const createDataSlice: StateCreator<
   _tokens: [],
   _popularTokens: [],
   _swappers: [],
-
+  fetchStatus: 'loading',
   // Selectors
   blockchains: (options) => {
     const blockchainsFromState = get()._blockchains;
@@ -163,41 +165,74 @@ export const createDataSlice: StateCreator<
     );
     return pinned;
   },
+  swappers: () => {
+    const {
+      config: { enableNewLiquiditySources, liquiditySources },
+    } = get();
+
+    /*
+     * If the enableNewLiquiditySources flag is set to true, we return all swappers that are not included in the config.
+     * Otherwise, we return all swappers that are included in the config.
+     */
+    const swappers = get()._swappers.filter((swapper) => {
+      const swapperGroupIncludedInLiquiditySources = liquiditySources?.includes(
+        swapper.swapperGroup
+      );
+
+      const shouldExcludeLiquiditySources =
+        enableNewLiquiditySources ||
+        !liquiditySources ||
+        liquiditySources.length === 0;
+
+      return shouldExcludeLiquiditySources
+        ? !swapperGroupIncludedInLiquiditySources
+        : swapperGroupIncludedInLiquiditySources;
+    });
+
+    const sortedSwappers = swappers.sort(sortLiquiditySourcesByGroupTitle);
 
+    return sortedSwappers;
+  },
   // Actions
   fetch: async () => {
-    const response = await sdk().getAllMetadata();
+    try {
+      const response = await sdk().getAllMetadata();
 
-    const blockchains: BlockchainMeta[] = [];
-    const tokens: Token[] = [];
-    const popularTokens: Token[] = response.popularTokens;
-    const swappers: SwapperMeta[] = response.swappers;
+      set({ fetchStatus: 'success' });
+      const blockchains: BlockchainMeta[] = [];
+      const tokens: Token[] = [];
+      const popularTokens: Token[] = response.popularTokens;
+      const swappers: SwapperMeta[] = response.swappers;
 
-    const blockchainsWithAtLeastOneToken = new Set();
+      const blockchainsWithAtLeastOneToken = new Set();
 
-    response.tokens.forEach((token) => {
-      blockchainsWithAtLeastOneToken.add(token.blockchain);
+      response.tokens.forEach((token) => {
+        blockchainsWithAtLeastOneToken.add(token.blockchain);
 
-      tokens.push(token);
-    });
+        tokens.push(token);
+      });
 
-    response.blockchains.forEach((blockchain) => {
-      if (
-        blockchain.enabled &&
-        blockchainsWithAtLeastOneToken.has(blockchain.name)
-      ) {
-        blockchains.push(blockchain);
-      }
-    });
+      response.blockchains.forEach((blockchain) => {
+        if (
+          blockchain.enabled &&
+          blockchainsWithAtLeastOneToken.has(blockchain.name)
+        ) {
+          blockchains.push(blockchain);
+        }
+      });
 
-    // Sort
-    blockchains.sort((a, b) => a.sort - b.sort);
+      // Sort
+      blockchains.sort((a, b) => a.sort - b.sort);
 
-    set({
-      _blockchains: blockchains,
-      _tokens: tokens,
-      _popularTokens: popularTokens,
-      _swappers: swappers,
-    });
+      set({
+        _blockchains: blockchains,
+        _tokens: tokens,
+        _popularTokens: popularTokens,
+        _swappers: swappers,
+      });
+    } catch (error) {
+      set({ fetchStatus: 'failed' });
+      throw error;
+    }
   },
 });

package/src/store/wallets.ts

@@ -1,5 +1,6 @@
 import type { Wallet } from '../types';
 import type { WalletType } from '@rango-dev/wallets-shared';
+import type { Token } from 'rango-sdk';
 
 import { create } from 'zustand';
 import { subscribeWithSelector } from 'zustand/middleware';
@@ -11,7 +12,6 @@ import {
   resetConnectedWalletState,
 } from '../utils/wallets';
 
-import { useMetaStore } from './meta';
 import createSelectors from './selectors';
 
 export type TokenBalance = {
@@ -38,11 +38,15 @@ interface WalletsStore {
   connectedWallets: ConnectedWallet[];
   customDestination: string;
   loading: boolean;
-  connectWallet: (accounts: Wallet[]) => void;
+  connectWallet: (accounts: Wallet[], tokens: Token[]) => void;
   disconnectWallet: (walletType: WalletType) => void;
   selectWallets: (wallets: { walletType: string; chain: string }[]) => void;
   clearConnectedWallet: () => void;
-  getWalletsDetails: (accounts: Wallet[], shouldRetry?: boolean) => void;
+  getWalletsDetails: (
+    accounts: Wallet[],
+    tokens: Token[],
+    shouldRetry?: boolean
+  ) => void;
 }
 
 export const useWalletsStore = createSelectors(
@@ -51,7 +55,7 @@ export const useWalletsStore = createSelectors(
       connectedWallets: [],
       customDestination: '',
       loading: false,
-      connectWallet: (accounts) => {
+      connectWallet: (accounts, tokens) => {
         const getWalletsDetails = get().getWalletsDetails;
         set((state) => ({
           loading: true,
@@ -77,7 +81,7 @@ export const useWalletsStore = createSelectors(
               })
             ),
         }));
-        getWalletsDetails(accounts);
+        getWalletsDetails(accounts, tokens);
       },
       disconnectWallet: (walletType) => {
         set((state) => {
@@ -135,9 +139,8 @@ export const useWalletsStore = createSelectors(
           connectedWallets: [],
           selectedWallets: [],
         })),
-      getWalletsDetails: async (accounts, shouldRetry = true) => {
+      getWalletsDetails: async (accounts, tokens, shouldRetry = true) => {
         const getWalletsDetails = get().getWalletsDetails;
-        const { tokens } = useMetaStore.getState().meta;
         set((state) => ({
           loading: true,
           connectedWallets: state.connectedWallets.map((wallet) => {
@@ -173,7 +176,7 @@ export const useWalletsStore = createSelectors(
                     matchedAccount &&
                     shouldRetry
                   ) {
-                    getWalletsDetails([matchedAccount], false);
+                    getWalletsDetails([matchedAccount], tokens, false);
                   }
                   return matchedAccount && retrievedBalanceAccount
                     ? {
@@ -183,6 +186,7 @@ export const useWalletsStore = createSelectors(
                           retrievedBalanceAccount,
                           tokens
                         ),
+                        loading: false,
                       }
                     : connectedWallet;
                 }

package/src/types/config.ts

@@ -61,7 +61,7 @@ export type WidgetTheme = {
  * @property {{ [key: string]: string }} wallets - If you want to change the default affiliate wallet
  *  addresses, you can provide new values here. (Map of route blockchains to affiliate address)
  */
-export type WidgeAffiliate = {
+export type WidgetAffiliate = {
   ref?: string;
   percent?: number;
   wallets?: { [key: string]: string };
@@ -85,13 +85,24 @@ export type BlockchainAndTokenConfig = {
   tokens?: Asset[];
 };
 
+/**
+ * `ExperimentalFeatures`
+ *
+ * @property {boolean} routing
+ *- This property is optional and sets experimental in quote api.
+ */
+type ExperimentalFeatures = {
+  routing?: boolean;
+};
+
 /**
  * The type WidgetConfig defines the configuration options for a widget, including API key, affiliate
  * reference, amount, blockchain and token configurations, liquidity sources, wallet types, language,
  * and theme.
  *
  * @property {string} apiKey - The API key used to communicate with Rango API
- * @property {WidgeAffiliate} affiliate - If you want to charge users fee per transaction, you should
+ * @property {string} apiUrl - The API url used to set custom API url
+ * @property {WidgetAffiliate} affiliate - If you want to charge users fee per transaction, you should
  * pass `WidgetAffiliate` including affiliateRef, affiliatePercent, and affiliateWallets.
  * @property {number} amount - The default input amount.
  * @property {BlockchainAndTokenConfig} from - The `from` property is an optional property of type
@@ -121,13 +132,16 @@ export type BlockchainAndTokenConfig = {
  * If `externalWallets` is `true`, you should add `WidgetWallets` to your app.
  * @property {Asset} pinnedTokens - The `pinnedTokens` property is an optional array of `Asset` objects that
  * you could use to pin tokens of your choice to the top of the token list.
- * @property {boolean} includeNewLiquiditySources - The `includeNewLiquiditySources` property is a boolean value that when you
+ * @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.
  */
+
 export type WidgetConfig = {
   apiKey: string;
+  apiUrl?: string;
   walletConnectProjectId?: string;
-  affiliate?: WidgeAffiliate;
+  affiliate?: WidgetAffiliate;
   amount?: number;
   from?: BlockchainAndTokenConfig;
   to?: BlockchainAndTokenConfig;
@@ -139,5 +153,6 @@ export type WidgetConfig = {
   theme?: WidgetTheme;
   externalWallets?: boolean;
   pinnedTokens?: Asset[];
-  includeNewLiquiditySources?: boolean;
+  enableNewLiquiditySources?: boolean;
+  experimental?: ExperimentalFeatures;
 };

package/src/types/index.ts

@@ -1,4 +1,4 @@
 export * from './swap';
 export * from './config';
-export * from './routing';
+export * from './quote';
 export * from './wallets';