docs(fassets): add auto-redemption documentation and examples #1043

AmadiaFlare · 2025-11-26T06:39:14Z

Adds docs and examples for FAsset auto-redemption.

docs/fassets/developer-guides/12-fassets-autoredeem.mdx

fassko · 2025-12-11T09:25:47Z

@AmadiaFlare please make a new section Layer Zero or Cross Chain in docs/fassets/developer-guides.mdx to have this guide when users click on Developer Guides.

fassko

I added bunch of comments, let's dicuss.

fassko · 2025-12-11T09:28:33Z

docs/fassets/developer-guides/12-fassets-autoredeem.mdx

+- Bridge FXRP tokens from Coston2 to Hyperliquid EVM to prepare for auto-redemption
+- Send FXRP from Hyperliquid back to Coston2 and auto-redeem to native XRP
+- Execute the entire bridge-and-redeem flow with just one transaction


Suggested change

- Bridge FXRP tokens from Coston2 to Hyperliquid EVM to prepare for auto-redemption

- Send FXRP from Hyperliquid back to Coston2 and auto-redeem to native XRP

- Execute the entire bridge-and-redeem flow with just one transaction

- Bridge FXRP tokens from Flare Testnet Coston2 to Hyperliquid EVM to prepare for auto-redemption.

- Send FXRP from Hyperliquid back to Flare Testnet Coston2 and auto-redeem to native XRP.

- Execute the entire bridge-and-redeem flow with just one transaction.

fassko · 2025-12-11T09:29:52Z

docs/fassets/developer-guides/12-fassets-autoredeem.mdx

+
+## Introduction
+
+This documentation covers a cross-chain bridge system that allows you to move FAssets (tokenized versions of non-smart contract tokens like XRP) between Flare Network's Coston2 testnet and Hyperliquid EVM Testnet.


Suggested change

This documentation covers a cross-chain bridge system that allows you to move FAssets (tokenized versions of non-smart contract tokens like XRP) between Flare Network's Coston2 testnet and Hyperliquid EVM Testnet.

This documentation covers a cross-chain bridge system that allows you to move FAssets (tokenized versions of non-smart contract tokens like XRP) between Flare Testnet Coston2 and Hyperliquid EVM Testnet.

fassko · 2025-12-11T09:35:00Z

docs/fassets/developer-guides/12-fassets-autoredeem.mdx

+- LayerZero OFT (Omnichain Fungible Token) for cross-chain messaging
+- Flare's FAsset system for tokenizing non-smart contract assets
+- Composer pattern for automatic execution on the destination chain


Suggested change

- LayerZero OFT (Omnichain Fungible Token) for cross-chain messaging

- Flare's FAsset system for tokenizing non-smart contract assets

- Composer pattern for automatic execution on the destination chain

- LayerZero OFT (Omnichain Fungible Token) for cross-chain messaging.

- Flare's [FAsset](/fassets/overview) system for tokenizing non-smart contract assets.

- Composer pattern for automatic execution on the destination chain.

Add link to LayerZero OFT to LayerZero docs.

Is it LayerZero composer, needs a bit more explanation what is it.

fassko · 2025-12-11T09:40:55Z

docs/fassets/developer-guides/12-fassets-autoredeem.mdx

+**IMPORTANT:** To successfully test the auto-redemption feature, you must run the scripts in the correct order:
+
+### Step 1: Bridge FXRP to Hyperliquid EVM (Required First)
+


I think it makes sense to explain briefly what is OFT how it moves tokens.

fassko · 2025-12-11T09:48:45Z

docs/fassets/developer-guides/12-fassets-autoredeem.mdx

+Run `bridgeToHyperEVM.ts` on **Coston2** network to transfer your FXRP tokens from Coston2 to Hyperliquid EVM Testnet.
+This script does NOT involve auto-redemption - it simply moves your tokens to Hyperliquid where you can use them to prepare for the auto-redemption process.
+
+**Why this is required:** You need FXRP tokens on Hyperliquid EVM before you can test the auto-redeem functionality.


Put this in info block

:::info

:::

fassko · 2025-12-11T14:41:47Z

examples/developer-hub-javascript/bridgeToHyperEVM.ts

+    composeMsg: "0x",
+    oftCmd: "0x",


Why these are 0x values? Add a comment

fassko · 2025-12-11T14:45:00Z

examples/developer-hub-javascript/getOftPeers.ts

+function getAllV2TestnetEndpoints(): { name: string; eid: number }[] {
+  const endpoints: { name: string; eid: number }[] = [];
+
+  for (const [key, value] of Object.entries(EndpointId)) {
+    // Only include V2 testnet endpoints (they end with _V2_TESTNET and have numeric values)
+    if (key.endsWith("_V2_TESTNET") && typeof value === "number") {
+      // Convert key like "SEPOLIA_V2_TESTNET" to "Sepolia"
+      const name = key
+        .replace("_V2_TESTNET", "")
+        .split("_")
+        .map((word) => word.charAt(0) + word.slice(1).toLowerCase())
+        .join(" ");
+      endpoints.push({ name, eid: value });
+    }
+  }
+
+  // Sort by EID for consistent output
+  return endpoints.sort((a, b) => a.eid - b.eid);
+}


If you use higher order function then there is no need to define empty array.

Suggested change

