IStateCommitmentChain
IStateCommitmentChain
Methods
appendStateBatch
function appendStateBatch(bytes32[] _batch, uint256 _shouldStartAtElement) external nonpayableAppends a batch of state roots to the chain.
Parameters
| Name | Type | Description |
|---|---|---|
| _batch | bytes32[] | Batch of state roots. |
| _shouldStartAtElement | uint256 | Index of the element at which this batch should start. |
deleteStateBatch
function deleteStateBatch(Lib_OVMCodec.ChainBatchHeader _batchHeader) external nonpayableDeletes all state roots after (and including) a given batch.
Parameters
| Name | Type | Description |
|---|---|---|
| _batchHeader | Lib_OVMCodec.ChainBatchHeader | Header of the batch to start deleting from. |
getLastSequencerTimestamp
function getLastSequencerTimestamp() external view returns (uint256 _lastSequencerTimestamp)Retrieves the timestamp of the last batch submitted by the sequencer.
Returns
| Name | Type | Description |
|---|---|---|
| _lastSequencerTimestamp | uint256 | Last sequencer batch timestamp. |
getTotalBatches
function getTotalBatches() external view returns (uint256 _totalBatches)Retrieves the total number of batches submitted.
Returns
| Name | Type | Description |
|---|---|---|
| _totalBatches | uint256 | Total submitted batches. |
getTotalElements
function getTotalElements() external view returns (uint256 _totalElements)Retrieves the total number of elements submitted.
Returns
| Name | Type | Description |
|---|---|---|
| _totalElements | uint256 | Total submitted elements. |
insideFraudProofWindow
function insideFraudProofWindow(Lib_OVMCodec.ChainBatchHeader _batchHeader) external view returns (bool _inside)Checks whether a given batch is still inside its fraud proof window.
Parameters
| Name | Type | Description |
|---|---|---|
| _batchHeader | Lib_OVMCodec.ChainBatchHeader | Header of the batch to check. |
Returns
| Name | Type | Description |
|---|---|---|
| _inside | bool | Whether or not the batch is inside the fraud proof window. |
verifyStateCommitment
function verifyStateCommitment(bytes32 _element, Lib_OVMCodec.ChainBatchHeader _batchHeader, Lib_OVMCodec.ChainInclusionProof _proof) external view returns (bool _verified)Verifies a batch inclusion proof.
Parameters
| Name | Type | Description |
|---|---|---|
| _element | bytes32 | Hash of the element to verify a proof for. |
| _batchHeader | Lib_OVMCodec.ChainBatchHeader | Header of the batch in which the element was included. |
| _proof | Lib_OVMCodec.ChainInclusionProof | Merkle inclusion proof for the element. |
Returns
| Name | Type | Description |
|---|---|---|
| _verified | bool | Whether or not the batch inclusion proof is verified. |
Events
StateBatchAppended
event StateBatchAppended(uint256 indexed _batchIndex, bytes32 _batchRoot, uint256 _batchSize, uint256 _prevTotalElements, bytes _extraData)Parameters
| Name | Type | Description |
|---|---|---|
_batchIndex indexed
|
uint256 | undefined |
| _batchRoot | bytes32 | undefined |
| _batchSize | uint256 | undefined |
| _prevTotalElements | uint256 | undefined |
| _extraData | bytes | undefined |
StateBatchDeleted
event StateBatchDeleted(uint256 indexed _batchIndex, bytes32 _batchRoot)Parameters
| Name | Type | Description |
|---|---|---|
_batchIndex indexed
|
uint256 | undefined |
| _batchRoot | bytes32 | undefined |