Merge pull request #594 from 0xPolygon/feature/#593_readClaims

read claim events

Author: ARR552

cmd/ulxly/claimGetUsage.md

@@ -0,0 +1,42 @@
+This command will attempt to scan a range of blocks and look for uLxLy
+Claim Events. This is the specific signature that we're interested
+in:
+
+```solidity
+    /**
+     * @dev Emitted when a claim is done from another network
+     */
+    event ClaimEvent(
+        uint256 globalIndex,
+        uint32 originNetwork,
+        address originAddress,
+        address destinationAddress,
+        uint256 amount
+    );
+```
+
+If you're looking at the raw topics from on chain or in an explorer, this is the associated value:
+
+`0x1df3f2a973a00d6635911755c260704e95e8a5876997546798770f76396fda4d`
+
+Each event that we counter will be parsed and written as JSON to
+stdout. Example usage:
+
+```bash
+polycli ulxly get-claims \
+        --bridge-address 0x528e26b25a34a4A5d0dbDa1d57D318153d2ED582 \
+        --rpc-url https://eth-sepolia.g.alchemy.com/v2/demo \
+        --from-block 4880876 \
+        --to-block 6028159 \
+        --filter-size 9999 > cardona-4880876-to-6028159.ndjson
+```
+
+This command will look for claim events from block `4880876` to
+block `6028159` in increments of `9999` blocks at a time for the
+contract address `0x528e26b25a34a4A5d0dbDa1d57D318153d2ED582`. The
+output will be written as newline delimited JSON.
+
+This command is very specific for the ulxly bridge, and it's meant to
+serve as the input to the proof command.
+
+

cmd/ulxly/ulxly.go

