[CLOB-547] IsClobOrderTransaction only filter out Short-Term orders…

…/cancels. (#7)

* generate protos for dydx

* add the matches and tx protos

* add dydx order id logic and constants

* IsClobOrderTransaction => IsShortTermClobOrderTransaction

* disable lint for dydx order id constants

* more specific linter disables

* rename proto package due to global proto registry name clash

* Update import paths for dydx clob types

* helpful text string function for order id

* minor pr comments, no logic changes

* README updates

README.md

@@ -20,6 +20,19 @@ Note that this doesn't pull in upstream tags, so in order to do this follow thes
 1. `git fetch upstream`
 2. `git push --tags`
 
+## dYdX Proto maintenance
+
+In order to support some of our custom functionality, we require some dydx protobuf files to be copied into this repository. Currently, the source of truth for protos is in `dydxprotocol/v4`, and any changes that require updates to any of the protos in this repository should be sync'd over as well. Here are steps for updating and compiling the protos here.
+
+1. Modify the protos in `proto/dydxcometbft`.
+2. `make proto-gen`
+
+Note that the protos cannot be copied over directly. golang protobufs share a global namespace, and we have changed the package name slightly to avoid a name clash.
+
+We've also included a new dependency in the `buf.yaml` file for `"cosmos_proto/cosmos.proto"`. If this needs to be updated, run `buf build`. For more information, read [here](https://github.com/dydxprotocol/v4/tree/main/proto#update-protos).
+
+In the future, we will aim to have a single source of truth for protos.
+
 ## Updating CometBFT to new versions
 
 When a new version of CometBFT is published, we may want to adopt the changes in our fork. This process can be somewhat tedious, but below are the recommended steps to accomplish this.

mempool/dydx_helpers.go

@@ -2,13 +2,15 @@ package mempool
 
 import (
 	"github.com/cometbft/cometbft/libs/log"
+	"github.com/cometbft/cometbft/proto/dydxcometbft/clob"
 	"github.com/cometbft/cometbft/types"
 	cosmostx "github.com/cosmos/cosmos-sdk/types/tx"
 )
 
-// isClobOrderTransaction returns true if the provided `tx` is a
-// Cosmos transaction containing a `MsgPlaceOrder` or `MsgCancelOrder` message.
-func IsClobOrderTransaction(
+// IsShortTermClobOrderTransaction returns true if the provided `tx` is a
+// Cosmos transaction containing a short-term `MsgPlaceOrder` or
+// short-term `MsgCancelOrder` message.
+func IsShortTermClobOrderTransaction(
 	tx types.Tx,
 	mempoolLogger log.Logger,
 ) bool {
@@ -18,12 +20,30 @@ func IsClobOrderTransaction(
 		mempoolLogger.Error("isClobOrderTransaction error. Invalid Cosmos Transaction.")
 		return false
 	}
-
-	if cosmosTx.Body != nil &&
-		len(cosmosTx.Body.Messages) == 1 &&
-		(cosmosTx.Body.Messages[0].TypeUrl == "/dydxprotocol.clob.MsgPlaceOrder" ||
-			cosmosTx.Body.Messages[0].TypeUrl == "/dydxprotocol.clob.MsgCancelOrder") {
-		return true
+	if cosmosTx.Body != nil && len(cosmosTx.Body.Messages) == 1 {
+		bytes := cosmosTx.Body.Messages[0].Value
+		if cosmosTx.Body.Messages[0].TypeUrl == "/dydxprotocol.clob.MsgPlaceOrder" {
+			msgPlaceOrder := &clob.MsgPlaceOrder{}
+			err := msgPlaceOrder.Unmarshal(bytes)
+			// In the case of an unmarshalling error, panic.
+			// Chances are, the protos are out of sync with the dydx v4 repo.
+			if err != nil {
+				panic(
+					"Failed to unmarshal MsgPlaceOrder from Cosmos transaction in CometBFT mempool.",
+				)
+			}
+			return msgPlaceOrder.Order.OrderId.IsShortTermOrder()
+		}
+		if cosmosTx.Body.Messages[0].TypeUrl == "/dydxprotocol.clob.MsgCancelOrder" {
+			msgCancelOrder := &clob.MsgCancelOrder{}
+			err := msgCancelOrder.Unmarshal(bytes)
+			// In the case of an unmarshalling error, panic.
+			// Chances are, the protos are out of sync with the dydx v4 repo.
+			if err != nil {
+				panic("Failed to unmarshal MsgCancelOrder from Cosmos transaction.")
+			}
+			return msgCancelOrder.OrderId.IsShortTermOrder()
+		}
 	}
 
 	return false

mempool/v0/clist_mempool.go

@@ -420,14 +420,14 @@ func (mem *CListMempool) resCbFirstTime(
 				"total", mem.Size(),
 			)
 
-			// If this transaction is a `PlaceOrder` or `CancelOrder` transaction,
+			// If this transaction is a short term `PlaceOrder` or `CancelOrder` transaction,
 			// don't call `notifyTxsAvailable()`. The `notifyTxsAvailable()` function
 			// uses a channel in the mempool called `txsAvailable` to signal to the
 			// consensus algorithm that transactions are available to be included in
 			// the next proposal. If no transactions are available for inclusion in
 			// the next proposal, the consensus algorithm will wait for `create_empty_blocks_interval`
 			// before proposing an empty block instead.
-			if mempool.IsClobOrderTransaction(memTx.tx, mem.logger) {
+			if mempool.IsShortTermClobOrderTransaction(memTx.tx, mem.logger) {
 				return
 			}
 
@@ -560,9 +560,10 @@ func (mem *CListMempool) ReapMaxBytesMaxGas(maxBytes, maxGas int64) types.Txs {
 	for e := mem.txs.Front(); e != nil; e = e.Next() {
 		memTx := e.Value.(*mempoolTx)
 
-		// If this transaction is Cosmos transaction containing a `PlaceOrder` or `CancelOrder` message,
+		// If this transaction is Cosmos transaction containing a
+		// short term `PlaceOrder` or `CancelOrder` message,
 		// don't include it in the next proposed block.
-		if mempool.IsClobOrderTransaction(memTx.tx, mem.logger) {
+		if mempool.IsShortTermClobOrderTransaction(memTx.tx, mem.logger) {
 			continue
 		}
 
@@ -677,9 +678,10 @@ func (mem *CListMempool) recheckTxs() {
 
 	for e := mem.txs.Front(); e != nil; e = e.Next() {
 		memTx := e.Value.(*mempoolTx)
-		// If this transaction is Cosmos transaction containing a `PlaceOrder` or `CancelOrder` message,
+		// If this transaction is Cosmos transaction containing a
+		// short term `PlaceOrder` or `CancelOrder` message,
 		// remove it from the mempool instead of rechecking.
-		if mempool.IsClobOrderTransaction(memTx.tx, mem.logger) {
+		if mempool.IsShortTermClobOrderTransaction(memTx.tx, mem.logger) {
 			mem.removeTx(memTx.tx, e, false)
 		}
 	}

mempool/v1/mempool.go

@@ -303,9 +303,10 @@ func (txmp *TxMempool) allEntriesSorted() []*WrappedTx {
 	for _, tx := range txmp.txByKey {
 		w := tx.Value.(*WrappedTx)
 
-		// If this transaction is Cosmos transaction containing a `PlaceOrder` or `CancelOrder` message,
+		// If this transaction is Cosmos transaction containing a
+		// short term `PlaceOrder` or `CancelOrder` message,
 		// don't include it in the list of transactions.
-		if mempool.IsClobOrderTransaction(w.tx, txmp.logger) {
+		if mempool.IsShortTermClobOrderTransaction(w.tx, txmp.logger) {
 			continue
 		}
 
@@ -681,9 +682,10 @@ func (txmp *TxMempool) recheckTransactions() {
 		next := e.Next()
 
 		wtx := e.Value.(*WrappedTx)
-		// If this transaction is Cosmos transaction containing a `PlaceOrder` or `CancelOrder` message,
+		// If this transaction is Cosmos transaction containing a
+		// short term `PlaceOrder` or `CancelOrder` message,
 		// remove it from the mempool instead of rechecking.
-		if mempool.IsClobOrderTransaction(wtx.tx, txmp.logger) {
+		if mempool.IsShortTermClobOrderTransaction(wtx.tx, txmp.logger) {
 			txmp.removeTxByElement(e)
 		} else {
 			wtxs = append(wtxs, wtx)

proto/buf.lock

@@ -1,7 +1,13 @@
 # Generated by buf. DO NOT EDIT.
 version: v1
 deps:
+  - remote: buf.build
+    owner: cosmos
+    repository: cosmos-proto
+    commit: 1935555c206d4afb9e94615dfd0fad31
+    digest: shake256:c74d91a3ac7ae07d579e90eee33abf9b29664047ac8816500cf22c081fec0d72d62c89ce0bebafc1f6fec7aa5315be72606717740ca95007248425102c365377
   - remote: buf.build
     owner: cosmos
     repository: gogo-proto
-    commit: 6652e3443c3b4504bb3bf82e73a7e409
+    commit: 5e5b9fdd01804356895f8f79a6f1ddc1
+    digest: shake256:0b85da49e2e5f9ebc4806eae058e2f56096ff3b1c59d1fb7c190413dd15f45dd456f0b69ced9059341c80795d2b6c943de15b120a9e0308b499e43e4b5fc2952

proto/buf.yaml

@@ -1,6 +1,8 @@
 version: v1
 deps:
   - buf.build/cosmos/gogo-proto
+    # Latest release was in Dec 2021, https://buf.build/cosmos/cosmos-proto/commits/main
+  - buf.build/cosmos/cosmos-proto:1935555c206d4afb9e94615dfd0fad31
 breaking:
   use:
     - FILE