Skip to content

Commit 37e2202

Browse files
feat(docs): update redemption guide
1 parent 23db96c commit 37e2202

1 file changed

Lines changed: 19 additions & 1 deletion

File tree

docs/fassets/04-redemption.mdx

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@ To do so, these holders, known as redeemers, send FAssets to the Asset Manager s
1111

1212
This is the summary of the redemption process:
1313

14-
1. The redeemer starts the redemption for a positive integer of lots by issuing a request to the Asset Manager smart contract.
14+
1. The redeemer starts the redemption by issuing a request to the Asset Manager smart contract.
15+
The standard `redeem` method requires a whole number of lots, while `redeemAmount` and `redeemWithTag` allow redeeming any amount.
1516

1617
The FAssets system chooses one or more redemption tickets from the front of the [FIFO redemption queue](/fassets/minting#redemption-tickets-and-the-redemption-queue).
1718
The number of chosen redemption tickets is capped to avoid high gas consumption.
@@ -51,6 +52,23 @@ This is the summary of the redemption process:
5152

5253
After the collateral is released, it can either back the minting of more FAssets or be withdrawn.
5354

55+
## Redeem Any Amount
56+
57+
The standard `redeem` method requires whole lots.
58+
The `redeemAmount` method allows redeeming **any amount** of FAssets, which is useful for redeeming yields or partial amounts that don not align with lot boundaries.
59+
60+
No redemption can be smaller than `minimumRedeemAmountUBA` to prevent uneconomical micro-redemptions.
61+
62+
## Redeem with Tag
63+
64+
The `redeemWithTag` method allows the redeemer to request an **XRP destination tag** on the redemption payment.
65+
This is useful when redeeming directly to an exchange address that requires a destination tag.
66+
Like `redeemAmount`, it also supports redeeming any amount, not just whole lots.
67+
68+
This is an XRP-only feature, gated by the `redeemWithTagSupported` flag.
69+
Confirming a redemption with a tag requires the `confirmXRPRedemptionPayment` method, which uses a dedicated FDC proof type that supports destination tags.
70+
If the agent fails to pay, the redeemer calls `xrpRedemptionPaymentDefault` to trigger the default process.
71+
5472
## Fees
5573

5674
These fees are charged when a user redeems FAssets for the underlying asset:

0 commit comments

Comments
 (0)