Repository navigation
docs(sdk): document programs, verbosity and utilities in rustdoc - #194
Merged
Merged
Conversation
schoen
force-pushed
the
docs/rustdoc-program
branch
from
November 2, 2026 21:57
d5264dc to
f99287e
Compare
Describe how a `Program` compiles and caches, which settings determine its CMR and its address, the shape of its Taproot tree with storage, which getters panic on a compile error, and what `execute` and `finalize` check and return. Correct three doc comments: `ScriptPubkeyMismatch` holds HASH160 script hashes, not CMRs; `Program` reports Bit Machine failures as `Pruning` and never returns `ProgramError::Execution`; and which signer methods print execution output, and when. Also document the verbosity's effect on addresses, the utilities that compute hashes and entropy, and what `DUMMY_SIGNATURE` and `MIN_FEE` are for. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
schoen
force-pushed
the
docs/rustdoc-program
branch
from
November 3, 2026 01:17
f99287e to
5f9a0ed
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
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.
Describe how a
Programcompiles and caches, which settings determine its CMR and its address, the shape of its Taproot tree with storage, which getters panic on a compile error, and whatexecuteandfinalizecheck and return.Correct three doc comments:
ScriptPubkeyMismatchholds HASH160 script hashes, not CMRs;Programreports Bit Machine failures asPruningand never returnsProgramError::Execution; and which signer methods print execution output, and when.Also document the verbosity's effect on addresses, the utilities that compute hashes and entropy, and what
DUMMY_SIGNATUREandMIN_FEEare for.