Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/fassets/1-overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -128,4 +128,6 @@ Movements of funds require multiple signatures and follow formal agreements, not

Learn more about the different components and processes involved in FAssets - [collateral](/fassets/collateral), [minting](/fassets/minting), [redemptions](/fassets/redemption), [liquidations](/fassets/liquidation) and [Core Vault](/fassets/core-vault).

For developer resources, explore our [FXRP address](/fassets/developer-guides/fassets-fxrp-address), [minting](/fassets/developer-guides/fassets-mint), and [redemption](/fassets/developer-guides/fassets-redeem) guides to get started with FAssets integration.

:::
8 changes: 8 additions & 0 deletions docs/fassets/2-minting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -320,3 +320,11 @@ Because self-minting is done without a collateral reservation request, in some c
If one of these changes occurs, the agent can self-mint a smaller number of lots, even 0 lots, and the remainder of the deposited underlying assets is added to the free underlying balance.

Additionally, when agents create a vault, they can choose not to make it public, so the vault can only be used to self-mint.

:::tip[What's next]

Learn more about the different components and processes involved in FAssets - [collateral](/fassets/collateral), [redemptions](/fassets/redemption), [liquidations](/fassets/liquidation) and [Core Vault](/fassets/core-vault).

For developer resources, explore our [FXRP address](/fassets/developer-guides/fassets-fxrp-address), [minting](/fassets/developer-guides/fassets-mint), and [redemption](/fassets/developer-guides/fassets-redeem) guides to get started with FAssets integration.

:::
8 changes: 8 additions & 0 deletions docs/fassets/3-redemption.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -136,3 +136,11 @@ As shown in the following process, agents can self-redeem for any reason, includ
4. The underlying collateral is released and can be withdrawn from the underlying address later.

The self-redeemed amount is not limited to a positive integer of lots and can be less than 1 lot, which makes self-closing ideal for redeeming an agent's dust.

:::tip[What's next]

Learn more about the different components and processes involved in FAssets - [collateral](/fassets/collateral), [minting](/fassets/minting), [liquidations](/fassets/liquidation) and [Core Vault](/fassets/core-vault).

For developer resources, explore our [FXRP address](/fassets/developer-guides/fassets-fxrp-address), [minting](/fassets/developer-guides/fassets-mint), and [redemption](/fassets/developer-guides/fassets-redeem) guides to get started with FAssets integration.

:::
8 changes: 8 additions & 0 deletions docs/fassets/4-collateral.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -441,3 +441,11 @@ These actions can cause the agent's CPTs to be burned:
## Top-up

To reduce the likelihood of liquidations because the pool collateral is too low, the pool can be topped up at a reduced price when the **CR** is above the **top-up CR**. A top-up mechanism for vault collateral is not available. To prevent liquidation, agents can add vault collateral any time.

:::tip[What's next]

Learn more about the different components and processes involved in FAssets - [minting](/fassets/minting), [redemptions](/fassets/redemption), [liquidations](/fassets/liquidation) and [Core Vault](/fassets/core-vault).

For developer resources, explore our [FXRP address](/fassets/developer-guides/fassets-fxrp-address), [minting](/fassets/developer-guides/fassets-mint), and [redemption](/fassets/developer-guides/fassets-redeem) guides to get started with FAssets integration.

:::
8 changes: 8 additions & 0 deletions docs/fassets/5-core-vault.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -190,3 +190,11 @@ The **Core Vault** fundamentally strengthens FAssets:
- **Adds layered security**, combining multisig, escrow, and governance controls.

It is the key to making cross-chain assets on Flare both **secure** and **efficient**.

:::tip[What's next]

Learn more about the different components and processes involved in FAssets - [collateral](/fassets/collateral), [minting](/fassets/minting), [redemptions](/fassets/redemption) and [liquidations](/fassets/liquidation).

For developer resources, explore our [FXRP address](/fassets/developer-guides/fassets-fxrp-address), [minting](/fassets/developer-guides/fassets-mint), and [redemption](/fassets/developer-guides/fassets-redeem) guides to get started with FAssets integration.

:::
8 changes: 8 additions & 0 deletions docs/fassets/6-liquidation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -330,3 +330,11 @@ The locked collateral is also ineligible for minting.

Agents must announce the closing of their vaults.
They become unusable until the lock expires, and then they can be closed.

:::tip[What's next]

Learn more about the different components and processes involved in FAssets - [collateral](/fassets/collateral), [minting](/fassets/minting), [redemptions](/fassets/redemption) and [Core Vault](/fassets/core-vault).

For developer resources, explore our [FXRP address](/fassets/developer-guides/fassets-fxrp-address), [minting](/fassets/developer-guides/fassets-mint), and [redemption](/fassets/developer-guides/fassets-redeem) guides to get started with FAssets integration.

:::
8 changes: 8 additions & 0 deletions docs/fassets/7-emergency-pause.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -68,3 +68,11 @@ It completely freezes all movement of the FAssets.

The FAssets emergency pause system provides a robust framework for maintaining system security and stability during critical situations.
The system can respond appropriately to various types of threats while maintaining essential functionality and protecting user assets.

:::tip[What's next]

Learn more about the different components and processes involved in FAssets - [collateral](/fassets/collateral), [minting](/fassets/minting), [redemptions](/fassets/redemption), [liquidations](/fassets/liquidation) and [Core Vault](/fassets/core-vault).

For developer resources, explore our [FXRP address](/fassets/developer-guides/fassets-fxrp-address), [minting](/fassets/developer-guides/fassets-mint), and [redemption](/fassets/developer-guides/fassets-redeem) guides to get started with FAssets integration.

:::
8 changes: 8 additions & 0 deletions docs/fassets/8-operational-parameters.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -67,3 +67,11 @@ To get the Core Vault manager operational parameters you need to use the [`ICore
To get the Core Vault settings you need to use the [`IAssetManager`](/fassets/reference/IAssetManager) interface. Specific functions added to each parameter.

<OperationalParameters sectionTitle="Core Vault Settings" hideBtc hideDoge />

:::tip[What's next]

Learn more about the different components and processes involved in FAssets - [collateral](/fassets/collateral), [minting](/fassets/minting), [redemptions](/fassets/redemption), [liquidations](/fassets/liquidation) and [Core Vault](/fassets/core-vault).

For developer resources, explore our [FXRP address](/fassets/developer-guides/fassets-fxrp-address), [minting](/fassets/developer-guides/fassets-mint), and [redemption](/fassets/developer-guides/fassets-redeem) guides to get started with FAssets integration.

:::
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,18 @@ import {IAssetManager} from "@flarenetwork/flare-periphery-contracts/coston2/IAs
IAssetManager assetManager = ContractRegistry.getAssetManagerFXRP();
```

## Next Steps
## Summary

In this guide, you learned how to get the FXRP Asset Manager address for the FAssets system by interacting with the `AssetManager` contract using the [`IAssetManager`](/fassets/reference/IAssetManager) interface.

You should not hardcode the FXRP Asset Manager address in your smart contracts.

:::tip[What's next]

To continue your FAssets development journey, you can:

- Learn how to [mint FXRP](/fassets/developer-guides/fassets-mint).
- Understand how to [redeem FXRP](/fassets/developer-guides/fassets-redeem).
- Explore [FAssets system settings](/fassets/operational-parameters).

:::
7 changes: 5 additions & 2 deletions docs/fassets/developer-guides/2-fassets-fxrp-address.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -85,13 +85,16 @@ Once you have the FXRP address, you can:
2. Add it to your wallet to track FXRP balances
3. Use it in DeFi protocols that support FXRP

## Next Steps
## Summary

In this guide, you learned how to get the FXRP address for the FAssets system by interacting with the `AssetManager` contract using the [`IAssetManager`](/fassets/reference/IAssetManager) interface.

:::tip[What's next]

To continue your FAssets development journey, you can:

- Learn how to [mint FXRP](/fassets/developer-guides/fassets-mint).
- Understand how to [redeem FXRP](/fassets/developer-guides/fassets-redeem).
- Explore [FAssets system settings](/fassets/operational-parameters).
- Check the [lot size](/fassets/developer-guides/fassets-settings-node) for FXRP operations.

:::
15 changes: 14 additions & 1 deletion docs/fassets/developer-guides/3-fassets-settings-solidity.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -116,9 +116,22 @@ Lot size in XRP 20
This script is included in the [Flare Hardhat Starter Kit](https://github.com/flare-foundation/flare-hardhat-starter).

:::

<ExploringAdditionalParameters />

## Summary

Congratulations! You have now deployed a Solidity helper contract and used a TypeScript script to:

- Fetch FAsset FXRP lot size and decimals
- Convert the value to a user-friendly format using decimal precision.

<ExploringAdditionalParameters />
:::tip[What's next]

To continue your FAssets development journey, you can:

- Learn how to [mint FXRP](/fassets/developer-guides/fassets-mint).
- Understand how to [redeem FXRP](/fassets/developer-guides/fassets-redeem).
- Explore [FAssets system settings](/fassets/operational-parameters).

:::
11 changes: 8 additions & 3 deletions docs/fassets/developer-guides/4-fassets-settings-node.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -323,13 +323,18 @@ Lot value in USD: 28.43861
Timestamp: 1756977702
```

Congratulations! You have built a TypeScript script that connects to the Coston2 network and retrieves the FAsset configuration settings and the price of XRP in USD.

<ExploringAdditionalParameters />

## Next Steps
## Summary

Congratulations! You have built a TypeScript script that connects to the Coston2 network and retrieves the FAsset configuration settings and the price of XRP in USD.

:::tip[What's next]

To continue your FAssets development journey, you can:

- Learn how to [mint FXRP](/fassets/developer-guides/fassets-mint).
- Understand how to [redeem FXRP](/fassets/developer-guides/fassets-redeem).
- Explore [FAssets system settings](/fassets/operational-parameters).

:::
12 changes: 9 additions & 3 deletions docs/fassets/developer-guides/5-fassets-mint.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -112,10 +112,16 @@ This script demonstrates how to retrieve the FDC proof and execute minting.
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).
11. On a successful transaction call `parseExecutemintingEvents` to extract and log events [`RedemptionTicketCreated`](/fassets/reference/IAssetManagerEvents#redemptionticketcreated) and [`MintingExecuted`](/fassets/reference/IAssetManagerEvents#mintingexecuted).

## Next Steps
## Summary

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.

:::tip Redeem
To convert your FAssets (e.g., FXRP) back into the original asset (e.g., XRP), follow the steps in the [FAssets Redemption Guide](/fassets/developer-guides/fassets-redeem).
:::tip[What's next]

To continue your FAssets development journey, you can:

- Learn how to [mint FAssets using the executor](/fassets/developer-guides/fassets-mint-executor).
- Understand how to [redeem FXRP](/fassets/developer-guides/fassets-redeem).
- Explore [FAssets system settings](/fassets/operational-parameters).

:::
11 changes: 8 additions & 3 deletions docs/fassets/developer-guides/6-fassets-mint-executor.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -126,10 +126,15 @@ This script demonstrates how to retrieve the FDC proof and execute minting.
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).
9. On a successful transaction call `parseExecutemintingEvents` to extract and log events [`RedemptionTicketCreated`](/fassets/reference/IAssetManagerEvents#redemptionticketcreated) and [`MintingExecuted`](/fassets/reference/IAssetManagerEvents#mintingexecuted).

## Next Steps
## Summary

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.

:::tip Redeem
To convert your FAssets (e.g., FXRP) back into the original asset (e.g., XRP), follow the steps in the [FAssets Redemption Guide](/fassets/developer-guides/fassets-redeem).
:::tip[What's next]

To continue your FAssets development journey, you can:

- Understand how to [redeem FXRP](/fassets/developer-guides/fassets-redeem).
- Explore [FAssets system settings](/fassets/operational-parameters).

:::
15 changes: 12 additions & 3 deletions docs/fassets/developer-guides/7-fassets-redeem.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -334,8 +334,17 @@ The FAssets agent should perform the redemption, and the user must retrieve the
If the agent is unable to redeem the assets on the underlying chain in the specified time.
In that case, the user can execute the [`redemptionPaymentDefault`](/fassets/reference/IAssetManager#redemptionpaymentdefault) function to receive compensation from the agent's collateral.

## Next Steps
## Summary

This is only the first step of the redemption process.
The redeemer or agent completes the redemption process when proof of payment is presented to the FAssets system.
Read more about the redemption process in the [here](/fassets/redemption).

:::tip[What's next]

To continue your FAssets development journey, you can:

- Learn how to [mint FAssets using the executor](/fassets/developer-guides/fassets-mint-executor).
- Explore [FAssets system settings](/fassets/operational-parameters).

:::tip
This is only the first step of the redemption process. The redeemer or agent completes the redemption process when proof of payment is presented to the FAssets system. Read more about the redemption process in the [here](/fassets/redemption).
:::
12 changes: 11 additions & 1 deletion docs/fassets/developer-guides/8-fassets-swap-redeem.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -139,11 +139,21 @@ The script outputs transaction details, including swap amounts and redemption re
For an in-depth explanation of the FAssets redemption process, refer to the [FAssets Redeem Guide](/fassets/developer-guides/fassets-redeem).
:::

## Conclusion
## Summary

In this guide, you learned how to:

- swap WCFLR for FXRP using Uniswap V2 compatible router (in this example, BlazeSwap);
- redeem FXRP to XRP on the XRP Ledger using FAssets asset manager.

The complete code is in the [Flare Hardhat Starter Kit](/network/guides/hardhat-foundry-starter-kit).

:::tip[What's next]

To continue your FAssets development journey, you can:

- Learn how to [mint FAssets using the executor](/fassets/developer-guides/fassets-mint-executor).
- Understand how to [redeem FXRP](/fassets/developer-guides/fassets-redeem).
- Explore [FAssets system settings](/fassets/operational-parameters).

:::
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ function getAgentDetails(address _managementAddress) external view
}
```

## Conclusion
## Summary

In this guide, you learned how to read FAssets agent details using the [AgentOwnerRegistry](/fassets/reference/IAgentOwnerRegistry) smart contract.
This functionality is crucial for building user interfaces that display agent information and for validating agent credentials in your applications.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
:::tip[Exploring Additional Parameters]
## Exploring Additional Parameters

The FAssets asset manager exposes key parameters like collateral ratios, minting fees, and liquidation thresholds via the `getSettings` function.
See the [FAssets Operational Parameters](/fassets/operational-parameters/#asset-manager-operational-parameters) for details.

:::
Loading