Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(internal/ethapi): historical-proof-query-window option for archive nodes eth_getProof #719

Merged
merged 22 commits into from
Jan 15, 2025
Merged

feat(internal/ethapi): historical-proof-query-window option for archive nodes eth_getProof #719

merged 22 commits into from
Jan 15, 2025

Conversation

qdm12
Copy link
Collaborator

@qdm12 qdm12 commented Dec 26, 2024 •
edited
Loading

Why this should be merged

Resolves #714

How this works

  • New option historical-proof-query-window for archive nodes only which:
    • can be set to a strictly positive number to accept get proof queries for a block number above the last accepted block number - historical-proof-query-window
    • defaults to 43200 to accept get proof queries for blocks dating from the last 24 hours approximately
    • can be set to 0 to accept any block number get proof query
  • For non-archive nodes, only the last 32 blocks before the accepted block are accepted for get proof queries (as before pretty much)

How this was tested

  • TestBlockChainAPI_stateQueryBlockNumberAllowed

Need to be documented?

Need to update RELEASES.md?

  • Done in RELEASES.md for the v0.14.1 release

qdm12
qdm12 commented Dec 26, 2024
View reviewed changes
eth/ethconfig/config.go Outdated Show resolved Hide resolved
internal/ethapi/api.go Outdated Show resolved Hide resolved
internal/ethapi/api.go Outdated Show resolved Hide resolved
internal/ethapi/api.go Outdated Show resolved Hide resolved
internal/ethapi/api.go Outdated Show resolved Hide resolved
internal/ethapi/api.go Outdated Show resolved Hide resolved
internal/ethapi/api_test.go Outdated Show resolved Hide resolved
internal/ethapi/mocks_generate_test.go Outdated Show resolved Hide resolved
plugin/evm/config.go Outdated Show resolved Hide resolved
internal/ethapi/api_test.go Outdated Show resolved Hide resolved
@qdm12 qdm12 force-pushed the qdm12/historical-proofs-options branch from 6deaa8a to bdfbbcd Compare December 26, 2024 15:59
@qdm12 qdm12 marked this pull request as ready for review December 26, 2024 16:36
@qdm12 qdm12 requested review from ceyonur, darioush and a team as code owners December 26, 2024 16:36
@qdm12 qdm12 force-pushed the qdm12/historical-proofs-options branch 2 times, most recently from 1d1a1a1 to 3a7ba07 Compare December 27, 2024 12:39
darioush
darioush reviewed Dec 27, 2024
View reviewed changes
internal/ethapi/api_extra.go Outdated Show resolved Hide resolved
internal/ethapi/mocks_generate_test.go Outdated Show resolved Hide resolved
license_header Outdated Show resolved Hide resolved
@qdm12 qdm12 requested a review from darioush December 30, 2024 17:44
darioush
darioush reviewed Dec 30, 2024
View reviewed changes
plugin/evm/vm.go Outdated Show resolved Hide resolved
eth/ethconfig/config.go Outdated Show resolved Hide resolved
ceyonur
ceyonur reviewed Jan 1, 2025
View reviewed changes
internal/ethapi/api.go Outdated Show resolved Hide resolved
eth/ethconfig/config.go Outdated Show resolved Hide resolved
eth/ethconfig/config.go Outdated Show resolved Hide resolved
internal/ethapi/api_extra.go Outdated Show resolved Hide resolved
internal/ethapi/api_extra.go Outdated Show resolved Hide resolved
internal/ethapi/api_extra.go Outdated Show resolved Hide resolved
@qdm12 qdm12 force-pushed the qdm12/historical-proofs-options branch 4 times, most recently from 5920832 to 534a73e Compare January 3, 2025 13:38
qdm12
qdm12 commented Jan 3, 2025
View reviewed changes
eth/ethconfig/config.go Outdated Show resolved Hide resolved
plugin/evm/config/config.go Outdated Show resolved Hide resolved
plugin/evm/vm_test.go Outdated Show resolved Hide resolved
@qdm12 qdm12 force-pushed the qdm12/historical-proofs-options branch from 6cea7d1 to 8a89462 Compare January 3, 2025 14:44
@qdm12 qdm12 requested review from ceyonur and darioush January 3, 2025 14:49
darioush
darioush reviewed Jan 6, 2025
View reviewed changes
RELEASES.md Outdated Show resolved Hide resolved
eth/ethconfig/config.go Outdated Show resolved Hide resolved
eth/ethconfig/config.go Outdated Show resolved Hide resolved
internal/ethapi/api.go Outdated Show resolved Hide resolved
internal/ethapi/api_extra.go Outdated Show resolved Hide resolved
eth/backend.go Outdated Show resolved Hide resolved
plugin/evm/vm.go Outdated Show resolved Hide resolved
@qdm12 qdm12 changed the title feat(internal/ethapi): historical-proofs and recent-blocks-window options for GetProofs feat(internal/ethapi): historical-state-query-window option for GetProofs Jan 7, 2025
@qdm12 qdm12 force-pushed the qdm12/historical-proofs-options branch 2 times, most recently from 76d1f74 to 8948854 Compare January 8, 2025 14:02
qdm12
qdm12 commented Jan 8, 2025
View reviewed changes
RELEASES.md Outdated Show resolved Hide resolved
plugin/evm/vm.go Outdated Show resolved Hide resolved
RELEASES.md Outdated Show resolved Hide resolved
@qdm12 qdm12 force-pushed the qdm12/historical-proofs-options branch from 8948854 to 6e83e97 Compare January 8, 2025 15:54
darioush
darioush reviewed Jan 8, 2025
View reviewed changes
RELEASES.md Outdated Show resolved Hide resolved
plugin/evm/config/config.go Outdated Show resolved Hide resolved
plugin/evm/vm.go Outdated Show resolved Hide resolved
darioush
darioush previously approved these changes Jan 9, 2025
View reviewed changes
@qdm12 qdm12 changed the title feat(internal/ethapi): historical-state-query-window option for GetProofs feat(internal/ethapi): historical-proof-query-window option for archive nodes get_proof Jan 9, 2025
@qdm12 qdm12 changed the title feat(internal/ethapi): historical-proof-query-window option for archive nodes get_proof feat(internal/ethapi): historical-proof-query-window option for archive nodes eth_getProof Jan 9, 2025
qdm12 added 20 commits January 10, 2025 15:49
@qdm12
recent-blocks-window configuration option
8b0866a
@qdm12
Use gomock.Any() for expected mock arguments
5bb2d6f
@qdm12
Self review feedback
f2d4b0e
@qdm12
Move new code to _extra files
11824c8
@qdm12
Add missing license header to test file
af282ad
@qdm12
isAllowedToBeQueried -> isHistoricalStateQueryAllowed
c7a4eaf
@qdm12
Update error wrapping in GetProof
1657d70
@qdm12
Rework code following feedback
c00004e 
- Dynamic default depending if pruning is true or false
- Replace `historical-proofs` with `historical-state-query-window` set to `0` to allow any block number state query
- Replace `recent-blocks-window` with `historical-state-query-window` which is only applicable for archive nodes
- For non-archive nodes, `historical-state-query-window` defaults to the tip buffer size of 32
- Set eth default HistoricalStateQueryWindow to 43200 (is this necessary?)
- Export core.tipBufferSize
- Update release notes
@qdm12
Rework logic to not use query window config field for non-archive nodes
7ab5fd5 
- remove the need to modify config after reading it
- remove the need to import core from config package
- core.TipBufferSize is used if running in non-archive mode within the function `isHistoricalStateQueryAllowed`
@qdm12
Rename isHistoricalStateQueryAllowed to stateQueryBlockNumberAllowed
2694346
@qdm12
Move field HistoricalStateQueryWindow in ethconfig.Config
47d6a12
@qdm12
Better error wrapping in GetProof
a6389e7
@qdm12
Do not set HistoricalStateQueryWindow in ethconfig.NewDefaultConfig()
b378870
@qdm12
consistent error wrapping within stateQueryBlockNumberAllowed
e747d93
@qdm12
Rename historical-state-query-window to `historical-proof-query-win…
6a1db79 
…dow`
@qdm12
Highlight node behavior change in releases document
9ec590b
@qdm12
Rename variables to HistoricalProofQueryWindow for consistency
8d8978a
@qdm12
Undo empty line added my mistake
bd83da9
@qdm12
Minor change: test name rename
8e4798d
@qdm12
Apply PR suggestions (Cey)
d09eabb 
- rename `defaultBlocksWindow` -> `defaultHistoricalProofQueryWindow`
- Chain calls with `s.b.LastAcceptedBlock().NumberU64()`
@qdm12 qdm12 force-pushed the qdm12/historical-proofs-options branch from 1633751 to d09eabb Compare January 10, 2025 14:51
@qdm12 qdm12 enabled auto-merge (squash) January 10, 2025 14:52
@qdm12 qdm12 requested review from darioush and ceyonur January 10, 2025 14:52
@darioush darioush disabled auto-merge January 13, 2025 15:26
@qdm12 qdm12 merged commit 5013851 into master Jan 15, 2025
8 checks passed
@qdm12 qdm12 deleted the qdm12/historical-proofs-options branch January 15, 2025 15:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ceyonur ceyonur ceyonur approved these changes

@darioush darioush darioush approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Deprecate historical proofs in eth_getProof API.
3 participants
@qdm12 @darioush @ceyonur