-
Notifications
You must be signed in to change notification settings - Fork 3.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'develop' into clabby/ctb/semver-assertions
- Loading branch information
Showing
5 changed files
with
195 additions
and
38 deletions.
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
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 |
|---|---|---|
| @@ -1,21 +1,91 @@ | ||
| package cannon | ||
|
|
||
| import ( | ||
| "errors" | ||
| "fmt" | ||
| "os" | ||
| "path/filepath" | ||
| "regexp" | ||
| "strconv" | ||
|
|
||
| "github.com/ethereum-optimism/optimism/op-challenger/config" | ||
| "github.com/ethereum/go-ethereum/log" | ||
| ) | ||
|
|
||
| type executor struct { | ||
| logger log.Logger | ||
| const snapsDir = "snapshots" | ||
|
|
||
| var snapshotNameRegexp = regexp.MustCompile(`^[0-9]+\.json$`) | ||
|
|
||
| const snapshotFrequency = 10_000 | ||
|
|
||
| type snapshotSelect func(logger log.Logger, dir string, absolutePreState string, i uint64) (string, error) | ||
|
|
||
| type Executor struct { | ||
| logger log.Logger | ||
| l1 string | ||
| l2 string | ||
| cannon string | ||
| absolutePreState string | ||
| dataDir string | ||
| selectSnapshot snapshotSelect | ||
| } | ||
|
|
||
| func newExecutor(logger log.Logger) Executor { | ||
| return &executor{ | ||
| logger: logger, | ||
| func NewExecutor(logger log.Logger, cfg *config.Config) *Executor { | ||
| return &Executor{ | ||
| logger: logger, | ||
| l1: cfg.L1EthRpc, | ||
| l2: cfg.CannonL2, | ||
| cannon: cfg.CannonBin, | ||
| absolutePreState: cfg.CannonAbsolutePreState, | ||
| dataDir: cfg.CannonDatadir, | ||
| selectSnapshot: findStartingSnapshot, | ||
| } | ||
| } | ||
|
|
||
| func (e *executor) GenerateProof(dir string, i uint64) error { | ||
| return fmt.Errorf("please execute cannon with --proof-at %v --proof-fmt %v/%v/%%d.json", i, dir, proofsDir) | ||
| func (e *Executor) GenerateProof(dir string, i uint64) error { | ||
| start, err := e.selectSnapshot(e.logger, filepath.Join(e.dataDir, snapsDir), e.absolutePreState, i) | ||
| if err != nil { | ||
| return fmt.Errorf("find starting snapshot: %w", err) | ||
| } | ||
| return fmt.Errorf("please execute cannon with --input %v --proof-at %v --proof-fmt %v/%v/%%d.json --snapshot-at %%%d --snapshot-fmt '%v/%v/%%d.json", | ||
| start, i, dir, proofsDir, snapshotFrequency, dir, snapsDir) | ||
| } | ||
|
|
||
| // findStartingSnapshot finds the closest snapshot before the specified traceIndex in snapDir. | ||
| // If no suitable snapshot can be found it returns absolutePreState. | ||
| func findStartingSnapshot(logger log.Logger, snapDir string, absolutePreState string, traceIndex uint64) (string, error) { | ||
| // Find the closest snapshot to start from | ||
| entries, err := os.ReadDir(snapDir) | ||
| if err != nil { | ||
| if errors.Is(err, os.ErrNotExist) { | ||
| return absolutePreState, nil | ||
| } | ||
| return "", fmt.Errorf("list snapshots in %v: %w", snapDir, err) | ||
| } | ||
| bestSnap := uint64(0) | ||
| for _, entry := range entries { | ||
| if entry.IsDir() { | ||
| logger.Warn("Unexpected directory in snapshots dir: %v/%v", snapDir, entry.Name()) | ||
| continue | ||
| } | ||
| name := entry.Name() | ||
| if !snapshotNameRegexp.MatchString(name) { | ||
| logger.Warn("Unexpected file in snapshots dir: %v/%v", snapDir, entry.Name()) | ||
| continue | ||
| } | ||
| index, err := strconv.ParseUint(name[0:len(name)-len(".json")], 10, 64) | ||
| if err != nil { | ||
| logger.Error("Unable to parse trace index of snapshot file: %v/%v", snapDir, entry.Name()) | ||
| continue | ||
| } | ||
| if index > bestSnap && index < traceIndex { | ||
| bestSnap = index | ||
| } | ||
| } | ||
| if bestSnap == 0 { | ||
| return absolutePreState, nil | ||
| } | ||
| startFrom := fmt.Sprintf("%v/%v.json", snapDir, bestSnap) | ||
|
|
||
| return startFrom, 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| package cannon | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "os" | ||
| "path/filepath" | ||
| "testing" | ||
|
|
||
| "github.com/ethereum-optimism/optimism/op-node/testlog" | ||
| "github.com/ethereum/go-ethereum/log" | ||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| const execTestCannonPrestate = "/foo/pre.json" | ||
|
|
||
| func TestFindStartingSnapshot(t *testing.T) { | ||
| logger := testlog.Logger(t, log.LvlInfo) | ||
|
|
||
| withSnapshots := func(t *testing.T, files ...string) string { | ||
| dir := t.TempDir() | ||
| for _, file := range files { | ||
| require.NoError(t, os.WriteFile(fmt.Sprintf("%v/%v", dir, file), nil, 0o644)) | ||
| } | ||
| return dir | ||
| } | ||
|
|
||
| t.Run("UsePrestateWhenSnapshotsDirDoesNotExist", func(t *testing.T) { | ||
| dir := t.TempDir() | ||
| snapshot, err := findStartingSnapshot(logger, filepath.Join(dir, "doesNotExist"), execTestCannonPrestate, 1200) | ||
| require.NoError(t, err) | ||
| require.Equal(t, execTestCannonPrestate, snapshot) | ||
| }) | ||
|
|
||
| t.Run("UsePrestateWhenSnapshotsDirEmpty", func(t *testing.T) { | ||
| dir := withSnapshots(t) | ||
| snapshot, err := findStartingSnapshot(logger, dir, execTestCannonPrestate, 1200) | ||
| require.NoError(t, err) | ||
| require.Equal(t, execTestCannonPrestate, snapshot) | ||
| }) | ||
|
|
||
| t.Run("UsePrestateWhenNoSnapshotBeforeTraceIndex", func(t *testing.T) { | ||
| dir := withSnapshots(t, "100.json", "200.json") | ||
| snapshot, err := findStartingSnapshot(logger, dir, execTestCannonPrestate, 99) | ||
| require.NoError(t, err) | ||
| require.Equal(t, execTestCannonPrestate, snapshot) | ||
|
|
||
| snapshot, err = findStartingSnapshot(logger, dir, execTestCannonPrestate, 100) | ||
| require.NoError(t, err) | ||
| require.Equal(t, execTestCannonPrestate, snapshot) | ||
| }) | ||
|
|
||
| t.Run("UseClosestAvailableSnapshot", func(t *testing.T) { | ||
| dir := withSnapshots(t, "100.json", "123.json", "250.json") | ||
|
|
||
| snapshot, err := findStartingSnapshot(logger, dir, execTestCannonPrestate, 101) | ||
| require.NoError(t, err) | ||
| require.Equal(t, filepath.Join(dir, "100.json"), snapshot) | ||
|
|
||
| snapshot, err = findStartingSnapshot(logger, dir, execTestCannonPrestate, 123) | ||
| require.NoError(t, err) | ||
| require.Equal(t, filepath.Join(dir, "100.json"), snapshot) | ||
|
|
||
| snapshot, err = findStartingSnapshot(logger, dir, execTestCannonPrestate, 124) | ||
| require.NoError(t, err) | ||
| require.Equal(t, filepath.Join(dir, "123.json"), snapshot) | ||
|
|
||
| snapshot, err = findStartingSnapshot(logger, dir, execTestCannonPrestate, 256) | ||
| require.NoError(t, err) | ||
| require.Equal(t, filepath.Join(dir, "250.json"), snapshot) | ||
| }) | ||
|
|
||
| t.Run("IgnoreDirectories", func(t *testing.T) { | ||
| dir := withSnapshots(t, "100.json") | ||
| require.NoError(t, os.Mkdir(filepath.Join(dir, "120.json"), 0o777)) | ||
| snapshot, err := findStartingSnapshot(logger, dir, execTestCannonPrestate, 150) | ||
| require.NoError(t, err) | ||
| require.Equal(t, filepath.Join(dir, "100.json"), snapshot) | ||
| }) | ||
|
|
||
| t.Run("IgnoreUnexpectedFiles", func(t *testing.T) { | ||
| dir := withSnapshots(t, ".file", "100.json", "foo", "bar.json") | ||
| snapshot, err := findStartingSnapshot(logger, dir, execTestCannonPrestate, 150) | ||
| require.NoError(t, err) | ||
| require.Equal(t, filepath.Join(dir, "100.json"), snapshot) | ||
| }) | ||
| } |
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