feat: consumer throttle state query

proto/interchain_security/ccv/consumer/v1/query.proto

@@ -7,6 +7,7 @@ option go_package = "github.com/cosmos/interchain-security/v3/x/ccv/consumer/typ
 import "gogoproto/gogo.proto";
 import "google/api/annotations.proto";
 import "interchain_security/ccv/consumer/v1/consumer.proto";
+import "interchain_security/ccv/v1/wire.proto";
 
 service Query {
   // ConsumerGenesis queries the genesis state needed to start a consumer chain
@@ -24,6 +25,11 @@ service Query {
   rpc QueryProviderInfo(QueryProviderInfoRequest) returns (QueryProviderInfoResponse) {
     option (google.api.http).get = "/interchain_security/ccv/consumer/provider-info";
   }
+
+  // QueryThrottleState returns on-chain state relevant to throttled consumer packets 
+  rpc QueryThrottleState(QueryThrottleStateRequest) returns (QueryThrottleStateResponse) {
+    option (google.api.http).get = "/interchain_security/ccv/consumer/throttle_state";
+  }
 }
 
 // NextFeeDistributionEstimate holds information about next fee distribution
@@ -65,6 +71,14 @@ message QueryProviderInfoResponse {
   ChainInfo provider = 2 [ (gogoproto.nullable) = false ];
 }
 
+message QueryThrottleStateRequest {}
+
+message QueryThrottleStateResponse {
+  SlashRecord slash_record = 1 [ (gogoproto.nullable) = true ];
+  repeated interchain_security.ccv.v1.ConsumerPacketData packet_data_queue = 2 [ (gogoproto.nullable) = false ];
+}
+
+
 message ChainInfo {
   string chainID = 1;
   string clientID = 2;

tests/e2e/state.go

@@ -26,8 +26,7 @@ type ChainState struct {
 	ConsumerChains                 *map[chainID]bool
 	AssignedKeys                   *map[validatorID]string
 	ProviderKeys                   *map[validatorID]string // validatorID: validator provider key
-	ConsumerChainQueueSizes        *map[chainID]uint
-	GlobalSlashQueueSize           *uint
+	ConsumerPendingPacketQueueSize *uint                   // Only relevant to consumer chains
 	RegisteredConsumerRewardDenoms *[]string
 }
 
@@ -173,6 +172,11 @@ func (tr TestRun) getChainState(chain chainID, modelState ChainState) ChainState
 		chainState.RegisteredConsumerRewardDenoms = &registeredConsumerRewardDenoms
 	}
 
+	if modelState.ConsumerPendingPacketQueueSize != nil {
+		pendingPacketQueueSize := tr.getPendingPacketQueueSize(chain)
+		chainState.ConsumerPendingPacketQueueSize = &pendingPacketQueueSize
+	}
+
 	if *verbose {
 		log.Println("Done getting chain state:\n" + pretty.Sprint(chainState))
 	}
@@ -694,6 +698,27 @@ func (tr TestRun) getRegisteredConsumerRewardDenoms(chain chainID) []string {
 	return rewardDenoms
 }
 
+func (tr TestRun) getPendingPacketQueueSize(chain chainID) uint {
+	//#nosec G204 -- Bypass linter warning for spawning subprocess with cmd arguments.
+	cmd := exec.Command("docker", "exec", tr.containerConfig.instanceName, tr.chainConfigs[chain].binaryName,
+
+		"query", "ccvconsumer", "throttle-state",
+		`--node`, tr.getQueryNode(chain),
+		`-o`, `json`,
+	)
+	bz, err := cmd.CombinedOutput()
+	if err != nil {
+		log.Fatal(err, "\n", string(bz))
+	}
+
+	if !gjson.ValidBytes(bz) {
+		panic("invalid json response from query ccvconsumer throttle-state: " + string(bz))
+	}
+
+	packetData := gjson.Get(string(bz), "packet_data_queue").Array()
+	return uint(len(packetData))
+}
+
 func (tr TestRun) getValidatorNode(chain chainID, validator validatorID) string {
 	// for CometMock, validatorNodes are all the same address as the query node (which is CometMocks address)
 	if tr.useCometmock {
@@ -742,3 +767,7 @@ func (tr TestRun) curlJsonRPCRequest(method, params, address string) {
 	verbosity := false
 	executeCommandWithVerbosity(cmd, "curlJsonRPCRequest", verbosity)
 }
+
+func uintPtr(i uint) *uint {
+	return &i
+}

tests/e2e/steps_downtime.go

@@ -293,6 +293,7 @@ func stepsThrottledDowntime(consumerName string) []Step {
 						validatorID("bob"):   500,
 						validatorID("carol"): 500,
 					},
+					ConsumerPendingPacketQueueSize: uintPtr(1), // bob's downtime slash packet is queued
 				},
 			},
 		},
