docs: document missing-event-for-admin-change and unchecked-token-amount - #388
Merged
unrealtim-tech merged 1 commit intoJul 31, 2026
Conversation
…unt checks Add sections for two undocumented checks in docs/checks.md: - missing-event-for-admin-change (Medium): flags public admin-mutating functions (set_owner, set_admin, transfer_ownership, set_operator) that write to storage without emitting an event via env.events().publish(). - unchecked-token-amount (Medium): flags token transfer/mint calls (transfer, transfer_from, xfer, mint) where no guard validates the amount is greater than zero. Note: issues SorobanGuard#285 (uninitialized-storage-read) and SorobanGuard#287 (missing-ttl-extension) were already merged to upstream main before this PR was opened; their closes are included here for traceability. Closes SorobanGuard#284 Closes SorobanGuard#285 Closes SorobanGuard#286 Closes SorobanGuard#287
Jesmaiya04
force-pushed
the
docs/284-286-document-missing-event-admin-unchecked-token
branch
from
July 30, 2026 11:27
64803de to
7592f69
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
2 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.
Summary
Adds documentation sections in
docs/checks.mdfor two checks that were implemented but had no corresponding documentation entry.missing-event-for-admin-change(Medium)Flags public admin-mutating functions (
set_owner,set_admin,transfer_ownership,set_operator) inside#[contractimpl]that write to storage but never callenv.events().publish(). Administrative state changes should be observable off-chain for auditing and governance monitoring.unchecked-token-amount(Medium)Flags token transfer/mint calls (
transfer,transfer_from,xfer,mint) where the function body contains no guard validating the amount is greater than zero. Zero or negative amounts can silently bypass intended accounting logic.Changes
docs/checks.md: two new##sections added at the end of the file, consistent with the style and structure of existing entries.Notes
Issues #285 (
uninitialized-storage-read) and #287 (missing-ttl-extension) were already merged tomainvia upstream commits before this PR was opened, so they are not included here.Closes #284
Closes #285
Closes #286
Closes #287