frontend

package

v1.11.0 Latest Latest Go to latest Published: Feb 10, 2025 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/ethereum-optimism/optimism

Links

Open Source Insights

Documentation ¶

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type AdminBackend ¶

type AdminBackend interface {
	Start(ctx context.Context) error
	Stop(ctx context.Context) error
	AddL2RPC(ctx context.Context, rpc string, jwtSecret eth.Bytes32) error
}

type AdminFrontend ¶

type AdminFrontend struct {
	Supervisor Backend
}

func (*AdminFrontend) AddL2RPC ¶ added in v1.9.3

func (a *AdminFrontend) AddL2RPC(ctx context.Context, rpc string, jwtSecret eth.Bytes32) error

AddL2RPC adds a new L2 chain to the supervisor backend

func (*AdminFrontend) Start ¶

func (a *AdminFrontend) Start(ctx context.Context) error

Start starts the service, if it was previously stopped.

func (*AdminFrontend) Stop ¶

func (a *AdminFrontend) Stop(ctx context.Context) error

Stop stops the service, if it was previously started.

type Backend ¶

type Backend interface {
	AdminBackend
	QueryBackend
}

type QueryBackend ¶

type QueryBackend interface {
	CheckMessage(identifier types.Identifier, payloadHash common.Hash) (types.SafetyLevel, error)
	CheckMessages(messages []types.Message, minSafety types.SafetyLevel) error
	CrossDerivedToSource(ctx context.Context, chainID eth.ChainID, derived eth.BlockID) (derivedFrom eth.BlockRef, err error)
	LocalUnsafe(ctx context.Context, chainID eth.ChainID) (eth.BlockID, error)
	CrossSafe(ctx context.Context, chainID eth.ChainID) (types.DerivedIDPair, error)
	Finalized(ctx context.Context, chainID eth.ChainID) (eth.BlockID, error)
	FinalizedL1() eth.BlockRef
	SuperRootAtTimestamp(ctx context.Context, timestamp hexutil.Uint64) (eth.SuperRootResponse, error)
	SyncStatus() (eth.SupervisorSyncStatus, error)
	AllSafeDerivedAt(ctx context.Context, derivedFrom eth.BlockID) (derived map[eth.ChainID]eth.BlockID, err error)
}

type QueryFrontend ¶

type QueryFrontend struct {
	Supervisor QueryBackend
}

func (*QueryFrontend) AllSafeDerivedAt ¶ added in v1.11.0

func (q *QueryFrontend) AllSafeDerivedAt(ctx context.Context, derivedFrom eth.BlockID) (derived map[eth.ChainID]eth.BlockID, err error)

func (*QueryFrontend) CheckMessage ¶

func (q *QueryFrontend) CheckMessage(identifier types.Identifier, payloadHash common.Hash) (types.SafetyLevel, error)

CheckMessage checks the safety-level of an individual message. The payloadHash references the hash of the message-payload of the message.

func (*QueryFrontend) CheckMessages ¶ added in v1.9.1

func (q *QueryFrontend) CheckMessages(
	messages []types.Message,
	minSafety types.SafetyLevel) error

CheckMessages checks the safety-level of a collection of messages, and returns if the minimum safety-level is met for all messages.

func (*QueryFrontend) CrossDerivedFrom ¶ added in v1.9.5

func (q *QueryFrontend) CrossDerivedFrom(ctx context.Context, chainID eth.ChainID, derived eth.BlockID) (derivedFrom eth.BlockRef, err error)

CrossDerivedFrom is deprecated, but remains for backwards compatibility to callers it is equivalent to CrossDerivedToSource

func (*QueryFrontend) CrossDerivedToSource ¶ added in v1.11.0

func (q *QueryFrontend) CrossDerivedToSource(ctx context.Context, chainID eth.ChainID, derived eth.BlockID) (derivedFrom eth.BlockRef, err error)

func (*QueryFrontend) CrossSafe ¶ added in v1.11.0

func (q *QueryFrontend) CrossSafe(ctx context.Context, chainID eth.ChainID) (types.DerivedIDPair, error)

func (*QueryFrontend) Finalized ¶ added in v1.9.5

func (q *QueryFrontend) Finalized(ctx context.Context, chainID eth.ChainID) (eth.BlockID, error)

func (*QueryFrontend) FinalizedL1 ¶ added in v1.11.0

func (q *QueryFrontend) FinalizedL1() eth.BlockRef

func (*QueryFrontend) LocalUnsafe ¶ added in v1.11.0

func (q *QueryFrontend) LocalUnsafe(ctx context.Context, chainID eth.ChainID) (eth.BlockID, error)

func (*QueryFrontend) SuperRootAtTimestamp ¶ added in v1.11.0

func (q *QueryFrontend) SuperRootAtTimestamp(ctx context.Context, timestamp hexutil.Uint64) (eth.SuperRootResponse, error)

func (*QueryFrontend) SyncStatus ¶ added in v1.11.0

func (q *QueryFrontend) SyncStatus() (eth.SupervisorSyncStatus, error)

Source Files ¶

View all Source files

frontend.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL