Add feeds signature order (#151)

* add feeds signature order

* fix import

* add tick price

* typo

* fix review

* change feed type

* add feeds price data

* change timestamp

* update getFeedsPriceData and test case

* fix review

---------

Co-authored-by: satawatnack <[email protected]>
Co-authored-by: Kitipong Sirirueangsakul <[email protected]>
Co-authored-by: nkitlabs <[email protected]>

Author: 4 people

app/app.go

@@ -124,6 +124,7 @@ import (
 	bandbank "github.com/bandprotocol/chain/v2/x/bank"
 	bandbankkeeper "github.com/bandprotocol/chain/v2/x/bank/keeper"
 	"github.com/bandprotocol/chain/v2/x/feeds"
+	feedsclient "github.com/bandprotocol/chain/v2/x/feeds/client"
 	feedskeeper "github.com/bandprotocol/chain/v2/x/feeds/keeper"
 	feedstypes "github.com/bandprotocol/chain/v2/x/feeds/types"
 	"github.com/bandprotocol/chain/v2/x/globalfee"
@@ -188,7 +189,10 @@ var (
 		oracle.AppModuleBasic{},
 		tss.AppModuleBasic{},
 		rollingseed.AppModuleBasic{},
-		bandtss.NewAppModuleBasic(oracleclient.OracleRequestSignatureHandler),
+		bandtss.NewAppModuleBasic(
+			oracleclient.OracleRequestSignatureHandler,
+			feedsclient.FeedsRequestSignatureHandler,
+		),
 		feeds.AppModuleBasic{},
 		globalfee.AppModule{},
 	)
@@ -579,23 +583,25 @@ func NewBandApp(
 	)
 	oracleIBCModule := oracle.NewIBCModule(app.OracleKeeper)
 
+	app.FeedsKeeper = feedskeeper.NewKeeper(
+		appCodec,
+		keys[feedstypes.StoreKey],
+		app.OracleKeeper,
+		app.StakingKeeper,
+		authtypes.NewModuleAddress(govtypes.ModuleName).String(),
+	)
+
 	// Add TSS route
 	tssRouter.
 		AddRoute(tsstypes.RouterKey, tsstypes.NewSignatureOrderHandler()).
 		AddRoute(oracletypes.RouterKey, oracle.NewSignatureOrderHandler(app.OracleKeeper)).
-		AddRoute(bandtsstypes.RouterKey, bandtsstypes.NewSignatureOrderHandler())
+		AddRoute(bandtsstypes.RouterKey, bandtsstypes.NewSignatureOrderHandler()).
+		AddRoute(feedstypes.RouterKey, feeds.NewSignatureOrderHandler(app.FeedsKeeper))
 
 	// It is vital to seal the request signature router here as to not allow
 	// further handlers to be registered after the keeper is created since this
 	// could create invalid or non-deterministic behavior.
 	tssRouter.Seal()
-	app.FeedsKeeper = feedskeeper.NewKeeper(
-		appCodec,
-		keys[feedstypes.StoreKey],
-		app.OracleKeeper,
-		app.StakingKeeper,
-		authtypes.NewModuleAddress(govtypes.ModuleName).String(),
-	)
 
 	app.StakingKeeper.SetHooks(
 		stakingtypes.NewMultiStakingHooks(

proto/feeds/v1beta1/feeds.proto

@@ -140,3 +140,50 @@ message PriceService {
   // Url is the URL of the price service.
   string url = 3;
 }
+
+// SignalPrice is a structure that defines the price of a signal id.
+message SignalPrice {
+  option (gogoproto.equal) = true;
+
+  // SignalID is the signal id of the price.
+  string signal_id = 1 [(gogoproto.customname) = "SignalID"];
+
+  // Price is the price of the signal id.
+  uint64 price = 2;
+}
+
+//
+message FeedsPriceData {
+  option (gogoproto.equal) = true;
+
+  // Prices is the list of prices of the feeds.
+  repeated SignalPrice signalPrices = 1 [(gogoproto.nullable) = false];
+
+  // Timestamp is the timestamp at which the price was submitted.
+  int64 timestamp = 2;
+}
+
+// FeedType is a structure that defines the type of feed.
+enum FeedType {
+  option (gogoproto.goproto_enum_prefix) = false;
+
+  // FEED_TYPE_UNSPECIFIED is an unspecified feed type.
+  FEED_TYPE_UNSPECIFIED = 0 [(gogoproto.enumvalue_customname) = "FEED_TYPE_UNSPECIFIED"];
+
+  // FEED_TYPE_DEFAULT is a default feed type.
+  FEED_TYPE_DEFAULT = 1 [(gogoproto.enumvalue_customname) = "FEED_TYPE_DEFAULT"];
+
+  // FEED_TYPE_TICK is a tick feed type.
+  FEED_TYPE_TICK = 2 [(gogoproto.enumvalue_customname) = "FEED_TYPE_TICK"];
+}
+
+// FeedSignatureOrder defines a general signature order for feed data.
+message FeedsSignatureOrder {
+  option (gogoproto.goproto_getters) = false;
+
+  // SignalIDs is the list of signal ids that require signatures.
+  repeated string signal_ids = 1 [(gogoproto.customname) = "SignalIDs"];
+
+  // FeedType is the type of feed.
+  FeedType feed_type = 2 [(gogoproto.customname) = "FeedType"];
+}

scripts/bandtss/request_signature_feeds.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+export WALLET_NAME=requester
+export SIGNAL_IDs=crypto_price.ethusd,crypto_price.usdtusd
+
+# 0: Unspecified, 1: Default, 2: Tick
+export FEEDS_TYPE=1
+
+bandd tx bandtss request-signature feeds-prices $SIGNAL_IDs $FEEDS_TYPE \
+    --from $WALLET_NAME --keyring-backend test \
+    --gas-prices 0.0025uband --fee-limit 100uband \
+    -b sync -y

x/feeds/client/cli/tx.go

@@ -14,11 +14,13 @@ import (
 	"github.com/spf13/cobra"
 
 	"github.com/bandprotocol/chain/v2/pkg/grant"
+	bandtsstypes "github.com/bandprotocol/chain/v2/x/bandtss/types"
 	"github.com/bandprotocol/chain/v2/x/feeds/types"
 )
 
 const (
 	flagExpiration = "expiration"
+	flagFeeLimit   = "fee-limit"
 )
 
 // getGrantMsgTypes returns types for GrantMsg.
@@ -192,3 +194,53 @@ $ %s tx feeds update-price-service 1234abcedf 1.0.0 http://www.example.com --fro
 
 	return cmd
 }
+
+// GetCmdRequestSignature implements the request signature handler.
+func GetCmdRequestSignature() *cobra.Command {
+	return &cobra.Command{
+		Use:   "feeds-prices [signal_id1,signal_id2,...] [feeds-type]",
+		Short: "Request bandtss signature prices from list of signal id and feeds-type (1: default, 2: tick)",
+		Args:  cobra.ExactArgs(2),
+		Long: strings.TrimSpace(
+			fmt.Sprintf(`Request bandtss signature from list of signal id and feeds-type (1: default, 2: tick)
+Example:
+$ %s tx bandtss request-signature feeds-prices crypto_price.ethusd,crypto_price.usdtusd 1 --fee-limit 10uband
+`,
+				version.AppName,
+			),
+		),
+		RunE: func(cmd *cobra.Command, args []string) error {
+			clientCtx, err := client.GetClientTxContext(cmd)
+			if err != nil {
+				return err
+			}
+
+			coinStr, err := cmd.Flags().GetString(flagFeeLimit)
+			if err != nil {
+				return err
+			}
+
+			feeLimit, err := sdk.ParseCoinsNormalized(coinStr)
+			if err != nil {
+				return err
+			}
+
+			signalIDs := strings.Split(args[0], ",")
+
+			feedsType, err := strconv.ParseInt(args[1], 10, 32)
+			if err != nil {
+				return err
+			}
+
+			from := clientCtx.GetFromAddress()
+			content := types.NewFeedSignatureOrder(signalIDs, types.FeedType(feedsType))
+
+			msg, err := bandtsstypes.NewMsgRequestSignature(content, feeLimit, from)
+			if err != nil {
+				return err
+			}
+
+			return tx.GenerateOrBroadcastTxCLI(clientCtx, cmd.Flags(), msg)
+		},
+	}
+}

x/feeds/client/signature_order_handler.go

@@ -0,0 +1,9 @@
+package client
+
+import (
+	bandtssclient "github.com/bandprotocol/chain/v2/x/bandtss/client"
+	"github.com/bandprotocol/chain/v2/x/feeds/client/cli"
+)
+
+// FeedsRequestSignatureHandler is the request signature handler.
+var FeedsRequestSignatureHandler = bandtssclient.NewRequestSignatureHandler(cli.GetCmdRequestSignature)

x/feeds/keeper/keeper_feeds_price_data.go

@@ -0,0 +1,51 @@
+package keeper
+
+import (
+	"fmt"
+	"time"
+
+	sdk "github.com/cosmos/cosmos-sdk/types"
+
+	"github.com/bandprotocol/chain/v2/x/feeds/types"
+)
+
+// GetFeedsPriceData returns the price data of the given signalIDs
+func (k Keeper) GetFeedsPriceData(
+	ctx sdk.Context,
+	signalIDs []string,
+	ft types.FeedType,
+) (*types.FeedsPriceData, error) {
+	var prices []types.SignalPrice
+	for _, signalID := range signalIDs {
+		// Get the price of the signal
+		p, err := k.GetPrice(ctx, signalID)
+		if err != nil {
+			return nil, err
+		}
+
+		// Check if the feed type is tick
+		if ft == types.FEED_TYPE_TICK {
+			err := p.ToTick()
+			if err != nil {
+				return nil, err
+			}
+		}
+
+		// Check if the price is available
+		if p.PriceStatus != types.PriceStatusAvailable {
+			return nil, fmt.Errorf("%s: price not available", signalID)
+		}
+
+		// Check if the price is too old
+		if ctx.BlockTime().Sub(time.Unix(p.Timestamp, 0)) > types.MAX_PRICE_TIME_DIFF {
+			return nil, fmt.Errorf("%s: price too old", signalID)
+		}
+
+		// Append the price to the list
+		prices = append(prices, types.SignalPrice{
+			SignalID: signalID,
+			Price:    p.Price,
+		})
+	}
+	return types.NewFeedsPriceData(prices, ctx.BlockTime().Unix()), nil
+}