[DON'T MERGE] feat(x/gov): add governors

app/keepers/keepers.go

@@ -207,15 +207,6 @@ func NewAppKeeper(
 		authtypes.NewModuleAddress(govtypes.ModuleName).String(),
 	)
 
-	// register the staking hooks
-	// NOTE: stakingKeeper above is passed by reference, so that it will contain these hooks
-	appKeepers.StakingKeeper.SetHooks(
-		stakingtypes.NewMultiStakingHooks(
-			appKeepers.DistrKeeper.Hooks(),
-			appKeepers.SlashingKeeper.Hooks(),
-		),
-	)
-
 	// UpgradeKeeper must be created before IBCKeeper
 	appKeepers.UpgradeKeeper = upgradekeeper.NewKeeper(
 		skipUpgradeHeights,
@@ -266,6 +257,16 @@ func NewAppKeeper(
 	// If evidence needs to be handled for the app, set routes in router here and seal
 	appKeepers.EvidenceKeeper = *evidenceKeeper
 
+	// register the staking hooks
+	// NOTE: stakingKeeper above is passed by reference, so that it will contain these hooks
+	appKeepers.StakingKeeper.SetHooks(
+		stakingtypes.NewMultiStakingHooks(
+			appKeepers.DistrKeeper.Hooks(),
+			appKeepers.SlashingKeeper.Hooks(),
+			appKeepers.GovKeeper.StakingHooks(),
+		),
+	)
+
 	return appKeepers
 }
 

go.mod

@@ -10,6 +10,7 @@ require (
 	cosmossdk.io/math v1.3.0
 	cosmossdk.io/simapp v0.0.0-20230602123434-616841b9704d
 	cosmossdk.io/tools/rosetta v0.2.1
+	github.com/chzyer/readline v1.5.1
 	github.com/cometbft/cometbft v0.37.4
 	github.com/cometbft/cometbft-db v0.10.0
 	github.com/cosmos/cosmos-proto v1.0.0-beta.4
@@ -19,6 +20,7 @@ require (
 	github.com/golang/mock v1.6.0
 	github.com/google/gofuzz v1.2.0
 	github.com/gorilla/mux v1.8.1
+	github.com/manifoldco/promptui v0.9.0
 	github.com/ory/dockertest/v3 v3.10.0
 	github.com/rakyll/statik v0.1.7
 	github.com/spf13/cast v1.6.0
@@ -30,6 +32,7 @@ require (
 	golang.org/x/sync v0.4.0
 	google.golang.org/genproto/googleapis/api v0.0.0-20231212172506-995d672761c0
 	google.golang.org/protobuf v1.32.0
+	gopkg.in/yaml.v2 v2.4.0
 	gotest.tools/v3 v3.5.1
 	sigs.k8s.io/yaml v1.4.0
 )
@@ -66,7 +69,6 @@ require (
 	github.com/cenkalti/backoff/v4 v4.1.3 // indirect
 	github.com/cespare/xxhash v1.1.0 // indirect
 	github.com/cespare/xxhash/v2 v2.2.0 // indirect
-	github.com/chzyer/readline v1.5.1 // indirect
 	github.com/cockroachdb/apd/v2 v2.0.2 // indirect
 	github.com/cockroachdb/errors v1.10.0 // indirect
 	github.com/cockroachdb/logtags v0.0.0-20230118201751-21c54148d20b // indirect
@@ -145,7 +147,6 @@ require (
 	github.com/libp2p/go-buffer-pool v0.1.0 // indirect
 	github.com/linxGnu/grocksdb v1.8.11 // indirect
 	github.com/magiconair/properties v1.8.7 // indirect
-	github.com/manifoldco/promptui v0.9.0 // indirect
 	github.com/mattn/go-colorable v0.1.13 // indirect
 	github.com/mattn/go-isatty v0.0.20 // indirect
 	github.com/matttproud/golang_protobuf_extensions v1.0.4 // indirect
@@ -203,7 +204,6 @@ require (
 	google.golang.org/appengine v1.6.8 // indirect
 	google.golang.org/genproto/googleapis/rpc v0.0.0-20240108191215-35c7eff3a6b1 // indirect
 	gopkg.in/ini.v1 v1.67.0 // indirect
-	gopkg.in/yaml.v2 v2.4.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 	nhooyr.io/websocket v1.8.6 // indirect
 	pgregory.net/rapid v1.1.0 // indirect

proto/atomone/gov/v1/genesis.proto

@@ -30,4 +30,9 @@ message GenesisState {
   //
   // Since: cosmos-sdk 0.47
   Params params = 8;
+
+  // governors defines all the governors present at genesis.
+  repeated Governor governors = 9;
+  // governance_delegations defines all the governance delegations present at genesis.
+  repeated GovernanceDelegation governance_delegations = 10;
 }

proto/atomone/gov/v1/gov.proto

@@ -217,4 +217,90 @@ message Params {
 
   // burn deposits if quorum with vote type no_veto is met
   bool burn_vote_veto = 15;
+
+  // defines the maximum number of governors that can be active at any given time.
+  uint64 max_governors = 20;
+  // defines the duration of time that need to elapse between governor status changes.
+  google.protobuf.Duration governor_status_change_period = 21 [(gogoproto.stdduration) = true];
+}
+
+
+// Governor defines a governor, together with the total amount of delegated
+// validator's bond shares for a set amount of validators. When a delegator
+// delegates a percentage of its x/gov power to a governor, the resulting
+// shares from each delegators delegations in x/staking are added to the
+// governor's total shares.
+message Governor {
+  option (gogoproto.equal)           = false;
+  option (gogoproto.goproto_getters) = false;
+
+  // governor_address defines the address of the governor; bech encoded in JSON.
+  string governor_address = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
+  // status is the status of the governor (active/inactive).
+  GovernorStatus status = 2;
+  // description defines the description terms for the governor.
+  GovernorDescription description = 3 [(gogoproto.nullable) = false, (amino.dont_omitempty) = true];
+  // voting_power defines the (estimated) voting power of the governor.
+  string voting_power = 4 [
+    (cosmos_proto.scalar)  = "cosmos.Dec",
+    (gogoproto.customtype) = "cosmossdk.io/math.LegacyDec",
+    (gogoproto.nullable)   = false
+  ];
+
+  // last_status_change_time is the time when the governor's status was last changed.
+  google.protobuf.Timestamp last_status_change_time = 5 [(gogoproto.stdtime) = true];
+}
+
+// GovernorStatus is the status of a governor.
+enum GovernorStatus {
+  option (gogoproto.goproto_enum_prefix) = false;
+
+  // UNSPECIFIED defines an invalid governor status.
+  GOVERNOR_STATUS_UNSPECIFIED = 0 [(gogoproto.enumvalue_customname) = "Unspecified"];
+  // ACTIVE defines a governor that is active.
+  GOVERNOR_STATUS_ACTIVE = 1 [(gogoproto.enumvalue_customname) = "Active"];
+  // INACTIVE defines a governor that is inactive.
+  GOVERNOR_STATUS_INACTIVE = 2 [(gogoproto.enumvalue_customname) = "Inactive"];
+}
+
+// Description defines a governor description.
+message GovernorDescription {
+  option (gogoproto.equal) = true;
+
+  // moniker defines a human-readable name for the governor.
+  string moniker = 1;
+  // identity defines an optional identity signature (ex. UPort or Keybase).
+  string identity = 2;
+  // website defines an optional website link.
+  string website = 3;
+  // security_contact defines an optional email for security contact.
+  string security_contact = 4;
+  // details define other optional details.
+  string details = 5;
+}
+
+// GovernorValShares holds the number of shares from the specific validator
+// that a governor can use to vote on proposals.
+message GovernorValShares {
+  option (gogoproto.equal)           = false;
+  option (gogoproto.goproto_getters) = false;
+
+  string governor_address = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
+  string validator_address = 2 [(cosmos_proto.scalar) = "cosmos.ValidatorAddressString"];
+  // shares define the delegation shares available from this validator.
+  string shares = 3 [
+    (cosmos_proto.scalar)  = "cosmos.Dec",
+    (gogoproto.customtype) = "cosmossdk.io/math.LegacyDec",
+    (gogoproto.nullable)   = false
+  ];
+}
+
+// GovernanceDelegation defines a delegation of governance voting power from a
+// delegator to a governor.
+message GovernanceDelegation {
+  option (gogoproto.equal)           = false;
+  option (gogoproto.goproto_getters) = false;
+
+  string delegator_address = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
+  string governor_address = 2 [(cosmos_proto.scalar) = "cosmos.AddressString"];
 }

proto/atomone/gov/v1/query.proto

@@ -51,6 +51,31 @@ service Query {
   rpc TallyResult(QueryTallyResultRequest) returns (QueryTallyResultResponse) {
     option (google.api.http).get = "/atomone/gov/v1/proposals/{proposal_id}/tally";
   }
+
+  // Governor queries governor information based on governor address.
+  rpc Governor(QueryGovernorRequest) returns (QueryGovernorResponse) {
+    option (google.api.http).get = "/atomone/gov/v1/governor/{governor_address}";
+  }
+
+  // Governors queries all governors.
+  rpc Governors(QueryGovernorsRequest) returns (QueryGovernorsResponse) {
+    option (google.api.http).get = "/atomone/gov/v1/governors";
+  }
+
+  // GovernanceDelegations queries all delegations of a governor.
+  rpc GovernanceDelegations(QueryGovernanceDelegationsRequest) returns (QueryGovernanceDelegationsResponse) {
+    option (google.api.http).get = "/atomone/gov/v1/governors/{governor_address}/delegations";
+  }
+
+  // GovernanceDelegation queries a delegation
+  rpc GovernanceDelegation(QueryGovernanceDelegationRequest) returns (QueryGovernanceDelegationResponse) {
+    option (google.api.http).get = "/atomone/gov/v1/delegations/{delegator_address}";
+  }
+
+  // GovernorValShares queries all governor validator shares resulting from all governance delegations.
+  rpc GovernorValShares(QueryGovernorValSharesRequest) returns (QueryGovernorValSharesResponse) {
+    option (google.api.http).get = "/atomone/gov/v1/valshares/{governor_address}";
+  }
 }
 
 // QueryProposalRequest is the request type for the Query/Proposal RPC method.
@@ -191,3 +216,78 @@ message QueryTallyResultResponse {
   // tally defines the requested tally.
   TallyResult tally = 1;
 }
+
+// QueryGovernorRequest is the request type for the Query/Governor RPC method.
+message QueryGovernorRequest {
+  // gvernor_address defines the address of the governor.
+  string governor_address = 1 [(cosmos_proto.scalar) = "atomone.GovernorAddressString"];
+}
+
+// QueryGovernorResponse is the response type for the Query/Governor RPC method.
+message QueryGovernorResponse {
+  // governor defines the requested governor.
+  Governor governor = 1;
+}
+
+// QueryGovernorsRequest is the request type for the Query/Governors RPC method.
+message QueryGovernorsRequest {
+  // pagination defines an optional pagination for the request.
+  cosmos.base.query.v1beta1.PageRequest pagination = 1;
+}
+
+// QueryGovernorsResponse is the response type for the Query/Governors RPC method.
+message QueryGovernorsResponse {
+  // governors defines the requested governors.
+  repeated Governor governors = 1;
+
+  // pagination defines the pagination in the response.
+  cosmos.base.query.v1beta1.PageResponse pagination = 2;
+}
+
+// QueryGovernanceDelegationsRequest is the request type for the Query/GovernanceDelegations RPC method.
+message QueryGovernanceDelegationsRequest {
+  // governor_address defines the address of the governor.
+  string governor_address = 1 [(cosmos_proto.scalar) = "atomone.GovernorAddressString"];
+
+  // pagination defines an optional pagination for the request.
+  cosmos.base.query.v1beta1.PageRequest pagination = 2;
+}
+
+// QueryGovernanceDelegationsResponse is the response type for the Query/GovernanceDelegations RPC method.
+message QueryGovernanceDelegationsResponse {
+  // delegations defines the requested delegations.
+  repeated GovernanceDelegation delegations = 1;
+
+  // pagination defines the pagination in the response.
+  cosmos.base.query.v1beta1.PageResponse pagination = 2;
+}
+
+// QueryGovernanceDelegationRequest is the request type for the Query/GovernanceDelegation RPC method.
+message QueryGovernanceDelegationRequest {
+  // delegator_address defines the address of the delegator.
+  string delegator_address = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
+}
+
+// QueryGovernanceDelegationResponse is the response type for the Query/GovernanceDelegation RPC method.
+message QueryGovernanceDelegationResponse {
+  // governor_address defines the address of the governor.
+  string governor_address = 1;
+}
+
+// QueryGovernorValSharesRequest is the request type for the Query/GovernorValShares RPC method.
+message QueryGovernorValSharesRequest {
+  // governor_address defines the address of the governor.
+  string governor_address = 1 [(cosmos_proto.scalar) = "atomone.GovernorAddressString"];
+
+  // pagination defines the pagination in the request.
+  cosmos.base.query.v1beta1.PageRequest pagination = 2;
+}
+
+// QueryGovernorValSharesResponse is the response type for the Query/GovernorValShares RPC method.
+message QueryGovernorValSharesResponse {
+  // val_shares defines the requested validator shares.
+  repeated GovernorValShares val_shares = 1;
+
+  // pagination defines the pagination in the response.
+  cosmos.base.query.v1beta1.PageResponse pagination = 2;
+}

proto/atomone/gov/v1/tx.proto

@@ -37,6 +37,23 @@ service Msg {
   //
   // Since: cosmos-sdk 0.47
   rpc UpdateParams(MsgUpdateParams) returns (MsgUpdateParamsResponse);
+
+  // CreateGovernor defines a method to create a new governor.
+  rpc CreateGovernor(MsgCreateGovernor) returns (MsgCreateGovernorResponse);
+
+  // EditGovernor defines a method to edit an existing governor.
+  // It also sets its status.
+  rpc EditGovernor(MsgEditGovernor) returns (MsgEditGovernorResponse);
+
+  // UpdateGovernorStatus defines a method to update the status of a governor.
+  rpc UpdateGovernorStatus(MsgUpdateGovernorStatus) returns (MsgUpdateGovernorStatusResponse);
+
+  // DelegateGovernor defines a method to delegate a non-zero percentange of
+  // governance voting power from a delegator to a governor.
+  rpc DelegateGovernor(MsgDelegateGovernor) returns (MsgDelegateGovernorResponse);
+
+  // UndelegateGovernor defines a method to undelegate governance voting power
+  rpc UndelegateGovernor(MsgUndelegateGovernor) returns (MsgUndelegateGovernorResponse);
 }
 
 // MsgSubmitProposal defines an sdk.Msg type that supports submitting arbitrary
@@ -170,3 +187,78 @@ message MsgUpdateParams {
 //
 // Since: cosmos-sdk 0.47
 message MsgUpdateParamsResponse {}
+
+// MsgCreateGovernor defines a SDK message for creating a new governor.
+message MsgCreateGovernor {
+  option (cosmos.msg.v1.signer) = "address";
+  option (amino.name)           = "atomone/MsgCreateGovernor";
+
+  option (gogoproto.equal)           = false;
+  option (gogoproto.goproto_getters) = false;
+
+  GovernorDescription      description = 1 [(gogoproto.nullable) = false, (amino.dont_omitempty) = true];
+  string                   address     = 2 [(cosmos_proto.scalar) = "cosmos.AddressString"];
+}
+
+// MsgCreateGovernorrResponse defines the Msg/CreateGovernor response type.
+message MsgCreateGovernorResponse {}
+
+// MsgEditGovernor defines a SDK message for editing an existing governor.
+message MsgEditGovernor {
+  option (cosmos.msg.v1.signer) = "address";
+  option (amino.name)           = "cosmos-sdk/MsgEditGovernor";
+
+  option (gogoproto.equal)           = false;
+  option (gogoproto.goproto_getters) = false;
+
+  GovernorDescription description = 1 [(gogoproto.nullable) = false, (amino.dont_omitempty) = true];
+  string              address     = 2 [(cosmos_proto.scalar) = "cosmos.AddressString"];
+}
+
+// MsgEditGovernorResponse defines the Msg/EditGovernor response type.
+message MsgEditGovernorResponse {}
+
+// MsgUpdateGovernorStatus defines a SDK message for updating the status of a governor.
+message MsgUpdateGovernorStatus {
+  option (cosmos.msg.v1.signer) = "address";
+  option (amino.name)           = "cosmos-sdk/MsgUpdateGovernorStatus";
+
+  option (gogoproto.equal)           = false;
+  option (gogoproto.goproto_getters) = false;
+
+  string         address = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
+  GovernorStatus status  = 2;
+}
+
+// MsgUpdateGovernorStatusResponse defines the Msg/UpdateGovernorStatus response type.
+message MsgUpdateGovernorStatusResponse {}
+
+// MsgDelegateGovernor defines a SDK message for performing a delegation of governance voting power
+// from a delegator to a governor.
+message MsgDelegateGovernor {
+  option (cosmos.msg.v1.signer) = "delegator_address";
+  option (amino.name)           = "atomone/MsgDelegateGovernor";
+
+  option (gogoproto.equal)           = false;
+  option (gogoproto.goproto_getters) = false;
+
+  string delegator_address = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
+  string governor_address  = 2 [(cosmos_proto.scalar) = "atomone.GovernorAddressString"];
+}
+
+// MsgDelegateGovernorResponse defines the Msg/Delegate response type.
+message MsgDelegateGovernorResponse {}
+
+// MsgUndelegateGovernor defines a SDK message for undelegating governance voting power
+message MsgUndelegateGovernor {
+  option (cosmos.msg.v1.signer) = "delegator_address";
+  option (amino.name)           = "cosmos-sdk/MsgUndelegateGovernor";
+
+  option (gogoproto.equal)           = false;
+  option (gogoproto.goproto_getters) = false;
+
+  string delegator_address = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
+}
+
+// MsgUndelegateGovernorResponse defines the Msg/UndelegateGovernor response type.
+message MsgUndelegateGovernorResponse {}