Add simple CLI to fetch and archive C-Chain blocks #4305
+429
−63
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| // Copyright (C) 2019-2025, Ava Labs, Inc. All rights reserved. | ||
| // See the file LICENSE for licensing terms. | ||
|
|
||
| package c | ||
|
|
||
| import ( | ||
| "os" | ||
|
|
||
| "github.com/ava-labs/libevm/core/types" | ||
| "github.com/ava-labs/libevm/rlp" | ||
| "github.com/onsi/ginkgo/v2" | ||
| "github.com/stretchr/testify/require" | ||
|
|
||
| "github.com/ava-labs/avalanchego/database" | ||
| "github.com/ava-labs/avalanchego/tests/fixture/e2e" | ||
| "github.com/ava-labs/avalanchego/tests/reexecute/utils" | ||
| ) | ||
|
|
||
| var _ = e2e.DescribeCChain("[Fetch Blocks]", func() { | ||
| tc := e2e.NewTestContext() | ||
| require := require.New(tc) | ||
|
|
||
| ginkgo.It("fetches created blocks", func() { | ||
| env := e2e.GetEnv(tc) | ||
| nodeURI := env.GetRandomNodeURI() | ||
| cChainNodeURI := nodeURI.URI + "/ext/bc/C/rpc" | ||
|
|
||
| fetchBlocksDBDir, err := os.MkdirTemp("", "fetch-blocks-test") | ||
| require.NoError(err) | ||
| defer func() { | ||
| require.NoError(os.RemoveAll(fetchBlocksDBDir)) | ||
| }() | ||
| const ( | ||
| startBlock = 1 | ||
| endBlock = 10 | ||
| numBlocks = 10 | ||
| ) | ||
| byAdvancingCChainHeight(tc, numBlocks) | ||
| ginkgo.By("fetching blocks", func() { | ||
| require.NoError(utils.FetchBlocksToBlockDB( | ||
| tc.DefaultContext(), | ||
| tc.Log(), | ||
| fetchBlocksDBDir, | ||
| startBlock, | ||
| endBlock, | ||
| cChainNodeURI, | ||
| numBlocks, | ||
| )) | ||
| }) | ||
|
Comment on lines
+39
to
+49
There was a problem hiding this comment. It feels weird to me that:
I feel like we either need to run a e2e test on the cli binary as a subprocess or do a unit test the root cmd type |
||
| ginkgo.By("checking blockDB contents", func() { | ||
| blockDB, err := utils.NewBlockDB(fetchBlocksDBDir) | ||
| require.NoError(err) | ||
|
|
||
| defer func() { | ||
| require.NoError(blockDB.Close()) | ||
| }() | ||
|
|
||
| blockIter := blockDB.NewIteratorFromHeight(startBlock) | ||
|
|
||
| expectedBlock := uint64(startBlock) | ||
| for blockIter.Next() { | ||
| blockHeightKey := blockIter.Key() | ||
| blockBytes := blockIter.Value() | ||
|
|
||
| require.Len(blockHeightKey, database.Uint64Size) | ||
| blockHeight, err := database.ParseUInt64(blockHeightKey) | ||
| require.NoError(err) | ||
| require.Equal(expectedBlock, blockHeight) | ||
| expectedBlock++ | ||
|
|
||
| block := new(types.Block) | ||
| require.NoError(rlp.DecodeBytes(blockBytes, block)) | ||
| require.Equal(blockHeight, block.NumberU64()) | ||
| } | ||
| require.Equal(expectedBlock, uint64(endBlock)+1) | ||
| require.NoError(blockIter.Error()) | ||
|
Comment on lines
+58
to
+76
There was a problem hiding this comment. Iterator is not released after use; other code paths (e.g., prior test helpers) defer Release to free underlying resources. Call blockIter.Release() (e.g., via defer right after creation) before closing the DB. Copilot uses AI. Check for mistakes. |
||
| }) | ||
| }) | ||
| }) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,62 @@ | ||||||||||||
| // Copyright (C) 2019-2025, Ava Labs, Inc. All rights reserved. | ||||||||||||
| // See the file LICENSE for licensing terms. | ||||||||||||
|
|
||||||||||||
| package cmd | ||||||||||||
|
|
||||||||||||
| import ( | ||||||||||||
| "context" | ||||||||||||
| "fmt" | ||||||||||||
|
|
||||||||||||
| "github.com/spf13/cobra" | ||||||||||||
|
|
||||||||||||
| "github.com/ava-labs/avalanchego/tests/reexecute/utils" | ||||||||||||
| ) | ||||||||||||
|
|
||||||||||||
| const ( | ||||||||||||
| dbDirKey = "db-dir" | ||||||||||||
| startBlockKey = "start-block" | ||||||||||||
| endBlockKey = "end-block" | ||||||||||||
| rpcURLKey = "rpc-url" | ||||||||||||
| concurrencyKey = "concurrency" | ||||||||||||
| ) | ||||||||||||
|
|
||||||||||||
| // fetchBlocksCmd represents the fetchBlocks command | ||||||||||||
|
There was a problem hiding this comment. nit: avoid self-documenting comments |
||||||||||||
| var fetchBlocksCmd = &cobra.Command{ | ||||||||||||
| Use: "fetchBlocks", | ||||||||||||
|
There was a problem hiding this comment. cli tooling typically uses kebab casing for multi-word expressions - additionally this camelCasing is inconsistent with the kebab-cased parameters |
||||||||||||
| Short: "Fetch blocks from the network and write to the specified database", | ||||||||||||
| RunE: runFetchBlocks, | ||||||||||||
| } | ||||||||||||
|
|
||||||||||||
| func init() { | ||||||||||||
| rootCmd.AddCommand(fetchBlocksCmd) | ||||||||||||
|
|
||||||||||||
| fetchBlocksCmd.Flags().String(dbDirKey, "", "Database to store the fetched blocks") | ||||||||||||
| fetchBlocksCmd.Flags().String(rpcURLKey, "http://localhost:9650/ext/bc/C/rpc", "Ethereum RPC URL to fetch blocks from") | ||||||||||||
| fetchBlocksCmd.Flags().Uint64(startBlockKey, 0, "Block number to start fetching from (inclusive)") | ||||||||||||
| fetchBlocksCmd.Flags().Uint64(endBlockKey, 0, "Block number to stop fetching at (inclusive)") | ||||||||||||
|
There was a problem hiding this comment. Why is stop inclusive? Typically range semantics are inclusive start and exclusive end (like loops), deviating might lead to confusion when using this tooling. |
||||||||||||
| fetchBlocksCmd.Flags().Int(concurrencyKey, 1000, "Number of concurrent fetches to make") | ||||||||||||
| } | ||||||||||||
|
|
||||||||||||
| func runFetchBlocks(cmd *cobra.Command, _ []string) error { | ||||||||||||
| dbDir, err := cmd.Flags().GetString(dbDirKey) | ||||||||||||
| if err != nil { | ||||||||||||
| return fmt.Errorf("failed to get db-dir flag: %w", err) | ||||||||||||
| } | ||||||||||||
| startBlock, err := cmd.Flags().GetUint64(startBlockKey) | ||||||||||||
| if err != nil { | ||||||||||||
| return fmt.Errorf("failed to get start-block flag: %w", err) | ||||||||||||
| } | ||||||||||||
| endBlock, err := cmd.Flags().GetUint64(endBlockKey) | ||||||||||||
| if err != nil { | ||||||||||||
| return fmt.Errorf("failed to get end-block flag: %w", err) | ||||||||||||
| } | ||||||||||||
| rpcURL, err := cmd.Flags().GetString(rpcURLKey) | ||||||||||||
| if err != nil { | ||||||||||||
| return fmt.Errorf("failed to get rpc-url flag: %w", err) | ||||||||||||
| } | ||||||||||||
| concurrency, err := cmd.Flags().GetInt(concurrencyKey) | ||||||||||||
| if err != nil { | ||||||||||||
| return fmt.Errorf("failed to get concurrency flag: %w", err) | ||||||||||||
| } | ||||||||||||
|
There was a problem hiding this comment. Concurrency flag is not validated; a negative value will cause a panic when used as the channel buffer size (make(chan uint64, concurrency)) and zero will spawn no workers. Add a check ensuring concurrency > 0 and return a descriptive error otherwise.
Suggested change
Copilot uses AI. Check for mistakes. |
||||||||||||
| return utils.FetchBlocksToBlockDB(context.Background(), cliLog, dbDir, startBlock, endBlock, rpcURL, concurrency) | ||||||||||||
|
There was a problem hiding this comment. I think we probably want to use |
||||||||||||
| } | ||||||||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| // Copyright (C) 2019-2025, Ava Labs, Inc. All rights reserved. | ||
| // See the file LICENSE for licensing terms. | ||
|
|
||
| package cmd | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "os" | ||
|
|
||
| "github.com/spf13/cobra" | ||
| "github.com/spf13/viper" | ||
|
|
||
| "github.com/ava-labs/avalanchego/utils/logging" | ||
| ) | ||
|
|
||
| var ( | ||
| cfgFile string | ||
| logLevelKey = "log-level" | ||
| cliLog logging.Logger | ||
| ) | ||
|
|
||
| // rootCmd represents the base command when called without any subcommands | ||
| var rootCmd = &cobra.Command{ | ||
|
There was a problem hiding this comment. Why do we need this root cmd? We only have one sub command anyways, would it make sense to just have a |
||
| Use: "argo", | ||
|
There was a problem hiding this comment.
|
||
| Short: "Simple CLI tool to interact with re-execution", | ||
| } | ||
|
|
||
| // Execute adds all child commands to the root command and sets flags appropriately. | ||
| // This is called by main.main(). It only needs to happen once to the rootCmd. | ||
|
There was a problem hiding this comment. Do we need this helper? It's a helper around a function that's only used once + it's exported even though it's only usage is for main. |
||
| func Execute() { | ||
| err := rootCmd.Execute() | ||
| if err != nil { | ||
| os.Exit(1) | ||
| } | ||
| } | ||
|
|
||
| func init() { | ||
|
There was a problem hiding this comment.
|
||
| cobra.OnInitialize(initConfig) | ||
|
|
||
| rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $HOME/.cli.yaml)") | ||
| rootCmd.PersistentFlags().String(logLevelKey, logging.Info.String(), "Log level") | ||
|
|
||
| rootCmd.PersistentPreRunE = func(_ *cobra.Command, _ []string) error { | ||
| logLevelStr, err := rootCmd.PersistentFlags().GetString(logLevelKey) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to get %q flag: %w", logLevelKey, err) | ||
| } | ||
| logLevel, err := logging.ToLevel(logLevelStr) | ||
|
Comment on lines
+47
to
+48
There was a problem hiding this comment. nit: This is in a lot of spots in this PR but typically a line break is done after these braces |
||
| if err != nil { | ||
| return fmt.Errorf("failed to parse log-level flag %q: %w", logLevelStr, err) | ||
| } | ||
| cliLog = logging.NewLogger( | ||
| "argo", | ||
| logging.NewWrappedCore( | ||
| logLevel, | ||
| os.Stdout, | ||
| logging.Colors.ConsoleEncoder(), | ||
| ), | ||
| ) | ||
| return nil | ||
| } | ||
| } | ||
|
|
||
| // initConfig reads in config file and ENV variables if set. | ||
| func initConfig() { | ||
| if cfgFile != "" { | ||
|
There was a problem hiding this comment.
|
||
| // Use config file from the flag. | ||
| viper.SetConfigFile(cfgFile) | ||
| } else { | ||
| // Find home directory. | ||
| home, err := os.UserHomeDir() | ||
| cobra.CheckErr(err) | ||
|
|
||
| // Search config in home directory with name ".cli" (without extension). | ||
| viper.AddConfigPath(home) | ||
| viper.SetConfigType("yaml") | ||
| viper.SetConfigName(".cli") | ||
| } | ||
|
|
||
| viper.AutomaticEnv() // read in environment variables that match | ||
|
|
||
| // If a config file is found, read it in. | ||
| if err := viper.ReadInConfig(); err == nil { | ||
| fmt.Fprintln(os.Stderr, "Using config file:", viper.ConfigFileUsed()) | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| // Copyright (C) 2019-2025, Ava Labs, Inc. All rights reserved. | ||
| // See the file LICENSE for licensing terms. | ||
|
|
||
| package main | ||
|
|
||
| import "github.com/ava-labs/avalanchego/tests/reexecute/c/cli/cmd" | ||
|
|
||
| func main() { | ||
| cmd.Execute() | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like we meant to merge this into the below require block?