[Feeds] Fix feeds issues (#149)

* add max signal id characters

* deactivate using block height

* calculate supported feeds every n blocks

* change default block update param

* using type Signal for signal-total-power

* add check err in init genesis

* fix test

* handle error in test

* delete power from feed, fix key, fix GetAllSignalTotalPowers bug

* not delete signalTotalPower when power is 0, remove signalTotalPower from genesis

* fix test

* fix test

* fix test

* fix command

* implement emit event for signal-total-power and supported-feeds

---------

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

Author: colmazia

grogu/feed/check.go

@@ -97,7 +97,7 @@ func fetchData(
 	if err != nil {
 		return types.Params{}, nil, nil, nil, err
 	}
-	feeds = feedsResponse.Feeds
+	feeds = feedsResponse.SupportedFeeds.Feeds
 
 	// Fetch validator prices
 	validatorPricesResponse, err := c.QueryClient.ValidatorPrices(

proto/feeds/v1beta1/feeds.proto

@@ -19,6 +19,8 @@ message Signal {
 
 // DelegatorSignals is the data structure that contains array of signals of a delegator.
 message DelegatorSignals {
+  option (gogoproto.equal) = true;
+
   // Delegator is the address of the delegator of this signals.
   string delegator = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
 
@@ -33,17 +35,25 @@ message Feed {
   // SignalID is the unique string that identifies the unit of feed.
   string signal_id = 1 [(gogoproto.customname) = "SignalID"];
 
-  // Power is the power of the corresponding feed.
-  int64 power = 2;
-
   // Interval is the interval of the price feed.
-  int64 interval = 3;
-
-  // LastIntervalUpdateTimestamp is the timestamp of the last time interval is updated.
-  int64 last_interval_update_timestamp = 4;
+  int64 interval = 2;
 
   // DeviationInThousandth is the maximum deviation value the feed can tolerate, expressed in thousandths.
-  int64 deviation_in_thousandth = 5;
+  int64 deviation_in_thousandth = 3;
+}
+
+// SupportedFeeds is a structure that holds a list of currently supported feeds, and its last update time and block.
+message SupportedFeeds {
+  option (gogoproto.equal) = true;
+
+  // Feed is a list of currently suppored feeds.
+  repeated Feed feeds = 1 [(gogoproto.nullable) = false];
+
+  // LastUpdateTimestamp is the timestamp of the last time supported feeds list is updated.
+  int64 last_update_timestamp = 2;
+
+  // LastUpdateBlock is the number of blocks of the last time supported feeds list is updated.
+  int64 last_update_block = 3;
 }
 
 // PriceStatus is a structure that defines the price status of a price.
@@ -112,6 +122,9 @@ message ValidatorPrice {
 
   // Timestamp is the timestamp at which the price was submitted.
   int64 timestamp = 5;
+
+  // BlockHeight is the block height at which the price was submitted.
+  int64 block_height = 6;
 }
 
 // PriceService is a structure that defines the information of price service.

proto/feeds/v1beta1/genesis.proto

@@ -12,12 +12,9 @@ message GenesisState {
   // Params is all parameters of the module.
   Params params = 1 [(gogoproto.nullable) = false];
 
-  // Feeds is a list of feeds that requires validators to submit the price.
-  repeated Feed feeds = 2 [(gogoproto.nullable) = false];
+  // DelegatorSignals is a list of delegator signals submitted by delegators.
+  repeated DelegatorSignals delegator_signals = 2 [(gogoproto.nullable) = false];
 
   // PriceService is the information about price service.
   PriceService price_service = 3 [(gogoproto.nullable) = false];
-
-  // DelegatorSignals is a list of delegator signals submitted by delegators.
-  repeated DelegatorSignals delegator_signals = 4 [(gogoproto.nullable) = false];
 }

proto/feeds/v1beta1/params.proto

@@ -43,4 +43,10 @@ message Params {
 
   // MaxDeviationInThousandth is the maximum limit of every feeds' deviation (in thousandth).
   int64 max_deviation_in_thousandth = 10;
+
+  // MaxSignalIDCharacters is the maximum limit of characters of a signal id.
+  uint64 max_signal_id_characters = 11 [(gogoproto.customname) = "MaxSignalIDCharacters"];
+
+  // BlocksPerFeedsUpdate is the number of blocks after which the feed interval and deviation will be recalculated
+  uint64 blocks_per_feeds_update = 12;
 }

proto/feeds/v1beta1/query.proto

@@ -37,9 +37,9 @@ service Query {
     option (google.api.http).get = "/feeds/v1beta1/validators/{validator}";
   }
 
-  // Feeds is a RPC method that returns all feeds.
-  rpc Feeds(QueryFeedsRequest) returns (QueryFeedsResponse) {
-    option (google.api.http).get = "/feeds/v1beta1/feeds";
+  // Signals is a RPC method that returns all signal-total-powers or specified signal-total-power by signal id.
+  rpc SignalTotalPowers(QuerySignalTotalPowersRequest) returns (QuerySignalTotalPowersResponse) {
+    option (google.api.http).get = "/feeds/v1beta1/signal-total-powers";
   }
 
   // Params is a RPC method that returns all parameters of the module.
@@ -91,9 +91,6 @@ message QueryPriceRequest {
 message QueryPriceResponse {
   // Price is the aggregated price of the signal id.
   Price price = 1 [(gogoproto.nullable) = false];
-
-  // ValidatorPrices is a list of prices from each validator.
-  repeated ValidatorPrice validator_prices = 2 [(gogoproto.nullable) = false];
 }
 
 // QueryValidatorPricesRequest is the request type for the Query/ValidatorPrices RPC method.
@@ -135,19 +132,19 @@ message QueryValidValidatorResponse {
   bool valid = 1;
 }
 
-// QueryFeedsRequest is the request type for the Query/Feeds RPC method.
-message QueryFeedsRequest {
+// QuerySignalTotalPowersRequest is the request type for the Query/SignalTotalPowers RPC method.
+message QuerySignalTotalPowersRequest {
   // SignalIDs is a list of signal ids to query.
   repeated string signal_ids = 1;
 
   // Pagination is the pagination for the request.
   cosmos.base.query.v1beta1.PageRequest pagination = 2;
 }
 
-// QueryFeedsResponse is the response type for the Query/Feeds RPC method.
-message QueryFeedsResponse {
-  // Feeds is a list of feeds.
-  repeated Feed feeds = 1;
+// QuerySignalTotalPowersResponse is the response type for the Query/SignalTotalPowers RPC method.
+message QuerySignalTotalPowersResponse {
+  // SingalTotalPowers is a list of signal-total-powers.
+  repeated Signal signal_total_powers = 1;
 
   // Pagination is the pagination information in the response.
   cosmos.base.query.v1beta1.PageResponse pagination = 2;
@@ -187,6 +184,6 @@ message QuerySupportedFeedsRequest {}
 
 // QuerySupportedFeedsResponse is the response type for the Query/SupportedFeeds RPC method
 message QuerySupportedFeedsResponse {
-  // Feeds is a list of feeds.
-  repeated Feed feeds = 1 [(gogoproto.nullable) = false];
+  // SupportedFeeds is a list of currently supported feeds, and its last update time and block.
+  SupportedFeeds supported_feeds = 1 [(gogoproto.nullable) = false];
 }

x/feeds/abci.go

@@ -9,4 +9,8 @@ import (
 // HandleEndBlock is a handler function for the EndBlock ABCI request.
 func HandleEndBlock(ctx sdk.Context, k keeper.Keeper) {
 	k.CalculatePrices(ctx)
+	if ctx.BlockHeight()%int64(k.GetParams(ctx).BlocksPerFeedsUpdate) == 0 {
+		feeds := k.CalculateNewSupportedFeeds(ctx)
+		k.SetSupportedFeeds(ctx, feeds)
+	}
 }

x/feeds/client/cli/query.go

@@ -26,7 +26,7 @@ func GetQueryCmd() *cobra.Command {
 		GetQueryCmdPrice(),
 		GetQueryCmdValidatorPrices(),
 		GetQueryCmdValidatorPrice(),
-		GetQueryCmdFeeds(),
+		GetQueryCmdSignalTotalPowers(),
 		GetQueryCmdParams(),
 		GetQueryCmdDelegatorSignal(),
 		GetQueryCmdSupportedFeeds(),
@@ -195,11 +195,11 @@ func GetQueryCmdValidatorPrice() *cobra.Command {
 	return cmd
 }
 
-// GetQueryCmdFeeds implements the query feeds command.
-func GetQueryCmdFeeds() *cobra.Command {
+// GetQueryCmdSignalTotalPowers implements the query signal-total-powers command.
+func GetQueryCmdSignalTotalPowers() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:   "feeds",
-		Short: "Shows all information of all feeds",
+		Use:   "signal-total-powers",
+		Short: "Shows all information of all signals and its total power",
 		Args:  cobra.NoArgs,
 		RunE: func(cmd *cobra.Command, args []string) error {
 			clientCtx := client.GetClientContextFromCmd(cmd)
@@ -210,7 +210,10 @@ func GetQueryCmdFeeds() *cobra.Command {
 				return err
 			}
 
-			res, err := queryClient.Feeds(context.Background(), &types.QueryFeedsRequest{Pagination: pageReq})
+			res, err := queryClient.SignalTotalPowers(
+				context.Background(),
+				&types.QuerySignalTotalPowersRequest{Pagination: pageReq},
+			)
 			if err != nil {
 				return err
 			}
@@ -219,7 +222,7 @@ func GetQueryCmdFeeds() *cobra.Command {
 		},
 	}
 
-	flags.AddPaginationFlagsToCmd(cmd, "feeds")
+	flags.AddPaginationFlagsToCmd(cmd, "signal-total-powers")
 	flags.AddQueryFlagsToCmd(cmd)
 
 	return cmd

x/feeds/keeper/calculate.go

@@ -5,7 +5,7 @@ import (
 )
 
 // calculateIntervalAndDeviation calculates feed interval and deviation from power
-func calculateIntervalAndDeviation(power int64, param types.Params) (interval int64, deviation int64) {
+func CalculateIntervalAndDeviation(power int64, param types.Params) (interval int64, deviation int64) {
 	if power < param.PowerThreshold {
 		return 0, 0
 	}

x/feeds/keeper/calculate_test.go

@@ -9,7 +9,7 @@ import (
 )
 
 func TestCalculateIntervalAndDeviation(t *testing.T) {
-	params := types.NewParams("[NOT_SET]", 30, 30, 60, 3600, 1000_000_000, 100, 30, 5, 300)
+	params := types.NewParams("[NOT_SET]", 30, 30, 60, 3600, 1000_000_000, 100, 30, 5, 300, 256, 28800)
 
 	testCases := []struct {
 		name         string
@@ -46,7 +46,7 @@ func TestCalculateIntervalAndDeviation(t *testing.T) {
 	for _, tc := range testCases {
 		tc := tc
 		t.Run(tc.name, func(tt *testing.T) {
-			interval, deviation := calculateIntervalAndDeviation(tc.power, params)
+			interval, deviation := CalculateIntervalAndDeviation(tc.power, params)
 			require.Equal(tt, tc.expInterval, interval)
 			require.Equal(tt, tc.expDeviation, deviation)
 		})

x/feeds/keeper/emit.go

@@ -8,41 +8,25 @@ import (
 	"github.com/bandprotocol/chain/v2/x/feeds/types"
 )
 
-func emitEventUpdateFeed(ctx sdk.Context, feed types.Feed) {
+func emitEventUpdateSignalTotalPower(ctx sdk.Context, signal types.Signal) {
 	ctx.EventManager().EmitEvent(
 		sdk.NewEvent(
-			types.EventTypeUpdateFeed,
-			sdk.NewAttribute(types.AttributeKeySignalID, feed.SignalID),
-			sdk.NewAttribute(types.AttributeKeyPower, fmt.Sprintf("%d", feed.Power)),
-			sdk.NewAttribute(types.AttributeKeyInterval, fmt.Sprintf("%d", feed.Interval)),
-			sdk.NewAttribute(
-				types.AttributeKeyLastIntervalUpdateTimestamp,
-				fmt.Sprintf("%d", feed.LastIntervalUpdateTimestamp),
-			),
-			sdk.NewAttribute(
-				types.AttributeKeyDeviationInThousandth,
-				fmt.Sprintf("%d", feed.DeviationInThousandth),
-			),
+			types.EventTypeUpdateSignalTotalPower,
+			sdk.NewAttribute(types.AttributeKeySignalID, signal.ID),
+			sdk.NewAttribute(types.AttributeKeyPower, fmt.Sprintf("%d", signal.Power)),
 		),
 	)
 }
 
-func emitEventDeleteFeed(ctx sdk.Context, feed types.Feed) {
+func emitEventUpdateSupportedFeeds(ctx sdk.Context, supportedFeeds types.SupportedFeeds) {
 	ctx.EventManager().EmitEvent(
 		sdk.NewEvent(
-			types.EventTypeDeleteFeed,
-			sdk.NewAttribute(types.AttributeKeySignalID, feed.SignalID),
-			sdk.NewAttribute(types.AttributeKeyPower, fmt.Sprintf("%d", feed.Power)),
-			sdk.NewAttribute(types.AttributeKeyInterval, fmt.Sprintf("%d", feed.Interval)),
+			types.EventTypeUpdateSupportedFeeds,
 			sdk.NewAttribute(
-				types.AttributeKeyLastIntervalUpdateTimestamp,
-				fmt.Sprintf("%d", feed.LastIntervalUpdateTimestamp),
+				types.AttributeKeyLastUpdateTimestamp,
+				fmt.Sprintf("%d", supportedFeeds.LastUpdateTimestamp),
 			),
-			sdk.NewAttribute(
-				types.AttributeKeyDeviationInThousandth,
-				fmt.Sprintf("%d", feed.DeviationInThousandth),
-			),
-		),
+			sdk.NewAttribute(types.AttributeKeyLastUpdateBlock, fmt.Sprintf("%d", supportedFeeds.LastUpdateBlock))),
 	)
 }