Skip to content

Commit 58a9074

Browse files
feat(docs): introduce Omnichain Fungible Token (OFT) section, update sidebar and move guides (#1194)
2 parents 7f8d8ca + 9a37085 commit 58a9074

File tree

6 files changed

+99
-10
lines changed

6 files changed

+99
-10
lines changed

docs/fassets/developer-guides.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,8 @@ Guides for [redeeming FAssets](/fassets/redemption) back to underlying assets.
9090
{
9191
type: "link",
9292
label: "FAsset Auto-Redemption",
93-
href: "/fxrp/token-interactions/fxrp-autoredeem",
94-
docId: "fxrp/token-interactions/fassets-autoredeem",
93+
href: "/fxrp/oft/fxrp-autoredeem",
94+
docId: "fxrp/oft/fassets-autoredeem",
9595
},
9696
]}
9797
/>

docs/fxrp/token-interactions/4-fassets-automint.mdx renamed to docs/fxrp/oft/fassets-automint.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -412,7 +412,7 @@ The FXRP remains in the personal account and can be retrieved or retried.
412412

413413
**Q: Can I bridge to chains other than Sepolia?**
414414
A: Yes, update the `SEPOLIA_EID` configuration to any LayerZero-supported destination.
415-
Use the [getOftPeers script](/fxrp/token-interactions/fxrp-autoredeem#discovering-available-bridge-routes) to discover available routes.
415+
Use the [getOftPeers script](/fxrp/oft/fxrp-autoredeem#discovering-available-bridge-routes) to discover available routes.
416416

417417
**Q: Do I need FLR tokens to use this?**
418418
A: You need C2FLR (testnet FLR) to:
@@ -459,6 +459,6 @@ To continue your FAssets development journey, you can:
459459

460460
- Learn how to [mint FXRP manually](/fassets/developer-guides/fassets-mint)
461461
- Understand how to [redeem FXRP](/fassets/developer-guides/fassets-redeem)
462-
- Explore [auto-redemption from Hyperliquid](/fxrp/token-interactions/fxrp-autoredeem)
462+
- Explore [auto-redemption from Hyperliquid](/fxrp/oft/fxrp-autoredeem)
463463
- Read more about [Flare Smart Accounts](/smart-accounts/overview)
464464
:::
File renamed without changes.

docs/fxrp/oft/index.mdx

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
title: Omnichain Fungible Token (OFT)
3+
tags: [intermediate, fassets]
4+
description: FXRP is an Omnichain Fungible Token (OFT) enabling cross-chain transfers via LayerZero
5+
keywords: [fassets, flare-network, fxrp, layerzero, oft, omnichain, cross-chain]
6+
---
7+
8+
import CopyButton from "@site/src/components/CopyButton";
9+
import DocCardList from "@theme/DocCardList";
10+
11+
## Overview
12+
13+
FXRP token is deployed as an [Omnichain Fungible Token (OFT)](https://docs.layerzero.network/v2/home/token-standards/oft-standard) using the [LayerZero](https://layerzero.network/) protocol.
14+
This enables FXRP to be transferred across multiple blockchain networks while maintaining fungibility and a unified total supply.
15+
16+
The OFT standard allows tokens to be natively transferred between chains without the need for wrapped versions or liquidity pools, providing a seamless cross-chain experience for FXRP holders.
17+
18+
## How It Works
19+
20+
On Flare, FXRP uses an **OFT Adapter** contract that locks tokens when bridging to other chains.
21+
On destination chains, native OFT contracts mint and burn tokens as they are transferred in and out.
22+
23+
For more details on the OFT standard and how it works, see the [LayerZero OFT documentation](https://docs.layerzero.network/v2/home/token-standards/oft-standard).
24+
25+
## Bridge FXRP
26+
27+
You can bridge FXRP between supported chains using [Stargate Finance](https://stargate.finance/?srcChain=flare&srcToken=0xAd552A648C74D49E10027AB8a618A3ad4901c5bE) protocol.
28+
29+
## Deployments
30+
31+
The following table lists the FXRP OFT contract addresses across supported chains:
32+
33+
| Chain | Contract Type | Address |
34+
| ---------------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
35+
| Flare | OFT Adapter | [`0xd70659a6396285BF7214d7Ea9673184e7C72E07E`](https://flare-explorer.flare.network/address/0xd70659a6396285BF7214d7Ea9673184e7C72E07E) <CopyButton textToCopy="0xd70659a6396285BF7214d7Ea9673184e7C72E07E" /> |
36+
| HyperEVM | OFT | [`0xd70659a6396285BF7214d7Ea9673184e7C72E07E`](https://hyperevmscan.io/address/0xd70659a6396285BF7214d7Ea9673184e7C72E07E) <CopyButton textToCopy="0xd70659a6396285BF7214d7Ea9673184e7C72E07E" /> |
37+
| HyperCore | OFT | [`0x200000000000000000000000000000000000016f`](https://app.hyperliquid.xyz/explorer/address/0x200000000000000000000000000000000000016f) <CopyButton textToCopy="0x200000000000000000000000000000000000016f" /> |
38+
| Ethereum Mainnet | OFT | [`0xce6170ea245dc8d1f275a710a062b70f125f0110`](https://etherscan.io/address/0xce6170ea245dc8d1f275a710a062b70f125f0110) <CopyButton textToCopy="0xce6170ea245dc8d1f275a710a062b70f125f0110" /> |
39+
40+
## Guides
41+
42+
Learn how to bridge FXRP across chains using LayerZero's OFT standard, including automatic redemption to native XRP and cross-chain minting.
43+
44+
<DocCardList
45+
items={[
46+
{
47+
type: "link",
48+
label: "FAsset Auto-Redemption",
49+
href: "/fxrp/oft/fxrp-autoredeem",
50+
docId: "fxrp/oft/fassets-autoredeem",
51+
},
52+
{
53+
type: "link",
54+
label: "Auto Minting and Bridging FXRP",
55+
href: "/fxrp/oft/fxrp-automint",
56+
docId: "fxrp/oft/fassets-automint",
57+
},
58+
]}
59+
/>
60+
61+
:::tip[What's next]
62+
63+
Learn more about FAssets and how to use the OFT with the FXRP token:
64+
65+
- [FAssets Overview](/fassets/overview)
66+
67+
:::

docs/fxrp/overview.mdx

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -77,17 +77,32 @@ Guides for working directly with the FXRP token.
7777
href: "/fxrp/token-interactions/x402-payments",
7878
docId: "fxrp/token-interactions/x402-payments",
7979
},
80+
]}
81+
/>
82+
83+
## Omnichain Fungible Token
84+
85+
FXRP is deployed as an [Omnichain Fungible Token (OFT)](/fxrp/oft) using LayerZero, enabling cross-chain transfers.
86+
87+
<DocCardList
88+
items={[
89+
{
90+
type: "link",
91+
label: "OFT Overview",
92+
href: "/fxrp/oft",
93+
docId: "fxrp/oft/index",
94+
},
8095
{
8196
type: "link",
8297
label: "FAsset Auto-Redemption",
83-
href: "/fxrp/token-interactions/fxrp-autoredeem",
84-
docId: "fxrp/token-interactions/fassets-autoredeem",
98+
href: "/fxrp/oft/fxrp-autoredeem",
99+
docId: "fxrp/oft/fassets-autoredeem",
85100
},
86101
{
87102
type: "link",
88103
label: "Auto Minting and Bridging",
89-
href: "/fxrp/token-interactions/fxrp-automint",
90-
docId: "fxrp/token-interactions/fassets-automint",
104+
href: "/fxrp/oft/fxrp-automint",
105+
docId: "fxrp/oft/fassets-automint",
91106
},
92107
]}
93108
/>

sidebars.ts

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -287,10 +287,17 @@ const sidebars: SidebarsConfig = {
287287
"fxrp/token-interactions/fxrp-address",
288288
"fxrp/token-interactions/usdt0-fxrp-swap",
289289
"fxrp/token-interactions/x402-payments",
290-
"fxrp/token-interactions/fassets-autoredeem",
291-
"fxrp/token-interactions/fassets-automint",
292290
],
293291
},
292+
{
293+
type: "category",
294+
label: "Omnichain Fungible Token",
295+
link: {
296+
type: "doc",
297+
id: "fxrp/oft/index",
298+
},
299+
items: ["fxrp/oft/fassets-autoredeem", "fxrp/oft/fassets-automint"],
300+
},
294301
{
295302
type: "category",
296303
label: "Firelight Vaults",

0 commit comments

Comments
 (0)