Skip to content

Conversation

VolodymyrBg
Copy link
Contributor

Enhance documentation for Contract::call_with_prefetch method to better explain its purpose, benefits, and trade-offs. This addresses issue #387.

  • Add detailed explanation of how call_with_prefetch helps reduce preflight time by minimizing RPC calls
  • Document trade-offs with certain node software (e.g., Geth vs Reth)
  • Add usage examples for both call_with_prefetch and prefetch_access_list methods
  • Update Contract struct documentation to recommend call_with_prefetch for calls with many storage accesses
  • Clarify relationship between prefetch_access_list and call_with_prefetch methods

@VolodymyrBg VolodymyrBg requested a review from a team as a code owner March 12, 2025 19:52
Copy link
Contributor

@Wollac Wollac left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice, thanks a lot.

@Wollac Wollac merged commit 4fbc876 into risc0:main Mar 14, 2025
9 of 11 checks passed
capossele pushed a commit that referenced this pull request Mar 17, 2025
Enhance documentation for Contract::call_with_prefetch method to better
explain its purpose, benefits, and trade-offs. This addresses issue
#387.

- Add detailed explanation of how call_with_prefetch helps reduce
preflight time by minimizing RPC calls
- Document trade-offs with certain node software (e.g., Geth vs Reth)
- Add usage examples for both call_with_prefetch and
prefetch_access_list methods
- Update Contract struct documentation to recommend call_with_prefetch
for calls with many storage accesses
- Clarify relationship between prefetch_access_list and
call_with_prefetch methods

---------

Co-authored-by: Wolfgang Welz <welzwo@gmail.com>
capossele pushed a commit that referenced this pull request Mar 17, 2025
Enhance documentation for Contract::call_with_prefetch method to better
explain its purpose, benefits, and trade-offs. This addresses issue
#387.

- Add detailed explanation of how call_with_prefetch helps reduce
preflight time by minimizing RPC calls
- Document trade-offs with certain node software (e.g., Geth vs Reth)
- Add usage examples for both call_with_prefetch and
prefetch_access_list methods
- Update Contract struct documentation to recommend call_with_prefetch
for calls with many storage accesses
- Clarify relationship between prefetch_access_list and
call_with_prefetch methods

---------

Co-authored-by: Wolfgang Welz <welzwo@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants