-
Notifications
You must be signed in to change notification settings - Fork 348
chore: State tracking in State object #1383
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.
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
Draft
kevaundray
wants to merge
1
commit into
ethereum:forks/osaka
Choose a base branch
from
kevaundray:kw/state-tracking
base: forks/osaka
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,135 @@ | ||
from dataclasses import dataclass, field | ||
from typing import Dict, List, Optional, Set, Tuple, Union | ||
|
||
from ethereum_types.bytes import Bytes32 | ||
from ethereum_types.numeric import U256 | ||
|
||
from .fork_types import Account, Address | ||
|
||
# State access types for tracking | ||
ACCOUNT_READ = "account_read" | ||
ACCOUNT_WRITE = "account_write" | ||
STORAGE_READ = "storage_read" | ||
STORAGE_WRITE = "storage_write" | ||
|
||
|
||
@dataclass | ||
class StateAccess: | ||
"""Record of a single state access for proof generation.""" | ||
access_type: str | ||
address: Address | ||
key: Optional[Bytes32] = None | ||
value_before: Optional[Union[Account, U256]] = None | ||
value_after: Optional[Union[Account, U256]] = None | ||
|
||
|
||
@dataclass | ||
class StateTracker: | ||
"""Tracks state access for merkle proof generation.""" | ||
accesses: List[StateAccess] = field(default_factory=list) | ||
main_trie_accessed_keys: Set[Address] = field(default_factory=set) | ||
storage_accessed_keys: Dict[Address, Set[Bytes32]] = field(default_factory=dict) | ||
track_reads: bool = True | ||
track_writes: bool = True | ||
|
||
|
||
def enable_state_tracking( | ||
state, | ||
track_reads: bool = True, | ||
track_writes: bool = True | ||
) -> None: | ||
""" | ||
Enable state tracking on a State object. | ||
|
||
Parameters | ||
---------- | ||
state : State | ||
The state to enable tracking on | ||
track_reads : bool | ||
Whether to track read operations | ||
track_writes : bool | ||
Whether to track write operations | ||
""" | ||
state._state_tracker = StateTracker( | ||
track_reads=track_reads, | ||
track_writes=track_writes | ||
) | ||
|
||
|
||
def disable_state_tracking(state) -> None: | ||
""" | ||
Disable state tracking on a State object. | ||
|
||
Parameters | ||
---------- | ||
state : State | ||
The state to disable tracking on | ||
""" | ||
state._state_tracker = None | ||
|
||
|
||
def log_state_access( | ||
state, | ||
access_type: str, | ||
address: Address, | ||
key: Optional[Bytes32] = None, | ||
value_before: Optional[Union[Account, U256]] = None, | ||
value_after: Optional[Union[Account, U256]] = None, | ||
) -> None: | ||
""" | ||
Log a state access if tracking is enabled. | ||
|
||
Parameters | ||
---------- | ||
state : State | ||
The state (with potential tracker) | ||
access_type : str | ||
Type of access (ACCOUNT_READ, ACCOUNT_WRITE, etc.) | ||
address : Address | ||
Address being accessed | ||
key : Optional[Bytes32] | ||
Storage key (for storage operations) | ||
value_before : Optional[Union[Account, U256]] | ||
Value before the operation | ||
value_after : Optional[Union[Account, U256]] | ||
Value after the operation | ||
""" | ||
if state._state_tracker is None: | ||
return | ||
|
||
tracker = state._state_tracker | ||
access = StateAccess( | ||
access_type=access_type, | ||
address=address, | ||
key=key, | ||
value_before=value_before, | ||
value_after=value_after, | ||
) | ||
tracker.accesses.append(access) | ||
|
||
if access_type in [ACCOUNT_READ, ACCOUNT_WRITE]: | ||
tracker.main_trie_accessed_keys.add(address) | ||
elif access_type in [STORAGE_READ, STORAGE_WRITE]: | ||
if address not in tracker.storage_accessed_keys: | ||
tracker.storage_accessed_keys[address] = set() | ||
if key is not None: | ||
tracker.storage_accessed_keys[address].add(key) | ||
|
||
# Dummy method | ||
def generate_merkle_proof_requests(state) -> Tuple[List[Address], List[Tuple[Address, Bytes32]]]: | ||
""" | ||
Comment on lines
+119
to
+120
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Left this here to show what the next addition may look like -- will delete |
||
Generate lists of proof requests needed for all tracked accesses. | ||
|
||
Parameters | ||
---------- | ||
state : State | ||
The state containing tracking logs | ||
|
||
Returns | ||
------- | ||
account_proofs : List[Address] | ||
List of addresses needing account proofs | ||
storage_proofs : List[Tuple[Address, Bytes32]] | ||
List of (address, storage_key) tuples needing storage proofs | ||
""" | ||
return [], [] |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Might be safer to also raise an error if
key is None
?For a
STORAGE_READ
orSTORAGE_WRITE
sounds like if this sitaution happens, it should be an error?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yep thats true -- @fselmo , this or the previous one were PRs that I was trying to merge into the execution specs, just want to confirm again that you will be adding the same functionality with your BAL PR?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the ping! I brought this up recently in the STEEL meeting. I've mostly been coordinating that PR with the testing side and @nerolation has been implementing most of the specs for it. It would make sense to me though to get these changes here dialed in and approved and then rebase our changes off of these to use the same tracker? What do you think?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We already have a working implementation for BALs. I think we should consolidate the ideas from here and in the BALs PR. I'm not sure what the differences in use / design are between the implementations but it would be worth not duplicating work and syncing on this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I believe the BALs work is a superset of what we need -- I can setup a group with Me + Ignacio + Toni + other STEEL members so we can dial this in