comments

protocol/x/clob/keeper/orders.go

@@ -487,6 +487,9 @@ func (k Keeper) AddPreexistingStatefulOrder(
 // PlaceStatefulOrdersFromLastBlock validates and places stateful orders from the last block onto the memclob.
 // Note that stateful orders could fail to be placed due to various reasons such as collateralization
 // check failures, self-trade errors, etc. In these cases the `checkState` will not be written to.
+// Note that this function also takes in a postOnlyFilter variable and only places post-only orders if
+// postOnlyFilter is true and non-post-only orders if postOnlyFilter is false.
+//
 // This function is used in:
 // 1. `PrepareCheckState` to place newly placed long term orders from the last
 // block from ProcessProposerMatchesEvents.PlacedStatefulOrderIds. This is step 3 in PrepareCheckState.
@@ -496,7 +499,7 @@ func (k Keeper) PlaceStatefulOrdersFromLastBlock(
 	ctx sdk.Context,
 	placedStatefulOrderIds []types.OrderId,
 	existingOffchainUpdates *types.OffchainUpdates,
-	onlyPlacePostOnly bool,
+	postOnlyFilter bool,
 ) (
 	offchainUpdates *types.OffchainUpdates,
 ) {
@@ -523,8 +526,8 @@ func (k Keeper) PlaceStatefulOrdersFromLastBlock(
 
 		order := orderPlacement.GetOrder()
 
-		// Skip the order if it is a post-only order and we are only placing post-only orders.
-		if onlyPlacePostOnly != order.IsPostOnlyOrder() {
+		// Skip post-only orders if postOnlyFilter is false or non-post-only orders if postOnlyFilter is true.
+		if postOnlyFilter != order.IsPostOnlyOrder() {
 			continue
 		}
 
@@ -582,11 +585,14 @@ func (k Keeper) PlaceStatefulOrdersFromLastBlock(
 // PlaceConditionalOrdersTriggeredInLastBlock takes in a list of conditional order ids that were triggered
 // in the last block, verifies they are conditional orders, verifies they are in triggered state, and places
 // the orders on the memclob.
+//
+// Note that this function also takes in a postOnlyFilter variable and only places post-only orders if
+// postOnlyFilter is true and non-post-only orders if postOnlyFilter is false.
 func (k Keeper) PlaceConditionalOrdersTriggeredInLastBlock(
 	ctx sdk.Context,
 	conditionalOrderIdsTriggeredInLastBlock []types.OrderId,
 	existingOffchainUpdates *types.OffchainUpdates,
-	onlyPlacePostOnly bool,
+	postOnlyFilter bool,
 ) (
 	offchainUpdates *types.OffchainUpdates,
 ) {
@@ -620,7 +626,7 @@ func (k Keeper) PlaceConditionalOrdersTriggeredInLastBlock(
 		ctx,
 		conditionalOrderIdsTriggeredInLastBlock,
 		existingOffchainUpdates,
-		onlyPlacePostOnly,
+		postOnlyFilter,
 	)
 }
 

protocol/x/clob/keeper/orders_test.go

@@ -2250,36 +2250,36 @@ func TestPlaceStatefulOrdersFromLastBlock(t *testing.T) {
 
 func TestPlaceStatefulOrdersFromLastBlock_PostOnly(t *testing.T) {
 	tests := map[string]struct {
-		orders            []types.Order
-		onlyPlacePostOnly bool
+		orders         []types.Order
+		postOnlyFilter bool
 
 		expectedOrderPlacementCalls []types.Order
 	}{
-		"places PO stateful orders from last block when onlyPlacePostOnly = true": {
-			onlyPlacePostOnly: true,
+		"places PO stateful orders from last block when postOnlyFilter = true": {
+			postOnlyFilter: true,
 			orders: []types.Order{
 				constants.LongTermOrder_Alice_Num0_Id0_Clob0_Buy5_Price10_GTBT5_PO,
 			},
 			expectedOrderPlacementCalls: []types.Order{
 				constants.LongTermOrder_Alice_Num0_Id0_Clob0_Buy5_Price10_GTBT5_PO,
 			},
 		},
-		"does not places non-PO stateful orders when onlyPlacePostOnly = true": {
-			onlyPlacePostOnly: true,
+		"does not places non-PO stateful orders when postOnlyFilter = true": {
+			postOnlyFilter: true,
 			orders: []types.Order{
 				constants.LongTermOrder_Alice_Num0_Id0_Clob0_Buy5_Price10_GTBT5,
 			},
 			expectedOrderPlacementCalls: []types.Order{},
 		},
-		"does not places PO stateful orders from last block, when onlyPlacePostOnly = false": {
-			onlyPlacePostOnly: false,
+		"does not places PO stateful orders from last block, when postOnlyFilter = false": {
+			postOnlyFilter: false,
 			orders: []types.Order{
 				constants.LongTermOrder_Alice_Num0_Id0_Clob0_Buy5_Price10_GTBT5_PO,
 			},
 			expectedOrderPlacementCalls: []types.Order{},
 		},
-		"places non-PO stateful orders from last block when onlyPlacePostOnly = false": {
-			onlyPlacePostOnly: false,
+		"places non-PO stateful orders from last block when postOnlyFilter = false": {
+			postOnlyFilter: false,
 			orders: []types.Order{
 				constants.LongTermOrder_Alice_Num0_Id0_Clob0_Buy5_Price10_GTBT5,
 			},
@@ -2350,7 +2350,7 @@ func TestPlaceStatefulOrdersFromLastBlock_PostOnly(t *testing.T) {
 			for _, order := range tc.orders {
 				orderIds = append(orderIds, order.OrderId)
 			}
-			ks.ClobKeeper.PlaceStatefulOrdersFromLastBlock(ctx, orderIds, offchainUpdates, tc.onlyPlacePostOnly)
+			ks.ClobKeeper.PlaceStatefulOrdersFromLastBlock(ctx, orderIds, offchainUpdates, tc.postOnlyFilter)
 
 			// PlaceStatefulOrdersFromLastBlock utilizes the memclob's PlaceOrder flow, but we
 			// do not want to emit PlaceMessages in offchain events for stateful orders. This assertion

protocol/x/clob/memclob/memclob.go

@@ -874,12 +874,15 @@ func (m *MemClobPriceTimePriority) matchOrder(
 // - Pre-existing stateful orders.
 // - Stateful cancelations.
 // Note that match operations are no-op.
+//
+// Note that this function also takes in a postOnlyFilter variable and only places post-only orders if
+// postOnlyFilter is true and non-post-only orders if postOnlyFilter is false.
 func (m *MemClobPriceTimePriority) ReplayOperations(
 	ctx sdk.Context,
 	localOperations []types.InternalOperation,
 	shortTermOrderTxBytes map[types.OrderHash][]byte,
 	existingOffchainUpdates *types.OffchainUpdates,
-	onlyPlacePostOnly bool,
+	postOnlyFilter bool,
 ) *types.OffchainUpdates {
 	lib.AssertCheckTxMode(ctx)
 
@@ -924,8 +927,8 @@ func (m *MemClobPriceTimePriority) ReplayOperations(
 		case *types.InternalOperation_ShortTermOrderPlacement:
 			order := operation.GetShortTermOrderPlacement().Order
 
-			// Skip the order if it is a post-only order and we are only replaying post-only orders.
-			if onlyPlacePostOnly != order.IsPostOnlyOrder() {
+			// Skip post-only orders if postOnlyFilter is false or non-post-only orders if postOnlyFilter is true.
+			if postOnlyFilter != order.IsPostOnlyOrder() {
 				continue
 			}
 
@@ -1019,8 +1022,8 @@ func (m *MemClobPriceTimePriority) ReplayOperations(
 				continue
 			}
 
-			// Skip the order if it is a post-only order and we are only replaying post-only orders.
-			if onlyPlacePostOnly != statefulOrderPlacement.Order.IsPostOnlyOrder() {
+			// Skip post-only orders if postOnlyFilter is false or non-post-only orders if postOnlyFilter is true.
+			if postOnlyFilter != statefulOrderPlacement.Order.IsPostOnlyOrder() {
 				continue
 			}
 
@@ -1077,8 +1080,8 @@ func (m *MemClobPriceTimePriority) ReplayOperations(
 				continue
 			}
 
-			// Skip the order if it is a post-only order and we are only replaying post-only orders.
-			if onlyPlacePostOnly != statefulOrderPlacement.Order.IsPostOnlyOrder() {
+			// Skip post-only orders if postOnlyFilter is false or non-post-only orders if postOnlyFilter is true.
+			if postOnlyFilter != statefulOrderPlacement.Order.IsPostOnlyOrder() {
 				continue
 			}
 

protocol/x/clob/types/memclob.go

@@ -110,7 +110,7 @@ type MemClob interface {
 		localOperations []InternalOperation,
 		shortTermOrderTxBytes map[OrderHash][]byte,
 		existingOffchainUpdates *OffchainUpdates,
-		onlyPlacePostOnly bool,
+		postOnlyFilter bool,
 	) (offchainUpdates *OffchainUpdates)
 	SetMemclobGauges(
 		ctx sdk.Context,