Improve Clarity in ChainPorter State Names #1036
Merged
Conversation
This file contains hidden or 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
Renamed the `ChainPorter` state `SendStateLogCommit` to `SendStateStorePreBroadcast` for better clarity on the state's functionality
Renamed the `ChainPorter` state `SendStateReceiverProofTransfer` to `SendStateTransferProofs` for better clarity. This change makes it clear that in that state the `ChainPorter` may transfer multiple proofs.
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.
This pull request includes two changes to the
ChainPorterstates to improve clarity and better reflect their functionality.Changes:
Rename
SendStateLogCommittoSendStateStorePreBroadcast:SendStateLogCommithas been renamed toSendStateStorePreBroadcast.Rename
SendStateReceiverProofTransfertoSendStateTransferProofs:SendStateReceiverProofTransferhas been renamed toSendStateTransferProofs.ChainPortermay transfer multiple proofs, improving understanding of its purpose.These changes enhance code readability and maintainability by providing more descriptive state names.