Skip to content

Commit 5cd24a8

Browse files
committed
feat(docs): add emergency pause system page
1 parent b73e27e commit 5cd24a8

File tree

4 files changed

+70
-0
lines changed

4 files changed

+70
-0
lines changed
File renamed without changes.

docs/fassets/7-emergency-pause.mdx

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
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. Each level defines a different scope of restrictions, ensuring a balance between **security, system availability, and user protection**.
10+
11+
## Emergency Pause Levels
12+
13+
### Start Operations
14+
15+
This level is intended for scenarios like network upgrades or planned maintenance.
16+
The goal is to prevent anyone from initiating new actions while allowing operations already in progress to complete before proceeding with maintenance.
17+
18+
#### Halted Operations
19+
20+
- **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).
21+
- **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](/fassets/reference/agent-bot#create) agent.
22+
- **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, [delegate pool collateral](/fassets/reference/agent-bot#delegate-pool-collateral).
23+
24+
#### Use Cases
25+
26+
- Scheduled network upgrades.
27+
- System configuration or parameter changes.
28+
- Non-critical security patches.
29+
30+
### Full
31+
32+
This level is designed for critical emergencies.
33+
It halts practically all activity while preserving essential system functions.
34+
35+
#### Halted Operations
36+
37+
Stops almost everything, except:
38+
39+
- **FAsset transfers**, but users can still move their assets.
40+
- **Settings modifications**, but governance can still adjust parameters.
41+
- **System upgrades**, but critical updates can still be deployed.
42+
43+
#### Use Cases
44+
45+
- Confirmed security vulnerabilities.
46+
- Market manipulation attempts.
47+
- Critical system failures.
48+
- Regulatory compliance requirements.
49+
50+
### Full and Transfer
51+
52+
The most restrictive level that freezes all transactional activity, including asset transfers.
53+
54+
#### Halted Operations
55+
56+
This is identical to the FULL level, but it also stops the **FAsset transfers**.
57+
It completely freezes all movement of the FAssets.
58+
59+
#### Use Cases
60+
61+
- Severe security breaches.
62+
- Complete system compromise.
63+
- Emergency asset protection.
64+
- Extreme market conditions.
65+
66+
## Conclusion
67+
68+
The FAssets emergency pause system provides a robust framework for maintaining system security and stability during critical situations.
69+
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)