Skip to content

feat: Refactor gas-optimized tx path for Ledger (refactor/gas-827-1) #2

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: Refactor gas-optimized tx path for Ledger (refactor/gas-827-1) #2

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
39 changes: 39 additions & 0 deletions docs/EMERGENCY_PAUSE_USAGE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Emergency Pause and Guarded Wallet usage

This project includes a lightweight pause mechanism provided by the OwnablePause pattern. The contract can be paused by the owner to prevent certain operations from executing during emergencies or maintenance windows.

Key concepts:

- Pausable by owner: The contract exposes pause/unpause controls via OwnablePause. When paused, sensitive operations can be restricted.
- Guarded wallet (extension): A guarded wallet address can be configured to enable additional admin-like workflows or offload certain administrative tasks. This is designed to be extended by future code paths.

How to use during development and in production:

1) Pause the contract (safest first):

- Ensure you are the contract owner.
- Call pause() to suspend operations guarded by the pause modifier.

2) Configure a guarded wallet (optional extension):

- Provide a guarded wallet address that your deployment uses for admin tasks.
- This can help separate concerns and enable safer operational flows.

3) Unpause when ready:

- After investigations or maintenance, call unpause() to resume normal operations.

Example concepts (not a direct call surface, depends on your contract wiring):

- Pausable actions typically decorate sensitive functions with a modifier like whenNotPaused. While paused, those functions revert.
- Guarded wallet can be used to implement admin-specific logic in future function paths or in external scripts that interact with the ledger.

Notes:

- This document describes the intended usage pattern and does not replace your own security reviews.
- If you extend the contract to expose more pause-protected entry points, ensure you update tests to cover pause/unpause behavior and access control.

For developers

- Review contracts/OwnablePause.sol to understand how pause control is implemented.
- Consider adding unit tests that verify that when paused, only privileged actions fail and that unpause restores functionality.