@rango-dev/widget-embedded 0.20.1-next.16 → 0.20.1-next.18

package/src/components/Quote/Quote.tsx

@@ -5,12 +5,8 @@ import type { SwapResult } from 'rango-sdk';
 import { i18n } from '@lingui/core';
 import {
   Alert,
-  ChevronDownIcon,
-  ChevronRightIcon,
   Divider,
-  Image,
   InfoIcon,
-  QuoteCost,
   StepDetails,
   TokenAmount,
   Tooltip,
@@ -20,8 +16,6 @@ import BigNumber from 'bignumber.js';
 import React, { useLayoutEffect, useRef, useState } from 'react';
 
 import {
-  GAS_FEE_MAX_DECIMALS,
-  GAS_FEE_MIN_DECIMALS,
   PERCENTAGE_CHANGE_MAX_DECIMALS,
   PERCENTAGE_CHANGE_MIN_DECIMALS,
   TOKEN_AMOUNT_MAX_DECIMALS,
@@ -40,32 +34,25 @@ import {
   getBlockchainShortNameFor,
   getSwapperDisplayName,
 } from '../../utils/meta';
-import {
-  formatTooltipNumbers,
-  numberToString,
-  secondsToString,
-  totalArrivalTime,
-} from '../../utils/numbers';
+import { formatTooltipNumbers, numberToString } from '../../utils/numbers';
 import { getPriceImpact, getPriceImpactLevel } from '../../utils/quote';
-import { getTotalFeeInUsd } from '../../utils/swap';
 
 import {
   BasicInfoOutput,
   basicInfoStyles,
-  ChainImageContainer,
-  Chains,
   ContainerInfoOutput,
   Content,
   EXPANDABLE_QUOTE_TRANSITION_DURATION,
   FrameIcon,
   HorizontalSeparator,
-  IconContainer,
   QuoteContainer,
   stepsDetailsStyles,
   SummaryContainer,
   summaryStyles,
 } from './Quote.styles';
+import { QuoteCostDetails } from './QuoteCostDetails';
 import { QuoteSummary } from './QuoteSummary';
+import { QuoteTrigger } from './QuoteTrigger ';
 
 export function Quote(props: QuoteProps) {
   const {
@@ -77,19 +64,12 @@ export function Quote(props: QuoteProps) {
     type,
     recommended = true,
   } = props;
-  const tokens = useAppStore().tokens();
   const blockchains = useAppStore().blockchains();
   const swappers = useAppStore().swappers();
 
   const [expanded, setExpanded] = useState(props.expanded);
   const quoteRef = useRef<HTMLButtonElement | null>(null);
   const prevExpanded = useRef(expanded);
-  const totalFee = numberToString(
-    getTotalFeeInUsd(quote.result?.swaps ?? [], tokens),
-    GAS_FEE_MIN_DECIMALS,
-    GAS_FEE_MAX_DECIMALS
-  );
-  const totalTime = secondsToString(totalArrivalTime(quote.result?.swaps));
   const roundedInput = numberToString(
     input.value,
     TOKEN_AMOUNT_MIN_DECIMALS,
@@ -283,7 +263,6 @@ export function Quote(props: QuoteProps) {
   const steps = getQuoteSteps(quote.result?.swaps ?? []);
   const numberOfSteps = steps.length;
   const tooltipContainer = getContainer();
-
   useLayoutEffect(() => {
     if (expanded && !prevExpanded.current && quoteRef.current) {
       setTimeout(() => {
@@ -300,7 +279,7 @@ export function Quote(props: QuoteProps) {
         listItem={type === 'list-item'}
         basic={type === 'basic'}>
         <div className={summaryStyles()}>
-          <QuoteCost fee={totalFee} time={totalTime} steps={numberOfSteps} />
+          <QuoteCostDetails steps={numberOfSteps} quote={quote} />
           {type === 'basic' && (
             <div className={basicInfoStyles()}>
               <FrameIcon>
@@ -374,59 +353,13 @@ export function Quote(props: QuoteProps) {
           recommended={recommended}
           open={expanded}
           onOpenChange={setExpanded}>
-          <Chains
-            ref={(ref) => (quoteRef.current = ref)}
+          <QuoteTrigger
+            quoteRef={quoteRef}
             recommended={recommended}
-            onClick={() => setExpanded((prevState) => !prevState)}>
-            <div>
-              {steps.map((step, index) => {
-                const key = `item-${index}`;
-                const arrow = (
-                  <IconContainer>
-                    <ChevronRightIcon
-                      size={12}
-                      color="black"
-                      {...(step.state && {
-                        color: step.state === 'error' ? 'error' : 'warning',
-                      })}
-                    />
-                  </IconContainer>
-                );
-                return (
-                  <React.Fragment key={key}>
-                    <Tooltip
-                      container={tooltipContainer}
-                      side="bottom"
-                      sideOffset={4}
-                      content={step.from.chain.displayName}>
-                      <ChainImageContainer
-                        state={step.state || steps[index - 1]?.state}>
-                        <Image src={step.from.chain.image} size={16} />
-                      </ChainImageContainer>
-                    </Tooltip>
-                    {index === numberOfSteps - 1 && (
-                      <>
-                        {arrow}
-                        <Tooltip
-                          container={tooltipContainer}
-                          side="bottom"
-                          sideOffset={4}
-                          content={step.to.chain.displayName}>
-                          <ChainImageContainer state={step.state}>
-                            <Image src={step.to.chain.image} size={16} />
-                          </ChainImageContainer>
-                        </Tooltip>
-                      </>
-                    )}
-                    {index !== numberOfSteps - 1 && <>{arrow}</>}
-                  </React.Fragment>
-                );
-              })}
-            </div>
-            <IconContainer orientation={expanded ? 'up' : 'down'}>
-              <ChevronDownIcon size={12} color="black" />
-            </IconContainer>
-          </Chains>
+            setExpanded={setExpanded}
+            expanded={expanded}
+            steps={steps}
+          />
           <Content open={expanded}>
             <HorizontalSeparator />
             <div className={stepsDetailsStyles()}>

package/src/components/Quote/Quote.types.ts

@@ -1,4 +1,5 @@
 import type { QuoteError, QuoteWarning } from '../../types';
+import type { Step } from '@rango-dev/ui';
 import type { BestRouteResponse } from 'rango-sdk';
 import type { ReactNode } from 'react';
 
@@ -13,3 +14,24 @@ export type QuoteProps = {
   output: { value: string; usdValue?: string };
   expanded?: boolean;
 };
+
+export type QuoteTriggerProps = {
+  quoteRef: React.MutableRefObject<HTMLButtonElement | null>;
+  recommended: boolean;
+  setExpanded: React.Dispatch<React.SetStateAction<boolean | undefined>>;
+  steps: Step[];
+  expanded?: boolean;
+};
+
+export type QuoteTriggerImagesProps = {
+  content: ReactNode;
+  state?: 'error' | 'warning' | undefined;
+  src: string;
+  open?: boolean;
+  className?: string;
+};
+
+export type QuoteCostDetailsProps = {
+  quote: BestRouteResponse;
+  steps: number;
+};

package/src/components/Quote/QuoteCostDetails.styles.ts

@@ -0,0 +1,50 @@
+import { css, styled } from '@rango-dev/ui';
+
+export const FeeSection = styled('div', {
+  display: 'flex',
+  justifyContent: 'space-between',
+  alignItems: 'center',
+  padding: '$5 0',
+  '&.total_payable_fee': {
+    padding: '$12 0',
+  },
+});
+
+export const Line = styled('div', {
+  width: '100%',
+  borderTop: '1px solid $neutral300',
+  margin: '$10 0',
+});
+
+export const ModalContainer = styled('div', {
+  padding: '$20 0',
+  display: 'flex',
+  flexDirection: 'column',
+  '& .collapsible_trigger': {
+    display: 'flex',
+    alignItems: 'center',
+  },
+});
+
+export const ModalHeader = styled('div', {
+  padding: '$20 $20 $10',
+  textAlign: 'center',
+  position: 'relative',
+  '._icon-button': {
+    position: 'absolute',
+    zIndex: 10,
+    top: '$16',
+    right: '$16',
+  },
+});
+export const trigger = css({
+  display: 'flex',
+  flexDirection: 'row',
+  alignItems: 'center',
+  padding: '$5',
+  '&:hover': {
+    '& ._typography, & svg': {
+      color: '$secondary',
+    },
+  },
+});

package/src/components/Quote/QuoteCostDetails.tsx

@@ -0,0 +1,218 @@
+import type { QuoteCostDetailsProps } from './Quote.types';
+import type { NameOfFees } from '../../constants/quote';
+
+import { i18n } from '@lingui/core';
+import {
+  ChevronDownIcon,
+  CloseIcon,
+  Divider,
+  IconButton,
+  Modal,
+  QuoteCost,
+  Tooltip,
+  Typography,
+} from '@rango-dev/ui';
+import BigNumber from 'bignumber.js';
+import React, { useState } from 'react';
+
+import { NAME_OF_FEES } from '../../constants/quote';
+import {
+  GAS_FEE_MAX_DECIMALS,
+  GAS_FEE_MIN_DECIMALS,
+  USD_VALUE_MAX_DECIMALS,
+  USD_VALUE_MIN_DECIMALS,
+} from '../../constants/routing';
+import { useAppStore } from '../../store/AppStore';
+import { getContainer } from '../../utils/common';
+import {
+  formatTooltipNumbers,
+  numberToString,
+  secondsToString,
+  totalArrivalTime,
+} from '../../utils/numbers';
+import {
+  getFeesGroup,
+  getTotalFeeInUsd,
+  getTotalFeesInUsd,
+  getUsdFee,
+} from '../../utils/swap';
+import { CustomCollapsible } from '../CustomCollapsible/CustomCollapsible';
+import { ExpandedIcon } from '../CustomCollapsible/CustomCollapsible.styles';
+
+import {
+  FeeSection,
+  Line,
+  ModalContainer,
+  ModalHeader,
+  trigger,
+} from './QuoteCostDetails.styles';
+
+const GAS_FEE_MAX = 30;
+
+const NonPayableFee = (props: { fee: BigNumber; label: string }) => {
+  return !props.fee.isZero() ? (
+    <FeeSection>
+      <Typography variant="label" size="medium" color="neutral600">
+        {props.label}
+      </Typography>
+      <Typography variant="label" size="medium">
+        $
+        {numberToString(
+          props.fee,
+          USD_VALUE_MIN_DECIMALS,
+          USD_VALUE_MAX_DECIMALS
+        )}
+      </Typography>
+    </FeeSection>
+  ) : null;
+};
+
+export function QuoteCostDetails(props: QuoteCostDetailsProps) {
+  const [open, setOpen] = useState<boolean>(false);
+  const [openCollapse, setOpenCollapse] = useState<boolean>(false);
+  const { steps, quote } = props;
+  const tokens = useAppStore().tokens();
+  const totalTime = secondsToString(totalArrivalTime(quote.result?.swaps));
+  const swaps = quote.result?.swaps ?? [];
+  const container = getContainer();
+
+  const totalFee = getTotalFeeInUsd(swaps, tokens);
+
+  const feesGroup = getFeesGroup(swaps);
+
+  return (
+    <>
+      <QuoteCost
+        onClickFee={() => setOpen(!open)}
+        fee={numberToString(
+          totalFee,
+          GAS_FEE_MIN_DECIMALS,
+          GAS_FEE_MAX_DECIMALS
+        )}
+        feeWarning={totalFee.gte(new BigNumber(GAS_FEE_MAX))}
+        time={totalTime}
+        steps={steps}
+        tooltipGas={i18n.t('View more info')}
+        tooltipContainer={container}
+      />
+
+      <Modal
+        container={container}
+        open={open}
+        header={
+          <ModalHeader>
+            <Typography variant="title" size="medium">
+              {i18n.t('Gas & Fee Explanation')}
+            </Typography>
+
+            <IconButton onClick={() => setOpen(false)} variant="ghost">
+              <CloseIcon color="gray" size={14} />
+            </IconButton>
+          </ModalHeader>
+        }
+        onClose={() => setOpen(false)}>
+        <ModalContainer>
+          <Typography variant="title" size="small">
+            {i18n.t('Details')}
+          </Typography>
+          <Divider size={10} />
+          {Object.entries(feesGroup.payable).flatMap(
+            ([payableFeesKey, feeArray]) =>
+              feeArray.map((fee, index) => {
+                const key = `payable-fee-${index}`;
+                const usdValue = getUsdFee(fee);
+                return (
+                  <FeeSection key={key}>
+                    <Typography
+                      variant="label"
+                      size="medium"
+                      color="neutral600">
+                      {NAME_OF_FEES[payableFeesKey as NameOfFees]}
+                    </Typography>
+                    <Tooltip
+                      content={formatTooltipNumbers(fee.amount)}
+                      container={container}>
+                      <Typography variant="label" size="medium">
+                        {numberToString(
+                          fee.amount,
+                          GAS_FEE_MIN_DECIMALS,
+                          GAS_FEE_MAX_DECIMALS
+                        )}{' '}
+                        {fee.asset.symbol} ($
+                        {numberToString(
+                          usdValue,
+                          USD_VALUE_MIN_DECIMALS,
+                          USD_VALUE_MAX_DECIMALS
+                        )}
+                        )
+                      </Typography>
+                    </Tooltip>
+                  </FeeSection>
+                );
+              })
+          )}
+
+          <FeeSection className="total_payable_fee">
+            <Typography variant="label" size="medium">
+              {i18n.t('Total Payable Fee')}
+            </Typography>
+            <Typography variant="label" size="medium">
+              $
+              {numberToString(
+                totalFee,
+                USD_VALUE_MIN_DECIMALS,
+                USD_VALUE_MAX_DECIMALS
+              )}
+            </Typography>
+          </FeeSection>
+          <Line />
+          {Object.keys(feesGroup.nonePayable).length && (
+            <CustomCollapsible
+              triggerAnchor="bottom"
+              onClickTrigger={() => setOpenCollapse((prev) => !prev)}
+              trigger={
+                <div className={trigger()}>
+                  <Typography size="small" variant="body" color="neutral700">
+                    {openCollapse
+                      ? i18n.t('Hide non-payable fees')
+                      : i18n.t('Show non-payable fees')}
+                  </Typography>
+                  <Divider size={4} direction="horizontal" />
+                  <ExpandedIcon orientation={openCollapse ? 'up' : 'down'}>
+                    <ChevronDownIcon size={12} color="gray" />
+                  </ExpandedIcon>
+                </div>
+              }
+              open={openCollapse}>
+              <Typography size="small" variant="title">
+                {i18n.t('Description')}
+              </Typography>
+              <Divider size={4} />
+              <Typography size="small" variant="body" color="neutral700">
+                {i18n.t(`The following fees are considered in the transaction output and
+                you won’t need to pay extra gas for them.`)}
+              </Typography>
+              <Divider size={10} />
+              {Object.entries(feesGroup.nonePayable).map(
+                ([nonPayableFeesKey, fees], index) => {
+                  const totalFeeInUsd = getTotalFeesInUsd(fees);
+                  const label = NAME_OF_FEES[nonPayableFeesKey as NameOfFees];
+                  const key = `non-payable-fee-${index}`;
+                  return (
+                    <NonPayableFee
+                      key={key}
+                      fee={totalFeeInUsd}
+                      label={label}
+                    />
+                  );
+                }
+              )}
+
+              <Line />
+            </CustomCollapsible>
+          )}
+        </ModalContainer>
+      </Modal>
+    </>
+  );
+}

package/src/components/Quote/QuoteTrigger .tsx

@@ -0,0 +1,215 @@
+import type { QuoteTriggerImagesProps, QuoteTriggerProps } from './Quote.types';
+
+import { i18n } from '@lingui/core';
+import {
+  ChevronDownIcon,
+  ChevronRightIcon,
+  Divider,
+  Image,
+  Tooltip,
+  Typography,
+} from '@rango-dev/ui';
+import React, { useEffect, useState } from 'react';
+
+import { getContainer } from '../../utils/common';
+import { getUniqueBlockchains } from '../../utils/quote';
+
+import {
+  IconContainer,
+  ImageContainer,
+  MoreStep,
+  rowStyles,
+  Trigger,
+} from './Quote.styles';
+
+const MAX_STEPS = 4;
+const MAX_BLOCKCHAINS = 6;
+const MIN_WIDTH_WINDOW = 375;
+
+const ImageComponent = (props: QuoteTriggerImagesProps) => {
+  const tooltipContainer = getContainer();
+  const { content, src, className, open, state } = props;
+  return (
+    <Tooltip
+      container={tooltipContainer}
+      side="bottom"
+      sideOffset={4}
+      open={open}
+      content={content}>
+      <ImageContainer className={className} state={state}>
+        <Image src={src} size={16} />
+      </ImageContainer>
+    </Tooltip>
+  );
+};
+
+export function QuoteTrigger(props: QuoteTriggerProps) {
+  const { quoteRef, recommended, setExpanded, steps, expanded } = props;
+  const tooltipContainer = getContainer();
+  const numberOfSteps = steps.length;
+  const blockchains = getUniqueBlockchains(steps);
+  const [isMobile, setIsMobile] = useState(false);
+
+  //choose the screen size
+  const handleResize = () => {
+    if (window.innerWidth < MIN_WIDTH_WINDOW) {
+      setIsMobile(true);
+    } else {
+      setIsMobile(false);
+    }
+  };
+
+  useEffect(() => {
+    window.addEventListener('resize', handleResize);
+  });
+
+  return (
+    <Trigger
+      ref={(ref) => (quoteRef.current = ref)}
+      recommended={recommended}
+      onClick={() => setExpanded((prevState) => !prevState)}>
+      <div className={rowStyles()}>
+        <Typography variant="body" size="xsmall">
+          {i18n.t('Via:')}
+        </Typography>
+        <Divider direction="horizontal" size={4} />
+        {steps.map((step, index) => {
+          const key = `item-${index}`;
+          const arrow = (
+            <IconContainer>
+              <ChevronRightIcon size={12} color="black" />
+            </IconContainer>
+          );
+
+          return isMobile ? (
+            <>
+              <ImageComponent
+                content={step.swapper.displayName}
+                src={step.swapper.image}
+                state={step.state}
+              />
+              {index !== numberOfSteps - 1 && <>{arrow}</>}
+            </>
+          ) : (
+            <React.Fragment key={key}>
+              {numberOfSteps <= MAX_STEPS ||
+              (numberOfSteps > MAX_STEPS && index < MAX_STEPS - 1) ? (
+                <>
+                  <ImageComponent
+                    content={step.swapper.displayName}
+                    src={step.swapper.image}
+                    state={step.state}
+                  />
+                  {index !== numberOfSteps - 1 && <>{arrow}</>}
+                </>
+              ) : (
+                index === MAX_STEPS - 1 && (
+                  <Tooltip
+                    container={tooltipContainer}
+                    side="bottom"
+                    align="right"
+                    sideOffset={4}
+                    content={
+                      <div className={rowStyles()}>
+                        {arrow}
+                        {steps.map((step, i) => {
+                          const key = `image-${i}`;
+                          return (
+                            i >= index && (
+                              <React.Fragment key={key}>
+                                <ImageComponent
+                                  content={step.swapper.displayName}
+                                  src={step.swapper.image}
+                                  state={step.state}
+                                  open={false}
+                                />
+                                {i !== numberOfSteps - 1 && <>{arrow}</>}
+                              </React.Fragment>
+                            )
+                          );
+                        })}
+                      </div>
+                    }>
+                    <MoreStep
+                      state={
+                        steps.find(
+                          (step, i) =>
+                            i >= index &&
+                            (step.state === 'error' || step.state === 'warning')
+                        )?.state
+                      }>
+                      <Typography size="xsmall" variant="body">
+                        +{numberOfSteps - index}
+                      </Typography>
+                    </MoreStep>
+                  </Tooltip>
+                )
+              )}
+            </React.Fragment>
+          );
+        })}
+      </div>
+      <div className={rowStyles()}>
+        <div className="blockchains_section">
+          <div className={rowStyles()}>
+            <Typography variant="body" size="xsmall">
+              {i18n.t('Chains:')}
+            </Typography>
+            <Divider direction="horizontal" size={4} />
+            {blockchains.map((blockchain, index) => (
+              <>
+                {blockchains.length <= MAX_BLOCKCHAINS ||
+                (blockchains.length > MAX_BLOCKCHAINS &&
+                  index < MAX_BLOCKCHAINS - 1) ? (
+                  <ImageComponent
+                    key={blockchain.displayName}
+                    content={''}
+                    src={blockchain.image}
+                    open={false}
+                    className={index !== 0 ? 'blockchainImage' : ''}
+                  />
+                ) : (
+                  index === MAX_BLOCKCHAINS - 1 && (
+                    <Tooltip
+                      container={tooltipContainer}
+                      side="bottom"
+                      align="right"
+                      sideOffset={4}
+                      content={
+                        <div className={rowStyles()}>
+                          {blockchains.map(
+                            (chain, i) =>
+                              i >= index && (
+                                <ImageComponent
+                                  key={chain.displayName}
+                                  content={''}
+                                  src={chain.image}
+                                  open={false}
+                                  className={i > index ? 'blockchainImage' : ''}
+                                />
+                              )
+                          )}
+                        </div>
+                      }>
+                      <MoreStep className={'blockchainImage'}>
+                        <Typography size="xsmall" variant="body">
+                          +{blockchains.length - index}
+                        </Typography>
+                      </MoreStep>
+                    </Tooltip>
+                  )
+                )}
+              </>
+            ))}
+
+            <Divider direction="horizontal" size={32} />
+          </div>
+        </div>
+
+        <IconContainer orientation={expanded ? 'up' : 'down'}>
+          <ChevronDownIcon size={12} color="black" />
+        </IconContainer>
+      </div>
+    </Trigger>
+  );
+}

package/src/constants/quote.ts

@@ -0,0 +1,23 @@
+import type { SwapFee } from 'rango-sdk';
+
+import { i18n } from '@lingui/core';
+
+export type NameOfFees =
+  | 'Swapper Fee'
+  | 'Affiliate Fee'
+  | 'Outbound network fee'
+  | 'Rango Fee'
+  | 'Network Fee';
+
+export const NAME_OF_FEES: Record<NameOfFees, string> = {
+  'Network Fee': i18n.t('Network Fee'),
+  'Swapper Fee': i18n.t('Protocol Fee'),
+  'Affiliate Fee': i18n.t('Affiliate Fee'),
+  'Outbound network fee': i18n.t('Outbound Fee'),
+  'Rango Fee': i18n.t('Rango Fee'),
+};
+
+export type FeesGroup = {
+  payable: { [key in NameOfFees]?: SwapFee[] };
+  nonePayable: { [key in NameOfFees]?: SwapFee[] };
+};