chore: fix some comments #2762
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
|
|
@@ -10,20 +10,20 @@ | |||||||
| // Sequencer is a generic interface for a sequencer | ||||||||
| type Sequencer interface { | ||||||||
| // SubmitBatchTxs submits a batch of transactions to sequencer | ||||||||
| // Id is the unique identifier for the target chain | ||||||||
| // Batch is the batch of transactions to submit | ||||||||
| // returns an error if any from the sequencer | ||||||||
| SubmitBatchTxs(ctx context.Context, req SubmitBatchTxsRequest) (*SubmitBatchTxsResponse, error) | ||||||||
|
|
||||||||
| // GetNextBatch returns the next batch of transactions from sequencer to | ||||||||
| // Id is the unique identifier for the target chain | ||||||||
|
There was a problem hiding this comment. The comment should refer to the 'target chain' for clarity. It's important to be specific in documentation to avoid ambiguity.
Suggested change
|
||||||||
| // LastBatchHash is the cryptographic hash of the last batch received by the | ||||||||
| // MaxBytes is the maximum number of bytes to return in the batch | ||||||||
| // returns the next batch of transactions and an error if any from the sequencer | ||||||||
| GetNextBatch(ctx context.Context, req GetNextBatchRequest) (*GetNextBatchResponse, error) | ||||||||
|
|
||||||||
| // VerifyBatch verifies a batch of transactions received from the sequencer | ||||||||
| // Id is the unique identifier for the target chain | ||||||||
|
There was a problem hiding this comment. The comment should refer to the 'target chain' for clarity. It's important to be specific in documentation to avoid ambiguity.
Suggested change
|
||||||||
| // BatchHash is the cryptographic hash of the batch to verify | ||||||||
| // returns a boolean indicating if the batch is valid and an error if any from the sequencer | ||||||||
| VerifyBatch(ctx context.Context, req VerifyBatchResponse) (*VerifyBatchResponse, error) | ||||||||
|
|
||||||||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The comment should refer to the 'target chain' for clarity.
It's important to be specific in documentation to avoid ambiguity.