forked from testinprod-io/op-erigon
-
Notifications
You must be signed in to change notification settings - Fork 3
/
forkdiff.yaml
181 lines (178 loc) · 9.02 KB
/
forkdiff.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
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
150
151
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
title: "op-erigon" # Define the HTML page title
footer: | # define the footer with markdown
Fork-diff overview of [op-erigon](https://github.com/testinprod-io/op-erigon), a fork of [erigon](https://github.com/ledgerwatch/erigon). and execution-engine of the [OP Stack](https://github.com/ethereum-optimism/optimism).
base:
name: ledgerwatch/erigon
url: https://github.com/ledgerwatch/erigon
ref: refs/tags/v2.43.0
fork:
name: testinprod-io/erigon
url: https://github.com/testinprod-io/op-erigon
ref: refs/heads/op-erigon
def:
title: "op-erigon"
description: | # description in markdown
This is an overview of the changes in [op-erigon](https://github.com/testinprod-io/op-erigon), a fork of [erigon](https://github.com/ledgerwatch/erigon), part of the OP Stack.
There are two more forks of erigon dependencies:
- [op-erigon-lib](./erigon-lib.html)
- [op-erigon-interfaces](./erigon-interfaces.html)
sub:
- title: "Core modifications"
sub:
- title: "State-transition modifications"
sub:
- title: "Deposit transaction type"
description: |
The Bedrock upgrade introduces a Deposit transaction-type (0x7E) to enable both users and the rollup system itself to change the L2 state based on L1 events and system rules as [specified](https://github.com/ethereum-optimism/optimism/blob/develop/specs/deposits.md).
globs:
- "core/types/deposit_tx.go"
- "core/types/transaction_marshalling.go"
- "core/types/transaction_signing.go"
- title: "Transaction properties"
description: |
The Transaction type now exposes the deposit-transaction and L1-cost properties required for the rollup.
globs:
- "core/types/access_list_tx.go"
- "core/types/dynamic_fee_tx.go"
- "core/types/legacy_tx.go"
- title: "L1 cost computation"
description: |
Transactions must pay an additional L1 cost based on the amount of rollup-data-gas they consume, estimated based on gas-price-oracle information and encoded tx size.
globs:
- "core/types/rollup_l1_cost.go"
- "core/types/transaction.go"
- "core/vm/evmtypes/evmtypes.go"
- "cmd/rpcdaemon/commands/trace_adhoc.go"
- "cmd/rpcdaemon/commands/trace_filtering.go"
- "cmd/rpcdaemon/commands/tracing.go"
- "turbo/transactions/call.go"
- "turbo/transactions/tracing.go"
- title: "Transaction processing"
description: |
Deposit transactions have special processing rules: gas is pre-paid on L1, and deposits with EVM-failure are included with rolled back changes (except mint). For regular transactions, at the end of the transition, the 1559 burn and L1 cost are routed to vaults.
globs:
- "core/state_transition.go"
- title: "Gaslimit"
description: |
Deposit transactions have special processing rules: gas is pre-paid on L1, and deposits with EVM-failure are included with rolled back changes (except mint). For regular transactions, at the end of the transition, the 1559 burn and L1 cost are routed to vaults.
globs:
- "consensus/misc/eip1559.go"
- title: "Regolith upgrade"
globs:
- "core/state_processor.go"
- title: "Chain config"
description: |
The rollup functionality is enabled with the optimism field in the chain config. The EIP-1559 parameters are configurable to adjust for faster more frequent and smaller blocks. The parameters can be overriden for testing.
globs:
- "params/protocol_params.go"
- title: "Engine API modifications"
description: |
The Engine API is extended to insert transactions into the block and optionally exclude the tx-pool, to reproduce the exact block of the sequencer from just the inputs, as derived from L1 by the rollup-node. See [L2 execution engine specs](https://github.com/ethereum-optimism/optimism/blob/develop/specs/exec-engine.md).
globs:
- "cmd/rpcdaemon/commands/engine_api.go"
- "ethdb/privateapi/ethbackend.go"
- title: "Block-building modifications"
description: |
The block-building code (in the “mining” stages because of Proof-Of-Work legacy of ethereum) implements the changes to support the transaction-inclusion, tx-pool toggle and gaslimit parameters of the Engine API.
globs:
- "cmd/integration/commands/stages.go"
- "eth/stagedsync/default_stages.go"
- "eth/stagedsync/stage_mining_create_block.go"
- "eth/stagedsync/stage_mining_exec.go"
- "eth/stagedsync/stage_mining_force_txs.go"
- "eth/stagedsync/stagebuilder.go"
- "core/block_builder_parameters.go"
- "params/mining.go"
- "core/chain_makers.go"
- "eth/stagedsync/stage_mining_exec_test.go"
- title: "Tx-pool tx cost updates"
description: |
Transaction queueing and inclusion needs to account for the L1 cost component.
globs:
- "cmd/txpool/main.go"
- title: "Node modifications"
description: |
Changes to the node configuration and services.
sub:
- title: "CLI"
sub:
- title: "Flags"
description: |
Flag changes: - Transactions can be forwarded to an RPC for sequencing. - Historical calls can be forwarded to a legacy node. - The tx pool propagation can be enabled/disabled. - The Optimism bedrock fork activation can be changed for testing.
globs:
- "cmd/utils/flags.go"
- "turbo/cli/default_flags.go"
- title: "Versioning"
description: |
List the op-geth and upstream go-ethereum versions.
globs:
- "params/version.go"
- title: "Node config"
globs:
- "eth/ethconfig/config.go"
- title: "Tx gossip disable option"
- title: "Goerli testnet configs"
globs:
- "params/config.go"
- "core/genesis.go"
- "params/networkname/network_name.go"
- title: "User API enhancements"
description: |
Encode the Deposit Tx properties, the L1 costs, and daisy-chain RPC-calls for pre-Bedrock historical data
sub:
- title: "Receipts metadata"
description: |
Pre-Bedrock L1-cost receipt data is loaded from the database if available, and post-Bedrock the L1-cost metadata is hydrated on-the-fly based on the L1 fee information in the corresponding block.
globs:
- "core/types/receipt.go"
- "core/types/receipt_test.go"
- "cmd/rpcdaemon/commands/eth_receipts.go"
- "cmd/rpcdaemon/commands/erigon_receipts_test.go"
- "accounts/abi/bind/backends/simulated.go"
- "core/rawdb/accessors_chain.go"
- "core/rawdb/accessors_chain_test.go"
- "core/rawdb/accessors_indexes.go"
- "ethdb/cbor/pool.go"
- title: "API Backend"
description: |
Forward transactions to the sequencer or historical node if configured.
globs:
- "cmd/erigon-el/backend/backend.go"
- "cmd/rpcdaemon/commands/daemon.go"
- "eth/backend.go"
- "cmd/rpcdaemon/commands/eth_accounts.go"
- "cmd/rpcdaemon/commands/eth_call.go"
- "cmd/rpcdaemon/commands/send_transaction.go"
- "rpc/errors.go"
- title: "Transaction & Block response"
description: |
Format deposit and L1-cost data in transaction responses.
globs:
- "cmd/rpcdaemon/commands/eth_api.go"
- "turbo/adapter/ethapi/api.go"
- "turbo/adapter/ethapi/internal.go"
- "cmd/rpcdaemon/commands/erigon_block.go"
- "cmd/rpcdaemon/commands/eth_block.go"
- "cmd/rpcdaemon/commands/eth_txs.go"
- "cmd/rpcdaemon/commands/eth_uncles.go"
- title: "Otterscan API"
globs:
- "cmd/rpcdaemon/commands/otterscan_api.go"
- "cmd/rpcdaemon/commands/otterscan_block_details.go"
- "cmd/rpcdaemon/commands/otterscan_contract_creator.go"
- "cmd/rpcdaemon/commands/otterscan_generic_tracer.go"
- "cmd/rpcdaemon/commands/otterscan_search_trace.go"
- title: "Generated files"
globs:
- "core/types/receipt_codecgen_gen.go"
# files can be ignored globally, these will be listed in a separate grayed-out section,
# and do not count towards the total line count.
ignore:
- "*.sum"
- ".gitignore"
- ".github/**/*"
- "Dockerfile"
- "cmd/downloader/recompress.sh"
- "cmd/downloader/torrent_hashes_update.sh"
- "README.md"
- "Makefile"