Skip to content

Test Blobhash Opcode

Documentation for tests/cancun/eip4844_blobs/test_blobhash_opcode.py.

Generate fixtures for these test cases with:

fill -v tests/cancun/eip4844_blobs/test_blobhash_opcode.py
Tests BLOBHASH opcode in EIP-4844: Shard Blob Transactions

Test cases for the BLOBHASH opcode in EIP-4844: Shard Blob Transactions.

Adding a new test

Add a function that is named test_<test_name> and takes at least the following arguments:

  • blockchain_test
  • pre
  • tx
  • post

Additional custom pytest.fixture fixtures can be added and parametrized for new test cases.

There is no specific structure to follow within this test module.

test_blobhash_gas_cost(pre, template_tx, blocks, post, tx_type, blockchain_test)

Tests BLOBHASH opcode gas cost using a variety of indexes.

Asserts that the gas consumption of the BLOBHASH opcode is correct by ensuring it matches HASH_OPCODE_GAS = 3. Includes both valid and invalid random index sizes from the range [0, 2**256-1], for tx types 2 and 3.

Source code in tests/cancun/eip4844_blobs/test_blobhash_opcode.py
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
@pytest.mark.parametrize("tx_type", [0, 1, 2, 3])
def test_blobhash_gas_cost(
    pre,
    template_tx,
    blocks,
    post,
    tx_type,
    blockchain_test: BlockchainTestFiller,
):
    """
    Tests `BLOBHASH` opcode gas cost using a variety of indexes.

    Asserts that the gas consumption of the `BLOBHASH` opcode is correct by ensuring
    it matches `HASH_OPCODE_GAS = 3`. Includes both valid and invalid random
    index sizes from the range `[0, 2**256-1]`, for tx types 2 and 3.
    """
    assert (
        Op.BLOBHASH.int() == Spec.HASH_OPCODE_BYTE
    ), "Opcodes blobhash byte doesn't match that defined in the spec"
    gas_measures_code = [
        CodeGasMeasure(
            code=Op.BLOBHASH(i),
            overhead_cost=3,
            extra_stack_items=1,
        )
        for i in blobhash_index_values
    ]
    for i, gas_code in enumerate(gas_measures_code):
        address = Address(0x100 + i * 0x100)
        pre[address] = Account(code=gas_code)
        blocks.append(
            Block(
                txs=[
                    template_tx.copy(
                        ty=tx_type,
                        nonce=i,
                        to=address,
                        gas_price=10 if tx_type < 2 else None,
                        access_list=[] if tx_type >= 1 else None,
                        max_fee_per_gas=10 if tx_type >= 2 else None,
                        max_priority_fee_per_gas=10 if tx_type >= 2 else None,
                        max_fee_per_blob_gas=10 if tx_type >= 3 else None,
                        blob_versioned_hashes=random_blob_hashes[
                            0 : SpecHelpers.target_blobs_per_block()
                        ]
                        if tx_type >= 3
                        else None,
                    )
                ]
            )
        )
        post[address] = Account(storage={0: Spec.HASH_GAS_COST})
    blockchain_test(
        pre=pre,
        blocks=blocks,
        post=post,
    )

test_blobhash_scenarios(pre, template_tx, blocks, post, scenario, blockchain_test)

Tests that the BLOBHASH opcode returns the correct versioned hash for various valid indexes.

Covers various scenarios with random blob_versioned_hash values within the valid range [0, 2**256-1].

Source code in tests/cancun/eip4844_blobs/test_blobhash_opcode.py
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
@pytest.mark.parametrize(
    "scenario",
    [
        "single_valid",
        "repeated_valid",
        "valid_invalid",
        "varied_valid",
    ],
)
def test_blobhash_scenarios(
    pre,
    template_tx,
    blocks,
    post,
    scenario: str,
    blockchain_test: BlockchainTestFiller,
):
    """
    Tests that the `BLOBHASH` opcode returns the correct versioned hash for
    various valid indexes.

    Covers various scenarios with random `blob_versioned_hash` values within
    the valid range `[0, 2**256-1]`.
    """
    TOTAL_BLOCKS = 5
    b_hashes_list = BlobhashScenario.create_blob_hashes_list(length=TOTAL_BLOCKS)
    blobhash_calls = BlobhashScenario.generate_blobhash_bytecode(scenario)
    for i in range(TOTAL_BLOCKS):
        address = Address(0x100 + i * 0x100)
        pre[address] = Account(code=blobhash_calls)
        blocks.append(
            Block(
                txs=[
                    template_tx.copy(
                        ty=Spec.BLOB_TX_TYPE,
                        nonce=i,
                        to=address,
                        access_list=[],
                        max_priority_fee_per_gas=10,
                        max_fee_per_blob_gas=10,
                        blob_versioned_hashes=b_hashes_list[i],
                    )
                ]
            )
        )
        post[address] = Account(
            storage={
                index: b_hashes_list[i][index]
                for index in range(SpecHelpers.max_blobs_per_block())
            }
        )
    blockchain_test(
        pre=pre,
        blocks=blocks,
        post=post,
    )

