scripts: add script for gasConsumed comparison

Signed-off-by: Tural Devrishev <tural@nspcc.ru>

Author: Tural Devrishev

scripts/compare-gasconsumed/compare-gasconsumed.go

@@ -0,0 +1,143 @@
+package main
+
+import (
+	"context"
+	"errors"
+	"fmt"
+	"os"
+
+	"github.com/davecgh/go-spew/spew"
+	"github.com/nspcc-dev/neo-go/pkg/rpcclient"
+	"github.com/nspcc-dev/neo-go/pkg/util"
+	"github.com/pmezard/go-difflib/difflib"
+	"github.com/urfave/cli/v2"
+)
+
+func initClient(addr string, name string) (*rpcclient.Client, uint32, error) {
+	c, err := rpcclient.New(context.Background(), addr, rpcclient.Options{})
+	if err != nil {
+		return nil, 0, fmt.Errorf("RPC %s: %w", name, err)
+	}
+	if err = c.Init(); err != nil {
+		return nil, 0, fmt.Errorf("RPC %s init: %w", name, err)
+	}
+	h, err := c.GetBlockCount()
+	if err != nil {
+		return nil, 0, fmt.Errorf("RPC %s block count: %w", name, err)
+	}
+	return c, h, nil
+}
+
+func compareNetworkMagic(ca, cb *rpcclient.Client) error {
+	va, err := ca.GetVersion()
+	if err != nil {
+		return fmt.Errorf("failed to get version from A: %w", err)
+	}
+	vb, err := cb.GetVersion()
+	if err != nil {
+		return fmt.Errorf("failed to get version from B: %w", err)
+	}
+	if va.Protocol.Network != vb.Protocol.Network {
+		return fmt.Errorf("different network magic: A=%s (0x%X), B=%s (0x%X)", va.Protocol.Network, uint32(va.Protocol.Network), vb.Protocol.Network, uint32(vb.Protocol.Network))
+	}
+	return nil
+}
+
+func dumpApplogDiff(tx util.Uint256, a string, b string, ca *rpcclient.Client, cb *rpcclient.Client) error {
+	la, err := ca.GetApplicationLog(tx, nil)
+	if err != nil {
+		return fmt.Errorf("can't get applog for tx %s from A: %w", tx.StringLE(), err)
+	}
+	lb, err := cb.GetApplicationLog(tx, nil)
+	if err != nil {
+		return fmt.Errorf("can't get applog for tx %s from B: %w", tx.StringLE(), err)
+	}
+	da := spew.Sdump(la)
+	db := spew.Sdump(lb)
+	diff, _ := difflib.GetUnifiedDiffString(difflib.UnifiedDiff{
+		A:        difflib.SplitLines(da),
+		B:        difflib.SplitLines(db),
+		FromFile: a,
+		ToFile:   b,
+		Context:  3,
+	})
+	fmt.Println(diff)
+	return nil
+}
+
+func cliMain(c *cli.Context) error {
+	a := c.Args().Get(0)
+	b := c.Args().Get(1)
+	if a == "" || b == "" {
+		return errors.New("usage: compare-gasconsumed RPC_A RPC_B [START_BLOCK_INDEX] [END_BLOCK_INDEX]")
+	}
+
+	ca, ha, err := initClient(a, "A")
+	if err != nil {
+		return err
+	}
+	cb, hb, err := initClient(b, "B")
+	if err != nil {
+		return err
+	}
+
+	if err := compareNetworkMagic(ca, cb); err != nil {
+		return err
+	}
+
+	var start uint32
+	_, err = fmt.Sscan(c.Args().Get(2), &start)
+	if err != nil {
+		return fmt.Errorf("invalid start block index: %w", err)
+	}
+
+	var end uint32
+	_, err = fmt.Sscan(c.Args().Get(3), &end)
+	if err != nil {
+		return fmt.Errorf("invalid end block index: %w", err)
+	}
+
+	if end >= ha || end >= hb {
+		return fmt.Errorf("end %d is beyond available blocks: A has %d, B has %d", end, ha, hb)
+	}
+
+	for i := start; i <= end; i++ {
+		blk, err := ca.GetBlockByIndex(i)
+		if err != nil {
+			return fmt.Errorf("can't get block %d from A: %w", i, err)
+		}
+		for _, tx := range blk.Transactions {
+			la, err := ca.GetApplicationLog(tx.Hash(), nil)
+			if err != nil {
+				return fmt.Errorf("can't get applog for tx %s from A: %w", tx.Hash().StringLE(), err)
+			}
+			lb, err := cb.GetApplicationLog(tx.Hash(), nil)
+			if err != nil {
+				return fmt.Errorf("can't get applog for tx %s from B: %w", tx.Hash().StringLE(), err)
+			}
+			ga := la.Executions[0].GasConsumed
+			gb := lb.Executions[0].GasConsumed
+			if ga != gb {
+				fmt.Printf("mismatch at block %d, tx %s: gasConsumed A=%d B=%d\n", i, tx.Hash().StringLE(), ga, gb)
+				if err := dumpApplogDiff(tx.Hash(), a, b, ca, cb); err != nil {
+					return err
+				}
+				return errors.New("gas mismatch found")
+			}
+		}
+	}
+	return nil
+}
+
+func main() {
+	ctl := cli.NewApp()
+	ctl.Name = "compare-gasconsumed"
+	ctl.Version = "1.0"
+	ctl.Usage = "compare-gasconsumed RPC_A RPC_B [START_BLOCK_INDEX] [END_BLOCK_INDEX]"
+	ctl.Action = cliMain
+	if err := ctl.Run(os.Args); err != nil {
+		fmt.Fprintln(os.Stderr, err)
+		os.Exit(1)
+	}
+	fmt.Println("compare-gasconsumed: all checks passed")
+}