feat(x/ecocredit): independent project API (#2150)

Co-authored-by: Cory <[email protected]>

Author: aaronc

api/regen/ecocredit/marketplace/v1/tx.pulsar.go

@@ -2,6 +2,7 @@ syntax = "proto3";
 
 package regen.ecocredit.v1;
 
+import "regen/ecocredit/v1/state.proto";
 import "regen/ecocredit/v1/types.proto";
 
 option go_package = "github.com/regen-network/regen-ledger/x/ecocredit/base/types/v1";
@@ -259,3 +260,61 @@ message EventBurnRegen {
   // reason is the reason for the burn.
   string reason = 3;
 }
+
+// EventUpdateApplication is emitted when a project admin creates, updates
+// or withdraws a project's application to a credit class.
+message EventUpdateApplication {
+  // project_id is the unique identifier of the project that was updated.
+  string project_id = 1;
+
+  // class_id is the unique identifier of the class that was updated.
+  string class_id = 2;
+
+  // Action describes an action taken on an application.
+  enum Action {
+    // ACTION_UNSPECIFIED is the default value for the action and is invalid.
+    ACTION_UNSPECIFIED = 0;
+
+    // ACTION_CREATE is the action taken when a project admin creates an
+    // application to a credit class.
+    ACTION_CREATE = 1;
+
+    // ACTION_UPDATE is the action taken when a project admin updates an
+    // application to a credit class.
+    ACTION_UPDATE = 2;
+
+    // ACTION_WITHDRAW is the action taken when a project admin withdraws an
+    // application to a credit class.
+    ACTION_WITHDRAW = 3;
+  }
+
+  // action is the action that was taken on the application.
+  Action action = 3;
+
+  // new_application_metadata is any new application metadata.
+  string new_application_metadata = 4;
+}
+
+// EventUpdateProjectEnrollment is emitted when a credit class issuer updates
+// the enrollment status of a project.
+message EventUpdateProjectEnrollment {
+  // issuer is the address of the credit class issuer which evaluated the
+  // project.
+  string issuer = 1;
+
+  // project_id is the unique identifier of the project that was evaluated.
+  string project_id = 2;
+
+  // class_id is the unique identifier of the class in which the project was
+  // evaluated.
+  string class_id = 3;
+
+  // old_status is the old status of the project class relationship.
+  ProjectEnrollmentStatus old_status = 4;
+
+  // new_status is the new status of the project class relationship.
+  ProjectEnrollmentStatus new_status = 5;
+
+  // new_enrollment_metadata is any new enrollment metadata.
+  string new_enrollment_metadata = 6;
+}

api/regen/ecocredit/v1/events.pulsar.go

@@ -259,6 +259,24 @@ service Query {
       returns (QueryAllowedBridgeChainsResponse) {
     option (google.api.http).get = "/regen/ecocredit/v1/allowed-bridge-chains";
   }
+
+  // ProjectEnrollment queries information about a project's enrollment in a
+  // credit class.
+  //
+  // Since Revision 3
+  rpc ProjectEnrollment(QueryProjectEnrollmentRequest) returns (QueryProjectEnrollmentResponse) {
+    option (google.api.http) = {
+      get : "/regen/ecocredit/v1/project/{project_id}/enrollments/{class_id}"
+    };
+  }
+
+  // ProjectEnrollments queries all credit class enrollments associated with a
+  // project.
+  rpc ProjectEnrollments(QueryProjectEnrollmentsRequest) returns (QueryProjectEnrollmentsResponse) {
+    option (google.api.http) = {
+      get : "/regen/ecocredit/v1/project/{project_id}/enrollments"
+    };
+  }
 }
 
 // QueryClassesRequest is the Query/Classes request type.
@@ -826,3 +844,47 @@ message QueryAllowedBridgeChainsResponse {
   // bridge operations.
   repeated string allowed_bridge_chains = 1;
 }
+
+// QueryProjectEnrollmentRequest is the Query/ProjectEnrollment request type.
+//
+// Since Revision 3
+message QueryProjectEnrollmentRequest {
+
+  // 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;
+}
+
+// QueryProjectEnrollmentResponse is the Query/ProjectEnrollment response type.
+//
+// Since Revision 3
+message QueryProjectEnrollmentResponse {
+
+  // project_class is the fetched project class relationship.
+  ProjectEnrollment project_class = 1;
+}
+
+// QueryProjectEnrollmentsRequest is the Query/ProjectEnrollments request type.
+//
+// Since Revision 3
+message QueryProjectEnrollmentsRequest {
+  // project_id is the unique identifier of the project to query.
+  string project_id = 1;
+
+  // pagination defines an optional pagination for the request.
+  cosmos.base.query.v1beta1.PageRequest pagination = 2;
+}
+
+// QueryProjectEnrollmentsResponse is the Query/ProjectEnrollments response type.
+//
+// Since Revision 3
+message QueryProjectEnrollmentsResponse {
+
+  // enrollments are the fetched project credit class enrollments.
+  repeated ProjectEnrollment enrollments = 1;
+
+  // pagination defines the pagination in the response.
+  cosmos.base.query.v1beta1.PageResponse pagination = 2;
+}

api/regen/ecocredit/v1/query.pulsar.go

@@ -122,6 +122,7 @@ message Batch {
     index : {id : 2 fields : "project_key"}
     index : {id : 3 fields : "start_date"}
     index : {id : 4 fields : "issuer"}
+    index : {id: 5 fields : "class_key"}
   };
 
   // key is the table row identifier of the credit batch used internally for
@@ -137,8 +138,9 @@ message Batch {
   uint64 project_key = 3;
 
   // denom is the unique identifier of the credit batch formed from the
-  // project id, the batch sequence number, and the start and end date of the
-  // credit batch.
+  // credit class ID (or just project ID for old project IDs which included the credit class),
+  // project id, the batch sequence number, and the start and
+  // end date of the credit batch.
   string denom = 4;
 
   // metadata is any arbitrary metadata attached to the credit batch.
@@ -158,6 +160,10 @@ message Batch {
   // open tells if it's possible to mint new credits in the future.
   // Once `open` is set to false, it can't be toggled any more.
   bool open = 9;
+
+  // class_key is the table row identifier of the credit class used internally
+  // for efficient lookups. This links a batch to a credit class.
+  uint64 class_key = 10;
 }
 
 // ClassSequence stores and increments the sequence number for credit classes
@@ -381,3 +387,74 @@ message AllowedBridgeChain {
   // chain_name is the name of the chain allowed to bridge ecocredits to.
   string chain_name = 1;
 }
+
+// ProjectEnrollment stores the data a project's enrollment in a credit class.
+message ProjectEnrollment {
+  option (cosmos.orm.v1.table) = {
+    id : 17
+    primary_key : {fields : "project_key,class_key"}
+    index: {id: 1, fields: "class_key"}
+  };
+
+  // project_key is the table row identifier of the project used internally for
+  // efficient lookups.
+  uint64 project_key = 1;
+
+  // class_key is the table row identifier of the credit class used internally
+  // for efficient lookups.
+  uint64 class_key = 3;
+
+  // 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
+  // admin evaluating the project's application to the credit class.
+  string enrollment_metadata = 6;
+}
+
+// Application represents the evaluation status that a credit class issuer
+// assigns to a credit class application.
+enum ProjectEnrollmentStatus {
+  // PROJECT_ENROLLMENT_STATUS_UNSPECIFIED indicates that a credit class application
+  // has been submitted but not evaluated.
+  PROJECT_ENROLLMENT_STATUS_UNSPECIFIED = 0;
+
+  // PROJECT_ENROLLMENT_STATUS_ACCEPTED indicates that the project has been
+  // accepted into the credit class.
+  PROJECT_ENROLLMENT_STATUS_ACCEPTED = 1;
+
+  // PROJECT_ENROLLMENT_STATUS_CHANGES_REQUESTED indicates that an application to
+  // a credit class has been reviewed and that changes to the application have
+  // been requested. It can also be used to indicate that a project within a credit
+  // class has had its status reassessed and that changes to the project are
+  // requested in order to continue in the credit class.
+  PROJECT_ENROLLMENT_STATUS_CHANGES_REQUESTED = 2;
+
+  // PROJECT_ENROLLMENT_STATUS_REJECTED indicates that the application has been
+  // rejected and that the project will not be accepted into the credit class.
+  PROJECT_ENROLLMENT_STATUS_REJECTED = 3;
+
+  // PROJECT_ENROLLMENT_STATUS_TERMINATED indicates that the project has been
+  // terminated from the credit class. This status is used when a project the
+  // was previously accepted into the credit class but has been removed or
+  // completed.
+  PROJECT_ENROLLMENT_STATUS_TERMINATED = 4;
+}
+
+// ProjectFee is the project creation fee. If not set, a project creation fee is
+// not required. This table is controlled via governance.
+//
+// Since Revision 3
+message ProjectFee {
+  option (cosmos.orm.v1.singleton) = {
+    id : 18
+  };
+
+  // fee is the project creation fee. If not set, a project creation fee is not
+  // required.
+  cosmos.base.v1beta1.Coin fee = 1;
+}

api/regen/ecocredit/v1/query_grpc.pb.go

@@ -28,6 +28,45 @@ service Msg {
   // class. The creator becomes the admin of the project upon creation.
   rpc CreateProject(MsgCreateProject) returns (MsgCreateProjectResponse);
 
+  // CreateUnregisteredProject creates a new project without registering it
+  // under a credit class. This method is intended to be used by project proponents
+  // who are not yet ready to register their project under a credit class, but who
+  // want to create a project and receive a project ID.
+  rpc CreateUnregisteredProject(MsgCreateUnregisteredProject)
+      returns (MsgCreateUnregisteredProjectResponse);
+
+  // 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.
+  //
+  // Since Revision 3
+  rpc CreateOrUpdateApplication(MsgCreateOrUpdateApplication)
+      returns (MsgCreateOrUpdateApplicationResponse);
+
+  // UpdateProjectEnrollment allows a credit class issuer to evaluate a project
+  // application - either approving, requesting changes to, or
+  // rejecting it, or to terminate an existing enrollment.
+  // Any issuer in the credit class may update the project credit
+  // class enrollment status using this method. If more sophisticated rules are
+  // required to coordinate between different issuers, the credit class admin
+  // should set up an on or off-chain governance process to coordinate this.
+  // Issuers may not admit projects into credit classes using this method
+  // without the project first creating an application. For an issuer to
+  // admit a project into a credit class without an
+  // application the CreateProject method should be used instead.
+  //
+  // If a project has not yet been accepted then the issuer may change the
+  // status to either changes requested, accepted or rejected. If the status
+  // is already accepted, the issuer may only change the status to terminated.
+  // Whenever a project is rejected or terminated, the project's enrollment
+  // the enrollment state will be deleted and the project may apply again
+  // to the same credit class in the future.
+  //
+  // Since Revision 3
+  rpc UpdateProjectEnrollment(MsgUpdateProjectEnrollment)
+      returns (MsgUpdateProjectEnrollmentResponse);
+
   // CreateBatch creates a new batch of credits under the given project with a
   // start and end date representing the monitoring period, a list of credits to
   // be issued with each issuance specifying a recipient, the amount of tradable
@@ -158,6 +197,14 @@ service Msg {
   // Since Revision 2
   rpc UpdateClassFee(MsgUpdateClassFee) returns (MsgUpdateClassFeeResponse);
 
+  // UpdateProjectFee is a governance method that allows for updating the
+  // project creation fee. If no fee is specified in the request, the project
+  // creation fee will be removed and no fee will be required to create a
+  // project.
+  //
+  // Since Revision 3
+  rpc UpdateProjectFee(MsgUpdateProjectFee) returns (MsgUpdateProjectFeeResponse);
+
   // AddAllowedBridgeChain is a governance method that allows for the
   // addition of a chain to bridge ecocredits to.
   //
@@ -264,6 +311,13 @@ message MsgCreateProject {
   // reference_id is any arbitrary string used to reference the project with a
   // maximum length of 32 characters.
   string reference_id = 5;
+
+  // 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 = 6;
 }
 
 // MsgCreateProjectResponse is the Msg/CreateProject response type.
@@ -273,12 +327,106 @@ message MsgCreateProjectResponse {
   string project_id = 1;
 }
 
+// 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
+  // the admin of the project upon creation.
+  string admin = 1;
+
+  // metadata is any arbitrary string with a maximum length of 256 characters
+  // that includes or references metadata to attach to the project.
+  string metadata = 2;
+
+  // jurisdiction is the jurisdiction of the project. A jurisdiction has with
+  // the format: <country-code>[-<sub-national-code>[ <postal-code>]]
+  // 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.
+  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;
+}
+
+// MsgCreateUnregisteredProjectResponse is the Msg/CreateUnregisteredProject response type.
+message MsgCreateUnregisteredProjectResponse {
+  // project_id is the unique identifier of the project.
+  string project_id = 1;
+}
+
+// MsgCreateOrUpdateApplication is the Msg/CreateOrUpdateApplication request type.
+message MsgCreateOrUpdateApplication {
+  option (cosmos.msg.v1.signer) = "project_admin";
+
+  // project_admin is the address of the account that is the admin of the
+  // project which is applying to the credit class.
+  string project_admin = 1;
+
+  // project_id is the identifier of the project which is applying to
+  // the credit class.
+  string project_id = 2;
+
+  // class_id is the identifier of the credit class which the project is
+  // applying to.
+  string class_id = 3;
+
+  // metadata is any optional arbitrary string with a maximum length of 256 characters
+  // that includes or references any metadata relevant to the application.
+  // This could be used as a digital reference to the actual contents of the application.
+  string metadata = 4;
+
+  // withdraw is a boolean that indicates whether the application is being
+  // withdrawn rather than updated.
+  bool withdraw = 5;
+}
+
+// MsgCreateOrUpdateApplicationResponse is the Msg/CreateOrUpdateApplication response type.
+message MsgCreateOrUpdateApplicationResponse {}
+
+// MsgUpdateProjectEnrollment is the Msg/UpdateProjectEnrollment request type.
+message MsgUpdateProjectEnrollment {
+  option (cosmos.msg.v1.signer) = "issuer";
+
+  // issuer is the address of the account that is the issuer of the credit class
+  // which is updating the project enrollment status.
+  string issuer = 1;
+
+  // project_id is the identifier of the project.
+  string project_id = 2;
+
+  // class_id is the identifier of the credit class.
+  string class_id = 3;
+
+  // new_status is the new status of the project enrollment.
+  ProjectEnrollmentStatus new_status = 4;
+
+  // metadata is any optiopnal arbitrary string with a maximum length of 256 characters
+  // that includes or references the reason for the approving, requesting changes
+  // to, or rejecting the application, or terminating the project.
+  string metadata = 5;
+}
+
+// MsgEvaluateProjectEnrollmentResponse is the Msg/EvaluateProjectEnrollment response type.
+message MsgUpdateProjectEnrollmentResponse {}
+
 // MsgCreateBatch is the Msg/CreateBatch request type.
 message MsgCreateBatch {
   option (cosmos.msg.v1.signer) = "issuer";
 
   // issuer is the address of the account issuing the credits and must be an
-  // approved issuer within the credit class of the project.
+  // approved issuer within a credit class of the project.
   string issuer = 1;
 
   // project_id is the unique identifier of the project under which the credit
@@ -313,6 +461,12 @@ message MsgCreateBatch {
   // issuing credits and should only be set when bridging assets from another
   // chain or registry as a result of a bridge operation.
   OriginTx origin_tx = 8;
+
+  // class_id is the unique identifier of the credit class under which the
+  // credit batch will be created.
+  //
+  // Since Revision 3
+  string class_id = 9;
 }
 
 // MsgCreateBatchResponse is the Msg/CreateBatch response type.
@@ -750,6 +904,21 @@ message MsgUpdateClassFee {
 // Since Revision 2
 message MsgUpdateClassFeeResponse {}
 
+// MsgUpdateProjectFee is the Msg/UpdateProjectFee request type.
+message MsgUpdateProjectFee {
+  option (cosmos.msg.v1.signer) = "authority";
+
+  // authority is the address of the governance account.
+  string authority = 1;
+
+  // fee is the project creation fee. If not set, the project creation fee will
+  // be removed and no fee will be required to create a project.
+  cosmos.base.v1beta1.Coin fee = 2;
+}
+
+// MsgUpdateProjectFeeResponse is the Msg/UpdateProjectFee response type.
+message MsgUpdateProjectFeeResponse {}
+
 // MsgAddAllowedBridgeChain is the Msg/AddAllowedBridgeChain request type.
 //
 // Since Revision 2

api/regen/ecocredit/v1/state.cosmos_orm.go

@@ -16,6 +16,9 @@ var (
 )
 
 type Keeper struct {
+	*types.UnimplementedMsgServer
+	*types.UnimplementedQueryServer
+
 	stateStore    api.StateStore
 	bankKeeper    ecocredit.BankKeeper
 	moduleAddress sdk.AccAddress

api/regen/ecocredit/v1/state.pulsar.go

@@ -0,0 +1,29 @@
+package v1
+
+import (
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	"github.com/cosmos/cosmos-sdk/x/auth/migrations/legacytx"
+)
+
+var _ legacytx.LegacyMsg = &MsgCreateOrUpdateApplication{}
+
+// Route implements the LegacyMsg interface.
+func (m *MsgCreateOrUpdateApplication) Route() string { return sdk.MsgTypeURL(m) }
+
+// Type implements the LegacyMsg interface.
+func (m *MsgCreateOrUpdateApplication) Type() string { return sdk.MsgTypeURL(m) }
+
+// GetSignBytes implements the LegacyMsg interface.
+func (m *MsgCreateOrUpdateApplication) GetSignBytes() []byte {
+	return sdk.MustSortJSON(ModuleCdc.MustMarshalJSON(m))
+}
+
+// ValidateBasic does a sanity check on the provided data.
+func (m *MsgCreateOrUpdateApplication) ValidateBasic() error {
+	panic("implement me")
+}
+
+// GetSigners returns the expected signers for MsgCreateOrUpdateApplication.
+func (m *MsgCreateOrUpdateApplication) GetSigners() []sdk.AccAddress {
+	return []sdk.AccAddress{sdk.MustAccAddressFromBech32(m.ProjectAdmin)}
+}

api/regen/ecocredit/v1/tx.pulsar.go

@@ -0,0 +1,29 @@
+package v1
+
+import (
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	"github.com/cosmos/cosmos-sdk/x/auth/migrations/legacytx"
+)
+
+var _ legacytx.LegacyMsg = &MsgCreateUnregisteredProject{}
+
+// Route implements the LegacyMsg interface.
+func (m *MsgCreateUnregisteredProject) Route() string { return sdk.MsgTypeURL(m) }
+
+// Type implements the LegacyMsg interface.
+func (m *MsgCreateUnregisteredProject) Type() string { return sdk.MsgTypeURL(m) }
+
+// GetSignBytes implements the LegacyMsg interface.
+func (m *MsgCreateUnregisteredProject) GetSignBytes() []byte {
+	return sdk.MustSortJSON(ModuleCdc.MustMarshalJSON(m))
+}
+
+// ValidateBasic does a sanity check on the provided data.
+func (m *MsgCreateUnregisteredProject) ValidateBasic() error {
+	panic("implement me")
+}
+
+// GetSigners returns the expected signers for MsgCreateUnregisteredProject.
+func (m *MsgCreateUnregisteredProject) GetSigners() []sdk.AccAddress {
+	return []sdk.AccAddress{sdk.MustAccAddressFromBech32(m.Admin)}
+}

api/regen/ecocredit/v1/tx_grpc.pb.go

@@ -0,0 +1,29 @@
+package v1
+
+import (
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	"github.com/cosmos/cosmos-sdk/x/auth/migrations/legacytx"
+)
+
+var _ legacytx.LegacyMsg = &MsgUpdateProjectEnrollment{}
+
+// Route implements the LegacyMsg interface.
+func (m *MsgUpdateProjectEnrollment) Route() string { return sdk.MsgTypeURL(m) }
+
+// Type implements the LegacyMsg interface.
+func (m *MsgUpdateProjectEnrollment) Type() string { return sdk.MsgTypeURL(m) }
+
+// GetSignBytes implements the LegacyMsg interface.
+func (m *MsgUpdateProjectEnrollment) GetSignBytes() []byte {
+	return sdk.MustSortJSON(ModuleCdc.MustMarshalJSON(m))
+}
+
+// ValidateBasic does a sanity check on the provided data.
+func (m *MsgUpdateProjectEnrollment) ValidateBasic() error {
+	panic("implement me")
+}
+
+// GetSigners returns the expected signers for MsgUpdateProjectEnrollment.
+func (m *MsgUpdateProjectEnrollment) GetSigners() []sdk.AccAddress {
+	return []sdk.AccAddress{sdk.MustAccAddressFromBech32(m.Issuer)}
+}

proto/regen/ecocredit/v1/events.proto

@@ -0,0 +1,43 @@
+package v1
+
+import (
+	"cosmossdk.io/errors"
+
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
+	"github.com/cosmos/cosmos-sdk/x/auth/migrations/legacytx"
+)
+
+var _ legacytx.LegacyMsg = &MsgUpdateProjectFee{}
+
+// Route implements the LegacyMsg interface.
+func (m MsgUpdateProjectFee) Route() string { return sdk.MsgTypeURL(&m) }
+
+// Type implements the LegacyMsg interface.
+func (m MsgUpdateProjectFee) Type() string { return sdk.MsgTypeURL(&m) }
+
+// GetSignBytes implements the LegacyMsg interface.
+func (m MsgUpdateProjectFee) GetSignBytes() []byte {
+	return sdk.MustSortJSON(ModuleCdc.MustMarshalJSON(&m))
+}
+
+// ValidateBasic does a sanity check on the provided data.
+func (m *MsgUpdateProjectFee) ValidateBasic() error {
+	if _, err := sdk.AccAddressFromBech32(m.Authority); err != nil {
+		return errors.Wrapf(err, "invalid authority address")
+	}
+
+	if m.Fee != nil {
+		if err := m.Fee.Validate(); err != nil {
+			return sdkerrors.ErrInvalidRequest.Wrapf("%s", err)
+		}
+	}
+
+	return nil
+}
+
+// GetSigners returns the expected signers for MsgUpdateProjectFee.
+func (m *MsgUpdateProjectFee) GetSigners() []sdk.AccAddress {
+	addr, _ := sdk.AccAddressFromBech32(m.Authority)
+	return []sdk.AccAddress{addr}
+}