Test Tstorage

Documentation for tests/cancun/eip1153_tstore/test_tstorage.py.

Generate fixtures for these test cases with:

fill -v tests/cancun/eip1153_tstore/test_tstorage.py

Tests EIP-1153: Transient Storage Opcodes

Test EIP-1153: Transient Storage Opcodes. Ports and extends some tests from ethereum/tests/src/EIPTestsFiller/StateTests/stEIP1153-transientStorage/

test_transient_storage_unset_values(state_test)

Test that tload returns zero for unset values. Loading an arbitrary value is 0 at beginning of transaction: TLOAD(x) is 0.

Based on ethereum/tests/.../01_tloadBeginningTxnFiller.yml", # noqa: E501

Source code in tests/cancun/eip1153_tstore/test_tstorage.py

def test_transient_storage_unset_values(state_test: StateTestFiller):
    """
    Test that tload returns zero for unset values. Loading an arbitrary value is
    0 at beginning of transaction: TLOAD(x) is 0.

    Based on [ethereum/tests/.../01_tloadBeginningTxnFiller.yml](https://github.com/ethereum/tests/blob/9b00b68593f5869eb51a6659e1cc983e875e616b/src/EIPTestsFiller/StateTests/stEIP1153-transientStorage/01_tloadBeginningTxnFiller.yml)",  # noqa: E501
    """
    env = Environment()

    slots_under_test = [0, 1, 2, 2**128, 2**256 - 1]
    code = sum(Op.SSTORE(slot, Op.TLOAD(slot)) for slot in slots_under_test)

    pre = {
        TestAddress: Account(balance=10_000_000),
        code_address: Account(code=code, storage={slot: 1 for slot in slots_under_test}),
    }

    tx = Transaction(
        to=code_address,
        data=b"",
        gas_limit=1_000_000,
    )

    post = {code_address: Account(storage={slot: 0 for slot in slots_under_test})}

    state_test(
        env=env,
        pre=pre,
        post=post,
        tx=tx,
    )

test_tload_after_tstore(state_test)

Loading after storing returns the stored value: TSTORE(x, y), TLOAD(x) returns y.

Based on ethereum/tests/.../02_tloadAfterTstoreFiller.yml", # noqa: E501

Source code in tests/cancun/eip1153_tstore/test_tstorage.py

def test_tload_after_tstore(state_test: StateTestFiller):
    """
    Loading after storing returns the stored value: TSTORE(x, y), TLOAD(x)
    returns y.

    Based on [ethereum/tests/.../02_tloadAfterTstoreFiller.yml](https://github.com/ethereum/tests/blob/9b00b68593f5869eb51a6659e1cc983e875e616b/src/EIPTestsFiller/StateTests/stEIP1153-transientStorage/02_tloadAfterTstoreFiller.yml)",  # noqa: E501
    """
    env = Environment()

    slots_under_test = [0, 1, 2, 2**128, 2**256 - 1]
    code = sum(
        Op.TSTORE(slot, slot) + Op.SSTORE(slot, Op.TLOAD(slot)) for slot in slots_under_test
    )

    pre = {
        TestAddress: Account(balance=10_000_000),
        code_address: Account(code=code, storage={slot: 0xFF for slot in slots_under_test}),
    }

    tx = Transaction(
        to=code_address,
        data=b"",
        gas_limit=1_000_000,
    )

    post = {code_address: Account(storage={slot: slot for slot in slots_under_test})}

    state_test(
        env=env,
        pre=pre,
        post=post,
        tx=tx,
    )

test_tload_after_sstore(state_test)

Loading after storing returns the stored value: TSTORE(x, y), TLOAD(x) returns y.

Based on ethereum/tests/.../18_tloadAfterStoreFiller.yml", # noqa: E501

Source code in tests/cancun/eip1153_tstore/test_tstorage.py

def test_tload_after_sstore(state_test: StateTestFiller):
    """
    Loading after storing returns the stored value: TSTORE(x, y), TLOAD(x)
    returns y.

    Based on [ethereum/tests/.../18_tloadAfterStoreFiller.yml](https://github.com/ethereum/tests/blob/9b00b68593f5869eb51a6659e1cc983e875e616b/src/EIPTestsFiller/StateTests/stEIP1153-transientStorage/18_tloadAfterStoreFiller.yml)",  # noqa: E501
    """
    env = Environment()

    slots_under_test = [1, 3, 2**128, 2**256 - 1]
    code = sum(
        Op.SSTORE(slot - 1, 0xFF) + Op.SSTORE(slot, Op.TLOAD(slot - 1))
        for slot in slots_under_test
    )

    pre = {
        TestAddress: Account(balance=10_000_000),
        code_address: Account(code=code, storage={slot: 1 for slot in slots_under_test}),
    }

    tx = Transaction(
        to=code_address,
        data=b"",
        gas_limit=1_000_000,
    )

    post = {
        code_address: Account(
            code=code,
            storage={slot - 1: 0xFF for slot in slots_under_test}
            | {slot: 0 for slot in slots_under_test},
        )
    }

    state_test(
        env=env,
        pre=pre,
        post=post,
        tx=tx,
    )

test_tload_after_tstore_is_zero(state_test)

Test that tload returns zero after tstore is called with zero.

Based on ethereum/tests/.../03_tloadAfterStoreIs0Filler.yml", # noqa: E501

Source code in tests/cancun/eip1153_tstore/test_tstorage.py

def test_tload_after_tstore_is_zero(state_test: StateTestFiller):
    """
    Test that tload returns zero after tstore is called with zero.

    Based on [ethereum/tests/.../03_tloadAfterStoreIs0Filler.yml](https://github.com/ethereum/tests/blob/9b00b68593f5869eb51a6659e1cc983e875e616b/src/EIPTestsFiller/StateTests/stEIP1153-transientStorage/03_tloadAfterStoreIs0Filler.yml)",  # noqa: E501
    """
    env = Environment()

    slots_to_write = [1, 4, 2**128, 2**256 - 2]
    slots_to_read = [slot - 1 for slot in slots_to_write] + [slot + 1 for slot in slots_to_write]
    assert set.intersection(set(slots_to_write), set(slots_to_read)) == set()

    code = sum(Op.TSTORE(slot, 1234) for slot in slots_to_write) + sum(
        Op.SSTORE(slot, Op.TLOAD(slot)) for slot in slots_to_read
    )

    pre = {
        TestAddress: Account(balance=10_000_000),
        code_address: Account(
            code=code, storage={slot: 0xFFFF for slot in slots_to_write + slots_to_read}
        ),
    }

    tx = Transaction(
        to=code_address,
        data=b"",
        gas_limit=1_000_000,
    )

    post = {
        code_address: Account(
            storage={slot: 0 for slot in slots_to_read} | {slot: 0xFFFF for slot in slots_to_write}
        )
    }

    state_test(
        env=env,
        pre=pre,
        post=post,
        tx=tx,
    )

test_gas_usage(state_test, bytecode, expected_gas, overhead_cost, extra_stack_items)

Test that tstore and tload consume the expected gas.

Source code in tests/cancun/eip1153_tstore/test_tstorage.py

@GasMeasureTestCases.parametrize()
def test_gas_usage(
    state_test: StateTestFiller,
    bytecode: Bytecode,
    expected_gas: int,
    overhead_cost: int,
    extra_stack_items: int,
):
    """
    Test that tstore and tload consume the expected gas.
    """
    gas_measure_bytecode = CodeGasMeasure(
        code=bytecode, overhead_cost=overhead_cost, extra_stack_items=extra_stack_items
    )

    env = Environment()
    pre = {
        TestAddress: Account(balance=10_000_000, nonce=0),
        code_address: Account(code=gas_measure_bytecode),
    }
    tx = Transaction(
        to=code_address,
        data=b"",
        gas_limit=1_000_000,
    )
    post = {
        code_address: Account(code=gas_measure_bytecode, storage={0: expected_gas}),
        TestAddress: Account(nonce=1),
    }
    state_test(env=env, pre=pre, tx=tx, post=post)

test_run_until_out_of_gas(state_test, repeat_bytecode, bytecode_repeat_times)

Use TSTORE over and over to different keys until we run out of gas.

Source code in tests/cancun/eip1153_tstore/test_tstorage.py

@LoopRunUntilOutOfGasCases.parametrize()
def test_run_until_out_of_gas(
    state_test: StateTestFiller,
    repeat_bytecode: Bytecode,
    bytecode_repeat_times: int,
):
    """
    Use TSTORE over and over to different keys until we run out of gas.
    """
    bytecode = Op.JUMPDEST + repeat_bytecode * bytecode_repeat_times + Op.JUMP(Op.PUSH0)
    pre = {
        TestAddress: Account(balance=10_000_000_000_000, nonce=0),
        code_address: Account(code=bytecode),
    }
    tx = Transaction(
        to=code_address,
        data=b"",
        gas_limit=30_000_000,
    )
    post = {
        code_address: Account(code=bytecode, storage={}),
        TestAddress: Account(nonce=1),
    }
    state_test(env=Environment(), pre=pre, tx=tx, post=post)