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
66 changes: 65 additions & 1 deletion docs/fassets/9-reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,68 @@ import Reference from "/src/components/FAssets/Reference";

## References

<DocCardList />
### Core Interfaces

Smart contract interfaces for interacting with the FAssets system.

<DocCardList
items={[
{
type: "link",
label: "IAssetManager",
href: "/fassets/reference/IAssetManager",
docId: "fassets/reference/IAssetManager",
},
{
type: "link",
label: "IAssetManagerController",
href: "/fassets/reference/IAssetManagerController",
docId: "fassets/reference/IAssetManagerController",
},
{
type: "link",
label: "IAssetManagerEvents",
href: "/fassets/reference/IAssetManagerEvents",
docId: "fassets/reference/IAssetManagerEvents",
},
{
type: "link",
label: "ICollateralPool",
href: "/fassets/reference/ICollateralPool",
docId: "fassets/reference/ICollateralPool",
},
{
type: "link",
label: "ICoreVaultManager",
href: "/fassets/reference/ICoreVaultManager",
docId: "fassets/reference/ICoreVaultManager",
},
{
type: "link",
label: "IAgentOwnerRegistry",
href: "/fassets/reference/IAgentOwnerRegistry",
docId: "fassets/reference/IAgentOwnerRegistry",
},
]}
/>

### Bot Documentation

Guides for running and managing FAssets bots.

<DocCardList
items={[
{
type: "link",
label: "Agent Bot",
href: "/fassets/reference/agent-bot",
docId: "fassets/reference/agent-bot",
},
{
type: "link",
label: "User Bot",
href: "/fassets/reference/user-bot",
docId: "fassets/reference/user-bot",
},
]}
/>
112 changes: 112 additions & 0 deletions docs/fassets/developer-guides.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
---
title: Developer Guides
description: Step-by-step guides for building with FAssets
keywords: [fassets, developer, guides, minting, redemption, flare-network]
---

import DocCardList from "@theme/DocCardList";

Step-by-step guides for integrating and building with the [FAssets system](/fassets/overview) on Flare.

## Getting Started

Essential guides to begin working with FAssets.

<DocCardList
items={[
{
type: "link",
label: "Get Asset Manager Address",
href: "/fassets/developer-guides/fassets-asset-manager-address-contracts-registry",
docId:
"fassets/developer-guides/fassets-asset-manager-address-contracts-registry",
},
{
type: "link",
label: "Get FXRP Token Address",
href: "/fassets/developer-guides/fassets-fxrp-address",
docId: "fassets/developer-guides/fassets-fxrp-address",
},
{
type: "link",
label: "Read FAssets Settings (Solidity)",
href: "/fassets/developer-guides/fassets-settings-solidity",
docId: "fassets/developer-guides/fassets-settings-solidity",
},
{
type: "link",
label: "Read FAssets Settings (Node.js)",
href: "/fassets/developer-guides/fassets-settings-node",
docId: "fassets/developer-guides/fassets-settings-node",
},
]}
/>

## Minting FAssets

Guides for [minting FAssets](/fassets/minting) from underlying assets.

<DocCardList
items={[
{
type: "link",
label: "Mint FAssets",
href: "/fassets/developer-guides/fassets-mint",
docId: "fassets/developer-guides/fassets-mint",
},
{
type: "link",
label: "Execute Minting with Executor",
href: "/fassets/developer-guides/fassets-mint-executor",
docId: "fassets/developer-guides/fassets-mint-executor",
},
]}
/>

## Redeeming FAssets

Guides for [redeeming FAssets](/fassets/redemption) back to underlying assets.

<DocCardList
items={[
{
type: "link",
label: "Redeem FAssets",
href: "/fassets/developer-guides/fassets-redeem",
docId: "fassets/developer-guides/fassets-redeem",
},
{
type: "link",
label: "Swap and Redeem FAssets",
href: "/fassets/developer-guides/fassets-swap-redeem",
docId: "fassets/developer-guides/fassets-swap-redeem",
},
{
type: "link",
label: "Redemption Defaults",
href: "/fassets/developer-guides/fassets-redemption-default",
docId: "fassets/developer-guides/fassets-redemption-default",
},
{
type: "link",
label: "Redemption Queue",
href: "/fassets/developer-guides/fassets-redemption-queue",
docId: "fassets/developer-guides/fassets-redemption-queue",
},
]}
/>

## Agent Information

Guides for reading and working with agent data.

<DocCardList
items={[
{
type: "link",
label: "Read FAssets Agent Details",
href: "/fassets/developer-guides/fassets-agent-details",
docId: "fassets/developer-guides/fassets-agent-details",
},
]}
/>
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Get FXRP Asset Manager Address
tags: [intermediate, fassets]
slug: fassets-asset-manager-address-contracts-registry
description: Get FXRP asset manager address from the Flare contract registry
description: Get FXRP asset manager address from registry
keywords: [fassets, flare-network, fxrp, asset-manager]
sidebar_position: 1
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Monitor Redemptions & Execute Defaults
tags: [intermediate, fassets]
slug: fassets-redemption-default
description: Learn how to monitor and handle redemption non-payment scenarios
description: Monitor and handle redemption scenarios
keywords: [fassets, flare-network]
sidebar_position: 10
---
Expand Down
2 changes: 1 addition & 1 deletion docs/fassets/developer-guides/2-fassets-fxrp-address.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Get FXRP Address
tags: [intermediate, fassets]
slug: fassets-fxrp-address
description: Learn how to get FXRP address for interacting with the FAssets system
description: Get FXRP address using the FAssets system
keywords: [fassets, flare-network, fxrp, asset-manager]
sidebar_position: 2
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Read FAssets Settings (Solidity)
tags: [intermediate, fassets]
slug: fassets-settings-solidity
description: Fetch FAsset Lot Size and Value in USD (via FTSO) from a smart contract
description: Fetch FAsset Lot Size and Value in USD (via FTSO)
keywords: [fassets, ftso, oracle, flare-time-series-oracle, flare-network, node]
sidebar_position: 3
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Read FAssets Settings (Node)
tags: [intermediate, fassets]
slug: fassets-settings-node
description: Fetch FAsset Lot Size and Value in USD (via FTSO) using Node.js
description: Fetch FAsset Lot Size and Value in USD (via FTSO)
keywords: [fassets, ftso, oracle, flare-time-series-oracle, flare-network, node]
sidebar_position: 4
---
Expand Down
4 changes: 2 additions & 2 deletions sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -222,8 +222,8 @@ const sidebars: SidebarsConfig = {
label: "Developer Guides",
collapsed: true,
link: {
slug: "/fassets/developer-guides",
type: "generated-index",
type: "doc",
id: "fassets/developer-guides",
},
items: [
{ type: "autogenerated", dirName: "fassets/developer-guides" },
Expand Down