feat(docs): adds redemption default guide, explains redemption, describes redemption requested event by fassko · Pull Request #908 · flare-foundation/developer-hub

fassko · 2025-09-11T18:55:02Z

No description provided.

nikerzetic-aflabs · 2025-09-19T06:41:52Z

docs/fassets/3-redemption.mdx

 The amount of time is defined by the last block and the last timestamp on the underlying chain.
-If the payment is not made in time, the redeemer has to prove nonpayment to be compensated.
-After the redeemer presents the nonpayment proof, he is paid with the agent's collateral plus a _redemption default premium_.
+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.


non-existence

nikerzetic-aflabs · 2025-09-22T10:45:22Z

docs/fassets/3-redemption.mdx

-If the payment is not made in time, the redeemer has to prove nonpayment to be compensated.
-After the redeemer presents the nonpayment proof, he is paid with the agent's collateral plus a _redemption default premium_.
+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.
+After the redeemer presents the payment non existence proof, he is paid with the agent's collateral plus a _redemption default premium_.


non-existence

nikerzetic-aflabs · 2025-09-22T10:45:47Z

docs/fassets/3-redemption.mdx


-1. The redeemer obtains a proof of nonpayment from the Flare Data Connector.
-2. The redeemer presents the nonpayment proofs to the FAssets system, which triggers a redemption failure.
+1. The redeemer obtains a proof of payment non existence from the Flare Data Connector.


non-existence everywhere

nikerzetic-aflabs · 2025-09-22T10:47:46Z

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

+From this event, you can obtain the following:
+
+- `requestId` - unique identifier for the redemption.
+- `agentVault` - the agent vault responsible for payment.


the payment

nikerzetic-aflabs · 2025-09-22T10:52:20Z

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

+- `lastUnderlyingBlock` - the last underlying block to submit payment.
+- `lastUnderlyingTimestamp` — the **deadline** on the underlying chain for submitting the redemption payment.
+
+You should wait until the deadline is passed and then check whether the agent has paid the redemption payment in the underlying chain.


is passed -> has been reached
has paid -> has made (repetition of pay and payment)
on the underlying chain

nikerzetic-aflabs · 2025-09-22T10:55:50Z

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

+
+## Handling Non-Payment
+
+If the agent fails to pay the redemption payment in the XRP Ledger, the redeemer or the executor can start the redemption default process.


pay...payment sound too similar

nikerzetic-aflabs · 2025-09-22T10:56:28Z

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

+
+### Generate the Proof of Payment Non-Existence
+
+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.


Missing an article before information

nikerzetic-aflabs · 2025-09-22T10:58:48Z

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

+
+- `requestId` - unique identifier for the redemption.
+- `agentVault` - the agent vault responsible for payment.
+- `redeemer` - address requesting redemption.


You have - here, but a : later down in the guide

nikerzetic-aflabs · 2025-09-22T11:00:58Z

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

