[Linter] Public mut tx context #16878
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
4 Skipped Deployments
|
qvmoveguy
reviewed
Mar 31, 2024
external-crates/move/crates/move-compiler/tests/custom_rules/public_mut_tx_context.exp
Outdated
Show resolved
Hide resolved
tx-tomcat
force-pushed
the
custom_rules/public_mut_tx_context
branch
from
4f8e7a9
to
48721ac
Compare
|
@tx-tomcat is attempting to deploy a commit to the Mysten Labs Team on Vercel. A member of the Team first needs to authorize it. |
tx-tomcat
force-pushed
the
custom_rules/public_mut_tx_context
branch
from
48721ac
to
282454b
Compare
tx-tomcat
force-pushed
the
custom_rules/public_mut_tx_context
branch
from
282454b
to
e9f0265
Compare
tnowacki
requested changes
Aug 12, 2024
external-crates/move/crates/move-compiler/src/linters/public_mut_tx_context.rs
Outdated
Show resolved
Hide resolved
external-crates/move/crates/move-compiler/tests/linter/correct_public_mut_tx_context.move
Outdated
Show resolved
Hide resolved
external-crates/move/crates/move-compiler/tests/move_check_testsuite.rs
Outdated
Show resolved
Hide resolved
tx-tomcat
force-pushed
the
custom_rules/public_mut_tx_context
branch
from
e9f0265
to
839ac30
Compare
tx-tomcat
force-pushed
the
custom_rules/public_mut_tx_context
branch
from
839ac30
to
304a8a5
Compare
tx-tomcat
force-pushed
the
custom_rules/public_mut_tx_context
branch
2 times, most recently
from
69410c5
to
069c997
Compare
tx-tomcat
force-pushed
the
custom_rules/public_mut_tx_context
branch
from
069c997
to
9b28751
Compare
tnowacki
approved these changes
Aug 14, 2024
suiwombat
pushed a commit
that referenced
this pull request
Sep 16, 2024
## Description This linter checks public functions to ensure they use `&mut TxContext` instead of `&TxContext `for better upgradability. Here's a step-by-step breakdown of how to implement this linter: Implement the main logic : `check_function_parameters`: Iterate through function parameters. `is_immutable_tx_context`: Check if a parameter is an immutable `TxContext`. `is_tx_context_type`: Check if a type is `TxContext`. `is_sui_tx_context`: Verify if the type is from the `sui::tx_context` module. ## Test plan Added more use case including false positive, false negative case ## Release notes - [ ] Protocol: - [ ] Nodes (Validators and Full nodes): - [ ] Indexer: - [ ] JSON-RPC: - [ ] GraphQL: - [X] CLI: Move will now lint against using `&TxContext` instead of `&mut TxContext` in public functions - [ ] Rust SDK: --------- Co-authored-by: jamedzung <dung.dinhnguyen@digitalavenues.com> Co-authored-by: Todd Nowacki <tmn@mystenlabs.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This linter checks public functions to ensure they use
&mut TxContextinstead of&TxContextfor better upgradability. Here's a step-by-step breakdown of how to implement this linter:Implement the main logic :
check_function_parameters: Iterate through function parameters.is_immutable_tx_context: Check if a parameter is an immutableTxContext.is_tx_context_type: Check if a type isTxContext.is_sui_tx_context: Verify if the type is from thesui::tx_contextmodule.Test plan
Added more use case including false positive, false negative case
Release notes
&TxContextinstead of&mut TxContextin public functions