Merge pull request #6308 from ethereum-optimism/jg/remove_examples

op-challenger: Remove unused examples

op-challenger/fault/cmd/examples/full.go

-package examples
-
-import (
-	"os"
-
-	"github.com/ethereum-optimism/optimism/op-challenger/fault"
-	"github.com/ethereum/go-ethereum/common"
-	"github.com/ethereum/go-ethereum/log"
-)
-
-func FullGame() {
-	log.Root().SetHandler(
-		log.LvlFilterHandler(log.LvlInfo, log.StreamHandler(os.Stdout, log.TerminalFormat(true))),
-	)
-
-	canonical := "abcdefgh"
-	disputed := "abcdexyz"
-	maxDepth := uint64(3)
-	canonicalProvider := fault.NewAlphabetProvider(canonical, maxDepth)
-	disputedProvider := fault.NewAlphabetProvider(disputed, maxDepth)
-
-	root := fault.Claim{
-		ClaimData: fault.ClaimData{
-			Value:    common.HexToHash("0x000000000000000000000000000000000000000000000000000000000000077a"),
-			Position: fault.NewPosition(0, 0),
-		},
-	}
-
-	o := fault.NewOrchestrator(maxDepth, []fault.TraceProvider{canonicalProvider, disputedProvider}, []string{"charlie", "mallory"}, []bool{false, true}, root)
-	o.Start()
-}

op-challenger/fault/cmd/examples/position.go

-package examples
-
-import (
-	"github.com/ethereum-optimism/optimism/op-challenger/fault"
-)
-
-func PositionExampleOne() {
-	// Example 1
-	// abcdefgh
-	// abcdexyz
-	// go left to d, then right to f, then left to e
-	p := fault.Position{}
-	p.Print(3)
-	p = p.Attack()
-	p.Print(3)
-	p = p.Defend()
-	p.Print(3)
-	p = p.Attack()
-	p.Print(3)
-}
-
-func PositionExampleTwo() {
-	// Example 2
-	// abcdefgh
-	// abqrstuv
-	// go left r, then left to b, then right to q
-	p := fault.Position{}
-	p.Print(3)
-	p = p.Attack()
-	p.Print(3)
-	p = p.Attack()
-	p.Print(3)
-	p = p.Defend()
-	p.Print(3)
-}

op-challenger/fault/cmd/examples/solver.go

-package examples
-
-import (
-	"fmt"
-
-	"github.com/ethereum/go-ethereum/common"
-
-	"github.com/ethereum-optimism/optimism/op-challenger/fault"
-)
-
-func PrettyPrintAlphabetClaim(name string, claim fault.Claim) {
-	value := claim.Value
-	idx := value[30]
-	letter := value[31]
-	if claim.IsRoot() {
-		fmt.Printf("%s\ttrace %v letter %c\n", name, idx, letter)
-	} else {
-		fmt.Printf("%s\ttrace %v letter %c is attack %v\n", name, idx, letter, !claim.DefendsParent())
-	}
-
-}
-
-// SolverExampleOne uses the [fault.Solver] with a [fault.AlphabetProvider]
-// to print out fault game traces for the "abcdexyz" counter-state.
-func SolverExampleOne() {
-	fmt.Println("Solver: Example 1")
-
-	// Construct the fault position.
-	canonical := "abcdefgh"
-	disputed := "abcdexyz"
-	maxDepth := 3
-	// Root claim is z at trace index 7 from the disputed provider
-	root := fault.Claim{
-		ClaimData: fault.ClaimData{
-			Value:    common.HexToHash("0x000000000000000000000000000000000000000000000000000000000000077a"),
-			Position: fault.NewPosition(0, 0),
-		},
-	}
-
-	canonicalProvider := fault.NewAlphabetProvider(canonical, uint64(maxDepth))
-	disputedProvider := fault.NewAlphabetProvider(disputed, uint64(maxDepth))
-
-	// Create a solver with the canonical provider.
-	cannonicalSolver := fault.NewSolver(maxDepth, canonicalProvider)
-	disputedSolver := fault.NewSolver(maxDepth, disputedProvider)
-
-	// Print the initial state.
-	fmt.Println("Canonical state: ", canonical)
-	fmt.Println("Disputed state:  ", disputed)
-	fmt.Println()
-	fmt.Println("Proceeding with the following moves:")
-	fmt.Println("go left to d, then right to x (cannonical is f), then left to e")
-	fmt.Println()
-	PrettyPrintAlphabetClaim("Root claim", root)
-
-	claim1, err := cannonicalSolver.NextMove(root, false)
-	if err != nil {
-		fmt.Printf("error getting claim from provider: %v", err)
-	}
-	PrettyPrintAlphabetClaim("Cannonical move", *claim1)
-
-	claim2, err := disputedSolver.NextMove(*claim1, false)
-	if err != nil {
-		fmt.Printf("error getting claim from provider: %v", err)
-	}
-	PrettyPrintAlphabetClaim("Disputed moved", *claim2)
-
-	claim3, err := cannonicalSolver.NextMove(*claim2, false)
-	if err != nil {
-		fmt.Printf("error getting claim from provider: %v", err)
-	}
-	PrettyPrintAlphabetClaim("Cannonical move", *claim3)
-}

op-challenger/fault/cmd/main.go

-package main
-
-import (
-	"github.com/ethereum-optimism/optimism/op-challenger/fault/cmd/examples"
-)
-
-func main() {
-	examples.FullGame()
-	// examples.SolverExampleOne()
-	// examples.PositionExampleOne()
-	// examples.PositionExampleTwo()
-}

op-challenger/fault/orchestrator.go

-package fault
-
-import (
-	"context"
-
-	"github.com/ethereum/go-ethereum/log"
-)
-
-type Orchestrator struct {
-	agents []Agent
-	claims []Claim
-	steps  []StepCallData
-
-	// tracking when to exit
-	claimLen, stepLen, step int
-}
-
-func NewOrchestrator(maxDepth uint64, traces []TraceProvider, names []string, agreeWithProposedOutput []bool, root Claim) Orchestrator {
-	o := Orchestrator{
-		agents: make([]Agent, len(traces)),
-		claims: []Claim{root},
-		steps:  make([]StepCallData, 0),
-	}
-	log.Info("Starting game", "root_letter", string(root.Value[31:]))
-	for i, trace := range traces {
-		o.agents[i] = NewAgent(&o, int(maxDepth), trace, &o, agreeWithProposedOutput[i], log.New("role", names[i]))
-	}
-	return o
-}
-
-func (o *Orchestrator) Respond(_ context.Context, response Claim) error {
-	response.ContractIndex = len(o.claims)
-	o.claims = append(o.claims, response)
-	return nil
-}
-
-func (o *Orchestrator) Step(_ context.Context, stepData StepCallData) error {
-	log.Info("Step recorded", "step", stepData)
-	o.steps = append(o.steps, stepData)
-	return nil
-}
-
-func (o *Orchestrator) FetchClaims(ctx context.Context) ([]Claim, error) {
-	c := make([]Claim, len(o.claims))
-	copy(c, o.claims)
-	return c, nil
-}
-
-func (o *Orchestrator) Start() {
-	for {
-		for _, a := range o.agents {
-			_ = a.Act()
-		}
-		if o.shouldExit() {
-			log.Info("exiting")
-			return
-		}
-	}
-}
-
-func (o *Orchestrator) shouldExit() bool {
-	cl := o.claimLen
-	sl := o.stepLen
-
-	o.claimLen = len(o.claims)
-	o.stepLen = len(o.steps)
-
-	noProgress := o.claimLen == cl && o.stepLen == sl
-	if noProgress {
-		o.step = o.step + 1
-	} else {
-		o.step = 0
-	}
-	return noProgress && o.step == 1
-}