Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor!: deprecate blocktime on context #17738

Merged
merged 17 commits into from
Sep 18, 2023
Merged

Conversation

tac0turtle
Copy link
Member

Description

pulls out some changes from #17502 as the pr was getting big and had more changes to come.


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...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • run make lint and make test
  • confirmed all CI checks have passed

Reviewers 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...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

@tac0turtle tac0turtle marked this pull request as ready for review September 14, 2023 15:57
@tac0turtle tac0turtle requested a review from a team as a code owner September 14, 2023 15:57
@github-prbot github-prbot requested review from a team, alexanderbez and atheeshp and removed request for a team September 14, 2023 15:57
types/context.go Show resolved Hide resolved
types/context.go Show resolved Hide resolved
@@ -106,7 +106,7 @@ func (k msgServer) CreateValidator(ctx context.Context, msg *types.MsgCreateVali

commission := types.NewCommissionWithTime(
msg.Commission.Rate, msg.Commission.MaxRate,
msg.Commission.MaxChangeRate, sdkCtx.BlockHeader().Time,
msg.Commission.MaxChangeRate, sdkCtx.HeaderInfo().Time,
Copy link
Member

@julienrbrt julienrbrt Sep 16, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think for these kind of changes need an UPGRADING.md section (Unreleased > Modules > All)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this isnt required to be changed as part of this pr. I migrated to be consistent throughout the repo

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You are right, the getter is an alias to the headerinfo, commented before seing it 😅
This does make my other comment even more relevant however.

types/context.go Outdated
@@ -175,6 +173,7 @@ func (c Context) WithHeaderHash(hash []byte) Context {

// 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.
// Deprecated: use WithHeaderInfo instead
func (c Context) WithBlockTime(newTime time.Time) Context {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should kill the setter but keep the getters.
Otherwise now, WithBlockTime/BlockTime with behave very weirdly as BlockTime gets is from the header info.

types/context_test.go Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
@tac0turtle tac0turtle added this pull request to the merge queue Sep 18, 2023
Merged via the queue into main with commit 6615ff4 Sep 18, 2023
51 of 52 checks passed
@tac0turtle tac0turtle deleted the marko/depreacte_blocktime branch September 18, 2023 14:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants