triedb/database: improve memory safety documentation for Node and Storage methods #32603
+14
−4
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.
Enhanced documentation for NodeReader.Node() and StateReader.Storage() methods to clearly communicate memory safety requirements and prevent potential data corruption.
Changes:
Why these changes are necessary:
The previous documentation was ambiguous about memory safety, potentially leading developers to accidentally modify shared database storage. The returned byte slices are direct references to internal database structures that must remain immutable for data integrity. Any modification would corrupt the database state and cause undefined behavior across the entire Ethereum node. These changes ensure developers understand the critical importance of treating returned data as read-only while maintaining the performance benefits of zero-copy access patterns.