feat: foxwifhat discount

src/components/FeeExplainer/FeeExplainer.tsx

@@ -1,5 +1,6 @@
 import type { CardProps, StackProps } from '@chakra-ui/react'
 import { Box, Card, CardBody, Flex, Heading, Stack, useToken } from '@chakra-ui/react'
+import { foxWifHatAssetId } from '@shapeshiftoss/caip'
 import { bnOrZero } from '@shapeshiftoss/chain-adapters'
 import { LinearGradient } from '@visx/gradient'
 import { GridColumns, GridRows } from '@visx/grid'
@@ -31,6 +32,7 @@ import {
   selectIsSnapshotApiQueriesRejected,
   selectVotingPower,
 } from 'state/apis/snapshot/selectors'
+import { selectPortfolioCryptoBalanceBaseUnitByFilter } from 'state/slices/common-selectors'
 import { useAppSelector } from 'state/store'
 
 import { CHART_TRADE_SIZE_MAX_USD } from './common'
@@ -149,6 +151,9 @@ const FeeChart: React.FC<FeeChartProps> = ({ foxHolding, tradeSize, feeModel })
           foxHeld: bn(debouncedFoxHolding),
           feeModel,
           isSnapshotApiQueriesRejected,
+          // This is for feeExplainer which is not supporting anything else than FOX discount for now
+          foxWifHatHeld: bn(0),
+          thorHeld: bn(0),
         }).feeBpsFloat.toNumber()
         return { x: trade, y: feeBps }
       })
@@ -161,6 +166,9 @@ const FeeChart: React.FC<FeeChartProps> = ({ foxHolding, tradeSize, feeModel })
       foxHeld: bn(debouncedFoxHolding),
       feeModel,
       isSnapshotApiQueriesRejected,
+      // This is for feeExplainer which is not supporting anything else than FOX discount for now
+      foxWifHatHeld: bn(0),
+      thorHeld: bn(0),
     }).feeBpsFloat.toNumber()
 
     return [{ x: tradeSize, y: feeBps }]
