[TRA-182] rename order_size_ppm to order_size_pct_ppm in vault params #1271
Conversation
WalkthroughThe update primarily involves renaming the 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 (
|
![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 ignored due to path filters (3)
protocol/app/testdata/default_genesis_state.jsonis excluded by!**/*.jsonprotocol/scripts/genesis/sample_pregenesis.jsonis excluded by!**/*.jsonprotocol/x/vault/types/params.pb.gois excluded by!**/*.pb.go
Files selected for processing (10)
- indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/params.ts (6 hunks)
- proto/dydxprotocol/vault/params.proto (1 hunks)
- protocol/testutil/constants/genesis.go (1 hunks)
- protocol/x/vault/keeper/msg_server_update_params_test.go (1 hunks)
- protocol/x/vault/keeper/orders.go (2 hunks)
- protocol/x/vault/keeper/orders_test.go (4 hunks)
- protocol/x/vault/keeper/params_test.go (2 hunks)
- protocol/x/vault/types/errors.go (1 hunks)
- protocol/x/vault/types/params.go (2 hunks)
- protocol/x/vault/types/params_test.go (2 hunks)
Path instructions used (10)
proto/dydxprotocol/vault/params.proto (1)
/
Do not include a walkthrough. For all comments on line changes that are longer than 15 lines, add a prefix to the comment of what lines you are commenting on (for example: "The changes from lines 100 to 200...". Add your comment to be on the last 15 lines of the chunk rather than adding your comment to the entire chunk.protocol/x/vault/types/params.go (1)
/
Do not include a walkthrough. For all comments on line changes that are longer than 15 lines, add a prefix to the comment of what lines you are commenting on (for example: "The changes from lines 100 to 200...". Add your comment to be on the last 15 lines of the chunk rather than adding your comment to the entire chunk.protocol/x/vault/types/errors.go (1)
/
Do not include a walkthrough. For all comments on line changes that are longer than 15 lines, add a prefix to the comment of what lines you are commenting on (for example: "The changes from lines 100 to 200...". Add your comment to be on the last 15 lines of the chunk rather than adding your comment to the entire chunk.protocol/x/vault/keeper/params_test.go (1)
/
Do not include a walkthrough. For all comments on line changes that are longer than 15 lines, add a prefix to the comment of what lines you are commenting on (for example: "The changes from lines 100 to 200...". Add your comment to be on the last 15 lines of the chunk rather than adding your comment to the entire chunk.protocol/x/vault/keeper/msg_server_update_params_test.go (1)
/
Do not include a walkthrough. For all comments on line changes that are longer than 15 lines, add a prefix to the comment of what lines you are commenting on (for example: "The changes from lines 100 to 200...". Add your comment to be on the last 15 lines of the chunk rather than adding your comment to the entire chunk.protocol/x/vault/types/params_test.go (1)
/
Do not include a walkthrough. For all comments on line changes that are longer than 15 lines, add a prefix to the comment of what lines you are commenting on (for example: "The changes from lines 100 to 200...". Add your comment to be on the last 15 lines of the chunk rather than adding your comment to the entire chunk.indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/params.ts (1)
/
Do not include a walkthrough. For all comments on line changes that are longer than 15 lines, add a prefix to the comment of what lines you are commenting on (for example: "The changes from lines 100 to 200...". Add your comment to be on the last 15 lines of the chunk rather than adding your comment to the entire chunk.protocol/x/vault/keeper/orders.go (1)
/
Do not include a walkthrough. For all comments on line changes that are longer than 15 lines, add a prefix to the comment of what lines you are commenting on (for example: "The changes from lines 100 to 200...". Add your comment to be on the last 15 lines of the chunk rather than adding your comment to the entire chunk.protocol/x/vault/keeper/orders_test.go (1)
/
Do not include a walkthrough. For all comments on line changes that are longer than 15 lines, add a prefix to the comment of what lines you are commenting on (for example: "The changes from lines 100 to 200...". Add your comment to be on the last 15 lines of the chunk rather than adding your comment to the entire chunk.protocol/testutil/constants/genesis.go (1)
/
Do not include a walkthrough. For all comments on line changes that are longer than 15 lines, add a prefix to the comment of what lines you are commenting on (for example: "The changes from lines 100 to 200...". Add your comment to be on the last 15 lines of the chunk rather than adding your comment to the entire chunk.
Additional comments (25)
proto/dydxprotocol/vault/params.proto (1)
- 24-24: The renaming of the field from
order_size_ppmtoorder_size_pct_ppmclarifies its purpose as representing a percentage in parts per million, aligning with the PR's objectives. This change maintains backward compatibility by not altering the field number.protocol/x/vault/types/params.go (2)
- 12-12: Renaming the field from
OrderSizePpmtoOrderSizePctPpmin theParamsstruct aligns with the PR's objective to clarify the parameter's purpose. This change is correctly applied throughout the file.- 28-29: The validation logic correctly uses the new field name
OrderSizePctPpm, ensuring that the parameter is validated as intended.protocol/x/vault/types/errors.go (1)
- 43-46: Renaming the error variable from
ErrInvalidOrderSizePpmtoErrInvalidOrderSizePctPpmand updating its message enhances clarity, aligning with the PR's objectives.protocol/x/vault/keeper/params_test.go (2)
- 26-26: The update of the field name to
OrderSizePctPpmin the test case aligns with the changes made in the main code, ensuring the test reflects the current codebase accurately.- 39-39: Correctly updating the field name in the test case for invalid parameters ensures that the test remains relevant and accurate.
protocol/x/vault/keeper/msg_server_update_params_test.go (2)
- 44-44: Updating the field name to
OrderSizePctPpmin the test function aligns with the changes made in the main code, ensuring the test accurately reflects the current codebase.- 48-48: The error message update to use the new error variable name
ErrInvalidOrderSizePctPpmensures that the test accurately reflects the updated codebase.protocol/x/vault/types/params_test.go (4)
- 27-27: The update of the field name to
OrderSizePctPpmin the test case aligns with the changes made in the main code, ensuring the test reflects the current codebase accurately.- 38-38: Correctly updating the field name in the test case for invalid parameters ensures that the test remains relevant and accurate.
- 43-49: Updating the field name to
OrderSizePctPpmin the test case for a failure scenario aligns with the changes made in the main code, ensuring the test accurately reflects the current codebase.- 60-60: Correctly updating the field name in another test case for invalid parameters ensures that the test remains relevant and accurate.
indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/params.ts (6)
- 26-26: Renaming the field from
orderSizePpmtoorderSizePctPpmin theParamsinterface aligns with the PR's objective to clarify the parameter's purpose. This change is correctly applied throughout the file.- 54-54: The serialization/deserialization logic correctly uses the new field name
order_size_pct_ppm, ensuring that the parameter is handled as intended.- 66-66: Correctly initializing the new field name in the
createBaseParamsfunction ensures that the default values are set accurately.- 89-90: The encoding function correctly handles the new field name, ensuring that the parameter is serialized accurately.
- 126-126: The decoding function correctly handles the new field name, ensuring that the parameter is deserialized accurately.
- 148-148: Correctly handling the new field name in the
fromPartialfunction ensures that partial objects are constructed accurately.protocol/x/vault/keeper/orders.go (2)
- 192-192: Updating the parameter name to
OrderSizePctPpmin theGetVaultClobOrdersfunction aligns with the PR's objective to clarify the parameter's purpose. This change is correctly applied, ensuring accurate calculation logic.- 231-231: Correctly handling the new parameter name in the calculation logic ensures that the function operates as intended with the updated parameter.
protocol/x/vault/keeper/orders_test.go (4)
- 257-257: The variable
OrderSizePpmhas been correctly renamed toOrderSizePctPpmin theTestGetVaultClobOrdersfunction. This change aligns with the PR's objective to enhance clarity in naming conventions. However, ensure that all references to this variable across the project, including documentation and comments, are updated to reflect this change.- 276-276: The comment explaining the calculation of order size has been updated to reflect the new variable name
order_size_pct_ppm. This is a good practice as it maintains the accuracy and relevance of the documentation inline with the code changes. Always ensure that comments are kept up-to-date with the code logic to aid future maintainability.- 315-315: The variable
OrderSizePpmhas been correctly renamed toOrderSizePctPpmin another instance within theTestGetVaultClobOrdersfunction. This consistent application of the new naming convention across the file is commendable and improves code clarity.- 334-334: Again, the comment has been updated to reflect the new variable name
order_size_pct_ppm, which is consistent with the changes made in the code. This attention to detail in keeping the comments aligned with the code changes is crucial for maintaining code readability and understandability.protocol/testutil/constants/genesis.go (1)
- 1501-1501: The renaming of
order_size_ppmtoorder_size_pct_ppmenhances clarity in the naming convention, making it explicit that the value represents a percentage in parts per million format. Ensure that all parts of the system that parse or access this JSON data are updated to use the new key name. This includes any parsing logic, data access patterns, and documentation that references the old key name.
Changelist
rename order_size_ppm to order_size_pct_ppm in vault params to be clearer that
order_size_ppmis not the actual order sizeTest Plan
N/A
Author/Reviewer Checklist
state-breakinglabel.indexer-postgres-breakinglabel.PrepareProposalorProcessProposal, manually add the labelproposal-breaking.feature:[feature-name].backport/[branch-name].refactor,chore,bug.