test_multi_block_beacon_root_timestamp_calls()

Documentation for tests/cancun/eip4788_beacon_root/test_beacon_root_contract.py::test_multi_block_beacon_root_timestamp_calls@88e9fb8f.

Generate fixtures for these test cases for Osaka with:

fill -v tests/cancun/eip4788_beacon_root/test_beacon_root_contract.py::test_multi_block_beacon_root_timestamp_calls --fork Osaka

Tests multiple blocks where each block writes a timestamp to storage and contains one transaction that calls the beacon root contract multiple times.

The blocks might overwrite the historical roots buffer, or not, depending on the timestamps, and whether they increment in multiples of Spec.HISTORY_BUFFER_LENGTH or not.

By default, the beacon roots are the keccak of the block number.

Each transaction checks the current timestamp and also all previous timestamps, and verifies that the beacon root is correct for all of them if the timestamp is supposed to be in the buffer, which might have been overwritten by a later block.

Source code in tests/cancun/eip4788_beacon_root/test_beacon_root_contract.py

@pytest.mark.parametrize(
    "timestamps_factory",
    [
        pytest.param(
            count_factory(
                start=Spec.HISTORY_BUFFER_LENGTH - 5,
                step=1,
            ),
            id="buffer_wraparound",
        ),
        pytest.param(
            count_factory(
                start=12,
                step=Spec.HISTORY_BUFFER_LENGTH,
            ),
            id="buffer_wraparound_overwrite",
        ),
        pytest.param(
            count_factory(
                start=2**32,
                step=Spec.HISTORY_BUFFER_LENGTH,
            ),
            id="buffer_wraparound_overwrite_high_timestamp",
        ),
        pytest.param(
            count_factory(
                start=5,
                step=Spec.HISTORY_BUFFER_LENGTH - 1,
            ),
            id="buffer_wraparound_no_overwrite",
        ),
        pytest.param(
            count_factory(
                start=Spec.HISTORY_BUFFER_LENGTH - 3,
                step=Spec.HISTORY_BUFFER_LENGTH + 1,
            ),
            id="buffer_wraparound_no_overwrite_2",
        ),
    ],
)
@pytest.mark.parametrize("block_count", [10])  # All tests use 10 blocks
@pytest.mark.valid_from("Cancun")
def test_multi_block_beacon_root_timestamp_calls(
    blockchain_test: BlockchainTestFiller,
    pre: Alloc,
    timestamps_factory: Callable[[], Iterator[int]],
    beacon_roots: Iterator[bytes],
    block_count: int,
    call_gas: int,
    call_value: int,
) -> None:
    """
    Tests multiple blocks where each block writes a timestamp to storage and
    contains one transaction that calls the beacon root contract multiple
    times.

    The blocks might overwrite the historical roots buffer, or not, depending
    on the `timestamps`, and whether they increment in multiples of
    `Spec.HISTORY_BUFFER_LENGTH` or not.

    By default, the beacon roots are the keccak of the block number.

    Each transaction checks the current timestamp and also all previous
    timestamps, and verifies that the beacon root is correct for all of them if
    the timestamp is supposed to be in the buffer, which might have been
    overwritten by a later block.
    """
    # Create fresh iterator to avoid state persistence between test phases
    timestamps = timestamps_factory()

    blocks: List[Block] = []
    post = {}

    timestamps_storage: Dict[int, int] = {}
    roots_storage: Dict[int, bytes] = {}

    all_timestamps: List[int] = []

    sender = pre.fund_eoa()

    for timestamp, beacon_root, _i in zip(
        timestamps,
        beacon_roots,
        range(block_count),
        strict=False,
    ):
        timestamp_index = timestamp % Spec.HISTORY_BUFFER_LENGTH
        timestamps_storage[timestamp_index] = timestamp
        roots_storage[timestamp_index] = beacon_root

        all_timestamps.append(timestamp)

        withdraw_index = count(0)

        current_call_account_code = Bytecode()
        current_call_account_expected_storage = Storage()

        # We are going to call the beacon roots contract once for every
        # timestamp of the current and all previous blocks, and check that the
        # returned beacon root is still correct only if it was not overwritten.
        for t in all_timestamps:
            current_call_account_code += Op.MSTORE(0, t)
            call_valid = (
                timestamp_index in timestamps_storage
                and timestamps_storage[t % Spec.HISTORY_BUFFER_LENGTH] == t
            )
            current_call_account_code += Op.SSTORE(
                current_call_account_expected_storage.store_next(0x01 if call_valid else 0x00),
                Op.CALL(
                    call_gas,
                    Spec.BEACON_ROOTS_ADDRESS,
                    call_value,
                    0x00,
                    0x20,
                    0x20,
                    0x20,
                ),
            )

            current_call_account_code += Op.SSTORE(
                current_call_account_expected_storage.store_next(
                    roots_storage[t % Spec.HISTORY_BUFFER_LENGTH] if call_valid else 0x00
                ),
                Op.MLOAD(0x20),
            )

        current_call_account_address = pre.deploy_contract(current_call_account_code)

        post[current_call_account_address] = Account(
            storage=current_call_account_expected_storage,
        )
        blocks.append(
            Block(
                txs=[
                    Transaction(
                        sender=sender,
                        to=current_call_account_address,
                        data=Hash(timestamp),
                        gas_limit=1_000_000,
                    )
                ],
                parent_beacon_block_root=beacon_root,
                timestamp=timestamp,
                withdrawals=[
                    # Also withdraw to the beacon root contract and the system
                    # address
                    Withdrawal(
                        address=Spec.BEACON_ROOTS_ADDRESS,
                        amount=1,
                        index=next(withdraw_index),
                        validator_index=0,
                    ),
                    Withdrawal(
                        address=Spec.SYSTEM_ADDRESS,
                        amount=1,
                        index=next(withdraw_index),
                        validator_index=1,
                    ),
                ],
            )
        )

    blockchain_test(
        pre=pre,
        blocks=blocks,
        post=post,
    )

