feat: add tally result querier

proto/ibc/applications/perm/v1/genesis.proto

@@ -9,8 +9,6 @@ option go_package = "github.com/initia-labs/initia/x/ibc/perm/types";
 
 // GenesisState defines the ibc perm genesis state
 message GenesisState {
-  repeated ChannelState channel_states = 1 [
-    (gogoproto.moretags) = "yaml:\"channel_states\"",
-    (gogoproto.nullable) = false
-  ];
+  repeated ChannelState channel_states = 1
+      [(gogoproto.moretags) = "yaml:\"channel_states\"", (gogoproto.nullable) = false];
 }

proto/ibc/applications/perm/v1/query.proto

@@ -39,7 +39,7 @@ message QueryChannelStatesResponse {
 // QueryChannelStateRequest is the request type for the Query/ChannelState RPC method.
 message QueryChannelStateRequest {
   string channel_id = 1;
-  string port_id = 2;
+  string port_id    = 2;
 }
 
 // QueryChannelStateResponse is the response type for the Query/ChannelState RPC method.

proto/ibc/applications/perm/v1/tx.proto

@@ -26,19 +26,16 @@ service Msg {
 // the specific ibc channel.
 message MsgSetPermissionedRelayers {
   option (cosmos.msg.v1.signer) = "authority";
-  option (amino.name) = "perm/MsgSetPermissionedRelayers";
+  option (amino.name)           = "perm/MsgSetPermissionedRelayers";
 
-  option (gogoproto.equal) = false;
+  option (gogoproto.equal)           = false;
   option (gogoproto.goproto_getters) = false;
 
   // authority is the address that controls the module
   // (defaults to x/gov unless overwritten).
-  string authority = 1 [
-    (gogoproto.moretags) = "yaml:\"authority\"",
-    (cosmos_proto.scalar) = "cosmos.AddressString"
-  ];
+  string authority  = 1 [(gogoproto.moretags) = "yaml:\"authority\"", (cosmos_proto.scalar) = "cosmos.AddressString"];
   string channel_id = 2 [(gogoproto.moretags) = "yaml:\"channel_id\""];
-  string port_id = 3 [(gogoproto.moretags) = "yaml:\"port_id\""];
+  string port_id    = 3 [(gogoproto.moretags) = "yaml:\"port_id\""];
   repeated string relayers = 4 [(gogoproto.moretags) = "yaml:\"relayers\""];
 }
 
@@ -48,19 +45,16 @@ message MsgSetPermissionedRelayersResponse {}
 // MsgHaltChannel defines msg to halt the specific ibc channel.
 message MsgHaltChannel {
   option (cosmos.msg.v1.signer) = "authority";
-  option (amino.name) = "perm/MsgHaltChannel";
+  option (amino.name)           = "perm/MsgHaltChannel";
 
-  option (gogoproto.equal) = false;
+  option (gogoproto.equal)           = false;
   option (gogoproto.goproto_getters) = false;
 
   // authority is the address that controls the module
   // (defaults to x/gov unless overwritten).
-  string authority = 1 [
-    (gogoproto.moretags) = "yaml:\"authority\"",
-    (cosmos_proto.scalar) = "cosmos.AddressString"
-  ];
+  string authority  = 1 [(gogoproto.moretags) = "yaml:\"authority\"", (cosmos_proto.scalar) = "cosmos.AddressString"];
   string channel_id = 2 [(gogoproto.moretags) = "yaml:\"channel_id\""];
-  string port_id = 3 [(gogoproto.moretags) = "yaml:\"port_id\""];
+  string port_id    = 3 [(gogoproto.moretags) = "yaml:\"port_id\""];
 }
 
 // MsgHaltChannelResponse defines the Msg/HaltChannel response type.
@@ -69,19 +63,16 @@ message MsgHaltChannelResponse {}
 // MsgResumeChannel defines msg to resume the specific ibc channel.
 message MsgResumeChannel {
   option (cosmos.msg.v1.signer) = "authority";
-  option (amino.name) = "perm/MsgResumeChannel";
+  option (amino.name)           = "perm/MsgResumeChannel";
 
-  option (gogoproto.equal) = false;
+  option (gogoproto.equal)           = false;
   option (gogoproto.goproto_getters) = false;
 
   // authority is the address that controls the module
   // (defaults to x/gov unless overwritten).
-  string authority = 1 [
-    (gogoproto.moretags) = "yaml:\"authority\"",
-    (cosmos_proto.scalar) = "cosmos.AddressString"
-  ];
+  string authority  = 1 [(gogoproto.moretags) = "yaml:\"authority\"", (cosmos_proto.scalar) = "cosmos.AddressString"];
   string channel_id = 2 [(gogoproto.moretags) = "yaml:\"channel_id\""];
-  string port_id = 3 [(gogoproto.moretags) = "yaml:\"port_id\""];
+  string port_id    = 3 [(gogoproto.moretags) = "yaml:\"port_id\""];
 }
 
 // MsgResumeChannelResponse defines the Msg/ResumeChannel response type.

proto/ibc/applications/perm/v1/types.proto

@@ -8,14 +8,14 @@ option go_package = "github.com/initia-labs/initia/x/ibc/perm/types";
 
 // ChannelState defines the channel state for the specific port-id:channel-id pair.
 message ChannelState {
-  string port_id = 1;
-  string channel_id = 2;
-  HaltState halt_state = 3 [(gogoproto.nullable) = false];
-  repeated string relayers = 4;
+  string          port_id    = 1;
+  string          channel_id = 2;
+  HaltState       halt_state = 3 [(gogoproto.nullable) = false];
+  repeated string relayers   = 4;
 }
 
 // HaltState defines the halt state for the specific port-id:channel-id pair.
 message HaltState {
-  bool halted = 1;
+  bool   halted    = 1;
   string halted_by = 2;
 }

proto/initia/gov/v1/gov.proto

@@ -1,14 +1,14 @@
 syntax = "proto3";
 package initia.gov.v1;
 
+import "amino/amino.proto";
 import "cosmos/base/v1beta1/coin.proto";
+import "cosmos/gov/v1/gov.proto";
+import "cosmos_proto/cosmos.proto";
 import "gogoproto/gogo.proto";
 import "google/protobuf/any.proto";
-import "google/protobuf/timestamp.proto";
 import "google/protobuf/duration.proto";
-import "cosmos_proto/cosmos.proto";
-import "cosmos/gov/v1/gov.proto";
-import "amino/amino.proto";
+import "google/protobuf/timestamp.proto";
 
 option go_package = "github.com/initia-labs/initia/x/gov/types";
 // option (gogoproto.equal_all) = true;
@@ -120,6 +120,16 @@ message Vesting {
   string creator_addr = 3;
 }
 
+message TallyResult {
+  uint64 tally_height        = 1;
+  string total_staking_power = 2 [(cosmos_proto.scalar) = "cosmos.Int"];
+  string total_vesting_power = 3 [(cosmos_proto.scalar) = "cosmos.Int"];
+
+  // v1_tally_result is the original TallyResult from cosmos-sdk,
+  // which contains both staking and vesting power.
+  cosmos.gov.v1.TallyResult v1_tally_result = 4;
+}
+
 // Proposal defines the core field members of a governance proposal.
 message Proposal {
   // id defines the unique id of the proposal.
@@ -134,7 +144,7 @@ message Proposal {
   // final_tally_result is the final tally result of the proposal. When
   // querying a proposal via gRPC, this field is not populated until the
   // proposal's voting period has ended.
-  cosmos.gov.v1.TallyResult final_tally_result = 4;
+  TallyResult final_tally_result = 4 [(gogoproto.nullable) = false, (amino.dont_omitempty) = true];
 
   // submit_time is the time of proposal submission.
   google.protobuf.Timestamp submit_time = 5 [(gogoproto.stdtime) = true];
@@ -185,4 +195,4 @@ message Proposal {
   //
   // Since: cosmos-sdk 0.50
   string failed_reason = 18;
-}
+}

proto/initia/gov/v1/query.proto

@@ -1,11 +1,12 @@
 syntax = "proto3";
 package initia.gov.v1;
 
-import "gogoproto/gogo.proto";
-import "google/api/annotations.proto";
-import "cosmos_proto/cosmos.proto";
+import "amino/amino.proto";
 import "cosmos/base/query/v1beta1/pagination.proto";
 import "cosmos/gov/v1/gov.proto";
+import "cosmos_proto/cosmos.proto";
+import "gogoproto/gogo.proto";
+import "google/api/annotations.proto";
 import "initia/gov/v1/gov.proto";
 
 option go_package = "github.com/initia-labs/initia/x/gov/types";
@@ -31,6 +32,11 @@ service Query {
   rpc Proposals(QueryProposalsRequest) returns (QueryProposalsResponse) {
     option (google.api.http).get = "/initia/gov/v1/proposals";
   }
+
+  // TallyResult queries the tally of a proposal vote.
+  rpc TallyResult(QueryTallyResultRequest) returns (QueryTallyResultResponse) {
+    option (google.api.http).get = "/initia/gov/v1/proposals/{proposal_id}/tally";
+  }
 }
 
 // QueryParamsRequest is the request type for the Query/Params RPC method.
@@ -96,4 +102,16 @@ message QueryProposalsResponse {
 
   // pagination defines the pagination in the response.
   cosmos.base.query.v1beta1.PageResponse pagination = 2;
-}
+}
+
+// QueryTallyResultRequest is the request type for the Query/Tally RPC method.
+message QueryTallyResultRequest {
+  // proposal_id defines the unique id of the proposal.
+  uint64 proposal_id = 1;
+}
+
+// QueryTallyResultResponse is the response type for the Query/Tally RPC method.
+message QueryTallyResultResponse {
+  // tally defines the requested tally.
+  TallyResult tally_result = 1 [(gogoproto.nullable) = false, (amino.dont_omitempty) = true];
+}

x/gov/abci.go

@@ -220,7 +220,7 @@ func handleTallyResult(
 	k *keeper.Keeper,
 	proposal customtypes.Proposal,
 	passed, burnDeposits bool,
-	tallyResults v1.TallyResult,
+	tallyResults customtypes.TallyResult,
 ) (err error) {
 	// If an expedited proposal fails, we do not want to update
 	// the deposit at this point since the proposal is converted to regular.
@@ -333,7 +333,7 @@ func handleTallyResult(
 		logMsg = "rejected"
 	}
 
-	proposal.FinalTallyResult = &tallyResults
+	proposal.FinalTallyResult = tallyResults
 
 	err = k.SetProposal(ctx, proposal)
 	if err != nil {

x/gov/keeper/custom_grpc_query.go

@@ -117,3 +117,46 @@
 
 	return &customtypes.QueryProposalsResponse{Proposals: filteredProposals, Pagination: pageRes}, nil
 }
+
+// TallyResult queries the tally of a proposal vote
+func (q CustomQueryServer) TallyResult(ctx context.Context, req *customtypes.QueryTallyResultRequest) (*customtypes.QueryTallyResultResponse, error) {
+	if req == nil {
+		return nil, status.Error(codes.InvalidArgument, "invalid request")
+	}
+
+	if req.ProposalId == 0 {
+		return nil, status.Error(codes.InvalidArgument, "proposal id can not be 0")
+	}
+
+	proposal, err := q.Keeper.Proposals.Get(ctx, req.ProposalId)
+	if err != nil {
+		if errors.IsOf(err, collections.ErrNotFound) {
+			return nil, status.Errorf(codes.NotFound, "proposal %d doesn't exist", req.ProposalId)
+		}
+		return nil, status.Error(codes.Internal, err.Error())
+	}
+
+	var tallyResult customtypes.TallyResult
+
+	switch {
+	case proposal.Status == v1.StatusDepositPeriod:
+		tallyResult = customtypes.EmptyTallyResult()
+
+	case proposal.Status == v1.StatusPassed || proposal.Status == v1.StatusRejected:
+		tallyResult = proposal.FinalTallyResult
+
+	default:
+		// proposal is in voting period
+		params, err := q.Keeper.Params.Get(ctx)
+		if err != nil {
+			return nil, err
+		}
+
+		_, _, _, tallyResult, err = q.Keeper.Tally(ctx, params, proposal)
+		if err != nil {
+			return nil, err
+		}
+	}
+
+	return &customtypes.QueryTallyResultResponse{TallyResult: tallyResult}, nil
+}

x/gov/keeper/custom_grpc_query_test.go

@@ -2,9 +2,14 @@ package keeper_test
 
 import (
 	"testing"
+	"time"
 
+	"cosmossdk.io/math"
 	"github.com/stretchr/testify/require"
 
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	v1 "github.com/cosmos/cosmos-sdk/x/gov/types/v1"
+
 	"github.com/initia-labs/initia/x/gov/keeper"
 	"github.com/initia-labs/initia/x/gov/types"
 )
@@ -115,3 +120,87 @@ func Test_CustomGrpcQuerier_Proposal(t *testing.T) {
 	require.Equal(t, res.Proposal.Id, uint64(5))
 	require.False(t, res.Proposal.Emergency)
 }
+
+func Test_CustomGrpcQuerier_TallyResult(t *testing.T) {
+	ctx, input := createDefaultTestInput(t)
+
+	setupVesting(t, ctx, input)
+
+	proposal, err := input.GovKeeper.SubmitProposal(ctx, nil, "", "test", "description", addrs[0], false)
+	require.NoError(t, err)
+
+	proposalID := proposal.Id
+	proposal.Status = v1.StatusVotingPeriod
+	err = input.GovKeeper.SetProposal(ctx, proposal)
+	require.NoError(t, err)
+
+	proposal, err = input.GovKeeper.Proposals.Get(ctx, proposalID)
+	require.NoError(t, err)
+
+	params, err := input.GovKeeper.Params.Get(ctx)
+	require.NoError(t, err)
+
+	quorumReached, passed, _, _, err := input.GovKeeper.Tally(ctx, params, proposal)
+	require.NoError(t, err)
+	require.False(t, quorumReached)
+	require.False(t, passed)
+
+	valAddr1 := createValidatorWithCoin(ctx, input,
+		sdk.NewCoins(sdk.NewInt64Coin(bondDenom, 100_000_000)),
+		sdk.NewCoins(sdk.NewInt64Coin(bondDenom, 100_000_000)),
+		1,
+	)
+	valAddr2 := createValidatorWithCoin(ctx, input,
+		sdk.NewCoins(sdk.NewInt64Coin(bondDenom, 100_000_000)),
+		sdk.NewCoins(sdk.NewInt64Coin(bondDenom, 100_000_000)),
+		2,
+	)
+
+	voterAddr1 := sdk.AccAddress(valAddr1)
+	voterAddr2 := sdk.AccAddress(valAddr2)
+
+	// vote yes
+	err = input.GovKeeper.AddVote(ctx, proposalID, voterAddr1, v1.WeightedVoteOptions{
+		{
+			Option: v1.OptionYes,
+			Weight: "1",
+		},
+	}, "")
+	require.NoError(t, err)
+
+	// vote no
+	err = input.GovKeeper.AddVote(ctx, proposalID, voterAddr2, v1.WeightedVoteOptions{
+		{
+			Option: v1.OptionNo,
+			Weight: "1",
+		},
+	}, "")
+	require.NoError(t, err)
+
+	// add vesting vote
+	vestingVoter := addrs[1]
+	err = input.GovKeeper.AddVote(ctx, proposalID, vestingVoter, v1.WeightedVoteOptions{
+		{
+			Option: v1.OptionYes,
+			Weight: "1",
+		},
+	}, "")
+	require.NoError(t, err)
+
+	// 15 minutes passed
+	ctx = ctx.WithBlockTime(time.Now().UTC().Add(time.Minute * 15))
+	cacheCtx, _ := ctx.CacheContext()
+
+	quorumReached, passed, burnDeposits, tallyResults, err := input.GovKeeper.Tally(cacheCtx, params, proposal)
+	require.NoError(t, err)
+	require.True(t, quorumReached)
+	require.True(t, passed)
+	require.False(t, burnDeposits)
+	require.Equal(t, tallyResults.V1TallyResult.YesCount, math.LegacyNewDec(1_500_000+100_000_000).TruncateInt().String())
+	require.Equal(t, tallyResults.V1TallyResult.NoCount, math.LegacyNewDec(100_000_000).TruncateInt().String())
+
+	qs := keeper.NewCustomQueryServer(&input.GovKeeper)
+	res, err := qs.TallyResult(ctx, &types.QueryTallyResultRequest{ProposalId: proposalID})
+	require.NoError(t, err)
+	require.Equal(t, tallyResults, res.TallyResult)
+}