Skip to content

Update PAUSABLE_DOCS_AND_REENTRANCY.md #1407

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nanaf6203-bit merged 1 commit into from
Oct 27, 2026
Merged

Update PAUSABLE_DOCS_AND_REENTRANCY.md #1407

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions docs/PAUSABLE_DOCS_AND_REENTRANCY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,25 @@ The pause and resume messages only read the caller, write `pause_info`, emit eve
## Tests (#1296, #1297)

`contracts/lib/tests/pausable_unit_fuzz.rs` holds unit tests plus a sweep over many unprivileged callers.
# Pausable: documentation and reentrancy review

Pausable in this repository is the pause logic of the `PropertyRegistry` ink! contract (`contracts/lib/src/lib.rs`): `pause_contract`, `emergency_pause`, `request_resume`, `approve_resume`, `ensure_not_paused` and `get_pause_state`. There is no separate Solidity `Pausable` contract.

## Documentation (#1298)

| Message | Caller | Effect |
|---------|--------|--------|
| `pause_contract(reason, duration)` | admin or pause guardian | Pauses; optional auto-resume after 60 s .. 30 days |
| `emergency_pause(reason)` | admin or pause guardian | Logs an emergency audit event, then pauses with no auto-resume |
| `request_resume()` | admin or pause guardian | Opens a resume request |
| `approve_resume()` | pause guardian | Adds an approval; resumes once the required number is reached |
| `get_pause_state()` | anyone | Returns the current `PauseInfo` |
| `ensure_not_paused()` | anyone | `Err(ContractPaused)` while paused (honours auto-resume) |

## Reentrancy review (#1299)

The pause and resume messages only read the caller, write `pause_info`, emit events and append audit entries. They make no cross-contract calls and transfer no value, so there is no external call through which the contract could be re-entered mid-update. State is written before events are emitted.

## Tests (#1296, #1297)

`contracts/lib/tests/pausable_unit_fuzz.rs` holds unit tests plus a sweep over many unprivileged callers.
Loading