Skip to content

Commit dbdf33b

Browse files
authored
feat(docs): add video tutorials to FAssets minting and redemption guides (#1013)
1 parent 7738f1d commit dbdf33b

File tree

4 files changed

+21
-0
lines changed

4 files changed

+21
-0
lines changed

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ keywords: [fassets, flare-network]
77
sidebar_position: 10
88
---
99

10+
import YoutubeEmbed from "@site/src/components/youtube";
11+
1012
## Overview
1113

1214
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).
@@ -105,6 +107,10 @@ It does the following:
105107
- Releases the agent's locked collateral.
106108
- Emits the [`RedemptionDefaulted`](/fassets/reference/IAssetManagerEvents#redemptiondefault) event.
107109

110+
## Video Tutorial
111+
112+
<YoutubeEmbed videoId="a737yFcglnM?si=bHoFxhrlWhMCxEQr&start=275"></YoutubeEmbed>
113+
108114
## Summary
109115

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

docs/fassets/developer-guides/5-fassets-mint.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ import FAssetsCreateXrpPayment from "!!raw-loader!/examples/developer-hub-javasc
1414
import FAssetsExecuteMinting from "!!raw-loader!/examples/developer-hub-javascript/fassetsExecuteMinting.ts";
1515
import MintingFees from "./_minting_fees.mdx";
1616
import PaymentTimeframes from "./_payment_timeframes.mdx";
17+
import YoutubeEmbed from "@site/src/components/youtube";
1718

1819
## Overview
1920

@@ -127,6 +128,10 @@ This script demonstrates how to retrieve the FDC proof and execute minting.
127128
10. Call the [`executeMinting`](/fassets/reference/IAssetManager#executeminting) function on the AssetManager contract and send a transaction to the Flare network to convert the attested XRP payment into FXRP (minting).
128129
11. On a successful transaction call the `parseExecutemintingEvents` function to extract and log events [`RedemptionTicketCreated`](/fassets/reference/IAssetManagerEvents#redemptionticketcreated) and [`MintingExecuted`](/fassets/reference/IAssetManagerEvents#mintingexecuted).
129130

131+
## Video Tutorial
132+
133+
<YoutubeEmbed videoId="a737yFcglnM?si=5L0owLyQREvO09d8"></YoutubeEmbed>
134+
130135
## Summary
131136

132137
Now that you have successfully minted FAssets, you can use them in Flare dApps or transfer them to other users or smart contracts within the Flare ecosystem.

docs/fassets/developer-guides/6-fassets-mint-executor.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ import FAssetsCreateXrpPayment from "!!raw-loader!/examples/developer-hub-javasc
1414
import FAssetsExecuteMinting from "!!raw-loader!/examples/developer-hub-javascript/fassetsExecuteMinting.ts";
1515
import MintingFees from "./_minting_fees.mdx";
1616
import PaymentTimeframes from "./_payment_timeframes.mdx";
17+
import YoutubeEmbed from "@site/src/components/youtube";
1718

1819
## Overview
1920

@@ -141,6 +142,10 @@ This script demonstrates how to retrieve the FDC proof and execute minting.
141142
8. Call the [`executeMinting`](/fassets/reference/IAssetManager#executeminting) function on the AssetManager contract and send a transaction to the Flare network to convert the attested XRP payment into FXRP (minting).
142143
9. On a successful transaction call `parseExecutemintingEvents` to extract and log events [`RedemptionTicketCreated`](/fassets/reference/IAssetManagerEvents#redemptionticketcreated) and [`MintingExecuted`](/fassets/reference/IAssetManagerEvents#mintingexecuted).
143144

145+
## Video Tutorial
146+
147+
<YoutubeEmbed videoId="a737yFcglnM?si=5L0owLyQREvO09d8"></YoutubeEmbed>
148+
144149
## Summary
145150

146151
Now that you have successfully minted FAssets using the executor, you can use them in Flare dApps or transfer them to other users or smart contracts within the Flare ecosystem.

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import CodeBlock from "@theme/CodeBlock";
1111
import Remix from "@site/src/components/remix";
1212
import FAssetsRedeem from "!!raw-loader!/examples/developer-hub-solidity/FAssetsRedeem.sol";
1313
import RedemptionProcessPrerequisites from "./_redemption_process_prerequisites.mdx";
14+
import YoutubeEmbed from "@site/src/components/youtube";
1415

1516
## Overview
1617

@@ -342,6 +343,10 @@ If the agent is unable to pay the redemption payment in the specified time, the
342343
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.
343344
3. The redeemer receives collateral plus a premium.
344345

346+
## Video Tutorial
347+
348+
<YoutubeEmbed videoId="a737yFcglnM?si=bHoFxhrlWhMCxEQr&start=275"></YoutubeEmbed>
349+
345350
## Summary
346351

347352
This is only the first step of the redemption process.

0 commit comments

Comments
 (0)