Skip to content

Commit 24b1068

Browse files
committed
feat(docs): enhance FXRP and Firelight documentation
1 parent d0baf49 commit 24b1068

File tree

7 files changed

+50
-13
lines changed

7 files changed

+50
-13
lines changed

docs/fxrp/firelight/01-status.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Get Firelight Vaults Status
2+
title: Get Firelight Vault Status
33
tags: [intermediate, fassets]
44
slug: status
55
description: Learn how to get Firelight vault status
@@ -22,7 +22,7 @@ The Firelight vault is an [ERC-4626](https://eips.ethereum.org/EIPS/eip-4626) va
2222
- [Flare Network Periphery Contracts](https://www.npmjs.com/package/@flarenetwork/flare-periphery-contracts)
2323
- Understanding of [FAssets](/fassets/overview)
2424

25-
## Firelight Vaults Status Script
25+
## Firelight Vault Status Script
2626

2727
The following script retrieves and displays information about the Firelight vault:
2828

docs/fxrp/firelight/02-deposit.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Deposit Assets into Firelight Vaults
2+
title: Deposit Assets into Firelight Vault
33
tags: [intermediate, fassets]
44
slug: deposit
55
description: Learn how to deposit assets into a Firelight vault
@@ -24,7 +24,7 @@ Depositing assets is the process of transferring assets to the vault and receivi
2424
- Understanding of [FAssets](/fassets/overview)
2525
- Sufficient asset balance (e.g., FXRP) to deposit into the vault.
2626

27-
## Firelight Vaults Deposit Script
27+
## Firelight Vault Deposit Script
2828

2929
The following script demonstrates how to deposit assets into the Firelight vault:
3030

docs/fxrp/firelight/03-mint.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Mint Firelight Vaults Shares
2+
title: Mint Firelight Vault Shares
33
tags: [intermediate, fassets]
44
slug: mint
55
description: Learn how to mint Firelight vault shares
@@ -24,7 +24,7 @@ Minting shares is the process of depositing assets into the vault and receiving
2424
- Understanding of [FAssets](/fassets/overview)
2525
- Sufficient asset balance (e.g., FXRP) to deposit into the vault.
2626

27-
## Firelight Vaults Mint Script
27+
## Firelight Vault Mint Script
2828

2929
The following script demonstrates how to mint vault shares by depositing assets into the Firelight vault:
3030

docs/fxrp/firelight/04-withdraw.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Withdraw Assets from Firelight Vaults
2+
title: Withdraw Assets from Firelight Vault
33
tags: [intermediate, fassets]
44
slug: withdraw
55
description: Learn how to withdraw assets from a Firelight vault
@@ -25,7 +25,7 @@ The assets are not immediately transferred; they must be claimed once the period
2525
- Understanding of [FAssets](/fassets/overview)
2626
- Vault shares in the Firelight vault to withdraw.
2727

28-
## Firelight Vaults Withdraw Script
28+
## Firelight Vault Withdraw Script
2929

3030
The following script demonstrates how to create a withdrawal request from the Firelight vault:
3131

docs/fxrp/firelight/05-redeem.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Redeem Assets from Firelight Vaults
2+
title: Redeem Assets from Firelight Vault
33
tags: [intermediate, fassets]
44
slug: redeem
55
description: Learn how to redeem assets from a Firelight vault
@@ -25,7 +25,7 @@ The assets are not immediately transferred; they must be claimed once the period
2525
- Understanding of [FAssets](/fassets/overview)
2626
- Vault shares in the Firelight vault to redeem.
2727

28-
## Firelight Vaults Redeem Script
28+
## Firelight Vault Redeem Script
2929

3030
The following script demonstrates how to create a redemption request from the Firelight vault:
3131

docs/fxrp/firelight/_firelight.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import DocCardList from "@theme/DocCardList";
33
[Firelight](https://firelight.finance) is a yield-generating protocol built on top of FXRP.
44
It provides [ERC-4626](https://eips.ethereum.org/EIPS/eip-4626) compliant vault that allows users to deposit FXRP and earn yield through the [FAssets](/fassets/overview) system.
55

6-
Firelight vaults operates on a [period-based logic](https://docs.firelight.finance/technical-documents#period-based-logic), where deposits and withdrawals are processed at specific intervals.
6+
Firelight vaults operate on a [period-based logic](https://docs.firelight.finance/technical-documents#period-based-logic), where deposits and withdrawals are processed at specific intervals.
77
Users receive vault shares representing their proportional ownership of the vault's assets.
88

99
<DocCardList

docs/fxrp/overview.mdx

Lines changed: 39 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,45 @@ keywords: [fassets, fxrp, xrp, flare-network, firelight, vault, defi]
77
import DocCardList from "@theme/DocCardList";
88
import Firelight from "./firelight/_firelight.mdx";
99

10-
FXRP is the [FAsset](/fassets/overview) representation of XRP on Flare.
11-
It enables XRP holders to participate in Flare's DeFi ecosystem while maintaining the ability to redeem their tokens for the original XRP at any time.
10+
FXRP is the [FAsset](/fassets/overview) representation of XRP on the Flare network.
11+
It is an [ERC-20](https://eips.ethereum.org/EIPS/eip-20) token that represents XRP bridged from the XRP Ledger (XRPL) to Flare.
12+
13+
FXRP is powered by the [FAssets](/fassets/overview) system, a trustless, over-collateralized bridge infrastructure that enables the creation of wrapped tokens for assets from non-smart contract networks.
14+
15+
### Key Features
16+
17+
- **ERC-20 Standard:** As an [ERC-20](https://eips.ethereum.org/EIPS/eip-20) token, FXRP is compatible with all EVM-compatible wallets, smart contracts, and DeFi protocols on Flare, giving you full interoperability across the ecosystem.
18+
- **Trustless Bridge:** Your FXRP is backed by the [FAssets](/fassets/overview) system, which uses the [Flare Data Connector (FDC)](/fdc/overview) to verify XRPL transactions, eliminating the need for trusted intermediaries.
19+
- **Always Redeemable:** You can redeem your FXRP for the original XRP at any time, maintaining complete control over your assets.
20+
- **DeFi Integration:** Use your FXRP in various DeFi applications, including lending, borrowing, yield farming, and liquidity provision across Flare's ecosystem.
21+
- **Yield Opportunities:** Earn yield on your FXRP through protocols like [Firelight](/fxrp/firelight/status), which provides [ERC-4626](https://eips.ethereum.org/EIPS/eip-4626) compliant vaults for FXRP holders.
22+
23+
## How to Acquire FXRP
24+
25+
There are three primary ways to acquire FXRP:
26+
27+
### Using Minting dApp
28+
29+
The most direct way to acquire FXRP is by minting it from native XRP on the XRP Ledger (XRPL) using a minting dApp.
30+
31+
You can mint FXRP on either of the following dApps:
32+
33+
- [https://fasset.oracle-daemon.com/flare](https://fasset.oracle-daemon.com/flare)
34+
- [https://fassets.au.cc](https://fassets.au.cc)
35+
36+
### 2. Mint FXRP via Code
37+
38+
You can also mint FXRP programmatically using smart contracts and code.
39+
40+
This approach is ideal for developers who want to integrate FXRP minting into their applications or automate the process for their users.
41+
42+
For complete code examples and step-by-step instructions, see the [FAssets minting guide](/fassets/developer-guides/fassets-mint).
43+
44+
### 3. Swap Other Tokens for FXRP
45+
46+
You can also acquire FXRP by swapping other tokens (such as USDT0, FLR, or other ERC-20 tokens) on decentralized exchanges (DEXs) on Flare.
47+
48+
For example, you can swap USDT0 to FXRP using SparkDEX (Uniswap V3) as described in the [swap guide](/fxrp/token-interactions/usdt0-fxrp-swap).
1249

1350
## FXRP Token Interactions
1451

0 commit comments

Comments
 (0)