-
Notifications
You must be signed in to change notification settings - Fork 20.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
cmd/geth: add a verkle subcommand #25718
Merged
gballet
merged 5 commits into
ethereum:master
from
gballet:verkle-add-verification-and-dump
Sep 14, 2022
Merged
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
2b4955c
cmd/geth: add a verkle subcommand
gballet 49a7da2
fix copyright year
gballet 7a25e1d
remove unused command parameters
gballet 64c8bcc
check that the output file was successfully written to
gballet ea2a962
cmd/geth: goimports fix
holiman File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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 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,213 @@ | ||
| // Copyright 2022 The go-ethereum Authors | ||
| // This file is part of go-ethereum. | ||
| // | ||
| // go-ethereum is free software: you can redistribute it and/or modify | ||
| // it under the terms of the GNU General Public License as published by | ||
| // the Free Software Foundation, either version 3 of the License, or | ||
| // (at your option) any later version. | ||
| // | ||
| // go-ethereum is distributed in the hope that it will be useful, | ||
| // but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| // GNU General Public License for more details. | ||
| // | ||
| // You should have received a copy of the GNU General Public License | ||
| // along with go-ethereum. If not, see <http://www.gnu.org/licenses/>. | ||
|
|
||
| package main | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "encoding/hex" | ||
| "errors" | ||
| "fmt" | ||
| "os" | ||
|
|
||
| "github.com/ethereum/go-ethereum/cmd/utils" | ||
| "github.com/ethereum/go-ethereum/common" | ||
| "github.com/ethereum/go-ethereum/core/rawdb" | ||
| "github.com/ethereum/go-ethereum/internal/flags" | ||
| "github.com/ethereum/go-ethereum/log" | ||
| "github.com/gballet/go-verkle" | ||
| cli "github.com/urfave/cli/v2" | ||
| ) | ||
|
|
||
| var ( | ||
| zero [32]byte | ||
|
|
||
| verkleCommand = &cli.Command{ | ||
| Name: "verkle", | ||
| Usage: "A set of experimental verkle tree management commands", | ||
| Category: "MISCELLANEOUS COMMANDS", | ||
| Description: "", | ||
| Subcommands: []*cli.Command{ | ||
| { | ||
| Name: "verify", | ||
| Usage: "verify the conversion of a MPT into a verkle tree", | ||
| ArgsUsage: "<root>", | ||
| Action: verifyVerkle, | ||
| Flags: flags.Merge(utils.NetworkFlags, utils.DatabasePathFlags), | ||
| Description: ` | ||
| geth verkle verify <state-root> | ||
| This command takes a root commitment and attempts to rebuild the tree. | ||
| `, | ||
| }, | ||
| { | ||
| Name: "dump", | ||
| Usage: "Dump a verkle tree to a DOT file", | ||
| ArgsUsage: "<root> <key1> [<key 2> ...]", | ||
| Action: expandVerkle, | ||
| Flags: flags.Merge(utils.NetworkFlags, utils.DatabasePathFlags), | ||
| Description: ` | ||
| geth verkle dump <state-root> <key 1> [<key 2> ...] | ||
| This command will produce a dot file representing the tree, rooted at <root>. | ||
| in which key1, key2, ... are expanded. | ||
| `, | ||
| }, | ||
| }, | ||
| } | ||
| ) | ||
|
|
||
| // recurse into each child to ensure they can be loaded from the db. The tree isn't rebuilt | ||
| // (only its nodes are loaded) so there is no need to flush them, the garbage collector should | ||
| // take care of that for us. | ||
| func checkChildren(root verkle.VerkleNode, resolver verkle.NodeResolverFn) error { | ||
| switch node := root.(type) { | ||
| case *verkle.InternalNode: | ||
| for i, child := range node.Children() { | ||
| childC := child.ComputeCommitment().Bytes() | ||
|
|
||
| childS, err := resolver(childC[:]) | ||
| if bytes.Equal(childC[:], zero[:]) { | ||
| continue | ||
| } | ||
| if err != nil { | ||
| return fmt.Errorf("could not find child %x in db: %w", childC, err) | ||
| } | ||
| // depth is set to 0, the tree isn't rebuilt so it's not a problem | ||
| childN, err := verkle.ParseNode(childS, 0, childC[:]) | ||
| if err != nil { | ||
| return fmt.Errorf("decode error child %x in db: %w", child.ComputeCommitment().Bytes(), err) | ||
| } | ||
| if err := checkChildren(childN, resolver); err != nil { | ||
| return fmt.Errorf("%x%w", i, err) // write the path to the erroring node | ||
| } | ||
| } | ||
| case *verkle.LeafNode: | ||
| // sanity check: ensure at least one value is non-zero | ||
|
|
||
| for i := 0; i < verkle.NodeWidth; i++ { | ||
| if len(node.Value(i)) != 0 { | ||
| return nil | ||
| } | ||
| } | ||
| return fmt.Errorf("Both balance and nonce are 0") | ||
| case verkle.Empty: | ||
| // nothing to do | ||
| default: | ||
| return fmt.Errorf("unsupported type encountered %v", root) | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func verifyVerkle(ctx *cli.Context) error { | ||
| stack, _ := makeConfigNode(ctx) | ||
| defer stack.Close() | ||
|
|
||
| chaindb := utils.MakeChainDatabase(ctx, stack, true) | ||
| headBlock := rawdb.ReadHeadBlock(chaindb) | ||
| if headBlock == nil { | ||
| log.Error("Failed to load head block") | ||
| return errors.New("no head block") | ||
| } | ||
| if ctx.NArg() > 1 { | ||
| log.Error("Too many arguments given") | ||
| return errors.New("too many arguments") | ||
| } | ||
| var ( | ||
| rootC common.Hash | ||
| err error | ||
| ) | ||
| if ctx.NArg() == 1 { | ||
| rootC, err = parseRoot(ctx.Args().First()) | ||
| if err != nil { | ||
| log.Error("Failed to resolve state root", "error", err) | ||
| return err | ||
| } | ||
| log.Info("Rebuilding the tree", "root", rootC) | ||
| } else { | ||
| rootC = headBlock.Root() | ||
| log.Info("Rebuilding the tree", "root", rootC, "number", headBlock.NumberU64()) | ||
| } | ||
|
|
||
| serializedRoot, err := chaindb.Get(rootC[:]) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| root, err := verkle.ParseNode(serializedRoot, 0, rootC[:]) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| if err := checkChildren(root, chaindb.Get); err != nil { | ||
| log.Error("Could not rebuild the tree from the database", "err", err) | ||
| return err | ||
| } | ||
|
|
||
| log.Info("Tree was rebuilt from the database") | ||
| return nil | ||
| } | ||
|
|
||
| func expandVerkle(ctx *cli.Context) error { | ||
| stack, _ := makeConfigNode(ctx) | ||
| defer stack.Close() | ||
|
|
||
| chaindb := utils.MakeChainDatabase(ctx, stack, true) | ||
| var ( | ||
| rootC common.Hash | ||
| keylist [][]byte | ||
| err error | ||
| ) | ||
| if ctx.NArg() >= 2 { | ||
| rootC, err = parseRoot(ctx.Args().First()) | ||
| if err != nil { | ||
| log.Error("Failed to resolve state root", "error", err) | ||
| return err | ||
| } | ||
| keylist = make([][]byte, 0, ctx.Args().Len()-1) | ||
| args := ctx.Args().Slice() | ||
| for i := range args[1:] { | ||
| key, err := hex.DecodeString(args[i+1]) | ||
| log.Info("decoded key", "arg", args[i+1], "key", key) | ||
| if err != nil { | ||
| return fmt.Errorf("error decoding key #%d: %w", i+1, err) | ||
| } | ||
| keylist = append(keylist, key) | ||
| } | ||
| log.Info("Rebuilding the tree", "root", rootC) | ||
| } else { | ||
| return fmt.Errorf("usage: %s root key1 [key 2...]", ctx.App.Name) | ||
| } | ||
|
|
||
| serializedRoot, err := chaindb.Get(rootC[:]) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| root, err := verkle.ParseNode(serializedRoot, 0, rootC[:]) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| for i, key := range keylist { | ||
| log.Info("Reading key", "index", i, "key", keylist[0]) | ||
| root.Get(key, chaindb.Get) | ||
| } | ||
|
|
||
| if err := os.WriteFile("dump.dot", []byte(verkle.ToDot(root)), 0600); err != nil{ | ||
| log.Error("Failed to dump file", "err", err) | ||
| } else{ | ||
| log.Info("Tree was dumped to file", "file", "dump.dot") | ||
| } | ||
| return nil | ||
| } | ||
This file contains 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 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
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.
I don't get it. Does this assume that the chaindb is already migrated to verkle?
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.
I mean, like, what is the order that things are done here, and what are the artefacts?
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.
yes, this is the verification tool, the goals are: