feat(x/tokenfactory): Add query for querying all before send hooks (o…

…smosis-labs#7623)

* Add query for querying all before send hooks

* Add cli

* Update x/tokenfactory/client/cli/query.go

* Update proto/osmosis/tokenfactory/v1beta1/query.proto

Co-authored-by: Dev Ojha <[email protected]>

* Generated protofile changes

* Add changelog

---------

Co-authored-by: Dev Ojha <[email protected]>
Co-authored-by: github-actions <[email protected]>

CHANGELOG.md

@@ -56,6 +56,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * [#7562](https://github.com/osmosis-labs/osmosis/pull/7562) Speedup Protorev estimation logic by removing unnecessary taker fee simulations.
 * [#7595](https://github.com/osmosis-labs/osmosis/pull/7595) Fix cosmwasm pool model code ID migration.
 * [#7619](https://github.com/osmosis-labs/osmosis/pull/7619) Slight speedup/gas improvement to CL GetTotalPoolLiquidity queries
+* [#7623](https://github.com/osmosis-labs/osmosis/pull/7623) Add query for querying all before send hooks
 * [#7622](https://github.com/osmosis-labs/osmosis/pull/7622) Remove duplicate CL accumulator update logic.
 
 ### State Compatible

proto/osmosis/tokenfactory/v1beta1/query.proto

@@ -40,6 +40,17 @@ service Query {
     option (google.api.http).get =
         "/osmosis/tokenfactory/v1beta1/denoms/{denom}/before_send_hook";
   }
+
+  // AllBeforeSendHooksAddresses defines a gRPC query method for
+  // getting all addresses with before send hook registered.
+  // The response returns two arrays, an array with a list of denom and an array
+  // of before send hook addresses. The idx of denom corresponds to before send
+  // hook addresse's idx.
+  rpc AllBeforeSendHooksAddresses(QueryAllBeforeSendHooksAddressesRequest)
+      returns (QueryAllBeforeSendHooksAddressesResponse) {
+    option (google.api.http).get =
+        "/osmosis/tokenfactory/v1beta1/all_before_send_hooks";
+  }
 }
 
 // QueryParamsRequest is the request type for the Query/Params RPC method.
@@ -87,4 +98,14 @@ message QueryBeforeSendHookAddressRequest {
 message QueryBeforeSendHookAddressResponse {
   string cosmwasm_address = 1
       [ (gogoproto.moretags) = "yaml:\"cosmwasm_address\"" ];
+}
+
+message QueryAllBeforeSendHooksAddressesRequest {}
+
+// QueryAllBeforeSendHooksAddressesResponse defines the response structure for
+// the AllBeforeSendHooksAddresses gRPC query.
+message QueryAllBeforeSendHooksAddressesResponse {
+  repeated string denoms = 1 [ (gogoproto.moretags) = "yaml:\"denoms\"" ];
+  repeated string before_send_hook_addresses = 2
+      [ (gogoproto.moretags) = "yaml:\"before_send_addresses\"" ];
 }

x/tokenfactory/client/cli/query.go

@@ -21,6 +21,7 @@ func GetQueryCmd() *cobra.Command {
 
 	osmocli.AddQueryCmd(cmd, types.NewQueryClient, GetCmdDenomAuthorityMetadata)
 	osmocli.AddQueryCmd(cmd, types.NewQueryClient, GetCmdDenomsFromCreator)
+	osmocli.AddQueryCmd(cmd, types.NewQueryClient, GetCmdAllBeforeSendHooks)
 
 	cmd.AddCommand(
 		osmocli.GetParams[*types.QueryParamsRequest](
@@ -47,6 +48,12 @@ func GetCmdDenomsFromCreator() (*osmocli.QueryDescriptor, *types.QueryDenomsFrom
 		{{.CommandPrefix}} <address>`,
 	}, &types.QueryDenomsFromCreatorRequest{}
 }
+func GetCmdAllBeforeSendHooks() (*osmocli.QueryDescriptor, *types.QueryAllBeforeSendHooksAddressesRequest) {
+	return &osmocli.QueryDescriptor{
+		Use:   "all-before-send-hooks",
+		Short: "Returns a list of all before send hooks registered",
+	}, &types.QueryAllBeforeSendHooksAddressesRequest{}
+}
 
 // GetCmdDenomAuthorityMetadata returns the authority metadata for a queried denom
 func GetCmdDenomBeforeSendHook() *cobra.Command {

x/tokenfactory/keeper/before_send.go

@@ -47,6 +47,24 @@ func (k Keeper) GetBeforeSendHook(ctx sdk.Context, denom string) string {
 	return string(bz)
 }
 
+func (k Keeper) GetAllBeforeSendHooks(ctx sdk.Context) ([]string, []string) {
+	denomsList := []string{}
+	beforeSendHooksList := []string{}
+
+	iterator := k.GetAllDenomsIterator(ctx)
+	defer iterator.Close()
+	for ; iterator.Valid(); iterator.Next() {
+		denom := string(iterator.Value())
+
+		beforeSendHook := k.GetBeforeSendHook(ctx, denom)
+		if beforeSendHook != "" {
+			denomsList = append(denomsList, denom)
+			beforeSendHooksList = append(beforeSendHooksList, beforeSendHook)
+		}
+	}
+	return denomsList, beforeSendHooksList
+}
+
 // Hooks wrapper struct for bank keeper
 type Hooks struct {
 	k Keeper

x/tokenfactory/keeper/before_send_test.go

@@ -113,6 +113,10 @@ func (s *KeeperTestSuite) TestBeforeSendHook() {
 			_, err = s.msgServer.SetBeforeSendHook(sdk.WrapSDKContext(s.Ctx), types.NewMsgSetBeforeSendHook(s.TestAccs[0].String(), denom, cosmwasmAddress.String()))
 			s.Require().NoError(err, "test: %v", tc.desc)
 
+			denoms, beforeSendHooks := s.App.TokenFactoryKeeper.GetAllBeforeSendHooks(s.Ctx)
+			s.Require().Equal(beforeSendHooks, []string{cosmwasmAddress.String()})
+			s.Require().Equal(denoms, []string{denom})
+
 			for _, sendTc := range tc.sendMsgs {
 				_, err := s.bankMsgServer.Send(sdk.WrapSDKContext(s.Ctx), sendTc.msg(denom))
 				if sendTc.expectPass {

x/tokenfactory/keeper/grpc_query.go

@@ -50,3 +50,10 @@ func (k Keeper) BeforeSendHookAddress(ctx context.Context, req *types.QueryBefor
 
 	return &types.QueryBeforeSendHookAddressResponse{CosmwasmAddress: cosmwasmAddress}, nil
 }
+
+func (k Keeper) AllBeforeSendHooksAddresses(ctx context.Context, req *types.QueryAllBeforeSendHooksAddressesRequest) (*types.QueryAllBeforeSendHooksAddressesResponse, error) {
+	sdkCtx := sdk.UnwrapSDKContext(ctx)
+	denoms, beforesendHookAddresses := k.GetAllBeforeSendHooks(sdkCtx)
+
+	return &types.QueryAllBeforeSendHooksAddressesResponse{Denoms: denoms, BeforeSendHookAddresses: beforesendHookAddresses}, nil
+}