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: rename genesis type RegisteredRelayer to RegisteredCounterpartyPayee #1514

Merged
merged 15 commits into from
Jun 15, 2022

Conversation

damiannolan
Copy link
Member

@damiannolan damiannolan commented Jun 8, 2022

Description

Renaming GenesisState field to RegisteredCounterpartyPayee to align

needs: #1513
closes: #XXXX


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.
  • Wrote unit and integration tests
  • Updated relevant documentation (docs/) or specification (x/<module>/spec/)
  • Added relevant godoc comments.
  • Added a relevant changelog entry to the Unreleased section in CHANGELOG.md
  • Re-reviewed Files changed in the Github PR explorer
  • Review Codecov Report in the comment section below once CI passes

@codecov-commenter
Copy link

codecov-commenter commented Jun 9, 2022

Codecov Report

Merging #1514 (84439e0) into main (dab07f9) will increase coverage by 0.00%.
The diff coverage is 85.48%.

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1514   +/-   ##
=======================================
  Coverage   80.24%   80.25%           
=======================================
  Files         166      166           
  Lines       12254    12274   +20     
=======================================
+ Hits         9833     9850   +17     
- Misses       1957     1959    +2     
- Partials      464      465    +1     
Impacted Files Coverage Δ
modules/apps/29-fee/types/genesis.go 78.12% <52.63%> (-3.85%) ⬇️
modules/apps/29-fee/keeper/genesis.go 87.50% <100.00%> (ø)
modules/apps/29-fee/keeper/keeper.go 92.48% <100.00%> (ø)
modules/apps/transfer/types/trace.go 90.08% <100.00%> (+1.62%) ⬆️

Copy link
Contributor

@charleenfei charleenfei left a comment

Choose a reason for hiding this comment

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

lgtm!

@@ -259,22 +259,22 @@ func (suite *KeeperTestSuite) TestGetAllFeeEnabledChannels() {
}

func (suite *KeeperTestSuite) TestGetAllRelayerAddresses() {
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 test function needs to be renamed!

Copy link
Member Author

Choose a reason for hiding this comment

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

I accidentally pushed this change to #1522. Doesn't make much difference really, both will be merged one after the other

Copy link
Contributor

@chatton chatton left a comment

Choose a reason for hiding this comment

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

LGTM

@@ -38,19 +38,20 @@ message FeeEnabledChannel {
// RegisteredPayee contains the relayer address and payee address for a specific channel
message RegisteredPayee {
// the relayer address
string relayer_address = 1 [(gogoproto.moretags) = "yaml:\"relayer_address\""];
string relayer = 1;
// the payee address
string payee = 2;
// unique channel identifier
string channel_id = 3 [(gogoproto.moretags) = "yaml:\"channel_id\""];
Copy link
Contributor

Choose a reason for hiding this comment

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

This is a nit, but should we move the channel_id to the first position? Usually we have the port_id and channel_id in the first positions of the messages?

Copy link
Member Author

Choose a reason for hiding this comment

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

I don't feel very strong about this tbh. I'll go ahead and make the change and get this merged

Copy link
Member Author

Choose a reason for hiding this comment

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

done for both 👍

string counterparty_address = 2 [(gogoproto.moretags) = "yaml:\"counterparty_address\""];
string relayer = 1;
// the counterparty payee address
string counterparty_payee = 2 [(gogoproto.moretags) = "yaml:\"counterparty_payee\""];
// unique channel identifier
string channel_id = 3 [(gogoproto.moretags) = "yaml:\"channel_id\""];
Copy link
Contributor

Choose a reason for hiding this comment

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

Same comment here.

@damiannolan damiannolan merged commit 0252bfb into main Jun 15, 2022
@damiannolan damiannolan deleted the damian/rename-genesis-register-counterparty-addr branch June 15, 2022 09:16
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.

5 participants