Implement EIP-1559 for XDC chain

[gzliudan]

Implement EIP-1559 for XDC chain

Authors: Dan Liu, XDC Protocol Team

Update date: 2024-06-28

1. Context

EIP-1559 is the fee market change for ETH 1.0 chain. It is requested by many third-party software now. To enhance user experiencet, the xdc chain should also support EIP-1559. We propose this plan to achieve this goal.

2. Methodology

There are two methods to implement the EIP-1559:

• method 1: fully implement the mechanism of EIP-1559
• method 2: only implement the external API and interface of EIP-1559 by fixed data

Here's a brief comparison:

method	1	2
complexity	high	low
workload	heavy	light
gas price	dynamic	fixed
miner rewards	decrease	not changed

There may be unpredictable risks if we choose the first method, since there are many difference between ethereum and xdc blockchain. So we choose the second method for safety and efficiency.

3. Detailed Operations

According to the official EIP list:

• EIP-1559 requires: EIP-2718, EIP-2930.
• EIP-2930 requires: EIP-2718, EIP-2929.

So we should implement the below EIPs:

• EIP-2718: Typed Transaction Envelope
• EIP-2929: Gas cost increases for state access opcodes
• EIP-2930: Optional access lists
• EIP-1559: Fee market change for ETH 1.0 chain

We picked the PRs from ethereum, and apply them one by one according to the actual situation.

4. Develop schedule

We will work from the latest commit of the dev-upgrade branch. Each PR will also be merged into the dev-upgrade branch.

In terms of role, Dan Liu and the protocol team will develop the code. Gerui Wang and Liam Lai will review and test all the PRs.

4.1 upgrade tx pool

10 work days:

no	PR	subject	status	PR
1	ethereum#16494	core: txpool stable underprice drop order, perf fixes	done	#528
2	ethereum#16446	build: enable goimports and varcheck linters	skip
3	ethereum#16576	core: ensure local transactions aren't discarded as underpriced	done	#528
4	ethereum#16720	all: collate new transaction events together	skip
5	ethereum#16670	core: use a wrapped map to remove contention in TxPool.Get.	done	#528
6	ethereum#16843	core: fix transaction event asynchronicity	done	#528
7	ethereum#16882	core: concurrent background transaction sender ecrecover	done	#528
8	ethereum#16853	params: fix golint warnings	skip
9	ethereum#16963	core: change comment to match code more closely	done	#528
10	ethereum#16980	core: reduce nesting in transaction pool code	done	#528
11	ethereum#17214	core: fix txpool guarantee comment	done	#528
12	ethereum#17243	core: fixed typo in addresssByHeartbeat	done	#528
13	ethereum#17472	cmd, core, miner: add --txpool.locals and priority mining	done	#528
14	ethereum#17508	core, eth, trie: use common/prque	done	#528
15	ethereum#17733	core: fix a typo	done	#528
16	ethereum#18144	core: fix comment typo	done	#528
17	ethereum#17210	core: sanitize more TxPoolConfig fields	done	#528
18	ethereum#19308	core: make txpool handle reorg due to setHead	done	#528
19	ethereum#19351	core: cache tx signature before obtaining lock	done	#528
20	ethereum#19692	core, ethdb, metrics, p2p: expose various counter metrics for grafana	done	#528
21	ethereum#19705	core: move TxPool reorg and events to background goroutine	done	#528
22	ethereum#19810	core: kill off managed state, use own tiny noncer for txpool	done	#528
23	ethereum#19835	core: fix write concurrency in txpool	done	#528
24	ethereum#19823	core, les: fix les unit tests	done	#528
25	ethereum#19931	core, light, params: implement eip2028	done	#528
26	ethereum#20047	core, metrics, p2p: switch some invalid counters to gauges	done	#528
27	ethereum#20080	core: smaller txpool status locking	done	#533
28	ethereum#20081	core: dedup known transactions without global lock, track metrics	done	#533
29	ethereum#20085	core: fix tx dedup return error count	done	#533
30	ethereum#20352	core: count tx size in slots, bump max size ot 4x32KB	done	#533
31	ethereum#20555	core: set max tx size down to 2 slots (64KB)	done	#533
32	ethereum#20234	core, eth: announce based transaction propagation	done	#533
33	ethereum#20835	core: bump txpool tx max size to 128KB	skip
34	ethereum#20830	all: seperate consensus error and evm internal error	skip
35	ethereum#21118	all: fix typos in comments	done	#533
36	ethereum#21145	core: collect NewTxsEvent items without holding reorg lock	done	#533
37	ethereum#21170	core: filter out txs with invalid signatures as soon as possible	done	#533
38	ethereum#21265	core: types: less allocations when hashing and tx handling	done	#533
39	ethereum#21232	core, txpool: less allocations when handling transactions	skip
40	ethereum#21328	core: transaction pool optimizations	done	#533
41	ethereum#21300	core: fix queued transaction eviction	done	#533
42	ethereum#21159	core: avoid modification of accountSet cache in tx_pool	done	#533
43	ethereum#21420	core: more detailed metering for reorgs	done	#533
44	ethereum#21683	core: fix txpool off-by-one error	done	#533
45	ethereum#21478	core/txpool: remove "local" notion from the txpool price heap	done	#533
46	ethereum#22247	core: reset txpool state on sethead	done	#533

4.2 implemment EIP

no	PR	subject	day	owner	status
47	ethereum#21509	EIP-2929: Gas cost increases for state opcodes	5	Dan	merged
48	ethereum#21502	EIP-2718: Typed Transaction Envelope + EIP-2930	15	Dan	merged
49	ethereum#22380	define and enable the Berlin hard fork on networks	0	Dan	skip
50	ethereum#22456	core/types: reduce allocations in GasPriceCmp	1	Dan	merged
51	ethereum#22480	properly init statedb accesslist	1	Dan	merged
52	ethereum#22402	core/types: improve comments in new EIP-2718 code	1	Dan	merged
53	ethereum#22543	core: fix method comment for txpool.requestReset	1	Dan	merged
54	ethereum#22333	initialize tracer statedb in CaptureStart	1	Dan	merged
55	ethereum#22491	clef support for 2930-type txs	0		skip
56	ethereum#22550	Create access list	1	Dan	merged
57	ethereum#16784	core/types: convert status type from uint to uint64	1	Dan	merged
58	ethereum#21043	recap gas limit with balance	0		skip
59	ethereum#22585	add support for EIP-2930 transactions	0		skip
60	ethereum#21212	cmd, eth, internal, les: add txfee cap	1	Dan	merged
61	ethereum#20409	lighter gas price oracle for light client	1	Dan	merged
62	ethereum#21231	internal/ethapi: cap txfee for SignTransaction and Resend	1	Dan	merged
63	ethereum#21177	serialize negative block number as pending	1	Dan	merged
64	ethereum#21531	offer maxprice flag for overwritting price cap	1	Dan	merged
65	ethereum#21356	allow specifying signer on transactOpts	1	Dan	merged
66	ethereum#22205	eth: move eth.Config to a common package	1	Dan	merged
67	ethereum#22722	improve stability of estimated price	1	Dan	merged
68	ethereum#22752	add configurable threshold to gas price oracle	1	Dan	merged
69	ethereum#22837	all: implement EIP-1559	1	Dan	finish
70	ethereum#22888	core: fix failing tests	1	Dan	finish
71	ethereum#22896	EIP-1559: miner changes	1	Dan	finish
72	ethereum#22933	make txpool free space calculation more accurate	1	Dan	finish
73	ethereum#22898	all: EIP-1559 tx pool support	1	Dan	finish
74	ethereum#22970	core: add new eip-1559 tx constraints	1	Dan	finish
75	ethereum#22718	internal/ethapi: merge CallArgs and SendTxArgs	1	Dan	finish
76	ethereum#22964	RPC methods and fields for EIP 1559	1	Dan	finish
77	ethereum#22995	enforce configured mining reward post 1559 too	1	Dan	finish
78	ethereum#22930	miner/stress: add stress test for eip 1559	0		skip
79	ethereum#23010	rename internal 1559 gas fields, support graphql	1	Dan	finish
80	ethereum#22966	cmd/clef, signer: support for eip-1559 txs in clef	1	Dan	finish
81	ethereum#23027	support various eth_call invocations post 1559	1	Dan	finish
82	ethereum#23028	bump the RPC gas cap to 50M, since 1559 exceeds 25	1	Dan	finish
83	ethereum#22290	tests: update to latest tests	1	Dan	finish
84	ethereum#22446	accounts/abi/bind: add NoSend transact option	1	Dan	finish
85	ethereum#22976	tests: update for London	1	Dan	finish
86	ethereum#23013	core: make genesis parse baseFee correctly	1	Dan	finish
87	ethereum#23039	change baseFee into baseFeePerGas in genesis json	1	Dan	finish
88	ethereum#23038	fix bounded contracts and sim backend for 1559	1	Dan	finish
89	ethereum#23050	expose effectiveGasPrice in receipts	1	Dan	finish
90	ethereum#23054	tests: fix eip1559 tx on non-eip1559 network	1	Dan	finish
91	ethereum#23033	eth/gasprice: implement feeHistory API	1	Dan	finish
92	ethereum#23102	fix gas price suggestion with pre EIP-1559 clients	1	Dan	finish
93	ethereum#22977	RPC client wrapper for geth-specific API	1	Dan	finish
94	ethereum#23133	fix panic in access list creation	1	Dan	finish
95	ethereum#23159	fix full node interface post 1559	1	Dan	finish
96	ethereum#23171	sanity check the basefee length inside a header	0		skip
97	ethereum#23178	minor feehistory fixes	1	Dan	finish
98	ethereum#23179	internal/ethapi: fix transaction APIs	1	Dan	finish
99	ethereum#22992	get pending and queued transaction by address	1	Dan	finish
100	ethereum#23244	fix pre-check for account balance under EIP-1559	1	Dan	finish
101	ethereum#23239	Use hexutil.Uint in feeHistory method	1	Dan	finish
102	ethereum#23225	fix panic in accesslist creation	1	Dan	finish
103	ethereum#23294	remove term whitelist in comments and log messages	1	Dan	finish
104	ethereum#23274	fixes for London tx signing	1	Dan	finish
105	ethereum#23303	core: check if sender is EOA	1	Dan	finish
106	ethereum#23345	return maxFeePerGas for gasPrice for EIP-1559 txs	1	Dan	finish
107	ethereum#23309	cap highest gas limit by account balance for 1559	0		skip
108	ethereum#23384	add back missing check for maxfee < maxPriorityFee	1	Dan	finish
109	ethereum#23424	core: only check sendernoeoa in non fake mode	1	Dan	finish
110	ethereum#23422	eth/gasprice: feeHistory improvements	1	Dan	finish
111	ethereum#23095	core: make txpool reject too sudden changes	1	Dan	finish
112	ethereum#23476	support both input and data for personal_sendTransaction	1	Dan	finish
113	ethereum#23650	graphql: add storage slots to access list	0		skip
114	ethereum#23474	core: fix race conditions in txpool	1	Dan	finish
115	ethereum#23376	core/types: copy tx recipient address	1	Dan	finish
116	ethereum#23204	eth/gasprice: avoid modifying TestChainConfig	1	Dan	finish
117	ethereum#23720	core: remove unused error from TxPool.Pending	1	Dan	finish
118	ethereum#22806	add MarshalBinary, UnmarshalBinary for Receipt	1	Dan	finish
119	ethereum#23719	accounts/abi/bind: refactor transact method	1	Dan	finish
120	ethereum#23781	fix error handling in baseFee query	1	Dan	finish
121	ethereum#23838	return basefee in suggestGasPrice	1	Dan	finish
122	ethereum#23840	make suggestGasPrice compatible non-1559 chains	1	Dan	finish
123	ethereum#22231	core: more efficient nonce-update in txpool	1	Dan	finish
124	ethereum#23855	check effective tip in txpool validation	1	Dan	finish
125	ethereum#24080	ignore basefee when comparing gasprice in txpool	1	Dan	finish
126	ethereum#24143	document JSON field name equivalents of DynamicFeeTx	1	Dan	finish
127	ethereum#24252	internal/ethapi: use same receiver names	1	Dan	finish
128	ethereum#24515	always clear access list when setting a new one	1	Dan	finish
129	ethereum#24256	improve error for too short transaction/receipt encode	1	Dan	finish
130	ethereum#24452	graphql: fee history fields	1	Dan	finish
131	ethereum#24663	remove unnecessary comparisons in accessList.equal	1	Dan	finish
132	ethereum#24908	core: fix the order of address in queue	1	Dan	finish
133	ethereum#24958	reduce allocations improve comments in CalcBaseFee	0		skip
134	ethereum#25032	core/types: improve LogForStorage and ReceiptForStorage comments	1	Dan
135	ethereum#24783	all: more linters	0		skip
136	ethereum#25097	internal/ethapi: add comment explaining return of nil instead of error	1	Dan	finish
137	ethereum#25149	core: fix typo in txpool	1	Dan	finish
138	ethereum#25219	internal/ethapi: add basefee to block overrides	0		skip
139	ethereum#25157	error if tx args includes chain id not match local	1	Dan	finish
140	ethereum#25403	ethereum, ethclient: add FeeHistory support	1	Dan	finish
141	ethereum#25442	support finalized block	1	Dan	finish
142	ethereum#25467	not estimate gas if no limit eth_createAccessList	1	Dan	finish
143	ethereum#25197	rework setDefaults for tx args so fee logic is separate	1	Dan	finish
144	ethereum#25548	internal/ethapi: fix comment typo	1	Dan	finish
145	ethereum#25737	core: preallocate maps in TxPool helper methods	1	Dan	finish
146	ethereum#25603	core: don't cache zero nonce in txNoncer	1	Dan	finish
147	ethereum#25872	fix datarace in txpool, fixes ethereum#25870 and ethereum#25869	1	Dan	finish
148	ethereum#25924	all: fix docstrings	0		skip
149	ethereum#25961	all: fix spelling mistakes	0		skip
150	ethereum#26038	refactor txpool into it's package in prep for 4844	1	Dan	finish
151	ethereum#26044	rename tx files to group them better together	1	Dan	finish
152	ethereum#25994	make eip1559 params non-global	0	Dan	skip
153	ethereum#27828	move eip1559 into a package	1	Dan	finish
154	ethereum#26713	add EffectiveGasPrice in Receipt	1	Dan	finish
155	ethereum#25977	core, core/types: plain Message struct	1		pending
156	ethereum#26911	internal/ethapi: avoid int overflow in GetTransactionReceipt	1	Dan	finish
157	ethereum#26922	change feehistory input type from int to uint64	1	Dan	finish
158	ethereum#27114	fix discrepancy in receipt.EffectiveGasPrice	1	Dan	finish
159	ethereum#27335	internal,tests: replace noarg fmt.Errorf with errors.New	1	Amanda	merged
160	ethereum#27845	internal/ethapi: add state override to estimateGas	0	Gerui	merged
161	ethereum#27860	remove duplication in eip2930 signer	1	Dan	merged
162	ethereum#27702	internal/ethapi: implement eth_getBlockReceipts		Dan
163	ethereum#28462	fix forwarding 1559 gas fields	1	Dan	finish
164	ethereum#28470	core/vm: set basefee to 0 internally on eth_call	0		skip
165	ethereum#27834	internal/ethapi: ethSendTransaction check baseFee	1	Dan	finish
166	ethereum#28832	apply accessList field in toCallArg	1	Dan	finish
167	ethereum#28954	fix percentile validation in eth_feeHistory	1	Dan	finish
168	ethereum#28846	fix zero rpc gas cap in eth_createAccessList	1	Dan	finish
169	ethereum#29051	use overriden baseFee for gasPrice	1	Dan	finish
170	ethereum#29089	pass in accesslist in test	1	Dan	skip
171	ethereum#29811	eth/tracers: fix basefee context for traceBlock	1	Dan	skip
		review and test		Gerui Liam

5. Test Strategy

5.1 Local test

• Each PR should pass all test cases
• Local network will be deployed for each PR
• Test cases will include all affected APIs
• Use MetaMask for integration test

5.2 Online test

• devnet
• testnet
• mainnet