Merge pull request #10474 from vegaprotocol/fix/10456

fix: expose proper value for graphql dispatch metrics

CHANGELOG.md

@@ -154,6 +154,7 @@
 - [10431](https://github.com/vegaprotocol/vega/issues/10431) - Fix source staleness validation.
 - [10419](https://github.com/vegaprotocol/vega/issues/10419) - Block explorer database migration is slow.
 - [10470](https://github.com/vegaprotocol/vega/issues/10470) - Mark non-optional parameters as required and update documentation strings.
+- [10456](https://github.com/vegaprotocol/vega/issues/10456) - Expose proper enum for `GraphQL` dispatch metric.
 
 ## 0.73.0
 

datanode/entities/enums.go

@@ -26,6 +26,38 @@ import (
 	"github.com/jackc/pgtype"
 )
 
+type DispatchMetric vega.DispatchMetric
+
+const (
+	DispatchMetricUnspecified       DispatchMetric = DispatchMetric(vega.DispatchMetric_DISPATCH_METRIC_UNSPECIFIED)
+	DispatchMetricMakerFeePaid                     = DispatchMetric(vega.DispatchMetric_DISPATCH_METRIC_MAKER_FEES_PAID)
+	DispatchMetricMakerFeesReceived                = DispatchMetric(vega.DispatchMetric_DISPATCH_METRIC_MAKER_FEES_RECEIVED)
+	DispatchMetricLPFeesReceived                   = DispatchMetric(vega.DispatchMetric_DISPATCH_METRIC_LP_FEES_RECEIVED)
+	DispatchMetricMarketValue                      = DispatchMetric(vega.DispatchMetric_DISPATCH_METRIC_MARKET_VALUE)
+	DispatchMetricAveragePosition                  = DispatchMetric(vega.DispatchMetric_DISPATCH_METRIC_AVERAGE_POSITION)
+	DispatchMetricRelativeReturn                   = DispatchMetric(vega.DispatchMetric_DISPATCH_METRIC_RELATIVE_RETURN)
+	DispatchMetricReturnVolatility                 = DispatchMetric(vega.DispatchMetric_DISPATCH_METRIC_RETURN_VOLATILITY)
+	DispatchMetricValidatorRanking                 = DispatchMetric(vega.DispatchMetric_DISPATCH_METRIC_VALIDATOR_RANKING)
+)
+
+func (m DispatchMetric) EncodeText(_ *pgtype.ConnInfo, buf []byte) ([]byte, error) {
+	mode, ok := vega.DispatchMetric_name[int32(m)]
+	if !ok {
+		return buf, fmt.Errorf("unknown dispatch metric: %s", mode)
+	}
+	return append(buf, []byte(mode)...), nil
+}
+
+func (m *DispatchMetric) DecodeText(_ *pgtype.ConnInfo, src []byte) error {
+	val, ok := vega.DispatchMetric_value[string(src)]
+	if !ok {
+		return fmt.Errorf("unknown dispatch metric: %s", src)
+	}
+
+	*m = DispatchMetric(val)
+	return nil
+}
+
 type Side = vega.Side
 
 const (

datanode/entities/game.go

@@ -21,6 +21,7 @@ import (
 
 	"code.vegaprotocol.io/vega/libs/num"
 	v2 "code.vegaprotocol.io/vega/protos/data-node/api/v2"
+	"code.vegaprotocol.io/vega/protos/vega"
 )
 
 type _Game struct{}
@@ -93,7 +94,7 @@ type TeamGameEntity struct {
 	Team               TeamGameParticipation
 	Rank               uint64
 	Volume             num.Decimal
-	RewardMetric       string
+	RewardMetric       vega.DispatchMetric
 	RewardEarned       *num.Uint
 	TotalRewardsEarned *num.Uint
 }
@@ -114,7 +115,7 @@ type IndividualGameEntity struct {
 	Individual         string
 	Rank               uint64
 	Volume             num.Decimal
-	RewardMetric       string
+	RewardMetric       vega.DispatchMetric
 	RewardEarned       *num.Uint
 	TotalRewardsEarned *num.Uint
 }

datanode/gateway/graphql/schema.graphql

@@ -7055,7 +7055,7 @@ type IndividualGameEntity {
   "The volume traded by the individual"
   volume: String!
   "The reward metric applied to the game"
-  rewardMetric: String!
+  rewardMetric: DispatchMetric!
   "The rewards earned by the individual during the epoch"
   rewardEarned: String!
   "Total rewards earned by the individual during the game"
@@ -7079,7 +7079,7 @@ type TeamGameEntity {
   "Total volume traded by the team"
   volume: String!
   "Reward metric applied to the game."
-  rewardMetric: String!
+  rewardMetric: DispatchMetric!
   "Total rewards earned by the team during the epoch"
   rewardEarned: String!
   "Total rewards earned by the team for the game"

datanode/sqlstore/games.go

@@ -246,7 +246,7 @@ func parseGameRewards(rewards []GameReward) ([]entities.Game, error) {
 			Individual:         rewards[i].PartyID.String(),
 			Rank:               uint64(rewards[i].MemberRank),
 			Volume:             num.DecimalZero(),
-			RewardMetric:       rewards[i].DispatchStrategy.Metric.String(),
+			RewardMetric:       rewards[i].DispatchStrategy.Metric,
 			RewardEarned:       rewardEarned,
 			TotalRewardsEarned: totalRewardsEarned,
 		}
@@ -291,9 +291,9 @@ func parseGameRewards(rewards []GameReward) ([]entities.Game, error) {
 				teamVolume := num.DecimalZero()
 				teamRewardEarned := num.NewUint(0)
 				teamTotalRewardsEarned := num.NewUint(0)
-				rewardMetric := ""
+				rewardMetric := vega.DispatchMetric_DISPATCH_METRIC_UNSPECIFIED
 				for _, individual := range individuals {
-					if rewardMetric == "" {
+					if rewardMetric == vega.DispatchMetric_DISPATCH_METRIC_UNSPECIFIED {
 						rewardMetric = individual.RewardMetric
 					}
 					teamVolume = teamVolume.Add(individual.Volume)

datanode/sqlstore/games_test.go

@@ -418,7 +418,7 @@ func setupGamesData(ctx context.Context, t *testing.T, stores gameStores, block
 							Individual:   member.ID.String(),
 							Rank:         0,
 							Volume:       num.DecimalZero(),
-							RewardMetric: "DISPATCH_METRIC_MAKER_FEES_PAID",
+							RewardMetric: vega.DispatchMetric_DISPATCH_METRIC_MAKER_FEES_PAID,
 							RewardEarned: rewardEarned,
 						}
 						teamRewards = teamRewards.Add(teamRewards, individualEntity.RewardEarned)
@@ -451,7 +451,7 @@ func setupGamesData(ctx context.Context, t *testing.T, stores gameStores, block
 						},
 						Rank:         0,
 						Volume:       teamVolume,
-						RewardMetric: "DISPATCH_METRIC_MAKER_FEES_PAID",
+						RewardMetric: vega.DispatchMetric_DISPATCH_METRIC_MAKER_FEES_PAID,
 						RewardEarned: teamRewards,
 					}
 					if teamTotalRewards[gk][team] == nil {
@@ -511,7 +511,7 @@ func setupGamesData(ctx context.Context, t *testing.T, stores gameStores, block
 						Individual:   individual.ID.String(),
 						Rank:         uint64(i + 1),
 						Volume:       num.DecimalZero(),
-						RewardMetric: "DISPATCH_METRIC_MAKER_FEES_PAID",
+						RewardMetric: vega.DispatchMetric_DISPATCH_METRIC_MAKER_FEES_PAID,
 						RewardEarned: rewardEarned,
 					}
 					individualEntities = append(individualEntities, &individualEntity)