feat(x/ecocredit)!: implement independent projects #2167

aaronc · 2024-02-13T16:05:58Z

Description

Review instructions:

please check the CHANGELOG and modified .proto files first
to review new code, I suggest looking at the new .feature files first
changes to existing code have mostly involved removing the assumption that the class is implied by the project and that an enrollment is needed
you will need to look at some large diffs that github has hidden by default because they're so big, sorry

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...

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)

…onc/independent-projects

Co-authored-by: Cory <cjlevinson@gmail.com>

…ojects-impl

codecov · 2024-03-31T23:16:39Z

Codecov Report

Attention: Patch coverage is 62.42545% with 189 lines in your changes are missing coverage. Please review.

Project coverage is 72.61%. Comparing base (3d818cf) to head (5d5249e).

❗ Current head 5d5249e differs from pull request most recent head 7c6fdb2

Please upload reports for the commit 7c6fdb2 to get more accurate results.

Additional details and impacted files

@@             Coverage Diff             @@
##             main    #2167       +/-   ##
===========================================
+ Coverage   62.24%   72.61%   +10.36%     
===========================================
  Files         277      251       -26     
  Lines       16434    14374     -2060     
===========================================
+ Hits        10230    10437      +207     
+ Misses       5449     3134     -2315     
- Partials      755      803       +48

Files	Coverage Δ
x/ecocredit/base/keeper/keeper.go	`100.00% <ø> (ø)`
x/ecocredit/base/keeper/msg_bridge_receive.go	`80.00% <100.00%> (+2.30%)`	⬆️
x/ecocredit/base/keeper/msg_burn_regen.go	`51.61% <ø> (ø)`
x/ecocredit/base/keeper/msg_cancel.go	`60.86% <100.00%> (ø)`
x/ecocredit/base/keeper/msg_create_class.go	`64.55% <100.00%> (-2.11%)`	⬇️
x/ecocredit/base/keeper/msg_mint_batch_credits.go	`57.02% <100.00%> (+1.02%)`	⬆️
x/ecocredit/base/keeper/msg_retire.go	`59.75% <100.00%> (ø)`
x/ecocredit/base/keeper/msg_send.go	`69.23% <100.00%> (ø)`
x/ecocredit/base/keeper/query_project_info.go	`100.00% <ø> (+14.28%)`	⬆️
x/ecocredit/base/keeper/query_projects.go	`66.66% <ø> (+3.25%)`	⬆️
... and 26 more

... and 35 files with indirect coverage changes

aaronc · 2024-03-31T23:48:09Z

I am finally marking this as ready for review.

The remaining lint errors are in my mind overly pedantic and I'm considering updating the lint config to disable them.

paul121

Nice work @aaronc this is a lot but looking pretty good to me. I think I have reviewed most of these changes but might take a second look with fresh eyes later.

I was going to try and run this locally to test a few things out but just saw the separate PR #2202 that adds CLI commands. Would this be worth testing at this point?

x/ecocredit/base/types/v1/features/msg_add_credit_type.feature

x/ecocredit/server/utils/utils.go

CHANGELOG.md

paul121 · 2024-04-11T01:04:24Z

x/ecocredit/base/keeper/features/msg_create_batch.feature

@@ -18,40 +18,40 @@ Feature: Msg/CreateBatch
    Background:
      Given a credit type with abbreviation "C"
      And a credit class with class id "C01" and issuer alice
-      And a project with project id "C01-001"
+      And a project with project id "P001" enrolled in "C01"


There is no scenario to cover issuing a credit batch for a project that does not have an ACCEPTED enrollment status. Maybe this Rule could be expanded: "The project must exist and have an accepted enrollment to a credit class"

Added a test to cover this: 4336def

proto/regen/ecocredit/v1/query.proto

paul121 · 2024-04-11T01:15:26Z

x/ecocredit/base/keeper/msg_create_or_update_application.go

