Skip to content

Commit c9c87a2

Browse files
fix(docs): ensure sentences start on newline
1 parent 37e2202 commit c9c87a2

7 files changed

Lines changed: 59 additions & 25 deletions

File tree

docs/fassets/01-overview.mdx

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,9 @@ Agents and a community-provided collateral pool ensure trustlessness through ove
3737
}}
3838
/>
3939

40-
Anyone on the Flare blockchain can mint FAssets, which are wrapped versions of original tokens from other blockchains, known as underlying networks. The original tokens from these chains, such as Ripple (XRPL), Dogecoin (DOGE), Bitcoin (BTC), and Litecoin (LTC), are referred to as underlying assets. For example, the FAsset version of Bitcoin is known as FBTC.
40+
Anyone on the Flare blockchain can mint FAssets, which are wrapped versions of original tokens from other blockchains, known as underlying networks.
41+
The original tokens from these chains, such as Ripple (XRPL), Dogecoin (DOGE), Bitcoin (BTC), and Litecoin (LTC), are referred to as underlying assets.
42+
For example, the FAsset version of Bitcoin is known as FBTC.
4143

4244
### Minting
4345

@@ -99,7 +101,8 @@ Eligibility:
99101

100102
### Challengers
101103

102-
Challengers monitor agents for illegal transactions that reduce collateral below the backing factor. They:
104+
Challengers monitor agents for illegal transactions that reduce collateral below the backing factor.
105+
They:
103106

104107
- Submit proof of illegal actions to the system.
105108
- Earn rewards from the agent's vault upon successful challenges.

docs/fassets/02-minting.mdx

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -120,11 +120,13 @@ The minting fee is further divided in two shares:
120120

121121
#### Agent share
122122

123-
This share remains in the agent's underlying account but is not marked as being in use. The agent can use this balance freely.
123+
This share remains in the agent's underlying account but is not marked as being in use.
124+
The agent can use this balance freely.
124125

125126
#### Pool share
126127

