Test Initcode

Documentation for test cases from tests/shanghai/eip3860_initcode/test_initcode.py.

Generate fixtures for these test cases with:

fill -v tests/shanghai/eip3860_initcode/test_initcode.py

Test EIP-3860: Limit and meter initcode

Tests for EIP-3860: Limit and meter initcode.

Tests ported from:

• ethereum/tests/pull/990
• ethereum/tests/pull/1012

test_contract_creating_tx(blockchain_test, initcode)

Test cases using a contract creating transaction

Test creating a contract using a transaction using an initcode that is on/over the max allowed limit.

Generates a BlockchainTest based on the provided initcode and its length.

Source code in tests/shanghai/eip3860_initcode/test_initcode.py

@pytest.mark.parametrize(
    "initcode",
    [
        INITCODE_ZEROS_MAX_LIMIT,
        INITCODE_ONES_MAX_LIMIT,
        INITCODE_ZEROS_OVER_LIMIT,
        INITCODE_ONES_OVER_LIMIT,
    ],
    ids=get_initcode_name,
)
def test_contract_creating_tx(blockchain_test: BlockchainTestFiller, initcode: Initcode):
    """
    Test cases using a contract creating transaction

    Test creating a contract using a transaction using an initcode that is
    on/over the max allowed limit.

    Generates a BlockchainTest based on the provided `initcode` and its
    length.
    """
    eip_3860_active = True
    env = Environment()

    pre = {
        TestAddress: Account(balance=1000000000000000000000),
    }

    post: Dict[Any, Any] = {}

    created_contract_address = compute_create_address(
        address=TestAddress,
        nonce=0,
    )

    tx = Transaction(
        nonce=0,
        to=None,
        data=initcode,
        gas_limit=10000000,
        gas_price=10,
    )

    block = Block(txs=[tx])

    if len(initcode.assemble()) > MAX_INITCODE_SIZE and eip_3860_active:
        # Initcode is above the max size, tx inclusion in the block makes
        # it invalid.
        post[created_contract_address] = Account.NONEXISTENT
        tx.error = "max initcode size exceeded"
        block.exception = "max initcode size exceeded"
    else:
        # Initcode is at or below the max size, tx inclusion in the block
        # is ok and the contract is successfully created.
        post[created_contract_address] = Account(code=Op.STOP)

    blockchain_test(
        pre=pre,
        post=post,
        blocks=[block],
        genesis_environment=env,
        tag=f"{initcode.name}",
    )

TestContractCreationGasUsage

Test EIP-3860 Limit Initcode Gas Usage for a contract creating transaction, using different initcode lengths.

Generates 4 test cases that verify the gas cost behavior of a contract creating transaction:

1. Test with exact intrinsic gas minus one, contract create fails and tx is invalid.
2. Test with exact intrinsic gas, contract create fails, but tx is valid.
3. Test with exact execution gas minus one, contract create fails, but tx is valid.
4. Test with exact execution gas, contract create succeeds.

Initcode must be within valid EIP-3860 length.

Source code in tests/shanghai/eip3860_initcode/test_initcode.py

