have individual vault quoting parameters #1997
Conversation
WalkthroughThe updates to the Changes
Sequence Diagram(s)sequenceDiagram
participant Client
participant VaultService
participant GenesisState
Client->>VaultService: Request to initialize vault
VaultService->>GenesisState: Set default_quoting_params
GenesisState-->>VaultService: Confirm setup
VaultService-->>Client: Vault initialized with quoting parameters
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
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (6)
protocol/x/vault/types/genesis.pb.gois excluded by!**/*.pb.goprotocol/x/vault/types/params.pb.gois excluded by!**/*.pb.goprotocol/x/vault/types/query.pb.gois excluded by!**/*.pb.goprotocol/x/vault/types/share.pb.gois excluded by!**/*.pb.goprotocol/x/vault/types/tx.pb.gois excluded by!**/*.pb.goprotocol/x/vault/types/vault.pb.gois excluded by!**/*.pb.go
Files selected for processing (6)
- proto/dydxprotocol/vault/genesis.proto (1 hunks)
- proto/dydxprotocol/vault/params.proto (2 hunks)
- proto/dydxprotocol/vault/query.proto (2 hunks)
- proto/dydxprotocol/vault/share.proto (1 hunks)
- proto/dydxprotocol/vault/tx.proto (2 hunks)
- proto/dydxprotocol/vault/vault.proto (2 hunks)
Additional comments not posted (13)
proto/dydxprotocol/vault/vault.proto (1)
1-2: LGTM!The
VaultTypeenum andVaultIdmessage are well-defined and provide clear context for vault identification.Also applies to: 4-5, 7-8
proto/dydxprotocol/vault/share.proto (3)
1-3: LGTM!The imports and options are correctly specified.
Also applies to: 7-8
9-17: LGTM!The
NumSharesmessage is well-defined and uses custom types appropriately.
19-23: LGTM!The
OwnerSharemessage is well-defined and correctly referencesNumShares.proto/dydxprotocol/vault/genesis.proto (2)
Line range hint
1-2:
LGTM!The imports and options are correctly specified.
Also applies to: 6-7
13-16: LGTM!The
default_quoting_paramsfield in theGenesisStatemessage is well-defined and ensures that a default quoting configuration is provided.proto/dydxprotocol/vault/params.proto (2)
Line range hint
8-40:
LGTM! Well-definedQuotingParamsmessage.The
QuotingParamsmessage is well-structured and includes detailed comments for each field. The use ofgogoprotooptions for custom types and non-nullable fields is appropriate.
42-45: LGTM! Well-definedVaultParamsmessage.The
VaultParamsmessage is well-structured and includes a detailed comment for thequoting_paramsfield. The use ofgogoprotooptions for non-nullable fields is appropriate.proto/dydxprotocol/vault/tx.proto (3)
18-19: LGTM! Well-definedUpdateDefaultQuotingParamsRPC method.The
UpdateDefaultQuotingParamsRPC method is well-structured and includes a detailed comment explaining its purpose. The change reflects a shift in focus towards managing quoting parameters.
47-54: LGTM! Well-definedMsgUpdateDefaultQuotingParamsmessage.The
MsgUpdateDefaultQuotingParamsmessage is well-structured and includes detailed comments for each field. The use ofcosmos.msg.v1.signerandgogoprotooptions for custom types and non-nullable fields is appropriate.
57-58: LGTM! Well-definedMsgUpdateDefaultQuotingParamsResponsemessage.The
MsgUpdateDefaultQuotingParamsResponsemessage is well-structured and includes a detailed comment explaining its purpose.proto/dydxprotocol/vault/query.proto (2)
9-9: LGTM! Necessary import statement forshare.proto.The import statement for
share.protois necessary to include the definitions used in the file.
40-40: LGTM! Well-definedQueryParamsResponsemessage.The
QueryParamsResponsemessage is well-structured and includes a detailed comment explaining its purpose. The change reflects a shift in focus towards managing quoting parameters.
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (2)
proto/dydxprotocol/vault/tx.proto (2)
18-19: Update all references toUpdateParamstoUpdateDefaultQuotingParamsin the following.protofiles:
proto/dydxprotocol/stats/tx.protoproto/dydxprotocol/rewards/tx.protoproto/dydxprotocol/perpetuals/tx.protoEnsure consistency across the codebase to avoid potential issues.
Analysis chain
LGTM! But verify the RPC method usage in the codebase.
The changes to the RPC method name and description accurately reflect the new functionality.
However, ensure that all references to
UpdateParamsare updated toUpdateDefaultQuotingParamsin the codebase.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify all references to `UpdateParams` are updated to `UpdateDefaultQuotingParams`. # Test: Search for the RPC method usage. Expect: Only occurrences of the new method name. rg --type proto -A 5 $'UpdateParams'Length of output: 65
Script:
#!/bin/bash # Description: Verify all references to `UpdateParams` are updated to `UpdateDefaultQuotingParams`. # Test: Search for the RPC method usage. Expect: Only occurrences of the new method name. rg --glob '*.proto' -A 5 'UpdateParams'Length of output: 3459
47-54: Update all references toMsgUpdateParamstoMsgUpdateDefaultQuotingParams.The following files still contain references to
MsgUpdateParams. Please update them toMsgUpdateDefaultQuotingParamsto ensure consistency across the codebase:
protocol/x/vault/keeper/msg_server_update_params_test.goprotocol/x/vault/keeper/msg_server_update_params.goprotocol/x/rewards/types/tx_test.goprotocol/x/rewards/types/tx.pb.goprotocol/x/rewards/types/tx.goprotocol/x/rewards/keeper/msg_server.goprotocol/x/rewards/keeper/msg_server_test.goprotocol/x/stats/types/tx_test.goprotocol/x/stats/types/tx.pb.goprotocol/x/stats/types/tx.goprotocol/x/stats/keeper/msg_server.goprotocol/x/stats/keeper/msg_server_test.goprotocol/x/perpetuals/types/message_update_params_test.goprotocol/x/perpetuals/types/message_update_params.goprotocol/x/perpetuals/types/tx.pb.goprotocol/x/perpetuals/types/tx.goprotocol/x/perpetuals/keeper/msg_server_update_params.goprotocol/x/perpetuals/keeper/msg_server_update_params_test.goprotocol/x/feetiers/keeper/msg_server_test.goprotocol/x/blocktime/keeper/msg_server_test.goproto/dydxprotocol/rewards/tx.protoproto/dydxprotocol/perpetuals/tx.protoproto/dydxprotocol/stats/tx.protoprotocol/scripts/governance/bridge_vesters_set_rewards.pyprotocol/testing/e2e/gov/sending_test.goprotocol/testing/e2e/authz/authz_test.goprotocol/testing/e2e/gov/stats_test.goprotocol/testing/e2e/gov/rewards_test.goprotocol/testing/e2e/gov/feetiers_test.goprotocol/testing/e2e/gov/perpetuals_test.goprotocol/lib/ante/unsupported_msgs.goprotocol/lib/ante/internal_msg_test.goprotocol/lib/ante/internal_msg.goprotocol/app/msgs/unsupported_msgs.goprotocol/app/msgs/internal_msgs_test.goprotocol/app/msgs/internal_msgs.goprotocol/app/msgs/all_msgs.goprotocol/app/msgs/unsupported_msgs_test.goprotocol/app/upgrades/v5.0.0/upgrade.goindexer/packages/v4-protos/src/codegen/dydxprotocol/vault/tx.rpc.msg.tsindexer/packages/v4-protos/src/codegen/dydxprotocol/vault/tx.tsindexer/packages/v4-protos/src/codegen/dydxprotocol/stats/tx.tsindexer/packages/v4-protos/src/codegen/dydxprotocol/stats/tx.rpc.msg.tsindexer/packages/v4-protos/src/codegen/dydxprotocol/perpetuals/tx.rpc.msg.tsindexer/packages/v4-protos/src/codegen/dydxprotocol/perpetuals/tx.tsindexer/packages/v4-protos/src/codegen/dydxprotocol/rewards/tx.rpc.msg.tsindexer/packages/v4-protos/src/codegen/dydxprotocol/rewards/tx.tsAnalysis chain
LGTM! But verify the message usage in the codebase.
The changes to the message name and fields accurately reflect the new functionality.
However, ensure that all references to
MsgUpdateParamsare updated toMsgUpdateDefaultQuotingParamsin the codebase.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify all references to `MsgUpdateParams` are updated to `MsgUpdateDefaultQuotingParams`. # Test: Search for the message usage. Expect: Only occurrences of the new message name. rg --type proto -A 5 $'MsgUpdateParams'Length of output: 68
Script:
#!/bin/bash # Description: Verify all references to `MsgUpdateParams` are updated to `MsgUpdateDefaultQuotingParams`. # Test: Search for the message usage. Expect: Only occurrences of the new message name. rg -A 5 'MsgUpdateParams'Length of output: 144212
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (6)
protocol/x/vault/types/genesis.pb.gois excluded by!**/*.pb.goprotocol/x/vault/types/params.pb.gois excluded by!**/*.pb.goprotocol/x/vault/types/query.pb.gois excluded by!**/*.pb.goprotocol/x/vault/types/share.pb.gois excluded by!**/*.pb.goprotocol/x/vault/types/tx.pb.gois excluded by!**/*.pb.goprotocol/x/vault/types/vault.pb.gois excluded by!**/*.pb.go
Files selected for processing (6)
- proto/dydxprotocol/vault/genesis.proto (1 hunks)
- proto/dydxprotocol/vault/params.proto (2 hunks)
- proto/dydxprotocol/vault/query.proto (2 hunks)
- proto/dydxprotocol/vault/share.proto (1 hunks)
- proto/dydxprotocol/vault/tx.proto (2 hunks)
- proto/dydxprotocol/vault/vault.proto (2 hunks)
Files skipped from review as they are similar to previous changes (5)
- proto/dydxprotocol/vault/genesis.proto
- proto/dydxprotocol/vault/params.proto
- proto/dydxprotocol/vault/query.proto
- proto/dydxprotocol/vault/share.proto
- proto/dydxprotocol/vault/vault.proto
Additional comments not posted (2)
proto/dydxprotocol/vault/tx.proto (2)
53-54: LGTM! But verify the field usage in the codebase.The changes to the field name and type accurately reflect the new functionality.
However, ensure that all references to
paramsare updated todefault_quoting_paramsin the codebase.
57-58: LGTM! But verify the message usage in the codebase.The changes to the message name accurately reflect the new functionality.
However, ensure that all references to
MsgUpdateParamsResponseare updated toMsgUpdateDefaultQuotingParamsResponsein the codebase.
| // VaultParams stores individual parameters of a vault. | ||
| message VaultParams { | ||
| // The quoting parameters specific to this vault. | ||
| QuotingParams quoting_params = 1 [ (gogoproto.nullable) = false ]; |
There was a problem hiding this comment.
nit: This isn't nullable, how do we know we should use the default? Or is the plan to set it to equal to the default at the start?
There was a problem hiding this comment.
yeah i was thinking about setting this to the default when a vault is created (i.e. first deposited into).
There was a problem hiding this comment.
thought more about this and simply removed VaultParams proto
There was a problem hiding this comment.
Actionable comments posted: 1
Outside diff range, codebase verification and nitpick comments (1)
protocol/testutil/constants/genesis.go (1)
4517-4517: Update required: Inconsistent key usage detectedThe key
"params"is still being used in multiple JSON files. Please update the key to"default_quoting_params"in the following files to ensure consistency:
protocol/x/rewards/testdata/expected_default_genesis.jsonprotocol/testing/delaymsg_config/perpetual_fee_params_msg.jsonprotocol/scripts/genesis/sample_pregenesis.jsonprotocol/testing/containertest/preupgrade_genesis.jsonprotocol/app/testdata/default_genesis_state.jsonprotocol/app/module/testdata/slashing_default_genesis_state.jsonAnalysis chain
LGTM! But verify the usage of the new key in the codebase.
The renaming of
"params"to"default_quoting_params"enhances clarity and maintainability.However, ensure that all references to the old key
"params"are updated to"default_quoting_params"throughout the codebase.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify all references to the old key "params" are updated to "default_quoting_params". # Test: Search for the old key usage. Expect: No occurrences of the old key. rg --type json -A 5 $'"params"'Length of output: 62496
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (2)
protocol/x/vault/types/genesis.pb.gois excluded by!**/*.pb.goprotocol/x/vault/types/params.pb.gois excluded by!**/*.pb.go
Files selected for processing (36)
- indexer/packages/v4-protos/src/codegen/dydxprotocol/bundle.ts (5 hunks)
- indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/genesis.ts (9 hunks)
- indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/params.ts (6 hunks)
- indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/query.ts (5 hunks)
- indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/share.ts (1 hunks)
- indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/tx.rpc.msg.ts (2 hunks)
- indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/tx.ts (6 hunks)
- indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/vault.ts (3 hunks)
- indexer/packages/v4-protos/src/codegen/gogoproto/bundle.ts (1 hunks)
- indexer/packages/v4-protos/src/codegen/google/bundle.ts (1 hunks)
- proto/dydxprotocol/vault/genesis.proto (2 hunks)
- proto/dydxprotocol/vault/params.proto (1 hunks)
- protocol/app/msgs/internal_msgs.go (1 hunks)
- protocol/app/testdata/default_genesis_state.json (1 hunks)
- protocol/app/upgrades/v5.0.0/upgrade.go (1 hunks)
- protocol/app/upgrades/v5.2.0/upgrade.go (1 hunks)
- protocol/lib/ante/internal_msg.go (1 hunks)
- protocol/mocks/VaultKeeper.go (2 hunks)
- protocol/scripts/genesis/sample_pregenesis.json (1 hunks)
- protocol/testutil/constants/genesis.go (1 hunks)
- protocol/x/vault/genesis.go (3 hunks)
- protocol/x/vault/keeper/grpc_query.go (1 hunks)
- protocol/x/vault/keeper/grpc_query_test.go (1 hunks)
- protocol/x/vault/keeper/msg_server_update_default_quoting_params.go (2 hunks)
- protocol/x/vault/keeper/msg_server_update_default_quoting_params_test.go (2 hunks)
- protocol/x/vault/keeper/orders.go (8 hunks)
- protocol/x/vault/keeper/orders_test.go (21 hunks)
- protocol/x/vault/keeper/params.go (1 hunks)
- protocol/x/vault/keeper/params_test.go (3 hunks)
- protocol/x/vault/keeper/vault.go (1 hunks)
- protocol/x/vault/keeper/vault_test.go (1 hunks)
- protocol/x/vault/types/genesis.go (2 hunks)
- protocol/x/vault/types/keys.go (1 hunks)
- protocol/x/vault/types/params.go (3 hunks)
- protocol/x/vault/types/params_test.go (5 hunks)
- protocol/x/vault/types/types.go (1 hunks)
Files skipped from review due to trivial changes (2)
- indexer/packages/v4-protos/src/codegen/gogoproto/bundle.ts
- protocol/x/vault/keeper/vault_test.go
Files skipped from review as they are similar to previous changes (2)
- proto/dydxprotocol/vault/genesis.proto
- proto/dydxprotocol/vault/params.proto
Additional context used
Biome
indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/tx.ts
[error] 60-60: An empty interface is equivalent to {}.
Safe fix: Use a type alias instead.
(lint/suspicious/noEmptyInterface)
[error] 63-63: An empty interface is equivalent to {}.
Safe fix: Use a type alias instead.
(lint/suspicious/noEmptyInterface)
Additional comments not posted (134)
indexer/packages/v4-protos/src/codegen/google/bundle.ts (2)
1-6: LGTM! Imports are updated correctly.The import statements have been updated to include necessary modules and remove unused ones.
8-14: LGTM! Namespace exports are updated correctly.The
protocol/x/vault/keeper/grpc_query.go (1)
20-22: LGTM! But verify the function usage in the codebase.The function
Paramshas been updated correctly to include a new fieldDefaultQuotingParamsin its response structure.However, ensure that all function calls to
Paramshandle the new response structure correctly.protocol/x/vault/keeper/msg_server_update_default_quoting_params.go (1)
Line range hint
13-31:
LGTM! But verify the function usage in the codebase.The function
UpdateParamshas been correctly renamed toUpdateDefaultQuotingParamsand updated to handle default quoting parameters.However, ensure that all function calls to
UpdateDefaultQuotingParamshandle the new behavior correctly.Verification successful
LGTM! The function
UpdateParamshas been correctly renamed toUpdateDefaultQuotingParamsand updated to handle default quoting parameters.The test cases and gRPC handler definitions have been updated to reflect the new behavior of the function.
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify all function calls to `UpdateDefaultQuotingParams` handle the new behavior correctly. # Test: Search for the function usage. Expect: All occurrences handle the new behavior. rg --type go -A 5 $'UpdateDefaultQuotingParams'Length of output: 22175
protocol/x/vault/keeper/grpc_query_test.go (1)
26-26: Verify the correctness ofDefaultQuotingParams.Ensure that the
DefaultQuotingParamsfunction returns the correct default values and that this change aligns with the new functionality introduced in the PR.protocol/x/vault/types/types.go (2)
28-30: Verify the methodGetDefaultQuotingParams.Ensure that the method correctly retrieves the default quoting parameters and that this change aligns with the new functionality introduced in the PR.
31-33: Verify the methodSetDefaultQuotingParams.Ensure that the method correctly sets the default quoting parameters and that this change aligns with the new functionality introduced in the PR.
protocol/x/vault/types/keys.go (2)
21-23: Verify the constantDefaultQuotingParamsKey.Ensure that the key correctly represents the default quoting parameters and that this change aligns with the new functionality introduced in the PR.
25-27: Verify the constantQuotingParamsKeyPrefix.Ensure that the key prefix correctly represents the quoting parameters for individual vaults and that this change aligns with the new functionality introduced in the PR.
protocol/x/vault/types/genesis.go (3)
6-6: LGTM!The change to initialize
DefaultQuotingParamsinDefaultGenesisis clear and aligns with the PR objectives.
14-14: LGTM!The validation of
DefaultQuotingParamsinValidateenhances robustness and aligns with the PR objectives.
39-43: LGTM!The added validation for
vault.QuotingParamsensures that all relevant parameters are checked for correctness.protocol/x/vault/types/params.go (2)
9-11: LGTM!The change to initialize
QuotingParamswith default values inDefaultQuotingParamsis clear and aligns with the PR objectives.
23-23: LGTM!The comprehensive validation logic for
QuotingParamsensures robustness and aligns with the PR objectives.protocol/x/vault/genesis.go (3)
13-14: LGTM!The change to set
DefaultQuotingParamsinInitGenesisis clear and aligns with the PR objectives.
32-33: LGTM!The logic to handle
QuotingParamsfor each vault inInitGenesisis clear and aligns with the PR objectives.
47-47: LGTM!The change to export
DefaultQuotingParamsinExportGenesisis clear and aligns with the PR objectives.indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/tx.rpc.msg.ts (3)
3-3: LGTM! Imports are correctly updated.The new message types
MsgUpdateDefaultQuotingParamsandMsgUpdateDefaultQuotingParamsResponseare correctly imported.
9-11: LGTM! Method inMsginterface correctly updated.The method
updateParamshas been replaced withupdateDefaultQuotingParams, aligning with the new functionality.
Line range hint
19-31:
LGTM! Method inMsgClientImplclass correctly updated.The method
updateParamshas been replaced withupdateDefaultQuotingParams, and the binding in the constructor is correctly updated.protocol/app/upgrades/v5.2.0/upgrade.go (1)
47-61: LGTM! Deprecation notice and commented-out implementation are clear.The function
setVaultOrderExpirationSecondsToSixtyis correctly marked as deprecated and its implementation is commented out, aligning with the transition toDefaultQuotingParams.protocol/x/vault/keeper/params.go (4)
9-16: LGTM! MethodGetDefaultQuotingParamscorrectly implemented.The method retrieves
DefaultQuotingParamsfrom the state and unmarshals it correctly.
21-33: LGTM! MethodSetDefaultQuotingParamscorrectly implemented.The method validates, marshals, and sets
DefaultQuotingParamsin the state correctly.
38-54: LGTM! MethodGetVaultQuotingParamscorrectly implemented.The method retrieves quoting parameters for a specific vault, returning default quoting parameters if none exist, and unmarshals them correctly.
57-69: LGTM! MethodSetVaultQuotingParamscorrectly implemented.The method validates, marshals, and sets quoting parameters for a specific vault correctly.
protocol/x/vault/keeper/msg_server_update_default_quoting_params_test.go (6)
17-20: Update function name and message type.The function name and message type have been updated to reflect the new focus on default quoting parameters.
24-29: Success case: Update to default quoting parameters.The test case successfully updates to default quoting parameters. Ensure that the default values are correct.
30-41: Success case: Update to non-default quoting parameters.The test case successfully updates to non-default quoting parameters. Ensure that the non-default values are valid and correctly set.
45-49: Failure case: Invalid authority.The test case correctly handles the scenario where the authority is invalid. Ensure that the error message is accurate.
52-57: Failure case: Invalid quoting parameters.The test case correctly handles the scenario where the quoting parameters are invalid. Ensure that the error message is accurate.
75-81: Update function call and validation.The function call and validation have been updated to reflect the new message type and expected outcomes.
protocol/x/vault/types/params_test.go (7)
11-14: Update function name and parameter type.The function name and parameter type have been updated to reflect the new focus on quoting parameters.
19-19: Success case: Validate default quoting parameters.The test case successfully validates the default quoting parameters. Ensure that the default values are correct.
Line range hint
23-32:
Failure case: Layer is greater than MaxUint8.The test case correctly handles the scenario where the layer value exceeds the maximum allowed value. Ensure that the error message is accurate.
Line range hint
35-44:
Failure case: SpreadMinPpm is 0.The test case correctly handles the scenario where the SpreadMinPpm value is zero. Ensure that the error message is accurate.
Line range hint
47-56:
Failure case: OrderSizePctPpm is 0.The test case correctly handles the scenario where the OrderSizePctPpm value is zero. Ensure that the error message is accurate.
Line range hint
59-68:
Failure case: OrderExpirationSeconds is 0.The test case correctly handles the scenario where the OrderExpirationSeconds value is zero. Ensure that the error message is accurate.
Line range hint
71-80:
Failure case: ActivationThresholdQuoteQuantums is negative.The test case correctly handles the scenario where the ActivationThresholdQuoteQuantums value is negative. Ensure that the error message is accurate.
indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/vault.ts (3)
1-1: Removal ofNumSharesandNumSharesSDKTypeinterfaces.The interfaces
NumSharesandNumSharesSDKTypeand their associated encoding/decoding logic have been removed. Ensure that the removal does not negatively impact the functionality and maintainability of the codebase.
1-1: Removal ofOwnerShareandOwnerShareSDKTypeinterfaces.The interfaces
OwnerShareandOwnerShareSDKTypeand their associated encoding/decoding logic have been removed. Ensure that the removal does not negatively impact the functionality and maintainability of the codebase.
1-1: Removal ofVaultParamsandVaultParamsSDKTypeinterfaces.The interfaces
VaultParamsandVaultParamsSDKTypeand their associated encoding/decoding logic have been removed. Ensure that the removal does not negatively impact the functionality and maintainability of the codebase.protocol/x/vault/keeper/params_test.go (8)
13-13: Function renaming is appropriate.The function name has been updated to reflect its focus on default quoting parameters.
19-20: Correct usage of GetDefaultQuotingParams.The function now retrieves default quoting parameters, aligning with the new parameter structure.
Line range hint
23-34:
Setting and verifying new quoting parameters.The new parameters are correctly set and verified. Ensure that the
QuotingParamsstructure is well-defined and validated.
Line range hint
37-48:
Handling invalid quoting parameters.The test correctly handles invalid parameters and verifies that the default parameters remain unchanged.
51-51: Function renaming is appropriate.The function name has been updated to reflect its focus on vault quoting parameters.
57-58: Correct usage of GetVaultQuotingParams.The function now retrieves quoting parameters for a specific vault, aligning with the new parameter structure.
61-75: Setting and verifying vault quoting parameters.The new parameters for
vaultClob0are correctly set and verified. Ensure that theQuotingParamsstructure is well-defined and validated.
78-92: Setting and verifying vault quoting parameters for another vault.The new parameters for
vaultClob1are correctly set and verified. Ensure that theQuotingParamsstructure is well-defined and validated.indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/share.ts (13)
1-2: Imports are appropriate.The necessary modules are imported correctly.
5-8: NumShares interface definition is correct.The
NumSharesinterface is well-defined.
11-14: NumSharesSDKType interface definition is correct.The
NumSharesSDKTypeinterface is well-defined.
17-20: OwnerShare interface definition is correct.The
OwnerShareinterface is well-defined.
23-26: OwnerShareSDKType interface definition is correct.The
OwnerShareSDKTypeinterface is well-defined.
28-32: createBaseNumShares function is correct.The function correctly initializes a
NumSharesobject.
34-41: NumShares encode function is correct.The function correctly encodes a
NumSharesmessage.
43-63: NumShares decode function is correct.The function correctly decodes a
NumSharesmessage.
65-69: NumShares fromPartial function is correct.The function correctly creates a
NumSharesmessage from a partial object.
73-77: createBaseOwnerShare function is correct.The function correctly initializes an
OwnerShareobject.
80-91: OwnerShare encode function is correct.The function correctly encodes an
OwnerSharemessage.
93-117: OwnerShare decode function is correct.The function correctly decodes an
OwnerSharemessage.
119-124: OwnerShare fromPartial function is correct.The function correctly creates an
OwnerSharemessage from a partial object.protocol/lib/ante/internal_msg.go (1)
129-129: Update to reference MsgUpdateDefaultQuotingParams is correct.The function now correctly references
vault.MsgUpdateDefaultQuotingParams, aligning with the new parameter structure.protocol/x/vault/keeper/vault.go (1)
142-150: Ensure the correctness of the newquotingParams.The changes correctly rename
vaultParamstoquotingParamsand adjust the data structure accordingly. Ensure that theGetVaultQuotingParamsmethod is correctly implemented and returns the expected values.indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/params.ts (6)
Line range hint
3-19:
Verify the correctness and consistency of theQuotingParamsinterface.The interface
QuotingParamsis well-defined with clear documentation comments. Ensure that the naming conventions and data types are consistent with the rest of the codebase.
Line range hint
39-55:
Verify the correctness and consistency of theQuotingParamsSDKTypeinterface.The interface
QuotingParamsSDKTypeis well-defined with clear documentation comments. Ensure that the naming conventions and data types are consistent with the rest of the codebase.
Line range hint
76-86:
Verify the correctness and appropriateness of the default values increateBaseQuotingParams.The function
createBaseQuotingParamsinitializes all fields of theQuotingParamsinterface. Ensure that the default values are appropriate for the intended use cases.
Line range hint
88-119:
Verify the correctness of the encoding logic forQuotingParams.The encoding method for
QuotingParamsappears to be well-defined, encoding all fields of the interface. Ensure that the encoding logic is correct and handles all edge cases.
Line range hint
121-165:
Verify the correctness of the decoding logic forQuotingParams.The decoding method for
QuotingParamsappears to be well-defined, decoding all fields of the interface. Ensure that the decoding logic is correct and handles all edge cases.
Line range hint
167-175:
Verify the correctness of thefromPartialmethod forQuotingParams.The
fromPartialmethod forQuotingParamsappears to be well-defined, constructing an object from a partial input. Ensure that the logic is correct and handles all edge cases.indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/genesis.ts (6)
1-19: Verify the correctness of theGenesisStateinterface changes.The
GenesisStateinterface has been modified to usedefaultQuotingParamsinstead ofparams. Ensure that the newdefaultQuotingParamsare correctly integrated and that the changes are consistent with the rest of the codebase.
Line range hint
35-55:
Verify the correctness of theVaultinterface changes.The
Vaultinterface has been modified to usequotingParamsinstead ofvaultParams. Ensure that the newquotingParamsare correctly integrated and that the changes are consistent with the rest of the codebase.
63-65: Verify the correctness of thecreateBaseGenesisStatefunction changes.The
createBaseGenesisStatefunction has been modified to initializedefaultQuotingParams. Ensure that the default values are appropriate and consistent with the rest of the codebase.
70-73: Verify the correctness of the encoding logic forGenesisState.The encoding method for
GenesisStatehas been modified to encodedefaultQuotingParams. Ensure that the encoding logic is correct and handles all edge cases.
91-93: Verify the correctness of the decoding logic forGenesisState.The decoding method for
GenesisStatehas been modified to decodedefaultQuotingParams. Ensure that the decoding logic is correct and handles all edge cases.
140-143: Verify the correctness of the encoding logic forVault.The encoding method for
Vaulthas been modified to encodequotingParams. Ensure that the encoding logic is correct and handles all edge cases.protocol/mocks/VaultKeeper.go (2)
21-33: LGTM!The function
GetDefaultQuotingParamshas been correctly updated to reflect the new return typevaulttypes.QuotingParams.
186-195: LGTM!The function
SetDefaultQuotingParamshas been correctly updated to reflect the new parameter typevaulttypes.QuotingParams.indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/tx.ts (8)
42-48: LGTM!The interface
MsgUpdateDefaultQuotingParamshas been correctly updated to reflect the new propertydefaultQuotingParamsof typeQuotingParams.
50-56: LGTM!The interface
MsgUpdateDefaultQuotingParamsSDKTypehas been correctly updated to reflect the new propertydefaultQuotingParamsof typeQuotingParamsSDKType.
58-61: LGTM!The interface
MsgUpdateDefaultQuotingParamsResponsehas been correctly updated to align with the new focus on quoting parameters.Tools
Biome
[error] 60-60: An empty interface is equivalent to {}.
Safe fix: Use a type alias instead.
(lint/suspicious/noEmptyInterface)
63-63: LGTM!The interface
MsgUpdateDefaultQuotingParamsResponseSDKTypehas been correctly updated to align with the new focus on quoting parameters.Tools
Biome
[error] 63-63: An empty interface is equivalent to {}.
Safe fix: Use a type alias instead.
(lint/suspicious/noEmptyInterface)
164-167: LGTM!The function
createBaseMsgUpdateDefaultQuotingParamshas been correctly updated to align with the new focus on quoting parameters.
Line range hint
171-213:
LGTM!The function
MsgUpdateDefaultQuotingParamshas been correctly updated to align with the new focus on quoting parameters.
219-223: LGTM!The function
createBaseMsgUpdateDefaultQuotingParamsResponsehas been correctly updated to align with the new focus on quoting parameters.
Line range hint
224-247:
LGTM!The function
MsgUpdateDefaultQuotingParamsResponsehas been correctly updated to align with the new focus on quoting parameters.protocol/app/msgs/internal_msgs.go (1)
189-190: LGTM!The message entries have been correctly updated to reflect the new
MsgUpdateDefaultQuotingParamsandMsgUpdateDefaultQuotingParamsResponse.indexer/packages/v4-protos/src/codegen/dydxprotocol/bundle.ts (2)
105-127: LGTM! Import statements are correctly integrated.The new imports for
vault/share,vest/vest_entry, andvest/query.lcdare necessary and correctly integrated.
357-367: LGTM! Export statements are correctly updated.The export structure for
vestandClientFactoryhas been updated to include the new modules.protocol/app/upgrades/v5.0.0/upgrade.go (1)
295-297: LGTM! But verify the function usage in the codebase.The function now sets default quoting parameters, which is a more focused configuration process. The error handling remains appropriate.
However, ensure that all function calls to
initializeVaultModuleParamsmatch the new implementation.Verification successful
LGTM! But verify the function usage in the codebase.
The function now sets default quoting parameters, which is a more focused configuration process. The error handling remains appropriate.
protocol/app/upgrades/v5.0.0/upgrade.go: The functioninitializeVaultModuleParamsis only used within this file, and the usage matches the new implementation.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify all function calls to `initializeVaultModuleParams` match the new implementation. # Test: Search for the function usage. Expect: Only occurrences of the new implementation. rg --type go -A 5 $'initializeVaultModuleParams'Length of output: 807
Script:
#!/bin/bash # Description: Verify all references to `initializeVaultModuleParams` in the entire codebase to ensure consistency. # Test: Search for any additional references to `initializeVaultModuleParams`. rg --type go 'initializeVaultModuleParams'Length of output: 207
protocol/app/testdata/default_genesis_state.json (1)
484-484: LGTM! The key renaming is consistent with the changes in the codebase.The key
paramshas been renamed todefault_quoting_params, which enhances clarity regarding the purpose of the parameters.indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/query.ts (6)
17-17: LGTM!The
paramsproperty has been correctly replaced bydefaultQuotingParamsin theQueryParamsResponseinterface.
22-22: LGTM!The
paramsproperty has been correctly replaced bydefault_quoting_paramsin theQueryParamsResponseSDKTypeinterface.
139-139: LGTM!The
createBaseQueryParamsResponsefunction correctly initializesdefaultQuotingParamsinstead ofparams.
145-146: LGTM!The
encodemethod correctly checks and encodesdefaultQuotingParamsinstead ofparams.
162-162: LGTM!The
decodemethod correctly decodesdefaultQuotingParamsinstead ofparams.
176-176: LGTM!The
fromPartialmethod correctly handlesdefaultQuotingParamsinstead ofparams.protocol/x/vault/keeper/orders.go (8)
43-44: LGTM!The
RefreshAllVaultOrdersfunction now retrieves quoting parameters for each vault, enhancing parameter specificity.
210-211: LGTM!The
GetVaultClobOrdersfunction now retrieves quoting parameters, ensuring calculations are aligned with each vault's characteristics.
214-214: LGTM!The calculation of order size now uses quoting parameters, ensuring more accurate order placements.
244-245: LGTM!The calculation of spread now uses quoting parameters, ensuring more accurate order placements.
256-256: LGTM!The order expiration time now uses quoting parameters, ensuring more accurate order placements.
258-258: LGTM!The skew factor now uses quoting parameters, ensuring more accurate order placements.
396-396: LGTM!The
GetVaultClobOrderIdsfunction now retrieves quoting parameters to determine the number of layers, ensuring alignment with vault characteristics.
438-438: LGTM!The
ReplaceVaultClobOrderfunction now uses quoting parameters for determining order expiration, ensuring alignment with vault characteristics.protocol/x/vault/keeper/orders_test.go (28)
149-150: LGTM!The test now uses
defaultQuotingParamsinstead ofParams, aligning with the new structure of vault parameters.
153-153: LGTM!The test now correctly sets
defaultQuotingParamsin the genesis state.
240-240: LGTM!The test now uses
defaultQuotingParamsinstead ofParams, aligning with the new structure of vault parameters.
245-245: LGTM!The test now correctly uses
defaultQuotingParamsfor order expiration seconds.
319-319: LGTM!The test now initializes
defaultQuotingParamscorrectly.
353-353: LGTM!The test now correctly sets
defaultQuotingParamsin the genesis state for subaccounts.
362-362: LGTM!The test now correctly sets
defaultQuotingParamsin the genesis state for subaccounts.
384-384: LGTM!The test now verifies the number of vault orders against
defaultQuotingParams.Layers.
411-413: LGTM!The test correctly verifies the order expiration time using
defaultQuotingParams.OrderExpirationSeconds.
420-420: LGTM!The test correctly verifies the order expiration time using
defaultQuotingParams.OrderExpirationSeconds.
425-425: LGTM!The test correctly verifies the order expiration time using
defaultQuotingParams.OrderExpirationSeconds.
432-432: LGTM!The test correctly verifies the order expiration time using
defaultQuotingParams.OrderExpirationSeconds.
443-444: LGTM!The test now uses
vaultQuotingParamsinstead ofvaultParams, aligning with the new structure of vault parameters.
466-466: LGTM!The test case correctly initializes
vaultQuotingParamswith specific values.
540-540: LGTM!The test case correctly initializes
vaultQuotingParamswith specific values.
620-620: LGTM!The test case correctly initializes
vaultQuotingParamswith specific values.
700-700: LGTM!The test case correctly initializes
vaultQuotingParamswith specific values.
768-768: LGTM!The test case correctly initializes
vaultQuotingParamswith specific values.
792-793: LGTM!The test case correctly initializes
vaultQuotingParamswith default values.
801-801: LGTM!The test case correctly initializes
vaultQuotingParamswith default values.
812-812: LGTM!The test case correctly initializes
vaultQuotingParamswith default values.
823-823: LGTM!The test case correctly initializes
vaultQuotingParamswith default values.
906-907: LGTM!The test correctly sets
vaultQuotingParamsfor the vault.
908-908: LGTM!The test correctly verifies that
vaultQuotingParamsis set without errors.
919-919: LGTM!The test correctly retrieves
vaultQuotingParamsfor the vault.
937-937: LGTM!The test correctly sets the order expiration time using
vaultQuotingParams.OrderExpirationSeconds.
1013-1014: LGTM!The test now retrieves quoting parameters to determine the number of layers, ensuring alignment with vault characteristics.
1015-1015: LGTM!The test correctly sets quoting parameters for the vault.
protocol/scripts/genesis/sample_pregenesis.json (1)
Line range hint
3905-3912:
LGTM! The renaming enhances clarity.The key
"params"has been renamed to"default_quoting_params"under the"vault"section. This change improves the clarity and specificity of the configuration.
tqin7
force-pushed
the
tq/tra-511
branch
2 times, most recently
from
61af221 to
ab61e12
Compare
There was a problem hiding this comment.
Caution
Inline review comments failed to post
Actionable comments posted: 2
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (2)
protocol/x/vault/types/genesis.pb.gois excluded by!**/*.pb.goprotocol/x/vault/types/params.pb.gois excluded by!**/*.pb.go
Files selected for processing (38)
- indexer/packages/v4-protos/src/codegen/dydxprotocol/bundle.ts (5 hunks)
- indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/genesis.ts (9 hunks)
- indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/params.ts (6 hunks)
- indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/query.ts (5 hunks)
- indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/share.ts (1 hunks)
- indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/tx.rpc.msg.ts (2 hunks)
- indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/tx.ts (6 hunks)
- indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/vault.ts (3 hunks)
- indexer/packages/v4-protos/src/codegen/gogoproto/bundle.ts (1 hunks)
- indexer/packages/v4-protos/src/codegen/google/bundle.ts (1 hunks)
- proto/dydxprotocol/vault/genesis.proto (2 hunks)
- proto/dydxprotocol/vault/params.proto (1 hunks)
- proto/dydxprotocol/vault/tx.proto (2 hunks)
- protocol/app/msgs/internal_msgs.go (1 hunks)
- protocol/app/testdata/default_genesis_state.json (1 hunks)
- protocol/app/upgrades/v5.0.0/upgrade.go (1 hunks)
- protocol/app/upgrades/v5.2.0/upgrade.go (1 hunks)
- protocol/lib/ante/internal_msg.go (1 hunks)
- protocol/mocks/VaultKeeper.go (2 hunks)
- protocol/scripts/genesis/sample_pregenesis.json (1 hunks)
- protocol/testutil/constants/genesis.go (1 hunks)
- protocol/x/vault/client/cli/query_test.go (1 hunks)
- protocol/x/vault/genesis.go (3 hunks)
- protocol/x/vault/keeper/grpc_query.go (1 hunks)
- protocol/x/vault/keeper/grpc_query_test.go (1 hunks)
- protocol/x/vault/keeper/msg_server_update_default_quoting_params.go (2 hunks)
- protocol/x/vault/keeper/msg_server_update_default_quoting_params_test.go (2 hunks)
- protocol/x/vault/keeper/orders.go (8 hunks)
- protocol/x/vault/keeper/orders_test.go (21 hunks)
- protocol/x/vault/keeper/params.go (1 hunks)
- protocol/x/vault/keeper/params_test.go (3 hunks)
- protocol/x/vault/keeper/vault.go (1 hunks)
- protocol/x/vault/keeper/vault_test.go (1 hunks)
- protocol/x/vault/types/genesis.go (2 hunks)
- protocol/x/vault/types/keys.go (1 hunks)
- protocol/x/vault/types/params.go (3 hunks)
- protocol/x/vault/types/params_test.go (5 hunks)
- protocol/x/vault/types/types.go (1 hunks)
Files skipped from review due to trivial changes (2)
- indexer/packages/v4-protos/src/codegen/gogoproto/bundle.ts
- protocol/x/vault/types/keys.go
Files skipped from review as they are similar to previous changes (28)
- indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/genesis.ts
- indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/params.ts
- indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/query.ts
- indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/share.ts
- indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/tx.rpc.msg.ts
- indexer/packages/v4-protos/src/codegen/google/bundle.ts
- proto/dydxprotocol/vault/tx.proto
- protocol/app/msgs/internal_msgs.go
- protocol/app/testdata/default_genesis_state.json
- protocol/app/upgrades/v5.0.0/upgrade.go
- protocol/app/upgrades/v5.2.0/upgrade.go
- protocol/lib/ante/internal_msg.go
- protocol/mocks/VaultKeeper.go
- protocol/scripts/genesis/sample_pregenesis.json
- protocol/testutil/constants/genesis.go
- protocol/x/vault/genesis.go
- protocol/x/vault/keeper/grpc_query.go
- protocol/x/vault/keeper/grpc_query_test.go
- protocol/x/vault/keeper/msg_server_update_default_quoting_params.go
- protocol/x/vault/keeper/orders.go
- protocol/x/vault/keeper/orders_test.go
- protocol/x/vault/keeper/params.go
- protocol/x/vault/keeper/params_test.go
- protocol/x/vault/keeper/vault.go
- protocol/x/vault/keeper/vault_test.go
- protocol/x/vault/types/genesis.go
- protocol/x/vault/types/params_test.go
- protocol/x/vault/types/types.go
Additional context used
Biome
indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/tx.ts
[error] 60-60: An empty interface is equivalent to {}.
Safe fix: Use a type alias instead.
(lint/suspicious/noEmptyInterface)
[error] 63-63: An empty interface is equivalent to {}.
Safe fix: Use a type alias instead.
(lint/suspicious/noEmptyInterface)
Additional comments not posted (27)
proto/dydxprotocol/vault/genesis.proto (3)
6-6: Import statement forshare.protoadded.The import statement for
share.protohas been added, which is necessary for the newQuotingParamsfield.
13-14:default_quoting_paramsfield added toGenesisState.The
Paramsfield has been replaced withdefault_quoting_params, marked as non-nullable, ensuring a default quoting configuration is mandatory.Ensure that the new field is correctly referenced and utilized throughout the codebase.
Verification successful
default_quoting_paramsfield added toGenesisState.The
Paramsfield has been replaced withdefault_quoting_params, marked as non-nullable, ensuring a default quoting configuration is mandatory.The new field is correctly referenced and utilized throughout the codebase in various files:
protocol/x/vault/types/tx.pb.goprotocol/x/vault/types/genesis.pb.goprotocol/x/vault/types/query.pb.goprotocol/testutil/constants/genesis.goprotocol/scripts/genesis/sample_pregenesis.jsonprotocol/app/testdata/default_genesis_state.jsonproto/dydxprotocol/vault/tx.protoproto/dydxprotocol/vault/query.protoproto/dydxprotocol/vault/genesis.protoindexer/packages/v4-protos/src/codegen/dydxprotocol/vault/query.tsindexer/packages/v4-protos/src/codegen/dydxprotocol/vault/tx.tsindexer/packages/v4-protos/src/codegen/dydxprotocol/vault/genesis.tsScripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify all references to `default_quoting_params` in the codebase. # Test: Search for the field usage. Expect: Only occurrences of the new field. rg --type proto -A 5 $'default_quoting_params'Length of output: 75
Script:
#!/bin/bash # Description: Verify all references to `default_quoting_params` in the codebase. # Test: Search for the field usage. Expect: Only occurrences of the new field. rg -A 5 'default_quoting_params'Length of output: 6325
27-28:quoting_paramsfield added toVault.The new
quoting_paramsfield has been added to theVaultmessage, allowing each vault to maintain its own set of quoting parameters.Ensure that the new field is correctly referenced and utilized throughout the codebase.
Verification successful
quoting_paramsfield added toVault.The new
quoting_paramsfield has been added to theVaultmessage, allowing each vault to maintain its own set of quoting parameters. The field is correctly referenced and utilized throughout the codebase.
protocol/x/vault/types/genesis.pb.goprotocol/x/vault/types/tx.pb.goprotocol/x/vault/types/query.pb.goproto/dydxprotocol/vault/genesis.protoindexer/packages/v4-protos/src/codegen/dydxprotocol/vault/genesis.tsScripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify all references to `quoting_params` in the codebase. # Test: Search for the field usage. Expect: Only occurrences of the new field. rg --type proto -A 5 $'quoting_params'Length of output: 67
Script:
#!/bin/bash # Description: Verify all references to `quoting_params` in the codebase. # Find all .proto files and search for the field usage within them. fd -e proto -x rg 'quoting_params' {}Length of output: 306
Script:
#!/bin/bash # Description: Verify all references to `quoting_params` in the codebase. # Search for the field usage in all files. rg 'quoting_params'Length of output: 1858
protocol/x/vault/client/cli/query_test.go (1)
53-53: Test case updated to compareDefaultQuotingParams.The assertion in the
TestQueryParamstest case has been updated to compareDefaultQuotingParamsinstead ofParams, aligning the test with the new functionality.Ensure that the test case provides adequate coverage for the new functionality.
Verification successful
Test case updated to compare
DefaultQuotingParams.The assertion in the
TestQueryParamstest case has been updated to compareDefaultQuotingParamsinstead ofParams, aligning the test with the new functionality. The search results indicate that there is adequate test coverage forDefaultQuotingParams.
params_test.gogrpc_query_test.gomsg_server_update_default_quoting_params_test.goorders_test.goScripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the test coverage for `DefaultQuotingParams`. # Test: Search for test cases involving `DefaultQuotingParams`. Expect: Adequate test coverage. rg --type go -A 5 $'DefaultQuotingParams'Length of output: 46121
proto/dydxprotocol/vault/params.proto (1)
8-8:QuotingParamsmessage added.The
Paramsmessage has been renamed toQuotingParams, clarifying its function as it pertains specifically to vault quoting parameters.Ensure that the new message is correctly referenced and utilized throughout the codebase.
Verification successful
QuotingParamsmessage added and correctly referenced.The
Paramsmessage has been renamed toQuotingParams, and it is correctly referenced throughout the codebase.
QuotingParamsis used in various contexts, such asdefault_quoting_paramsandquoting_params.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify all references to `QuotingParams` in the codebase. # Test: Search for the message usage. Expect: Only occurrences of the new message. rg --type proto -A 5 $'QuotingParams'Length of output: 66
Script:
#!/bin/bash # Description: Verify all references to `QuotingParams` in the codebase. # Find all .proto files and search for the message usage of `QuotingParams`. fd -e proto -x rg 'QuotingParams' {}Length of output: 822
protocol/x/vault/types/params.go (2)
Line range hint
9-21:
Default parameters look good.The default quoting parameters are set sensibly and should work well for the application.
Line range hint
23-37:
Validation logic looks good.The validation logic for the quoting parameters is thorough and covers all necessary cases.
protocol/x/vault/keeper/msg_server_update_default_quoting_params_test.go (4)
24-29: Test case for updating to default looks good.The test case correctly verifies the successful update to default quoting parameters.
30-41: Test case for updating to non-default looks good.The test case correctly verifies the successful update to non-default quoting parameters.
45-49: Test case for invalid authority looks good.The test case correctly verifies the failure scenario for invalid authority.
Line range hint
52-60:
Test case for invalid parameters looks good.The test case correctly verifies the failure scenario for invalid quoting parameters.
indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/vault.ts (3)
1-1: Removal ofNumSharesandNumSharesSDKTypelooks good.The removal simplifies the data structure related to vault shares and should not affect the functionality.
1-1: Removal ofOwnerShareandOwnerShareSDKTypelooks good.The removal simplifies the data structure related to vault ownership and should not affect the functionality.
1-1: Removal ofVaultParamsandVaultParamsSDKTypelooks good.The removal simplifies the data structure related to vault parameters and should not affect the functionality.
indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/tx.ts (11)
3-3: LGTM!The import statement for
QuotingParamsandQuotingParamsSDKTypealigns with the new focus on quoting parameters.
42-48: LGTM!The new
MsgUpdateDefaultQuotingParamsinterface correctly introducesauthorityanddefaultQuotingParams, aligning with the updated focus.
52-56: LGTM!The new
MsgUpdateDefaultQuotingParamsSDKTypeinterface correctly introducesauthorityanddefault_quoting_params, aligning with the updated focus.
164-167: LGTM!The
createBaseMsgUpdateDefaultQuotingParamsfunction correctly initializesauthorityanddefaultQuotingParamsto default values.
171-178: LGTM!The encoding function for
MsgUpdateDefaultQuotingParamscorrectly encodesauthorityanddefaultQuotingParams.
Line range hint
184-198: LGTM!The decoding function for
MsgUpdateDefaultQuotingParamscorrectly decodesauthorityanddefaultQuotingParams.
210-213: LGTM!The
fromPartialfunction forMsgUpdateDefaultQuotingParamscorrectly handles partial updates forauthorityanddefaultQuotingParams.
219-219: LGTM!The
createBaseMsgUpdateDefaultQuotingParamsResponsefunction correctly initializes an empty object.
223-223: LGTM!The encoding function for
MsgUpdateDefaultQuotingParamsResponsecorrectly encodes an empty object.
228-231: LGTM!The decoding function for
MsgUpdateDefaultQuotingParamsResponsecorrectly decodes an empty object.
246-247: LGTM!The
fromPartialfunction forMsgUpdateDefaultQuotingParamsResponsecorrectly handles partial updates for an empty object.indexer/packages/v4-protos/src/codegen/dydxprotocol/bundle.ts (2)
357-364: LGTM!The updated
vestexport structure correctly includes additional modules, enhancing vesting functionalities.
365-367: LGTM!The updated
ClientFactoryexport structure correctly includes an additional module, expanding the factory's capabilities.
Comments failed to post (2)
indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/tx.ts
58-60: Avoid using empty interfaces.
An empty interface is equivalent to
{}. Consider using a type alias instead.- export interface MsgUpdateDefaultQuotingParamsResponse {} + export type MsgUpdateDefaultQuotingParamsResponse = {};Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements./** MsgUpdateDefaultQuotingParamsResponse is the Msg/UpdateDefaultQuotingParams response type. */ export type MsgUpdateDefaultQuotingParamsResponse = {};Tools
Biome
[error] 60-60: An empty interface is equivalent to {}.
Safe fix: Use a type alias instead.
(lint/suspicious/noEmptyInterface)
63-63: Avoid using empty interfaces.
An empty interface is equivalent to
{}. Consider using a type alias instead.- export interface MsgUpdateDefaultQuotingParamsResponseSDKType {} + export type MsgUpdateDefaultQuotingParamsResponseSDKType = {};Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.export type MsgUpdateDefaultQuotingParamsResponseSDKType = {};Tools
Biome
[error] 63-63: An empty interface is equivalent to {}.
Safe fix: Use a type alias instead.
(lint/suspicious/noEmptyInterface)
| // Set vault module parameters to default values. | ||
| vaultParams := vaulttypes.DefaultParams() | ||
| if err := vaultKeeper.SetParams(ctx, vaultParams); err != nil { | ||
| // Set vault module quoting parameters to default values. |
There was a problem hiding this comment.
nit: Comment out code rather than changing.
| import "dydxprotocol/vault/vault.proto"; | ||
|
|
||
| option go_package = "github.com/dydxprotocol/v4-chain/protocol/x/vault/types"; | ||
|
|
||
| // GenesisState defines `x/vault`'s genesis state. | ||
| message GenesisState { | ||
| // The parameters of the module. | ||
| Params params = 1 [ (gogoproto.nullable) = false ]; |
There was a problem hiding this comment.
nit: Can we make these changes backwards compatible?
| @@ -5,8 +5,8 @@ import "gogoproto/gogo.proto"; | |||
|
|
|||
| option go_package = "github.com/dydxprotocol/v4-chain/protocol/x/vault/types"; | |||
|
|
|||
| // Params stores `x/vault` parameters. | |||
| message Params { | |||
There was a problem hiding this comment.
nit: deprecate this rather than just outright deleting.
proto/dydxprotocol/vault/query.proto
Outdated
| @@ -36,7 +37,7 @@ message QueryParamsRequest {} | |||
|
|
|||
| // QueryParamsResponse is a response type for the Params RPC method. | |||
| message QueryParamsResponse { | |||
| Params params = 1 [ (gogoproto.nullable) = false ]; | |||
| QuotingParams default_quoting_params = 1 [ (gogoproto.nullable) = false ]; | |||
There was a problem hiding this comment.
nit: Make this backwards compatible.
| @@ -15,8 +15,9 @@ service Msg { | |||
| // DepositToVault deposits funds into a vault. | |||
| rpc DepositToVault(MsgDepositToVault) returns (MsgDepositToVaultResponse); | |||
|
|
|||
| // UpdateParams updates the Params in state. | |||
| rpc UpdateParams(MsgUpdateParams) returns (MsgUpdateParamsResponse); | |||
| // UpdateDefaultQuotingParams updates the default quoting params in state. | |||
There was a problem hiding this comment.
nit: Create new queries / handlers rather than replacing old ones.
There was a problem hiding this comment.
I'm thinking that for MsgServer, i should replace the old method. It's a bit too messy otherwise with UpdateParams still there (implementation, internal msg testing, etc.)
| } | ||
|
|
||
| func TestGetSetVaultParams(t *testing.T) { | ||
| func TestGetSetVaultQuotingParams(t *testing.T) { |
There was a problem hiding this comment.
nit: Given the paramaterized nature of the tests now, prefer test cases pattern.
| _, exists := k.GetTotalShares(ctx, tc.vaultId) | ||
| require.Equal(t, false, exists) | ||
| for _, owner := range tc.owners { | ||
| _, exists = k.GetOwnerShares(ctx, tc.vaultId, owner) | ||
| require.Equal(t, false, exists) | ||
| } | ||
| _, exists = k.GetVaultParams(ctx, tc.vaultId) |
There was a problem hiding this comment.
nit: Do you need to check if the quote params were deleted?
There was a problem hiding this comment.
yep. will do so in the later PR that adds a governance message to set individual vault quoting params
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (5)
indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/vault.ts (1)
Incomplete removal of interfaces detected.
The interfaces
NumShares,NumSharesSDKType,OwnerShare,OwnerShareSDKType,VaultParams, andVaultParamsSDKTypehave been removed but are still referenced in several files. This incomplete removal will likely cause issues with the functionality that depends on these interfaces. Please review and update all dependent code to ensure consistency.
- Files with references to removed interfaces:
indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/genesis.tsindexer/packages/v4-protos/src/codegen/dydxprotocol/vault/share.tsindexer/packages/v4-protos/src/codegen/dydxprotocol/vault/query.lcd.tsindexer/packages/v4-protos/src/codegen/dydxprotocol/vault/query.tsindexer/packages/v4-protos/src/codegen/dydxprotocol/vault/query.rpc.Query.tsAnalysis chain
Line range hint
1-99: Verify the impact of interface deletions.The removal of interfaces
NumShares,NumSharesSDKType,OwnerShare,OwnerShareSDKType,VaultParams, andVaultParamsSDKTypesuggests a significant change in the data model. Ensure that the existing functionality is not adversely affected by these deletions.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the impact of interface deletions on existing functionality. # Test: Search for the usage of the removed interfaces. Expect: No occurrences of the removed interfaces. rg --type ts -A 5 $'NumShares|NumSharesSDKType|OwnerShare|OwnerShareSDKType|VaultParams|VaultParamsSDKType'Length of output: 33354
proto/dydxprotocol/vault/tx.proto (2)
19-21: Deprecation Notice: UpdateParamsThe
UpdateParamsRPC method is deprecated. Ensure that all references to this method are updated to use the newUpdateDefaultQuotingParamsmethod.
- Files with references to
UpdateParams:
proto/dydxprotocol/vault/tx.protoproto/dydxprotocol/stats/tx.protoproto/dydxprotocol/rewards/tx.protoproto/dydxprotocol/perpetuals/tx.protoAnalysis chain
Deprecation Notice: UpdateParams
The
UpdateParamsRPC method is deprecated. Ensure that all references to this method are updated to use the newUpdateDefaultQuotingParamsmethod.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify that all references to `UpdateParams` are updated to `UpdateDefaultQuotingParams`. # Test: Search for the usage of `UpdateParams`. Expect: No occurrences. rg --type proto -A 5 $'UpdateParams'Length of output: 65
Script:
#!/bin/bash # Description: Verify that all references to `UpdateParams` are updated to `UpdateDefaultQuotingParams`. # Test: Search for the usage of `UpdateParams`. Expect: No occurrences. rg 'UpdateParams' -g '*.proto' -A 5Length of output: 5411
Deprecation Notice: MsgUpdateParams
The
MsgUpdateParamsmessage is still being referenced in multiple locations across the codebase. Please update all references to use the newMsgUpdateDefaultQuotingParamsmessage instead. The following files contain references toMsgUpdateParams:
proto/dydxprotocol/vault/tx.protoproto/dydxprotocol/stats/tx.protoproto/dydxprotocol/rewards/tx.protoproto/dydxprotocol/perpetuals/tx.protoprotocol/x/rewards/types/tx.goprotocol/x/stats/types/tx.pb.goprotocol/x/vault/types/tx.pb.goprotocol/x/perpetuals/types/tx.pb.goprotocol/x/rewards/keeper/msg_server.goprotocol/x/stats/keeper/msg_server.goprotocol/x/perpetuals/keeper/msg_server.goPlease ensure that all these references are updated to maintain consistency with the deprecation notice.
Analysis chain
Line range hint
53-66: Deprecation Notice: MsgUpdateParamsThe
MsgUpdateParamsmessage is deprecated. Ensure that all references to this message are updated to use the newMsgUpdateDefaultQuotingParamsmessage.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify that all references to `MsgUpdateParams` are updated to `MsgUpdateDefaultQuotingParams`. # Test: Search for the usage of `MsgUpdateParams`. Expect: No occurrences. rg --type proto -A 5 $'MsgUpdateParams'Length of output: 68
Script:
#!/bin/bash # Description: Verify that all references to `MsgUpdateParams` are updated to `MsgUpdateDefaultQuotingParams`. # Test: Search for the usage of `MsgUpdateParams` across all files. Expect: No occurrences. rg -A 5 $'MsgUpdateParams'Length of output: 158831
indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/tx.ts (2)
99-109: Consider using a type alias for empty interfaces.The
MsgUpdateDefaultQuotingParamsResponseinterface is consistent with the naming conventions and structure. However, an empty interface is equivalent to{}and can be replaced with a type alias.- export interface MsgUpdateDefaultQuotingParamsResponse {} + export type MsgUpdateDefaultQuotingParamsResponse = {};Tools
Biome
[error] 103-103: An empty interface is equivalent to {}.
Safe fix: Use a type alias instead.
(lint/suspicious/noEmptyInterface)
[error] 109-109: An empty interface is equivalent to {}.
Safe fix: Use a type alias instead.
(lint/suspicious/noEmptyInterface)
354-356: Consider using a type alias for empty interfaces.The
createBaseMsgUpdateDefaultQuotingParamsResponsefunction is well-defined but initializes an empty interface. An empty interface is equivalent to{}and can be replaced with a type alias.- export interface MsgUpdateDefaultQuotingParamsResponse {} + export type MsgUpdateDefaultQuotingParamsResponse = {};
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (4)
protocol/x/vault/types/genesis.pb.gois excluded by!**/*.pb.goprotocol/x/vault/types/params.pb.gois excluded by!**/*.pb.goprotocol/x/vault/types/query.pb.gois excluded by!**/*.pb.goprotocol/x/vault/types/tx.pb.gois excluded by!**/*.pb.go
Files selected for processing (41)
- indexer/packages/v4-protos/src/codegen/dydxprotocol/bundle.ts (5 hunks)
- indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/genesis.ts (11 hunks)
- indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/params.ts (3 hunks)
- indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/query.ts (6 hunks)
- indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/share.ts (1 hunks)
- indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/tx.rpc.msg.ts (3 hunks)
- indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/tx.ts (3 hunks)
- indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/vault.ts (3 hunks)
- indexer/packages/v4-protos/src/codegen/gogoproto/bundle.ts (1 hunks)
- indexer/packages/v4-protos/src/codegen/google/bundle.ts (1 hunks)
- proto/dydxprotocol/vault/genesis.proto (2 hunks)
- proto/dydxprotocol/vault/params.proto (1 hunks)
- proto/dydxprotocol/vault/query.proto (2 hunks)
- proto/dydxprotocol/vault/tx.proto (3 hunks)
- protocol/app/msgs/internal_msgs.go (1 hunks)
- protocol/app/testdata/default_genesis_state.json (1 hunks)
- protocol/app/upgrades/v5.0.0/upgrade.go (1 hunks)
- protocol/app/upgrades/v5.2.0/upgrade.go (1 hunks)
- protocol/lib/ante/internal_msg.go (1 hunks)
- protocol/mocks/VaultKeeper.go (2 hunks)
- protocol/scripts/genesis/sample_pregenesis.json (1 hunks)
- protocol/testing/genesis.sh (1 hunks)
- protocol/testutil/constants/genesis.go (1 hunks)
- protocol/x/vault/client/cli/query_test.go (1 hunks)
- protocol/x/vault/genesis.go (3 hunks)
- protocol/x/vault/keeper/grpc_query.go (1 hunks)
- protocol/x/vault/keeper/grpc_query_test.go (1 hunks)
- protocol/x/vault/keeper/msg_server_update_default_quoting_params.go (1 hunks)
- protocol/x/vault/keeper/msg_server_update_default_quoting_params_test.go (2 hunks)
- protocol/x/vault/keeper/msg_server_update_params.go (1 hunks)
- protocol/x/vault/keeper/orders.go (8 hunks)
- protocol/x/vault/keeper/orders_test.go (21 hunks)
- protocol/x/vault/keeper/params.go (1 hunks)
- protocol/x/vault/keeper/params_test.go (3 hunks)
- protocol/x/vault/keeper/vault.go (1 hunks)
- protocol/x/vault/keeper/vault_test.go (1 hunks)
- protocol/x/vault/types/genesis.go (2 hunks)
- protocol/x/vault/types/keys.go (1 hunks)
- protocol/x/vault/types/params.go (3 hunks)
- protocol/x/vault/types/params_test.go (5 hunks)
- protocol/x/vault/types/types.go (1 hunks)
Files skipped from review due to trivial changes (1)
- indexer/packages/v4-protos/src/codegen/gogoproto/bundle.ts
Files skipped from review as they are similar to previous changes (28)
- indexer/packages/v4-protos/src/codegen/dydxprotocol/bundle.ts
- indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/share.ts
- indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/tx.rpc.msg.ts
- indexer/packages/v4-protos/src/codegen/google/bundle.ts
- proto/dydxprotocol/vault/genesis.proto
- proto/dydxprotocol/vault/query.proto
- protocol/app/msgs/internal_msgs.go
- protocol/app/testdata/default_genesis_state.json
- protocol/app/upgrades/v5.0.0/upgrade.go
- protocol/app/upgrades/v5.2.0/upgrade.go
- protocol/lib/ante/internal_msg.go
- protocol/mocks/VaultKeeper.go
- protocol/scripts/genesis/sample_pregenesis.json
- protocol/testutil/constants/genesis.go
- protocol/x/vault/client/cli/query_test.go
- protocol/x/vault/genesis.go
- protocol/x/vault/keeper/grpc_query.go
- protocol/x/vault/keeper/grpc_query_test.go
- protocol/x/vault/keeper/msg_server_update_default_quoting_params_test.go
- protocol/x/vault/keeper/orders.go
- protocol/x/vault/keeper/orders_test.go
- protocol/x/vault/keeper/params.go
- protocol/x/vault/keeper/params_test.go
- protocol/x/vault/keeper/vault.go
- protocol/x/vault/keeper/vault_test.go
- protocol/x/vault/types/keys.go
- protocol/x/vault/types/params_test.go
- protocol/x/vault/types/types.go
Additional context used
Biome
indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/tx.ts
[error] 69-69: An empty interface is equivalent to {}.
Safe fix: Use a type alias instead.
(lint/suspicious/noEmptyInterface)
[error] 75-75: An empty interface is equivalent to {}.
Safe fix: Use a type alias instead.
(lint/suspicious/noEmptyInterface)
[error] 103-103: An empty interface is equivalent to {}.
Safe fix: Use a type alias instead.
(lint/suspicious/noEmptyInterface)
[error] 109-109: An empty interface is equivalent to {}.
Safe fix: Use a type alias instead.
(lint/suspicious/noEmptyInterface)
Additional comments not posted (36)
protocol/x/vault/keeper/msg_server_update_params.go (1)
11-16: Deprecation Notice: Ensure no calls toUpdateParams.The
UpdateParamsfunction has been deprecated and now only returns an error message. Verify that no parts of the codebase are still calling this function.Verification successful
Deprecation Notice: Ensure no calls to
UpdateParams.The
UpdateParamsfunction has been deprecated and now only returns an error message. Upon verification, no calls to theUpdateParamsfunction were found in the main application logic, excluding test and generated files.
- The only instances of
UpdateParamsfound were within the definitions and comments, not actual function calls.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify that no calls are made to the deprecated `UpdateParams` function. # Test: Search for the function usage. Expect: No occurrences of `UpdateParams` calls. rg --type python -A 5 $'UpdateParams'Length of output: 67
Script:
#!/bin/bash # Description: Verify that no calls are made to the deprecated `UpdateParams` function. # Test: Search for the function usage. Expect: No occurrences of `UpdateParams` calls. rg --type go -A 5 $'UpdateParams'Length of output: 119477
Script:
#!/bin/bash # Description: Verify that no calls are made to the deprecated `UpdateParams` function, excluding test and generated files. # Test: Search for the function usage in Go files, excluding test and generated files. Expect: No occurrences of `UpdateParams` calls. rg --type go -A 5 'UpdateParams' --glob '!**/*_test.go' --glob '!**/*.pb.go'Length of output: 24218
protocol/x/vault/keeper/msg_server_update_default_quoting_params.go (1)
13-32: Ensure proper error handling and authority checks.The
UpdateDefaultQuotingParamsfunction correctly handles authority checks and updates the default quoting parameters. Verify that the function is correctly integrated and called within the codebase.Verification successful
Function
UpdateDefaultQuotingParamsis properly integrated and called within the codebase.The function is referenced in multiple places, including the keeper, tests, and other protocol files, indicating correct usage and testing.
protocol/x/vault/keeper/msg_server_update_default_quoting_params.goprotocol/x/vault/keeper/msg_server_update_default_quoting_params_test.goprotocol/x/vault/types/tx.pb.goprotocol/lib/ante/internal_msg.goprotocol/app/msgs/internal_msgs.goScripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the integration and calls to `UpdateDefaultQuotingParams`. # Test: Search for the function usage. Expect: Correct integration and calls to `UpdateDefaultQuotingParams`. rg --type python -A 5 $'UpdateDefaultQuotingParams'Length of output: 81
Script:
#!/bin/bash # Description: Verify the integration and calls to `UpdateDefaultQuotingParams`. # Test: Search for the function usage. Expect: Correct integration and calls to `UpdateDefaultQuotingParams`. rg --type go -A 5 $'UpdateDefaultQuotingParams'Length of output: 24472
protocol/x/vault/types/genesis.go (3)
6-6: Initialization Change: Ensure correct initialization ofDefaultQuotingParams.The
DefaultGenesisfunction now initializesDefaultQuotingParamsinstead ofParams. Verify that this change is correctly implemented and does not affect other parts of the codebase.Verification successful
Initialization Change Verified:
DefaultQuotingParamsis correctly initialized and used throughout the codebase.The initialization of
DefaultQuotingParamshas been correctly implemented and does not negatively impact other parts of the codebase.
protocol/x/vault/types/params.go: Initialization ofDefaultQuotingParams.protocol/x/vault/types/genesis.go: Usage in genesis state.protocol/x/vault/keeper/params_test.go: Tests for setting and gettingDefaultQuotingParams.protocol/x/vault/keeper/msg_server_update_default_quoting_params_test.go: Tests for updatingDefaultQuotingParams.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the initialization of `DefaultQuotingParams`. # Test: Search for the initialization of `DefaultQuotingParams`. Expect: Correct initialization in all necessary parts of the codebase. rg --type python -A 5 $'DefaultQuotingParams'Length of output: 75
Script:
#!/bin/bash # Description: Verify the initialization of `DefaultQuotingParams`. # Test: Search for the initialization of `DefaultQuotingParams`. Expect: Correct initialization in all necessary parts of the codebase. rg --type go -A 5 $'DefaultQuotingParams'Length of output: 48161
14-14: Validation Change: Ensure correct validation ofDefaultQuotingParams.The
Validatemethod now validatesDefaultQuotingParamsinstead ofParams. Verify that this change is correctly implemented and does not affect other parts of the codebase.Verification successful
Validation Change: Ensure correct validation of
DefaultQuotingParams.The change to use
DefaultQuotingParams.Validateinstead ofParams.Validateinprotocol/x/vault/types/genesis.gois correctly implemented and does not affect other parts of the codebase.
protocol/x/vault/types/genesis.gocorrectly usesDefaultQuotingParams.Validate.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the validation of `DefaultQuotingParams`. # Test: Search for the validation of `DefaultQuotingParams`. Expect: Correct validation in all necessary parts of the codebase. rg --type python -A 5 $'DefaultQuotingParams.Validate'Length of output: 84
Script:
#!/bin/bash # Description: Verify the validation of `DefaultQuotingParams`. # Test: Search for the validation of `DefaultQuotingParams`. Expect: Correct validation in all necessary parts of the codebase. rg --type go -A 5 $'DefaultQuotingParams.Validate'Length of output: 417
Script:
#!/bin/bash # Description: Verify if instances of `Params.Validate` have been correctly updated. # Test: Search for instances of `Params.Validate`. Expect: No outdated instances remaining. rg --type go -A 5 $'Params.Validate'Length of output: 13786
39-43: New Validation: Ensure correct validation ofvault.QuotingParams.The
Validatemethod now includes validation forvault.QuotingParams. Verify that this change is correctly implemented and does not affect other parts of the codebase.Verification successful
Validation of
vault.QuotingParamsis correctly implemented.The
Validatemethod forQuotingParamsis thoroughly implemented inprotocol/x/vault/types/params.goand is correctly called inprotocol/x/vault/types/genesis.go. This ensures proper validation ofvault.QuotingParamswithout affecting other parts of the codebase.
protocol/x/vault/types/params.go: Implementation ofValidatemethod.protocol/x/vault/types/genesis.go: Call tovault.QuotingParams.Validate().Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the validation of `vault.QuotingParams`. # Test: Search for the validation of `vault.QuotingParams`. Expect: Correct validation in all necessary parts of the codebase. rg --type python -A 5 $'vault.QuotingParams.Validate'Length of output: 83
Script:
#!/bin/bash # Description: Verify the validation of `vault.QuotingParams`. # Search for the implementation of the `Validate` method for `vault.QuotingParams`. ast-grep --lang go --pattern 'func ($_ QuotingParams) Validate() error { $$$ }' # Search for all occurrences of `vault.QuotingParams.Validate()` in the Go codebase. rg 'vault.QuotingParams.Validate()'Length of output: 1738
protocol/x/vault/types/params.go (2)
Line range hint
9-21: LGTM!The
DefaultQuotingParamsfunction correctly returns a default set of quoting parameters with clear inline comments.
Line range hint
23-39: LGTM!The
Validatefunction correctly validates theQuotingParamswith appropriate checks for each parameter.proto/dydxprotocol/vault/params.proto (2)
8-40: LGTM!The
QuotingParamsmessage is well-defined with clear comments and appropriate use ofgogoprotooptions.
42-43: LGTM!The
Paramsmessage is correctly marked as deprecated, with a clear notice indicating its replacement byQuotingParams.proto/dydxprotocol/vault/tx.proto (4)
22-24: New Method: UpdateDefaultQuotingParamsThe new
UpdateDefaultQuotingParamsRPC method is correctly defined. Ensure that this method is properly integrated and tested.
67-76: New Message: MsgUpdateDefaultQuotingParamsThe new
MsgUpdateDefaultQuotingParamsmessage is correctly defined. Ensure that this message is properly integrated and tested.
78-80: New Message: MsgUpdateDefaultQuotingParamsResponseThe new
MsgUpdateDefaultQuotingParamsResponsemessage is correctly defined. Ensure that this message is properly integrated and tested.
64-66: Deprecation Notice: MsgUpdateParamsResponseThe
MsgUpdateParamsResponsemessage is deprecated. Ensure that all references to this message are updated to use the newMsgUpdateDefaultQuotingParamsResponsemessage.indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/genesis.ts (4)
1-21: Renaming: params to defaultQuotingParamsThe
paramsfield is correctly renamed todefaultQuotingParamsin theGenesisStateinterface. Ensure that all references toparamsare updated todefaultQuotingParams.
26-38: Renaming: params to default_quoting_paramsThe
paramsfield is correctly renamed todefault_quoting_paramsin theGenesisStateSDKTypeinterface. Ensure that all references toparamsare updated todefault_quoting_params.
51-53: Renaming: vaultParams to quotingParamsThe
vaultParamsfield is correctly renamed toquotingParamsin theVaultinterface. Ensure that all references tovaultParamsare updated toquotingParams.
69-71: Renaming: vault_params to quoting_paramsThe
vault_paramsfield is correctly renamed toquoting_paramsin theVaultSDKTypeinterface. Ensure that all references tovault_paramsare updated toquoting_params.indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/params.ts (4)
3-38: Renaming: Params to QuotingParamsThe
Paramsinterface is correctly renamed toQuotingParams. Ensure that all references toParamsare updated toQuotingParams.
41-74: Renaming: ParamsSDKType to QuotingParamsSDKTypeThe
ParamsSDKTypeinterface is correctly renamed toQuotingParamsSDKType. Ensure that all references toParamsSDKTypeare updated toQuotingParamsSDKType.
154-164: Renaming: createBaseParams to createBaseQuotingParamsThe
createBaseParamsfunction is correctly renamed tocreateBaseQuotingParams. Ensure that all references tocreateBaseParamsare updated tocreateBaseQuotingParams.
166-255: Renaming: Encoding and Decoding MethodsThe encoding and decoding methods are correctly updated to accommodate
QuotingParams. Ensure that all references toParamsare updated toQuotingParams.indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/tx.ts (8)
3-3: Imports look good!The import changes align with the updated focus on quoting parameters.
42-45: Deprecation and replacement look good!The deprecation of
MsgUpdateParamsand its replacement withMsgUpdateDefaultQuotingParamsalign with the new focus on quoting parameters.Also applies to: 53-56, 64-67, 71-73
77-86: New interface looks good!The
MsgUpdateDefaultQuotingParamsinterface is well-defined and aligns with the updated focus on quoting parameters.Also applies to: 92-97
297-304: Deprecation and replacement look good!The deprecation of
createBaseMsgUpdateParamsand its replacement withcreateBaseMsgUpdateDefaultQuotingParamsalign with the new focus on quoting parameters.
299-304: New function looks good!The
createBaseMsgUpdateDefaultQuotingParamsfunction is well-defined and aligns with the updated focus on quoting parameters.
306-350: Deprecation and replacement look good!The deprecation of encoding/decoding functions for
MsgUpdateParamsand their replacement with those forMsgUpdateDefaultQuotingParamsalign with the new focus on quoting parameters.
306-350: New encoding/decoding functions look good!The encoding/decoding functions for
MsgUpdateDefaultQuotingParamsare well-defined and align with the updated focus on quoting parameters.
354-356: Deprecation and replacement look good!The deprecation of
createBaseMsgUpdateParamsResponseand its replacement withcreateBaseMsgUpdateDefaultQuotingParamsResponsealign with the new focus on quoting parameters.indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/query.ts (6)
3-3: Imports look good!The import changes align with the updated focus on quoting parameters.
17-21: Deprecation and replacement look good!The deprecation of the
paramsproperty and its replacement withdefaultQuotingParamsalign with the new focus on quoting parameters.Also applies to: 26-30
147-148: Changes look good!The
createBaseQueryParamsResponsefunction now initializesdefaultQuotingParams, aligning with the updated focus on quoting parameters.
158-160: Changes look good!The
QueryParamsResponseencoding function now handlesdefaultQuotingParams, aligning with the updated focus on quoting parameters.
178-180: Changes look good!The
QueryParamsResponsedecoding function now handlesdefaultQuotingParams, aligning with the updated focus on quoting parameters.
194-194: Changes look good!The
QueryParamsResponsefromPartial function now handlesdefaultQuotingParams, aligning with the updated focus on quoting parameters.protocol/testing/genesis.sh (1)
2237-2237: Verify the updated path for setting the minimum spread parameter.The path for the minimum spread parameter has been updated to
.app_state.vault.default_quoting_params.spread_min_ppm. Ensure this path is consistent with the new structure of the configuration data.
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/vault/types/genesis.pb.gois excluded by!**/*.pb.go
Files selected for processing (2)
- proto/dydxprotocol/vault/genesis.proto (2 hunks)
- protocol/app/msgs/internal_msgs.go (1 hunks)
Files skipped from review as they are similar to previous changes (1)
- protocol/app/msgs/internal_msgs.go
Additional comments not posted (4)
proto/dydxprotocol/vault/genesis.proto (4)
6-6: Import statement added forshare.proto.The addition of this import statement suggests that the new quoting parameters may be detailed or utilized within the
share.protofile.
14-15: FieldParamsdeprecated.The
Paramsfield has been marked as deprecated since v6.x in favor ofdefault_quoting_params.
18-19: Fielddefault_quoting_paramsadded.The
default_quoting_paramsfield has been added to enhance the configuration capabilities of vaults.
30-31: Fieldvault_paramsrenamed toquoting_params.The
vault_paramsfield has been renamed toquoting_paramsto reinforce the focus on quoting parameters.
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (3)
- protocol/app/msgs/all_msgs.go (1 hunks)
- protocol/app/msgs/internal_msgs_test.go (1 hunks)
- protocol/scripts/genesis/sample_pregenesis.json (2 hunks)
Files skipped from review as they are similar to previous changes (1)
- protocol/scripts/genesis/sample_pregenesis.json
Additional comments not posted (2)
protocol/app/msgs/internal_msgs_test.go (1)
149-150: LGTM! New message paths are correctly added.The new message paths for
MsgUpdateDefaultQuotingParamsandMsgUpdateDefaultQuotingParamsResponseare correctly integrated within the existing structure.protocol/app/msgs/all_msgs.go (1)
246-247: LGTM! New message types are correctly added.The new message types for
MsgUpdateDefaultQuotingParamsandMsgUpdateDefaultQuotingParamsResponseare correctly integrated within the existing structure.
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- protocol/lib/ante/internal_msg.go (1 hunks)
Files skipped from review as they are similar to previous changes (1)
- protocol/lib/ante/internal_msg.go
There was a problem hiding this comment.
Actionable comments posted: 1
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (1)
protocol/x/vault/types/tx.pb.gois excluded by!**/*.pb.go
Files selected for processing (7)
- indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/tx.rpc.msg.ts (2 hunks)
- indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/tx.ts (6 hunks)
- proto/dydxprotocol/vault/tx.proto (2 hunks)
- protocol/app/msgs/all_msgs.go (1 hunks)
- protocol/app/msgs/internal_msgs.go (1 hunks)
- protocol/app/msgs/internal_msgs_test.go (1 hunks)
- protocol/lib/ante/internal_msg.go (1 hunks)
Files skipped from review as they are similar to previous changes (5)
- indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/tx.rpc.msg.ts
- proto/dydxprotocol/vault/tx.proto
- protocol/app/msgs/all_msgs.go
- protocol/app/msgs/internal_msgs.go
- protocol/lib/ante/internal_msg.go
Additional context used
Biome
indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/tx.ts
[error] 69-69: An empty interface is equivalent to {}.
Safe fix: Use a type alias instead.
(lint/suspicious/noEmptyInterface)
[error] 75-75: An empty interface is equivalent to {}.
Safe fix: Use a type alias instead.
(lint/suspicious/noEmptyInterface)
Additional comments not posted (16)
protocol/app/msgs/internal_msgs_test.go (1)
147-148: Added new message paths for vault quoting parameters.The new message paths for
MsgUpdateDefaultQuotingParamsandMsgUpdateDefaultQuotingParamsResponseare correctly added to the test case. Ensure corresponding message handlers are implemented and tested.indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/tx.ts (15)
3-3: Import statement updated for quoting parameters.The import statement for
QuotingParamsandQuotingParamsSDKTypeis correctly added.
42-45: Added new interfaceMsgUpdateDefaultQuotingParams.The new interface
MsgUpdateDefaultQuotingParamsis correctly defined to handle default quoting parameters.
47-51: InterfaceMsgUpdateDefaultQuotingParamscorrectly defines fields.The interface correctly includes
authorityanddefaultQuotingParamsfields.
53-56: Added new SDK type interfaceMsgUpdateDefaultQuotingParamsSDKType.The new SDK type interface
MsgUpdateDefaultQuotingParamsSDKTypeis correctly defined.
58-62: SDK type interfaceMsgUpdateDefaultQuotingParamsSDKTypecorrectly defines fields.The interface correctly includes
authorityanddefault_quoting_paramsfields.
64-67: Added new interfaceMsgUpdateDefaultQuotingParamsResponse.The new interface
MsgUpdateDefaultQuotingParamsResponseis correctly defined.
69-73: Added new SDK type interfaceMsgUpdateDefaultQuotingParamsResponseSDKType.The new SDK type interface
MsgUpdateDefaultQuotingParamsResponseSDKTypeis correctly defined.Tools
Biome
[error] 69-69: An empty interface is equivalent to {}.
Safe fix: Use a type alias instead.
(lint/suspicious/noEmptyInterface)
176-179: FunctioncreateBaseMsgUpdateDefaultQuotingParamscorrectly initializes default values.The function correctly initializes default values for
MsgUpdateDefaultQuotingParams.
183-190: FunctionMsgUpdateDefaultQuotingParams.encodecorrectly encodes message fields.The function correctly encodes the
authorityanddefaultQuotingParamsfields.
Line range hint
196-210:
FunctionMsgUpdateDefaultQuotingParams.decodecorrectly decodes message fields.The function correctly decodes the
authorityanddefaultQuotingParamsfields.
222-225: FunctionMsgUpdateDefaultQuotingParams.fromPartialcorrectly handles partial messages.The function correctly handles partial messages for
MsgUpdateDefaultQuotingParams.
231-235: FunctioncreateBaseMsgUpdateDefaultQuotingParamsResponsecorrectly initializes default values.The function correctly initializes default values for
MsgUpdateDefaultQuotingParamsResponse.
236-236: FunctionMsgUpdateDefaultQuotingParamsResponse.encodecorrectly encodes message fields.The function correctly encodes the message fields.
240-243: FunctionMsgUpdateDefaultQuotingParamsResponse.decodecorrectly decodes message fields.The function correctly decodes the message fields.
258-259: FunctionMsgUpdateDefaultQuotingParamsResponse.fromPartialcorrectly handles partial messages.The function correctly handles partial messages for
MsgUpdateDefaultQuotingParamsResponse.
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- protocol/app/testdata/default_genesis_state.json (2 hunks)
- protocol/testutil/constants/genesis.go (2 hunks)
Files skipped from review as they are similar to previous changes (1)
- protocol/testutil/constants/genesis.go
Additional comments not posted (2)
protocol/app/testdata/default_genesis_state.json (2)
Line range hint
484-491:
LGTM! Renamingparamstodefault_quoting_paramsenhances clarity.The change makes it clear that these parameters are related to quoting defaults.
493-493: Verify the purpose of adding aparamskey with a null value.The addition of a
paramskey with a null value might be a placeholder for future configuration or to indicate the absence of parameters. Please confirm the intent.
| import "dydxprotocol/vault/vault.proto"; | ||
|
|
||
| option go_package = "github.com/dydxprotocol/v4-chain/protocol/x/vault/types"; | ||
|
|
||
| // GenesisState defines `x/vault`'s genesis state. | ||
| message GenesisState { | ||
| // The parameters of the module. | ||
| Params params = 1 [ (gogoproto.nullable) = false ]; | ||
| // Deprecated since v6.x in favor of default_quoting_params. | ||
| Params params = 1 [ deprecated = true ]; |
There was a problem hiding this comment.
nit: Any issue in using reserved instead?
There was a problem hiding this comment.
hmm yeah that's probably cleaner!
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/vault/types/genesis.pb.gois excluded by!**/*.pb.go
Files selected for processing (5)
- indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/genesis.ts (9 hunks)
- proto/dydxprotocol/vault/genesis.proto (2 hunks)
- protocol/app/testdata/default_genesis_state.json (1 hunks)
- protocol/scripts/genesis/sample_pregenesis.json (1 hunks)
- protocol/testutil/constants/genesis.go (1 hunks)
Files skipped from review as they are similar to previous changes (3)
- protocol/app/testdata/default_genesis_state.json
- protocol/scripts/genesis/sample_pregenesis.json
- protocol/testutil/constants/genesis.go
Additional comments not posted (9)
proto/dydxprotocol/vault/genesis.proto (3)
6-6: Import statement addition looks good.The addition of the
share.protoimport is appropriate given the context of the changes.
13-18: Deprecation and addition of fields are handled correctly.The
paramsfield is deprecated and replaced withdefault_quoting_params, which is correctly defined as non-nullable.
29-30: Renaming ofvault_paramstoquoting_paramsis handled correctly.The
quoting_paramsfield is properly defined and the renaming is consistent with the overall changes.indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/genesis.ts (6)
1-2: Import statements addition looks good.The addition of the
QuotingParamsandQuotingParamsSDKTypeimports is appropriate given the context of the changes.
11-13: Replacement ofparamswithdefaultQuotingParamsis handled correctly.The
defaultQuotingParamsfield is properly defined and the replacement is consistent with the overall changes.
20-22: Replacement ofparamswithdefault_quoting_paramsis handled correctly.The
default_quoting_paramsfield is properly defined and the replacement is consistent with the overall changes.
35-37: Renaming ofvaultParamstoquotingParamsis handled correctly.The
quotingParamsfield is properly defined and the renaming is consistent with the overall changes.
53-55: Renaming ofvault_paramstoquoting_paramsis handled correctly.The
quoting_paramsfield is properly defined and the renaming is consistent with the overall changes.
63-64: Updates to handle new fields in methods are correct.The
encode,decode, andfromPartialmethods are correctly updated to handle the newdefaultQuotingParamsandquotingParamsfields.Also applies to: 74-77, 94-97, 110-110, 121-121, 140-141, 176-176, 206-206
|
@Mergifyio backport release/protocol/v6.x |
✅ Backports have been created
|
(cherry picked from commit b1cb4d0) # Conflicts: # protocol/app/upgrades/v5.2.0/upgrade.go # protocol/testing/genesis.sh
Co-authored-by: Tian <[email protected]>
Changelist
New vault parameter behavior
Paramsrenamed toQuotingParamsx/vaulthasQuotingParams default_quoting_parametersQuotingParams quoting_params, which inherits from above by defaultTest Plan
TBD
Author/Reviewer Checklist
state-breakinglabel.indexer-postgres-breakinglabel.PrepareProposalorProcessProposal, manually add the labelproposal-breaking.feature:[feature-name].backport/[branch-name].refactor,chore,bug.Summary by CodeRabbit
New Features
Bug Fixes
Refactor
Chores