127-
This share is minted as FAssets and sent to the [collateral pool](/fassets/collateral#pool-collateral). The percentage of this share is defined by the agent and can be changed by the agent after a delay that provides time for minters to notice the change.
128+
This share is minted as FAssets and sent to the [collateral pool](/fassets/collateral#pool-collateral).
129+
The percentage of this share is defined by the agent and can be changed by the agent after a delay that provides time for minters to notice the change.
128130

129131
### Executor Fee
130132

@@ -140,13 +142,21 @@ This design ensures timely and reliable minting finalization without relying on
140142

141143
### Minting
142144

143-
The FAssets agent verifies the minter after the user completes the collateral reservation and pays the collateral reservation fee. The agent is responsible for confirming or rejecting the minter's status. If the agent does not respond within a certain timeframe, the minter has the option to cancel the reservation and receive a full refund of the collateral reservation fee.
145+
The FAssets agent verifies the minter after the user completes the collateral reservation and pays the collateral reservation fee.
146+
The agent is responsible for confirming or rejecting the minter's status.
147+
If the agent does not respond within a certain timeframe, the minter has the option to cancel the reservation and receive a full refund of the collateral reservation fee.
144148

145-
To enable the agent to verify the minter, the collateral reservation must include the address (or multiple addresses, in the case of UTXO chains) from which the payment will be made. If multiple addresses are provided, all of them must be used for the payment.
149+
To enable the agent to verify the minter, the collateral reservation must include the address (or multiple addresses, in the case of UTXO chains) from which the payment will be made.
150+
If multiple addresses are provided, all of them must be used for the payment.
146151

147-
Users must wait up to 60 seconds before they can cancel their request. If the agent accepts within this time, the user can proceed to mint by depositing the underlying assets. Therefore, it is important for the agent to respond quickly. If the agent does not respond in time, it will depend on whether the user is willing to wait; otherwise, the agent will simply miss the opportunity to mint, but there will be no loss of tokens.
152+
Users must wait up to 60 seconds before they can cancel their request.
153+
If the agent accepts within this time, the user can proceed to mint by depositing the underlying assets.
154+
Therefore, it is important for the agent to respond quickly.
155+
If the agent does not respond in time, it will depend on whether the user is willing to wait; otherwise, the agent will simply miss the opportunity to mint, but there will be no loss of tokens.
148156

149-
When the agent rejects the minter's request or the minter decides to cancel, the minter will receive a refund of the collateral reservation fee, minus a small percentage (e.g., 5%) that is burned. This burned amount is designed to prevent abuse of the agent by stopping someone from repeatedly reserving collateral from a sanctioned address. If the burned percentage were zero, an attacker could exploit the system without any cost.
157+
When the agent rejects the minter's request or the minter decides to cancel, the minter will receive a refund of the collateral reservation fee, minus a small percentage (e.g., 5%) that is burned.
158+
This burned amount is designed to prevent abuse of the agent by stopping someone from repeatedly reserving collateral from a sanctioned address.
159+
If the burned percentage were zero, an attacker could exploit the system without any cost.
150160

151161
## Payment Failure
152162

@@ -200,7 +210,8 @@ FAssets are still transferred to the minter's account, and the agent's collatera
200210
### Expired proof
201211

202212
Proofs provided by the [Flare Data Connector](/fdc/overview) can be created for 14 days and remain valid indefinitely once created.
203-
Suppose neither the minter nor the agent presents the proof of payment or nonpayment within the 14-day window. In that case, the regular minting process cannot continue, and the agent's collateral could be locked indefinitely.
213+
Suppose neither the minter nor the agent presents the proof of payment or nonpayment within the 14-day window.
214+
In that case, the regular minting process cannot continue, and the agent's collateral could be locked indefinitely.
204215

205216
In this case, the agent can still recover the collateral by buying it back with native tokens.
206217
The recovery is accomplished with the following procedure:

docs/fassets/05-collateral.mdx

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@ import useBaseUrl from "@docusaurus/useBaseUrl";
1010
FAssets collateral is locked in contracts that ensure the minted FAssets can always be redeemed for the underlying assets they represent or compensated by collateral.
1111
Along with Flare's native token, FLR, any governance approved ERC-20 token on the Flare blockchain can be used as collateral.
1212

13-
FAssets collateral ensures the security and redemption of minted FAssets by locking collateral in smart contracts. This guarantees that FAssets can either be redeemed for their underlying assets or compensated by collateral. Collateral can include Flare's native token (FLR) and any governance-approved ERC-20 tokens on the Flare blockchain.
13+
FAssets collateral ensures the security and redemption of minted FAssets by locking collateral in smart contracts.
14+
This guarantees that FAssets can either be redeemed for their underlying assets or compensated by collateral.
15+
Collateral can include Flare's native token (FLR) and any governance-approved ERC-20 tokens on the Flare blockchain.
1416

1517
## Collateral Types
1618

@@ -123,7 +125,8 @@ The following thresholds are set by the FAssets system's governance and are the
123125

124126
#### Minimal CR
125127

126-
The lowest collateral ratio the agent vault and the collateral pool must maintain so that enough collateral exists to insure the minted FAssets and to compensate for redemption payments that fail. The minimal CR can be different for each type of collateral.
128+
The lowest collateral ratio the agent vault and the collateral pool must maintain so that enough collateral exists to insure the minted FAssets and to compensate for redemption payments that fail.
129+
The minimal CR can be different for each type of collateral.
127130

128131
If an agent's CR remains below the minimal CR for longer than a governance-set amount of time, [liquidations](/fassets/liquidation) can start.
129132

@@ -180,12 +183,14 @@ To reduce the threat of liquidation, agents should set the minting CR well above
180183

181184
#### Exit CR
182185

183-
After a user redeems CPTs, the pool CR must be more than the exit CR. If the pool CR is already below the exit CR, redemption cannot occur.
186+
After a user redeems CPTs, the pool CR must be more than the exit CR.
187+
If the pool CR is already below the exit CR, redemption cannot occur.
184188
The exit CR is for the collateral pool only.
185189

186190
#### Top-up CR
187191

188-
To incentivize healthy collateral pools, if the pool CR falls below the top-up CR, anyone can add collateral to the pool and receive [CPTs](#pool-collateral) at a reduced price. This [top-up mechanism](#top-up) decreases the likelihood of liquidations because of a low amount of pool collateral.
192+
To incentivize healthy collateral pools, if the pool CR falls below the top-up CR, anyone can add collateral to the pool and receive [CPTs](#pool-collateral) at a reduced price.
193+
This [top-up mechanism](#top-up) decreases the likelihood of liquidations because of a low amount of pool collateral.
189194

190195
## Minting Fees and Debt
191196

@@ -282,7 +287,8 @@ The following example shows fee entitlement.
282287
After step **4**, Bob is not entitled to any of the fees in the pool:
283288

284289
- Bob is assigned an initial fee debt of 10 FAssets, according to the $fee\_debt_p$ formula in the box above.
285-
- As a result, the total virtual fees are increased to 20 FAssets. 10 of them are in fees, and 10 of them are in debt.
290+
- As a result, the total virtual fees are increased to 20 FAssets.
291+
10 of them are in fees, and 10 of them are in debt.
286292
- Each user now holds half the total CPTs, therefore they are allowed to withdraw half the virtual fees, this is, 10 FAssets each.
287293
- Alice has no debt, so she can withdraw 10 FAssets, which is all the fees in the pool, because she was the only CPT holder when these fees were accrued.
288294
- Conversely, Bob has 10 FAssets of debt, so he can't withdraw any of the fees.
@@ -379,7 +385,8 @@ After step **2**, all of Alice's CPTs are transferable because she has no debt.
379385
After step **3**, all of Alice's CPTs continue to be transferable, and she is entitled to 100% of the fees in the pool.
380386
If she transferred or traded his CPTs, the recipient of those CPTs would be entitled to the fees.
381387

382-
After step **4**, only half of Alice's CPTs are transferable (50 CPTs). The other half is debt-locked.
388+
After step **4**, only half of Alice's CPTs are transferable (50 CPTs).
389+
The other half is debt-locked.
383390

384391
After step **5**, only 25% of Alice's CPTs remain locked (25 CPTs), which correspond to her 5 FAssets of debt.
385392

@@ -445,7 +452,9 @@ These actions can cause the agent's CPTs to be burned:
445452

446453
## Top-up
447454

448-
To reduce the likelihood of liquidations because the pool collateral is too low, the pool can be topped up at a reduced price when the **CR** is above the **top-up CR**. A top-up mechanism for vault collateral is not available. To prevent liquidation, agents can add vault collateral any time.
455+
To reduce the likelihood of liquidations because the pool collateral is too low, the pool can be topped up at a reduced price when the **CR** is above the **top-up CR**.
456+
A top-up mechanism for vault collateral is not available.
457+
To prevent liquidation, agents can add vault collateral any time.
449458

450459
:::tip[What's next]
451460

docs/fassets/06-core-vault.mdx

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,9 @@ The CV effectively acts as an **insurance-backed reserve** that boosts efficienc
119119

120120
:::info
121121

122-
Transfer requests do not expire. Agents must either complete the transfer or cancel and re-queue it. Inaction leaves collateral locked indefinitely.
122+
Transfer requests do not expire.
123+
Agents must either complete the transfer or cancel and re-queue it.
124+
Inaction leaves collateral locked indefinitely.
123125

124126
:::
125127

@@ -176,9 +178,12 @@ Three escrows are created if `remaining_funds = M + 3L`, and M stays in the wall
176178

177179
### Security Model
178180

179-
The XRP Core Vault features enhanced security measures for managing daily liquidity, including escrow time-locking and a minimum reserve in multisig setups. It has an emergency pause function and "Red Alert Mode" for urgent threats.
181+
The XRP Core Vault features enhanced security measures for managing daily liquidity, including escrow time-locking and a minimum reserve in multisig setups.
182+
It has an emergency pause function and "Red Alert Mode" for urgent threats.
180183

181-
In case of a security issue, all signing is halted pending governance review. Escrow accounts may be unlocked to prevent asset loss, with governance overseeing the restoration of operations. Only one escrow can be unlocked per day, minimizing potential damage.
184+
In case of a security issue, all signing is halted pending governance review.
185+
Escrow accounts may be unlocked to prevent asset loss, with governance overseeing the restoration of operations.
186+
Only one escrow can be unlocked per day, minimizing potential damage.
182187

183188
## Summary
184189

docs/fassets/07-liquidation.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ description: Understand how liquidations work in FAssets.
44
keywords: [fassets, xrp, bitcoin, dogecoin, flare-network]
55
---
66

7-
Liquidation is the process of selling assets to bring the FAssets system back to health after an [agent](/fassets/overview#agents) becomes undercollateralized. The following types of liquidation can occur:
7+
Liquidation is the process of selling assets to bring the FAssets system back to health after an [agent](/fassets/overview#agents) becomes undercollateralized.
8+
The following types of liquidation can occur:
89

910
- **Unhealthy position liquidation**: Occurs when the [collateral ratio (CR)](/fassets/collateral#collateral-ratio) of either the agent's vault or collateral pool falls below its respective [minimal CR](/fassets/collateral#system-wide-thresholds).
1011
In this case, the agent's position is liquidated until the collateral ratio reaches the [safety CR](/fassets/collateral#system-wide-thresholds) or all of the backed FAssets are liquidated.

docs/fassets/09-operational-parameters.mdx

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,13 @@ import TabItem from "@theme/TabItem";
1010

1111
import OperationalParameters from "@site/src/features/FAssets/OperationalParameters";
1212

13-
This page lists the current values for the most important parameters of the FAssets system on **Songbird Canary-Network** and **Songbird Testnet Coston**. These values are subject to change as the system is further developed and tested.
13+
This page lists the current values for the most important parameters of the FAssets system on **Songbird Canary-Network** and **Songbird Testnet Coston**.
14+
These values are subject to change as the system is further developed and tested.
1415

1516
## Asset Manager Operational Parameters
1617

17-
To get the default agent settings, you need to call the `getSettings` function on the `IAssetManager` interface. Read more about the `IAssetManager` interface [here](/fassets/reference/IAssetManager).
18+
To get the default agent settings, you need to call the `getSettings` function on the `IAssetManager` interface.
19+
Read more about the `IAssetManager` interface [here](/fassets/reference/IAssetManager).
1820

1921
### Minting and Redeeming
2022

@@ -48,13 +50,15 @@ To get the default agent settings, you need to call the `getSettings` function o
4850

4951
### Core Vault Manager
5052

51-
To get the Core Vault manager operational parameters you need to use the [`ICoreVaultManager`](/fassets/reference/ICoreVaultManager) interface. Specific functions added to each parameter.
53+
To get the Core Vault manager operational parameters you need to use the [`ICoreVaultManager`](/fassets/reference/ICoreVaultManager) interface.
54+
Specific functions added to each parameter.
5255

5356
<OperationalParameters sectionTitle="Core Vault Manager" hideBtc hideDoge />
5457

5558
### Core Vault Settings
5659

57-
To get the Core Vault settings you need to use the [`IAssetManager`](/fassets/reference/IAssetManager) interface. Specific functions added to each parameter.
60+
To get the Core Vault settings you need to use the [`IAssetManager`](/fassets/reference/IAssetManager) interface.
61+
Specific functions added to each parameter.
5862

5963
<OperationalParameters sectionTitle="Core Vault Settings" hideBtc hideDoge />
6064

docs/fassets/11-songbird.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ keywords: [fassets, xrp, bitcoin, dogecoin, flare-network]
66

77
import JiraIssueCollector from "/src/components/JiraIssueCollector";
88

9-
The launch of FAssets on Songbird Canary-Network demonstrates system behavior while paving the way for its next deployment on Flare Mainnet. The primary goals of this test are to ensure the system operates as intended, identify edge cases, refine usability and automation, and incentivize whitehat security researchers to uncover potential code errors.
9+
The launch of FAssets on Songbird Canary-Network demonstrates system behavior while paving the way for its next deployment on Flare Mainnet.
10+
The primary goals of this test are to ensure the system operates as intended, identify edge cases, refine usability and automation, and incentivize whitehat security researchers to uncover potential code errors.
1011

1112
The test on Songbird Canary-Network will have the following characteristics:
1213

0 commit comments

Comments
 (0)