Skip to content

Commit

Permalink
feat(op-challenger): Split Preimage Uploader Wiring (ethereum-optimis…
Browse files Browse the repository at this point in the history 
…m#9023)

* feat(op-challenger): large preimage uploader

* feat(op-challenger): split preimage wiring
  • Loading branch information
@refcell
refcell authored Jan 17, 2024
1 parent 247225b commit 7ccb26b
Show file tree
Hide file tree
Showing 3 changed files with 66 additions and 29 deletions.
7 changes: 6 additions & 1 deletion op-challenger/game/fault/player.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import (
"context"
"fmt"

"github.com/ethereum-optimism/optimism/op-challenger/game/fault/preimages"
"github.com/ethereum-optimism/optimism/op-challenger/game/fault/responder"
"github.com/ethereum-optimism/optimism/op-challenger/game/fault/types"
gameTypes "github.com/ethereum-optimism/optimism/op-challenger/game/types"
Expand Down Expand Up @@ -80,7 +81,11 @@ func NewGamePlayer(
return nil, fmt.Errorf("failed to create trace accessor: %w", err)
}

responder, err := responder.NewFaultResponder(logger, txMgr, loader)
direct := preimages.NewDirectPreimageUploader(logger, txMgr, loader)
large := preimages.NewLargePreimageUploader(logger, txMgr, loader)
uploader := preimages.NewSplitPreimageUploader(direct, large)

responder, err := responder.NewFaultResponder(logger, txMgr, loader, uploader)
if err != nil {
return nil, fmt.Errorf("failed to create the responder: %w", err)
}
Expand Down
4 changes: 2 additions & 2 deletions op-challenger/game/fault/responder/responder.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,12 @@ type FaultResponder struct {
}

// NewFaultResponder returns a new [FaultResponder].
func NewFaultResponder(logger log.Logger, txMgr txmgr.TxManager, contract GameContract) (*FaultResponder, error) {
func NewFaultResponder(logger log.Logger, txMgr txmgr.TxManager, contract GameContract, uploader preimages.PreimageUploader) (*FaultResponder, error) {
return &FaultResponder{
log: logger,
txMgr: txMgr,
contract: contract,
uploader: preimages.NewDirectPreimageUploader(logger, txMgr, contract),
uploader: uploader,
}, nil
}

Expand Down
84 changes: 58 additions & 26 deletions op-challenger/game/fault/responder/responder_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,15 @@ import (
)

var (
mockSendError = errors.New("mock send error")
mockCallError = errors.New("mock call error")
mockPreimageUploadErr = errors.New("mock preimage upload error")
mockSendError = errors.New("mock send error")
mockCallError = errors.New("mock call error")
)

// TestCallResolve tests the [Responder.CallResolve].
func TestCallResolve(t *testing.T) {
t.Run("SendFails", func(t *testing.T) {
responder, _, contract := newTestFaultResponder(t)
responder, _, contract, _ := newTestFaultResponder(t)
contract.callFails = true
status, err := responder.CallResolve(context.Background())
require.ErrorIs(t, err, mockCallError)
Expand All @@ -35,7 +36,7 @@ func TestCallResolve(t *testing.T) {
})

t.Run("Success", func(t *testing.T) {
responder, _, contract := newTestFaultResponder(t)
responder, _, contract, _ := newTestFaultResponder(t)
status, err := responder.CallResolve(context.Background())
require.NoError(t, err)
require.Equal(t, gameTypes.GameStatusInProgress, status)
Expand All @@ -46,15 +47,15 @@ func TestCallResolve(t *testing.T) {
// TestResolve tests the [Responder.Resolve] method.
func TestResolve(t *testing.T) {
t.Run("SendFails", func(t *testing.T) {
responder, mockTxMgr, _ := newTestFaultResponder(t)
responder, mockTxMgr, _, _ := newTestFaultResponder(t)
mockTxMgr.sendFails = true
err := responder.Resolve(context.Background())
require.ErrorIs(t, err, mockSendError)
require.Equal(t, 0, mockTxMgr.sends)
})

t.Run("Success", func(t *testing.T) {
responder, mockTxMgr, _ := newTestFaultResponder(t)
responder, mockTxMgr, _, _ := newTestFaultResponder(t)
err := responder.Resolve(context.Background())
require.NoError(t, err)
require.Equal(t, 1, mockTxMgr.sends)
Expand All @@ -63,15 +64,15 @@ func TestResolve(t *testing.T) {

func TestCallResolveClaim(t *testing.T) {
t.Run("SendFails", func(t *testing.T) {
responder, _, contract := newTestFaultResponder(t)
responder, _, contract, _ := newTestFaultResponder(t)
contract.callFails = true
err := responder.CallResolveClaim(context.Background(), 0)
require.ErrorIs(t, err, mockCallError)
require.Equal(t, 0, contract.calls)
})

t.Run("Success", func(t *testing.T) {
responder, _, contract := newTestFaultResponder(t)
responder, _, contract, _ := newTestFaultResponder(t)
err := responder.CallResolveClaim(context.Background(), 0)
require.NoError(t, err)
require.Equal(t, 1, contract.calls)
Expand All @@ -80,15 +81,15 @@ func TestCallResolveClaim(t *testing.T) {

func TestResolveClaim(t *testing.T) {
t.Run("SendFails", func(t *testing.T) {
responder, mockTxMgr, _ := newTestFaultResponder(t)
responder, mockTxMgr, _, _ := newTestFaultResponder(t)
mockTxMgr.sendFails = true
err := responder.ResolveClaim(context.Background(), 0)
require.ErrorIs(t, err, mockSendError)
require.Equal(t, 0, mockTxMgr.sends)
})

t.Run("Success", func(t *testing.T) {
responder, mockTxMgr, _ := newTestFaultResponder(t)
responder, mockTxMgr, _, _ := newTestFaultResponder(t)
err := responder.ResolveClaim(context.Background(), 0)
require.NoError(t, err)
require.Equal(t, 1, mockTxMgr.sends)
Expand All @@ -98,7 +99,7 @@ func TestResolveClaim(t *testing.T) {
// TestRespond tests the [Responder.Respond] method.
func TestPerformAction(t *testing.T) {
t.Run("send fails", func(t *testing.T) {
responder, mockTxMgr, _ := newTestFaultResponder(t)
responder, mockTxMgr, _, _ := newTestFaultResponder(t)
mockTxMgr.sendFails = true
err := responder.PerformAction(context.Background(), types.Action{
Type: types.ActionTypeMove,
Expand All @@ -111,7 +112,7 @@ func TestPerformAction(t *testing.T) {
})

t.Run("sends response", func(t *testing.T) {
responder, mockTxMgr, _ := newTestFaultResponder(t)
responder, mockTxMgr, _, _ := newTestFaultResponder(t)
err := responder.PerformAction(context.Background(), types.Action{
Type: types.ActionTypeMove,
ParentIdx: 123,
Expand All @@ -123,7 +124,7 @@ func TestPerformAction(t *testing.T) {
})

t.Run("attack", func(t *testing.T) {
responder, mockTxMgr, contract := newTestFaultResponder(t)
responder, mockTxMgr, contract, _ := newTestFaultResponder(t)
action := types.Action{
Type: types.ActionTypeMove,
ParentIdx: 123,
Expand All @@ -139,7 +140,7 @@ func TestPerformAction(t *testing.T) {
})

t.Run("defend", func(t *testing.T) {
responder, mockTxMgr, contract := newTestFaultResponder(t)
responder, mockTxMgr, contract, _ := newTestFaultResponder(t)
action := types.Action{
Type: types.ActionTypeMove,
ParentIdx: 123,
Expand All @@ -155,7 +156,7 @@ func TestPerformAction(t *testing.T) {
})

t.Run("step", func(t *testing.T) {
responder, mockTxMgr, contract := newTestFaultResponder(t)
responder, mockTxMgr, contract, _ := newTestFaultResponder(t)
action := types.Action{
Type: types.ActionTypeStep,
ParentIdx: 123,
Expand All @@ -172,7 +173,7 @@ func TestPerformAction(t *testing.T) {
})

t.Run("stepWithOracleData", func(t *testing.T) {
responder, mockTxMgr, contract := newTestFaultResponder(t)
responder, mockTxMgr, contract, uploader := newTestFaultResponder(t)
action := types.Action{
Type: types.ActionTypeStep,
ParentIdx: 123,
Expand All @@ -186,23 +187,54 @@ func TestPerformAction(t *testing.T) {
err := responder.PerformAction(context.Background(), action)
require.NoError(t, err)

require.Len(t, mockTxMgr.sent, 2)
require.EqualValues(t, action.OracleData, contract.updateOracleArgs)
require.EqualValues(t, action.ParentIdx, contract.updateOracleClaimIdx)
require.EqualValues(t, []interface{}{uint64(action.ParentIdx), action.IsAttack, action.PreState, action.ProofData}, contract.stepArgs)
// Important that the oracle is updated first
require.Equal(t, ([]byte)("updateOracle"), mockTxMgr.sent[0].TxData)
require.Equal(t, ([]byte)("step"), mockTxMgr.sent[1].TxData)
require.Len(t, mockTxMgr.sent, 1)
require.Nil(t, contract.updateOracleArgs) // mock uploader returns nil
require.Equal(t, ([]byte)("step"), mockTxMgr.sent[0].TxData)
require.Equal(t, 1, uploader.updates)
})

t.Run("stepWithOracleDataAndUploadFails", func(t *testing.T) {
responder, mockTxMgr, contract, uploader := newTestFaultResponder(t)
uploader.uploadFails = true
action := types.Action{
Type: types.ActionTypeStep,
ParentIdx: 123,
IsAttack: true,
PreState: []byte{1, 2, 3},
ProofData: []byte{4, 5, 6},
OracleData: &types.PreimageOracleData{
IsLocal: true,
},
}
err := responder.PerformAction(context.Background(), action)
require.ErrorIs(t, err, mockPreimageUploadErr)
require.Len(t, mockTxMgr.sent, 0)
require.Nil(t, contract.updateOracleArgs) // mock uploader returns nil
require.Equal(t, 1, uploader.updates)
})
}

func newTestFaultResponder(t *testing.T) (*FaultResponder, *mockTxManager, *mockContract) {
func newTestFaultResponder(t *testing.T) (*FaultResponder, *mockTxManager, *mockContract, *mockPreimageUploader) {
log := testlog.Logger(t, log.LvlError)
mockTxMgr := &mockTxManager{}
contract := &mockContract{}
responder, err := NewFaultResponder(log, mockTxMgr, contract)
uploader := &mockPreimageUploader{}
responder, err := NewFaultResponder(log, mockTxMgr, contract, uploader)
require.NoError(t, err)
return responder, mockTxMgr, contract
return responder, mockTxMgr, contract, uploader
}

type mockPreimageUploader struct {
updates int
uploadFails bool
}

func (m *mockPreimageUploader) UploadPreimage(ctx context.Context, parent uint64, data *types.PreimageOracleData) error {
m.updates++
if m.uploadFails {
return mockPreimageUploadErr
}
return nil
}

type mockTxManager struct {
Expand Down

0 comments on commit 7ccb26b

Please sign in to comment.