|
| 1 | +import BigNumber from 'bignumber.js' |
| 2 | +import { BN_ZERO } from 'constants/math' |
| 3 | +import useCurrentAccount from 'hooks/accounts/useCurrentAccount' |
| 4 | +import { useKeeperFee } from 'hooks/perps/useKeeperFee' |
| 5 | +import { useMemo } from 'react' |
| 6 | +import { BNCoin } from 'types/classes/BNCoin' |
| 7 | +import { OrderType } from 'types/enums' |
| 8 | +import { byDenom } from 'utils/array' |
| 9 | + |
| 10 | +interface KeeperFeeCalculation { |
| 11 | + totalKeeperFeeAmount: BigNumber |
| 12 | + keeperFeeFromLends: BNCoin |
| 13 | + keeperFeeFromBorrows: BNCoin |
| 14 | +} |
| 15 | + |
| 16 | +export function useKeeperFeeCalculation({ |
| 17 | + orderType, |
| 18 | + conditionalTriggers, |
| 19 | + tradingFee, |
| 20 | + enabled, |
| 21 | +}: { |
| 22 | + orderType: OrderType |
| 23 | + conditionalTriggers: { sl: string | null; tp: string | null } |
| 24 | + tradingFee?: { opening: BigNumber; closing: BigNumber } |
| 25 | + enabled: boolean |
| 26 | +}): KeeperFeeCalculation { |
| 27 | + const currentAccount = useCurrentAccount() |
| 28 | + const keeperFee = useKeeperFee() |
| 29 | + |
| 30 | + // Extract stable primitive values for dependencies |
| 31 | + const keeperFeeDenom = keeperFee.calculateKeeperFee?.denom |
| 32 | + const keeperFeeAmount = keeperFee.calculateKeeperFee?.amount.toString() |
| 33 | + const tradingFeeOpeningStr = tradingFee?.opening.toString() |
| 34 | + const tradingFeeClosingStr = tradingFee?.closing.toString() |
| 35 | + |
| 36 | + return useMemo(() => { |
| 37 | + const emptyResult: KeeperFeeCalculation = { |
| 38 | + totalKeeperFeeAmount: BN_ZERO, |
| 39 | + keeperFeeFromLends: BNCoin.fromDenomAndBigNumber(keeperFee.calculateKeeperFee.denom, BN_ZERO), |
| 40 | + keeperFeeFromBorrows: BNCoin.fromDenomAndBigNumber( |
| 41 | + keeperFee.calculateKeeperFee.denom, |
| 42 | + BN_ZERO, |
| 43 | + ), |
| 44 | + } |
| 45 | + |
| 46 | + if (!enabled || !currentAccount) return emptyResult |
| 47 | + |
| 48 | + const hasTriggers = !!(conditionalTriggers.tp ?? conditionalTriggers.sl) |
| 49 | + if (!hasTriggers && orderType === OrderType.MARKET) return emptyResult |
| 50 | + |
| 51 | + const orderKeeperFee = keeperFee.calculateKeeperFee |
| 52 | + const numConditionalTriggers = |
| 53 | + (conditionalTriggers.tp ? 1 : 0) + (conditionalTriggers.sl ? 1 : 0) |
| 54 | + |
| 55 | + // For limit/stop orders (orderType !== MARKET), the parent order also needs keeper fee |
| 56 | + // For market orders, only the conditional triggers need keeper fees |
| 57 | + const totalTriggerOrders = |
| 58 | + orderType === OrderType.MARKET ? numConditionalTriggers : numConditionalTriggers + 1 |
| 59 | + |
| 60 | + let totalKeeperFeeAmount = orderKeeperFee.amount.times(totalTriggerOrders) |
| 61 | + |
| 62 | + // For market orders, the execute_perp_order runs immediately and consumes trading fees |
| 63 | + // before the keeper fees are deducted. We need to account for this. |
| 64 | + // Limit orders don't have this issue because execute_perp_order is inside the trigger. |
| 65 | + if (orderType === OrderType.MARKET && numConditionalTriggers > 0) { |
| 66 | + let tradingFeeBuffer = BN_ZERO |
| 67 | + |
| 68 | + if (tradingFee) { |
| 69 | + const totalTradingFee = tradingFee.opening.plus(tradingFee.closing) |
| 70 | + tradingFeeBuffer = totalTradingFee.times(1.01).integerValue(BigNumber.ROUND_UP) |
| 71 | + } |
| 72 | + |
| 73 | + // If trading fee is 0 or very small, use 1% of keeper fees as minimum buffer |
| 74 | + // This accounts for trading fees that aren't captured in the API estimate |
| 75 | + const minBuffer = orderKeeperFee.amount |
| 76 | + .times(numConditionalTriggers) |
| 77 | + .times(0.01) |
| 78 | + .integerValue(BigNumber.ROUND_UP) |
| 79 | + tradingFeeBuffer = BigNumber.max(tradingFeeBuffer, minBuffer) |
| 80 | + |
| 81 | + totalKeeperFeeAmount = totalKeeperFeeAmount.plus(tradingFeeBuffer) |
| 82 | + } |
| 83 | + |
| 84 | + let keeperFeeAmountLeft = totalKeeperFeeAmount |
| 85 | + |
| 86 | + const keeperFeeTokenDepositsAmount = |
| 87 | + currentAccount.deposits.find(byDenom(orderKeeperFee.denom))?.amount ?? BN_ZERO |
| 88 | + |
| 89 | + keeperFeeAmountLeft = keeperFeeTokenDepositsAmount.isGreaterThan(totalKeeperFeeAmount) |
| 90 | + ? BN_ZERO |
| 91 | + : totalKeeperFeeAmount.minus(keeperFeeTokenDepositsAmount) |
| 92 | + |
| 93 | + const keeperFeeTokenLendsAmount = |
| 94 | + currentAccount.lends.find(byDenom(orderKeeperFee.denom))?.amount ?? BN_ZERO |
| 95 | + |
| 96 | + const keeperFeeFromLendsAmount = keeperFeeTokenLendsAmount.isGreaterThan(keeperFeeAmountLeft) |
| 97 | + ? keeperFeeAmountLeft |
| 98 | + : keeperFeeTokenLendsAmount |
| 99 | + |
| 100 | + keeperFeeAmountLeft = keeperFeeAmountLeft.minus(keeperFeeFromLendsAmount) |
| 101 | + |
| 102 | + const keeperFeeFromBorrowAmount = keeperFeeAmountLeft.isZero() ? BN_ZERO : keeperFeeAmountLeft |
| 103 | + |
| 104 | + return { |
| 105 | + totalKeeperFeeAmount, |
| 106 | + keeperFeeFromLends: BNCoin.fromDenomAndBigNumber( |
| 107 | + orderKeeperFee.denom, |
| 108 | + keeperFeeFromLendsAmount, |
| 109 | + ), |
| 110 | + keeperFeeFromBorrows: BNCoin.fromDenomAndBigNumber( |
| 111 | + orderKeeperFee.denom, |
| 112 | + keeperFeeFromBorrowAmount, |
| 113 | + ), |
| 114 | + } |
| 115 | + // eslint-disable-next-line react-hooks/exhaustive-deps |
| 116 | + }, [ |
| 117 | + enabled, |
| 118 | + currentAccount, |
| 119 | + keeperFeeDenom, |
| 120 | + keeperFeeAmount, |
| 121 | + orderType, |
| 122 | + conditionalTriggers.tp, |
| 123 | + conditionalTriggers.sl, |
| 124 | + tradingFeeOpeningStr, |
| 125 | + tradingFeeClosingStr, |
| 126 | + ]) |
| 127 | +} |
0 commit comments