feat(dumpblocks): add --only-tx-hashes flag to return only tx hashes when dumping blocks (#730)

* dumpblocks: add --only-tx-hashes flag to return only tx hashes when dumping blocks

* make gen-doc

Author: tclemos

cmd/dumpblocks/dumpblocks.go

@@ -32,6 +32,7 @@ type (
 		BatchSize          uint64
 		Threads            uint
 		ShouldDumpBlocks   bool
+		OnlyTxHashes       bool
 		ShouldDumpReceipts bool
 		Filename           string
 		Mode               string
@@ -87,7 +88,7 @@ var DumpblocksCmd = &cobra.Command{
 				defer wg.Done()
 				for {
 					failCount := 0
-					blocks, err := util.GetBlockRange(ctx, rangeStart, rangeEnd, ec)
+					blocks, err := util.GetBlockRange(ctx, rangeStart, rangeEnd, ec, inputDumpblocks.OnlyTxHashes)
 					if err != nil {
 						failCount = failCount + 1
 						if failCount > 5 {
@@ -146,6 +147,7 @@ func init() {
 	f.StringVarP(&inputDumpblocks.RpcUrl, "rpc-url", "r", "http://localhost:8545", "the RPC endpoint URL")
 	f.UintVarP(&inputDumpblocks.Threads, "concurrency", "c", 1, "how many go routines to leverage")
 	f.BoolVarP(&inputDumpblocks.ShouldDumpBlocks, "dump-blocks", "B", true, "dump blocks to output")
+	f.BoolVar(&inputDumpblocks.OnlyTxHashes, "only-tx-hashes", false, "dump blocks will output only the tx hashes instead of the full tx body")
 	f.BoolVar(&inputDumpblocks.ShouldDumpReceipts, "dump-receipts", true, "dump receipts to output")
 	f.StringVarP(&inputDumpblocks.Filename, "filename", "f", "", "where to write the output to (default stdout)")
 	f.StringVarP(&inputDumpblocks.Mode, "mode", "m", "json", "the output format [json, proto]")

cmd/loadtest/output.go

@@ -320,7 +320,7 @@ func summarizeTransactions(ctx context.Context, c *ethclient.Client, rpc *ethrpc
 	if err != nil {
 		return err
 	}
-	rawBlocks, err := util.GetBlockRange(ctx, startBlockNumber, lastBlockNumber, rpc)
+	rawBlocks, err := util.GetBlockRange(ctx, startBlockNumber, lastBlockNumber, rpc, false)
 	if err != nil {
 		return err
 	}

cmd/loadtest/recall.go

@@ -3,17 +3,18 @@ package loadtest
 import (
 	"context"
 	"encoding/json"
+	"math/big"
+	"strings"
+
 	"github.com/0xPolygon/polygon-cli/rpctypes"
 	"github.com/0xPolygon/polygon-cli/util"
 	ethtypes "github.com/ethereum/go-ethereum/core/types"
 	"github.com/ethereum/go-ethereum/ethclient"
 	ethrpc "github.com/ethereum/go-ethereum/rpc"
-	"math/big"
-	"strings"
 )
 
 // TODO allow this to be pre-specified with an input file
-func getRecentBlocks(ctx context.Context, ec *ethclient.Client, c *ethrpc.Client) ([]*json.RawMessage, error) {
+func getRecentBlocks(ctx context.Context, ec *ethclient.Client, c *ethrpc.Client, onlyTxHashes bool) ([]*json.RawMessage, error) {
 	bn, err := ec.BlockNumber(ctx)
 	if err != nil {
 		return nil, err
@@ -22,12 +23,12 @@ func getRecentBlocks(ctx context.Context, ec *ethclient.Client, c *ethrpc.Client
 	// FIXME the batch size of 25 is hard coded and probably should at least be a constant or a parameter. This limit is
 	// different than the actual json RPC batch size of 999. Because we're fetching blocks, its' more likely that we hit
 	// a response size limit rather than a batch length limit
-	rawBlocks, err := util.GetBlockRangeInPages(ctx, bn-inputLoadTestParams.RecallLength, bn, 25, c)
+	rawBlocks, err := util.GetBlockRangeInPages(ctx, bn-inputLoadTestParams.RecallLength, bn, 25, c, onlyTxHashes)
 	return rawBlocks, err
 }
 
 func getRecallTransactions(ctx context.Context, c *ethclient.Client, rpc *ethrpc.Client) ([]rpctypes.PolyTransaction, error) {
-	rb, err := getRecentBlocks(ctx, c, rpc)
+	rb, err := getRecentBlocks(ctx, c, rpc, false)
 	if err != nil {
 		return nil, err
 	}
@@ -60,7 +61,7 @@ type IndexedActivity struct {
 }
 
 func getIndexedRecentActivity(ctx context.Context, ec *ethclient.Client, c *ethrpc.Client) (*IndexedActivity, error) {
-	blockData, err := getRecentBlocks(ctx, ec, c)
+	blockData, err := getRecentBlocks(ctx, ec, c, false)
 	if err != nil {
 		return nil, err
 	}

doc/polycli_dumpblocks.md

@@ -82,6 +82,7 @@ To solve this, add the unknown fields to the `.proto` files and recompile them (
   -F, --filter string      filter output based on tx to and from (not setting a filter means all are allowed) (default "{}")
   -h, --help               help for dumpblocks
   -m, --mode string        the output format [json, proto] (default "json")
+      --only-tx-hashes     dump blocks will output only the tx hashes instead of the full tx body
   -r, --rpc-url string     the RPC endpoint URL (default "http://localhost:8545")
 ```
 

util/util.go

@@ -60,14 +60,14 @@ func EcrecoverTx(tx *types.Transaction) ([]byte, error) {
 	return from.Bytes(), nil
 }
 
-func GetBlockRange(ctx context.Context, from, to uint64, c *ethrpc.Client) ([]*json.RawMessage, error) {
+func GetBlockRange(ctx context.Context, from, to uint64, c *ethrpc.Client, onlyTxHashes bool) ([]*json.RawMessage, error) {
 	blms := make([]ethrpc.BatchElem, 0)
 	for i := from; i <= to; i = i + 1 {
 		r := new(json.RawMessage)
 		var err error
 		blms = append(blms, ethrpc.BatchElem{
 			Method: "eth_getBlockByNumber",
-			Args:   []interface{}{"0x" + strconv.FormatUint(i, 16), true},
+			Args:   []interface{}{"0x" + strconv.FormatUint(i, 16), !onlyTxHashes},
 			Result: r,
 			Error:  err,
 		})
@@ -92,7 +92,7 @@ func GetBlockRange(ctx context.Context, from, to uint64, c *ethrpc.Client) ([]*j
 	return blocks, nil
 }
 
-func GetBlockRangeInPages(ctx context.Context, from, to, pageSize uint64, c *ethrpc.Client) ([]*json.RawMessage, error) {
+func GetBlockRangeInPages(ctx context.Context, from, to, pageSize uint64, c *ethrpc.Client, onlyTxHashes bool) ([]*json.RawMessage, error) {
 	var allBlocks []*json.RawMessage
 
 	for i := from; i <= to; i += pageSize {
@@ -101,7 +101,7 @@ func GetBlockRangeInPages(ctx context.Context, from, to, pageSize uint64, c *eth
 			end = to
 		}
 
-		blocks, err := GetBlockRange(ctx, i, end, c)
+		blocks, err := GetBlockRange(ctx, i, end, c, onlyTxHashes)
 		if err != nil {
 			return nil, err
 		}