Refactor report builder interfaces. #430
Merged
+263
−136
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
winder
force-pushed
the
will/builder-interfaces
branch
from
5c3ed89 to
4e01194
Compare
winder
requested review from
asoliman92,
makramkd,
dimkouv,
mateusz-sekara,
0xAustinWang,
0xnogo and
b-gopalswami
asoliman92
reviewed
Jan 10, 2025
asoliman92
reviewed
Jan 10, 2025
execute/report/report.go
Outdated
| // temporary map to store state between nonce checks for this round. | ||
| expectedNonce := make(map[cciptypes.ChainSelector]map[string]uint64) | ||
| return func(lggr logger.Logger, msg cciptypes.Message, idx int, report exectypes.CommitData) (messageStatus, error) { | ||
| if msg.Header.Nonce != 0 { |
There was a problem hiding this comment.
Is it a valid input to have a Zero nonce? We return None status if it's Zero
There was a problem hiding this comment.
Yes, setting it to zero is how we allow out of order execution.
There was a problem hiding this comment.
I'll add a comment here explaining that.
asoliman92
reviewed
Jan 10, 2025
execute/report/report.go
Outdated
| } | ||
|
|
||
| // Check expected nonce is valid for sequenced messages. | ||
| if msg.Header.Nonce != expectedNonce[report.SourceChain][sender] { |
There was a problem hiding this comment.
That assumes that messages will be sent to this function in order? Should this be a holding assumption always?
There was a problem hiding this comment.
Yes, if they're sent out of my order the expected nonce will be wrong.
asoliman92
reviewed
Jan 10, 2025
asoliman92
previously approved these changes
Jan 10, 2025
winder
force-pushed
the
will/builder-interfaces
branch
from
4e01194 to
b724aaa
Compare
|
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 PR contains no functional changes, only refactoring to the execution report builder.
New functional options for
report.NewBuilderwhich allow for more dynamic configuration without further modification to the function signature.Break the message checking functions into multiple
Checkfunctions which can be added or removed based on requirements for a particular chain. This also allows more complex checks to be added without increasing the overall builder complexity, for example converting the nonce checking to the new scheme allowed me to remove two variables from the builder struct.