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

feat(x/ecocredit): add bridge receive event and update bridge event #1224

Merged
merged 2 commits into from
Jun 29, 2022

Conversation

ryanchristo
Copy link
Member

@ryanchristo ryanchristo commented Jun 28, 2022

Description

Ref: #1193 / Ref: #1206

This pull request adds EventBridgeReceive and updates EventBridge to include amount. Additional changes included after running make proto-format and make tidy.


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
  • 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)

@ryanchristo ryanchristo marked this pull request as ready for review June 28, 2022 21:22
@codecov
Copy link

codecov bot commented Jun 28, 2022

Codecov Report

Merging #1224 (fc62b72) into master (9bdf10d) will increase coverage by 0.00%.
The diff coverage is 89.18%.

@@           Coverage Diff           @@
##           master    #1224   +/-   ##
=======================================
  Coverage   70.94%   70.95%           
=======================================
  Files         240      240           
  Lines       24324    24349   +25     
=======================================
+ Hits        17257    17276   +19     
- Misses       5655     5658    +3     
- Partials     1412     1415    +3     
Flag Coverage Δ
experimental-codecov 70.91% <89.18%> (+0.02%) ⬆️
stable-codecov 65.89% <89.18%> (+0.04%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Copy link
Contributor

@technicallyty technicallyty left a comment

Choose a reason for hiding this comment

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

lgtm!

Copy link
Member

@clevinson clevinson left a comment

Choose a reason for hiding this comment

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

lgtm. Only question is if we should also add amount to BridgeReceive. I'm not sure that EventBridgeReceive conveys anything meaningful with just project_id and batch_denom as the only fields.


// EventBridgeReceive is emitted when credits are bridged from another chain.
message EventBridgeReceive {
Copy link
Member

Choose a reason for hiding this comment

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

What's the use case for this event? I'm wondering if we should also add amount here too?

Copy link
Member Author

@ryanchristo ryanchristo Jun 29, 2022

Choose a reason for hiding this comment

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

amount is redundant with EventMint, which will be emitted from Msg/CreateBatch or Msg/MintBatchCredits.

In general, we are taking a lean approach to event fields based on how events are written in the sdk. EventBridge is a special case because we want to make all necessary information easily accessible to the bridge service.

We would ideally include an event specific to each message so that we can track the execution of each message and the two fields here (project id and batch denom) seem to be the most relevant to Msg/BridgeReceive.

See #1035 and #1086 for reference.

Copy link
Member Author

Choose a reason for hiding this comment

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

If anything, we could probably remove project id but it still seems relevant.

@ryanchristo ryanchristo merged commit f561931 into master Jun 29, 2022
@ryanchristo ryanchristo deleted the ryan/1193-bridge-events branch June 29, 2022 15:14
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.

3 participants