+	if msg.Withdraw {
+		action = types.EventUpdateApplication_ACTION_WITHDRAW
+		if err := k.stateStore.ProjectEnrollmentTable().Delete(ctx, enrollment); err != nil {
+			return nil, err
+		}


Should a project admin be able to withdraw their application if it already has project enrollment status ACCEPTED ?

No, I discussed this with @S4mmyb and because of programmatic requirements sometimes in legal contracts, only an issuer should be able to terminate an approved project.

Makes sense. This logic might require a change then because there doesn't seem to be a check for the enrollment status here. Could use a test scenario as well

Added a test scenario here: 7c6fdb2 and turns out this logic wasn't properly implemented. So good catch @paul121 👍

Implementation looks good, left a suggestion re: the test rule text

paul121 · 2024-04-11T01:28:47Z

x/ecocredit/base/keeper/msg_create_project.go

+	if req.ReferenceId != "" {
+		project.ReferenceId = req.ReferenceId
+		// only set deprecated class key if reference id is not empty to support the use case of reference IDs
+		project.ClassKey = classInfo.Key //nolint:staticcheck
+	}


It seems that the reference ID can only be set by credit class issuers when directly creating + enrolling a project into a credit class via MsgCreateProject and there is no way to update this value. If a project is created by an admin and applies to a credit class it doesn't seem that the reference ID could be set. Is this intentional? Would it make sense to move the reference ID to the ProjectEnrollmentTable?

The reference ID is only relevant in the case of bridging and I can consider it a legacy use case. It needs to be in the project table to impose an unique constraint on it, again only needed for bridging.

The reference ID is only relevant in the case of bridging and I can consider it a legacy use case.

Oh interesting, I did not realize this was only intended for bridging. In fact we are using the reference ID field in another way on some projects we are working on (SeaTrees, ZFP). It is useful as a key to reference on-chain projects with existing "external IDs" programs may already be using. This makes it much easier to create scripts that update projects in bulk when metadata might be changing in an external CMS of some kind.

It would be good to know if this will be supported going forward. These projects/processes are being deployed on Redwood now and could be deployed on mainnet in the coming months.

// reference_id is any arbitrary string that can be use to reference project.

https://buf.build/regen/regen-ledger/docs/main:regen.ecocredit.v1#regen.ecocredit.v1.ProjectInfo

I don't think we're planning to remove the support, but I'd prefer not to add or update the functionality much unless there's a specific use case. Basically, it can only be added at creation, not modified and there will be an unique constraint on reference ID and originally enrolled credit class.

x/ecocredit/base/keeper/features/msg_update_project_enrollment.feature

aaronc · 2024-04-11T02:32:06Z

I was going to try and run this locally to test a few things out but just saw the separate PR #2202 that adds CLI commands. Would this be worth testing at this point?

If you're going to test manually, the CLI commands would be useful. How should we handle this? Would you test in that branch? Or should I just merge the CLI into here?

paul121 · 2024-04-11T21:12:30Z

I was going to try and run this locally to test a few things out but just saw the separate PR #2202 that adds CLI commands. Would this be worth testing at this point?

If you're going to test manually, the CLI commands would be useful. How should we handle this? Would you test in that branch? Or should I just merge the CLI into here?

I can do either way. Comparing the two branches, looks like there aren't many changes. Maybe merging here is easiest. aaronc/independent-projects-impl...aaronc/independent-projects-cli

Co-authored-by: Paul Weidner <paul.weidner@gmail.com>

…t-projects-impl

aaronc · 2024-05-02T17:44:30Z

I was going to try and run this locally to test a few things out but just saw the separate PR #2202 that adds CLI commands. Would this be worth testing at this point?

If you're going to test manually, the CLI commands would be useful. How should we handle this? Would you test in that branch? Or should I just merge the CLI into here?

I can do either way. Comparing the two branches, looks like there aren't many changes. Maybe merging here is easiest. aaronc/independent-projects-impl...aaronc/independent-projects-cli

I went ahead and merged the CLI code into this PR.

Co-authored-by: Paul Weidner <paul.weidner@gmail.com>

aaronc · 2024-05-28T23:12:51Z

@paul121 I believe I've addressed all your comments. Can you re-review when you get a chance please?

paul121 · 2024-06-01T16:20:52Z

x/ecocredit/base/keeper/features/msg_create_or_update_application.feature

@@ -61,4 +61,11 @@ Feature: Msg/CreateOrUpdateApplication
      Then expect error contains "unauthorized"
      And expect the application for "P001" to "C01" exists with metadata "abc123"

-  Rule: events get emitted
+  Rule: project admins cannot withdraw a project with an accepted enrollment (a credit class issuer must do that)


Suggested change

Rule: project admins cannot withdraw a project with an accepted enrollment (a credit class issuer must do that)

Rule: project admins cannot withdraw a project with an accepted enrollment

Just got hung up on this getting my head back into things.. this implies a credit class issuer can withdraw a project. But only project admins can attempt a withdraw via MsgCreateorUpdateApplication. To remove the project enrollment from state credit class issuers must change enrollment status from ACCEPTED -> TERMINATED. Maybe just drop (a credit class issuer must do that) for clarity?

paul121 · 2024-06-01T16:34:19Z

x/ecocredit/base/keeper/msg_update_project_enrollment.go

+	case ecocreditv1.ProjectEnrollmentStatus_PROJECT_ENROLLMENT_STATUS_ACCEPTED:
+		switch newStatus {
+		case ecocreditv1.ProjectEnrollmentStatus_PROJECT_ENROLLMENT_STATUS_ACCEPTED:
+			// Valid case for just updating metadata of an accepted project
+		case ecocreditv1.ProjectEnrollmentStatus_PROJECT_ENROLLMENT_STATUS_TERMINATED:
+			remove = true
+		default:
+			return nil, sdkerrors.ErrInvalidRequest.Wrapf("invalid status transition from %s to %s", existingStatus, newStatus)
+		}


I think these state transitions from enrollment status ACCEPTED could have better tests. Right now I only see one test case for the valid ACCEPTED -> TERMINATED transition, and one for the invalid ACCEPTED -> REJECTED transition.

paul121 · 2024-06-01T16:34:45Z

x/ecocredit/base/keeper/features/msg_update_project_enrollment.feature

+        | I01 accepted to rejected            | ACCEPTED          | foo123       | I01    | REJECTED   | baz789       | invalid      | true   |
+        | Bob accepted to rejected            | ACCEPTED          | foo123       | Bob    | REJECTED   | baz789       | unauthorized | true   |


Related to my other comment, I think this is the only test for an invalid state transition from enrollment status ACCEPTED.

aaronc and others added 28 commits January 30, 2024 11:27

feat(x/ecocredit): independent project API

89e7630

feat(x/ecocredit): independent project API

c54af2a

fixes and proto-gen

d98b364

updates

78d71e1

add credit class to batch

cf50830

Merge branch 'main' of github.com:regen-network/regen-ledger into aar…

0139192

…onc/independent-projects

update to multiple credit classes per project

4a7370e

updates

f4146a3

add queries

864c63b

add queries

7f0af0d

add events

f6d3f93

Update proto/regen/ecocredit/v1/tx.proto

041af55

Co-authored-by: Cory <cjlevinson@gmail.com>

Update proto/regen/ecocredit/v1/tx.proto

ea41f12

Co-authored-by: Cory <cjlevinson@gmail.com>

address review comments

c3c15cd

proto-gen

d13c13c

fix build errors

809c089

fix tests with msg stubs

fe74b46

add msg_create_unregistered_project.feature

1798de5

udpates

b571c1f

update design

ad6b522

docs

a03d165

fixes

4c81f78

Merge branch 'aaronc/independent-projects' into aaronc/independent-pr…

89e986f

…ojects-impl

tests

222a6af

tests

d5feae9

tests and validation

4921fbe

add project creation fee

84ac1a4

Merge branch 'aaronc/independent-projects' into aaronc/independent-pr…

5faa1ae

…ojects-impl

aaronc changed the title ~~feat(x/ecocredit):c independent projects~~ feat(x/ecocredit): implement independent projects Feb 13, 2024

WIP

72f1d54

aaronc added 2 commits March 31, 2024 19:07

docs, fix sims/tests

b3a7eb3

lint fix

497de7b

aaronc added 4 commits March 31, 2024 19:21

lint

38b631a

lint

4aff001

lint

a53fe68

add CHANGELOG entries

5d5249e

aaronc marked this pull request as ready for review March 31, 2024 23:47

aaronc added 2 commits April 9, 2024 15:15

feat(x/ecocredit/v3/client): add/update independent project CLI commands

ab7cc06

query commands

5724801

paul121 reviewed Apr 11, 2024

View reviewed changes

aaronc and others added 4 commits May 2, 2024 13:37

Update x/ecocredit/base/types/v1/features/msg_add_credit_type.feature

29f659b

Co-authored-by: Paul Weidner <paul.weidner@gmail.com>

Update proto/regen/ecocredit/v1/query.proto

f4fd66a

Co-authored-by: Paul Weidner <paul.weidner@gmail.com>

Merge branch 'aaronc/independent-projects-cli' into aaronc/independen…

2b8e175

…t-projects-impl

proto-gen

d6e0b78

Merge branch 'main' into aaronc/independent-projects-impl

65f60c7

aaronc mentioned this pull request May 28, 2024

feat(x/ecocredit/v3/client): add/update independent project CLI commands #2202

Closed

19 tasks

aaronc and others added 5 commits May 28, 2024 18:52

rename refactor

356a2ff

Update CHANGELOG.md

b0cfdb7

Co-authored-by: Paul Weidner <paul.weidner@gmail.com>

fix CHANGELOG.md

c262750

add test for project not accepted to credit class

4336def

add test for withdrawing an accepted enrollment and fix logic

7c6fdb2

paul121 reviewed Jun 1, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(x/ecocredit)!: implement independent projects #2167

feat(x/ecocredit)!: implement independent projects #2167

aaronc commented Feb 13, 2024 •

edited

codecov bot commented Mar 31, 2024 •

edited

aaronc commented Mar 31, 2024 •

edited

paul121 left a comment •

edited

paul121 Apr 11, 2024

aaronc May 28, 2024

paul121 Jun 1, 2024

paul121 Apr 11, 2024

aaronc Apr 11, 2024

paul121 Apr 11, 2024

aaronc May 28, 2024

paul121 Jun 1, 2024

paul121 Apr 11, 2024

aaronc May 2, 2024

paul121 May 2, 2024

aaronc May 2, 2024 •

edited

aaronc commented Apr 11, 2024

paul121 commented Apr 11, 2024

aaronc commented May 2, 2024

aaronc commented May 28, 2024

paul121 Jun 1, 2024

paul121 Jun 1, 2024

paul121 Jun 1, 2024

	Rule: project admins cannot withdraw a project with an accepted enrollment (a credit class issuer must do that)
	Rule: project admins cannot withdraw a project with an accepted enrollment

		\| I01 accepted to rejected \| ACCEPTED \| foo123 \| I01 \| REJECTED \| baz789 \| invalid \| true \|
		\| Bob accepted to rejected \| ACCEPTED \| foo123 \| Bob \| REJECTED \| baz789 \| unauthorized \| true \|

feat(x/ecocredit)!: implement independent projects #2167

Are you sure you want to change the base?

feat(x/ecocredit)!: implement independent projects #2167

Conversation

aaronc commented Feb 13, 2024 • edited

Description

Author Checklist

Reviewers Checklist

codecov bot commented Mar 31, 2024 • edited

Codecov Report

aaronc commented Mar 31, 2024 • edited

paul121 left a comment • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aaronc May 2, 2024 • edited

Choose a reason for hiding this comment

aaronc commented Apr 11, 2024

paul121 commented Apr 11, 2024

aaronc commented May 2, 2024

aaronc commented May 28, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aaronc commented Feb 13, 2024 •

edited

codecov bot commented Mar 31, 2024 •

edited

aaronc commented Mar 31, 2024 •

edited

paul121 left a comment •

edited

aaronc May 2, 2024 •

edited