fix: Make WithBlockTime() consistent with CometBFT canonical time #15124
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
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Comment on lines
142
to
153
| return c | ||
| } | ||
|
|
||
| // WithBlockTime returns a Context with an updated CometBFT block header time in UTC time | ||
| // WithBlockTime returns a Context with an updated CometBFT block header time in UTC with no monotonic component. | ||
| // Stripping the monotonic component is for time equality. | ||
| func (c Context) WithBlockTime(newTime time.Time) Context { | ||
| newHeader := c.BlockHeader() | ||
| // https://github.com/gogo/protobuf/issues/519 | ||
| newHeader.Time = newTime.UTC() | ||
| newHeader.Time = newTime.Round(0).UTC() | ||
| return c.WithBlockHeader(newHeader) | ||
| } | ||
|
|
There was a problem hiding this comment.
Change potentially affects state.
Call sequence:
(github.com/cosmos/cosmos-sdk/types.Context).WithHeaderHash (types/context.go:137)
(*github.com/cosmos/cosmos-sdk/baseapp.BaseApp).BeginBlock (types/context.go:156)
julienrbrt
reviewed
Feb 22, 2023
| func (c Context) WithBlockTime(newTime time.Time) Context { | ||
| newHeader := c.BlockHeader() | ||
| // https://github.com/gogo/protobuf/issues/519 | ||
| newHeader.Time = newTime.UTC() | ||
| newHeader.Time = newTime.Round(0).UTC() |
There was a problem hiding this comment.
Can we add a test to compare they give the same time?
tac0turtle
approved these changes
Feb 22, 2023
julienrbrt
approved these changes
Feb 22, 2023
|
@Mergifyio backport release/v0.47.x |
✅ Backports have been created
|
19 tasks
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
Closes: #15057
This PR adds changes to make WithBlockTime() consistent with CometBFT canonical time and changes the spec for it
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...
!to the type prefix if API or client breaking changeCHANGELOG.mdReviewers 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...
!in the type prefix if API or client breaking change