change supported feeds to current feeds (#183)

Author: colmazia

benchmark/feeds_bench_test.go

@@ -76,7 +76,7 @@ func BenchmarkSubmitSignalPricesDeliver(b *testing.B) {
 				ba.TxConfig,
 				GenMsgSubmitSignalPrices(
 					val,
-					ba.FeedsKeeper.GetSupportedFeeds(ba.Ctx).Feeds,
+					ba.FeedsKeeper.GetCurrentFeeds(ba.Ctx).Feeds,
 					ba.Ctx.BlockTime().Unix(),
 				),
 				val,
@@ -135,7 +135,7 @@ func BenchmarkFeedsEndBlock(b *testing.B) {
 }
 
 func setupFeeds(ba *BenchmarkApp) error {
-	numFeeds := ba.FeedsKeeper.GetParams(ba.Ctx).MaxSupportedFeeds
+	numFeeds := ba.FeedsKeeper.GetParams(ba.Ctx).MaxCurrentFeeds
 
 	ba.CallBeginBlock()
 
@@ -146,7 +146,7 @@ func setupFeeds(ba *BenchmarkApp) error {
 			Interval: 60,
 		})
 	}
-	ba.FeedsKeeper.SetSupportedFeeds(ba.Ctx, feeds)
+	ba.FeedsKeeper.SetCurrentFeeds(ba.Ctx, feeds)
 
 	ba.CallEndBlock()
 	ba.Commit()
@@ -155,7 +155,7 @@ func setupFeeds(ba *BenchmarkApp) error {
 }
 
 func setupValidatorPriceList(ba *BenchmarkApp, vals []*Account) error {
-	sfs := ba.FeedsKeeper.GetSupportedFeeds(ba.Ctx)
+	sfs := ba.FeedsKeeper.GetCurrentFeeds(ba.Ctx)
 
 	ba.CallBeginBlock()
 	for valIdx, val := range vals {
@@ -181,7 +181,7 @@ func setupValidatorPriceList(ba *BenchmarkApp, vals []*Account) error {
 }
 
 func setupValidatorPrices(ba *BenchmarkApp, vals []*Account) error {
-	sfs := ba.FeedsKeeper.GetSupportedFeeds(ba.Ctx)
+	sfs := ba.FeedsKeeper.GetCurrentFeeds(ba.Ctx)
 
 	ba.CallBeginBlock()
 	for valIdx, val := range vals {

grogu/querier/feed.go

@@ -79,16 +79,16 @@ func (q *FeedQuerier) QueryParams() (*feeds.QueryParamsResponse, error) {
 	return getMaxBlockHeightResponse(fs, &in)
 }
 
-func (q *FeedQuerier) QuerySupportedFeeds() (*feeds.QuerySupportedFeedsResponse, error) {
+func (q *FeedQuerier) QueryCurrentFeeds() (*feeds.QueryCurrentFeedsResponse, error) {
 	fs := make(
-		[]QueryFunction[feeds.QuerySupportedFeedsRequest, feeds.QuerySupportedFeedsResponse],
+		[]QueryFunction[feeds.QueryCurrentFeedsRequest, feeds.QueryCurrentFeedsResponse],
 		0,
 		len(q.queryClients),
 	)
 	for _, queryClient := range q.queryClients {
-		fs = append(fs, queryClient.SupportedFeeds)
+		fs = append(fs, queryClient.CurrentFeeds)
 	}
 
-	in := feeds.QuerySupportedFeedsRequest{}
+	in := feeds.QueryCurrentFeedsRequest{}
 	return getMaxBlockHeightResponse(fs, &in)
 }

grogu/signaller/signaller.go

@@ -129,13 +129,13 @@ func (h *Signaller) updateParams() bool {
 }
 
 func (h *Signaller) updateFeedMap() bool {
-	resp, err := h.feedQuerier.QuerySupportedFeeds()
+	resp, err := h.feedQuerier.QueryCurrentFeeds()
 	if err != nil {
 		h.logger.Error("[Signaller] failed to query supported feeds: %v", err)
 		return false
 	}
 
-	h.signalIDToFeed = sliceToMap(resp.SupportedFeeds.Feeds, func(feed types.FeedWithDeviation) string {
+	h.signalIDToFeed = sliceToMap(resp.CurrentFeeds.Feeds, func(feed types.FeedWithDeviation) string {
 		return feed.SignalID
 	})
 

proto/feeds/v1beta1/feeds.proto

@@ -59,8 +59,8 @@ message FeedWithDeviation {
   int64 deviation_basis_point = 4;
 }
 
-// SupportedFeeds is a structure that holds a list of currently supported feeds, and its last update time and block.
-message SupportedFeeds {
+// CurrentFeeds is a structure that holds a list of currently supported feeds, and its last update time and block.
+message CurrentFeeds {
   option (gogoproto.equal) = true;
 
   // Feeds is a list of currently suppored feeds.
@@ -73,9 +73,9 @@ message SupportedFeeds {
   int64 last_update_block = 3;
 }
 
-// SupportedFeedWithDeviations is a structure that holds a list of currently supported feed-with-deviations, and its
+// CurrentFeedWithDeviations is a structure that holds a list of currently supported feed-with-deviations, and its
 // last update time and block.
-message SupportedFeedWithDeviations {
+message CurrentFeedWithDeviations {
   option (gogoproto.equal) = true;
 
   // FeedWithDeviations is a list of currently suppored feed-with-deviations.

proto/feeds/v1beta1/params.proto

@@ -26,14 +26,14 @@ message Params {
   int64 min_interval = 4;
 
   // MaxInterval is the maximum limit of every feeds' interval (in seconds).
-  // If the calculated interval of a feed is higher than this, it will not be recognized as a supported feed.
+  // If the calculated interval of a feed is higher than this, it will not be capped at this value.
   int64 max_interval = 5;
 
-  // PowerStepThreshold is the amount of minimum power required to put feed in the supported list.
+  // PowerStepThreshold is the amount of minimum power required to put feed in the current feeds list.
   int64 power_step_threshold = 6;
 
-  // MaxSupportedFeeds is the maximum number of feeds supported at a time.
-  uint64 max_supported_feeds = 7;
+  // MaxCurrentFeeds is the maximum number of feeds supported at a time.
+  uint64 max_current_feeds = 7;
 
   // CooldownTime represents the duration (in seconds) during which validators are prohibited from sending new prices.
   int64 cooldown_time = 8;
@@ -44,6 +44,6 @@ message Params {
   // MaxDeviationBasisPoint is the maximum limit of every feeds' deviation (in basis point).
   int64 max_deviation_basis_point = 10;
 
-  // SupportedFeedsUpdateInterval is the number of blocks after which the supported feeds will be re-calculated.
-  int64 supported_feeds_update_interval = 11;
+  // CurrentFeedsUpdateInterval is the number of blocks after which the current feeds will be re-calculated.
+  int64 current_feeds_update_interval = 11;
 }

proto/feeds/v1beta1/query.proto

@@ -53,8 +53,8 @@ service Query {
     option (google.api.http).get = "/feeds/v1beta1/delegators/{delegator}/signals";
   }
 
-  // SupportedFeeds is an RPC method that returns a list of current supported feeds
-  rpc SupportedFeeds(QuerySupportedFeedsRequest) returns (QuerySupportedFeedsResponse) {
+  // CurrentFeeds is an RPC method that returns a list of current supported feeds
+  rpc CurrentFeeds(QueryCurrentFeedsRequest) returns (QueryCurrentFeedsResponse) {
     option (google.api.http).get = "/feeds/v1beta1/supported-feeds";
   }
 
@@ -169,14 +169,14 @@ message QueryDelegatorSignalsResponse {
   repeated Signal signals = 1 [(gogoproto.nullable) = false];
 }
 
-// QuerySupportedFeedsRequest is the request type for the Query/SupportedFeeds RPC method
-message QuerySupportedFeedsRequest {}
+// QueryCurrentFeedsRequest is the request type for the Query/CurrentFeeds RPC method
+message QueryCurrentFeedsRequest {}
 
-// QuerySupportedFeedsResponse is the response type for the Query/SupportedFeeds RPC method
-message QuerySupportedFeedsResponse {
-  // SupportedFeeds is a list of currently supported feed-with-deviations, and its last update time and
+// QueryCurrentFeedsResponse is the response type for the Query/CurrentFeeds RPC method
+message QueryCurrentFeedsResponse {
+  // CurrentFeeds is a list of currently supported feed-with-deviations, and its last update time and
   // block.
-  SupportedFeedWithDeviations supported_feeds = 1 [(gogoproto.nullable) = false];
+  CurrentFeedWithDeviations current_feeds = 1 [(gogoproto.nullable) = false];
 }
 
 // QueryIsFeederRequest is request type for the Query/IsFeeder RPC method.

scripts/generate_genesis.sh

@@ -43,4 +43,4 @@ sed -i -e \
 cat <<< $(jq '.app_state.gov.params.voting_period = "60s"' ~/.band/config/genesis.json) > ~/.band/config/genesis.json
 
 # update blocks per feeds update to 10 blocks for testing
-cat <<< $(jq '.app_state.feeds.params.supported_feeds_update_interval = "10"' ~/.band/config/genesis.json) > ~/.band/config/genesis.json
+cat <<< $(jq '.app_state.feeds.params.current_feeds_update_interval = "10"' ~/.band/config/genesis.json) > ~/.band/config/genesis.json

x/feeds/README.md

@@ -19,13 +19,13 @@ This module is used in the BandChain.
       - [Feed Interval](#feed-interval)
       - [Feed Deviation](#feed-deviation)
       - [How Feed Interval and Deviation are calculated](#how-feed-interval-and-deviation-are-calculated)
-      - [Supported Feeds](#supported-feeds)
+      - [Current Feeds](#current-feeds)
     - [Validator Price](#validator-price)
     - [Price](#price)
     - [Reference Source Config](#reference-source-config)
   - [State](#state)
     - [ReferenceSourceConfig](#referencesourceconfig)
-    - [SupportedFeeds](#supportedfeeds)
+    - [CurrentFeeds](#currentfeeds)
     - [ValidatorPriceList](#validatorpricelist)
     - [Price](#price-1)
     - [DelegatorSignal](#delegatorsignal)
@@ -43,7 +43,7 @@ This module is used in the BandChain.
       - [Objective](#objective)
       - [Assumption](#assumption)
       - [Procedure](#procedure)
-    - [Update supported feeds](#update-supported-feeds)
+    - [Update current feeds](#update-current-feeds)
   - [Events](#events)
     - [EndBlocker](#endblocker)
     - [Handlers](#handlers)
@@ -84,9 +84,9 @@ It should be noted that while feed deviation is calculated, it is only used as a
 
 You can visualize the interval/deviation as resembling the harmonic series times MaxInterval/MaxDeviationBasisPoint, with the step of PowerStepThreshold.
 
-#### Supported Feeds
+#### Current Feeds
 
-The list of currently supported feeds includes those with power exceeding the PowerStepThreshold parameter and ranking within the top `MaxSupportedFeeds`. The supported feeds will be re-calculated on every `SupportedFeedsUpdateInterval` block(s). Validators are only required to submit their prices for the supported feeds.
+The list of currently supported feeds includes those with power exceeding the PowerStepThreshold parameter and ranking within the top `MaxCurrentFeeds`. The current feeds will be re-calculated on every `CurrentFeedsUpdateInterval` block(s). Validators are only required to submit their prices for the current feeds.
 
 ### Validator Price
 
@@ -114,11 +114,11 @@ ReferenceSourceConfig is stored in the global store `0x00` to hold Reference Sou
 
 * ReferenceSourceConfig: `0x00 | []byte("ReferenceSourceConfig") -> ProtocolBuffer(ReferenceSourceConfig)`
 
-### SupportedFeeds
+### CurrentFeeds
 
-SupportedFeeds is stored in the global store `0x00` to hold the list of supported feeds.
+CurrentFeeds is stored in the global store `0x00` to hold the list of currently supported feeds.
 
-* SupportedFeeds: `0x00 | []byte("SupportedFeeds") -> ProtocolBuffer(SupportedFeeds)`
+* CurrentFeeds: `0x00 | []byte("CurrentFeeds") -> ProtocolBuffer(CurrentFeeds)`
 
 ### ValidatorPriceList
 
@@ -177,14 +177,14 @@ message Params {
   int64 min_interval = 4;
 
   // MaxInterval is the maximum limit of every feeds' interval (in seconds).
-  // If the calculated interval of a feed is higher than this, it will not be recognized as a supported feed.
+  // If the calculated interval of a feed is higher than this, it will not be capped at this value.
   int64 max_interval = 5;
 
-  // PowerStepThreshold is the amount of minimum power required to put feed in the supported list.
+  // PowerStepThreshold is the amount of minimum power required to put feed in the current feeds list.
   int64 power_step_threshold = 6;
 
-  // MaxSupportedFeeds is the maximum number of feeds supported at a time.
-  int64 max_supported_feeds = 7;
+  // MaxCurrentFeeds is the maximum number of feeds supported at a time.
+  uint64 max_current_feeds = 7;
 
   // CooldownTime represents the duration (in seconds) during which validators are prohibited from sending new prices.
   int64 cooldown_time = 8;
@@ -195,8 +195,8 @@ message Params {
   // MaxDeviationBasisPoint is the maximum limit of every feeds' deviation (in basis point).
   int64 max_deviation_basis_point = 10;
 
-  // SupportedFeedsUpdateInterval is the number of blocks after which the supported feeds will be re-calculated.
-  uint64 supported_feeds_update_interval = 11;
+  // CurrentFeedsUpdateInterval is the number of blocks after which the current feeds will be re-calculated.
+  int64 current_feeds_update_interval = 11;
 }
 ```
 
@@ -233,7 +233,7 @@ This message is expected to fail if:
 * validator's oracle status is not active.
 * timestamp is too different from block time.
 * the price is submitted in the `CooldownTime` param.
-* the signals of the prices are not in the supported feeds.
+* the signals of the prices are not in the current feeds.
 
 ### MsgUpdateReferenceSourceConfig
 
@@ -315,8 +315,8 @@ Each abci end block call, the operations to update prices.
 
 ### Update Prices
 
-At every end block, the Validator Price of all supported feeds will be obtained and checked if it is within the acceptance period (1 interval).
-Any validator that does not submit a price within this period is considered to have miss-reported and will be deactivated unless the Supported feeds are in a grace period.
+At every end block, the Validator Price of all current feeds will be obtained and checked if it is within the acceptance period (1 interval).
+Any validator that does not submit a price within this period is considered to have miss-reported and will be deactivated unless the current feeds are in a grace period.
 Accepted Validator Prices of the same SignalID will be weighted and median based on the recency of the price and the power of the validator who submitted the price.
 The median price is then set as the Price. Here is the price aggregation logic:
 
@@ -366,25 +366,25 @@ A list of PriceFeedInfo objects, each containing:
 - Compute the weighted median of the generated points to determine the final aggregated price.
 - The weighted median price is the price at which the cumulative power (sorted by increasing price) crosses half of the total weighted power.
 
-### Update supported feeds
+### Update current feeds
 
-At every `BlocksPerFeedsUpdate` block(s), the supported feeds will be re-calculated based on the parameters of the module (e.g. `MinInterval`, `MaxSupportedFeeds`). 
+At every `BlocksPerFeedsUpdate` block(s), the current feeds will be re-calculated based on the parameters of the module (e.g. `MinInterval`, `MaxCurrentFeeds`). 
 
 ## Events
 
 The feeds module emits the following events:
 
 ### EndBlocker
 
-| Type                    | Attribute Key         | Attribute Value |
-| ----------------------- | --------------------- | --------------- |
-| calculate_price_failed  | signal_id             | {signalID}      |
-| calculate_price_failed  | error_message         | {error}         |
-| update_price            | signal_id             | {signalID}      |
-| update_price            | price                 | {price}         |
-| update_price            | timestamp             | {timestamp}     |
-| updated_supported_feeds | last_update_timestamp | {timestamp}     |
-| updated_supported_feeds | last_update_block     | {block_height}  |
+| Type                   | Attribute Key         | Attribute Value |
+| ---------------------- | --------------------- | --------------- |
+| calculate_price_failed | signal_id             | {signalID}      |
+| calculate_price_failed | error_message         | {error}         |
+| update_price           | signal_id             | {signalID}      |
+| update_price           | price                 | {price}         |
+| update_price           | timestamp             | {timestamp}     |
+| updated_current_feeds  | last_update_timestamp | {timestamp}     |
+| updated_current_feeds  | last_update_block     | {block_height}  |
 
 ### Handlers
 

x/feeds/abci.go

@@ -9,8 +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()%k.GetParams(ctx).SupportedFeedsUpdateInterval == 0 {
-		feeds := k.CalculateNewSupportedFeeds(ctx)
-		k.SetSupportedFeeds(ctx, feeds)
+	if ctx.BlockHeight()%k.GetParams(ctx).CurrentFeedsUpdateInterval == 0 {
+		feeds := k.CalculateNewCurrentFeeds(ctx)
+		k.SetCurrentFeeds(ctx, feeds)
 	}
 }

x/feeds/client/cli/query.go

@@ -28,7 +28,7 @@ func GetQueryCmd() *cobra.Command {
 		GetQueryCmdSignalTotalPowers(),
 		GetQueryCmdParams(),
 		GetQueryCmdDelegatorSignal(),
-		GetQueryCmdSupportedFeeds(),
+		GetQueryCmdCurrentFeeds(),
 		GetQueryCmdIsFeeder(),
 	)
 
@@ -118,17 +118,17 @@ func GetQueryCmdPrice() *cobra.Command {
 	return cmd
 }
 
-// GetQueryCmdSupportedFeeds implements the query supported feeds command.
-func GetQueryCmdSupportedFeeds() *cobra.Command {
+// GetQueryCmdCurrentFeeds implements the query current feeds command.
+func GetQueryCmdCurrentFeeds() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:   "supported-feeds",
+		Use:   "current-feeds",
 		Short: "Shows all currently supported feeds",
 		Args:  cobra.NoArgs,
 		RunE: func(cmd *cobra.Command, args []string) error {
 			clientCtx := client.GetClientContextFromCmd(cmd)
 			queryClient := types.NewQueryClient(clientCtx)
 
-			res, err := queryClient.SupportedFeeds(context.Background(), &types.QuerySupportedFeedsRequest{})
+			res, err := queryClient.CurrentFeeds(context.Background(), &types.QueryCurrentFeedsRequest{})
 			if err != nil {
 				return err
 			}