feat(x/ecocredit)!: implement independent projects

CHANGELOG.md

@@ -16,6 +16,27 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 #### Added
 - [#2107](https://github.com/regen-network/regen-ledger/pull/2107) Add `BurnRegen` method.
+- [#2167](https://github.com/regen-network/regen-ledger/pull/2167) Add `CreateUnregisteredProject`, `CreateOrUpdateApplication`, `UpdateProjectEnrollment` and `UpdateProjectFee` methods and `ProjectEnrollment` and `ProjectEnrollments` queries. These additions allow:
+  - projects to be created without being already enrolled in a credit class
+  - projects to apply for one or more credit class and for project-credit class relationships to be dynamically managed on-chain
+
+#### Changed
+- [#2167](https://github.com/regen-network/regen-ledger/pull/2167):
+  - `FormatProjectID` just takes a sequence number and doesn't need a class ID.
+  - `FormatBatchDenom` requires a class ID because the class is no longer implied by the project ID.
+  - the credit type `P` is now reserved because this is the new project prefix
+  - project and batch string validation is now more lenient and just checks for a non-empty string
+  - `GetCreditTypeFromBatchDenom` was renamed to `GetCreditTypeFromBatch` and takes a `*Batch` parameter instead of a string.
+
+#### Deprecated
+- [#2167](https://github.com/regen-network/regen-ledger/pull/2167):
+  - `regen.ecocredit.v1.Project.class_key`
+  - `regen.ecocredit.v1.ProjectSequence`
+  - `regen.ecocredit.v1.ProjectInfo.class_id`
+
+#### Removed
+- [#2167](https://github.com/regen-network/regen-ledger/pull/2167): the `GetClassIDFromProjectID` and `GetProjectIDFromBatchDenom` have been removed and a state lookup must now be used to resolved these references.
+    - 
 
 ## [v5.1.2](https://github.com/regen-network/regen-ledger/releases/tag/v5.1.2) - 2023-06-28
 

proto/regen/ecocredit/v1/query.proto

@@ -270,8 +270,8 @@
     };
   }
 
-  // ProjectEnrollments queries all credit class enrollments associated with a
-  // project.
+  // ProjectEnrollments queries all credit class enrollments and allows for filtering by
+  // project or credit class.
   rpc ProjectEnrollments(QueryProjectEnrollmentsRequest) returns (QueryProjectEnrollmentsResponse) {
     option (google.api.http) = {
       get : "/regen/ecocredit/v1/project/{project_id}/enrollments"
@@ -702,9 +702,8 @@
   // admin is the admin of the project.
   string admin = 2;
 
-  // class_id is the unique identifier of the credit class within which the
-  // project was created.
-  string class_id = 3;
+  // Deprecated: use ProjectEnrollment instead.
+  string class_id = 3 [deprecated = true];
 
   // jurisdiction is the jurisdiction of the project. Full documentation can be
   // found in MsgCreateProject.jurisdiction.
@@ -863,16 +862,21 @@
 message QueryProjectEnrollmentResponse {
 
   // project_class is the fetched project class relationship.
-  ProjectEnrollment project_class = 1;
+  EnrollmentInfo enrollment = 1;
 }
 
 // QueryProjectEnrollmentsRequest is the Query/ProjectEnrollments request type.
 //
 // Since Revision 3
 message QueryProjectEnrollmentsRequest {
-  // project_id is the unique identifier of the project to query.
+  // project_id is the unique identifier of the project to filter enrollments
+  // by. If not set, enrollments for all projects will be returned.
   string project_id = 1;
 
+  // class_id is the unique identifier of the credit class to filter enrollments
+  // by. If not set, enrollments for all credit classes will be returned.
+  string class_id = 3;
+
   // pagination defines an optional pagination for the request.
   cosmos.base.query.v1beta1.PageRequest pagination = 2;
 }
@@ -883,8 +887,28 @@
 message QueryProjectEnrollmentsResponse {
 
   // enrollments are the fetched project credit class enrollments.
-  repeated ProjectEnrollment enrollments = 1;
+  repeated EnrollmentInfo enrollments = 1;
 
   // pagination defines the pagination in the response.
   cosmos.base.query.v1beta1.PageResponse pagination = 2;
+}
+
+// EnrollmentInfo is the human-readable project enrollment information.
+message EnrollmentInfo {
+  // project_id is the unique identifier of the project to query.
+  string project_id = 1;
+
+  // class_id is the unique identifier of the credit class to query.
+  string class_id = 2;
+
+  // status is the status of the enrollment.
+  ProjectEnrollmentStatus status = 4;
+
+  // application_metadata is any arbitrary metadata set by the project
+  // admin related to its application to the credit class.
+  string application_metadata = 5;
+
+  // enrollment_metadata is any arbitrary metadata set by the credit class
+  // issuer evaluating the project's application to the credit class.
+  string enrollment_metadata = 6;
 }

proto/regen/ecocredit/v1/state.proto

@@ -19,6 +19,8 @@ message CreditType {
 
   // abbreviation is a 1-3 character uppercase abbreviation of the CreditType
   // name, used in batch denominations within the CreditType. It must be unique.
+  // The letter P is reserved as the project prefix and cannot be used as a
+  // credit type to avoid confusion.
   string abbreviation = 1;
 
   // name is the name of the credit type (e.g. carbon, biodiversity).
@@ -91,16 +93,14 @@ message Project {
   // efficient lookups. This identifier is auto-incrementing.
   uint64 key = 1;
 
-  // id is the unique identifier of the project either auto-generated from the
-  // credit class id and project sequence number or provided upon creation.
+  // id is the auto-generated unique identifier of the project.
   string id = 2;
 
   // admin is the admin of the project.
   bytes admin = 3;
 
-  // class_key is the table row identifier of the credit class used internally
-  // for efficient lookups. This links a project to a credit class.
-  uint64 class_key = 4;
+  // Deprecated: use ProjectEnrollment instead.
+  uint64 class_key = 4 [deprecated = true];
 
   // jurisdiction is the jurisdiction of the project.
   // Full documentation can be found in MsgCreateProject.jurisdiction.
@@ -183,9 +183,10 @@ message ClassSequence {
   uint64 next_sequence = 2;
 }
 
-// ProjectSequence stores and increments the sequence number for projects within
-// a credit class.
+// Deprecated: No longer used.
 message ProjectSequence {
+  option deprecated = true;
+
   option (cosmos.orm.v1.table) = {
     id : 7,
     primary_key : {fields : "class_key"}

proto/regen/ecocredit/v1/tx.proto

@@ -38,7 +38,8 @@
   // CreateOrUpdateApplicaton creates a new project credit class application, updates
   // the metadata for an existing one when changes have been requested, or withdraws
   // the application. When an application is withdrawn, its data will be deleted from
-  // state and the project may apply again to the same credit class in the future.
+  // state and the project may apply again to the same credit class in the future. Any
+  // new metadata will be passed to EventUpdateApplication including for withdrawals.
   //
   // Since Revision 3
   rpc CreateOrUpdateApplication(MsgCreateOrUpdateApplication)
@@ -157,8 +158,8 @@
   // the scope of the provided credit class, the credits will be minted to the
   // existing credit batch, otherwise the credits will be issued in a new credit
   // batch. The new credit batch will be created under an existing project if a
-  // project with a matching reference id already exists within the scope of the
-  // credit class, otherwise a new project will be created.
+  // project with a matching reference id already exists, otherwise a new project
+  // will be created.
   rpc BridgeReceive(MsgBridgeReceive) returns (MsgBridgeReceiveResponse);
 
   // AddCreditType is a governance method that allows the addition of new
@@ -328,7 +329,7 @@
 }
 
 // MsgCreateUnregisteredProject is the Msg/CreateUnregisteredProject request type.
 message MsgCreateUnregisteredProject {
   option (cosmos.msg.v1.signer) = "admin";
 
   // admin is the address of the account creating the project that will become
@@ -348,16 +349,12 @@
   // increased precision.
   string jurisdiction = 3;
 
-  // reference_id is any arbitrary string used to reference the project with a
-  // maximum length of 32 characters.
-  string reference_id = 4;
-
   // fee is the project creation fee. An equal fee is required if the project
   // creation fee parameter is set. The provided fee can be greater than the
   // parameter, but only the amount in the parameter will be charged.
   //
   // Since Revision 3
-  cosmos.base.v1beta1.Coin fee = 5;
+  cosmos.base.v1beta1.Coin fee = 4;
 }
 
 // MsgCreateUnregisteredProjectResponse is the Msg/CreateUnregisteredProject response type.

x/ecocredit/base/client/query.go

@@ -667,3 +667,66 @@
 	flags.AddPaginationFlagsToCmd(cmd, "allowed-bridge-chains")
 	return qflags(cmd)
 }
+
+func QueryProjectEnrollmentCmd() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:     "project-enrollment [project-id] [class-id]",
+		Short:   "Retrieve project enrollment information",
+		Long:    "Retrieve project enrollment information.",
+		Example: "regen q ecocredit project-enrollment P001 C01",
+		Args:    cobra.ExactArgs(2),
+		RunE: func(cmd *cobra.Command, args []string) error {
+			c, ctx, err := mkQueryClient(cmd)
+			if err != nil {
+				return err
+			}
+			res, err := c.ProjectEnrollment(cmd.Context(), &types.QueryProjectEnrollmentRequest{
+				ProjectId: args[0],
+				ClassId:   args[1],
+			})
+			return printQueryResponse(ctx, res, err)
+		},
+	}
+	return qflags(cmd)
+}
+
+func QueryProjectEnrollmentsCmd() *cobra.Command {
+	var projectID, classID string
+
+	cmd := &cobra.Command{
+		Use:   "project-enrollments",
+		Short: "Retrieve project enrollments",
+		Long: `Retrieve project enrollments with optional pagination and filtering by project or credit class.
+
+Flags:
+	  --project string   Filter by project ID
+	  --class   string   Filter by credit class ID
+`,
+		Example: `regen q ecocredit project-enrollments --limit 10 --offset 10
+regen q ecocredit project-enrollments --project P001
+regen q ecocredit project-enrollments --class C01`,
+		RunE: func(cmd *cobra.Command, args []string) error {
+			c, ctx, err := mkQueryClient(cmd)
+			if err != nil {
+				return err
+			}
+
+			pagination, err := client.ReadPageRequest(cmd.Flags())
+			if err != nil {
+				return err
+			}
+
+			res, err := c.ProjectEnrollments(cmd.Context(), &types.QueryProjectEnrollmentsRequest{
+				ProjectId:  projectID,
+				ClassId:    classID,
+				Pagination: pagination,
+			})
+			return printQueryResponse(ctx, res, err)
+		},
+	}
+
+	cmd.Flags().StringVar(&projectID, FlagProject, "", "Filter by project ID")
+	cmd.Flags().StringVar(&classID, FlagClass, "", "Filter by credit class ID")
+
+	return qflags(cmd)
+}