feat: extend show to latest non claimable root (#229)

* feat: extend show to latest non claimable root

* update readme

* update readme

* addressed comments

Author: shrimalmadhur

pkg/rewards/README.md

@@ -121,7 +121,7 @@ eigenlayer rewards set-claimer \
 ```bash
 eigenlayer rewards show --help
 NAME:
-   eigenlayer rewards show - Show rewards for an address against the latest `active` `DistributionRoot` posted on-chain by the rewards updater.
+   eigenlayer rewards show - Show rewards for an address against the `DistributionRoot` posted on-chain by the rewards updater
 
 USAGE:
    show
@@ -130,10 +130,15 @@ DESCRIPTION:
 
    Command to show rewards for earners
 
-   Currently supports past total rewards (claimed and unclaimed) and past unclaimed rewards
+   Helpful flags
+   - claim-type: Type of rewards to show. Can be 'all', 'claimed' or 'unclaimed'
+   - claim-timestamp: Timestamp of the claim distribution root to use. Can be 'latest' or 'latest_active'.
+     - 'latest' will show rewards for the latest root (can contain non-claimable rewards)
+     - 'latest_active' will show rewards for the latest active root (only claimable rewards)
 
 
 OPTIONS:
+   --claim-timestamp value, -c value           Specify the timestamp. Only 'latest' and 'latest_active' are supported. 'latest' can be a from an inactive root which you can't claim yet. (default: "latest_active") [$CLAIM_TIMESTAMP]
    --claim-type value, --ct value              Type of claim you want to see. Can be 'all', 'unclaimed', or 'claimed' (default: "all") [$REWARDS_CLAIM_TYPE]
    --earner-address value, --ea value          Address of the earner [$REWARDS_EARNER_ADDRESS]
    --environment value, --env value            Environment to use. Currently supports 'preprod' ,'testnet' and 'prod'. If not provided, it will be inferred based on network [$ENVIRONMENT]

pkg/rewards/claim.go

@@ -32,7 +32,7 @@ import (
 	"github.com/ethereum/go-ethereum/ethclient"
 
 	"github.com/urfave/cli/v2"
-	"github.com/wk8/go-ordered-map/v2"
+	orderedmap "github.com/wk8/go-ordered-map/v2"
 )
 
 type elChainReader interface {
@@ -277,7 +277,7 @@ func getClaimDistributionRoot(
 	elReader elChainReader,
 	logger logging.Logger,
 ) (string, uint32, error) {
-	if claimTimestamp == "latest" {
+	if claimTimestamp == LatestTimestamp {
 		latestSubmittedTimestamp, err := elReader.CurrRewardsCalculationEndTimestamp(&bind.CallOpts{Context: ctx})
 		if err != nil {
 			return "", 0, eigenSdkUtils.WrapError("failed to get latest submitted timestamp", err)
@@ -292,12 +292,11 @@ func getClaimDistributionRoot(
 		rootIndex := uint32(rootCount.Uint64() - 1)
 		logger.Debugf("Latest active rewards snapshot timestamp: %s, root index: %d", claimDate, rootIndex)
 		return claimDate, rootIndex, nil
-	} else if claimTimestamp == "latest_active" {
+	} else if claimTimestamp == LatestActiveTimestamp {
 		latestClaimableRoot, err := elReader.GetCurrentClaimableDistributionRoot(&bind.CallOpts{Context: ctx})
 		if err != nil {
 			return "", 0, eigenSdkUtils.WrapError("failed to get latest claimable root", err)
 		}
-
 		rootIndex, err := elReader.GetRootIndexFromHash(&bind.CallOpts{Context: ctx}, latestClaimableRoot.Root)
 		if err != nil {
 			return "", 0, eigenSdkUtils.WrapError("failed to get root index from hash", err)

pkg/rewards/claim_test.go

@@ -24,7 +24,7 @@ import (
 
 	"github.com/stretchr/testify/assert"
 	"github.com/urfave/cli/v2"
-	"github.com/wk8/go-ordered-map/v2"
+	orderedmap "github.com/wk8/go-ordered-map/v2"
 )
 
 type fakeELReader struct {

pkg/rewards/flags.go

@@ -21,7 +21,7 @@ var (
 	ClaimTimestampFlag = cli.StringFlag{
 		Name:    "claim-timestamp",
 		Aliases: []string{"c"},
-		Usage:   "Specify the timestamp. Only 'latest' and 'latest_active' are supported. 'latest' can be an inactive root which you can't claim yet.",
+		Usage:   "Specify the timestamp. Only 'latest' and 'latest_active' are supported. 'latest' can be a from an inactive root which you can't claim yet.",
 		Value:   "latest_active",
 		EnvVars: []string{"CLAIM_TIMESTAMP"},
 	}

pkg/rewards/show.go

@@ -20,8 +20,8 @@ import (
 	"github.com/Layr-Labs/eigensdk-go/chainio/clients/elcontracts"
 	"github.com/Layr-Labs/eigensdk-go/logging"
 	eigenSdkUtils "github.com/Layr-Labs/eigensdk-go/utils"
-	"github.com/ethereum/go-ethereum/accounts/abi/bind"
 
+	"github.com/ethereum/go-ethereum/accounts/abi/bind"
 	gethcommon "github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/ethclient"
 
@@ -38,17 +38,24 @@ const (
 	All       ClaimType = "all"
 	Unclaimed ClaimType = "unclaimed"
 	Claimed   ClaimType = "claimed"
+
+	LatestTimestamp       = "latest"
+	LatestActiveTimestamp = "latest_active"
 )
 
 func ShowCmd(p utils.Prompter) *cli.Command {
 	showCmd := &cli.Command{
 		Name:      "show",
-		Usage:     "Show rewards for an address",
+		Usage:     "Show rewards for an address against the `DistributionRoot` posted on-chain by the rewards updater",
 		UsageText: "show",
 		Description: `
 Command to show rewards for earners
 
-Currently supports past total rewards (claimed and unclaimed) and past unclaimed rewards
+Helpful flags
+- claim-type: Type of rewards to show. Can be 'all', 'claimed' or 'unclaimed'
+- claim-timestamp: Timestamp of the claim distribution root to use. Can be 'latest' or 'latest_active'.
+	- 'latest' will show rewards for the latest root (can contain non-claimable rewards)
+	- 'latest_active' will show rewards for the latest active root (only claimable rewards)
 		`,
 		After: telemetry.AfterRunAction(),
 		Flags: getShowFlags(),
@@ -71,6 +78,7 @@ func getShowFlags() []cli.Flag {
 		&EnvironmentFlag,
 		&ClaimTypeFlag,
 		&ProofStoreBaseURLFlag,
+		&ClaimTimestampFlag,
 	}
 
 	sort.Sort(cli.FlagsByName(baseFlags))
@@ -109,7 +117,7 @@ func ShowRewards(cCtx *cli.Context) error {
 		http.DefaultClient,
 	)
 
-	claimDate, _, err := getClaimDistributionRoot(ctx, "latest_active", elReader, logger)
+	claimDate, _, err := getClaimDistributionRoot(ctx, config.ClaimTimestamp, elReader, logger)
 	if err != nil {
 		return eigenSdkUtils.WrapError("failed to get claim distribution root", err)
 	}
@@ -125,7 +133,7 @@ func ShowRewards(cCtx *cli.Context) error {
 	}
 
 	allRewards := make(map[gethcommon.Address]*big.Int)
-	msg := "All Rewards"
+	msg := "Lifetime Rewards"
 	for pair := tokenAddressesMap.Oldest(); pair != nil; pair = pair.Next() {
 		amt, _ := new(big.Int).SetString(pair.Value.String(), 10)
 		allRewards[pair.Key] = amt
@@ -145,7 +153,7 @@ func ShowRewards(cCtx *cli.Context) error {
 			msg = "Unclaimed Rewards"
 		}
 	}
-	err = handleRewardsOutput(config.Output, config.OutputType, allRewards, msg)
+	err = handleRewardsOutput(config, allRewards, msg)
 	if err != nil {
 		return err
 	}
@@ -185,13 +193,11 @@ func calculateUnclaimedRewards(
 }
 
 func handleRewardsOutput(
-	outputFile string,
-	outputType string,
+	cfg *ShowConfig,
 	rewards map[gethcommon.Address]*big.Int,
 	msg string,
 ) error {
-	fmt.Println(strings.Repeat("-", 30), msg, strings.Repeat("-", 30))
-	if outputType == "json" {
+	if cfg.OutputType == "json" {
 		allRewards := make(allRewardsJson, 0)
 		for address, amount := range rewards {
 			allRewards = append(allRewards, rewardsJson{
@@ -203,12 +209,20 @@ func handleRewardsOutput(
 		if err != nil {
 			return err
 		}
-		if outputFile != "" {
-			return common.WriteToFile(out, outputFile)
+		if cfg.Output != "" {
+			return common.WriteToFile(out, cfg.Output)
 		} else {
 			fmt.Println(string(out))
 		}
 	} else {
+		fmt.Println()
+		if cfg.ClaimTimestamp == LatestTimestamp {
+			fmt.Println("> Showing rewards for latest root (can contain non-claimable rewards)")
+		} else {
+			fmt.Println("> Showing rewards for latest active root (only claimable rewards)")
+		}
+		fmt.Println()
+		fmt.Println(strings.Repeat("-", 30), msg, strings.Repeat("-", 30))
 		printRewards(rewards)
 	}
 	return nil
@@ -295,6 +309,12 @@ func readAndValidateConfig(cCtx *cli.Context, logger logging.Logger) (*ShowConfi
 		return nil, errors.New("claim type must be 'all', 'unclaimed' or 'claimed'")
 	}
 	logger.Debugf("Claim Type: %s", claimType)
+
+	claimTimestamp := cCtx.String(ClaimTimestampFlag.Name)
+	if claimTimestamp != LatestTimestamp && claimTimestamp != LatestActiveTimestamp {
+		return nil, errors.New("claim timestamp must be 'latest' or 'latest_active'")
+	}
+
 	chainID := utils.NetworkNameToChainId(network)
 	logger.Debugf("Using chain ID: %s", chainID.String())
 
@@ -313,6 +333,7 @@ func readAndValidateConfig(cCtx *cli.Context, logger logging.Logger) (*ShowConfi
 		OutputType:                outputType,
 		RPCUrl:                    ethRpcUrl,
 		ProofStoreBaseURL:         proofStoreBaseURL,
+		ClaimTimestamp:            claimTimestamp,
 		RewardsCoordinatorAddress: gethcommon.HexToAddress(rewardsCoordinatorAddress),
 	}, nil
 }

pkg/rewards/types.go

@@ -57,5 +57,6 @@ type ShowConfig struct {
 	Output                    string
 	OutputType                string
 	ProofStoreBaseURL         string
+	ClaimTimestamp            string
 	RewardsCoordinatorAddress gethcommon.Address
 }