Skip to content

Commit 2c48d3a

Browse files
committed
Add docs for eth_simulateV1
1 parent 95109af commit 2c48d3a

File tree

1 file changed

+70
-0
lines changed

1 file changed

+70
-0
lines changed

docs/web3.eth.rst

+70
Original file line numberDiff line numberDiff line change
@@ -947,6 +947,76 @@ The following methods are available on the ``web3.eth`` namespace.
947947
can be accessed via the ``data`` attribute on ``ContractLogicError``.
948948

949949

950+
.. py:method:: Eth.simulateV1(payload, block_identifier)
951+
952+
* Delegates to ``eth_simulateV1`` RPC Method
953+
954+
Executes a simulation for the given payload at the given block. Returns the simulation results.
955+
956+
.. code-block:: python
957+
958+
>>> w3.eth.simulateV1(
959+
... {
960+
... "blockStateCalls": [
961+
... {
962+
... "blockOverrides": {
963+
... "baseFeePerGas": Wei(10),
964+
... },
965+
... "stateOverrides": {
966+
... "0xc100000000000000000000000000000000000000": {
967+
... "balance": Wei(500000000),
968+
... }
969+
... },
970+
... "calls": [
971+
... {
972+
... "from": "0xc100000000000000000000000000000000000000",
973+
... "to": "0xc100000000000000000000000000000000000000",
974+
... "maxFeePerGas": Wei(10),
975+
... "maxPriorityFeePerGas": Wei(10),
976+
... }
977+
... ],
978+
... }
979+
... ],
980+
... "validation": True,
981+
... "traceTransfers": True,
982+
... },
983+
... "latest",
984+
... )
985+
[AttributeDict({
986+
'baseFeePerGas': 10,
987+
'blobGasUsed': 0,
988+
'calls': [AttributeDict({
989+
'returnData': HexBytes('0x'),
990+
'logs': [],
991+
'gasUsed': 21000,
992+
'status': 1
993+
})],
994+
'difficulty': 0,
995+
'excessBlobGas': 0,
996+
'extraData': HexBytes('0x'),
997+
'gasLimit': 983527531,
998+
'gasUsed': 21000,
999+
'hash': HexBytes('0xb2dba64c905dea42e940d67b8e0f44019f4a61c4833a9cba99c426b748d9e1a4'),
1000+
'logsBloom': HexBytes('0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000'),
1001+
'miner': '0x0000000000000000000000000000000000000000',
1002+
'mixHash': HexBytes('0x0000000000000000000000000000000000000000000000000000000000000000'),
1003+
'nonce': HexBytes('0x0000000000000000'),
1004+
'number': 18,
1005+
'parentBeaconBlockRoot': HexBytes('0x0000000000000000000000000000000000000000000000000000000000000000'),
1006+
'parentHash': HexBytes('0x71d32db179a1291de86b5f7fa15224292ef9ee6ebb3fa62484896601d9f20d5f'),
1007+
'receiptsRoot': HexBytes('0xf78dfb743fbd92ade140711c8bbc542b5e307f0ab7984eff35d751969fe57efa'),
1008+
'sha3Uncles': HexBytes('0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347'),
1009+
'size': 626,
1010+
'stateRoot': HexBytes('0xbbbe846b616911d13780f58f500f8948e0878ba6f55cae7432da915cab3ba2b6'),
1011+
'timestamp': 1739921487,
1012+
'transactions': [HexBytes('0xfd801060af398c615f1ffb61586604aaf4fc688615cb1ff088531638a9b9e8e6')],
1013+
'transactionsRoot': HexBytes('0xa6bc01d7707e94b62dccb8d097df1db25d6b44fad35463ecc99c9e5822e7aa5f'),
1014+
'uncles': [],
1015+
'withdrawals': [],
1016+
'withdrawalsRoot': HexBytes('0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421')
1017+
})]
1018+
1019+
9501020
.. py:method:: Eth.create_access_list(transaction, block_identifier=web3.eth.default_block)
9511021
9521022
* Delegates to ``eth_createAccessList`` RPC Method

0 commit comments

Comments
 (0)