Skip to content

Commit ac11bcb

Browse files
dineshpintodineshpinto
authored
fix(docs): fassets docs in line with dev hub format (#449)
2 parents 15cb5ab + 4766df4 commit ac11bcb

10 files changed

+147
-106
lines changed

‎docs/fassets/6-operational-parameters.mdx

+21-21
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ keywords: [fassets, xrp, bitcoin, dogecoin, flare-network]
88
import Tabs from "@theme/Tabs";
99
import TabItem from "@theme/TabItem";
1010

11-
This page lists the current values for the most important parameters of the FAssets system on the Coston testnet. These values are subject to change as the system is further developed and tested.
11+
This page lists the current values for the most important parameters of the FAssets system on **Songbird Canary-Network** and **Songbird Testnet Coston**. These values are subject to change as the system is further developed and tested.
1212

1313
## Minting and Redeeming
1414

@@ -17,8 +17,8 @@ This page lists the current values for the most important parameters of the FAss
1717
defaultValue="songbird"
1818
groupId="operational-parameters"
1919
values={[
20-
{label: 'Songbird', value: 'songbird'},
21-
{label: 'Coston', value: 'coston'},
20+
{label: "Songbird Canary-Network", value: 'songbird'},
21+
{label: "Songbird Testnet Coston", value: 'coston'},
2222
]}>
2323
<TabItem value="songbird">
2424
| **Parameter** | **XRP** | **BTC** | **DOGE** |
@@ -50,8 +50,8 @@ This page lists the current values for the most important parameters of the FAss
5050
defaultValue="songbird"
5151
groupId="operational-parameters"
5252
values={[
53-
{label: 'Songbird', value: 'songbird'},
54-
{label: 'Coston', value: 'coston'},
53+
{label: "Songbird Canary-Network", value: 'songbird'},
54+
{label: "Songbird Testnet Coston", value: 'coston'},
5555
]}>
5656
<TabItem value="songbird">
5757
| **Parameter** | **XRP** | **BTC** | **DOGE** |
@@ -81,8 +81,8 @@ This page lists the current values for the most important parameters of the FAss
8181
defaultValue="songbird"
8282
groupId="operational-parameters"
8383
values={[
84-
{label: 'Songbird', value: 'songbird'},
85-
{label: 'Coston', value: 'coston'},
84+
{label: "Songbird Canary-Network", value: 'songbird'},
85+
{label: "Songbird Testnet Coston", value: 'coston'},
8686
]}>
8787
<TabItem value="songbird">
8888
| **Parameter** | **XRP** | **BTC** | **DOGE** |
@@ -126,8 +126,8 @@ This page lists the current values for the most important parameters of the FAss
126126
defaultValue="songbird"
127127
groupId="operational-parameters"
128128
values={[
129-
{label: 'Songbird', value: 'songbird'},
130-
{label: 'Coston', value: 'coston'},
129+
{label: "Songbird Canary-Network", value: 'songbird'},
130+
{label: "Songbird Testnet Coston", value: 'coston'},
131131
]}>
132132
<TabItem value="songbird">
133133
| **Parameter** | **XRP** | **BTC** | **DOGE** |
@@ -162,8 +162,8 @@ Agents are free to adjust these settings as they see fit.
162162
defaultValue="songbird"
163163
groupId="operational-parameters"
164164
values={[
165-
{label: 'Songbird', value: 'songbird'},
166-
{label: 'Coston', value: 'coston'},
165+
{label: "Songbird Canary-Network", value: 'songbird'},
166+
{label: "Songbird Testnet Coston", value: 'coston'},
167167
]}>
168168
<TabItem value="songbird">
169169
| **Parameter** | **XRP** | **BTC** | **DOGE** |
@@ -201,8 +201,8 @@ Agents are free to adjust these settings as they see fit.
201201
defaultValue="songbird"
202202
groupId="operational-parameters"
203203
values={[
204-
{label: 'Songbird', value: 'songbird'},
205-
{label: 'Coston', value: 'coston'},
204+
{label: "Songbird Canary-Network", value: 'songbird'},
205+
{label: "Songbird Testnet Coston", value: 'coston'},
206206
]}>
207207
<TabItem value="songbird">
208208
| **Parameter** | **XRP** | **BTC** | **DOGE** |
@@ -232,8 +232,8 @@ These settings are far shorter in the beta phases than in the final version, in
232232
defaultValue="songbird"
233233
groupId="operational-parameters"
234234
values={[
235-
{label: 'Songbird', value: 'songbird'},
236-
{label: 'Coston', value: 'coston'},
235+
{label: "Songbird Canary-Network", value: 'songbird'},
236+
{label: "Songbird Testnet Coston", value: 'coston'},
237237
]}>
238238
<TabItem value="songbird">
239239
| **Parameter** | **XRP** | **BTC** | **DOGE** |
@@ -273,8 +273,8 @@ These settings are far shorter in the beta phases than in the final version, in
273273
defaultValue="songbird"
274274
groupId="operational-parameters"
275275
values={[
276-
{label: 'Songbird', value: 'songbird'},
277-
{label: 'Coston', value: 'coston'},
276+
{label: "Songbird Canary-Network", value: 'songbird'},
277+
{label: "Songbird Testnet Coston", value: 'coston'},
278278
]}>
279279
<TabItem value="songbird">
280280
| **Parameter** | **XRP** | **BTC** | **DOGE** |
@@ -298,8 +298,8 @@ These settings are far shorter in the beta phases than in the final version, in
298298
defaultValue="songbird"
299299
groupId="operational-parameters"
300300
values={[
301-
{label: 'Songbird', value: 'songbird'},
302-
{label: 'Coston', value: 'coston'},
301+
{label: "Songbird Canary-Network", value: 'songbird'},
302+
{label: "Songbird Testnet Coston", value: 'coston'},
303303
]}>
304304
<TabItem value="songbird">
305305
| Parameter | XRP | BTC | DOGE |
@@ -323,7 +323,7 @@ These settings are far shorter in the beta phases than in the final version, in
323323
defaultValue="songbird"
324324
groupId="operational-parameters"
325325
values={[
326-
{label: 'Songbird', value: 'songbird'},
326+
{label: "Songbird Canary-Network", value: 'songbird'},
327327
]}>
328328
<TabItem value="songbird">
329329
| Parameter | XRP | BTC | DOGE |
@@ -343,7 +343,7 @@ These settings are far shorter in the beta phases than in the final version, in
343343
defaultValue="songbird"
344344
groupId="operational-parameters"
345345
values={[
346-
{label: 'Songbird', value: 'songbird'},
346+
{label: "Songbird Canary-Network", value: 'songbird'},
347347
]}>
348348
<TabItem value="songbird">
349349
| **Parameter** | XRP | BTC | DOGE |

‎docs/fassets/7-songbird.mdx

+13-28
Original file line numberDiff line numberDiff line change
@@ -6,34 +6,19 @@ keywords: [fassets, xrp, bitcoin, dogecoin, flare-network]
66

77
import JiraIssueCollector from "/src/components/JiraIssueCollector";
88

9-
The launch of FAssets on the Songbird network demonstrates system behavior while paving the way for its next deployment on the Flare network. The primary goals of this test are to ensure the system operates as intended, identify edge cases, refine usability and automation, and incentivize whitehat security researchers to uncover potential code errors.
10-
11-
The test on Songbird will have the following characteristics:
12-
13-
- XRP will be tested first, followed by either BTC or DOGE;
14-
- FAssets agents must be whitelisted by Flare Labs to perform their roles;
15-
- Flare Labs will underwrite up to \$300,000 in FAsset issuance to cover any losses resulting from system issues, while imposing a cap of $2 million in issuance per asset.
16-
17-
## Duration of the Test
18-
19-
Each FAsset will be tested on Songbird for at least 6 weeks until no issues have been found.
20-
21-
## FAssets Minting dApps
22-
23-
FAssets system users can access the frontend web interface for minting and redeeming:
24-
25-
- [https://fasset.oracle-daemon.com/sgb](https://fasset.oracle-daemon.com/sgb)
26-
- [https://fassets.au.cc/](https://fassets.au.cc/)
27-
28-
## System Integrity and FAsset Pricing
29-
30-
During the Songbird test, restrictions and incentives may cause the FAsset price to deviate from the underlying currency's value.
31-
32-
The current focus is on testing system integrity, not price alignment.
33-
34-
## Vault Collateral
35-
36-
USDX will serve as collateral for FAsset agent vaults. To ensure sufficient support for FAsset issuance and possible liquidations on Songbird, a large amount of USDX has been minted.
9+
The launch of FAssets on Songbird Canary-Network demonstrates system behavior while paving the way for its next deployment on Flare Mainnet. The primary goals of this test are to ensure the system operates as intended, identify edge cases, refine usability and automation, and incentivize whitehat security researchers to uncover potential code errors.
10+
11+
The test on Songbird Canary-Network will have the following characteristics:
12+
13+
| Parameters | Description |
14+
| ----------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
15+
| FAsset Sequence | XRP will be tested first, followed by either BTC or DOGE. |
16+
| Agent Whitelisting | FAssets agents must be whitelisted by Flare Labs to perform their roles. |
17+
| Caps and Losses | Flare Labs will underwrite up to \$300,000 in FAsset issuance to cover any losses resulting from system issues, while imposing a cap of $2 million in issuance per asset. |
18+
| Duration of the Test | Each FAsset will be tested on Songbird for at least 6 weeks until no issues have been found. |
19+
| FAssets Minting dApps | FAssets system users can access the frontend web interface for minting and redeeming: <br/> - [`https://fasset.oracle-daemon.com/sgb`](https://fasset.oracle-daemon.com/sgb) <br /> - [`https://fassets.au.cc/`](https://fassets.au.cc/) |
20+
| System Integrity and FAsset Pricing | During the Songbird test, restrictions and incentives may cause the FAsset price to deviate from the underlying currency's value. The current focus is on testing system integrity, not price alignment. |
21+
| Vault Collateral | USDX will serve as collateral for FAsset agent vaults. To ensure sufficient support for FAsset issuance and possible liquidations on Songbird, a large amount of USDX has been minted. |
3722

3823
:::tip[Help improve FAssets]
3924

‎docs/fassets/8-reference.mdx

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
title: FAssets Reference
3+
description: Solidity reference for FAssets smart contracts.
4+
keywords:
5+
[
6+
solidity,
7+
reference,
8+
fassets,
9+
xrp,
10+
bitcoin,
11+
dogecoin,
12+
flare-network,
13+
smart-contracts,
14+
]
15+
---
16+
17+
import Tabs from "@theme/Tabs";
18+
import TabItem from "@theme/TabItem";
19+
import DocCardList from "@theme/DocCardList";
20+
import SolidityReference from "@site/src/components/DataTables/SolidityReference";
21+
22+
## Deployed Contracts
23+
24+
<Tabs block>
25+
<TabItem value="flare" label="Flare Mainnet">
26+
27+
| **Contract** | **Address** | **Description** |
28+
| -------------------: | ----------- | --------------- |
29+
| `AgentOwnerRegistry` | - | - |
30+
| `FXRP` | - | - |
31+
| `USDX` | - | - |
32+
33+
34+
</TabItem>
35+
<TabItem value="coston2" label="Flare Testnet Coston2">
36+
37+
| **Contract** | **Address** | **Description** |
38+
| -------------------: | ----------- | --------------- |
39+
| `AgentOwnerRegistry` | - | - |
40+
| `FXRP` | - | - |
41+
| `USDX` | - | - |
42+
43+
44+
</TabItem>
45+
<TabItem value="songbird" label="Songbird Canary-Network" default>
46+
47+
| **Contract** | **Address** | **Description** |
48+
| -------------------: | ------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------- |
49+
| `AgentOwnerRegistry` | [`0xa7f5d3C81f55f2b072FB62a0D4A03317BFd1a3c0`](https://songbird-explorer.flare.network/address/0xa7f5d3C81f55f2b072FB62a0D4A03317BFd1a3c0) | Manages agent whitelisting and allows setting and retrieving details such as work and management addresses, name, description, and icon. |
50+
| `FXRP` | [`0xF9a84f4ec903F4EaB117A9c1098BeC078BA7027d`](https://songbird-explorer.flare.network/address/0xF9a84f4ec903F4EaB117A9c1098BeC078BA7027d) | The FAsset-wrapped TestXRP token, ready for use on Songbird. |
51+
| `USDX` | [`0x4A771Cc1a39FDd8AA08B8EA51F7Fd412e73B3d2B`](https://songbird-explorer.flare.network/address/0x4A771Cc1a39FDd8AA08B8EA51F7Fd412e73B3d2B) | ERC-20 token used by FAssets. |
52+
53+
</TabItem>
54+
<TabItem value="coston" label="Songbird Testnet Coston">
55+
56+
| **Contract** | **Address** | **Description** |
57+
| -------------------: | ----------- | --------------- |
58+
| `AgentOwnerRegistry` | - | - |
59+
| `FXRP` | - | - |
60+
| `USDX` | - | - |
61+
62+
</TabItem>
63+
64+
</Tabs>
65+
66+
## Interfaces
67+
68+
<DocCardList />

0 commit comments

Comments
 (0)