feat: add params to disable script #254
Conversation
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.OpenSSF Scorecard
Scanned Manifest Files |
WalkthroughWalkthroughThe changes introduce a new Changes
Sequence Diagram(s)sequenceDiagram
participant MsgServer
participant Params
participant Keeper
participant User
User->>MsgServer: Request Script Execution
MsgServer->>Keeper: Check ScriptEnabled
Keeper-->>MsgServer: Return ScriptEnabled status
alt Script Enabled
MsgServer->>User: Execute Script
else Script Disabled
MsgServer->>User: Return ErrScriptDisabled
end
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 (
|
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #254 +/- ##
=======================================
Coverage 40.61% 40.62%
=======================================
Files 264 264
Lines 25082 25096 +14
=======================================
+ Hits 10187 10195 +8
- Misses 13326 13329 +3
- Partials 1569 1572 +3
|
![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 (2)
client/docs/swagger-ui/swagger.yamlis excluded by!**/*.yamlx/move/types/types.pb.gois excluded by!**/*.pb.go,!**/*.pb.go
Files selected for processing (8)
- api/initia/gov/v1/gov.pulsar.go (25 hunks)
- api/initia/move/v1/types.pulsar.go (31 hunks)
- proto/initia/move/v1/types.proto (2 hunks)
- x/move/keeper/msg_server.go (1 hunks)
- x/move/keeper/msg_server_test.go (1 hunks)
- x/move/keeper/params.go (1 hunks)
- x/move/types/errors.go (1 hunks)
- x/move/types/params.go (4 hunks)
Additional comments not posted (25)
x/move/types/errors.go (1)
51-52: New error constantErrScriptDisabledadded.The addition of
ErrScriptDisabledis consistent with the existing error handling pattern and enhances error management by providing a specific error for disabled script execution.x/move/keeper/params.go (1)
51-59: New methodScriptEnabledadded toKeeper.The
ScriptEnabledmethod is well-implemented, providing functionality to check if script execution is enabled. It includes proper error handling for parameter retrieval.x/move/types/params.go (4)
17-18: New constantDefaultScriptEnabledadded.The addition of
DefaultScriptEnabledwith a value oftrueenhances configuration options and is integrated seamlessly into the default parameters.
39-39: Integration ofScriptEnabledintoDefaultParams.The
ScriptEnabledfield is correctly included in theDefaultParamsfunction, ensuring it is part of the default parameter set.
79-79: Propagation ofScriptEnabledinToRawmethod.The
ScriptEnabledfield is correctly propagated in theToRawmethod, maintaining consistency in parameter conversion.
90-90: Propagation ofScriptEnabledinToParamsmethod.The
ScriptEnabledfield is correctly propagated in theToParamsmethod, ensuring consistent handling in parameter conversion.proto/initia/move/v1/types.proto (2)
33-34: Addition ofscript_enabledfield.The
script_enabledfield is added to bothParamsandRawParamsmessages to control script execution. This change aligns with the PR's objective to introduce parameters for disabling scripts. Ensure that this field is correctly handled in all relevant parts of the codebase.Also applies to: 60-61
38-38: Reordering of fields inParams.The
allowed_publishersfield index has been updated from 4 to 5. Ensure that this change does not affect backward compatibility with existing serialized data.Run the following script to verify the usage of
Paramsand ensure compatibility:x/move/keeper/msg_server_test.go (1)
69-82: Addition ofTest_ScriptDisabled.The test function
Test_ScriptDisabledeffectively verifies the behavior when script execution is disabled. This enhances test coverage and ensures robustness.x/move/keeper/msg_server.go (2)
140-145: Script execution check inScriptmethod.The addition of a check to determine if script execution is enabled enhances the robustness of the method by ensuring that scripts are only executed when allowed.
140-140: Context parameter name change.The change from
contexttoctxfor the parameter name is a good practice to avoid shadowing the built-incontextpackage and aligns with Go conventions.api/initia/gov/v1/gov.pulsar.go (9)
243-243: Addition offd_Params_vestingis appropriate.The declaration of the field descriptor for the new
Vestingfield in theParamsstruct is necessary for its management.
268-268: Initialization offd_Params_vestingis correct.The field descriptor for the
Vestingfield is properly initialized in theinit()function.
450-455: Update toRangemethod is appropriate.Including the
Vestingfield in theRangemethod ensures consistent handling of all fields in theParamsstruct.
509-510: Update toHasmethod is correct.The method now checks for the presence of the
Vestingfield, consistent with other fields in theParamsstruct.
565-566: Update toClearmethod is appropriate.The method now clears the
Vestingfield, maintaining consistency with other fields in theParamsstruct.
652-654: Update toGetmethod is correct.The method now retrieves the value of the
Vestingfield, consistent with other fields in theParamsstruct.
721-722: Update toSetmethod is appropriate.The method now sets the value of the
Vestingfield, maintaining consistency with other fields in theParamsstruct.
787-791: Update toMutablemethod is correct.The method now provides a mutable reference to the
Vestingfield, consistent with other fields in theParamsstruct.
873-875: Update toNewFieldmethod is appropriate.The method now returns a new value for the
Vestingfield, maintaining consistency with other fields in theParamsstruct.api/initia/move/v1/types.pulsar.go (5)
19-59: LGTM: Version increment for_Params_5_list.The changes from
_Params_4_listto_Params_5_listare straightforward and correctly handle list operations.
Line range hint
433-489: LGTM: Serialization updates forScriptEnabledfield.The
ProtoMethodsfunctions correctly handle the serialization and deserialization of theScriptEnabledfield.Also applies to: 1082-1123
657-675: LGTM: Unmarshalling updates forScriptEnabledfield.The
Unmarshalfunctions correctly parse theScriptEnabledfield.Also applies to: 1290-1309
Line range hint
68-348: LGTM: Addition ofScriptEnabledfield inParams.The
ScriptEnabledfield is consistently handled across methods in theParamsstruct.However, ensure that the usage of
ScriptEnabledis correctly integrated across the codebase.Run the following script to verify the usage of
ScriptEnabled:Verification successful
Verification Successful:
ScriptEnabledis consistently integrated across the codebase.The
ScriptEnabledfield is well-represented in various parts of the codebase, including parameter management, message handling, and tests. This suggests that the integration is thorough and consistent.
- Files with
ScriptEnabledreferences:
x/move/keeper/params.gox/move/keeper/msg_server.gox/move/keeper/msg_server_test.gox/move/types/params.gox/move/types/types.pb.goapi/initia/move/v1/types.pulsar.goScripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify all references to `ScriptEnabled` in the codebase. # Test: Search for the usage of `ScriptEnabled`. Expect: Consistent usage across the codebase. rg --type go 'ScriptEnabled'Length of output: 4065
Line range hint
748-1000: LGTM: Addition ofScriptEnabledfield inRawParams.The
ScriptEnabledfield is consistently handled across methods in theRawParamsstruct.However, ensure that the usage of
ScriptEnabledis correctly integrated across the codebase.Run the following script to verify the usage of
ScriptEnabled:Verification successful
Verified: Consistent usage of
ScriptEnabledacross the codebase.The
ScriptEnabledfield is consistently integrated and used across various files and contexts, including protobuf definitions, comparisons, and function implementations.
- Files and contexts:
x/move/types/types.pb.go: Field definition and usage in comparisons.x/move/keeper/msg_server_test.go: Test case assignments.x/move/keeper/msg_server.go: Function calls.x/move/keeper/params.go: Function definitions and returns.api/initia/move/v1/types.pulsar.go: Multiple method implementations and accessors.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify all references to `ScriptEnabled` in the codebase. # Test: Search for the usage of `ScriptEnabled`. Expect: Consistent usage across the codebase. rg --type go 'ScriptEnabled'Length of output: 4065
Description
Closes: #XXXX
Author Checklist
All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.
I have...
!in the type prefix if API or client breaking changeReviewers Checklist
All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.
I have...