FNS protos - add taker order in stream update oneof #2021
Conversation
WalkthroughThe recent changes enhance the Changes
Poem
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 Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (3)
proto/dydxprotocol/clob/query.proto (1)
181-185: Add documentation forStreamTakerOrderStatus.The new
StreamTakerOrderStatusfield has been added to theoneofblock. Ensure that this field is well-documented to provide clarity on its usage and significance.indexer/packages/v4-protos/src/codegen/dydxprotocol/clob/query.ts (2)
290-290: Add documentation fortakerOrderStatus.The new
takerOrderStatusfield has been added to theStreamUpdateinterface. Ensure that this field is well-documented to provide clarity on its usage and significance.
306-306: Add documentation fortaker_order_status.The new
taker_order_statusfield has been added to theStreamUpdateSDKTypeinterface. Ensure that this field is well-documented to provide clarity on its usage and significance.
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (1)
protocol/x/clob/types/query.pb.gois excluded by!**/*.pb.go
Files selected for processing (2)
- indexer/packages/v4-protos/src/codegen/dydxprotocol/clob/query.ts (6 hunks)
- proto/dydxprotocol/clob/query.proto (1 hunks)
Additional comments not posted (4)
proto/dydxprotocol/clob/query.proto (1)
189-192: Verify field renumbering consistency.The
block_heightfield has been renumbered from 3 to 4, and theexec_modefield from 4 to 5. Ensure that these changes are reflected consistently across all related code and documentation.Verification successful
Field renumbering consistency verified.
The renumbering of the
block_heightfield from 3 to 4 and theexec_modefield from 4 to 5 is consistent across the related code and documentation.
block_heightappears with different numbers in various contexts, which is expected.exec_modeis correctly numbered as 5 in the relevant file.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify consistency of field renumbering for `block_height` and `exec_mode`. # Test: Search for field usage. Expect: Consistent field numbers across all related code and documentation. rg --type proto -A 3 $'block_height' rg --type proto -A 3 $'exec_mode'Length of output: 128
Script:
#!/bin/bash # Description: Verify consistency of field renumbering for `block_height` and `exec_mode`. # Test: Search for field usage in .proto files. Expect: Consistent field numbers across all related code and documentation. rg 'block_height' --glob '*.proto' -A 3 rg 'exec_mode' --glob '*.proto' -A 3Length of output: 3571
indexer/packages/v4-protos/src/codegen/dydxprotocol/clob/query.ts (3)
1289-1289: LGTM!The
takerOrderStatusfield is correctly initialized toundefinedin thecreateBaseStreamUpdatefunction.
1305-1307: LGTM!The
takerOrderStatusfield is correctly included in the encoding logic of theStreamUpdatefunction.
1338-1343: LGTM!The
takerOrderStatusfield is correctly included in the decoding logic of theStreamUpdatefunction.
| } | ||
|
|
||
| // Block height of the update. | ||
| uint32 block_height = 3; | ||
| uint32 block_height = 4; |
There was a problem hiding this comment.
just to make sure - is this schema backwards compatible?
There was a problem hiding this comment.
Since this is emitted in fns only, no need for it to be backwards compatible?
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (1)
protocol/x/clob/types/query.pb.gois excluded by!**/*.pb.go
Files selected for processing (2)
- indexer/packages/v4-protos/src/codegen/dydxprotocol/clob/query.ts (6 hunks)
- proto/dydxprotocol/clob/query.proto (1 hunks)
Files skipped from review as they are similar to previous changes (2)
- indexer/packages/v4-protos/src/codegen/dydxprotocol/clob/query.ts
- proto/dydxprotocol/clob/query.proto
Summary by CodeRabbit
New Features
takerOrderStatusproperty to provide enhanced insights into taker order status within real-time order updates.StreamUpdatemessage to includeStreamTakerOrderStatus, improving the message structure for orderbook updates.takerOrderproperty to theStreamUpdatemessage, allowing detailed information about taker orders.Bug Fixes
block_heightandexec_modeto maintain consistency with new features, ensuring accurate message interpretation.