Skip to content

Commit 7dcaecf

Browse files
authored
feat(docs): add emergency pause system page (#888)
1 parent 5a37dfe commit 7dcaecf

File tree

4 files changed

+71
-0
lines changed

4 files changed

+71
-0
lines changed
File renamed without changes.

docs/fassets/7-emergency-pause.mdx

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
---
2+
title: Emergency Pause System
3+
description: FAssets emergency pause system
4+
keywords: [fassets, emergency, pause, security, system-control, maintenance]
5+
---
6+
7+
## Overview
8+
9+
The FAssets system includes a structured **three-level emergency pause mechanism** that allows governance to selectively restrict operations in response to planned upgrades, critical failures, or security threats.
10+
Each level defines a different scope of restrictions, ensuring a balance between **security, system availability, and user protection**.
11+
12+
## Emergency Pause Levels
13+
14+
### Start Operations
15+
16+
This level is intended for scenarios like network upgrades or planned maintenance.
17+
The goal is to prevent anyone from initiating new actions while allowing operations already in progress to complete before proceeding with maintenance.
18+
19+
#### Halted Operations
20+
21+
- **User/Agent Operations**: [minting](/fassets/minting), [redeeming](/fassets/redemption), [liquidation](/fassets/liquidation), [destroy agent](/fassets/reference/agent-bot#close-agent-vault), [collateral withdrawal](/fassets/reference/agent-bot#withdraw-vault-collateral), [exit available](/fassets/reference/agent-bot#exit-available).
22+
- **One-Step Operations**: [self mint](/fassets/reference/agent-bot#self-mint-fasset), [self close](/fassets/reference/agent-bot#self-close), [enter](/fassets/reference/agent-bot#enter-available), [create agent](/fassets/reference/agent-bot#create).
23+
- **Collateral Pool Operations**: [enter](/fassets/reference/user-bot#enter-pool), [exit](/fassets/reference/user-bot#exit-pool), [withdraw fees](/fassets/reference/agent-bot#withdraw-vault-collateral-1), [pay fee debt](/fassets/collateral#minting-fees-and-debt), [delegate pool collateral](/fassets/reference/agent-bot#delegate-pool-collateral).
24+
25+
#### Use Cases
26+
27+
- Scheduled network upgrades.
28+
- System configuration or parameter changes.
29+
- Non-critical security patches.
30+
31+
### Full
32+
33+
This level is designed for critical emergencies.
34+
It halts practically all activity while preserving essential system functions.
35+
36+
#### Halted Operations
37+
38+
Stops almost everything, except:
39+
40+
- **FAsset transfers**, but users can still move their assets.
41+
- **Settings modifications**, but governance can still adjust parameters.
42+
- **System upgrades**, but critical updates can still be deployed.
43+
44+
#### Use Cases
45+
46+
- Confirmed security vulnerabilities.
47+
- Market manipulation attempts.
48+
- Critical system failures.
49+
- Regulatory compliance requirements.
50+
51+
### Full and Transfer
52+
53+
The most restrictive level that freezes all transactional activity, including asset transfers.
54+
55+
#### Halted Operations
56+
57+
This is identical to the FULL level, but it also stops the **FAsset transfers**.
58+
It completely freezes all movement of the FAssets.
59+
60+
#### Use Cases
61+
62+
- Severe security breaches.
63+
- Complete system compromise.
64+
- Emergency asset protection.
65+
- Extreme market conditions.
66+
67+
## Conclusion
68+
69+
The FAssets emergency pause system provides a robust framework for maintaining system security and stability during critical situations.
70+
The system can respond appropriately to various types of threats while maintaining essential functionality and protecting user assets.

sidebars.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -214,6 +214,7 @@ const sidebars: SidebarsConfig = {
214214
"fassets/collateral",
215215
"fassets/core-vault",
216216
"fassets/liquidation",
217+
"fassets/emergency-pause",
217218
"fassets/operational-parameters",
218219
"fassets/songbird",
219220
{

0 commit comments

Comments
 (0)