Documentation
¶
Index ¶
- Constants
- Variables
- type Interop
- func (i *Interop) CurrentL1() eth.BlockID
- func (i *Interop) LatestVerifiedL2Block(chainID eth.ChainID) (eth.BlockID, uint64)
- func (i *Interop) Name() string
- func (i *Interop) PauseAt(ts uint64)
- func (i *Interop) Reset(chainID eth.ChainID, timestamp uint64, invalidatedBlock eth.BlockRef)
- func (i *Interop) Resume()
- func (i *Interop) Start(ctx context.Context) error
- func (i *Interop) Stop(ctx context.Context) error
- func (i *Interop) VerifiedAtTimestamp(ts uint64) (bool, error)
- type LogsDB
- type Result
- type VerifiedDB
- func (v *VerifiedDB) Close() error
- func (v *VerifiedDB) Commit(result VerifiedResult) error
- func (v *VerifiedDB) Get(ts uint64) (VerifiedResult, error)
- func (v *VerifiedDB) Has(ts uint64) (bool, error)
- func (v *VerifiedDB) LastTimestamp() (uint64, bool)
- func (v *VerifiedDB) Rewind(timestamp uint64) (bool, error)
- func (v *VerifiedDB) RewindAfter(timestamp uint64) (bool, error)
- type VerifiedResult
Constants ¶
const ExpiryTime = 604800
ExpiryTime is the maximum age of an initiating message that can be executed. Messages older than this are considered expired and invalid. 7 days = 7 * 24 * 60 * 60 = 604800 seconds
Variables ¶
var ( // ErrUnknownChain is returned when an executing message references // a chain that is not registered with the interop activity. ErrUnknownChain = errors.New("unknown chain") // ErrTimestampViolation is returned when an executing message references // an initiating message with a timestamp >= the executing message's timestamp. ErrTimestampViolation = errors.New("initiating message timestamp must be less than executing message timestamp") // ErrMessageExpired is returned when an executing message references // an initiating message that has expired (older than ExpiryTime). ErrMessageExpired = errors.New("initiating message has expired") )
var ( // ErrPreviousTimestampNotSealed is returned when loadLogs is called but the // previous timestamp has not been sealed in the logsDB. ErrPreviousTimestampNotSealed = errors.New("previous timestamp not sealed in logsDB") // ErrParentHashMismatch is returned when the block's parent hash does not match // the hash of the last sealed block in the logsDB. ErrParentHashMismatch = errors.New("block parent hash does not match logsDB") )
var ( ErrNotFound = errors.New("timestamp not found") ErrNonSequential = errors.New("timestamps must be committed sequentially with no gaps") ErrAlreadyCommitted = errors.New("timestamp already committed") )
var InteropActivationTimestampFlag = &cli.Uint64Flag{
Name: "interop.activation-timestamp",
Usage: "The timestamp at which interop should start",
Value: 0,
}
InteropActivationTimestampFlag is the CLI flag for the interop activation timestamp.
Functions ¶
This section is empty.
Types ¶
type Interop ¶
type Interop struct {
// contains filtered or unexported fields
}
Interop is a VerificationActivity that can also run background work as a RunnableActivity.
func New ¶
func New( log log.Logger, activationTimestamp uint64, chains map[eth.ChainID]cc.ChainContainer, dataDir string, ) *Interop
New constructs a new Interop activity.
func (*Interop) CurrentL1 ¶
CurrentL1 returns the L1 block which has been fully considered for interop, whether or not it advanced the verified timestamp.
func (*Interop) LatestVerifiedL2Block ¶
LatestVerifiedL3Block returns the latest L2 block which has been verified, along with the timestamp at which it was verified.
func (*Interop) PauseAt ¶
PauseAt sets a timestamp at which the interop activity should pause. When progressInterop encounters this timestamp or any later timestamp, it returns early without processing. Uses >= check so that if the activity is already beyond the pause point, it will still stop. This function is for integration test control only. Pass 0 to clear the pause (equivalent to calling Resume).
func (*Interop) Reset ¶
Reset is called when a chain container resets due to an invalidated block. It prunes the logsDB and verifiedDB for that chain at and after the timestamp. The invalidatedBlock contains the block info that triggered the reset.
func (*Interop) Resume ¶
func (i *Interop) Resume()
Resume clears any pause timestamp, allowing normal processing to continue. This function is for integration test control only.
func (*Interop) Start ¶
Start begins the Interop activity background loop and blocks until ctx is canceled.
func (*Interop) VerifiedAtTimestamp ¶
VerifiedAtTimestamp returns whether the data is verified at the given timestamp. For timestamps before the activation timestamp, this returns true since interop wasn't active yet and verification proceeds automatically. For timestamps at or after the activation timestamp, this checks the verifiedDB.
type LogsDB ¶
type LogsDB interface {
// LatestSealedBlock returns the latest sealed block ID, or false if no blocks are sealed.
LatestSealedBlock() (eth.BlockID, bool)
// FirstSealedBlock returns the first block seal in the DB.
FirstSealedBlock() (types.BlockSeal, error)
// FindSealedBlock returns the block seal for the given block number.
FindSealedBlock(number uint64) (types.BlockSeal, error)
// OpenBlock returns the block reference, log count, and executing messages for a block.
OpenBlock(blockNum uint64) (ref eth.BlockRef, logCount uint32, execMsgs map[uint32]*types.ExecutingMessage, err error)
// Contains checks if an initiating message exists in the database.
// Returns the block seal if found, or an error (ErrConflict if not found, ErrFuture if not yet indexed).
Contains(query types.ContainsQuery) (types.BlockSeal, error)
// AddLog adds a log entry to the database.
AddLog(logHash common.Hash, parentBlock eth.BlockID, logIdx uint32, execMsg *types.ExecutingMessage) error
// SealBlock seals a block in the database.
SealBlock(parentHash common.Hash, block eth.BlockID, timestamp uint64) error
// Rewind removes all blocks after newHead from the database.
Rewind(inv reads.Invalidator, newHead eth.BlockID) error
// Clear removes all data from the database.
Clear(inv reads.Invalidator) error
// Close closes the database.
Close() error
}
LogsDB is the interface for interacting with a chain's logs database. *logs.DB implements this interface.
type Result ¶
type Result struct {
Timestamp uint64 `json:"timestamp"`
L1Head eth.BlockID `json:"l1Head"`
L2Heads map[eth.ChainID]eth.BlockID `json:"l2Heads"`
InvalidHeads map[eth.ChainID]eth.BlockID `json:"invalidHeads"`
}
Result represents the result of interop validation at a specific timestamp given current data. it contains all the same information as VerifiedResult, but also contains a list of invalid heads.
func (*Result) ToVerifiedResult ¶
func (r *Result) ToVerifiedResult() VerifiedResult
type VerifiedDB ¶
type VerifiedDB struct {
// contains filtered or unexported fields
}
VerifiedDB provides persistence for verified timestamps using bbolt.
func OpenVerifiedDB ¶
func OpenVerifiedDB(dataDir string) (*VerifiedDB, error)
OpenVerifiedDB opens or creates a VerifiedDB at the given data directory.
func (*VerifiedDB) Commit ¶
func (v *VerifiedDB) Commit(result VerifiedResult) error
Commit stores a verified result at the given timestamp. Timestamps must be committed sequentially with no gaps.
func (*VerifiedDB) Get ¶
func (v *VerifiedDB) Get(ts uint64) (VerifiedResult, error)
Get retrieves the verified result at the given timestamp.
func (*VerifiedDB) Has ¶
func (v *VerifiedDB) Has(ts uint64) (bool, error)
Has returns whether a timestamp has been verified.
func (*VerifiedDB) LastTimestamp ¶
func (v *VerifiedDB) LastTimestamp() (uint64, bool)
LastTimestamp returns the most recently committed timestamp. Returns 0 and false if no timestamps have been committed.
func (*VerifiedDB) Rewind ¶
func (v *VerifiedDB) Rewind(timestamp uint64) (bool, error)
Rewind removes all verified results at or after the given timestamp. Returns true if any results were deleted, false otherwise.
func (*VerifiedDB) RewindAfter ¶
func (v *VerifiedDB) RewindAfter(timestamp uint64) (bool, error)
RewindAfter removes all verified results after the given timestamp.
type VerifiedResult ¶
type VerifiedResult struct {
Timestamp uint64 `json:"timestamp"`
L1Head eth.BlockID `json:"l1Head"`
L2Heads map[eth.ChainID]eth.BlockID `json:"l2Heads"`
}
VerifiedResult represents the verified state at a specific timestamp. It contains the L1 head from which the L2 heads were derived, and a map of each chain's L2 head at that timestamp.
Source Files