@@ -262,12 +270,20 @@ type FeeOutputProps = {
 
 export const FeeOutput: React.FC<FeeOutputProps> = ({ tradeSizeUSD, foxHolding, feeModel }) => {
   const isSnapshotApiQueriesRejected = useAppSelector(selectIsSnapshotApiQueriesRejected)
+
+  const foxWifHatHeld = useAppSelector(state =>
+    selectPortfolioCryptoBalanceBaseUnitByFilter(state, { assetId: foxWifHatAssetId }),
+  )
+
   const { feeUsd, feeBps, foxDiscountPercent, feeUsdBeforeDiscount, feeBpsBeforeDiscount } =
     calculateFees({
       tradeAmountUsd: bn(tradeSizeUSD),
       foxHeld: bn(foxHolding),
       feeModel,
       isSnapshotApiQueriesRejected,
+      foxWifHatHeld: bn(foxWifHatHeld),
+      // @TODO: remove this when thor swap discount is removed
+      thorHeld: bn(0),
     })
 
   const basedOnFeeTranslation: TextPropTypes['translation'] = useMemo(

src/components/MultiHopTrade/hooks/useGetTradeQuotes/useGetTradeQuotes.tsx

@@ -1,5 +1,5 @@
 import { skipToken as reduxSkipToken } from '@reduxjs/toolkit/query'
-import { fromAccountId } from '@shapeshiftoss/caip'
+import { foxWifHatAssetId, fromAccountId } from '@shapeshiftoss/caip'
 import { isLedger } from '@shapeshiftoss/hdwallet-ledger'
 import type {
   GetTradeQuoteInput,
@@ -36,6 +36,7 @@ import { swapperApi } from 'state/apis/swapper/swapperApi'
 import type { ApiQuote, TradeQuoteError } from 'state/apis/swapper/types'
 import {
   selectPortfolioAccountMetadataByAccountId,
+  selectPortfolioCryptoBalanceBaseUnitByFilter,
   selectUsdRateByAssetId,
 } from 'state/slices/selectors'
 import {
@@ -213,6 +214,9 @@ export const useGetTradeQuotes = () => {
 
   const votingPower = useAppSelector(state => selectVotingPower(state, votingPowerParams))
   const thorVotingPower = useAppSelector(state => selectVotingPower(state, thorVotingPowerParams))
+  const foxWifHatHeld = useAppSelector(state =>
+    selectPortfolioCryptoBalanceBaseUnitByFilter(state, { assetId: foxWifHatAssetId }),
+  )
 
   const walletSupportsBuyAssetChain = useWalletSupportsChain(buyAsset.chainId, wallet)
   const isBuyAssetChainSupported = walletSupportsBuyAssetChain
@@ -273,6 +277,7 @@ export const useGetTradeQuotes = () => {
         tradeAmountUsd,
         foxHeld: bnOrZero(votingPower),
         thorHeld: bnOrZero(thorVotingPower),
+        foxWifHatHeld: bnOrZero(foxWifHatHeld),
         feeModel: 'SWAPPER',
         isSnapshotApiQueriesRejected,
       })
@@ -321,6 +326,7 @@ export const useGetTradeQuotes = () => {
     sellAsset,
     sellAssetUsdRate,
     thorVotingPower,
+    foxWifHatHeld,
     userSlippageTolerancePercentageDecimal,
     votingPower,
     wallet,

src/components/MultiHopTrade/hooks/useGetTradeQuotes/useGetTradeRates.tsx

@@ -1,5 +1,5 @@
 import { skipToken } from '@reduxjs/toolkit/dist/query'
-import { fromAccountId } from '@shapeshiftoss/caip'
+import { foxWifHatAssetId, fromAccountId } from '@shapeshiftoss/caip'
 import { isLedger } from '@shapeshiftoss/hdwallet-ledger'
 import type { GetTradeRateInput, TradeRate } from '@shapeshiftoss/swapper'
 import {
@@ -28,6 +28,7 @@ import {
 } from 'state/apis/snapshot/selectors'
 import { swapperApi } from 'state/apis/swapper/swapperApi'
 import type { ApiQuote, TradeQuoteError } from 'state/apis/swapper/types'
+import { selectPortfolioCryptoBalanceBaseUnitByFilter } from 'state/slices/common-selectors'
 import { selectUsdRateByAssetId } from 'state/slices/marketDataSlice/selectors'
 import { selectPortfolioAccountMetadataByAccountId } from 'state/slices/portfolioSlice/selectors'
 import {
@@ -135,6 +136,10 @@ export const useGetTradeRates = () => {
   const sellAccountId = useAppSelector(selectFirstHopSellAccountId)
   const buyAccountId = useAppSelector(selectLastHopBuyAccountId)
 
+  const foxWifHatHeld = useAppSelector(state =>
+    selectPortfolioCryptoBalanceBaseUnitByFilter(state, { assetId: foxWifHatAssetId }),
+  )
+
   const userSlippageTolerancePercentageDecimal = useAppSelector(selectUserSlippagePercentageDecimal)
 
   const sellAccountMetadataFilter = useMemo(
@@ -193,6 +198,7 @@ export const useGetTradeRates = () => {
         // referentially invalidate, while ensuring the *initial* connection of a wallet when quotes were gotten without one, doesn't invalidate anything
         sellAccountMetadata,
         votingPower,
+        foxWifHatHeld,
         thorVotingPower,
         receiveAccountMetadata,
         sellAccountId,
@@ -226,6 +232,7 @@ export const useGetTradeRates = () => {
         tradeAmountUsd,
         foxHeld: bnOrZero(votingPower),
         thorHeld: bnOrZero(thorVotingPower),
+        foxWifHatHeld: bnOrZero(foxWifHatHeld),
         feeModel: 'SWAPPER',
         isSnapshotApiQueriesRejected,
       })

src/lib/fees/constant.ts

@@ -0,0 +1,5 @@
+// This timestamp is the 24th of January 2025
+export const FOX_WIF_HAT_CAMPAIGN_STARTING_TIME_MS = 1737707777000
+// Supposed to end the 5th of May 2025
+export const FOX_WIF_HAT_CAMPAIGN_ENDING_TIME_MS = 1746396000000
+export const FOX_WIF_HAT_MINIMUM_AMOUNT_BASE_UNIT = 10000000000000000000000

src/lib/fees/model.test.ts

@@ -1,8 +1,13 @@
-import { describe, expect, it, vi } from 'vitest'
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
 import { bn } from 'lib/bignumber/bignumber'
 import { selectIsSnapshotApiQueriesRejected } from 'state/apis/snapshot/selectors'
 import { store } from 'state/store'
 
+import {
+  FOX_WIF_HAT_CAMPAIGN_ENDING_TIME_MS,
+  FOX_WIF_HAT_CAMPAIGN_STARTING_TIME_MS,
+  FOX_WIF_HAT_MINIMUM_AMOUNT_BASE_UNIT,
+} from './constant'
 import { calculateFees } from './model'
 import { swapperParameters } from './parameters/swapper'
 
@@ -36,6 +41,8 @@ describe('calculateFees', () => {
     const { feeBps } = calculateFees({
       tradeAmountUsd,
       foxHeld,
+      thorHeld: bn(0),
+      foxWifHatHeld: bn(0),
       feeModel: 'SWAPPER',
       isSnapshotApiQueriesRejected,
     })
@@ -49,6 +56,8 @@ describe('calculateFees', () => {
     const { feeBps } = calculateFees({
       tradeAmountUsd,
       foxHeld,
+      thorHeld: bn(0),
+      foxWifHatHeld: bn(0),
       feeModel: 'SWAPPER',
       isSnapshotApiQueriesRejected,
     })
@@ -62,6 +71,8 @@ describe('calculateFees', () => {
     const { feeBps } = calculateFees({
       tradeAmountUsd,
       foxHeld,
+      thorHeld: bn(0),
+      foxWifHatHeld: bn(0),
       feeModel: 'SWAPPER',
       isSnapshotApiQueriesRejected,
     })
@@ -75,6 +86,8 @@ describe('calculateFees', () => {
     const { feeBps } = calculateFees({
       tradeAmountUsd,
       foxHeld,
+      thorHeld: bn(0),
+      foxWifHatHeld: bn(0),
       feeModel: 'SWAPPER',
       isSnapshotApiQueriesRejected,
     })
@@ -88,6 +101,8 @@ describe('calculateFees', () => {
     const { feeBps } = calculateFees({
       tradeAmountUsd,
       foxHeld,
+      thorHeld: bn(0),
+      foxWifHatHeld: bn(0),
       feeModel: 'SWAPPER',
       isSnapshotApiQueriesRejected,
     })
@@ -101,6 +116,8 @@ describe('calculateFees', () => {
     const { feeBps, foxDiscountPercent } = calculateFees({
       tradeAmountUsd,
       foxHeld,
+      thorHeld: bn(0),
+      foxWifHatHeld: bn(0),
       feeModel: 'SWAPPER',
       isSnapshotApiQueriesRejected,
     })
@@ -115,6 +132,8 @@ describe('calculateFees', () => {
     const { feeBps, foxDiscountPercent } = calculateFees({
       tradeAmountUsd,
       foxHeld,
+      thorHeld: bn(0),
+      foxWifHatHeld: bn(0),
       feeModel: 'SWAPPER',
       isSnapshotApiQueriesRejected,
     })
@@ -131,10 +150,131 @@ describe('calculateFees', () => {
     const { feeBps, foxDiscountPercent } = calculateFees({
       tradeAmountUsd,
       foxHeld,
+      thorHeld: bn(0),
+      foxWifHatHeld: bn(0),
       feeModel: 'SWAPPER',
       isSnapshotApiQueriesRejected,
     })
     expect(feeBps.toNumber()).toEqual(FEE_CURVE_MAX_FEE_BPS)
     expect(foxDiscountPercent).toEqual(bn(0))
   })
+
+  describe('foxWifHat campaign', () => {
+    beforeEach(() => {
+      vi.useFakeTimers()
+    })
+
+    afterEach(() => {
+      vi.useRealTimers()
+    })
+
+    it('should return 100% discount at campaign start for eligible holders', () => {
+      vi.setSystemTime(new Date(FOX_WIF_HAT_CAMPAIGN_STARTING_TIME_MS))
+      const tradeAmountUsd = bn(FEE_CURVE_MIDPOINT_USD)
+      const foxHeld = bn(0)
+      const thorHeld = bn(0)
+      const foxWifHatHeld = bn(FOX_WIF_HAT_MINIMUM_AMOUNT_BASE_UNIT)
+      const isSnapshotApiQueriesRejected = selectIsSnapshotApiQueriesRejected(store.getState())
+
+      const { feeBps, foxDiscountPercent } = calculateFees({
+        tradeAmountUsd,
+        foxHeld,
+        thorHeld,
+        foxWifHatHeld,
+        feeModel: 'SWAPPER',
+        isSnapshotApiQueriesRejected,
+      })
+
+      expect(feeBps.toNumber()).toEqual(0)
+      expect(foxDiscountPercent.toNumber()).toEqual(100)
+    })
+
+    it('should return 50% discount at campaign midpoint for eligible holders', () => {
+      const campaignMidpoint =
+        FOX_WIF_HAT_CAMPAIGN_STARTING_TIME_MS +
+        (FOX_WIF_HAT_CAMPAIGN_ENDING_TIME_MS - FOX_WIF_HAT_CAMPAIGN_STARTING_TIME_MS) / 2
+
+      vi.setSystemTime(new Date(campaignMidpoint))
+      const tradeAmountUsd = bn(FEE_CURVE_MIDPOINT_USD)
+      const foxHeld = bn(0)
+      const thorHeld = bn(0)
+      const foxWifHatHeld = bn(FOX_WIF_HAT_MINIMUM_AMOUNT_BASE_UNIT)
+      const isSnapshotApiQueriesRejected = selectIsSnapshotApiQueriesRejected(store.getState())
+
+      const { feeBps, foxDiscountPercent } = calculateFees({
+        tradeAmountUsd,
+        foxHeld,
+        thorHeld,
+        foxWifHatHeld,
+        feeModel: 'SWAPPER',
+        isSnapshotApiQueriesRejected,
+      })
+
+      expect(foxDiscountPercent.toNumber()).toBeCloseTo(50, 0)
+      expect(feeBps.toNumber()).toBeCloseTo(17, 0) // ~35 * 0.5
+    })
+
+    it('should return 0% discount at campaign end for eligible holders', () => {
+      vi.setSystemTime(new Date(FOX_WIF_HAT_CAMPAIGN_ENDING_TIME_MS))
+      const tradeAmountUsd = bn(FEE_CURVE_MIDPOINT_USD)
+      const foxHeld = bn(0)
+      const thorHeld = bn(0)
+      const foxWifHatHeld = bn(FOX_WIF_HAT_MINIMUM_AMOUNT_BASE_UNIT)
+      const isSnapshotApiQueriesRejected = selectIsSnapshotApiQueriesRejected(store.getState())
+
+      const { feeBps, foxDiscountPercent } = calculateFees({
+        tradeAmountUsd,
+        foxHeld,
+        thorHeld,
+        foxWifHatHeld,
+        feeModel: 'SWAPPER',
+        isSnapshotApiQueriesRejected,
+      })
+
+      expect(foxDiscountPercent.toNumber()).toEqual(0)
+      expect(feeBps.toNumber()).toEqual(35) // No discount applied
+    })
+
+    it('should return no discount for holders below minimum amount', () => {
+      vi.setSystemTime(new Date(FOX_WIF_HAT_CAMPAIGN_STARTING_TIME_MS))
+      const tradeAmountUsd = bn(FEE_CURVE_MIDPOINT_USD)
+      const foxHeld = bn(0)
+      const thorHeld = bn(0)
+      const foxWifHatHeld = bn(FOX_WIF_HAT_MINIMUM_AMOUNT_BASE_UNIT).minus(1)
+      const isSnapshotApiQueriesRejected = selectIsSnapshotApiQueriesRejected(store.getState())
+
+      const { feeBps, foxDiscountPercent } = calculateFees({
+        tradeAmountUsd,
+        foxHeld,
+        thorHeld,
+        foxWifHatHeld,
+        feeModel: 'SWAPPER',
+        isSnapshotApiQueriesRejected,
+      })
+
+      expect(foxDiscountPercent.toNumber()).toEqual(0)
+      expect(feeBps.toNumber()).toEqual(35)
+    })
+
+    it('should return no discount outside campaign period', () => {
+      vi.setSystemTime(new Date(FOX_WIF_HAT_CAMPAIGN_ENDING_TIME_MS + 1))
+      const tradeAmountUsd = bn(FEE_CURVE_MIDPOINT_USD)
+      const foxHeld = bn(0)
+      const thorHeld = bn(0)
+      const foxWifHatHeld = bn(FOX_WIF_HAT_MINIMUM_AMOUNT_BASE_UNIT)
+      const isSnapshotApiQueriesRejected = selectIsSnapshotApiQueriesRejected(store.getState())
+
+      const { feeBps, foxDiscountPercent } = calculateFees({
+        tradeAmountUsd,
+        foxHeld,
+        thorHeld,
+        foxWifHatHeld,
+        feeModel: 'SWAPPER',
+        isSnapshotApiQueriesRejected,
+      })
+
+      expect(foxDiscountPercent.toNumber()).toEqual(0)
+      expect(feeBps.toNumber()).toEqual(35)
+    })
+  })
 })