docs: Align BuiltinHintProcessor README with current cairo-vm API #2274
Conversation
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
Collaborator
|
Hi @sashass1315, thanks for contributing, Could you please add the corresponding changelog entry? |
DiegoCivi
approved these changes
Dec 22, 2025
Collaborator
|
Sorry, @sashass1315, because this PR only changes documentation the changelog entry is not necessary, my bad. Could you please revert the commit that updates the changelog? Thanks! |
Author
updated |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
The README under docs/hint_processor/builtin_hint_processor was using legacy types and call patterns that no longer match the codebase. I updated all examples and guidance to the current API: hint functions now use VirtualMachine, Felt252 constants and return HintError; add_hint requires Rc; BuiltinHintProcessor::new takes a preset HashMap<String, Rc> and a RunResources; cairo_run now receives program bytes together with a CairoRunConfig. Error handling was also corrected to use HintError::CustomHint. These changes are verified against builtin_hint_processor_definition.rs, cairo_run.rs, hint_errors.rs and the canonical example at examples/custom_hint/src/main.rs to ensure accuracy and prevent confusion for users integrating custom hints.