@@ -321,6 +322,7 @@ func stepsThrottledDowntime(consumerName string) []Step {
 						validatorID("bob"):   500,
 						validatorID("carol"): 500,
 					},
+					ConsumerPendingPacketQueueSize: uintPtr(0), // slash packet handled ack clears consumer queue
 				},
 			},
 		},
@@ -344,6 +346,7 @@ func stepsThrottledDowntime(consumerName string) []Step {
 						validatorID("bob"):   500, // VSC packet jailing bob is not yet relayed to consumer
 						validatorID("carol"): 500,
 					},
+					ConsumerPendingPacketQueueSize: uintPtr(1), // carol's downtime slash packet is queued
 				},
 			},
 		},
@@ -368,6 +371,7 @@ func stepsThrottledDowntime(consumerName string) []Step {
 						validatorID("bob"):   0, // VSC packet applying bob jailing is also relayed and recv by consumer
 						validatorID("carol"): 500,
 					},
+					ConsumerPendingPacketQueueSize: uintPtr(1), // slash packet bounced ack keeps carol's downtime slash packet queued
 				},
 			},
 		},

x/ccv/consumer/client/cli/query.go

@@ -22,6 +22,7 @@ func NewQueryCmd() *cobra.Command {
 	cmd.AddCommand(
 		CmdNextFeeDistribution(),
 		CmdProviderInfo(),
+		CmdThrottleState(),
 	)
 
 	return cmd
@@ -80,3 +81,30 @@ func CmdProviderInfo() *cobra.Command {
 
 	return cmd
 }
+
+func CmdThrottleState() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "throttle-state",
+		Short: "Query throttle state",
+		Args:  cobra.ExactArgs(0),
+		RunE: func(cmd *cobra.Command, args []string) (err error) {
+			clientCtx, err := client.GetClientQueryContext(cmd)
+			if err != nil {
+				return err
+			}
+			queryClient := types.NewQueryClient(clientCtx)
+
+			req := &types.QueryThrottleStateRequest{}
+			res, err := queryClient.QueryThrottleState(cmd.Context(), req)
+			if err != nil {
+				return err
+			}
+
+			return clientCtx.PrintProto(res)
+		},
+	}
+
+	flags.AddQueryFlagsToCmd(cmd)
+
+	return cmd
+}

x/ccv/consumer/keeper/grpc_query.go

@@ -9,6 +9,7 @@ import (
 	sdk "github.com/cosmos/cosmos-sdk/types"
 
 	"github.com/cosmos/interchain-security/v3/x/ccv/consumer/types"
+	ccvtypes "github.com/cosmos/interchain-security/v3/x/ccv/types"
 )
 
 var _ types.QueryServer = Keeper{} //nolint:golint
@@ -51,3 +52,25 @@ func (k Keeper) QueryProviderInfo(c context.Context, //nolint:golint
 
 	return k.GetProviderInfo(ctx)
 }
+
+func (k Keeper) QueryThrottleState(c context.Context,
+	req *types.QueryThrottleStateRequest,
+) (*types.QueryThrottleStateResponse, error) {
+	ctx := sdk.UnwrapSDKContext(c)
+
+	resp := types.QueryThrottleStateResponse{}
+
+	slashRecord, found := k.GetSlashRecord(ctx)
+	if found {
+		resp.SlashRecord = &slashRecord
+	} else {
+		resp.SlashRecord = nil
+	}
+
+	resp.PacketDataQueue = make([]ccvtypes.ConsumerPacketData, 0)
+	pendingPackets := k.GetAllPendingPacketsWithIdx(ctx)
+	for _, packet := range pendingPackets {
+		resp.PacketDataQueue = append(resp.PacketDataQueue, packet.ConsumerPacketData)
+	}
+	return &resp, nil
+}