Merge pull request #1910 from bandprotocol/request-search

chain: Implement request-search REST and CLI endpoint

CHANGELOG.md

@@ -12,6 +12,7 @@
 
 ### Chain
 
+- (feat) [\#1910](https://github.com/bandprotocol/bandchain/pull/1910) Implement request-search REST and CLI endpoint.
 - (impv) [\#1903](https://github.com/bandprotocol/bandchain/pull/1903) Store result in store instead of result hash.
 - (impv) [\#1901](https://github.com/bandprotocol/bandchain/pull/1901) Added `moniker` field to `delegations_view` table.
 - (feat) [\#1879](https://github.com/bandprotocol/bandchain/pull/1879) Keep `Request` and `Report` around. We avoid premature optimization at the moment.

chain/x/oracle/client/cli/query.go

@@ -10,6 +10,7 @@ import (
 	"github.com/cosmos/cosmos-sdk/client/flags"
 	"github.com/cosmos/cosmos-sdk/codec"
 
+	clientcmn "github.com/bandprotocol/bandchain/chain/x/oracle/client/common"
 	"github.com/bandprotocol/bandchain/chain/x/oracle/types"
 )
 
@@ -28,6 +29,7 @@ func GetQueryCmd(storeKey string, cdc *codec.Codec) *cobra.Command {
 		GetQueryCmdDataSource(storeKey, cdc),
 		GetQueryCmdOracleScript(storeKey, cdc),
 		GetQueryCmdRequest(storeKey, cdc),
+		GetQueryCmdRequestSearch(storeKey, cdc),
 	)...)
 	return oracleCmd
 }
@@ -121,3 +123,21 @@ func GetQueryCmdRequest(route string, cdc *codec.Codec) *cobra.Command {
 		},
 	}
 }
+
+// GetQueryCmdRequestSearch implements the search request command.
+func GetQueryCmdRequestSearch(route string, cdc *codec.Codec) *cobra.Command {
+	return &cobra.Command{
+		Use:  "request-search [oracle-script-id] [calldata] [ask-count] [min-count]",
+		Args: cobra.ExactArgs(4),
+		RunE: func(cmd *cobra.Command, args []string) error {
+			cliCtx := context.NewCLIContext().WithCodec(cdc)
+			res, _, err := clientcmn.QuerySearchLatestRequest(route, cliCtx, args[0], args[1], args[2], args[3])
+			if err != nil {
+				return err
+			}
+			var out types.QueryRequestResult
+			cdc.MustUnmarshalJSON(res, &out)
+			return cliCtx.PrintOutput(out)
+		},
+	}
+}

chain/x/oracle/client/common/request_search.go

@@ -0,0 +1,62 @@
+package common
+
+import (
+	"fmt"
+
+	"github.com/cosmos/cosmos-sdk/client/context"
+	authclient "github.com/cosmos/cosmos-sdk/x/auth/client"
+
+	"github.com/bandprotocol/bandchain/chain/x/oracle/types"
+)
+
+func queryRequest(route string, cliCtx context.CLIContext, rid string) ([]byte, int64, error) {
+	res, height, err := cliCtx.QueryWithData(fmt.Sprintf("custom/%s/%s/%s", route, types.QueryRequests, rid), nil)
+	if err != nil {
+		return nil, 0, err
+	}
+	return res, height, nil
+}
+
+func QuerySearchLatestRequest(
+	route string, cliCtx context.CLIContext, oid, calldata, askCount, minCount string,
+) ([]byte, int64, error) {
+
+	events := []string{
+		fmt.Sprintf("%s.%s='%s'", types.EventTypeRequest, types.AttributeKeyOracleScriptID, oid),
+		fmt.Sprintf("%s.%s='%s'", types.EventTypeRequest, types.AttributeKeyCalldata, calldata),
+		fmt.Sprintf("%s.%s='%s'", types.EventTypeRequest, types.AttributeKeyAskCount, askCount),
+		fmt.Sprintf("%s.%s='%s'", types.EventTypeRequest, types.AttributeKeyMinCount, minCount),
+	}
+	searchResult, err := authclient.QueryTxsByEvents(cliCtx, events, 1, 30, "desc")
+	if err != nil {
+		return nil, 0, err
+	}
+	for _, tx := range searchResult.Txs {
+		for _, log := range tx.Logs {
+			for _, ev := range log.Events {
+				if ev.Type != types.EventTypeRequest {
+					continue
+				}
+				rid := ""
+				ok := true
+				for _, attr := range ev.Attributes {
+					if attr.Key == types.AttributeKeyID {
+						rid = attr.Value
+					}
+					if attr.Key == types.AttributeKeyOracleScriptID && attr.Value != oid ||
+						attr.Key == types.AttributeKeyCalldata && attr.Value != calldata ||
+						attr.Key == types.AttributeKeyAskCount && attr.Value != askCount ||
+						attr.Key == types.AttributeKeyMinCount && attr.Value != minCount {
+						ok = false
+						break
+					}
+				}
+				if ok && rid != "" {
+					// TODO: Check if request has resolved.
+					return queryRequest(route, cliCtx, rid)
+				}
+			}
+		}
+	}
+	return nil, 0, fmt.Errorf("request not found")
+}

chain/x/oracle/client/rest/query.go

@@ -8,6 +8,7 @@ import (
 	"github.com/cosmos/cosmos-sdk/types/rest"
 	"github.com/gorilla/mux"
 
+	clientcmn "github.com/bandprotocol/bandchain/chain/x/oracle/client/common"
 	"github.com/bandprotocol/bandchain/chain/x/oracle/types"
 )
 
