Skip to content

Commit 505b5c0

Browse files
dineshpintodineshpinto
authored
Merge branch 'main' into new-features
2 parents 68d60b4 + a0efc1a commit 505b5c0

26 files changed

+246
-306
lines changed

‎.github/workflows/spell-check.yml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ on:
1818
- "**/*.go"
1919
- "!**/*.sum"
2020
- "!**/*.mod"
21+
- "!**/*.json"
2122

2223
jobs:
2324
spell-check:
@@ -40,7 +41,7 @@ jobs:
4041
run: |
4142
codespell \
4243
--ignore-words=.github/config/ignored-words.txt \
43-
--skip="*.svg,*.png,*.jpg,*.woff,*.woff2,*.pdf,*.json,package-lock.json" \
44+
--skip="*.svg,*.png,*.jpg,*.woff,*.woff2,*.pdf,package-lock.json" \
4445
--quiet-level=2 \
4546
--check-filenames \
4647
.

‎automations/anchor_feeds.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -349,7 +349,7 @@
349349
"decimals": 6,
350350
"base_asset": "Fantom",
351351
"category": "Crypto",
352-
"risk": 2
352+
"risk": 3
353353
},
354354
{
355355
"feed_name": "ONDO/USD",

‎automations/anchor_risk.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
{ "name": "PEPE/USD", "index": 40, "decimals": 10, "volatility": 3 },
4343
{ "name": "QNT/USD", "index": 41, "decimals": 5, "volatility": 2 },
4444
{ "name": "AAVE/USD", "index": 42, "decimals": 4, "volatility": 1 },
45-
{ "name": "FTM/USD", "index": 43, "decimals": 5, "volatility": 2 },
45+
{ "name": "FTM/USD", "index": 43, "decimals": 5, "volatility": 3 },
4646
{ "name": "ONDO/USD", "index": 44, "decimals": 5, "volatility": 2 },
4747
{ "name": "TAO/USD", "index": 45, "decimals": 4, "volatility": 2 },
4848
{ "name": "FET/USD", "index": 46, "decimals": 5, "volatility": 1 },

‎automations/block_latency_feeds.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -393,7 +393,7 @@
393393
"decimals": 6,
394394
"base_asset": "Fantom",
395395
"category": "Crypto",
396-
"risk": 2
396+
"risk": 3
397397
},
398398
{
399399
"feed_name": "ONDO/USD",

‎automations/block_latency_risk.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
{ "name": "PEPE/USD", "index": 40, "decimals": 10, "volatility": 3 },
4343
{ "name": "QNT/USD", "index": 41, "decimals": 5, "volatility": 2 },
4444
{ "name": "AAVE/USD", "index": 42, "decimals": 4, "volatility": 1 },
45-
{ "name": "FTM/USD", "index": 43, "decimals": 5, "volatility": 2 },
45+
{ "name": "FTM/USD", "index": 43, "decimals": 5, "volatility": 3 },
4646
{ "name": "ONDO/USD", "index": 44, "decimals": 5, "volatility": 2 },
4747
{ "name": "TAO/USD", "index": 45, "decimals": 4, "volatility": 2 },
4848
{ "name": "FET/USD", "index": 46, "decimals": 5, "volatility": 1 },

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ This page lists the current values for the most important parameters of the FAss
8787
<TabItem value="songbird">
8888
| **Parameter** | **XRP** | **BTC** | **DOGE** |
8989
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | ------- | -------- |
90-
| [**Backing factor**](/fassets/overview#agents)<br />The percentage of underlying assets that must be actively backed at any time. | 98% | 99% | 95-98% |
90+
| [**Backing factor**](/fassets/overview#agents)<br />The percentage of underlying assets that must be actively backed at any time. | 98% | 99% | 95% |
9191
| [**Vault collateral**](/fassets/collateral#vault-collateral)<br />Types of collateral required in the agent's vault. | | | |
9292
| &emsp;&bullet;&emsp; **Supported types**<br />Collateral types allowed in the vault. | `USDX` | `USDX` | `USDX` |
9393
| &emsp;&bullet;&emsp; [**Minimal CR**](/fassets/collateral#minimal-cr)<br />The minimum collateral ratio required to avoid liquidation. | 1.2 | 1.2 | 1.2 |
@@ -171,8 +171,8 @@ Agents are free to adjust these settings as they see fit.
171171
| [**Minting fee**](/fassets/minting#minting-fee)<br />The minting fee is when users (minters) mint FAssets by depositing underlying assets with an agent. | 1% | 1% | 1% |
172172
| [**Pool share**](/fassets/minting#pool-share)<br />The pool share fee is the portion of the minting and redemption fees allocated to pool collateral providers. | 30% | 30% | 30% |
173173
| [**Minting CR**](/fassets/collateral#minting-cr) | | | |
174-
| &emsp;**Agent vault**<br />&emsp;The minting vault collateral ratio is the minimum collateral required to back FAssets, ensuring value protection against under-collateralization. | 1.3 | 1.3 | 1.3 |
175-
| &emsp;**Collateral pool**<br />&emsp;The minting pool collateral ratio ensures the collateral value supports the minted FAssets. | 1.6 | 1.6 | 1.6 |
174+
| &emsp;**Agent vault**<br />&emsp;The minting vault collateral ratio is the minimum collateral required to back FAssets, ensuring value protection against under-collateralization. | 1.4 | 1.4 | 1.4 |
175+
| &emsp;**Collateral pool**<br />&emsp;The minting pool collateral ratio ensures the collateral value supports the minted FAssets. | 1.7 | 1.7 | 1.7 |
176176
| [**Exit CR**](/fassets/collateral#exit-cr)<br />The pool exit collateral ratio is the minimum collateral ratio agents must maintain when exiting their pool collateral. | 1.6 | 1.6 | 1.6 |
177177
| [**Top-up CR**](/fassets/collateral#top-up-cr)<br />Defines the minimum collateral ratio agents must maintain when topping up pool collateral. | 1.5 | 1.5 | 1.5 |
178178
| **Top-up discount**<br />The pool top-up token discount values added tokens at a slight discount to market price, increasing system stability, shown as a factor on the Agent UI. | 0.5% | 0.5% | 0.5% |
@@ -242,8 +242,8 @@ These settings are far shorter in the beta phases than in the final version, in
242242
| **Maximum governance update frequency**<br />Minimum amount of time between updates of any governance setting.<br /> | 1 day | 1 day | 1 day |
243243
| **Token invalidation time**<br />Time between the moment a token is deprecated by governance and it becomes invalid. Agents still using it as vault collateral get liquidated after this time.<br /> | 1 day | 1 day | 1 day |
244244
| **Agent exit available time lock**<br />The time the agent has to wait after announcing exit from the list of publicly available agents and executing the exit.<br /> | 3 hours | 3 hours | 3 hours |
245-
| **Agent fee change time lock**<br />The time the agent has to wait between announcing and changing the agent fee or the pool share.<br /> | 1 day | 1 day | 1 day |
246-
| **Agent minting CR change time lock**<br />The time the agent has to wait between announcing and changing the minting CR (vault or pool).<br /> | 1 hour | 1 hour | 1 hour |
245+
| **Agent fee change time lock**<br />The time the agent has to wait between announcing and changing the agent fee or the pool share.<br /> | 1 hour | 1 hour | 1 hour |
246+
| **Agent minting CR change time lock**<br />The time the agent has to wait between announcing and changing the minting CR (vault or pool).<br /> | 5 minutes | 5 minutes | 5 minutes |
247247
| **Pool exit and top-up change time lock**<br />The time the agent has to wait between announcing and changing any pool exit and top-up settings.<br /> | 1 day | 1 day | 1 day |
248248
| **Agent time-locked operation window**<br />Once the above time locks expire, agents have this amount of time to execute the requested operation.<br /> | 2 hours | 2 hours | 2 hours |
249249
| **Collateral pool token time lock**<br />Amount of seconds that a user entering the collateral pool must wait before spending (exit or transfer) the obtained pool tokens.<br /> | 60 seconds | 60 seconds | 60 seconds |

‎docs/fassets/8-reference.mdx‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,11 @@ import SolidityReference from "@site/src/components/DataTables/SolidityReference
4747
| **Contract** | **Address** | **Description** |
4848
| -------------------: | ------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------- |
4949
| `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. |
50+
| `AssetManager_XRP` | [`0x299d678f67e7ADD4efdf295Ebe0E92FCb4f75C4c`](https://songbird-explorer.flare.network/address/0x299d678f67e7ADD4efdf295Ebe0E92FCb4f75C4c) | Smart ontract that can mint and burn FXRP while managing collateral and backing funds. |
51+
| `FXRP` | [`0xF9a84f4ec903F4EaB117A9c1098BeC078BA7027d`](https://songbird-explorer.flare.network/address/0xF9a84f4ec903F4EaB117A9c1098BeC078BA7027d) | The FAsset-wrapped XRP token, ready for use on Songbird. |
52+
| `AssetManager_FDOGE` | [`0x866077dC52445167dC971643c1b2910608eD0C5A`](https://songbird-explorer.flare.network/address/0x866077dC52445167dC971643c1b2910608eD0C5A) | Smart ontract that can mint and burn FDOGE while managing collateral and backing funds. |
53+
| `FDOGE` | [`0xaa25ee3B68c515e69A463876Ab262bc4e8339030`](https://songbird-explorer.flare.network/address/0xaa25ee3B68c515e69A463876Ab262bc4e8339030) | The FAsset-wrapped DOGE token, ready for use on Songbird. |
54+
| `USDX` | [`0x4A771Cc1a39FDd8AA08B8EA51F7Fd412e73B3d2B`](https://songbird-explorer.flare.network/address/0x4A771Cc1a39FDd8AA08B8EA51F7Fd412e73B3d2B) | ERC-20 token used by FAssets as vault collateral. |
5255

5356
</TabItem>
5457
<TabItem value="coston" label="Songbird Testnet Coston">

‎docs/fassets/guides/1-deploy-fassets-agent.mdx‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ authors: [fassko]
88
keywords: [fassets, xrp, btc, doge flare-network, flare-network]
99
---
1010

11+
import RestartDocker from "./_restart_docker.mdx";
12+
1113
The FAssets system by Flare enables non-smart contract tokens like BTC and XRP to interact trustlessly with smart contracts on the Flare network, unlocking their use in DeFi applications. It achieves this through collateralized minting, utilizing [Flare Data Connector (FDC)](/fdc/overview) and [Flare Time Series Oracle (FTSO)](/ftso/overview) for secure cross-chain functionality.
1214

1315
Agents in the FAssets system facilitate the minting and redemption of FAssets by providing over-collateralized assets and managing transactions securely. A liquidator in the FAssets system monitors agent's collateralization levels to ensure the system's security and trustlessness.
@@ -140,6 +142,12 @@ sudo chown 1000:1000 log -R
140142

141143
## Whitelist the Management Address
142144

145+
:::info
146+
Given our current insurance mechanisms to protect users, Flare Labs will not add any more agents to the FAssets protocol on Songbird.
147+
As covered in this [blog](https://flare.network/fxrp-is-live-on-songbird/), Flare Labs will cover losses up to \$100,000 per asset, for a total coverage of $300,000.
148+
We appreciate the interest received and look forward to onboarding agents once we have launched FAssets on Flare mainnet.
149+
:::
150+
143151
To access the FAssets system, you must be whitelisted for security reasons.
144152

145153
1. Use the [FlareFAssetsSongbirdBot Telegram channel](https://t.me/FlareFAssetsSongbirdBot), specifically designed for registration, and provide the necessary information.
@@ -225,15 +233,7 @@ docker compose --profile cli run user-bot info --fasset FASSET
225233

226234
### Update the FAssets Agent
227235

228-
To restart and update the FAssets agent, run the following commands:
229-
230-
```bash
231-
docker compose down
232-
git pull
233-
docker compose pull
234-
docker compose --profile cli run agent-bot listAgents --fasset FXRP
235-
docker compose up -d
236-
```
236+
<RestartDocker />
237237

238238
## Access the Agent Frontend
239239

‎docs/fassets/guides/5-faq.mdx‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,3 +51,8 @@ Yes, for an agent to stay operational, it must run continuously.
5151
Do not restart the agent, as this may result in double payments.
5252
The current solution is duplicating the database and launching a new agent instance.
5353
You should monitor your database closely and, if access is lost, remove the agent from the available list, self-close FAssets, and backup agent keys.
54+
55+
### Is there a minimum history needed in the Data Availability Layer for agents?
56+
57+
No minimum history is required; it can be set to the latest block.
58+
You need to start the [Data Availability Layer](/fdc/overview#data-availability-layer) before you can participate as an FAsset agent.

‎docs/fassets/guides/7-telegram-bot-notifications.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 6
2+
sidebar_position: 7
33
slug: telegram-bot-notifications
44
title: Telegram Bot Notifications
55
description: Set up a Telegram bot to receive notifications

0 commit comments

Comments
 (0)