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.

Sign up for GitHub

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

Jump to bottom

Remove Info suffix from ecocredit state proto messages #1029

Closed
4 tasks
Tracked by #818
ryanchristo opened this issue Apr 18, 2022 · 1 comment · Fixed by #1040
Closed
4 tasks
Tracked by #818

Remove Info suffix from ecocredit state proto messages #1029

ryanchristo opened this issue Apr 18, 2022 · 1 comment · Fixed by #1040
Assignees
@aleem1314
Labels
Scope: x/ecocredit Issues that update the x/ecocredit module Type: Refactor A code change that neither fixes a bug nor adds a feature
Milestone
v4.0 - Llangorse ...

Comments

@ryanchristo
Copy link
Member

ryanchristo commented Apr 18, 2022 •
edited
Loading

Summary

In order to create human-readable query responses for the ecocredit module (#1022), we need to create a new proto message for each query response (i.e. we are currently using state proto messages that represent addresses as bytes and that include identifiers only meant to be used internally).

The state messages already use the Info suffix, which seems like a potentially fitting suffix to add to the query proto messages that include human-readable information about the item queried. Also, the removal of the Info suffix from the state proto messages has been requested for other reasons (see #1004 (comment)).

Problem Definition

The Info suffix is being used for state proto messages that include information that is not human-readable.

Proposal

Rename ClassInfo, ProjectInfo, and BatchInfo to Class, Project, and Batch.

For Admin Use

  • Not duplicate issue
  • Appropriate labels applied
  • Appropriate contributors tagged
  • Contributor assigned/self-assigned
@ryanchristo ryanchristo added Status: Proposed Scope: x/ecocredit Issues that update the x/ecocredit module labels Apr 18, 2022
@aaronc
Copy link
Member

aaronc commented Apr 19, 2022

Sounds good to me 👍

@ryanchristo ryanchristo added Type: Refactor A code change that neither fixes a bug nor adds a feature and removed Status: Proposed labels Apr 19, 2022
@ryanchristo ryanchristo added this to the v4.0 - Llangorse Upgrade milestone Apr 19, 2022
@ryanchristo ryanchristo mentioned this issue Apr 19, 2022
Closed
@aleem1314 aleem1314 self-assigned this Apr 20, 2022
@aleem1314 aleem1314 mentioned this issue Apr 20, 2022
Merged
19 tasks
@ryanchristo ryanchristo mentioned this issue May 5, 2022
Merged
19 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@aleem1314 aleem1314

Labels
Scope: x/ecocredit Issues that update the x/ecocredit module Type: Refactor A code change that neither fixes a bug nor adds a feature
Projects
None yet
Milestone
v4.0 - Llangorse Upgrade
Development

Successfully merging a pull request may close this issue.

refactor(ecocredit): remove info suffix from state proto messages regen-network/regen-ledger
3 participants
@aaronc @ryanchristo @aleem1314