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(x/ecocredit): update core proto comments and fields #1161

Merged
merged 5 commits into from
Jun 14, 2022

Conversation

ryanchristo
Copy link
Member

@ryanchristo ryanchristo commented Jun 7, 2022

Description

Ref: #715

This pull request updates proto comments, updates Issuer to Admin in MsgCreateProject (the address that will become the admin of the project, same as MsgCreateClass and other messages, i.e. we don't use Creator for MsgCreateClass), moves BatchIssuance to types, moves and makes use of Credits, and updates MsgUpdateCreditClassMetada to use NewMetadata rather than Metadata (same as other update methods and when updating a project).


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 mentioned this pull request Jun 7, 2022
31 tasks
@codecov
Copy link

codecov bot commented Jun 7, 2022

Codecov Report

❗ No coverage uploaded for pull request base (master@1f7fa5a). Click here to learn what that means.
The diff coverage is 56.66%.

@@            Coverage Diff            @@
##             master    #1161   +/-   ##
=========================================
  Coverage          ?   69.62%           
=========================================
  Files             ?      221           
  Lines             ?    23075           
  Branches          ?        0           
=========================================
  Hits              ?    16065           
  Misses            ?     5623           
  Partials          ?     1387           
Flag Coverage Δ
experimental-codecov 69.69% <56.66%> (?)
stable-codecov 64.08% <56.66%> (?)

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

@ryanchristo ryanchristo changed the title docs(x/ecocredit): update ecocredit proto comments refactor(x/ecocredit): update core proto comments and fields Jun 7, 2022
@ryanchristo
Copy link
Member Author

Pending #1160

@ryanchristo
Copy link
Member Author

Some overlap with #1160 but ready for review.

@ryanchristo ryanchristo marked this pull request as ready for review June 10, 2022 21:12
Comment on lines +23 to +25
// basket_fee is a list of basket creation fees accepted when creating a
// basket. Any fee listed is accepted and charged to the basket creator when
// creating a basket.
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 is not the current behavior but should be. See #1165.

Comment on lines +72 to +76
// The country-code must be 2 alphabetic characters, the sub-national-code
// can be 1-3 alphanumeric characters, and the postal-code can be up to 64
// alphanumeric characters. Only the country-code is required, while the
// sub-national-code and postal-code are optional and can be added for
// increased precision.
Copy link
Member Author

Choose a reason for hiding this comment

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

Removed mention of needing to conform to ISO 3166-2 here and elsewhere given the current implementation does not require this and we want to avoid being political and requiring a protocol update to update accepted countries.

@ryanchristo ryanchristo merged commit f219544 into master Jun 14, 2022
@ryanchristo ryanchristo deleted the ryan/715-ecocredit-api-audit branch June 14, 2022 16:19
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