function getAllV2TestnetEndpoints(): { name: string; eid: number }[] {

const endpoints: { name: string; eid: number }[] = [];

for (const [key, value] of Object.entries(EndpointId)) {

// Only include V2 testnet endpoints (they end with _V2_TESTNET and have numeric values)

if (key.endsWith("_V2_TESTNET") && typeof value === "number") {

// Convert key like "SEPOLIA_V2_TESTNET" to "Sepolia"

const name = key

.replace("_V2_TESTNET", "")

.split("_")

.map((word) => word.charAt(0) + word.slice(1).toLowerCase())

.join(" ");

endpoints.push({ name, eid: value });

}

}

// Sort by EID for consistent output

return endpoints.sort((a, b) => a.eid - b.eid);

}

function getAllV2TestnetEndpoints(): { name: string; eid: number }[] {

return Object.entries(EndpointId)

.filter(([key, value]) => key.endsWith("_V2_TESTNET") && typeof value === "number")

.map(([key, eid]) => ({

name: key

.replace("_V2_TESTNET", "")

.split("_")

.map(w => w.charAt(0) + w.slice(1).toLowerCase())

.join(" "),

eid,

}))

.sort((a, b) => a.eid - b.eid);

}

fassko · 2025-12-11T14:45:42Z

examples/developer-hub-javascript/getOftPeers.ts

+
+  for (const endpoint of V2_TESTNET_ENDPOINTS) {
+    try {
+      const peer = await oftAdapter.methods.peers(endpoint.eid).call();


Similar here , can convert to higher order function.

examples/developer-hub-javascript/getOftPeers.ts

fassko

I added bunch of comments, let's dicuss.

fassko

Style improvements and lot calculation

fassko · 2025-12-15T11:34:39Z

docs/fassets/developer-guides/12-fassets-autoredeem.mdx

+
+Once you have FXRP tokens on Hyperliquid (from Step 1), run `autoRedeemHyperEVM.ts` on **Hyperliquid Testnet** network to send them back to Coston2 with automatic redemption to native XRP.
+This is the auto-redemption feature that converts FXRP back to native XRP in a single transaction.
+


OK if the same private key works, then it is all good.

docs/fassets/developer-guides/12-fassets-autoredeem.mdx

examples/developer-hub-javascript/autoRedeemHyperEVM.ts

examples/developer-hub-javascript/bridgeToHyperEVM.ts

fassko

Style improvements

docs/fassets/developer-guides/12-fassets-autoredeem.mdx

examples/developer-hub-javascript/autoRedeemHyperEVM.ts

docs(fassets): add auto-redemption documentation and examples

93ac894

AmadiaFlare requested a review from dineshpinto as a code owner November 26, 2025 06:39

chore(fassets): use Contract type

7d7547f

AmadiaFlare requested a review from fassko November 26, 2025 06:48

AmadiaFlare and others added 3 commits December 10, 2025 11:39

docs(fassets): add OFT peers discovery section to auto-redemption guide

8018c5a

chore(fassets): lint

af19dd2

Merge branch 'main' into fassets/autoredeem

986c558

dineshpinto reviewed Dec 10, 2025

View reviewed changes

fassko requested changes Dec 11, 2025

View reviewed changes

AmadiaFlare and others added 5 commits December 12, 2025 14:15

chore(fassets): formatting

a86d066

chore(fassets): newlines and script updates

37d6233

chore(fassets): typescript linting

cb266ff

chore(fassets): lz docs

84fd866

Merge branch 'main' into fassets/autoredeem

9b9f7bf

dineshpinto previously approved these changes Dec 16, 2025

View reviewed changes

fassko requested changes Dec 16, 2025

View reviewed changes

chore(fassets): formatting and style

9ed764e

AmadiaFlare dismissed dineshpinto’s stale review via 9ed764e December 16, 2025 16:05

chore(fassets): remove address

b45ffe4

fassko requested changes Dec 17, 2025

View reviewed changes

chore(fassets): styling and index guide

bc71326

fassko approved these changes Dec 18, 2025

View reviewed changes

Merge branch 'main' into fassets/autoredeem

d688ef4

dineshpinto merged commit a27c2e9 into main Dec 18, 2025
14 checks passed

dineshpinto deleted the fassets/autoredeem branch December 18, 2025 13:12


		## Introduction

		This documentation covers a cross-chain bridge system that allows you to move FAssets (tokenized versions of non-smart contract tokens like XRP) between Flare Network's Coston2 testnet and Hyperliquid EVM Testnet.

		IMPORTANT: To successfully test the auto-redemption feature, you must run the scripts in the correct order:

		### Step 1: Bridge FXRP to Hyperliquid EVM (Required First)


		Once you have FXRP tokens on Hyperliquid (from Step 1), run `autoRedeemHyperEVM.ts` on Hyperliquid Testnet network to send them back to Coston2 with automatic redemption to native XRP.
		This is the auto-redemption feature that converts FXRP back to native XRP in a single transaction.

docs(fassets): add auto-redemption documentation and examples #1043

docs(fassets): add auto-redemption documentation and examples #1043

Uh oh!

Conversation

AmadiaFlare commented Nov 26, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fassko commented Dec 11, 2025

Uh oh!

fassko left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

fassko left a comment

Choose a reason for hiding this comment

Uh oh!

fassko left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fassko left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants