@rango-dev/widget-embedded 0.36.1-next.12 → 0.36.1-next.13

package/src/utils/quote.ts

@@ -15,7 +15,6 @@ import type {
   MultiRouteSimulationResult,
   PreferenceType,
   RouteTag,
-  Token,
 } from 'rango-sdk';
 import type { PendingSwap } from 'rango-types';
 
@@ -29,30 +28,19 @@ import { QuoteWarningType } from '../types';
 
 import { areEqual } from './common';
 import { createTokenHash, findBlockchain } from './meta';
+import { numberToString } from './numbers';
 import {
-  calcOutputUsdValue,
   checkSlippageWarnings,
   getMinRequiredSlippage,
   getPercentageChange,
   getTotalFeeInUsd,
+  getUsdInputFrom,
+  getUsdOutputFrom,
   hasHighValueLoss,
   hasProperSlippage,
+  isOutputAmountChangedExcessively,
 } from './swap';
 
-export function getQuoteToTokenUsdPrice(
-  quote: SelectedQuote | null
-): number | null | undefined {
-  const swaps = quote?.swaps || [];
-  return swaps[swaps.length - 1].to.usdPrice;
-}
-
-export function getQuoteFromTokenUsdPrice(
-  quote: SelectedQuote | null
-): number | null | undefined {
-  const swaps = quote?.swaps || [];
-  return swaps[0].from.usdPrice;
-}
-
 export function isNumberOfSwapsChanged(
   quoteA: SelectedQuote,
   quoteB: SelectedQuote
@@ -195,56 +183,73 @@ export function createRetryQuote(
   };
 }
 
-export function generateQuoteWarnings(
-  quote: SelectedQuote,
-  params: {
-    fromToken: Token;
-    toToken: Token;
-    findToken: FindToken;
-    userSlippage: number;
-  }
-): QuoteWarning | null {
-  const { fromToken, toToken, findToken, userSlippage } = params;
-  const inputUsdValue = calcOutputUsdValue(
-    quote.requestAmount,
-    getQuoteFromTokenUsdPrice(quote) || fromToken?.usdPrice
-  );
-  const outputUsdValue = calcOutputUsdValue(
-    quote.outputAmount,
-    getQuoteToTokenUsdPrice(quote) || toToken?.usdPrice
-  );
-
-  if (!!quote && inputUsdValue && outputUsdValue) {
+export function generateQuoteWarnings(params: {
+  previousQuote?: SelectedQuote;
+  currentQuote: SelectedQuote;
+  findToken: FindToken;
+  userSlippage: number;
+}): QuoteWarning | null {
+  const { previousQuote, currentQuote, findToken, userSlippage } = params;
+  const usdInput = getUsdInputFrom(currentQuote);
+  const usdOutput = getUsdOutputFrom(currentQuote);
+
+  if (!!currentQuote && usdInput && usdOutput) {
     const priceImpact = getPriceImpact(
-      inputUsdValue.toString(),
-      outputUsdValue.toString()
+      usdInput.toString(),
+      usdOutput.toString()
     );
     const highValueLoss =
-      !!priceImpact && hasHighValueLoss(inputUsdValue, priceImpact);
+      !!priceImpact && hasHighValueLoss(usdInput, priceImpact);
 
     if (highValueLoss) {
-      const totalFee = getTotalFeeInUsd(quote?.swaps, findToken);
+      const totalFee = getTotalFeeInUsd(currentQuote?.swaps, findToken);
       const warningLevel = getPriceImpactLevel(priceImpact);
       return {
         type: QuoteWarningType.HIGH_VALUE_LOSS,
-        inputUsdValue,
-        outputUsdValue,
+        inputUsdValue: usdInput,
+        outputUsdValue: usdOutput,
         priceImpact,
         totalFee,
         warningLevel,
       };
     }
-  } else if (quote && (!inputUsdValue || !outputUsdValue)) {
+  }
+
+  if (
+    previousQuote &&
+    isOutputAmountChangedExcessively(previousQuote, currentQuote)
+  ) {
+    return {
+      type: QuoteWarningType.EXCESSIVE_OUTPUT_AMOUNT_CHANGE,
+      usdValueChange: numberToString(
+        getUsdOutputFrom(currentQuote)
+          ?.minus(getUsdOutputFrom(previousQuote) ?? 0)
+          .toString() ?? '0',
+        null,
+        2
+      ),
+      percentageChange: numberToString(
+        getPriceImpact(
+          getUsdOutputFrom(previousQuote) ?? '1',
+          getUsdOutputFrom(currentQuote) ?? '1'
+        ),
+        null,
+        2
+      ),
+    };
+  }
+
+  if (currentQuote && (!usdInput || !usdOutput)) {
     return { type: QuoteWarningType.UNKNOWN_PRICE };
   }
 
-  const minRequiredSlippage = getMinRequiredSlippage(quote.swaps);
+  const minRequiredSlippage = getMinRequiredSlippage(currentQuote.swaps);
   const highSlippage = userSlippage > HIGH_SLIPPAGE;
 
   if (!hasProperSlippage(params.userSlippage.toString(), minRequiredSlippage)) {
     return {
       type: QuoteWarningType.INSUFFICIENT_SLIPPAGE,
-      recommendedSlippages: checkSlippageWarnings(quote, userSlippage),
+      recommendedSlippages: checkSlippageWarnings(currentQuote, userSlippage),
       minRequiredSlippage: minRequiredSlippage,
     };
   } else if (
@@ -260,6 +265,13 @@ export function generateQuoteWarnings(
   return null;
 }
 
+export function isQuoteWarningConfirmationRequired(warning: QuoteWarning) {
+  const WARNINGS_NOT_REQUIRING_CONFIRMATION = [
+    QuoteWarningType.EXCESSIVE_OUTPUT_AMOUNT_CHANGE,
+  ];
+  return !WARNINGS_NOT_REQUIRING_CONFIRMATION.includes(warning.type);
+}
+
 export function getPriceImpact(
   inputUsdValue: BigNumber | string | null,
   outputUsdValue: BigNumber | string | null

package/src/utils/swap.ts

@@ -1,5 +1,3 @@
-/* eslint-disable @typescript-eslint/no-magic-numbers */
-import type { FeesGroup, NameOfFees } from '../constants/quote';
 import type { FetchStatus, FindToken } from '../store/slices/data';
 import type { ConnectedWallet } from '../store/slices/wallets';
 import type {
@@ -34,6 +32,14 @@ import { PendingSwapNetworkStatus } from 'rango-types';
 import { errorMessages } from '../constants/errors';
 import { swapButtonTitles } from '../constants/messages';
 import { ZERO } from '../constants/numbers';
+import {
+  type FeesGroup,
+  HIGH_FEE_THRESHOLD_USD,
+  HIGH_VALUE_LOSS_CRITERIA,
+  type NameOfFees,
+  OUTPUT_CHANGE_WARNING_CRITERIA,
+  PERCENT_MULTIPLIER,
+} from '../constants/quote';
 import {
   BALANCE_MAX_DECIMALS,
   BALANCE_MIN_DECIMALS,
@@ -43,7 +49,7 @@ import {
 
 import { getBlockchainShortNameFor, isValidTokenAddress } from './meta';
 import { numberToString } from './numbers';
-import { getPriceImpact, getRequiredBalanceOfWallet } from './quote';
+import { getRequiredBalanceOfWallet } from './quote';
 import { getQuoteWallets } from './wallets';
 
 export function getOutputRatio(
@@ -61,7 +67,7 @@ export function getOutputRatio(
   return outputUsdValue
     .div(inputUsdValue)
     .minus(1)
-    .multipliedBy(100)
+    .multipliedBy(PERCENT_MULTIPLIER)
     .toNumber();
 }
 
@@ -69,12 +75,16 @@ export function hasHighValueLoss(
   inputUsdValue: BigNumber | null,
   priceImpact: number
 ): boolean {
-  return (
-    ((parseInt(priceImpact.toFixed(2) || '0') <= -10 &&
-      inputUsdValue?.gte(new BigNumber(400))) ||
-      (parseInt(priceImpact.toFixed(2) || '0') <= -5 &&
-        inputUsdValue?.gte(new BigNumber(1000)))) ??
-    false
+  if (!inputUsdValue) {
+    return false;
+  }
+
+  const formattedPriceImpact = parseInt(priceImpact.toFixed(2) || '0');
+
+  return HIGH_VALUE_LOSS_CRITERIA.some(
+    ({ threshold, minInput }) =>
+      formattedPriceImpact <= threshold &&
+      inputUsdValue.gte(new BigNumber(minInput))
   );
 }
 
@@ -328,7 +338,7 @@ export function hasHighFee(totalFeeInUsd: BigNumber | null) {
   if (!totalFeeInUsd) {
     return false;
   }
-  return !totalFeeInUsd.lt(new BigNumber(30));
+  return !totalFeeInUsd.lt(new BigNumber(HIGH_FEE_THRESHOLD_USD));
 }
 
 export function hasSlippageError(
@@ -480,8 +490,7 @@ export function createQuoteRequestBody(params: {
       addresses: [wallet.address],
     });
   });
-  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-  // @ts-ignore
+
   const requestBody: BestRouteRequest = {
     amount: inputAmount.toString(),
     affiliateRef: affiliateRef ?? undefined,
@@ -535,33 +544,52 @@ export function getWalletsForNewSwap(selectedWallets: Wallet[]) {
   return wallets;
 }
 
-export function getQuoteOutputAmount(quote: SelectedQuote) {
-  return quote?.outputAmount || null;
+export function getUsdInputFrom(quote: SelectedQuote): BigNumber | undefined {
+  const inputAmount = quote.requestAmount;
+  const inputTokenUsdPrice = quote.swaps[0].from.usdPrice;
+  if (!inputAmount || !inputTokenUsdPrice) {
+    return;
+  }
+  return new BigNumber(inputAmount).multipliedBy(inputTokenUsdPrice);
+}
+
+export function getUsdOutputFrom(quote: SelectedQuote): BigNumber | undefined {
+  const outputAmount = quote?.outputAmount || null;
+  const outputTokenUsdPrice = quote.swaps[quote.swaps.length - 1].to.usdPrice;
+  if (!outputAmount || !outputTokenUsdPrice) {
+    return;
+  }
+  return new BigNumber(outputAmount).multipliedBy(outputTokenUsdPrice);
 }
 
 export function getPercentageChange(input: string, output: string) {
   return new BigNumber(output)
     .div(new BigNumber(input))
     .minus(1)
-    .multipliedBy(100)
+    .multipliedBy(PERCENT_MULTIPLIER)
     .toNumber();
 }
 
-export function isOutputAmountChangedALot(
-  oldQuote: SelectedQuote,
-  newQuote: SelectedQuote
+export function isOutputAmountChangedExcessively(
+  previousQuote: SelectedQuote,
+  currentQuote: SelectedQuote
 ) {
-  const oldOutputAmount = getQuoteOutputAmount(oldQuote);
-  const newOutputAmount = getQuoteOutputAmount(newQuote);
-  if (!oldOutputAmount || !newOutputAmount) {
+  const usdInput = getUsdInputFrom(previousQuote);
+  const previousUsdOutput = getUsdOutputFrom(previousQuote);
+  const currentUsdOutput = getUsdOutputFrom(currentQuote);
+  if (!usdInput || !previousUsdOutput || !currentUsdOutput) {
     return false;
   }
-  const percentageChange = getPriceImpact(oldOutputAmount, newOutputAmount);
-  if (!percentageChange) {
-    return true;
-  }
 
-  return percentageChange <= -1;
+  const percentageChange = getPercentageChange(
+    previousUsdOutput.toString(),
+    currentUsdOutput.toString()
+  );
+
+  return OUTPUT_CHANGE_WARNING_CRITERIA.some(
+    ({ threshold, minInput }) =>
+      percentageChange <= threshold && usdInput.isGreaterThanOrEqualTo(minInput)
+  );
 }
 
 export function generateBalanceWarnings(
@@ -623,15 +651,6 @@ export function generateBalanceWarnings(
     });
 }
 
-export function calcOutputUsdValue(
-  outputAmount?: string,
-  tokenPrice?: number | null
-) {
-  const amount = !!outputAmount ? new BigNumber(outputAmount) : ZERO;
-
-  return amount.multipliedBy(tokenPrice || 0);
-}
-
 export function isNetworkStatusInWarningState(
   pendingSwapStep: PendingSwapStep | null
 ): boolean {

package/dist/constants/warnings.d.ts

@@ -1,3 +0,0 @@
-import type { QuoteUpdateWarning } from '../types';
-export declare function getQuoteUpdateWarningMessage(warning: QuoteUpdateWarning): string;
-//# sourceMappingURL=warnings.d.ts.map

package/dist/constants/warnings.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"warnings.d.ts","sourceRoot":"","sources":["../../src/constants/warnings.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAMnD,wBAAgB,4BAA4B,CAAC,OAAO,EAAE,kBAAkB,UAmBvE"}

package/src/constants/warnings.ts

@@ -1,26 +0,0 @@
-import type { QuoteUpdateWarning } from '../types';
-
-import { i18n } from '@lingui/core';
-
-import { QuoteUpdateType } from '../types';
-
-export function getQuoteUpdateWarningMessage(warning: QuoteUpdateWarning) {
-  switch (warning.type) {
-    case QuoteUpdateType.QUOTE_UPDATED:
-      return i18n.t('Route has been updated.');
-    case QuoteUpdateType.QUOTE_AND_OUTPUT_AMOUNT_UPDATED:
-      return i18n.t(
-        'Output amount changed to {newOutputAmount} ({percentageChange}% change).',
-        {
-          newOutputAmount: warning.newOutputAmount,
-          percentageChange: warning.percentageChange,
-        }
-      );
-    case QuoteUpdateType.QUOTE_SWAPPERS_UPDATED:
-      return i18n.t('Route swappers has been updated.');
-    case QuoteUpdateType.QUOTE_COINS_UPDATED:
-      return i18n.t('Route internal coins has been updated.');
-    default:
-      return '';
-  }
-}