Skip to content

Commit 5197c93

Browse files
authored
feat(docs): enhance minting process documentation with visual aids and structured sections (#750)
1 parent c665d66 commit 5197c93

File tree

3 files changed

+45
-21
lines changed

3 files changed

+45
-21
lines changed

docs/fassets/3-minting.mdx

Lines changed: 43 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,40 +4,62 @@ description: Understand how minting works in FAssets.
44
keywords: [fassets, xrp, bitcoin, dogecoin, flare-network]
55
---
66

7+
import ThemedImage from "@theme/ThemedImage";
8+
import useBaseUrl from "@docusaurus/useBaseUrl";
9+
710
Minting FAssets is the process of wrapping underlying tokens from connected blockchains into FAssets to be used on the Flare blockchain.
811
Any user can mint FAssets.
912

1013
## Minting Process
1114

15+
<ThemedImage
16+
alt="FAssets Minting Process"
17+
sources={{
18+
light: useBaseUrl("img/fassets/flare_fassets_minting_light.svg"),
19+
dark: useBaseUrl("img/fassets/flare_fassets_minting_dark.svg"),
20+
}}
21+
/>
22+
1223
This is the summary of the minting process:
1324

14-
1. The minter chooses an agent from the publicly available [agent list](/fassets/overview#agents).
15-
The choice is based on the minting fee or the amount of free collateral, which must be enough to back the amount to be minted.
16-
2. The minter sends to the Asset Manager contract a collateral reservation transaction (CRT). The CRT includes:
25+
### 1. Reserving Collateral
26+
27+
The minter chooses an agent from the publicly available [agent list](/fassets/overview#agents).
28+
The choice is based on the minting fee or the amount of free collateral, which must be enough to back the amount to be minted.
1729

18-
- The address of the chosen agent.
19-
- The amount to mint, which must be a whole number of [lots](/fassets/minting#lots).
20-
- The [collateral reservation fee (CRF)](#fees) to compensate for the locked collateral.
21-
- The executor's address, if the minter is not the executor.
22-
- The executor's fee, if the minter is not the executor.
30+
The minter sends to the Asset Manager contract a collateral reservation transaction (CRT). The CRT includes:
2331

24-
3. The Asset Manager contract locks the agent's collateral in the amount needed to back the whole minting until the underlying payment is proved or disproved.
25-
The collateral reservation response is an event issued by the contract, which includes:
32+
- The address of the chosen agent.
33+
- The amount to mint, which must be a whole number of [lots](/fassets/minting#lots).
34+
- The [collateral reservation fee (CRF)](#fees) to compensate for the locked collateral.
35+
- The executor's address, if the minter is not the executor.
36+
- The executor's fee, if the minter is not the executor.
2637

27-
- The agent's address to which the minter must send funds on the underlying chain.
28-
- The amount to be paid on the underlying chain, which corresponds to the amount to be minted plus the agent's fee.
29-
- The payment reference, which is a unique 32-byte number the minter must include as a memo in the payment on the underlying chain.
30-
- The last underlying block and the last underlying timestamp to pay.
31-
Valid payments occur either before the last block or before the last timestamp, both inclusive.
32-
- The executor's address, if the minter is not the executor.
33-
- The executor's fee, if the minter is not the executor.
38+
The Asset Manager contract locks the agent's collateral in the amount needed to back the whole minting until the underlying payment is proved or disproved.
39+
The collateral reservation response is an event issued by the contract, which includes:
40+
41+
- The agent's address to which the minter must send funds on the underlying chain.
42+
- The amount to be paid on the underlying chain, which corresponds to the amount to be minted plus the agent's fee.
43+
- The payment reference, which is a unique 32-byte number the minter must include as a memo in the payment on the underlying chain.
44+
- The last underlying block and the last underlying timestamp to pay.
45+
Valid payments occur either before the last block or before the last timestamp, both inclusive.
46+
- The executor's address, if the minter is not the executor.
47+
- The executor's fee, if the minter is not the executor.
3448

3549
The time to pay is measured both in the underlying chain's block numbers and block times because the underlying chain might halt for a long time.
3650
In this situation, the block numbers do not increment but the block timestamps do.
3751

38-
4. After this event is emitted, the minter must pay the full underlying amount plus the fee to the agent on the underlying chain in a certain amount of time.
39-
5. Using the Data Connector, the minter or executor proves the payment on Flare.
40-
6. After the payment is proved, the minter or executor executes the minting process, which sends FAssets to the minter's account.
52+
### 2. Underlying Payment
53+
54+
After this event is emitted, the minter must pay the full underlying amount plus the fee to the agent on the underlying chain in a certain amount of time.
55+
56+
### 3. Payment Proof
57+
58+
Using the [Flare Data Connector](/fdc/overview), the minter or executor proves the payment on Flare network.
59+
60+
### 4. Minting Execution
61+
62+
After the payment is proved, the minter or executor executes the minting process, which sends FAssets to the minter's account.
4163

4264
When minting is executed, the [minting fee](#fees) is split between the agent and the pool:
4365

@@ -49,7 +71,7 @@ When minting is executed, the [minting fee](#fees) is split between the agent an
4971

5072
After minting is complete, the Asset Manager creates a [redemption ticket](#redemption-tickets-and-the-redemption-queue), which includes the mint amount and the name of the agent backing the minting.
5173

52-
### Executor Role
74+
## Executor Role
5375

5476
The execution of the minting process can be performed by an **executor**, an external actor such as a bot or service that monitors pending minting requests.
5577
Executors are incentivized to act quickly and correctly, but they hold no special permissions.

static/img/fassets/flare_fassets_minting_dark.svg

Lines changed: 1 addition & 0 deletions
Loading

static/img/fassets/flare_fassets_minting_light.svg

Lines changed: 1 addition & 0 deletions
Loading

0 commit comments

Comments
 (0)