feat(x/ecocredit)!: migrate add-credit-type proposal to msg based proposal

app/app.go

@@ -360,6 +360,7 @@ func NewRegenApp(logger log.Logger, db dbm.DB, traceStore io.Writer, loadLatest
 		app.GetSubspace(ecocredit.DefaultParamspace),
 		app.AccountKeeper,
 		app.BankKeeper,
+		authtypes.NewModuleAddress(govtypes.ModuleName),
 	)
 	dataModule := data.NewModule(app.AccountKeeper, app.BankKeeper)
 	newModules := []moduletypes.Module{ecocreditModule, dataModule}
@@ -519,7 +520,7 @@ func NewRegenApp(logger log.Logger, db dbm.DB, traceStore io.Writer, loadLatest
 			authzmodule.NewAppModule(appCodec, app.AuthzKeeper, app.AccountKeeper, app.BankKeeper, app.interfaceRegistry),
 			// ibc.NewAppModule(app.IBCKeeper),
 			// transferModule,
-			ecocreditmodule.NewModule(app.GetSubspace(ecocredit.DefaultParamspace), app.AccountKeeper, app.BankKeeper),
+			ecocreditmodule.NewModule(app.GetSubspace(ecocredit.DefaultParamspace), app.AccountKeeper, app.BankKeeper, authtypes.NewModuleAddress(govtypes.ModuleName)),
 			data.NewModule(app.AccountKeeper, app.BankKeeper),
 		}, app.setCustomSimulationManager()...)...,
 	)

app/stable_appconfig.go

@@ -21,8 +21,6 @@ import (
 	upgradeclient "github.com/cosmos/cosmos-sdk/x/upgrade/client"
 
 	"github.com/regen-network/regen-ledger/types/module/server"
-	ecocreditcore "github.com/regen-network/regen-ledger/x/ecocredit/client/core"
-	"github.com/regen-network/regen-ledger/x/ecocredit/client/marketplace"
 )
 
 func setCustomModuleBasics() []module.AppModuleBasic {
@@ -31,7 +29,6 @@ func setCustomModuleBasics() []module.AppModuleBasic {
 			[]govclient.ProposalHandler{
 				paramsclient.ProposalHandler, distrclient.ProposalHandler,
 				upgradeclient.LegacyProposalHandler, upgradeclient.LegacyCancelProposalHandler,
-				ecocreditcore.CreditTypeProposalHandler, marketplace.AllowDenomProposalHandler,
 			},
 		),
 	}

proto/regen/ecocredit/v1/tx.proto

@@ -6,6 +6,7 @@ import "gogoproto/gogo.proto";
 import "google/protobuf/timestamp.proto";
 import "cosmos/base/v1beta1/coin.proto";
 import "regen/ecocredit/v1/types.proto";
+import "regen/ecocredit/v1/state.proto";
 
 option go_package = "github.com/regen-network/regen-ledger/x/ecocredit/core";
 
@@ -111,8 +112,23 @@ service Msg {
   // project with a matching reference id already exists within the scope of the
   // credit class, otherwise a new project will be created.
   rpc BridgeReceive(MsgBridgeReceive) returns (MsgBridgeReceiveResponse);
+
+  // AddCreditType is a governance method that allows the addition of new credit types to the network.
+  rpc AddCreditType(MsgAddCreditType) returns (MsgAddCreditTypeResponse);
 }
 
