@rango-dev/widget-embedded 0.17.1-next.1 → 0.17.1-next.10

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
                     ? {

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 };
@@ -91,7 +91,7 @@ export type BlockchainAndTokenConfig = {
  * 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 {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 +121,13 @@ 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.
  */
 export type WidgetConfig = {
   apiKey: string;
   walletConnectProjectId?: string;
-  affiliate?: WidgeAffiliate;
+  affiliate?: WidgetAffiliate;
   amount?: number;
   from?: BlockchainAndTokenConfig;
   to?: BlockchainAndTokenConfig;
@@ -139,5 +139,5 @@ export type WidgetConfig = {
   theme?: WidgetTheme;
   externalWallets?: boolean;
   pinnedTokens?: Asset[];
-  includeNewLiquiditySources?: boolean;
+  enableNewLiquiditySources?: boolean;
 };

package/src/types/index.ts

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

package/src/types/quote.ts

@@ -0,0 +1,107 @@
+/* eslint-disable @typescript-eslint/prefer-enum-initializers */
+
+import type { PriceImpactWarningLevel } from '@rango-dev/ui';
+import type BigNumber from 'bignumber.js';
+import type { SwapResult } from 'rango-sdk';
+
+export enum QuoteErrorType {
+  NO_RESULT,
+  REQUEST_FAILED,
+  REQUEST_CANCELED,
+  BRIDGE_LIMIT,
+  INSUFFICIENT_SLIPPAGE,
+}
+
+export type NoResultError = {
+  type: QuoteErrorType.NO_RESULT;
+  diagnosisMessage?: string;
+};
+
+export type BridgeLimitError = {
+  type: QuoteErrorType.BRIDGE_LIMIT;
+  swap: SwapResult;
+  recommendation: string;
+  fromAmountRangeError: string;
+};
+
+export type InsufficientSlippageError = {
+  type: QuoteErrorType.INSUFFICIENT_SLIPPAGE;
+  recommendedSlippages: RecommendedSlippages | null;
+  minRequiredSlippage: string | null;
+};
+
+export type QuoteRequestFailed = { type: QuoteErrorType.REQUEST_FAILED };
+export type QuoteRequestCanceled = { type: QuoteErrorType.REQUEST_CANCELED };
+
+export type QuoteError =
+  | NoResultError
+  | BridgeLimitError
+  | InsufficientSlippageError
+  | QuoteRequestFailed
+  | QuoteRequestCanceled;
+
+export enum QuoteWarningType {
+  HIGH_VALUE_LOSS,
+  UNKNOWN_PRICE,
+  INSUFFICIENT_SLIPPAGE,
+  HIGH_SLIPPAGE,
+}
+
+export enum QuoteUpdateType {
+  QUOTE_UPDATED,
+  QUOTE_SWAPPERS_UPDATED,
+  QUOTE_COINS_UPDATED,
+  QUOTE_AND_OUTPUT_AMOUNT_UPDATED,
+  QUOTE_UPDATED_WITH_HIGH_VALUE_LOSS,
+}
+
+export type QuoteUpdateWarning =
+  | {
+      type: QuoteUpdateType.QUOTE_AND_OUTPUT_AMOUNT_UPDATED;
+      newOutputAmount: string;
+      percentageChange: string;
+    }
+  | {
+      type: Exclude<
+        QuoteUpdateType,
+        QuoteUpdateType.QUOTE_AND_OUTPUT_AMOUNT_UPDATED
+      >;
+    };
+
+export type RecommendedSlippages = Map<number, string>;
+
+export type InsufficientSlippageWarning = {
+  type: QuoteWarningType.INSUFFICIENT_SLIPPAGE;
+  recommendedSlippages: RecommendedSlippages | null;
+  minRequiredSlippage: string | null;
+};
+
+export type HighSlippageWarning = {
+  type: QuoteWarningType.HIGH_SLIPPAGE;
+  slippage: string | null;
+};
+
+export type HighValueLossWarning = {
+  type: QuoteWarningType.HIGH_VALUE_LOSS;
+  warningLevel: PriceImpactWarningLevel;
+  inputUsdValue: BigNumber;
+  outputUsdValue: BigNumber;
+  totalFee: BigNumber;
+  priceImpact: number;
+};
+
+export type UnknownPriceWarning = {
+  type: QuoteWarningType.UNKNOWN_PRICE;
+};
+
+export type QuoteWarning =
+  | HighValueLossWarning
+  | InsufficientSlippageWarning
+  | HighSlippageWarning
+  | UnknownPriceWarning;
+
+export type ConfirmSwapWarnings = {
+  quote: QuoteWarning | null;
+  quoteUpdate: QuoteUpdateWarning | null;
+  balance: { messages: string[] } | null;
+};

package/src/utils/numbers.ts

@@ -16,7 +16,7 @@ export const secondsToString = (s: number): string => {
 };
 
 export const numberToString = (
-  number: BigNumber | string | null | undefined,
+  number: BigNumber | string | number | null | undefined,
   minDecimals: number | null = null,
   maxDecimals: number | null = null
 ): string => {

package/src/utils/quote.ts

@@ -0,0 +1,338 @@
+/* eslint-disable @typescript-eslint/no-magic-numbers */
+import type { QuoteError, QuoteWarning, Wallet } from '../types';
+import type { PendingSwap } from '@rango-dev/queue-manager-rango-preset';
+import type { PriceImpactWarningLevel } from '@rango-dev/ui';
+import type {
+  SimulationAssetAndAmount,
+  SimulationValidationStatus,
+} from '@rango-dev/ui/dist/widget/ui/src/types/swaps';
+import type {
+  Asset,
+  BestRouteResponse,
+  BlockchainMeta,
+  Token,
+} from 'rango-sdk';
+
+import { getLastSuccessfulStep } from '@rango-dev/queue-manager-rango-preset';
+import BigNumber from 'bignumber.js';
+
+import { HIGHT_PRICE_IMPACT, LOW_PRICE_IMPACT } from '../constants/routing';
+import { HIGH_SLIPPAGE } from '../constants/swapSettings';
+import { getUsdValue } from '../store/quote';
+import { QuoteErrorType, QuoteWarningType } from '../types';
+
+import { areEqual } from './common';
+import { findBlockchain, findToken } from './meta';
+import {
+  checkSlippageErrors,
+  checkSlippageWarnings,
+  getLimitErrorMessage,
+  getMinRequiredSlippage,
+  getPercentageChange,
+  getTotalFeeInUsd,
+  hasHighValueLoss,
+  hasLimitError,
+  hasProperSlippage,
+} from './swap';
+
+export function searchParamsToToken(
+  tokens: Token[],
+  searchParams: string | null,
+  chain: BlockchainMeta | null
+): Token | null {
+  if (!chain) {
+    return null;
+  }
+  return (
+    tokens.find((token) => {
+      const symbolAndAddress = searchParams?.split('--');
+      if (symbolAndAddress?.length === 1) {
+        return (
+          token.symbol === symbolAndAddress[0] &&
+          token.address === null &&
+          token.blockchain === chain.name
+        );
+      }
+      return (
+        token.symbol === symbolAndAddress?.[0] &&
+        token.address === symbolAndAddress?.[1] &&
+        token.blockchain === chain.name
+      );
+    }) || null
+  );
+}
+
+export function getQuoteToTokenUsdPrice(
+  quote: BestRouteResponse | null
+): number | null | undefined {
+  return quote?.result?.swaps[quote?.result?.swaps.length - 1].to.usdPrice;
+}
+
+export function isNumberOfSwapsChanged(
+  quoteA: BestRouteResponse,
+  quoteB: BestRouteResponse
+) {
+  const quoteASwaps = quoteA.result?.swaps || [];
+  const quoteBSwaps = quoteB.result?.swaps || [];
+  return quoteASwaps.length !== quoteBSwaps.length;
+}
+
+export function isQuoteSwappersUpdated(
+  quoteA: BestRouteResponse,
+  quoteB: BestRouteResponse
+) {
+  const quoteASwappers =
+    quoteA.result?.swaps.map((swap) => swap.swapperId) || [];
+  const quoteBSwappers =
+    quoteB.result?.swaps.map((swap) => swap.swapperId) || [];
+  return !areEqual(quoteASwappers, quoteBSwappers);
+}
+
+export function isQuoteInternalCoinsUpdated(
+  quoteA: BestRouteResponse,
+  quoteB: BestRouteResponse
+) {
+  const quoteAInternalCoins =
+    quoteA.result?.swaps.map((swap) => swap.to.symbol) || [];
+  const quoteBInternalCoins =
+    quoteB.result?.swaps.map((swap) => swap.to.symbol) || [];
+  return !areEqual(quoteAInternalCoins, quoteBInternalCoins);
+}
+
+export function isQuoteChanged(
+  quoteA: BestRouteResponse,
+  quoteB: BestRouteResponse
+): boolean {
+  return (
+    isNumberOfSwapsChanged(quoteA, quoteB) ||
+    isQuoteSwappersUpdated(quoteA, quoteB) ||
+    isQuoteInternalCoinsUpdated(quoteA, quoteB)
+  );
+}
+
+export function outToRatioHasWarning(
+  fromUsdValue: BigNumber | null,
+  outToInRatio: BigNumber | 0
+) {
+  return (
+    (parseInt(outToInRatio?.toFixed(2) || '0') <= -10 &&
+      (fromUsdValue === null || fromUsdValue.gte(new BigNumber(200)))) ||
+    (parseInt(outToInRatio?.toFixed(2) || '0') <= -5 &&
+      (fromUsdValue === null || fromUsdValue.gte(new BigNumber(1000))))
+  );
+}
+
+export function getRequiredBalanceOfWallet(
+  selectedWallet: Wallet,
+  fee: SimulationValidationStatus[] | null
+): SimulationAssetAndAmount[] | null {
+  if (fee === null) {
+    return null;
+  }
+  const relatedFeeStatus = fee
+    ?.find((item) => item.blockchain === selectedWallet.chain)
+    ?.wallets.find(
+      (wallet) =>
+        wallet.address?.toLowerCase() === selectedWallet.address.toLowerCase()
+    );
+  if (!relatedFeeStatus) {
+    return null;
+  }
+  return relatedFeeStatus.requiredAssets;
+}
+
+export function getPriceImpactLevel(
+  priceImpact: number
+): PriceImpactWarningLevel {
+  let warningLevel: PriceImpactWarningLevel = undefined;
+  if (priceImpact <= LOW_PRICE_IMPACT && priceImpact > HIGHT_PRICE_IMPACT) {
+    warningLevel = 'low';
+  } else if (priceImpact <= HIGHT_PRICE_IMPACT) {
+    warningLevel = 'high';
+  }
+
+  return warningLevel;
+}
+
+export function findCommonTokens<T extends Asset[], R extends Asset[]>(
+  listA: T,
+  listB: R
+) {
+  const tokenToString = (token: Asset): string =>
+    `${token.symbol}-${token.blockchain}-${token.address ?? ''}`;
+
+  const set = new Set();
+
+  listA.forEach((token) => set.add(tokenToString(token)));
+
+  return listB.filter((token) => set.has(tokenToString(token))) as R;
+}
+
+export function createRetryQuote(
+  pendingSwap: PendingSwap,
+  blockchains: BlockchainMeta[],
+  tokens: Token[]
+): {
+  fromBlockchain: BlockchainMeta | null;
+  fromToken: Token | null;
+  toBlockchain: BlockchainMeta | null;
+  toToken: Token | null;
+  inputAmount: string;
+} {
+  const firstStep = pendingSwap.steps[0];
+  const lastStep = pendingSwap.steps[pendingSwap.steps.length - 1];
+  const lastSuccessfulStep = getLastSuccessfulStep(pendingSwap.steps);
+
+  const toToken = {
+    blockchain: lastStep.toBlockchain,
+    symbol: lastStep.toSymbol,
+    address: lastStep.toSymbolAddress,
+  };
+
+  const fromBlockchainMeta = findBlockchain(
+    lastSuccessfulStep
+      ? lastSuccessfulStep.toBlockchain
+      : firstStep.fromBlockchain,
+    blockchains
+  );
+  const toBlockchainMeta = findBlockchain(lastStep.toBlockchain, blockchains);
+  const fromTokenMeta = findToken(
+    lastSuccessfulStep
+      ? {
+          blockchain: fromBlockchainMeta?.name ?? '',
+          symbol: lastSuccessfulStep.toSymbol,
+          address: lastSuccessfulStep.toSymbolAddress,
+        }
+      : {
+          blockchain: fromBlockchainMeta?.name ?? '',
+          symbol: firstStep.fromSymbol,
+          address: firstStep.fromSymbolAddress,
+        },
+    tokens
+  );
+  const toTokenMeta = findToken(toToken, tokens);
+  const inputAmount = lastSuccessfulStep
+    ? lastSuccessfulStep.outputAmount ?? ''
+    : pendingSwap.inputAmount;
+
+  return {
+    fromBlockchain: fromBlockchainMeta,
+    fromToken: fromTokenMeta,
+    toBlockchain: toBlockchainMeta,
+    toToken: toTokenMeta,
+    inputAmount,
+  };
+}
+
+export function generateQuoteWarnings(
+  quote: BestRouteResponse,
+  params: {
+    fromToken: Token;
+    toToken: Token;
+    tokens: Token[];
+    userSlippage: number;
+  }
+): QuoteWarning | null {
+  const { fromToken, toToken, tokens, userSlippage } = params;
+  const inputUsdValue = getUsdValue(fromToken, quote.requestAmount);
+  const outputUsdValue = getUsdValue(toToken, quote.result?.outputAmount ?? '');
+
+  if (quote.result && inputUsdValue && outputUsdValue) {
+    const priceImpact = getPercentageChange(
+      inputUsdValue.toString(),
+      outputUsdValue.toString()
+    );
+    const highValueLoss = hasHighValueLoss(inputUsdValue, priceImpact);
+
+    if (highValueLoss) {
+      const totalFee = getTotalFeeInUsd(quote.result.swaps, tokens);
+      const warningLevel = getPriceImpactLevel(priceImpact);
+      return {
+        type: QuoteWarningType.HIGH_VALUE_LOSS,
+        inputUsdValue,
+        outputUsdValue,
+        priceImpact,
+        totalFee,
+        warningLevel,
+      };
+    }
+  } else if (quote.result && (!inputUsdValue || !outputUsdValue)) {
+    return { type: QuoteWarningType.UNKNOWN_PRICE };
+  }
+
+  const minRequiredSlippage = getMinRequiredSlippage(quote);
+  const highSlippage = userSlippage > HIGH_SLIPPAGE;
+
+  if (!hasProperSlippage(params.userSlippage.toString(), minRequiredSlippage)) {
+    return {
+      type: QuoteWarningType.INSUFFICIENT_SLIPPAGE,
+      recommendedSlippages: checkSlippageWarnings(quote, userSlippage),
+      minRequiredSlippage: minRequiredSlippage,
+    };
+  } else if (
+    highSlippage &&
+    parseFloat(minRequiredSlippage ?? '0') < userSlippage
+  ) {
+    return {
+      type: QuoteWarningType.HIGH_SLIPPAGE,
+      slippage: userSlippage.toString(),
+    };
+  }
+
+  return null;
+}
+
+export function generateQuoteErrors(
+  quote: BestRouteResponse
+): QuoteError | null {
+  if (!quote.result) {
+    return {
+      type: QuoteErrorType.NO_RESULT,
+      diagnosisMessage: quote.diagnosisMessages?.[0],
+    };
+  }
+  const limitError = hasLimitError(quote);
+  if (limitError) {
+    const { swap, recommendation, fromAmountRangeError } =
+      getLimitErrorMessage(quote);
+    return {
+      type: QuoteErrorType.BRIDGE_LIMIT,
+      swap: swap,
+      recommendation,
+      fromAmountRangeError,
+    };
+  }
+
+  const recommendedSlippages = checkSlippageErrors(quote);
+
+  if (recommendedSlippages) {
+    const minRequiredSlippage = getMinRequiredSlippage(quote);
+    return {
+      type: QuoteErrorType.INSUFFICIENT_SLIPPAGE,
+      recommendedSlippages,
+      minRequiredSlippage,
+    };
+  }
+
+  return null;
+}
+
+export function getPriceImpact(
+  inputUsdValue: BigNumber | string | null,
+  outputUsdValue: BigNumber | string | null
+) {
+  const outputUsdValueIsInvalid =
+    typeof outputUsdValue === 'string'
+      ? parseFloat(outputUsdValue) <= 0
+      : !outputUsdValue?.gt(0);
+
+  const priceImpact =
+    !inputUsdValue || !outputUsdValue || outputUsdValueIsInvalid
+      ? null
+      : getPercentageChange(
+          inputUsdValue.toString(),
+          outputUsdValue.toString()
+        );
+
+  return priceImpact;
+}

package/src/utils/settings.ts

@@ -1,4 +1,5 @@
-import { useMetaStore } from '../store/meta';
+import type { SwapperMeta } from 'rango-sdk';
+
 import { useSettingsStore } from '../store/settings';
 
 import { removeDuplicateFrom } from './common';
@@ -14,11 +15,11 @@ export type UniqueSwappersGroupType = {
 };
 
 export function getUniqueSwappersGroups(
-  supportedSwappers?: string[]
+  swappers: SwapperMeta[]
 ): UniqueSwappersGroupType[] {
-  const swappers = useMetaStore.use.meta().swappers;
   const disabledLiquiditySources =
     useSettingsStore.use.disabledLiquiditySources();
+  const supportedSwappers = swappers.map((swapper) => swapper.swapperGroup);
 
   const uniqueSupportedSwappersGroups: Array<UniqueSwappersGroupType> = [];
 
@@ -57,14 +58,14 @@ export function getUniqueSwappersGroups(
 }
 
 export function sortLiquiditySourcesByGroupTitle(
-  a: UniqueSwappersGroupType,
-  b: UniqueSwappersGroupType
+  a: SwapperMeta,
+  b: SwapperMeta
 ) {
-  if (a.groupTitle < b.groupTitle) {
+  if (a.swapperGroup < b.swapperGroup) {
     return -1;
   }
 
-  if (a.groupTitle > b.groupTitle) {
+  if (a.swapperGroup > b.swapperGroup) {
     return 1;
   }