test_blobhash_invalid_blob_index(pre, template_tx, blocks, post, blockchain_test, scenario)

Tests that the BLOBHASH opcode returns a zeroed bytes32 value for invalid indexes.

Includes cases where the index is negative (index < 0) or exceeds the maximum number of blob_versioned_hash values stored: (index >= len(tx.message.blob_versioned_hashes)).

It confirms that the returned value is a zeroed bytes32 for each case.

Source code in tests/cancun/eip4844_blobs/test_blobhash_opcode.py
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
@pytest.mark.parametrize(
    "scenario",
    [
        "invalid_calls",
    ],
)
def test_blobhash_invalid_blob_index(
    pre,
    template_tx,
    blocks,
    post,
    blockchain_test: BlockchainTestFiller,
    scenario,
):
    """
    Tests that the `BLOBHASH` opcode returns a zeroed `bytes32` value for invalid
    indexes.

    Includes cases where the index is negative (`index < 0`) or
    exceeds the maximum number of `blob_versioned_hash` values stored:
    (`index >= len(tx.message.blob_versioned_hashes)`).

    It confirms that the returned value is a zeroed `bytes32` for each case.
    """
    TOTAL_BLOCKS = 5
    blobhash_calls = BlobhashScenario.generate_blobhash_bytecode(scenario)
    for i in range(TOTAL_BLOCKS):
        address = Address(0x100 + i * 0x100)
        pre[address] = Account(code=blobhash_calls)
        blob_per_block = (i % SpecHelpers.max_blobs_per_block()) + 1
        blobs = [random_blob_hashes[blob] for blob in range(blob_per_block)]
        blocks.append(
            Block(
                txs=[
                    template_tx.copy(
                        ty=Spec.BLOB_TX_TYPE,
                        nonce=i,
                        to=address,
                        access_list=[],
                        max_priority_fee_per_gas=10,
                        max_fee_per_blob_gas=10,
                        blob_versioned_hashes=blobs,
                    )
                ]
            )
        )
        post[address] = Account(
            storage={
                index: (0 if index < 0 or index >= blob_per_block else blobs[index])
                for index in range(
                    -TOTAL_BLOCKS,
                    blob_per_block + (TOTAL_BLOCKS - (i % SpecHelpers.max_blobs_per_block())),
                )
            }
        )
    blockchain_test(
        pre=pre,
        blocks=blocks,
        post=post,
    )

test_blobhash_multiple_txs_in_block(pre, blob_tx, post, blockchain_test)

Tests that the BLOBHASH opcode returns the appropriate values when there is more than 1 blob tx type within a block (for tx types 2 and 3).

Scenarios involve tx type 3 followed by tx type 2 running the same code within a block, including the opposite.

Source code in tests/cancun/eip4844_blobs/test_blobhash_opcode.py
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
def test_blobhash_multiple_txs_in_block(
    pre,
    blob_tx,
    post,
    blockchain_test: BlockchainTestFiller,
):
    """
    Tests that the `BLOBHASH` opcode returns the appropriate values when there
    is more than 1 blob tx type within a block (for tx types 2 and 3).

    Scenarios involve tx type 3 followed by tx type 2 running the same code
    within a block, including the opposite.
    """
    blobhash_bytecode = BlobhashScenario.generate_blobhash_bytecode("single_valid")
    pre = {
        **pre,
        **{
            Address(address): Account(code=blobhash_bytecode)
            for address in range(0x100, 0x500, 0x100)
        },
    }
    blocks = [
        Block(
            txs=[
                blob_tx(address=Address(0x100), type=3, nonce=0),
                blob_tx(address=Address(0x100), type=2, nonce=1),
            ]
        ),
        Block(
            txs=[
                blob_tx(address=Address(0x200), type=2, nonce=2),
                blob_tx(address=Address(0x200), type=3, nonce=3),
            ]
        ),
        Block(
            txs=[
                blob_tx(address=Address(0x300), type=2, nonce=4),
                blob_tx(address=Address(0x400), type=3, nonce=5),
            ],
        ),
    ]
    post = {
        Address(address): Account(
            storage={i: random_blob_hashes[i] for i in range(SpecHelpers.max_blobs_per_block())}
        )
        if address in (0x200, 0x400)
        else Account(storage={i: 0 for i in range(SpecHelpers.max_blobs_per_block())})
        for address in range(0x100, 0x500, 0x100)
    }
    blockchain_test(
        pre=pre,
        blocks=blocks,
        post=post,
    )