+// MsgAddCreditType is the Msg/AddCreditType request type.
+message MsgAddCreditType {
+  // authority is the address of the governance account.
+  string authority = 1;
+
+  // credit_type defines a credit type to add to the credit types parameter. 
+  repeated CreditType credit_type = 2;
+}
+
+// MsgAddCreditTypeResponse is the Msg/AddCreditType response type.
+message MsgAddCreditTypeResponse {}
+
 // MsgCreateClass is the Msg/CreateClass request type.
 message MsgCreateClass {
 

x/ecocredit/core/codec.go

@@ -32,6 +32,7 @@ func RegisterLegacyAminoCodec(cdc *codec.LegacyAmino) {
 	cdc.RegisterConcrete(&MsgUpdateProjectMetadata{}, "regen.core/MsgUpdateProjectMetadata", nil)
 	cdc.RegisterConcrete(&CreditTypeProposal{}, "regen.core/CreditTypeProposal", nil)
 	cdc.RegisterConcrete(&MsgBridgeReceive{}, "regen.core/MsgBridgeReceive", nil)
+	cdc.RegisterConcrete(&MsgAddCreditType{}, "regen.core/MsgAddCreditType", nil)
 }
 
 var (

x/ecocredit/core/features/msg_add_credit_type.feature

@@ -0,0 +1,104 @@
+Feature: CreditTypes
+
+  Scenario: a valid credit types
+    Given the message
+    """
+    {
+      "authority":"regen1depk54cuajgkzea6zpgkq36tnjwdzv4ak663u6",
+      "credit_type": [
+        {
+            "abbreviation":"C",
+            "precision":6,
+            "name":"carbon",
+            "unit":"ton"
+        }
+      ]
+    }
+    """
+    When the message is validated
+    Then expect no error
+
+  Scenario: an error is returned if authority address is empty
+    Given the message
+    """
+    {}
+    """
+    When the message is validated
+    Then expect the error "invalid authority address: empty address string is not allowed"
+
+  Scenario: an error is returned if authority address is not a valid bech32 address
+    Given the message
+    """
+    {
+        "authority": "foo"
+    }
+    """
+    When the message is validated
+    Then expect the error "invalid authority address: decoding bech32 failed: invalid bech32 string length 3"
+
+  Scenario: an error is returned if credit type is empty
+    Given the message
+    """
+    {
+      "authority": "regen1depk54cuajgkzea6zpgkq36tnjwdzv4ak663u6"
+    }
+    """
+    When the message is validated
+    Then expect the error "credit types cannot be empty: invalid request"
+  Scenario: an error is returned if credit type precision is not 6
+    Given the message
+    """
+    {
+      "authority": "regen1depk54cuajgkzea6zpgkq36tnjwdzv4ak663u6",
+      "credit_type": [
+        {
+            "abbreviation":"C",
+            "precision":60,
+            "name":"carbon",
+            "unit":"ton"
+        }
+      ]
+    }
+    """
+    When the message is validated
+    Then expect the error "credit_type[0]: credit type precision is currently locked to 6: invalid request"
+  Scenario: an error is returned if credit type abbreviation is empty
+    Given the message
+    """
+    {
+      "authority": "regen1depk54cuajgkzea6zpgkq36tnjwdzv4ak663u6",
+      "credit_type": [
+        {
+            "abbreviation":"",
+            "precision":6,
+            "name":"carbon",
+            "unit":"ton"
+        }
+      ]
+    }
+    """
+    When the message is validated
+    Then expect the error "credit_type[0]: credit type abbreviation cannot be empty: parse error"
+  Scenario: an error is returned if credit type duplicate
+    Given the message
+    """
+    {
+      "authority": "regen1depk54cuajgkzea6zpgkq36tnjwdzv4ak663u6",
+      "credit_type": [
+        {
+            "abbreviation":"C",
+            "precision":6,
+            "name":"carbon",
+            "unit":"ton"
+        },
+        {
+            "abbreviation":"C",
+            "precision":6,
+            "name":"carbon",
+            "unit":"ton"
+        }
+      ]
+    }
+    """
+    When the message is validated
+    Then expect the error "credit_type[1]: duplicate credit type: invalid request"

x/ecocredit/core/msg_add_credit_type.go

@@ -0,0 +1,58 @@
+package core
+
+import (
+	"fmt"
+
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
+	"github.com/cosmos/cosmos-sdk/x/auth/migrations/legacytx"
+
+	"github.com/regen-network/regen-ledger/x/ecocredit"
+)
+
+var _ legacytx.LegacyMsg = &MsgAddCreditType{}
+
+// Route implements the LegacyMsg interface.
+func (m MsgAddCreditType) Route() string { return sdk.MsgTypeURL(&m) }
+
+// Type implements the LegacyMsg interface.
+func (m MsgAddCreditType) Type() string { return sdk.MsgTypeURL(&m) }
+
+// GetSignBytes implements the LegacyMsg interface.
+func (m MsgAddCreditType) GetSignBytes() []byte {
+	return sdk.MustSortJSON(ecocredit.ModuleCdc.MustMarshalJSON(&m))
+}
+
+// ValidateBasic does a sanity check on the provided data.
+func (m *MsgAddCreditType) ValidateBasic() error {
+	if _, err := sdk.AccAddressFromBech32(m.Authority); err != nil {
+		return sdkerrors.Wrapf(err, "invalid authority address")
+	}
+
+	if len(m.CreditType) == 0 {
+		return sdkerrors.ErrInvalidRequest.Wrap("credit types cannot be empty")
+	}
+
+	duplicateAddMap := make(map[string]bool)
+	for i, creditType := range m.CreditType {
+		cTypeIndex := fmt.Sprintf("credit_type[%d]", i)
+
+		if err := creditType.Validate(); err != nil {
+			return sdkerrors.Wrapf(err, "%s", cTypeIndex)
+		}
+
+		if _, ok := duplicateAddMap[creditType.Name]; ok {
+			return sdkerrors.ErrInvalidRequest.Wrapf("%s: duplicate credit type", cTypeIndex)
+		}
+
+		duplicateAddMap[creditType.Name] = true
+	}
+
+	return nil
+}
+
+// GetSigners returns the expected signers for MsgAddCreditType.
+func (m *MsgAddCreditType) GetSigners() []sdk.AccAddress {
+	addr, _ := sdk.AccAddressFromBech32(m.Authority)
+	return []sdk.AccAddress{addr}
+}