Skip to content

Create new instance for fee calculation (backport #3051) #3052

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.

Sign up for GitHub

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

Merged
jusbar23 merged 1 commit into from
Aug 22, 2025
Merged

Create new instance for fee calculation (backport #3051) #3052

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 7 additions & 2 deletions protocol/x/revshare/keeper/revshare.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ func (k Keeper) GetAllRevShares(
}

var orderRouterRevShares []types.RevShare
netFeesSubRevenueShare := netFees
netFeesSubRevenueShare := new(big.Int).Set(netFees)
// No affiliate fees shared, so we can generate order router rev shares
if affiliateRevShares == nil {
orderRouterRevShares, err = k.getOrderRouterRevShares(ctx, fill, takerFees, makerFees)
Expand All @@ -231,7 +231,7 @@ func (k Keeper) GetAllRevShares(
netFeesSubRevenueShare.Sub(netFeesSubRevenueShare, revShare.QuoteQuantums)
}
} else {
netFeesSubRevenueShare = new(big.Int).Sub(netFees, affiliateFeesShared)
netFeesSubRevenueShare.Sub(netFeesSubRevenueShare, affiliateFeesShared)
}

if netFeesSubRevenueShare.Sign() <= 0 {
Expand Down Expand Up @@ -270,8 +270,13 @@ func (k Keeper) GetAllRevShares(
// Add the rev share ppm to the total for the fee source
feeSourceToRevSharePpm[revShare.RevShareFeeSource] += revShare.RevSharePpm
}

// Check total fees shared is less than or equal to net fees
if totalFeesShared.Cmp(netFees) > 0 {
k.Logger(ctx).Error(
"Total fees exceed net fees. Total fees: ", totalFeesShared,
"Net fees: ", netFees,
"Revshares generated: ", revShares)
return types.RevSharesForFill{}, types.ErrTotalFeesSharedExceedsNetFees
}

Expand Down
218 changes: 218 additions & 0 deletions protocol/x/revshare/keeper/revshare_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -652,6 +652,224 @@ func TestKeeper_GetAllRevShares_Valid(t *testing.T) {
require.NoError(t, err)
},
},
{
name: "Valid taker order router rev share with unconditional rev share",
expectedRevSharesForFill: types.RevSharesForFill{
AllRevShares: []types.RevShare{
{
Recipient: constants.DaveAccAddress.String(),
RevShareFeeSource: types.REV_SHARE_FEE_SOURCE_TAKER_FEE,
RevShareType: types.REV_SHARE_TYPE_ORDER_ROUTER,
QuoteQuantums: big.NewInt(175_000),
RevSharePpm: 500_000, // 50%
},
{
Recipient: constants.BobAccAddress.String(),
RevShareFeeSource: types.REV_SHARE_FEE_SOURCE_NET_PROTOCOL_REVENUE,
RevShareType: types.REV_SHARE_TYPE_UNCONDITIONAL,
QuoteQuantums: big.NewInt(87_500),
RevSharePpm: 500_000, // 50%
},
{
Recipient: constants.CarlAccAddress.String(),
RevShareFeeSource: types.REV_SHARE_FEE_SOURCE_NET_PROTOCOL_REVENUE,
RevShareType: types.REV_SHARE_TYPE_UNCONDITIONAL,
QuoteQuantums: big.NewInt(17_500),
RevSharePpm: 100_000, // 20%
},
},
FeeSourceToQuoteQuantums: map[types.RevShareFeeSource]*big.Int{
types.REV_SHARE_FEE_SOURCE_NET_PROTOCOL_REVENUE: big.NewInt(105_000),
types.REV_SHARE_FEE_SOURCE_TAKER_FEE: big.NewInt(175_000),
types.REV_SHARE_FEE_SOURCE_MAKER_FEE: big.NewInt(0),
},
FeeSourceToRevSharePpm: map[types.RevShareFeeSource]uint32{
types.REV_SHARE_FEE_SOURCE_NET_PROTOCOL_REVENUE: 600_000, // 60%
types.REV_SHARE_FEE_SOURCE_TAKER_FEE: 500_000, // 50%
types.REV_SHARE_FEE_SOURCE_MAKER_FEE: 0,
},
AffiliateRevShare: nil,
},
fill: clobtypes.FillForProcess{
TakerAddr: constants.AliceAccAddress.String(),
TakerFeeQuoteQuantums: big.NewInt(450_000),
MakerAddr: constants.BobAccAddress.String(),
MakerFeeQuoteQuantums: big.NewInt(-100_000),
FillQuoteQuantums: big.NewInt(100_000_000),
ProductId: perpetualId,
MarketId: marketId,
MonthlyRollingTakerVolumeQuantums: 1_000_000_000_000,
TakerOrderRouterAddr: constants.DaveAccAddress.String(),
},
setup: func(tApp *testapp.TestApp, ctx sdk.Context, keeper *keeper.Keeper,
affiliatesKeeper *affiliateskeeper.Keeper) {
keeper.SetUnconditionalRevShareConfigParams(ctx, types.UnconditionalRevShareConfig{
Configs: []types.UnconditionalRevShareConfig_RecipientConfig{
{
Address: constants.BobAccAddress.String(),
SharePpm: 500_000, // 20%
},
{
Address: constants.CarlAccAddress.String(),
SharePpm: 100_000, // 10%
},
},
})
// Set order router rev shares
err := keeper.SetOrderRouterRevShare(ctx, constants.DaveAccAddress.String(), 500_000) // 10%
require.NoError(t, err)
},
},
{
name: "Valid taker order router rev share with unconditional rev share and maker fee " +
"rebate and maker order router rev share",
expectedRevSharesForFill: types.RevSharesForFill{
AllRevShares: []types.RevShare{
{
Recipient: constants.DaveAccAddress.String(),
RevShareFeeSource: types.REV_SHARE_FEE_SOURCE_TAKER_FEE,
RevShareType: types.REV_SHARE_TYPE_ORDER_ROUTER,
QuoteQuantums: big.NewInt(225_000),
RevSharePpm: 500_000, // 50%
},
{
Recipient: constants.BobAccAddress.String(),
RevShareFeeSource: types.REV_SHARE_FEE_SOURCE_NET_PROTOCOL_REVENUE,
RevShareType: types.REV_SHARE_TYPE_UNCONDITIONAL,
QuoteQuantums: big.NewInt(162_500), // 50% * ((taker + maker) - taker ORRS)
RevSharePpm: 500_000, // 50%
},
{
Recipient: constants.CarlAccAddress.String(),
RevShareFeeSource: types.REV_SHARE_FEE_SOURCE_NET_PROTOCOL_REVENUE,
RevShareType: types.REV_SHARE_TYPE_UNCONDITIONAL,
QuoteQuantums: big.NewInt(32_500),
RevSharePpm: 100_000, // 10%
},
},
FeeSourceToQuoteQuantums: map[types.RevShareFeeSource]*big.Int{
types.REV_SHARE_FEE_SOURCE_NET_PROTOCOL_REVENUE: big.NewInt(195_000),
types.REV_SHARE_FEE_SOURCE_TAKER_FEE: big.NewInt(225_000),
types.REV_SHARE_FEE_SOURCE_MAKER_FEE: big.NewInt(0),
},
FeeSourceToRevSharePpm: map[types.RevShareFeeSource]uint32{
types.REV_SHARE_FEE_SOURCE_NET_PROTOCOL_REVENUE: 600_000, // 60%
types.REV_SHARE_FEE_SOURCE_TAKER_FEE: 500_000, // 50%
types.REV_SHARE_FEE_SOURCE_MAKER_FEE: 0,
},
AffiliateRevShare: nil,
},
fill: clobtypes.FillForProcess{
TakerAddr: constants.AliceAccAddress.String(),
TakerFeeQuoteQuantums: big.NewInt(450_000),
MakerAddr: constants.BobAccAddress.String(),
MakerFeeQuoteQuantums: big.NewInt(100_000),
FillQuoteQuantums: big.NewInt(100_000_000),
ProductId: perpetualId,
MarketId: marketId,
MonthlyRollingTakerVolumeQuantums: 1_000_000_000_000,
TakerOrderRouterAddr: constants.DaveAccAddress.String(),
},
setup: func(tApp *testapp.TestApp, ctx sdk.Context, keeper *keeper.Keeper,
affiliatesKeeper *affiliateskeeper.Keeper) {
keeper.SetUnconditionalRevShareConfigParams(ctx, types.UnconditionalRevShareConfig{
Configs: []types.UnconditionalRevShareConfig_RecipientConfig{
{
Address: constants.BobAccAddress.String(),
SharePpm: 500_000, // 50%
},
{
Address: constants.CarlAccAddress.String(),
SharePpm: 100_000, // 10%
},
},
})
// Set order router rev shares
err := keeper.SetOrderRouterRevShare(ctx, constants.DaveAccAddress.String(), 500_000) // 50%
require.NoError(t, err)
err = keeper.SetOrderRouterRevShare(ctx, constants.AliceAccAddress.String(), 500_000) // 50%
require.NoError(t, err)
},
},
{
name: "Valid taker order router rev share with unconditional rev share and maker fee " +
"rebate and maker order router rev share",
expectedRevSharesForFill: types.RevSharesForFill{
AllRevShares: []types.RevShare{
{
Recipient: constants.DaveAccAddress.String(),
RevShareFeeSource: types.REV_SHARE_FEE_SOURCE_TAKER_FEE,
RevShareType: types.REV_SHARE_TYPE_ORDER_ROUTER,
QuoteQuantums: big.NewInt(225_000),
RevSharePpm: 500_000, // 50%
},
{
Recipient: constants.AliceAccAddress.String(),
RevShareFeeSource: types.REV_SHARE_FEE_SOURCE_MAKER_FEE,
RevShareType: types.REV_SHARE_TYPE_ORDER_ROUTER,
QuoteQuantums: big.NewInt(50_000),
RevSharePpm: 500_000, // 50%
},
{
Recipient: constants.BobAccAddress.String(),
RevShareFeeSource: types.REV_SHARE_FEE_SOURCE_NET_PROTOCOL_REVENUE,
RevShareType: types.REV_SHARE_TYPE_UNCONDITIONAL,
QuoteQuantums: big.NewInt(137_500),
RevSharePpm: 500_000, // 50%
},
{
Recipient: constants.CarlAccAddress.String(),
RevShareFeeSource: types.REV_SHARE_FEE_SOURCE_NET_PROTOCOL_REVENUE,
RevShareType: types.REV_SHARE_TYPE_UNCONDITIONAL,
QuoteQuantums: big.NewInt(27_500),
RevSharePpm: 100_000, // 20%
},
},
FeeSourceToQuoteQuantums: map[types.RevShareFeeSource]*big.Int{
types.REV_SHARE_FEE_SOURCE_NET_PROTOCOL_REVENUE: big.NewInt(165_000),
types.REV_SHARE_FEE_SOURCE_TAKER_FEE: big.NewInt(225_000),
types.REV_SHARE_FEE_SOURCE_MAKER_FEE: big.NewInt(50_000),
},
FeeSourceToRevSharePpm: map[types.RevShareFeeSource]uint32{
types.REV_SHARE_FEE_SOURCE_NET_PROTOCOL_REVENUE: 600_000, // 60%
types.REV_SHARE_FEE_SOURCE_TAKER_FEE: 500_000, // 50%
types.REV_SHARE_FEE_SOURCE_MAKER_FEE: 500_000, // 50%
},
AffiliateRevShare: nil,
},
fill: clobtypes.FillForProcess{
TakerAddr: constants.AliceAccAddress.String(),
TakerFeeQuoteQuantums: big.NewInt(450_000),
MakerAddr: constants.BobAccAddress.String(),
MakerFeeQuoteQuantums: big.NewInt(100_000),
FillQuoteQuantums: big.NewInt(100_000_000),
ProductId: perpetualId,
MarketId: marketId,
MonthlyRollingTakerVolumeQuantums: 1_000_000_000_000,
TakerOrderRouterAddr: constants.DaveAccAddress.String(),
MakerOrderRouterAddr: constants.AliceAccAddress.String(),
},
setup: func(tApp *testapp.TestApp, ctx sdk.Context, keeper *keeper.Keeper,
affiliatesKeeper *affiliateskeeper.Keeper) {
keeper.SetUnconditionalRevShareConfigParams(ctx, types.UnconditionalRevShareConfig{
Configs: []types.UnconditionalRevShareConfig_RecipientConfig{
{
Address: constants.BobAccAddress.String(),
SharePpm: 500_000, // 50%
},
{
Address: constants.CarlAccAddress.String(),
SharePpm: 100_000, // 10%
},
},
})
// Set order router rev shares
err := keeper.SetOrderRouterRevShare(ctx, constants.DaveAccAddress.String(), 500_000) // 50%
require.NoError(t, err)
err = keeper.SetOrderRouterRevShare(ctx, constants.AliceAccAddress.String(), 500_000) // 50%
require.NoError(t, err)
},
},
{
name: "Valid revenue share with whitelisted affiliate and no unconditional rev shares",
expectedRevSharesForFill: types.RevSharesForFill{
Expand Down
Loading