Skip to content

Commit c333c41

Browse files
authored
fix(docs): fix FAssets formula and explanation (#886)
1 parent b73e27e commit c333c41

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

docs/fassets/3-redemption.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ This is the summary of the redemption process:
3434

3535
4. Every agent pays the redeemer on the underlying chain and includes the payment reference in the memo field of the payment transaction.
3636

37-
Agents can pay the redemption from any address they control on the underlying chain.
37+
Agents can pay the redemption from their own address they control on the underlying chain.
3838
It does not need to be the same address where they receive minting payments.
3939

4040
5. After the payment is finalized, the agent uses the [FDC](/fdc/overview) to prove the payment and obtain a payment proof.

docs/fassets/4-collateral.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -213,21 +213,21 @@ It is worth noting that:
213213
<details>
214214
<summary>Fee entitlement formulae and examples.</summary>
215215

216-
The following formulas consider all the above information to calculate each provider's due share of FAsset minting fees.
216+
The following formulas are based on the concept of virtual fees, which are the fees that a provider would be entitled to if they had no fee debt.
217217

218218
The amount of debt a provider $p$ is assigned upon entering a pool is calculated as:
219219

220220
$$
221-
fee\_debt_p = { added\_collateral_p \over collateral\_in\_pool } \times fees\_in\_pool
221+
fee\_debt_p = { added\_collateral_p \over collateral\_in\_pool } \times total\_virtual\_fees
222222
$$
223223

224224
where:
225225

226226
- $added\_collateral_p$ is the amount of FLR tokens that provider $p$ is adding to the pool.
227227
- $collateral\_in\_pool$ is the amount of FLR tokens in the pool before adding the new tokens.
228-
- $fees\_in\_pool$ is the amount of FAsset minting fees currently in the pool.
228+
- $total\_virtual\_fees$ is the sum of all provider's virtual fees.
229229

230-
The following formulas are based on the concept of **virtual fees**, which are the fees that a provider would be entitled to if they had no fee debt.
230+
The following formulas use **total virtual fees**, which are the gross fees accrued to a provider assuming no prior fee withdrawals, slashing, or outstanding fee debt.
231231

232232
The **total virtual fees** is the sum of all provider's virtual fees and can be expressed as:
233233

@@ -269,7 +269,7 @@ The following example shows fee entitlement.
269269
| An agent creates a new vault. | 0 | 0 | 0 | 0 |
270270
| Alice deposits 100 FLR and gets 100 CPTs in return. | **100** | 0 | 0 | 0 |
271271
| 10 FAssets of fees are added to the pool due to a mint. | 100 | **10** | 0 | **10** |
272-
| Bob deposits 100 FLR and gets 100s CPT in return. | **200** | 10 | **10** | **20** |
272+
| Bob deposits 100 FLR and gets 100 CPTs in return. | **200** | 10 | **10** | **20** |
273273
| 10 more FAssets of fees are added to the pool due to another mint. | 200 | **20** | 10 | **30** |
274274
| Alice withdraws 10 FAssets of fees. | 200 | **10** | **20** | 30 |
275275
| Bob exits the pool by returning the 100 CPTs and withdrawing 100 FLR. | **100** | **5** | **10** | **15** |

0 commit comments

Comments
 (0)