[CT-517] E2E tests batch cancel #1149
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
WalkthroughThese updates introduce new order declarations for testing different trading scenarios and enhance the exchange's order cancellation feature. By adding specific orders for users like Alice and Bob, the changes allow for more detailed and scenario-specific testing. Additionally, the batch cancellation tests and the correction in the order cancellation logic improve the reliability and functionality of the exchange, ensuring that off-chain updates are correctly emitted and that successful cancellations are accurately tracked. Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
jonfung-dydx
commented
Mar 6, 2024
| @@ -109,11 +109,10 @@ func (k Keeper) BatchCancelShortTermOrder( | |||
| log.Error, err, | |||
| ) | |||
| } else { | |||
| success = append(failure, clientId) | |||
| success = append(success, clientId) | |||
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files selected for processing (3)
- protocol/testutil/constants/orders.go (3 hunks)
- protocol/x/clob/e2e/batch_cancel_test.go (2 hunks)
- protocol/x/clob/keeper/orders.go (1 hunks)
Additional comments: 9
protocol/x/clob/e2e/batch_cancel_test.go (5)
- 4-19: The addition of new package imports is necessary for the functionality being tested. It's good practice to ensure that these imports are used efficiently and that there are no unused imports to keep the code clean.
- 294-337: The variable declarations for test orders are well-defined and cover a variety of scenarios. This thorough setup is essential for comprehensive testing of batch cancellation functionality. Ensure that these test orders are representative of real-world scenarios to maximize the effectiveness of the tests.
- 1-22: > 📝 NOTE
This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [19-293]
The
TestBatchCancelSingleCancelFunctionalityfunction follows best practices for table-driven tests and covers a variety of scenarios for single order cancellations in batch mode. This thorough approach ensures comprehensive testing of the functionality. Consider adding comments to each test case to briefly explain the scenario being tested, enhancing readability and maintainability.
- 339-594: The
TestBatchCancelBatchFunctionalityfunction effectively tests a wide range of scenarios for batch cancellations, using a table-driven approach. This method ensures that the functionality is thoroughly tested under various conditions. As with the previous function, adding comments to explain each scenario would improve readability and maintainability.- 596-819: The
TestBatchCancelOffchainUpdatesfunction correctly tests the emission of offchain updates following batch cancellations. UsingElementsMatchto verify the offchain messages is appropriate, as it accounts for potential variations in message order. This test is crucial for ensuring that offchain systems are accurately informed of state changes within the protocol.protocol/x/clob/keeper/orders.go (1)
- 112-112: The change made here corrects the logic by appending
clientIdto thesuccessslice instead of thefailureslice in theBatchCancelShortTermOrderfunction. This adjustment ensures that the system accurately reflects the outcomes of cancellation requests.protocol/testutil/constants/orders.go (3)
- 200-213: The addition of
Order_Alice_Num1_Id2_Clob1_Buy10_Price10_GTB20andOrder_Alice_Num1_Id2_Clob1_Buy10_Price10_GTB26introduces new buy orders for Alice with identical parameters except for theGoodTilBlockvalue. This variation in expiration blocks is crucial for testing different expiry scenarios. Ensure that these new orders are integrated into the test cases that specifically aim to verify behavior around order expiration.- 382-395: The addition of
Order_Alice_Num1_Id3_Clob0_Sell100_Price100000_GTB20andOrder_Alice_Num1_Id5_Clob1_Buy10_Price15_GTB23introduces a high-value sell order and a standard buy order with a uniqueGoodTilBlockvalue. It's important to verify that the high-value sell order (100_000_000_000subticks) is correctly handled by the system, especially in terms of precision and overflow checks. Additionally, the uniqueGoodTilBlockvalue in the buy order should be tested for correct expiry behavior.- 1511-1518: The addition of
Order_Alice_Num1_Id4_Clob1_Sell10_Price15_GTB20_POintroduces a new post-only sell order for Alice. This type of order is crucial for testing the exchange's handling of orders that should only be added to the book if they do not immediately match and execute. Ensure that the post-only flag (TimeInForce: clobtypes.Order_TIME_IN_FORCE_POST_ONLY) is correctly respected by the order matching engine and that such orders are either correctly placed in the order book or rejected if they would immediately match.
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files selected for processing (1)
- protocol/x/clob/e2e/batch_cancel_test.go (2 hunks)
Files skipped from review as they are similar to previous changes (1)
- protocol/x/clob/e2e/batch_cancel_test.go
jayy04
reviewed
Mar 7, 2024
| constants.Order_Alice_Num1_Id1_Clob1_Sell10_Price15_GTB20.OrderId: 25, | ||
| constants.Order_Alice_Num1_Id3_Clob0_Sell100_Price100000_GTB20.OrderId: 25, | ||
| }, | ||
| }, |
There was a problem hiding this comment.
can we add a test for
- cancelling non existent orders
- cancel then place order with higher gtb should succeed
jayy04
approved these changes
Mar 7, 2024
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files selected for processing (2)
- protocol/testutil/constants/orders.go (3 hunks)
- protocol/x/clob/e2e/batch_cancel_test.go (2 hunks)
Files skipped from review as they are similar to previous changes (2)
- protocol/testutil/constants/orders.go
- protocol/x/clob/e2e/batch_cancel_test.go
Eric-Warehime
pushed a commit
to skip-mev/v4-chain
that referenced
this pull request
Mar 12, 2024
* more end to end test * extraprint * more e2e test Signed-off-by: Eric <[email protected]>
Eric-Warehime
added a commit
to skip-mev/v4-chain
that referenced
this pull request
Mar 12, 2024
commit d98f859 Author: Eric <[email protected]> Date: Mon Mar 11 12:46:53 2024 -0700 Update sample pregenesis Signed-off-by: Eric <[email protected]> commit 7f178fe Author: Mohammed Affan <[email protected]> Date: Mon Mar 11 13:46:08 2024 -0400 [OTE-209] Emit metrics gated through execution mode (dydxprotocol#1157) Signed-off-by: Eric <[email protected]> commit 47e365d Author: dydxwill <[email protected]> Date: Mon Mar 11 13:43:16 2024 -0400 add aggregate comlink response code stats (dydxprotocol#1162) Signed-off-by: Eric <[email protected]> commit 7774ad9 Author: shrenujb <[email protected]> Date: Fri Mar 8 17:30:49 2024 -0500 [TRA-70] Add state migrations for isolated markets (dydxprotocol#1155) Signed-off-by: Shrenuj Bansal <[email protected]> Signed-off-by: Eric <[email protected]> commit 89c7405 Author: Jonathan Fung <[email protected]> Date: Thu Mar 7 17:28:06 2024 -0500 [CT-517] E2E tests batch cancel (dydxprotocol#1149) * more end to end test * extraprint * more e2e test Signed-off-by: Eric <[email protected]> commit 41a3a41 Author: Teddy Ding <[email protected]> Date: Thu Mar 7 15:42:30 2024 -0500 [OTE-200] OIMF protos (dydxprotocol#1125) * OIMF protos * add default genesis value, modify methods interface * fix genesis file * fix integration test * lint Signed-off-by: Eric <[email protected]> commit 2a062b1 Author: Teddy Ding <[email protected]> Date: Thu Mar 7 15:24:15 2024 -0500 Add `v5` upgrade handler and set up container upgrade test (dydxprotocol#1153) * wip * update preupgrade_genesis * fix preupgrade_genesis.json * nit * setupUpgradeStoreLoaders for v5.0.0 Signed-off-by: Eric <[email protected]> commit b7942b3 Author: jayy04 <[email protected]> Date: Thu Mar 7 13:43:48 2024 -0500 [CT-647] construct the initial orderbook snapshot (dydxprotocol#1147) * [CT-647] construct the initial orderbook snapshot * [CT-647] initialize new streams and send orderbook snapshot (dydxprotocol#1152) * [CT-647] initialize new streams and send orderbook snapshot * use sync once * comments Signed-off-by: Eric <[email protected]> commit c67a3c6 Author: shrenujb <[email protected]> Date: Thu Mar 7 12:40:37 2024 -0500 [TRA-84] Move SA module address transfers to use perpetual based SA accounts (dydxprotocol#1146) Signed-off-by: Shrenuj Bansal <[email protected] Signed-off-by: Eric <[email protected]> commit dba23e0 Author: Mohammed Affan <[email protected]> Date: Thu Mar 7 10:34:11 2024 -0500 update readme link to point to the right page (dydxprotocol#1151) Signed-off-by: Eric <[email protected]> commit b5870d5 Author: Tian <[email protected]> Date: Wed Mar 6 16:43:04 2024 -0500 [TRA-86] scaffold x/vault (dydxprotocol#1148) * scaffold x/vault Signed-off-by: Eric <[email protected]> commit 0eca041 Author: jayy04 <[email protected]> Date: Wed Mar 6 10:48:42 2024 -0500 [CT-652] add command line flag for full node streaming (dydxprotocol#1145) Signed-off-by: Eric <[email protected]> commit b319cb8 Author: jayy04 <[email protected]> Date: Tue Mar 5 21:58:35 2024 -0500 [CT-646] stream offchain updates through stream manager (dydxprotocol#1138) * [CT-646] stream offchain updates through stream manager * comments * fix lint * get rid of finished * comments * comments Signed-off-by: Eric <[email protected]> commit 1c54620 Author: shrenujb <[email protected]> Date: Tue Mar 5 16:34:19 2024 -0500 [TRA-78] Add function to retrieve collateral pool addr for a subaccount (dydxprotocol#1142) Signed-off-by: Shrenuj Bansal <[email protected]> Signed-off-by: Eric <[email protected]> commit b8c1d62 Author: dydxwill <[email protected]> Date: Tue Mar 5 15:03:28 2024 -0500 [OTE-141] implement post /compliance/geoblock (dydxprotocol#1129) Signed-off-by: Eric <[email protected]> commit ab8c570 Author: Jonathan Fung <[email protected]> Date: Tue Mar 5 11:19:53 2024 -0500 Fix mock-gen dydxprotocol#1140 Signed-off-by: Eric <[email protected]> commit 12506a1 Author: shrenujb <[email protected]> Date: Mon Mar 4 21:33:28 2024 -0500 [TRA-64] Use market specific insurance fund for cross or isolated markets (dydxprotocol#1132) Signed-off-by: Shrenuj Bansal <[email protected]> Signed-off-by: Eric <[email protected]> commit 929f09e Author: Jonathan Fung <[email protected]> Date: Mon Mar 4 13:48:04 2024 -0800 [CT-514] Clob `MsgBatchCancel` functionality (dydxprotocol#1110) * wip implementation * use new cometbft * Revert "use new cometbft" This reverts commit e5b8a03. * go mod tidy * basic e2e test * more msgBatchCancels in code * repeated fixed32 -> uint32 * remove debug prints * update cometbft replace go.mod sha * one more debug print * typo * regen indexer protos * update comment on proto * proto comment changes * extract stateful validation into own fn * pr format comments * clean up test file * new return type with success and failure Signed-off-by: Eric <[email protected]> commit 41de83e Author: dydxwill <[email protected]> Date: Mon Mar 4 12:22:16 2024 -0500 add index to address read replica lag (dydxprotocol#1137) Signed-off-by: Eric <[email protected]> commit 735d9a8 Author: dydxwill <[email protected]> Date: Mon Mar 4 11:56:59 2024 -0500 rename (dydxprotocol#1136) Signed-off-by: Eric <[email protected]> commit 86617dd Author: jayy04 <[email protected]> Date: Mon Mar 4 10:43:31 2024 -0500 [CT-644] instantiate grpc stream manager (dydxprotocol#1134) * [CT-644] instantiate grpc stream manager * update type * update channel type Signed-off-by: Eric <[email protected]> commit 32afd64 Author: Eric <[email protected]> Date: Mon Mar 11 12:41:06 2024 -0700 Update go version in Dockerfile Signed-off-by: Eric <[email protected]> commit ba27204 Author: Eric <[email protected]> Date: Fri Mar 8 09:44:04 2024 -0800 Add slinky utils, use that to convert between market and currency pair commit 667a804 Author: Eric <[email protected]> Date: Wed Mar 6 20:43:40 2024 -0800 Update error messages commit d53292c Author: Eric <[email protected]> Date: Wed Mar 6 20:16:01 2024 -0800 Update docstrings, rename OracleClient commit daad125 Author: Eric <[email protected]> Date: Mon Mar 4 10:51:23 2024 -0800 VoteExtension slinky logic
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
add some of those e2e tests.