Merge pull request #380 from reservoirprotocol/pedro/relay-6415-creat…

…e-onswapvalidating-callback-for-analytics-events

Add onSwapValidating callback for analytics events

.changeset/fluffy-ducks-smoke.md

@@ -0,0 +1,5 @@
+---
+'@reservoir0x/relay-kit-ui': patch
+---
+
+Add onSwapValidating callback

.changeset/gorgeous-eggs-boil.md

@@ -0,0 +1,5 @@
+---
+'@reservoir0x/relay-kit-ui': patch
+---
+
+Use transaction data rather than quote data on success screen

packages/ui/src/components/common/TransactionModal/SwapModal.tsx

@@ -43,6 +43,7 @@ type SwapModalProps = {
   onAnalyticEvent?: (eventName: string, data?: any) => void
   onOpenChange: (open: boolean) => void
   onSuccess?: (data: Execute) => void
+  onSwapValidating?: (data: Execute) => void
 }
 
 export const SwapModal: FC<SwapModalProps> = (swapModalProps) => {
@@ -64,7 +65,8 @@ export const SwapModal: FC<SwapModalProps> = (swapModalProps) => {
     wallet,
     invalidateBalanceQueries,
     onAnalyticEvent,
-    onSuccess
+    onSuccess,
+    onSwapValidating
   } = swapModalProps
   return (
     <TransactionModalRenderer
@@ -85,9 +87,16 @@ export const SwapModal: FC<SwapModalProps> = (swapModalProps) => {
       onAnalyticEvent={onAnalyticEvent}
       onValidating={(quote) => {
         const steps = quote?.steps
+        const details = quote?.details
+        const fees = quote?.fees
         onAnalyticEvent?.(EventNames.TRANSACTION_VALIDATING, {
           quote_id: steps ? extractQuoteId(steps) : undefined
         })
+        onSwapValidating?.({
+          steps: steps,
+          fees: fees,
+          details: details
+        })
       }}
       onSuccess={(quote, steps) => {
         const details = quote?.details
@@ -192,7 +201,8 @@ const InnerSwapModal: FC<InnerSwapModalProps> = ({
   multiWalletSupportEnabled,
   useExternalLiquidity,
   fromChain,
-  waitingForSteps
+  waitingForSteps,
+  isLoadingTransaction
 }) => {
   useEffect(() => {
     if (!open) {
@@ -308,6 +318,7 @@ const InnerSwapModal: FC<InnerSwapModalProps> = ({
             timeEstimate={timeEstimate?.formattedTime}
             isCanonical={isCanonical}
             details={details}
+            isLoadingTransaction={isLoadingTransaction}
           />
         ) : null}
         {progressStep === TransactionProgressStep.Error ? (

packages/ui/src/components/common/TransactionModal/TransactionModalRenderer.tsx

@@ -81,6 +81,7 @@ export type ChildrenProps = {
       swapImpact?: string
     }
   } | null
+  isLoadingTransaction: boolean
 }
 
 type Props = {
@@ -405,7 +406,7 @@ export const TransactionModalRenderer: FC<Props> = ({
   }, [steps, quoteError, swapError])
 
   // Fetch Success Tx
-  const { data: transactions } = useRequests(
+  const { data: transactions, isFetching: isLoadingTransaction } = useRequests(
     (progressStep === TransactionProgressStep.Success ||
       progressStep === TransactionProgressStep.Error) &&
       allTxHashes[0]
@@ -470,7 +471,8 @@ export const TransactionModalRenderer: FC<Props> = ({
         setStartTimestamp,
         quoteUpdatedAt,
         requestId,
-        feeBreakdown
+        feeBreakdown,
+        isLoadingTransaction
       })}
     </>
   )

packages/ui/src/components/common/TransactionModal/steps/SwapSuccessStep.tsx

@@ -7,7 +7,8 @@ import {
   Pill,
   Text,
   ChainTokenIcon,
-  ChainIcon
+  ChainIcon,
+  Skeleton
 } from '../../../primitives/index.js'
 import { motion } from 'framer-motion'
 import { FontAwesomeIcon } from '@fortawesome/react-fontawesome'
@@ -22,19 +23,21 @@ import { useRelayClient } from '../../../../hooks/index.js'
 import { faClockFour } from '@fortawesome/free-solid-svg-icons/faClockFour'
 import type { Execute } from '@reservoir0x/relay-sdk'
 import { bitcoin } from '../../../../utils/bitcoin.js'
+import { formatBN } from '../../../../utils/numbers.js'
 
 type SwapSuccessStepProps = {
   fromToken?: Token
   toToken?: Token
-  fromAmountFormatted: string
-  toAmountFormatted: string
+  fromAmountFormatted?: string
+  toAmountFormatted?: string
   allTxHashes: TxHashes
-  transaction: ReturnType<typeof useRequests>['data']['0']
+  transaction?: ReturnType<typeof useRequests>['data']['0']
   seconds: number
   fillTime: string
   timeEstimate?: string
   isCanonical?: boolean
   details?: Execute['details'] | null
+  isLoadingTransaction?: boolean
   onOpenChange: (open: boolean) => void
 }
 
@@ -50,21 +53,46 @@ export const SwapSuccessStep: FC<SwapSuccessStepProps> = ({
   timeEstimate,
   isCanonical,
   details,
+  isLoadingTransaction,
   onOpenChange
 }) => {
   const relayClient = useRelayClient()
   const isWrap = details?.operation === 'wrap'
   const isUnwrap = details?.operation === 'unwrap'
 
+  const _fromAmountFormatted = transaction?.data?.metadata?.currencyIn?.amount
+    ? formatBN(
+        transaction?.data?.metadata?.currencyIn?.amount,
+        5,
+        transaction?.data?.metadata?.currencyIn?.currency?.decimals ?? 18
+      )
+    : fromAmountFormatted
+  const _fromToken =
+    transaction?.data?.metadata?.currencyIn?.currency ?? fromToken
+  const fromTokenLogoUri =
+    transaction?.data?.metadata?.currencyIn?.currency?.metadata?.logoURI ??
+    fromToken?.logoURI
+  const _toAmountFormatted = transaction?.data?.metadata?.currencyOut?.amount
+    ? formatBN(
+        transaction?.data?.metadata?.currencyOut?.amount,
+        5,
+        transaction?.data?.metadata?.currencyOut?.currency?.decimals ?? 18
+      )
+    : toAmountFormatted
+  const _toToken = transaction?.data?.metadata?.currencyOut?.currency ?? toToken
+  const toTokenLogoUri =
+    transaction?.data?.metadata?.currencyOut?.currency?.metadata?.logoURI ??
+    toToken?.logoURI
+
   const actionTitle = isWrap ? 'wrapped' : isUnwrap ? 'unwrapped' : 'swapped'
   const baseTransactionUrl = relayClient?.baseApiUrl.includes('testnets')
     ? 'https://testnets.relay.link'
     : 'https://relay.link'
-  const fromChain = fromToken
-    ? relayClient?.chains.find((chain) => chain.id === fromToken?.chainId)
+  const fromChain = _fromToken
+    ? relayClient?.chains.find((chain) => chain.id === _fromToken?.chainId)
     : null
-  const toChain = toToken
-    ? relayClient?.chains.find((chain) => chain.id === toToken?.chainId)
+  const toChain = _toToken
+    ? relayClient?.chains.find((chain) => chain.id === _toToken?.chainId)
     : null
   const delayedTxUrl = transaction?.data?.inTxs?.[0]?.hash
     ? `${baseTransactionUrl}/transaction/${transaction?.data?.inTxs?.[0]?.hash}`
@@ -129,9 +157,9 @@ export const SwapSuccessStep: FC<SwapSuccessStepProps> = ({
         </motion.div>
 
         <Text style="subtitle1" css={{ mt: '4', mb: '2', textAlign: 'center' }}>
-          Processing the order to swap {fromAmountFormatted} {fromToken?.symbol}{' '}
-          into {toAmountFormatted} {toToken?.symbol}, this will take ~
-          {timeEstimate}.
+          Processing the order to swap {_fromAmountFormatted}{' '}
+          {_fromToken?.symbol} into {_toAmountFormatted} {_toToken?.symbol},
+          this will take ~{timeEstimate}.
         </Text>
 
         <Flex align="center" css={{ gap: '2', mb: 24 }}>
@@ -282,39 +310,51 @@ export const SwapSuccessStep: FC<SwapSuccessStepProps> = ({
         </Text>
 
         <Flex align="center" css={{ gap: '2', mb: 20 }}>
-          {fromToken ? (
+          {_fromToken ? (
             <Pill
               color="gray"
               css={{ alignItems: 'center', py: '2', px: '3', gap: '2' }}
             >
               <ChainTokenIcon
-                chainId={fromToken.chainId}
-                tokenlogoURI={fromToken.logoURI}
+                chainId={_fromToken.chainId}
+                tokenlogoURI={fromTokenLogoUri}
                 css={{ height: 32, width: 32 }}
               />
-              <Text style="subtitle1" ellipsify>
-                {fromAmountFormatted} {fromToken.symbol}
-              </Text>
+              {isLoadingTransaction ? (
+                <Skeleton
+                  css={{ height: 24, width: 60, background: 'gray5' }}
+                />
+              ) : (
+                <Text style="subtitle1" ellipsify>
+                  {_fromAmountFormatted} {_fromToken.symbol}
+                </Text>
+              )}
             </Pill>
           ) : (
             <Text style="subtitle1">?</Text>
           )}
           <Text style="subtitle1" color="subtle">
             to
           </Text>
-          {toToken ? (
+          {_toToken ? (
             <Pill
               color="gray"
               css={{ alignItems: 'center', py: '2', px: '3', gap: '2' }}
             >
               <ChainTokenIcon
-                chainId={toToken.chainId}
-                tokenlogoURI={toToken.logoURI}
+                chainId={_toToken.chainId}
+                tokenlogoURI={toTokenLogoUri}
                 css={{ height: 32, width: 32 }}
               />
-              <Text style="subtitle1" ellipsify>
-                {toAmountFormatted} {toToken.symbol}
-              </Text>
+              {isLoadingTransaction ? (
+                <Skeleton
+                  css={{ height: 24, width: 60, background: 'gray5' }}
+                />
+              ) : (
+                <Text style="subtitle1" ellipsify>
+                  {_toAmountFormatted} {_toToken.symbol}
+                </Text>
+              )}
             </Pill>
           ) : (
             <Text style="subtitle1">?</Text>

packages/ui/src/components/widgets/SwapWidget/index.tsx

@@ -53,6 +53,7 @@ type BaseSwapWidgetProps = {
   onToTokenChange?: (token?: Token) => void
   onConnectWallet?: () => void
   onAnalyticEvent?: (eventName: string, data?: any) => void
+  onSwapValidating?: (data: Execute) => void
   onSwapSuccess?: (data: Execute) => void
   onSwapError?: (error: string, data?: Execute) => void
 }
@@ -97,6 +98,7 @@ const SwapWidget: FC<SwapWidgetProps> = ({
   onConnectWallet,
   onAnalyticEvent,
   onSwapSuccess,
+  onSwapValidating,
   onSwapError
 }) => {
   const relayClient = useRelayClient()
@@ -274,6 +276,7 @@ const SwapWidget: FC<SwapWidgetProps> = ({
             }}
             useExternalLiquidity={useExternalLiquidity}
             onSwapSuccess={onSwapSuccess}
+            onSwapValidating={onSwapValidating}
             onAnalyticEvent={onAnalyticEvent}
             invalidateBalanceQueries={invalidateBalanceQueries}
             customToAddress={customToAddress}

packages/ui/src/components/widgets/WidgetContainer.tsx

@@ -21,6 +21,7 @@ export type WidgetContainerProps = {
   onSwapModalOpenChange: (open: boolean) => void
   onAnalyticEvent?: (eventName: string, data?: any) => void
   onSwapSuccess?: (data: Execute) => void
+  onSwapValidating?: (data: Execute) => void
   invalidateBalanceQueries: () => void
 } & Pick<
   ChildrenProps,
@@ -68,6 +69,7 @@ const WidgetContainer: FC<WidgetContainerProps> = ({
   multiWalletSupportEnabled,
   onSwapModalOpenChange,
   onSwapSuccess,
+  onSwapValidating,
   onAnalyticEvent,
   invalidateBalanceQueries,
   setCustomToAddress
@@ -99,6 +101,7 @@ const WidgetContainer: FC<WidgetContainerProps> = ({
           timeEstimate={timeEstimate}
           onAnalyticEvent={onAnalyticEvent}
           onSuccess={onSwapSuccess}
+          onSwapValidating={onSwapValidating}
           invalidateBalanceQueries={invalidateBalanceQueries}
           wallet={wallet}
           linkedWallets={linkedWallets}