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 credit class designer to admin (#496) #500

Merged
merged 10 commits into from
Sep 1, 2021

Conversation

ruhatch
Copy link
Contributor

@ruhatch ruhatch commented Aug 26, 2021

Description

This renames credit class designer to admin, because this a more accurate description of the permissions of this account. The actual designer of the class may not be involved in the process of managing the credit class on-chain.

Closes: #496


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)

@codecov
Copy link

codecov bot commented Aug 26, 2021

Codecov Report

Merging #500 (16213e4) into master (adcf73f) will increase coverage by 0.00%.
The diff coverage is 96.00%.

@@           Coverage Diff           @@
##           master     #500   +/-   ##
=======================================
  Coverage   77.08%   77.08%           
=======================================
  Files         101      101           
  Lines       12824    12826    +2     
=======================================
+ Hits         9885     9887    +2     
  Misses       2332     2332           
  Partials      607      607           
Flag Coverage Δ
experimental-codecov 77.08% <96.00%> (+<0.01%) ⬆️
stable-codecov 67.85% <96.00%> (+<0.01%) ⬆️

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

Copy link
Member

@ryanchristo ryanchristo left a comment

Choose a reason for hiding this comment

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

As you mentioned in the issue, when checking whether an address is on the allowlist, I'm pretty sure we want to check the --from address rather than the admin address provided in the request.

Also, should the creator pay the fee? This would prevent the need for two signatures.

x/ecocredit/params.go Outdated Show resolved Hide resolved
x/ecocredit/params.go Outdated Show resolved Hide resolved
x/ecocredit/params_test.go Outdated Show resolved Hide resolved
@ruhatch
Copy link
Contributor Author

ruhatch commented Aug 27, 2021

As you mentioned in the issue, when checking whether an address is on the allowlist, I'm pretty sure we want to check the --from address rather than the admin address provided in the request.

Also, should the creator pay the fee? This would prevent the need for two signatures.

So I've modified it to set the admin based on the --from flag so that creator and admin are always the same. I think we can keep the separate terms like you suggested, because the allowlist is about creation and is only used in that stage.

@ruhatch ruhatch marked this pull request as ready for review August 27, 2021 12:23
@ruhatch ruhatch requested a review from ryanchristo August 27, 2021 12:23
@ruhatch ruhatch force-pushed the ruhatch/class-admin branch from 440ed3f to 654d35f Compare August 27, 2021 15:59
Copy link
Member

@ryanchristo ryanchristo left a comment

Choose a reason for hiding this comment

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

This looks good to me. I think removing the CLI parameter for admin and using --from helps make things more clear from a user perspective.

x/ecocredit/client/tx.go Outdated Show resolved Hide resolved
Copy link
Member

@blushi blushi left a comment

Choose a reason for hiding this comment

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

LGTM!

@ruhatch ruhatch merged commit e701d84 into master Sep 1, 2021
@ruhatch ruhatch deleted the ruhatch/class-admin branch September 1, 2021 14:33
@blushi blushi mentioned this pull request Sep 2, 2021
19 tasks
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.

Update Credit Class Designer to "Credit Class Admin"
3 participants