@@ -11,6 +11,7 @@ import (
 	"errors"
 	"fmt"
 	"io"
+	"math"
 	"math/big"
 	"net/http"
 	"os"
@@ -108,11 +109,11 @@ type BridgeDepositResponse struct {
 }
 
 func readDeposit(cmd *cobra.Command) error {
-	bridgeAddress := getDepositOptions.BridgeAddress
-	rpcUrl := getDepositsAndVerifyBatchesSharedOptions.URL
-	toBlock := getDepositsAndVerifyBatchesSharedOptions.ToBlock
-	fromBlock := getDepositsAndVerifyBatchesSharedOptions.FromBlock
-	filter := getDepositsAndVerifyBatchesSharedOptions.FilterSize
+	bridgeAddress := getSmcOptions.BridgeAddress
+	rpcUrl := getEvent.URL
+	toBlock := getEvent.ToBlock
+	fromBlock := getEvent.FromBlock
+	filter := getEvent.FilterSize
 
 	// Dial the Ethereum RPC server.
 	rpc, err := ethrpc.DialContext(cmd.Context(), rpcUrl)
@@ -164,12 +165,96 @@ func readDeposit(cmd *cobra.Command) error {
 	return nil
 }
 
+func DecodeGlobalIndex(globalIndex *big.Int) (bool, uint32, uint32, error) {
+	const lengthGlobalIndexInBytes = 32
+	var buf [32]byte
+	gIBytes := globalIndex.FillBytes(buf[:])
+	if len(gIBytes) != lengthGlobalIndexInBytes {
+		return false, 0, 0, fmt.Errorf("invalid globaIndex length. Should be 32. Current length: %d", len(gIBytes))
+	}
+	mainnetFlag := big.NewInt(0).SetBytes([]byte{gIBytes[23]}).Uint64() == 1
+	rollupIndex := big.NewInt(0).SetBytes(gIBytes[24:28])
+	localRootIndex := big.NewInt(0).SetBytes(gIBytes[28:32])
+	if rollupIndex.Uint64() > math.MaxUint32 {
+		return false, 0, 0, fmt.Errorf("invalid rollupIndex length. Should be fit into uint32 type")
+	}
+	if localRootIndex.Uint64() > math.MaxUint32 {
+		return false, 0, 0, fmt.Errorf("invalid localRootIndex length. Should be fit into uint32 type")
+	}
+	return mainnetFlag, uint32(rollupIndex.Uint64()), uint32(localRootIndex.Uint64()), nil // nolint:gosec
+}
+
+func readClaim(cmd *cobra.Command) error {
+	bridgeAddress := getSmcOptions.BridgeAddress
+	rpcUrl := getEvent.URL
+	toBlock := getEvent.ToBlock
+	fromBlock := getEvent.FromBlock
+	filter := getEvent.FilterSize
+
+	// Dial the Ethereum RPC server.
+	rpc, err := ethrpc.DialContext(cmd.Context(), rpcUrl)
+	if err != nil {
+		log.Error().Err(err).Msg("Unable to Dial RPC")
+		return err
+	}
+	defer rpc.Close()
+	ec := ethclient.NewClient(rpc)
+
+	bridgeV2, err := ulxly.NewUlxly(common.HexToAddress(bridgeAddress), ec)
+	if err != nil {
+		return err
+	}
+	currentBlock := fromBlock
+	for currentBlock < toBlock {
+		endBlock := currentBlock + filter
+		if endBlock > toBlock {
+			endBlock = toBlock
+		}
+
+		opts := bind.FilterOpts{
+			Start:   currentBlock,
+			End:     &endBlock,
+			Context: cmd.Context(),
+		}
+		evtV2Iterator, err := bridgeV2.FilterClaimEvent(&opts)
+		if err != nil {
+			return err
+		}
+
+		for evtV2Iterator.Next() {
+			evt := evtV2Iterator.Event
+			var (
+				mainnetFlag                     bool
+				rollupIndex, localExitRootIndex uint32
+			)
+			mainnetFlag, rollupIndex, localExitRootIndex, err = DecodeGlobalIndex(evt.GlobalIndex)
+			if err != nil {
+				log.Error().Err(err).Msg("error decoding globalIndex")
+				return err
+			}
+			log.Info().Bool("claim-mainnetFlag", mainnetFlag).Uint32("claim-RollupIndex", rollupIndex).Uint32("claim-LocalExitRootIndex", localExitRootIndex).Uint64("block-number", evt.Raw.BlockNumber).Msg("Found Claim")
+			var jBytes []byte
+			jBytes, err = json.Marshal(evt)
+			if err != nil {
+				return err
+			}
+			fmt.Println(string(jBytes))
+		}
+		err = evtV2Iterator.Close()
+		if err != nil {
+			log.Error().Err(err).Msg("error closing event iterator")
+		}
+		currentBlock = endBlock
+	}
+
+	return nil
+}
 func readVerifyBatches(cmd *cobra.Command) error {
 	rollupManagerAddress := getVerifyBatchesOptions.RollupManagerAddress
-	rpcUrl := getDepositsAndVerifyBatchesSharedOptions.URL
-	toBlock := getDepositsAndVerifyBatchesSharedOptions.ToBlock
-	fromBlock := getDepositsAndVerifyBatchesSharedOptions.FromBlock
-	filter := getDepositsAndVerifyBatchesSharedOptions.FilterSize
+	rpcUrl := getEvent.URL
+	toBlock := getEvent.ToBlock
+	fromBlock := getEvent.FromBlock
+	filter := getEvent.FilterSize
 
 	// Dial the Ethereum RPC server.
 	rpc, err := ethrpc.DialContext(cmd.Context(), rpcUrl)
@@ -1528,6 +1613,9 @@ var rollupsProofUsage string
 //go:embed depositGetUsage.md
 var depositGetUsage string
 
+//go:embed claimGetUsage.md
+var claimGetUsage string
+
 //go:embed verifyBatchesGetUsage.md
 var verifyBatchesGetUsage string
 
@@ -1555,7 +1643,7 @@ var ulxlyBridgeAndClaimCmd = &cobra.Command{
 	},
 }
 
-var ulxlyGetDepositsAndVerifyBatchesCmd = &cobra.Command{
+var ulxlyGetEventsCmd = &cobra.Command{
 	Args:   cobra.NoArgs,
 	Hidden: true,
 }
@@ -1619,14 +1707,15 @@ var (
 	proofCommand             *cobra.Command
 	rollupsProofCommand      *cobra.Command
 	getDepositCommand        *cobra.Command
+	getClaimCommand          *cobra.Command
 	getVerifyBatchesCommand  *cobra.Command
 
-	getDepositsAndVerifyBatchesSharedOptions = &GetDepositsAndVerifyBatchesSharedOptions{}
-	getDepositOptions                        = &GetDepositOptions{}
-	getVerifyBatchesOptions                  = &GetVerifyBatchesOptions{}
-	proofsSharedOptions                      = &ProofsSharedOptions{}
-	proofOptions                             = &ProofOptions{}
-	rollupsProofOptions                      = &RollupsProofOptions{}
+	getEvent                = &GetEvent{}
+	getSmcOptions           = &GetSmcOptions{}
+	getVerifyBatchesOptions = &GetVerifyBatchesOptions{}
+	proofsSharedOptions     = &ProofsSharedOptions{}
+	proofOptions            = &ProofOptions{}
+	rollupsProofOptions     = &RollupsProofOptions{}
 )
 
 const (
@@ -1734,12 +1823,12 @@ func (o *RollupsProofOptions) AddFlags(cmd *cobra.Command) {
 	cmd.Flags().BoolVarP(&o.CompleteMerkleTree, ArgCompleteMT, "", false, "Allows to get the proof for a leave higher than the highest rollupID")
 }
 
-type GetDepositsAndVerifyBatchesSharedOptions struct {
+type GetEvent struct {
 	URL                            string
 	FromBlock, ToBlock, FilterSize uint64
 }
 
-func (o *GetDepositsAndVerifyBatchesSharedOptions) AddFlags(cmd *cobra.Command) {
+func (o *GetEvent) AddFlags(cmd *cobra.Command) {
 	cmd.Flags().StringVarP(&o.URL, ArgRPCURL, "u", "", "The RPC URL to read the events data")
 	cmd.Flags().Uint64VarP(&o.FromBlock, ArgFromBlock, "f", 0, "The start of the range of blocks to retrieve")
 	cmd.Flags().Uint64VarP(&o.ToBlock, ArgToBlock, "t", 0, "The end of the range of blocks to retrieve")
@@ -1749,11 +1838,11 @@ func (o *GetDepositsAndVerifyBatchesSharedOptions) AddFlags(cmd *cobra.Command)
 	fatalIfError(cmd.MarkFlagRequired(ArgRPCURL))
 }
 
-type GetDepositOptions struct {
+type GetSmcOptions struct {
 	BridgeAddress string
 }
 
-func (o *GetDepositOptions) AddFlags(cmd *cobra.Command) {
+func (o *GetSmcOptions) AddFlags(cmd *cobra.Command) {
 	cmd.Flags().StringVarP(&o.BridgeAddress, ArgBridgeAddress, "a", "", "The address of the ulxly bridge")
 }
 
@@ -1885,11 +1974,25 @@ or if it's actually an intermediate hash.`,
 		},
 		SilenceUsage: true,
 	}
-	getDepositsAndVerifyBatchesSharedOptions.AddFlags(getDepositCommand)
-	getDepositOptions.AddFlags(getDepositCommand)
-	ulxlyGetDepositsAndVerifyBatchesCmd.AddCommand(getDepositCommand)
+	getEvent.AddFlags(getDepositCommand)
+	getSmcOptions.AddFlags(getDepositCommand)
+	ulxlyGetEventsCmd.AddCommand(getDepositCommand)
 	ULxLyCmd.AddCommand(getDepositCommand)
 
+	getClaimCommand = &cobra.Command{
+		Use:   "get-claims",
+		Short: "Generate ndjson for each bridge claim over a particular range of blocks",
+		Long:  claimGetUsage,
+		RunE: func(cmd *cobra.Command, args []string) error {
+			return readClaim(cmd)
+		},
+		SilenceUsage: true,
+	}
+	getEvent.AddFlags(getClaimCommand)
+	getSmcOptions.AddFlags(getClaimCommand)
+	ulxlyGetEventsCmd.AddCommand(getClaimCommand)
+	ULxLyCmd.AddCommand(getClaimCommand)
+
 	getVerifyBatchesCommand = &cobra.Command{
 		Use:   "get-verify-batches",
 		Short: "Generate ndjson for each verify batch over a particular range of blocks",
@@ -1899,9 +2002,9 @@ or if it's actually an intermediate hash.`,
 		},
 		SilenceUsage: true,
 	}
-	getDepositsAndVerifyBatchesSharedOptions.AddFlags(getVerifyBatchesCommand)
+	getEvent.AddFlags(getVerifyBatchesCommand)
 	getVerifyBatchesOptions.AddFlags(getVerifyBatchesCommand)
-	ulxlyGetDepositsAndVerifyBatchesCmd.AddCommand(getVerifyBatchesCommand)
+	ulxlyGetEventsCmd.AddCommand(getVerifyBatchesCommand)
 	ULxLyCmd.AddCommand(getVerifyBatchesCommand)
 
 	// Arguments for both bridge and claim
@@ -1945,7 +2048,7 @@ or if it's actually an intermediate hash.`,
 
 	// Top Level
 	ULxLyCmd.AddCommand(ulxlyBridgeAndClaimCmd)
-	ULxLyCmd.AddCommand(ulxlyGetDepositsAndVerifyBatchesCmd)
+	ULxLyCmd.AddCommand(ulxlyGetEventsCmd)
 	ULxLyCmd.AddCommand(ulxlyProofsCmd)
 	ULxLyCmd.AddCommand(emptyProofCommand)
 	ULxLyCmd.AddCommand(zeroProofCommand)

doc/polycli_ulxly.md

@@ -48,6 +48,8 @@ The command also inherits flags from parent commands.
 
 - [polycli ulxly empty-proof](polycli_ulxly_empty-proof.md) - create an empty proof
 
+- [polycli ulxly get-claims](polycli_ulxly_get-claims.md) - Generate ndjson for each bridge claim over a particular range of blocks
+
 - [polycli ulxly get-deposits](polycli_ulxly_get-deposits.md) - Generate ndjson for each bridge deposit over a particular range of blocks
 
 - [polycli ulxly get-verify-batches](polycli_ulxly_get-verify-batches.md) - Generate ndjson for each verify batch over a particular range of blocks

doc/polycli_ulxly_get-claims.md

@@ -0,0 +1,93 @@
+# `polycli ulxly get-claims`
+
+> Auto-generated documentation.
+
+## Table of Contents
+
+- [Description](#description)
+- [Usage](#usage)
+- [Flags](#flags)
+- [See Also](#see-also)
+
+## Description
+
+Generate ndjson for each bridge claim over a particular range of blocks
+
+```bash
+polycli ulxly get-claims [flags]
+```
+
+## Usage
+
+This command will attempt to scan a range of blocks and look for uLxLy
+Claim Events. This is the specific signature that we're interested
+in:
+
+```solidity
+    /**
+     * @dev Emitted when a claim is done from another network
+     */
+    event ClaimEvent(
+        uint256 globalIndex,
+        uint32 originNetwork,
+        address originAddress,
+        address destinationAddress,
+        uint256 amount
+    );
+```
+
+If you're looking at the raw topics from on chain or in an explorer, this is the associated value:
+
+`0x1df3f2a973a00d6635911755c260704e95e8a5876997546798770f76396fda4d`
+
+Each event that we counter will be parsed and written as JSON to
+stdout. Example usage:
+
+```bash
+polycli ulxly get-claims \
+        --bridge-address 0x528e26b25a34a4A5d0dbDa1d57D318153d2ED582 \
+        --rpc-url https://eth-sepolia.g.alchemy.com/v2/demo \
+        --from-block 4880876 \
+        --to-block 6028159 \
+        --filter-size 9999 > cardona-4880876-to-6028159.ndjson
+```
+
+This command will look for claim events from block `4880876` to
+block `6028159` in increments of `9999` blocks at a time for the
+contract address `0x528e26b25a34a4A5d0dbDa1d57D318153d2ED582`. The
+output will be written as newline delimited JSON.
+
+This command is very specific for the ulxly bridge, and it's meant to
+serve as the input to the proof command.
+
+
+
+## Flags
+
+```bash
+  -a, --bridge-address string   The address of the ulxly bridge
+  -i, --filter-size uint        The batch size for individual filter queries (default 1000)
+  -f, --from-block uint         The start of the range of blocks to retrieve
+  -h, --help                    help for get-claims
+  -u, --rpc-url string          The RPC URL to read the events data
+  -t, --to-block uint           The end of the range of blocks to retrieve
+```
+
+The command also inherits flags from parent commands.
+
+```bash
+      --config string   config file (default is $HOME/.polygon-cli.yaml)
+      --pretty-logs     Should logs be in pretty format or JSON (default true)
+  -v, --verbosity int   0 - Silent
+                        100 Panic
+                        200 Fatal
+                        300 Error
+                        400 Warning
+                        500 Info
+                        600 Debug
+                        700 Trace (default 500)
+```
+
+## See also
+
+- [polycli ulxly](polycli_ulxly.md) - Utilities for interacting with the uLxLy bridge