Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Canonical ux improvements #301

Merged
merged 3 commits into from
Oct 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/sweet-planes-attend.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@reservoir0x/relay-kit-ui': patch
---

Improvements on the canonical fallback ux
6 changes: 3 additions & 3 deletions packages/ui/src/components/widgets/SwapRouteSelector.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ const SwapRouteSelector: FC<Props> = ({
color="gray"
>
<Text style="subtitle2">
{externalLiquidtySelected ? 'Standard' : 'Relay'}
{externalLiquidtySelected ? 'Native' : 'Relay'}
</Text>
{supportsExternalLiquidity || externalLiquidtySelected ? (
<Box css={{ color: 'gray11', width: 14, flexShrink: 0 }}>
Expand Down Expand Up @@ -118,7 +118,7 @@ const SwapRouteSelector: FC<Props> = ({
</DropdownMenuItem>
{supportsExternalLiquidity || externalLiquidtySelected ? (
<DropdownMenuItem
aria-label={'Standard Bridge'}
aria-label={'Native Bridge'}
onClick={() => {
setOpen(false)
onExternalLiquidityChange(true)
Expand Down Expand Up @@ -148,7 +148,7 @@ const SwapRouteSelector: FC<Props> = ({
}}
/>
<Flex direction="column">
<Text style="subtitle2">Standard</Text>
<Text style="subtitle2">Native</Text>
<Text style="body3" color="subtle">
Standard time (&#62;2m), unlimited transaction capacity
</Text>
Expand Down
34 changes: 19 additions & 15 deletions packages/ui/src/components/widgets/SwapWidget/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -831,23 +831,27 @@ const SwapWidget: FC<SwapWidgetProps> = ({
/>
{isCapacityExceededError && supportsExternalLiquidity ? (
<Flex css={{ mt: '6px', gap: '3' }}>
<Button
color="white"
onClick={() => {
if (maxCapacityFormatted) {
setAmountInputValue(maxCapacityFormatted)
} else {
console.error('Missing max capacity')
}
onAnalyticEvent?.(
EventNames.CTA_SET_MAX_CAPACITY_CLICKED
)
}}
>
Set to {maxCapacityFormatted} {toToken?.symbol}
</Button>
{maxCapacityFormatted != '0' ? (
<Button
color="white"
css={{ flexGrow: '1', justifyContent: 'center' }}
onClick={() => {
if (maxCapacityFormatted) {
setAmountInputValue(maxCapacityFormatted)
} else {
console.error('Missing max capacity')
}
onAnalyticEvent?.(
EventNames.CTA_SET_MAX_CAPACITY_CLICKED
)
}}
>
Set to {maxCapacityFormatted} {toToken?.symbol}
</Button>
) : null}
<Button
color="primary"
css={{ flexGrow: '1', justifyContent: 'center' }}
onClick={() => {
setUseExternalLiquidity(true)
onAnalyticEvent?.(EventNames.CTA_SWITCH_ROUTE_CLICKED)
Expand Down
15 changes: 13 additions & 2 deletions packages/ui/src/components/widgets/SwapWidgetRenderer.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ import {
useRelayClient,
useDebounceState,
useWalletAddress,
useDisconnected
useDisconnected,
usePreviousValueChange
} from '../../hooks/index.js'
import type { Address } from 'viem'
import { formatUnits, isAddress, parseUnits } from 'viem'
Expand Down Expand Up @@ -518,7 +519,7 @@ const SwapWidgetRenderer: FC<SwapWidgetRendererProps> = ({
? fetchQuoteDataErrorMessage.match(/(\d+)/)?.[0]
: undefined
const maxCapacityFormatted = maxCapacityWei
? formatBN(BigInt(maxCapacityWei), 5, toToken?.decimals ?? 18)
? formatBN(BigInt(maxCapacityWei), 2, toToken?.decimals ?? 18)
: undefined

let ctaCopy: string = context || 'Swap'
Expand Down Expand Up @@ -589,6 +590,16 @@ const SwapWidgetRenderer: FC<SwapWidgetRendererProps> = ({
}
}

usePreviousValueChange(
isCapacityExceededError && supportsExternalLiquidity,
!isFetchingPrice && !externalLiquiditySupport.isFetching,
(capacityExceeded) => {
if (capacityExceeded) {
onAnalyticEvent?.(EventNames.CTA_MAX_CAPACITY_PROMPTED)
}
}
)

return (
<>
{children({
Expand Down
4 changes: 2 additions & 2 deletions packages/ui/src/components/widgets/WidgetErrorWell.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { type Execute } from '@reservoir0x/relay-sdk'
import { type FC } from 'react'
import { useEffect, type FC } from 'react'
import { Box, Flex, Text } from '../primitives/index.js'
import { FontAwesomeIcon } from '@fortawesome/react-fontawesome'
import { faExclamationCircle } from '@fortawesome/free-solid-svg-icons/faExclamationCircle'
Expand Down Expand Up @@ -71,7 +71,7 @@ export const WidgetErrorWell: FC<Props> = ({
<Text style="subtitle3" css={{ color: 'amber12' }}>
Due to high demand, only {maxCapacity} {currency.symbol} can be
bridged instantly. Set to max instant capacity or switch to the
standard route for unlimited capacity.
native route for unlimited capacity.
</Text>
</Flex>
)
Expand Down
1 change: 1 addition & 0 deletions packages/ui/src/constants/events.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ export const EventNames = {
SWAP_ROUTE_SELECTED: 'SWAP_ROUTE_SELECTED',
CTA_SET_MAX_CAPACITY_CLICKED: 'CTA_SET_MAX_CAPACITY_CLICKED',
CTA_SWITCH_ROUTE_CLICKED: 'CTA_SWITCH_ROUTE_CLICKED',
CTA_MAX_CAPACITY_PROMPTED: 'CTA_MAX_CAPACITY_PROMPTED',
WALLET_SELECTOR_SELECT: 'WALLET_SELECTOR_SELECT',
WALLET_SELECTOR_OPEN: 'WALLET_SELECTOR_OPEN',
WALLET_SELECTOR_CLOSE: 'WALLET_SELECTOR_CLOSE',
Expand Down
4 changes: 3 additions & 1 deletion packages/ui/src/hooks/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import useDebounceState from './useDebounceState.js'
import useDuneBalances from './useDuneBalances.js'
import useWalletAddress from './useWalletAddress.js'
import useDisconnected from './useDisconnected.js'
import usePreviousValueChange from './usePreviousValueChange.js'

export {
useMounted,
Expand All @@ -15,5 +16,6 @@ export {
useDebounceState,
useDuneBalances,
useWalletAddress,
useDisconnected
useDisconnected,
usePreviousValueChange
}
18 changes: 18 additions & 0 deletions packages/ui/src/hooks/usePreviousValueChange.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import { useEffect, useRef } from 'react'

export default <T>(
value: T,
enabled: boolean,
onChange: (value: T) => void
) => {
const ref = useRef<T>()

useEffect(() => {
if (enabled && ref.current !== value) {
ref.current = value
onChange(value)
}
}, [value, enabled, onChange])

return ref.current
}