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

chore: add Timeout type #3602

Merged
merged 4 commits into from
May 23, 2023
Merged

chore: add Timeout type #3602

merged 4 commits into from
May 23, 2023

Conversation

charleenfei
Copy link
Contributor

@charleenfei charleenfei commented May 17, 2023

Description

In many parts of the codebase at the moment, we are always submitting both TimeoutHeight and Timestamp together as params to various functions such as SendPacket, NewPacket, etc.

This PR introduces a new Timeout type containing both the height and timestamp, which we can use to simplify these APIs.

Commit Message / Changelog Entry

imp: adding `Timeout` type to 04-channel which encapsulates both timestamp and block height timeout values

see the guidelines for commit messages. (view raw markdown for examples)


Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

  • Targeted PR against correct branch (see CONTRIBUTING.md).
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
  • Code follows the module structure standards and Go style guide.
  • Wrote unit and integration tests.
  • Updated relevant documentation (docs/) or specification (x/<module>/spec/).
  • Added relevant godoc comments.
  • Provide a commit message to be used for the changelog entry in the PR description for review.
  • Re-reviewed Files changed in the Github PR explorer.
  • Review Codecov Report in the comment section below once CI passes.

Copy link
Member

Choose a reason for hiding this comment

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

I guess this wasn't generated when QueryTotalEscrowForDenom was added?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yea, i think the swagger hadn't been regenerated for a while

@damiannolan
Copy link
Member

We could add some extra info to the changelog. E.g.

imp: adding `Timeout` type to 04-channel which encapsulates both timestamp and block height timeout values

@charleenfei charleenfei merged commit ba62612 into main May 23, 2023
@charleenfei charleenfei deleted the charly/timeout_type branch May 23, 2023 13:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants