Skip to content

Commit aba4dc3

Browse files
committed
fix(docs): improve clarity and grammar in FAssets redemption and default guides
1 parent 029c5ed commit aba4dc3

File tree

2 files changed

+51
-51
lines changed

2 files changed

+51
-51
lines changed

docs/fassets/3-redemption.mdx

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,12 @@ 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 their own address they control on the underlying chain.
37+
Agents can pay the redemption from their own address, which 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.
4141

42-
6. The agent (or, in Core Vault and certain flows, the **executor**) presents the payment proof to the FAssets system, which issues a **redemption ticket**.
42+
6. The agent (or, in Core Vault and specific flows, the **executor**) presents the payment proof to the FAssets system, which issues a **redemption ticket**.
4343

4444
The executor role is responsible for ensuring that the system can finalize redemptions even if the agent is unresponsive or if the flow is managed by a central entity (such as the Core Vault executor).
4545

@@ -54,92 +54,92 @@ This is the summary of the redemption process:
5454
## Redemption-Payment Failure
5555

5656
Agents have a limited time to pay the redeemer on the underlying chain.
57-
The amount of time is defined by the last block and the last timestamp on the underlying chain.
58-
If the payment is not made in time, the redeemer has to prove [payment non existence](/fdc/attestation-types/referenced-payment-nonexistence) to be compensated.
59-
After the redeemer presents the payment non existence proof, he is paid with the agent's collateral plus a _redemption default premium_.
57+
The last block and the last timestamp on the underlying chain define the amount of time.
58+
If the payment is not made in time, the redeemer has to prove [payment non-existence](/fdc/attestation-types/referenced-payment-nonexistence) to be compensated.
59+
After the redeemer presents the payment non-existence proof, he is paid with the agent's collateral plus a _redemption default premium_.
6060
The premium is intended to encourage the agent to complete redemptions by paying with the underlying asset instead of collateral.
6161

62-
If a payment fails and the failed transaction is recorded on the underlying chain, the agent must submit a proof of failed payment.
62+
If a payment fails and the failed transaction is recorded on the underlying chain, the agent must submit proof of the failed payment.
6363
In this way, the gas costs of the failed transaction can be accounted for by the FAssets system.
64-
If the transaction was not recorded, then no gas was spent and reporting is not necessary.
64+
If the transaction was not recorded, then no gas was spent, and reporting is not necessary.
6565

6666
If the agent does not report the failed payment in time, anyone (including the executor) can report the failed payment and receive a reward from the agent's vault.
6767

6868
:::info
6969

70-
When payment fails because of the redeemer, the agent can obtain a proof of the failed payment from the Flare Data Connector and present it to the FAssets system.
70+
When payment fails because of the redeemer, the agent can obtain proof of the failed payment from the Flare Data Connector and present it to the FAssets system.
7171
The agent's obligation is then fulfilled, and he can keep both the collateral and the underlying.
7272

7373
Two different proofs can be used:
7474

7575
* Proof of invalid address, due to a wrong syntax or checksum, for example.
7676
* Proof of blocked payment: Even if the address is valid, it might contain a contract that blocks the payment.
77-
This can only happen on underlying networks supporting smart contracts.
77+
This can only occur on underlying networks that support smart contracts.
7878

79-
The agent must still try to pay and, if the payment is blocked, the agent can request this proof from the Flare Data Connector and present it to the FAssets system.
79+
The agent must still try to pay, and if the payment is blocked, the agent can request this proof from the Flare Data Connector and present it to the FAssets system.
8080

8181
:::
8282

8383
During step 4 above, if any agent does not pay on the underlying chain, the redeemer completes the following procedure separately for each nonpaying agent:
8484

85-
1. The redeemer obtains a proof of payment non existence from the Flare Data Connector.
86-
2. The redeemer presents the payment non existence proofs to the FAssets system, which triggers a redemption failure.
85+
1. The redeemer obtains a proof of payment non-existence from the Flare Data Connector.
86+
2. The redeemer presents the payment non-existence proofs to the FAssets system, which triggers a redemption failure.
8787
3. The redeemer is paid with collateral, according to the current price plus a premium.
8888
4. FAssets are overcollateralized, so, even after paying the redeemer with a premium, a remainder is released.
89-
This remainder is derived by the [system-wide collateral ratio settings](/fassets/collateral#system-wide-thresholds) specified by governance.
89+
This remainder is derived from the [system-wide collateral ratio settings](/fassets/collateral#system-wide-thresholds) specified by governance.
9090
5. The underlying assets backing the redeemed FAssets are marked as free and can be withdrawn by the agent later.
9191

9292
## Edge Cases
9393

9494
### Unresponsive redeemer
9595

9696
After a redemption nonpayment, the redeemer might not report the failure for some reason.
97-
In this case, the agent or the executor can present a payment non existence proof, and the redeemer receives collateral plus a premium.
97+
In this case, the agent or the executor can present a payment non-existence proof, and the redeemer receives collateral plus a premium.
9898
After this operation, the underlying backing collateral and the remaining local collateral are released.
9999

100100
### Unresponsive agent
101101

102102
After a successful payment, the agent might not present the payment proof (redemption ticket).
103103

104104
Because the agent has already paid, the redeemer is not affected.
105-
However, the system still requires the payment proof to correctly track the agent's balance on the underlying chain.
106-
After enough time for the agent to present the proof has elapsed, anyone, including the executor, can present the payment proof and receive collateral from the agent's vault as a reward.
105+
However, the system still requires the payment proof to track the agent's balance on the underlying chain correctly.
106+
After enough time for the agent to present the proof has elapsed, anyone, including the executor, can show the payment proof and receive collateral from the agent's vault as a reward.
107107

108108
### Expired proof
109109

110-
Proofs provided by the Flare Data Connector are available for only 24 hours, approximately.
111-
If neither the redeemer, the agent, nor the executor presents the proof of payment or payment non existence within 24 hours, the regular redeeming process cannot continue, and the agent's collateral could be locked indefinitely.
110+
Proofs provided by the Flare Data Connector are available for approximately 24 hours.
111+
If neither the redeemer, the agent, nor the executor presents the proof of payment or payment non-existence within 24 hours, the regular redemption process cannot continue, and the agent's collateral could be locked indefinitely.
112112

113113
The procedure to recover this collateral is the same as the procedure in the minting case.
114114

115115
## Redemption Fee
116116

117-
The redemption fee is the amount of the underlying asset that the agent can keep for doing the redemption.
118-
This fee is meant only to cover the agent's transaction fee on the underlying chain, so it is not shared with the collateral pool.
117+
The redemption fee is the amount of the underlying asset that the agent retains upon redemption.
118+
This fee is intended solely to cover the agent's transaction fee on the underlying chain, and therefore, it is not shared with the collateral pool.
119119
The fee percentage is defined by governance, is the same for all agents, and is typically smaller than the minting fee.
120120

121-
Governance calculates the percentage so that the fee to redeem 1 lot pays for a typical transaction fee on the underlying chain.
122-
Therefore, when larger amounts on a single address are redeemed, the agent accrues some extra fees because the underlying fee for small and large transactions is the same.
123-
However, when underlying fees are very high, the agent might still lose funds when a redemption for a small amount, such as 1 lot, is made.
121+
Governance calculates the percentage so that the fee to redeem one lot pays for a typical transaction fee on the underlying chain.
122+
Therefore, when larger amounts are redeemed at a single address, the agent accrues additional fees because the underlying fee for both small and large transactions is the same.
123+
However, when underlying fees are very high, the agent might still lose funds when a redemption for a small amount, such as one lot, is made.
124124
If this situation occurs frequently, governance will increase the redemption-fee percentage.
125125

126126
## Self-redemption
127127

128128
Agents can also act as users and redeem FAssets from their own vaults.
129129
This process is called self-redemption or self-closing, and it is simplified because payment on the underlying chain is not required.
130130

131-
As shown in the following process, agents can self-redeem for any reason, including to stop liquidations because it reduces the amount of FAssets the agent is backing.
131+
As shown in the following process, agents can self-redeem for any reason, including to prevent liquidations, as it reduces the amount of FAssets the agent is backing.
132132

133133
1. An agent sends FAssets to their account.
134134
2. FAssets are burned.
135135
3. The collateral that was backing those assets is released.
136136
4. The underlying collateral is released and can be withdrawn from the underlying address later.
137137

138-
The self-redeemed amount is not limited to a positive integer of lots and can be less than 1 lot, which makes self-closing ideal for redeeming an agent's dust.
138+
The self-redeemed amount is not limited to a positive integer of lots and can be less than one lot, which makes self-closing ideal for redeeming an agent's dust.
139139

140140
:::tip[What's next]
141141

142-
Learn more about the different components and processes involved in FAssets - [collateral](/fassets/collateral), [minting](/fassets/minting), [liquidations](/fassets/liquidation) and [Core Vault](/fassets/core-vault).
142+
Learn more about the different components and processes involved in FAssets - [collateral](/fassets/collateral), [minting](/fassets/minting), [liquidations](/fassets/liquidation), and [Core Vault](/fassets/core-vault).
143143

144144
For developer resources, explore our [FXRP address](/fassets/developer-guides/fassets-fxrp-address), [minting](/fassets/developer-guides/fassets-mint), and [redemption](/fassets/developer-guides/fassets-redeem) guides to get started with FAssets integration.
145145

docs/fassets/developer-guides/10-fassets-redemption-default.mdx

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,17 @@ sidebar_position: 10
99

1010
## Overview
1111

12-
In the FAssets system, once a **redeemer submits a redemption request**, the assigned **agent must send the underlying asset** (e.g., XRP) to the redeemer within a specific time that is defined by the [operational parameters](/fassets/operational-parameters).
12+
In the FAssets system, once a **redeemer submits a redemption request**, the assigned **agent must send the underlying asset** (e.g., XRP) to the redeemer within a specific time defined in the [operational parameters](/fassets/operational-parameters).
1313

1414
This guide explains:
1515

1616
- How to **observe the redemption deadline**.
17-
- What parameters to use (`underlyingSecondsForPayment`, `underlyingBlocksForPayment`)
17+
- What parameters to use (`underlyingSecondsForPayment`, `underlyingBlocksForPayment`).
1818
- How to **handle agent failure** by calling [`redemptionPaymentDefault`](/fassets/reference/IAssetManager#redemptionpaymentdefault).
1919

2020
## Prerequisites
2121

22-
- Basic understanding of [FAssets system](/fassets/overview).
22+
- Basic understanding of the [FAssets system](/fassets/overview).
2323
- [Flare Network Periphery Contracts](https://www.npmjs.com/package/@flarenetwork/flare-periphery-contracts) package.
2424

2525
## Key Operational Parameters
@@ -30,7 +30,7 @@ These parameters define both the minimum time window and block range during whic
3030
| Parameter | Unit | Purpose |
3131
| ----------------------------- | ------- | ------------------------------------------------------------------------------------ |
3232
| `underlyingSecondsForPayment` | seconds | The minimum time allowed for an agent to pay for a redemption. |
33-
| `underlyingBlocksForPayment` | blocks | The number of underlying blocks during which the agent can pay the underlying value. |
33+
| `underlyingBlocksForPayment` | blocks | The number of underlying blocks during which the agent can pay the underlying value. |
3434

3535
Both values are defined per asset in the FAssets system and can be fetched from the [Asset Manager contract](/fassets/developer-guides/fassets-settings-solidity).
3636

@@ -40,34 +40,34 @@ When a redemption is created, the [`RedemptionRequested`](/fassets/reference/IAs
4040

4141
From this event, you can obtain the following:
4242

43-
- `requestId` - unique identifier for the redemption.
44-
- `agentVault` - the agent vault responsible for payment.
45-
- `redeemer` - address requesting redemption.
46-
- `underlyingAddress` - the destination address on the underlying chain.
47-
- `paymentReference` - a unique hash for proof tracking.
48-
- `firstUnderlyingBlock` - the first underlying block to submit payment.
49-
- `lastUnderlyingBlock` - the last underlying block to submit payment.
50-
- `lastUnderlyingTimestamp` the **deadline** on the underlying chain for submitting the redemption payment.
51-
52-
You should wait until the deadline is passed and then check whether the agent has paid the redemption payment in the underlying chain.
53-
The two values work together as a dual safety mechanism: `lastUnderlyingBlock` ensures payment happens within a reasonable number of blocks, while `lastUnderlyingTimestamp` ensures payment occurs within a reasonable amount of time.
43+
- `requestId`: unique identifier for the redemption.
44+
- `agentVault`: the agent vault responsible for the payment.
45+
- `redeemer`: address requesting redemption.
46+
- `underlyingAddress`: the destination address on the underlying chain.
47+
- `paymentReference`: a unique hash for proof tracking.
48+
- `firstUnderlyingBlock`: the first underlying block to submit payment.
49+
- `lastUnderlyingBlock`: the last underlying block to submit payment.
50+
- `lastUnderlyingTimestamp`: the **deadline** on the underlying chain for submitting the redemption payment.
51+
52+
Wait until the deadline passes, then check whether the agent made the redemption payment on the underlying chain.
53+
These two values work together as a dual safety mechanism: `lastUnderlyingBlock` ensures the payment happens within a reasonable number of blocks, while `lastUnderlyingTimestamp` guarantees the payment occurs within a reasonable amount of time.
5454
Both constraints must be satisfied for the payment to be considered valid, providing robust protection against timing-based attacks.
5555

5656
The [`RedemptionPerformed`](/fassets/reference/IAssetManagerEvents#redemptionperformed) event is emitted by the Asset Manager contract when the redemption payment is completed.
5757

5858
:::info
59-
The simplest way to observe if a redemption payment has been made is to use the [xrpl](https://www.npmjs.com/package/xrpl) Node.js package to monitor the redeemer's account balance.
60-
Wait until the `underlyingSecondsForPayment` and `underlyingBlocksForPayment` deadlines pass, then check if the account balance has increased by the expected redemption amount.
59+
The simplest way to observe if a redemption payment has been made is to use the [xrpl](https://www.npmjs.com/package/xrpl) Node.js package to monitor incoming transactions to the `underlyingAddress` (the redeemer's address on the underlying chain).
60+
Wait until the `underlyingSecondsForPayment` and `underlyingBlocksForPayment` deadlines pass, then check if any incoming transactions match the expected redemption amount.
6161
To verify the payment is for the correct redemption, compare the memo data in the XRP transaction to the `paymentReference` from the `RedemptionRequested` event.
6262
:::
6363

6464
## Handling Non-Payment
6565

66-
If the agent fails to pay the redemption payment in the XRP Ledger, the redeemer or the executor can start the redemption default process.
66+
If the agent fails to complete the redemption in the XRP Ledger, the redeemer or the executor can initiate the redemption default process.
6767

6868
### Generate the Proof of Payment Non-Existence
6969

70-
With information from the [`RedemptionRequested`](/fassets/reference/IAssetManagerEvents#redemptionrequested) event, you can generate the attestation request for the [ReferencedPaymentNonexistence](/fdc/attestation-types/referenced-payment-nonexistence) attestation type.
70+
With the information from the [`RedemptionRequested`](/fassets/reference/IAssetManagerEvents#redemptionrequested) event, you can generate the attestation request for the [ReferencedPaymentNonexistence](/fdc/attestation-types/referenced-payment-nonexistence) attestation type.
7171

7272
Use the following parameters:
7373

@@ -88,9 +88,9 @@ Check the [ReferencedPaymentNonexistence](/fdc/attestation-types/referenced-paym
8888

8989
### Execute the Redemption Default
9090

91-
After the attestation request is confirmed, you can retrieve the proof of payment non-existence of the redemption payment on the XRP Ledger.
91+
After the attestation request is confirmed, you can retrieve the proof of payment for the non-existence of the redemption payment on the XRP Ledger.
9292

93-
The redeemer or executor can execute the redemption default process by calling the [`redemptionPaymentDefault`](/fassets/reference/IAssetManager#redemptionpaymentdefault) function on the Asset Manager contract.
93+
The redeemer or the executor can execute the redemption default process by calling the [`redemptionPaymentDefault`](/fassets/reference/IAssetManager#redemptionpaymentdefault) function on the AssetManager contract.
9494

9595
This function requires two parameters:
9696

@@ -103,22 +103,22 @@ It does the following:
103103
- Verifies that both the `underlyingSecondsForPayment` and `underlyingBlocksForPayment` deadlines have passed.
104104
- Executes the compensation payment to the redeemer or the executor from the agent's collateral.
105105
- Releases the agent's locked collateral.
106-
- Emits [`RedemptionDefaulted`](/fassets/reference/IAssetManagerEvents#redemptiondefault) event.
106+
- Emits the [`RedemptionDefaulted`](/fassets/reference/IAssetManagerEvents#redemptiondefault) event.
107107

108108
## Summary
109109

110110
In this guide, you learned how to monitor redemption requests and handle agent payment failures in the FAssets system:
111111

112-
- **Monitor deadlines**: Track the [`RedemptionRequested`](/fassets/reference/IAssetManagerEvents#redemptionrequested) event and wait for the payment deadline to pass.
112+
- **Monitor the deadlines**: Track the [`RedemptionRequested`](/fassets/reference/IAssetManagerEvents#redemptionrequested) event and wait for the payment deadline to pass.
113113
- **Generate proof**: Create a [`ReferencedPaymentNonexistence`](/fdc/attestation-types/referenced-payment-nonexistence) attestation using the [Flare Data Connector](/fdc/overview).
114114
- **Execute default**: Call [`redemptionPaymentDefault`](/fassets/reference/IAssetManager#redemptionpaymentdefault) to trigger compensation from the agent's collateral.
115115

116-
This process ensures redeemers can recover their funds when agents fail to fulfill payment obligations.
116+
This process ensures redeemers can recover their funds when agents fail to meet their payment obligations.
117117

118118
:::tip Next Steps
119119
To continue your FAssets development journey, you can:
120120

121121
- Learn how to [mint FXRP](/fassets/developer-guides/fassets-mint)
122122
- Understand how to [redeem FXRP](/fassets/developer-guides/fassets-redeem)
123123
- Explore [FAssets system settings](/fassets/operational-parameters)
124-
:::
124+
:::

0 commit comments

Comments
 (0)