@pytest.mark.parametrize(
    "initcode",
    [
        INITCODE_ZEROS_MAX_LIMIT,
        INITCODE_ONES_MAX_LIMIT,
        EMPTY_INITCODE,
        SINGLE_BYTE_INITCODE,
        INITCODE_ZEROS_32_BYTES,
        INITCODE_ZEROS_33_BYTES,
        INITCODE_ZEROS_49120_BYTES,
        INITCODE_ZEROS_49121_BYTES,
    ],
    ids=get_initcode_name,
)
@pytest.mark.parametrize(
    "gas_test_case",
    [
        "too_little_intrinsic_gas",
        "exact_intrinsic_gas",
        "too_little_execution_gas",
        "exact_execution_gas",
    ],
    ids=lambda x: x,
)
class TestContractCreationGasUsage:
    """
    Test EIP-3860 Limit Initcode Gas Usage for a contract
    creating transaction, using different initcode lengths.

    Generates 4 test cases that verify the gas cost behavior of a
    contract creating transaction:

    1. Test with exact intrinsic gas minus one, contract create fails
        and tx is invalid.
    2. Test with exact intrinsic gas, contract create fails,
        but tx is valid.
    3. Test with exact execution gas minus one, contract create fails,
        but tx is valid.
    4. Test with exact execution gas, contract create succeeds.

    Initcode must be within valid EIP-3860 length.
    """

    @pytest.fixture
    def eip_3860_active(self):  # noqa: D102
        return True

    @pytest.fixture
    def exact_intrinsic_gas(self, initcode, eip_3860_active):
        """
        Calculates the intrinsic tx gas cost.
        """
        return calculate_create_tx_intrinsic_cost(initcode, eip_3860_active)

    @pytest.fixture
    def exact_execution_gas(self, initcode, eip_3860_active):
        """
        Calculates the total execution gas cost.
        """
        return calculate_create_tx_execution_cost(
            initcode,
            eip_3860_active,
        )

    @pytest.fixture
    def created_contract_address(self):
        """
        Calculates the address of the contract deployed via CREATE.
        """
        return compute_create_address(
            address=TestAddress,
            nonce=0,
        )

    @pytest.fixture
    def env(self) -> Environment:  # noqa: D102
        return Environment()

    @pytest.fixture
    def pre(self) -> Dict[Any, Any]:  # noqa: D102
        return {
            TestAddress: Account(balance=1000000000000000000000),
        }

    @pytest.fixture
    def tx_error(self, gas_test_case) -> str | None:
        """
        Test that the transaction is invalid if too little intrinsic gas is
        specified, otherwise the tx succeeds.
        """
        if gas_test_case == "too_little_intrinsic_gas":
            return "intrinsic gas too low"
        return None

    @pytest.fixture
    def tx(
        self,
        gas_test_case,
        initcode,
        tx_error,
        exact_intrinsic_gas,
        exact_execution_gas,
    ) -> Transaction:
        """
        Implement the gas_test_case by setting the gas_limit of the tx
        appropriately and test whether the tx succeeds or fails with
        appropriate error.
        """
        if gas_test_case == "too_little_intrinsic_gas":
            gas_limit = exact_intrinsic_gas - 1
        elif gas_test_case == "exact_intrinsic_gas":
            gas_limit = exact_intrinsic_gas
        elif gas_test_case == "too_little_execution_gas":
            gas_limit = exact_execution_gas - 1
        elif gas_test_case == "exact_execution_gas":
            gas_limit = exact_execution_gas
        else:
            pytest.fail("Invalid gas test case provided.")

        return Transaction(
            nonce=0,
            to=None,
            data=initcode,
            gas_limit=gas_limit,
            gas_price=10,
            error=tx_error,
        )

    @pytest.fixture
    def block(self, tx, tx_error) -> Block:
        """
        Test that the tx_error is also propagated on the Block for the case of
        too little intrinsic gas.
        """
        return Block(txs=[tx], exception=tx_error)

    @pytest.fixture
    def post(
        self,
        gas_test_case,
        initcode,
        created_contract_address,
        exact_intrinsic_gas,
        exact_execution_gas,
    ) -> Dict[Any, Any]:
        """
        Test that contract creation fails unless enough execution gas is
        provided.
        """
        if gas_test_case == "exact_intrinsic_gas" and exact_intrinsic_gas == exact_execution_gas:
            # Special scenario where the execution of the initcode and
            # gas cost to deploy are zero
            return {created_contract_address: Account(code=initcode.deploy_code)}
        elif gas_test_case == "exact_execution_gas":
            return {created_contract_address: Account(code=initcode.deploy_code)}
        return {created_contract_address: Account.NONEXISTENT}

    def test_gas_usage(
        self,
        blockchain_test: BlockchainTestFiller,
        gas_test_case: str,
        initcode: Initcode,
        exact_intrinsic_gas,
        exact_execution_gas,
        env,
        pre,
        block,
        post,
    ):
        """
        Test transaction and contract creation behavior for different gas
        limits.
        """
        if (gas_test_case == "too_little_execution_gas") and (
            exact_execution_gas == exact_intrinsic_gas
        ):
            pytest.skip(
                "Special case, the execution of the initcode and gas "
                "cost to deploy are zero: Then this test case is "
                "equivalent to that of 'test_exact_intrinsic_gas'."
            )

        blockchain_test(
            pre=pre,
            post=post,
            blocks=[block],
            genesis_environment=env,
            tag=f"{initcode.name}_{gas_test_case}",
        )

test_gas_usage(blockchain_test, gas_test_case, initcode, exact_intrinsic_gas, exact_execution_gas, env, pre, block, post)

Test transaction and contract creation behavior for different gas limits.

Source code in tests/shanghai/eip3860_initcode/test_initcode.py

def test_gas_usage(
    self,
    blockchain_test: BlockchainTestFiller,
    gas_test_case: str,
    initcode: Initcode,
    exact_intrinsic_gas,
    exact_execution_gas,
    env,
    pre,
    block,
    post,
):
    """
    Test transaction and contract creation behavior for different gas
    limits.
    """
    if (gas_test_case == "too_little_execution_gas") and (
        exact_execution_gas == exact_intrinsic_gas
    ):
        pytest.skip(
            "Special case, the execution of the initcode and gas "
            "cost to deploy are zero: Then this test case is "
            "equivalent to that of 'test_exact_intrinsic_gas'."
        )

    blockchain_test(
        pre=pre,
        post=post,
        blocks=[block],
        genesis_environment=env,
        tag=f"{initcode.name}_{gas_test_case}",
    )

TestCreateInitcode

Test contract creation via the CREATE/CREATE2 opcodes that have an initcode that is on/over the max allowed limit.

Source code in tests/shanghai/eip3860_initcode/test_initcode.py

@pytest.mark.parametrize(
    "initcode",
    [
        INITCODE_ZEROS_MAX_LIMIT,
        INITCODE_ONES_MAX_LIMIT,
        INITCODE_ZEROS_OVER_LIMIT,
        INITCODE_ONES_OVER_LIMIT,
        EMPTY_INITCODE,
        SINGLE_BYTE_INITCODE,
        INITCODE_ZEROS_32_BYTES,
        INITCODE_ZEROS_33_BYTES,
        INITCODE_ZEROS_49120_BYTES,
        INITCODE_ZEROS_49121_BYTES,
    ],
    ids=get_initcode_name,
)
@pytest.mark.parametrize("opcode", [Op.CREATE, Op.CREATE2], ids=get_create_id)
class TestCreateInitcode:
    """
    Test contract creation via the CREATE/CREATE2 opcodes that have an initcode
    that is on/over the max allowed limit.
    """

    @pytest.fixture
    def create_code(self, opcode: Op, initcode: Initcode):  # noqa: D102
        if opcode == Op.CREATE:
            create_call = Op.CREATE(0, 0, Op.CALLDATASIZE)
        elif opcode == Op.CREATE2:
            create_call = Op.CREATE2(0, 0, Op.CALLDATASIZE, 0xDEADBEEF)
        else:
            raise Exception("Invalid opcode specified for test.")
        return (
            Op.CALLDATACOPY(0, 0, Op.CALLDATASIZE)
            + Op.GAS
            + create_call
            + Op.GAS
            # stack: [Gas 2, Call Result, Gas 1]
            + Op.SWAP1
            # stack: [Call Result, Gas 2, Gas 1]
            + Op.SSTORE(0)
            # stack: [Gas 2, Gas 1]
            + Op.SWAP1
            # stack: [Gas 1, Gas 2]
            + Op.SUB
            # stack: [Gas 1 - Gas 2]
            + Op.SSTORE(1)
        )

    @pytest.fixture
    def created_contract_address(self, initcode: Initcode, opcode: Op):  # noqa: D102
        if opcode == Op.CREATE:
            return compute_create_address(
                address=0x100,
                nonce=1,
            )
        if opcode == Op.CREATE2:
            return compute_create2_address(
                address=0x100,
                salt=0xDEADBEEF,
                initcode=initcode.assemble(),
            )
        raise Exception("invalid opcode for generator")

    def test_create_opcode_initcode(
        self,
        state_test: StateTestFiller,
        opcode: Op,
        initcode: Initcode,
        create_code: Yul,
        created_contract_address: str,
    ):
        """
        Test contract creation via the CREATE/CREATE2 opcodes that have an
        initcode that is on/over the max allowed limit.
        """
        eip_3860_active = True
        env = Environment()

        call_code = Op.CALLDATACOPY(0, 0, Op.CALLDATASIZE)
        call_code += Op.SSTORE(
            Op.CALL(5000000, 0x100, 0, 0, Op.CALLDATASIZE, 0, 0),
            1,
        )

        pre = {
            TestAddress: Account(balance=1000000000000000000000),
            to_address(0x100): Account(
                code=create_code,
                nonce=1,
            ),
            to_address(0x200): Account(
                code=call_code,
                nonce=1,
            ),
        }

        post: Dict[Any, Any] = {}

        tx = Transaction(
            nonce=0,
            to=to_address(0x200),
            data=initcode,
            gas_limit=10000000,
            gas_price=10,
        )

        # Calculate the expected gas of the contract creation operation
        expected_gas_usage = (
            CREATE_CONTRACT_BASE_GAS
            + GAS_OPCODE_GAS
            + (2 * PUSH_DUP_OPCODE_GAS)
            + CALLDATASIZE_OPCODE_GAS
        )
        if opcode == Op.CREATE2:
            # Extra PUSH operation
            expected_gas_usage += PUSH_DUP_OPCODE_GAS

        if len(initcode.assemble()) > MAX_INITCODE_SIZE and eip_3860_active:
            # Call returns 0 as out of gas s[0]==1
            post[to_address(0x200)] = Account(
                nonce=1,
                storage={
                    0: 1,
                    1: 0,
                },
            )

            post[created_contract_address] = Account.NONEXISTENT
            post[to_address(0x100)] = Account(
                nonce=1,
                storage={
                    0: 0,
                    1: 0,
                },
            )

        else:
            # The initcode is only executed if the length check succeeds
            expected_gas_usage += initcode.execution_gas
            # The code is only deployed if the length check succeeds
            expected_gas_usage += initcode.deployment_gas

            if opcode == Op.CREATE2:
                # CREATE2 hashing cost should only be deducted if the initcode
                # does not exceed the max length
                expected_gas_usage += calculate_create2_word_cost(len(initcode.assemble()))

            if eip_3860_active:
                # Initcode word cost is only deducted if the length check
                # succeeds
                expected_gas_usage += calculate_initcode_word_cost(len(initcode.assemble()))

            # Call returns 1 as valid initcode length s[0]==1 && s[1]==1
            post[to_address(0x200)] = Account(
                nonce=1,
                storage={
                    0: 0,
                    1: 1,
                },
            )

            post[created_contract_address] = Account(code=initcode.deploy_code)
            post[to_address(0x100)] = Account(
                nonce=2,
                storage={
                    0: created_contract_address,
                    1: expected_gas_usage,
                },
            )

        state_test(
            env=env,
            pre=pre,
            post=post,
            txs=[tx],
            tag=f"{initcode.name}_{opcode}",
        )

