fix:fix transactional receipt handling and improve public docs#1
Merged
fix:fix transactional receipt handling and improve public docs#1
Conversation
Add field-level documentation for Receipt to match the rest of the public API surface and keep rustdoc coverage consistent.
Extract duplicated short address and hash formatting helpers into the app module so the demo and REPL present identifiers consistently from one implementation.
Replace the runtime Address::default().len() call with size_of::<Address>() so host memory reads express the fixed address width directly.
Only persist receipts after a mined batch succeeds so failed executions roll back receipt side effects together with chain and state changes. Update tests to assert the transactional contract.
Document the narrow JSON-to-Borsh mapping used by the REPL so callers understand which value shapes are accepted and why objects are rejected.
Add deny(missing_docs) and document the remaining public modules and API types so documentation coverage becomes an enforced repository standard.
Why: capture the fixes, refactors, and documentation updates that are shipping in the next patch release.
mattwend
force-pushed
the
fix/minor_gaps
branch
from
264edef to
0668b24
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
This PR improves API documentation, cleans up app display helpers, fixes VM host read sizing, and makes receipt persistence transactional.
Changes
Behavior change
Receipt handling is now transactional: