Documentation ¶
Index ¶
- Variables
- func ComputeL2OutputRoot(proofElements *bindings.TypesOutputRootProof) (eth.Bytes32, error)
- func L2OutputRootVersion(cfg *Config, timestamp uint64) [32]byte
- type Config
- func (cfg *Config) Check() error
- func (cfg *Config) CheckL1ChainID(ctx context.Context, client L1Client) error
- func (cfg *Config) CheckL1GenesisBlockHash(ctx context.Context, client L1Client) error
- func (cfg *Config) CheckL2ChainID(ctx context.Context, client L2Client) error
- func (cfg *Config) CheckL2GenesisBlockHash(ctx context.Context, client L2Client) error
- func (cfg *Config) ComputeTimestamp(blockNum uint64) uint64
- func (cfg *Config) Description(l2Chains map[string]string) string
- func (cfg *Config) L1Signer() types.Signer
- func (cfg *Config) LogDescription(log log.Logger, l2Chains map[string]string)
- func (cfg *Config) TargetBlockNumber(timestamp uint64) (num uint64, err error)
- func (cfg *Config) ValidateL1Config(ctx context.Context, client L1Client) error
- func (cfg *Config) ValidateL2Config(ctx context.Context, client L2Client) error
- type Epoch
- type Genesis
- type L1Client
- type L2Client
Constants ¶
This section is empty.
Variables ¶
var ( ErrNilProof = errors.New("output root proof is nil") ErrUnknownOutputRootProofVersion = errors.New("unknown output root proof version") ErrVersionNotMatched = errors.New("output root version is not matched") )
var ( ErrBlockTimeZero = errors.New("block time cannot be 0") ErrMissingChannelTimeout = errors.New("channel timeout must be set, this should cover at least a L1 block time") ErrInvalidSeqWindowSize = errors.New("sequencing window size must at least be 2") ErrMissingGenesisL1Hash = errors.New("genesis L1 hash cannot be empty") ErrMissingGenesisL2Hash = errors.New("genesis L2 hash cannot be empty") ErrGenesisHashesSame = errors.New("achievement get! rollup inception: L1 and L2 genesis cannot be the same") ErrMissingGenesisL2Time = errors.New("missing L2 genesis time") ErrMissingBatcherAddr = errors.New("missing genesis system config batcher address") ErrMissingOverhead = errors.New("missing genesis system config overhead") ErrMissingScalar = errors.New("missing genesis system config scalar") ErrMissingGasLimit = errors.New("missing genesis system config gas limit") ErrMissingBatchInboxAddress = errors.New("missing batch inbox address") ErrMissingDepositContractAddress = errors.New("missing deposit contract address") ErrMissingL1ChainID = errors.New("L1 chain ID must not be nil") ErrMissingL2ChainID = errors.New("L2 chain ID must not be nil") ErrChainIDsSame = errors.New("L1 and L2 chain IDs must be different") ErrL1ChainIDNotPositive = errors.New("L1 chain ID must be non-zero and positive") ErrL2ChainIDNotPositive = errors.New("L2 chain ID must be non-zero and positive") )
var V0 = [32]byte{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}
Functions ¶
func ComputeL2OutputRoot ¶
func ComputeL2OutputRoot(proofElements *bindings.TypesOutputRootProof) (eth.Bytes32, error)
ComputeL2OutputRoot computes the L2 output root by hashing an output root proof.
func L2OutputRootVersion ¶
Types ¶
type Config ¶
type Config struct { // Genesis anchor point of the rollup Genesis Genesis `json:"genesis"` // Seconds per L2 block BlockTime uint64 `json:"block_time"` // Sequencer batches may not be more than MaxSequencerDrift seconds after // the L1 timestamp of the sequencing window end. // // Note: When L1 has many 1 second consecutive blocks, and L2 grows at fixed 2 seconds, // the L2 time may still grow beyond this difference. MaxSequencerDrift uint64 `json:"max_sequencer_drift"` // Number of epochs (L1 blocks) per sequencing window, including the epoch L1 origin block itself SeqWindowSize uint64 `json:"seq_window_size"` // Number of L1 blocks between when a channel can be opened and when it must be closed by. ChannelTimeout uint64 `json:"channel_timeout"` // Required to verify L1 signatures L1ChainID *big.Int `json:"l1_chain_id"` // Required to identify the L2 network and create p2p signatures unique for this chain. L2ChainID *big.Int `json:"l2_chain_id"` // L1 address that batches are sent to. BatchInboxAddress common.Address `json:"batch_inbox_address"` // L1 Deposit Contract Address DepositContractAddress common.Address `json:"deposit_contract_address"` // L1 System Config Address L1SystemConfigAddress common.Address `json:"l1_system_config_address"` }
func (*Config) CheckL1ChainID ¶
CheckL1ChainID checks that the configured L1 chain ID matches the client's chain ID.
func (*Config) CheckL1GenesisBlockHash ¶
CheckL1GenesisBlockHash checks that the configured L1 genesis block hash is valid for the given client.
func (*Config) CheckL2ChainID ¶
CheckL2ChainID checks that the configured L2 chain ID matches the client's chain ID.
func (*Config) CheckL2GenesisBlockHash ¶
CheckL2GenesisBlockHash checks that the configured L2 genesis block hash is valid for the given client.
func (*Config) ComputeTimestamp ¶
func (*Config) Description ¶
Description outputs a banner describing the important parts of rollup configuration in a human-readable form. Optionally provide a mapping of L2 chain IDs to network names to label the L2 chain with if not unknown. The config should be config.Check()-ed before creating a description.
func (*Config) LogDescription ¶
LogDescription outputs a banner describing the important parts of rollup configuration in a log format. Optionally provide a mapping of L2 chain IDs to network names to label the L2 chain with if not unknown. The config should be config.Check()-ed before creating a description.
func (*Config) TargetBlockNumber ¶
func (*Config) ValidateL1Config ¶
ValidateL1Config checks L1 config variables for errors.
type Genesis ¶
type Genesis struct { // The L1 block that the rollup starts *after* (no derived transactions) L1 eth.BlockID `json:"l1"` // The L2 block the rollup starts from (no transactions, pre-configured state) L2 eth.BlockID `json:"l2"` // Timestamp of L2 block L2Time uint64 `json:"l2_time"` // Initial system configuration values. // The L2 genesis block may not include transactions, and thus cannot encode the config values, // unlike later L2 blocks. SystemConfig eth.SystemConfig `json:"system_config"` }
Directories ¶
Path | Synopsis |
---|---|
Package derive provides the data transformation functions that take L1 data and turn it into L2 blocks and results.
|
Package derive provides the data transformation functions that take L1 data and turn it into L2 blocks and results. |
Package sync is responsible for reconciling L1 and L2.
|
Package sync is responsible for reconciling L1 and L2. |