test_create_opcode_initcode(state_test, opcode, initcode, create_code, created_contract_address)

Test contract creation via the CREATE/CREATE2 opcodes that have an initcode that is on/over the max allowed limit.

Source code in tests/shanghai/eip3860_initcode/test_initcode.py

def test_create_opcode_initcode(
    self,
    state_test: StateTestFiller,
    opcode: Op,
    initcode: Initcode,
    create_code: Yul,
    created_contract_address: str,
):
    """
    Test contract creation via the CREATE/CREATE2 opcodes that have an
    initcode that is on/over the max allowed limit.
    """
    eip_3860_active = True
    env = Environment()

    call_code = Op.CALLDATACOPY(0, 0, Op.CALLDATASIZE)
    call_code += Op.SSTORE(
        Op.CALL(5000000, 0x100, 0, 0, Op.CALLDATASIZE, 0, 0),
        1,
    )

    pre = {
        TestAddress: Account(balance=1000000000000000000000),
        to_address(0x100): Account(
            code=create_code,
            nonce=1,
        ),
        to_address(0x200): Account(
            code=call_code,
            nonce=1,
        ),
    }

    post: Dict[Any, Any] = {}

    tx = Transaction(
        nonce=0,
        to=to_address(0x200),
        data=initcode,
        gas_limit=10000000,
        gas_price=10,
    )

    # Calculate the expected gas of the contract creation operation
    expected_gas_usage = (
        CREATE_CONTRACT_BASE_GAS
        + GAS_OPCODE_GAS
        + (2 * PUSH_DUP_OPCODE_GAS)
        + CALLDATASIZE_OPCODE_GAS
    )
    if opcode == Op.CREATE2:
        # Extra PUSH operation
        expected_gas_usage += PUSH_DUP_OPCODE_GAS

    if len(initcode.assemble()) > MAX_INITCODE_SIZE and eip_3860_active:
        # Call returns 0 as out of gas s[0]==1
        post[to_address(0x200)] = Account(
            nonce=1,
            storage={
                0: 1,
                1: 0,
            },
        )

        post[created_contract_address] = Account.NONEXISTENT
        post[to_address(0x100)] = Account(
            nonce=1,
            storage={
                0: 0,
                1: 0,
            },
        )

    else:
        # The initcode is only executed if the length check succeeds
        expected_gas_usage += initcode.execution_gas
        # The code is only deployed if the length check succeeds
        expected_gas_usage += initcode.deployment_gas

        if opcode == Op.CREATE2:
            # CREATE2 hashing cost should only be deducted if the initcode
            # does not exceed the max length
            expected_gas_usage += calculate_create2_word_cost(len(initcode.assemble()))

        if eip_3860_active:
            # Initcode word cost is only deducted if the length check
            # succeeds
            expected_gas_usage += calculate_initcode_word_cost(len(initcode.assemble()))

        # Call returns 1 as valid initcode length s[0]==1 && s[1]==1
        post[to_address(0x200)] = Account(
            nonce=1,
            storage={
                0: 0,
                1: 1,
            },
        )

        post[created_contract_address] = Account(code=initcode.deploy_code)
        post[to_address(0x100)] = Account(
            nonce=2,
            storage={
                0: created_contract_address,
                1: expected_gas_usage,
            },
        )

    state_test(
        env=env,
        pre=pre,
        post=post,
        txs=[tx],
        tag=f"{initcode.name}_{opcode}",
    )