@@ -111,3 +112,22 @@ func getRequestByIDHandler(cliCtx context.CLIContext, route string) http.Handler
 		rest.PostProcessResponse(w, cliCtx, res)
 	}
 }
+
+func getRequestSearchHandler(cliCtx context.CLIContext, route string) http.HandlerFunc {
+	return func(w http.ResponseWriter, r *http.Request) {
+		cliCtx, ok := rest.ParseQueryHeightOrReturnBadRequest(w, cliCtx, r)
+		if !ok {
+			return
+		}
+		res, height, err := clientcmn.QuerySearchLatestRequest(
+			route, cliCtx,
+			r.FormValue("oid"), r.FormValue("calldata"), r.FormValue("min_count"), r.FormValue("ask_count"),
+		)
+		if err != nil {
+			rest.WriteErrorResponse(w, http.StatusInternalServerError, err.Error())
+			return
+		}
+		cliCtx = cliCtx.WithHeight(height)
+		rest.PostProcessResponse(w, cliCtx, res)
+	}
+}

chain/x/oracle/client/rest/rest.go

@@ -20,4 +20,5 @@ func RegisterRoutes(cliCtx context.CLIContext, r *mux.Router, storeName string)
 	r.HandleFunc(fmt.Sprintf("/%s/data_sources/{%s}", storeName, idTag), getDataSourceByIDHandler(cliCtx, storeName)).Methods("GET")
 	r.HandleFunc(fmt.Sprintf("/%s/oracle_scripts/{%s}", storeName, idTag), getOracleScriptByIDHandler(cliCtx, storeName)).Methods("GET")
 	r.HandleFunc(fmt.Sprintf("/%s/requests/{%s}", storeName, idTag), getRequestByIDHandler(cliCtx, storeName)).Methods("GET")
+	r.HandleFunc(fmt.Sprintf("/%s/request_search", storeName), getRequestSearchHandler(cliCtx, storeName)).Methods("GET")
 }

chain/x/oracle/handler_test.go

@@ -436,6 +436,10 @@ func TestRequestDataSuccess(t *testing.T) {
 		sdk.NewEvent(
 			types.EventTypeRequest,
 			sdk.NewAttribute(types.AttributeKeyID, "1"),
+			sdk.NewAttribute(types.AttributeKeyOracleScriptID, "1"),
+			sdk.NewAttribute(types.AttributeKeyCalldata, "62656562"), // "beeb" in hex
+			sdk.NewAttribute(types.AttributeKeyAskCount, "2"),
+			sdk.NewAttribute(types.AttributeKeyMinCount, "2"),
 			sdk.NewAttribute(types.AttributeKeyValidator, Validator1.ValAddress.String()),
 			sdk.NewAttribute(types.AttributeKeyValidator, Validator3.ValAddress.String()),
 		),

chain/x/oracle/keeper/owasm.go

@@ -1,6 +1,7 @@
 package keeper
 
 import (
+	"encoding/hex"
 	"fmt"
 
 	"github.com/bandprotocol/bandchain/chain/x/oracle/types"
@@ -55,7 +56,13 @@ func (k Keeper) PrepareRequest(ctx sdk.Context, r types.RequestSpec, ibcInfo *ty
 	id := k.AddRequest(ctx, req)
 	// Emit an event describing a data request and asked validators.
 	event := sdk.NewEvent(types.EventTypeRequest)
-	event = event.AppendAttributes(sdk.NewAttribute(types.AttributeKeyID, fmt.Sprintf("%d", id)))
+	event = event.AppendAttributes(
+		sdk.NewAttribute(types.AttributeKeyID, fmt.Sprintf("%d", id)),
+		sdk.NewAttribute(types.AttributeKeyOracleScriptID, fmt.Sprintf("%d", req.OracleScriptID)),
+		sdk.NewAttribute(types.AttributeKeyCalldata, hex.EncodeToString(req.Calldata)),
+		sdk.NewAttribute(types.AttributeKeyAskCount, fmt.Sprintf("%d", askCount)),
+		sdk.NewAttribute(types.AttributeKeyMinCount, fmt.Sprintf("%d", req.MinCount)),
+	)
 	for _, val := range req.RequestedValidators {
 		event = event.AppendAttributes(sdk.NewAttribute(types.AttributeKeyValidator, val.String()))
 	}

chain/x/oracle/keeper/owasm_test.go

@@ -33,7 +33,7 @@ func TestPrepareRequestSuccess(t *testing.T) {
 	oracleScriptID := k.AddOracleScript(ctx, os)
 	calldata := []byte("beeb")
 	askCount := uint64(1)
-	minCount := uint64(2)
+	minCount := uint64(1)
 	clientID := "beeb"
 	requestHeight := int64(0)
 	rawRequestID := []types.ExternalID{1, 2, 3}
@@ -51,6 +51,10 @@ func TestPrepareRequestSuccess(t *testing.T) {
 		sdk.NewEvent(
 			types.EventTypeRequest,
 			sdk.NewAttribute(types.AttributeKeyID, "1"),
+			sdk.NewAttribute(types.AttributeKeyOracleScriptID, "1"),
+			sdk.NewAttribute(types.AttributeKeyCalldata, "62656562"), // "beeb" in hex
+			sdk.NewAttribute(types.AttributeKeyAskCount, "1"),
+			sdk.NewAttribute(types.AttributeKeyMinCount, "1"),
 			sdk.NewAttribute(types.AttributeKeyValidator, Validator1.ValAddress.String()),
 		),
 		sdk.NewEvent(