+
+After the attestation request is confirmed, you can retrieve the proof of payment non-existence of the redemption payment on the XRP Ledger.
+
+The redeemer or executor can execute the redemption default process by calling the [`redemptionPaymentDefault`](/fassets/reference/IAssetManager#redemptionpaymentdefault) function on the Asset Manager contract.


AssetManager

Hmm we need to rename in all occurances like that.

nikerzetic-aflabs · 2025-09-22T11:02:15Z

docs/fassets/developer-guides/7-fassets-redeem.mdx

+If the agent is unable to pay the redemption payment in the specified time, the redeemer can:
+
+1. Make a proof of [payment non existence](/fdc/attestation-types/referenced-payment-nonexistence) using the [Flare Data Connector](/fdc/overview).
+2. Execute the [`redemptionPaymentDefault`](/fassets/reference/IAssetManager#redemptionpaymentdefault) function and present the proof of payment non existence to the FAssets system, which triggers a redemption failure.


non-existence

You still have non existence on this line

nikerzetic-aflabs · 2025-09-26T08:40:03Z

docs/fassets/developer-guides/7-fassets-redeem.mdx

+If the agent is unable to pay the redemption payment in the specified time, the redeemer can:
+
+1. Make a proof of [payment non existence](/fdc/attestation-types/referenced-payment-nonexistence) using the [Flare Data Connector](/fdc/overview).
+2. Execute the [`redemptionPaymentDefault`](/fassets/reference/IAssetManager#redemptionpaymentdefault) function and present the proof of payment non existence to the FAssets system, which triggers a redemption failure.


You still have non existence on this line

nikerzetic-aflabs · 2025-09-26T08:40:52Z

docs/fassets/developer-guides/7-fassets-redeem.mdx

+
+If the agent is unable to pay the redemption payment in the specified time, the redeemer can:
+
+1. Make a proof of [payment non existence](/fdc/attestation-types/referenced-payment-nonexistence) using the [Flare Data Connector](/fdc/overview).


You have non existence

…ibes redemption requested event

…tionPaymentCompleted to RedemptionPerformed

…ers and payment verification details

…ult guides

…emption guide

…ts redemption guide

fassko self-assigned this Sep 11, 2025

fassko force-pushed the feat/fassets-redemption-guide-improvements branch from fe96582 to 343bec3 Compare September 17, 2025 13:35

fassko requested a review from nikerzetic-aflabs September 17, 2025 13:57

fassko marked this pull request as ready for review September 17, 2025 13:57

fassko requested a review from dineshpinto as a code owner September 17, 2025 13:57

nikerzetic-aflabs requested changes Sep 22, 2025

View reviewed changes

fassko force-pushed the feat/fassets-redemption-guide-improvements branch 2 times, most recently from a376509 to 3f63e56 Compare September 24, 2025 09:42

fassko requested a review from nikerzetic-aflabs September 24, 2025 11:09

nikerzetic-aflabs requested changes Sep 26, 2025

View reviewed changes

fassko force-pushed the feat/fassets-redemption-guide-improvements branch from f1469bd to 04afd93 Compare September 26, 2025 11:34

fassko requested a review from nikerzetic-aflabs September 26, 2025 11:43

nikerzetic-aflabs approved these changes Sep 30, 2025

View reviewed changes

fassko added 6 commits September 30, 2025 15:15

feat(docs): adds redemption default guide, explains redemption, descr…

238ca93

…ibes redemption requested event

fix(docs): correct event name in redemption default guide from Redemp…

44b37a4

…tionPaymentCompleted to RedemptionPerformed

feat(docs): enhance FAssets redemption guide with operational paramet…

a5a58f0

…ers and payment verification details

fix(docs): improve clarity and grammar in FAssets redemption and defa…

69d086f

…ult guides

fix(docs): correct formatting of parameter description in FAssets red…

420b14b

…emption guide

fix(docs): standardize terminology for payment non-existence in FAsse…

98556e4

…ts redemption guide

fassko force-pushed the feat/fassets-redemption-guide-improvements branch from 67f7dd6 to 98556e4 Compare September 30, 2025 12:15

dineshpinto approved these changes Sep 30, 2025

View reviewed changes

fassko merged commit b1d3a7c into main Sep 30, 2025
13 checks passed

fassko deleted the feat/fassets-redemption-guide-improvements branch September 30, 2025 12:25


		## Handling Non-Payment

		If the agent fails to pay the redemption payment in the XRP Ledger, the redeemer or the executor can start the redemption default process.


		### Generate the Proof of Payment Non-Existence

		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.


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

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


		If the agent is unable to pay the redemption payment in the specified time, the redeemer can:

		1. Make a proof of [payment non existence](/fdc/attestation-types/referenced-payment-nonexistence) using the [Flare Data Connector](/fdc/overview).

Conversation

fassko commented Sep 11, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants