17 KiB
ScrollChain
ScrollChain
This contract maintains data for the Scroll rollup.
Methods
addProver
function addProver(address _account) external nonpayable
Add an account to the prover list.
Parameters
| Name | Type | Description |
|---|---|---|
| _account | address | The address of account to add. |
addSequencer
function addSequencer(address _account) external nonpayable
Add an account to the sequencer list.
Parameters
| Name | Type | Description |
|---|---|---|
| _account | address | The address of account to add. |
commitBatch
function commitBatch(uint8 _version, bytes _parentBatchHeader, bytes[] _chunks, bytes _skippedL1MessageBitmap) external nonpayable
Commit a batch of transactions on layer 1.
Parameters
| Name | Type | Description |
|---|---|---|
| _version | uint8 | undefined |
| _parentBatchHeader | bytes | undefined |
| _chunks | bytes[] | undefined |
| _skippedL1MessageBitmap | bytes | undefined |
committedBatches
function committedBatches(uint256) external view returns (bytes32)
Return the batch hash of a committed batch.
Parameters
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | undefined |
Returns
| Name | Type | Description |
|---|---|---|
| _0 | bytes32 | undefined |
finalizeBatch
function finalizeBatch(bytes _batchHeader, bytes32 _prevStateRoot, bytes32 _postStateRoot, bytes32 _withdrawRoot) external nonpayable
Finalize a committed batch on layer 1 without providing proof.
Parameters
| Name | Type | Description |
|---|---|---|
| _batchHeader | bytes | undefined |
| _prevStateRoot | bytes32 | undefined |
| _postStateRoot | bytes32 | undefined |
| _withdrawRoot | bytes32 | undefined |
finalizeBatch4844
function finalizeBatch4844(bytes _batchHeader, bytes32 _prevStateRoot, bytes32 _postStateRoot, bytes32 _withdrawRoot, bytes _blobDataProof) external nonpayable
Finalize a committed batch (with blob) on layer 1 without providing proof.
Parameters
| Name | Type | Description |
|---|---|---|
| _batchHeader | bytes | undefined |
| _prevStateRoot | bytes32 | undefined |
| _postStateRoot | bytes32 | undefined |
| _withdrawRoot | bytes32 | undefined |
| _blobDataProof | bytes | undefined |
finalizeBatchWithProof
function finalizeBatchWithProof(bytes _batchHeader, bytes32 _prevStateRoot, bytes32 _postStateRoot, bytes32 _withdrawRoot, bytes _aggrProof) external nonpayable
Finalize a committed batch on layer 1.
We keep this function to upgrade to 4844 more smoothly.
Parameters
| Name | Type | Description |
|---|---|---|
| _batchHeader | bytes | undefined |
| _prevStateRoot | bytes32 | undefined |
| _postStateRoot | bytes32 | undefined |
| _withdrawRoot | bytes32 | undefined |
| _aggrProof | bytes | undefined |
finalizeBatchWithProof4844
function finalizeBatchWithProof4844(bytes _batchHeader, bytes32 _prevStateRoot, bytes32 _postStateRoot, bytes32 _withdrawRoot, bytes _blobDataProof, bytes _aggrProof) external nonpayable
Finalize a committed batch (with blob) on layer 1.
Memory layout of _blobDataProof: text | z | y | kzg_commitment | kzg_proof | |---------|---------|----------------|-----------| | bytes32 | bytes32 | bytes48 | bytes48 |
Parameters
| Name | Type | Description |
|---|---|---|
| _batchHeader | bytes | undefined |
| _prevStateRoot | bytes32 | undefined |
| _postStateRoot | bytes32 | undefined |
| _withdrawRoot | bytes32 | undefined |
| _blobDataProof | bytes | undefined |
| _aggrProof | bytes | undefined |
finalizedStateRoots
function finalizedStateRoots(uint256) external view returns (bytes32)
Return the state root of a committed batch.
Parameters
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | undefined |
Returns
| Name | Type | Description |
|---|---|---|
| _0 | bytes32 | undefined |
importGenesisBatch
function importGenesisBatch(bytes _batchHeader, bytes32 _stateRoot) external nonpayable
Import layer 2 genesis block
Parameters
| Name | Type | Description |
|---|---|---|
| _batchHeader | bytes | undefined |
| _stateRoot | bytes32 | undefined |
initialize
function initialize(address _messageQueue, address _verifier, uint256 _maxNumTxInChunk) external nonpayable
Initialize the storage of ScrollChain.
The parameters _messageQueue are no longer used.
Parameters
| Name | Type | Description |
|---|---|---|
| _messageQueue | address | The address of L1MessageQueue contract. |
| _verifier | address | The address of zkevm verifier contract. |
| _maxNumTxInChunk | uint256 | The maximum number of transactions allowed in each chunk. |
isBatchFinalized
function isBatchFinalized(uint256 _batchIndex) external view returns (bool)
Return whether the batch is finalized by batch index.
Parameters
| Name | Type | Description |
|---|---|---|
| _batchIndex | uint256 | undefined |
Returns
| Name | Type | Description |
|---|---|---|
| _0 | bool | undefined |
isProver
function isProver(address) external view returns (bool)
Whether an account is a prover.
Parameters
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
Returns
| Name | Type | Description |
|---|---|---|
| _0 | bool | undefined |
isSequencer
function isSequencer(address) external view returns (bool)
Whether an account is a sequencer.
Parameters
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
Returns
| Name | Type | Description |
|---|---|---|
| _0 | bool | undefined |
lastFinalizedBatchIndex
function lastFinalizedBatchIndex() external view returns (uint256)
The latest finalized batch index.
Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | undefined |
layer2ChainId
function layer2ChainId() external view returns (uint64)
The chain id of the corresponding layer 2 chain.
Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint64 | undefined |
maxNumTxInChunk
function maxNumTxInChunk() external view returns (uint256)
The maximum number of transactions allowed in each chunk.
Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | undefined |
messageQueue
function messageQueue() external view returns (address)
The address of L1MessageQueue contract.
Returns
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
owner
function owner() external view returns (address)
Returns the address of the current owner.
Returns
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
paused
function paused() external view returns (bool)
Returns true if the contract is paused, and false otherwise.
Returns
| Name | Type | Description |
|---|---|---|
| _0 | bool | undefined |
removeProver
function removeProver(address _account) external nonpayable
Add an account from the prover list.
Parameters
| Name | Type | Description |
|---|---|---|
| _account | address | The address of account to remove. |
removeSequencer
function removeSequencer(address _account) external nonpayable
Remove an account from the sequencer list.
Parameters
| Name | Type | Description |
|---|---|---|
| _account | address | The address of account to remove. |
renounceOwnership
function renounceOwnership() external nonpayable
Leaves the contract without owner. It will not be possible to call onlyOwner functions. Can only be called by the current owner. NOTE: Renouncing ownership will leave the contract without an owner, thereby disabling any functionality that is only available to the owner.
revertBatch
function revertBatch(bytes _batchHeader, uint256 _count) external nonpayable
Revert a pending batch.
If the owner want to revert a sequence of batches by sending multiple transactions, make sure to revert recent batches first.
Parameters
| Name | Type | Description |
|---|---|---|
| _batchHeader | bytes | undefined |
| _count | uint256 | undefined |
setPause
function setPause(bool _status) external nonpayable
Pause the contract
Parameters
| Name | Type | Description |
|---|---|---|
| _status | bool | The pause status to update. |
transferOwnership
function transferOwnership(address newOwner) external nonpayable
Transfers ownership of the contract to a new account (newOwner). Can only be called by the current owner.
Parameters
| Name | Type | Description |
|---|---|---|
| newOwner | address | undefined |
updateMaxNumTxInChunk
function updateMaxNumTxInChunk(uint256 _maxNumTxInChunk) external nonpayable
Update the value of maxNumTxInChunk.
Parameters
| Name | Type | Description |
|---|---|---|
| _maxNumTxInChunk | uint256 | The new value of maxNumTxInChunk. |
verifier
function verifier() external view returns (address)
The address of RollupVerifier.
Returns
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
withdrawRoots
function withdrawRoots(uint256) external view returns (bytes32)
Return the message root of a committed batch.
Parameters
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | undefined |
Returns
| Name | Type | Description |
|---|---|---|
| _0 | bytes32 | undefined |
Events
CommitBatch
event CommitBatch(uint256 indexed batchIndex, bytes32 indexed batchHash)
Emitted when a new batch is committed.
Parameters
| Name | Type | Description |
|---|---|---|
batchIndex indexed |
uint256 | The index of the batch. |
batchHash indexed |
bytes32 | The hash of the batch. |
FinalizeBatch
event FinalizeBatch(uint256 indexed batchIndex, bytes32 indexed batchHash, bytes32 stateRoot, bytes32 withdrawRoot)
Emitted when a batch is finalized.
Parameters
| Name | Type | Description |
|---|---|---|
batchIndex indexed |
uint256 | The index of the batch. |
batchHash indexed |
bytes32 | The hash of the batch |
| stateRoot | bytes32 | The state root on layer 2 after this batch. |
| withdrawRoot | bytes32 | The merkle root on layer2 after this batch. |
Initialized
event Initialized(uint8 version)
Triggered when the contract has been initialized or reinitialized.
Parameters
| Name | Type | Description |
|---|---|---|
| version | uint8 | undefined |
OwnershipTransferred
event OwnershipTransferred(address indexed previousOwner, address indexed newOwner)
Parameters
| Name | Type | Description |
|---|---|---|
previousOwner indexed |
address | undefined |
newOwner indexed |
address | undefined |
Paused
event Paused(address account)
Emitted when the pause is triggered by account.
Parameters
| Name | Type | Description |
|---|---|---|
| account | address | undefined |
RevertBatch
event RevertBatch(uint256 indexed batchIndex, bytes32 indexed batchHash)
revert a pending batch.
Parameters
| Name | Type | Description |
|---|---|---|
batchIndex indexed |
uint256 | The index of the batch. |
batchHash indexed |
bytes32 | The hash of the batch |
Unpaused
event Unpaused(address account)
Emitted when the pause is lifted by account.
Parameters
| Name | Type | Description |
|---|---|---|
| account | address | undefined |
UpdateMaxNumTxInChunk
event UpdateMaxNumTxInChunk(uint256 oldMaxNumTxInChunk, uint256 newMaxNumTxInChunk)
Emitted when the value of maxNumTxInChunk is updated.
Parameters
| Name | Type | Description |
|---|---|---|
| oldMaxNumTxInChunk | uint256 | The old value of maxNumTxInChunk. |
| newMaxNumTxInChunk | uint256 | The new value of maxNumTxInChunk. |
UpdateProver
event UpdateProver(address indexed account, bool status)
Emitted when owner updates the status of prover.
Parameters
| Name | Type | Description |
|---|---|---|
account indexed |
address | The address of account updated. |
| status | bool | The status of the account updated. |
UpdateSequencer
event UpdateSequencer(address indexed account, bool status)
Emitted when owner updates the status of sequencer.
Parameters
| Name | Type | Description |
|---|---|---|
account indexed |
address | The address of account updated. |
| status | bool | The status of the account updated. |
Errors
ErrorAccountIsNotEOA
error ErrorAccountIsNotEOA()
Thrown when the given account is not EOA account.
ErrorBatchHeaderLengthTooSmall
error ErrorBatchHeaderLengthTooSmall()
Thrown when the length of batch header is smaller than 89
ErrorBatchIsAlreadyCommitted
error ErrorBatchIsAlreadyCommitted()
Thrown when committing a committed batch.
ErrorBatchIsAlreadyVerified
error ErrorBatchIsAlreadyVerified()
Thrown when finalizing a verified batch.
ErrorBatchIsEmpty
error ErrorBatchIsEmpty()
Thrown when committing empty batch (batch without chunks)
ErrorCallPointEvaluationPrecompileFailed
error ErrorCallPointEvaluationPrecompileFailed()
Thrown when call precompile failed.
ErrorCallerIsNotProver
error ErrorCallerIsNotProver()
Thrown when the caller is not prover.
ErrorCallerIsNotSequencer
error ErrorCallerIsNotSequencer()
Thrown when the caller is not sequencer.
ErrorFoundMultipleBlob
error ErrorFoundMultipleBlob()
Thrown when the transaction has multiple blobs.
ErrorGenesisBatchHasNonZeroField
error ErrorGenesisBatchHasNonZeroField()
Thrown when some fields are not zero in genesis batch.
ErrorGenesisBatchImported
error ErrorGenesisBatchImported()
Thrown when importing genesis batch twice.
ErrorGenesisDataHashIsZero
error ErrorGenesisDataHashIsZero()
Thrown when data hash in genesis batch is zero.
ErrorGenesisParentBatchHashIsNonZero
error ErrorGenesisParentBatchHashIsNonZero()
Thrown when the parent batch hash in genesis batch is zero.
ErrorIncompleteL2TransactionData
error ErrorIncompleteL2TransactionData()
Thrown when the l2 transaction is incomplete.
ErrorIncorrectBatchHash
error ErrorIncorrectBatchHash()
Thrown when the batch hash is incorrect.
ErrorIncorrectBatchIndex
error ErrorIncorrectBatchIndex()
Thrown when the batch index is incorrect.
ErrorIncorrectBitmapLength
error ErrorIncorrectBitmapLength()
Thrown when the bitmap length is incorrect.
ErrorIncorrectChunkLength
error ErrorIncorrectChunkLength()
Thrown when the length of chunk is incorrect.
ErrorIncorrectPreviousStateRoot
error ErrorIncorrectPreviousStateRoot()
Thrown when the previous state root doesn't match stored one.
ErrorInvalidBatchHeaderVersion
error ErrorInvalidBatchHeaderVersion()
Thrown when the batch header version is invalid.
ErrorLastL1MessageSkipped
error ErrorLastL1MessageSkipped()
Thrown when the last message is skipped.
ErrorNoBlobFound
error ErrorNoBlobFound()
Thrown when no blob found in the transaction.
ErrorNoBlockInChunk
error ErrorNoBlockInChunk()
Thrown when no blocks in chunk.
ErrorNumTxsLessThanNumL1Msgs
error ErrorNumTxsLessThanNumL1Msgs()
Thrown when the number of transactions is less than number of L1 message in one block.
ErrorPreviousStateRootIsZero
error ErrorPreviousStateRootIsZero()
Thrown when the given previous state is zero.
ErrorRevertFinalizedBatch
error ErrorRevertFinalizedBatch()
Thrown when reverting a finialized batch.
ErrorRevertNotStartFromEnd
error ErrorRevertNotStartFromEnd()
Thrown when the reverted batches are not in the ending of commited batch chain.
ErrorRevertZeroBatches
error ErrorRevertZeroBatches()
Thrown when the number of batches to revert is zero.
ErrorStateRootIsZero
error ErrorStateRootIsZero()
Thrown when the given state root is zero.
ErrorTooManyTxsInOneChunk
error ErrorTooManyTxsInOneChunk()
Thrown when a chunk contains too many transactions.
ErrorUnexpectedPointEvaluationPrecompileOutput
error ErrorUnexpectedPointEvaluationPrecompileOutput()
Thrown when the precompile output is incorrect.
ErrorZeroAddress
error ErrorZeroAddress()
Thrown when the given address is address(0).