Parametrized Test Cases

The interactive table below is also available as a standalone page.

Fork All Forks Cancun Prague Osaka

Fixture Type All Fixture Types blockchain_test

Test ID (Abbreviated)	block_count	timestamps_factory
...fork_Cancun-blockchain_test-block_count_10-buffer_wraparound	10	. at 0x7feba3248a40>
...fork_Cancun-blockchain_test-block_count_10-buffer_wraparound_overwrite	10	. at 0x7feba3248ae0>
...fork_Cancun-blockchain_test-block_count_10-buffer_wraparound_overwrite_high_timestamp	10	. at 0x7feba3248b80>
...fork_Cancun-blockchain_test-block_count_10-buffer_wraparound_no_overwrite	10	. at 0x7feba3248c20>
...fork_Cancun-blockchain_test-block_count_10-buffer_wraparound_no_overwrite_2	10	. at 0x7feba3248cc0>
...fork_Prague-blockchain_test-block_count_10-buffer_wraparound	10	. at 0x7feba3248a40>
...fork_Prague-blockchain_test-block_count_10-buffer_wraparound_overwrite	10	. at 0x7feba3248ae0>
...fork_Prague-blockchain_test-block_count_10-buffer_wraparound_overwrite_high_timestamp	10	. at 0x7feba3248b80>
...fork_Prague-blockchain_test-block_count_10-buffer_wraparound_no_overwrite	10	. at 0x7feba3248c20>
...fork_Prague-blockchain_test-block_count_10-buffer_wraparound_no_overwrite_2	10	. at 0x7feba3248cc0>
...fork_Osaka-blockchain_test-block_count_10-buffer_wraparound	10	. at 0x7feba3248a40>
...fork_Osaka-blockchain_test-block_count_10-buffer_wraparound_overwrite	10	. at 0x7feba3248ae0>
...fork_Osaka-blockchain_test-block_count_10-buffer_wraparound_overwrite_high_timestamp	10	. at 0x7feba3248b80>
...fork_Osaka-blockchain_test-block_count_10-buffer_wraparound_no_overwrite	10	. at 0x7feba3248c20>
...fork_Osaka-blockchain_test-block_count_10-buffer_wraparound_no_overwrite_2	10	. at 0x7feba3248cc0>