clean up referrer eligibility check, support placeAndTake/Make referral fees

Author: wphan

programs/drift/src/controller/orders.rs

@@ -72,8 +72,7 @@ use crate::state::state::FeeStructure;
 use crate::state::state::*;
 use crate::state::traits::Size;
 use crate::state::user::{
-    AssetType, Order, OrderBitFlag, OrderStatus, OrderTriggerCondition, OrderType, ReferrerStatus,
-    UserStats,
+    AssetType, Order, OrderBitFlag, OrderStatus, OrderTriggerCondition, OrderType, UserStats,
 };
 use crate::state::user::{MarketType, User};
 use crate::state::user_map::{UserMap, UserStatsMap};
@@ -2285,7 +2284,12 @@ pub fn fulfill_perp_order_with_amm(
         )?;
     }
 
-    let reward_referrer = can_reward_user_with_perp_pnl(referrer, market.market_index);
+    let reward_referrer = can_reward_user_with_referral_reward(
+        referrer,
+        market.market_index,
+        rev_share_escrow,
+        builder_referral_feature_enabled,
+    );
     let reward_filler = can_reward_user_with_perp_pnl(filler, market.market_index)
         || can_reward_user_with_perp_pnl(maker, market.market_index);
 
@@ -2573,7 +2577,7 @@ pub fn fulfill_perp_order_with_match(
     fee_structure: &FeeStructure,
     oracle_map: &mut OracleMap,
     is_liquidation: bool,
-    builder_escrow: &mut Option<&mut RevenueShareEscrowZeroCopyMut>,
+    rev_share_escrow: &mut Option<&mut RevenueShareEscrowZeroCopyMut>,
     builder_referral_feature_enabled: bool,
 ) -> DriftResult<(u64, u64, u64)> {
     if !are_orders_same_market_but_different_sides(
@@ -2687,7 +2691,7 @@ pub fn fulfill_perp_order_with_match(
                 Some(jit_base_asset_amount),
                 Some(maker_price), // match the makers price
                 is_liquidation,
-                builder_escrow,
+                rev_share_escrow,
                 builder_referral_feature_enabled,
             )?;
 
@@ -2781,12 +2785,17 @@ pub fn fulfill_perp_order_with_match(
 
     taker_stats.update_taker_volume_30d(market.fuel_boost_taker, quote_asset_amount, now)?;
 
-    let reward_referrer = can_reward_user_with_perp_pnl(referrer, market.market_index);
+    let reward_referrer = can_reward_user_with_referral_reward(
+        referrer,
+        market.market_index,
+        rev_share_escrow,
+        builder_referral_feature_enabled,
+    );
     let reward_filler = can_reward_user_with_perp_pnl(filler, market.market_index);
 
     let (builder_order_idx, referrer_builder_order_idx, builder_order_fee_bps, builder_idx) =
         get_builder_escrow_info(
-            builder_escrow,
+            rev_share_escrow,
             taker.sub_account_id,
             taker.orders[taker_order_index].order_id,
             market.market_index,
@@ -2825,7 +2834,7 @@ pub fn fulfill_perp_order_with_match(
     )?;
     let builder_fee = builder_fee_option.unwrap_or(0);
 
-    if let (Some(idx), Some(escrow)) = (builder_order_idx, builder_escrow.as_deref_mut()) {
+    if let (Some(idx), Some(escrow)) = (builder_order_idx, rev_share_escrow.as_deref_mut()) {
         let mut order = escrow.get_order_mut(idx)?;
         order.fees_accrued = order.fees_accrued.safe_add(builder_fee)?;
     }
@@ -2887,7 +2896,8 @@ pub fn fulfill_perp_order_with_match(
         filler.update_last_active_slot(slot);
     }
 
-    if let (Some(idx), Some(escrow)) = (referrer_builder_order_idx, builder_escrow.as_deref_mut()) {
+    if let (Some(idx), Some(escrow)) = (referrer_builder_order_idx, rev_share_escrow.as_deref_mut())
+    {
         let mut order = escrow.get_order_mut(idx)?;
         order.fees_accrued = order.fees_accrued.safe_add(referrer_reward)?;
     } else if let (Some(referrer), Some(referrer_stats)) =
@@ -2908,7 +2918,7 @@ pub fn fulfill_perp_order_with_match(
     )?;
 
     if is_filled {
-        if let (Some(idx), Some(escrow)) = (builder_order_idx, builder_escrow.as_deref_mut()) {
+        if let (Some(idx), Some(escrow)) = (builder_order_idx, rev_share_escrow.as_deref_mut()) {
             escrow
                 .get_order_mut(idx)?
                 .add_bit_flag(RevenueShareOrderBitFlag::Completed);
@@ -3432,6 +3442,22 @@ pub fn can_reward_user_with_perp_pnl(user: &mut Option<&mut User>, market_index:
     }
 }
 
+pub fn can_reward_user_with_referral_reward(
+    user: &mut Option<&mut User>,
+    market_index: u16,
+    rev_share_escrow: &mut Option<&mut RevenueShareEscrowZeroCopyMut>,
+    builder_referral_feature_enabled: bool,
+) -> bool {
+    if builder_referral_feature_enabled {
+        if let Some(escrow) = rev_share_escrow {
+            return escrow.find_or_create_referral_index(market_index).is_some();
+        }
+        false
+    } else {
+        can_reward_user_with_perp_pnl(user, market_index)
+    }
+}
+
 pub fn pay_keeper_flat_reward_for_perps(
     user: &mut User,
     filler: Option<&mut User>,

programs/drift/src/controller/revenue_share.rs

@@ -5,9 +5,7 @@ use crate::math::safe_math::SafeMath;
 use crate::math::spot_balance::get_token_amount;
 use crate::state::events::{emit_stack, RevenueShareSettleRecord};
 use crate::state::perp_market_map::PerpMarketMap;
-use crate::state::revenue_share::{
-    RevenueShareEscrowZeroCopyMut, RevenueShareOrder, RevenueShareOrderBitFlag,
-};
+use crate::state::revenue_share::{RevenueShareEscrowZeroCopyMut, RevenueShareOrder};
 use crate::state::revenue_share_map::RevenueShareMap;
 use crate::state::spot_market::SpotBalance;
 use crate::state::spot_market_map::SpotMarketMap;

programs/drift/src/instructions/keeper.rs

@@ -148,7 +148,10 @@ fn fill_order<'c: 'info, 'info>(
     let builder_codes_enabled = state.builder_codes_enabled();
     let builder_referral_enabled = state.builder_referral_enabled();
     let mut escrow = if builder_codes_enabled || builder_referral_enabled {
-        get_revenue_share_escrow_account(&mut remaining_accounts_iter, &load!(ctx.accounts.user)?.authority)?
+        get_revenue_share_escrow_account(
+            &mut remaining_accounts_iter,
+            &load!(ctx.accounts.user)?.authority,
+        )?
     } else {
         None
     };

programs/drift/src/instructions/user.rs

@@ -2473,6 +2473,14 @@ pub fn handle_place_and_take_perp_order<'c: 'info, 'info>(
     let user = &mut ctx.accounts.user;
     let order_id = load!(user)?.get_last_order_id();
 
+    let builder_referral_enabled = state.builder_referral_enabled();
+    let builder_codes_enabled = state.builder_codes_enabled();
+    let mut escrow = if builder_codes_enabled || builder_referral_enabled {
+        get_revenue_share_escrow_account(remaining_accounts_iter, &load!(user)?.authority)?
+    } else {
+        None
+    };
+
     let (base_asset_amount_filled, _) = controller::orders::fill_perp_order(
         order_id,
         &ctx.accounts.state,
@@ -2491,8 +2499,8 @@ pub fn handle_place_and_take_perp_order<'c: 'info, 'info>(
             is_immediate_or_cancel || optional_params.is_some(),
             auction_duration_percentage,
         ),
-        &mut None,
-        false,
+        &mut escrow.as_mut(),
+        builder_referral_enabled,
     )?;
 
     let order_unfilled = load!(ctx.accounts.user)?
@@ -2597,7 +2605,10 @@ pub fn handle_place_and_make_perp_order<'c: 'info, 'info>(
     let builder_referral_enabled = state.builder_referral_enabled();
     let builder_codes_enabled = state.builder_codes_enabled();
     let mut escrow = if builder_codes_enabled || builder_referral_enabled {
-        get_revenue_share_escrow_account(remaining_accounts_iter, &load!(ctx.accounts.taker)?.authority)?
+        get_revenue_share_escrow_account(
+            remaining_accounts_iter,
+            &load!(ctx.accounts.taker)?.authority,
+        )?
     } else {
         None
     };
@@ -2709,7 +2720,10 @@ pub fn handle_place_and_make_signed_msg_perp_order<'c: 'info, 'info>(
     let builder_referral_enabled = state.builder_referral_enabled();
     let builder_codes_enabled = state.builder_codes_enabled();
     let mut escrow = if builder_codes_enabled || builder_referral_enabled {
-        get_revenue_share_escrow_account(remaining_accounts_iter, &load!(ctx.accounts.taker)?.authority)?
+        get_revenue_share_escrow_account(
+            remaining_accounts_iter,
+            &load!(ctx.accounts.taker)?.authority,
+        )?
     } else {
         None
     };

programs/drift/src/math/fees.rs

@@ -1,6 +1,5 @@
 use std::cmp::{max, min};
 
-use anchor_lang::prelude::Pubkey;
 use num_integer::Roots;
 
 use crate::error::DriftResult;

programs/drift/src/state/revenue_share.rs

@@ -63,8 +63,8 @@ pub struct RevenueShareOrder {
     /// [`RevenueShareOrderBitFlag::Open`]: this order slot is occupied, `order_id` is the `sub_account_id`'s active order.
     /// [`RevenueShareOrderBitFlag::Completed`]: this order has been filled or canceled, and is waiting to be settled into.
     /// the builder's account order_id and sub_account_id are no longer relevant, it may be merged with other orders.
-    /// [`RevenueShareOrderBitFlag::Referral`]: this order stores referral rewards waiting to be settled. If it is set, no
-    /// other bitflag should be set.
+    /// [`RevenueShareOrderBitFlag::Referral`]: this order stores referral rewards waiting to be settled for this market.
+    /// If it is set, no other bitflag should be set.
     pub bit_flags: u8,
     /// the index into the User's orders list when this RevenueShareOrder was created, make sure to verify that order_id matches.
     pub user_order_index: u8,
@@ -399,7 +399,8 @@ impl<'a> RevenueShareEscrowZeroCopyMut<'a> {
         None
     }
 
-    /// Returns the index for the referral order, creating one if necessary.
+    /// Returns the index for the referral order, creating one if necessary. Returns None if a new order
+    /// cannot be created.
     pub fn find_or_create_referral_index(&mut self, market_index: u16) -> Option<u32> {
         // look for an existing referral order
         for i in 0..self.orders_len() {
@@ -417,7 +418,7 @@ impl<'a> RevenueShareEscrowZeroCopyMut<'a> {
             0,
             0,
             0,
-            MarketType::Spot,
+            MarketType::Perp,
             market_index,
             RevenueShareOrderBitFlag::Referral as u8,
             0,

sdk/src/driftClient.ts

@@ -6638,6 +6638,15 @@ export class DriftClient {
 			});
 		}
 
+		remainingAccounts.push({
+			pubkey: getRevenueShareEscrowAccountPublicKey(
+				this.program.programId,
+				this.getUserAccount(subAccountId).authority
+			),
+			isWritable: true,
+			isSigner: false,
+		});
+
 		let optionalParams = null;
 		if (auctionDurationPercentage || successCondition) {
 			optionalParams =
@@ -6717,6 +6726,15 @@ export class DriftClient {
 			});
 		}
 
+		remainingAccounts.push({
+			pubkey: getRevenueShareEscrowAccountPublicKey(
+				this.program.programId,
+				takerInfo.takerUserAccount.authority
+			),
+			isWritable: true,
+			isSigner: false,
+		});
+
 		const takerOrderId = takerInfo.order.orderId;
 		return await this.program.instruction.placeAndMakePerpOrder(
 			orderParams,

sdk/src/idl/drift.json

@@ -11280,8 +11280,8 @@
               "[`RevenueShareOrderBitFlag::Open`]: this order slot is occupied, `order_id` is the `sub_account_id`'s active order.",
               "[`RevenueShareOrderBitFlag::Completed`]: this order has been filled or canceled, and is waiting to be settled into.",
               "the builder's account order_id and sub_account_id are no longer relevant, it may be merged with other orders.",
-              "[`RevenueShareOrderBitFlag::Referral`]: this order stores referral rewards waiting to be settled. If it is set, no",
-              "other bitflag should be set."
+              "[`RevenueShareOrderBitFlag::Referral`]: this order stores referral rewards waiting to be settled for this market.",
+              "If it is set, no other bitflag should be set."
             ],
             "type": "u8"
           },