refactor(docs): add helper functions and update asset manager retrieval in FAssets swap and redeem documentation

Author: fassko

docs/fassets/developer-guides/8-fassets-swap-redeem.mdx

@@ -85,6 +85,15 @@ The `swapAndRedeem` is the core function that executes the swap and redemption f
   - Accept the number of FXRP lots intended for redemption.
   - Fetch the lot size from the FAssets asset manager and calculate the WCFLR needed for swap and redemption.
 
+### 5. Helper Function: `calculateRedemptionAmountIn`
+
+This function calculates the amount of WCFLR needed to swap to FXRP and redeem.
+
+### 6. Helper Function: `_redeem`
+
+- Redeem the obtained FXRP through the FAssets system.
+- Transfer the resulting XRP to the caller's XRPL address.
+
 ## Execute the Swap and Redeem
 
 To execute the swap and redeem process, you need to deploy the smart contract instance and call the `swapAndRedeem` function.
@@ -96,11 +105,10 @@ To execute the swap and redeem process, you need to deploy the smart contract in
 ### Code Breakdown
 
 - **1. Dependencies and Constants**
-  - `ASSET_MANAGER_ADDRESS`: The address of the FAssets Asset Manager contract.
   - `LOTS_TO_REDEEM`: The number of FAsset lots to redeem (typically set to 1).
   - `UNDERLYING_ADDRESS`: The XRPL address that will receive the redeemed assets.
   - `SWAP_ROUTER_ADDRESS`: The address of the Uniswap V2-compatible swap router.
-  - `SWAP_PATH`: An array of token addresses defining the swap path from WCFLR to FXRP.
+  - `WC2FLR`: Wrapped CFLR token address.
 
 - **2. Deploy and Verify**
   - Deploys the `SwapAndRedeem` contract and verifies it using [Flare Hardhat Starter Kit](/network/guides/hardhat-foundry-starter-kit).

examples/developer-hub-javascript/fassetsSwapAndRedeem.ts

@@ -4,68 +4,70 @@ import { run } from "hardhat";
 import { SwapAndRedeemInstance } from "../../typechain-types";
 import { ERC20Instance } from "../../typechain-types/@openzeppelin/contracts/token/ERC20/ERC20";
 
-// AssetManager address on Songbird Testnet Coston network
-const ASSET_MANAGER_ADDRESS = "0x56728e46908fB6FcC5BCD2cc0c0F9BB91C3e4D34";
+import { getAssetManagerFXRP } from "../utils/getters";
+
+// yarn hardhat run scripts/fassets/swapAndRedeem.ts --network coston2
+
 const LOTS_TO_REDEEM = 1;
 const UNDERLYING_ADDRESS = "rSHYuiEvsYsKR8uUHhBTuGP5zjRcGt4nm";
-// BlazeSwap router address on Songbird Testnet Coston network
-const SWAP_ROUTER_ADDRESS = "0xf0D01450C037DB2903CF5Ff638Dd1e2e6B0EEDF4";
-const SWAP_PATH = [
-  "0x767b25A658E8FC8ab6eBbd52043495dB61b4ea91", // WCFLR
-  "0x36be8f2e1CC3339Cf6702CEfA69626271C36E2fd", // FXRP
-];
+
+// BlazeSwap router address on Flare Testnet Coston2 network
+const SWAP_ROUTER_ADDRESS = "0x8D29b61C41CF318d15d031BE2928F79630e068e6";
+const WC2FLR = "0xC67DCE33D7A8efA5FfEB961899C73fe01bCe9273";
+
+const SwapAndRedeem = artifacts.require("SwapAndRedeem");
 
 // 2. Deploy and verify the `SwapAndRedeem` smart contract
 async function deployAndVerifyContract() {
-  const SwapAndRedeem = artifacts.require("SwapAndRedeem");
-  const args = [SWAP_ROUTER_ADDRESS, ASSET_MANAGER_ADDRESS, SWAP_PATH];
-  const swapAndRedeem: SwapAndRedeemInstance = await SwapAndRedeem.new(...args);
+    const assetManager = await getAssetManagerFXRP();
+    const fassetAddress = await assetManager.fAsset();
+    const swapPath = [WC2FLR, fassetAddress];
+
+    const args = [SWAP_ROUTER_ADDRESS, swapPath];
+    const swapAndRedeem: SwapAndRedeemInstance = await SwapAndRedeem.new(...args);
 
-  const fassetsSwapAndRedeemAddress = await swapAndRedeem.address;
+    const fassetsSwapAndRedeemAddress = await swapAndRedeem.address;
 
-  try {
-    await run("verify:verify", {
-      address: fassetsSwapAndRedeemAddress,
-      constructorArguments: args,
-    });
-  } catch (e) {
-    console.log(e);
-  }
+    try {
+        await run("verify:verify", {
+            address: fassetsSwapAndRedeemAddress,
+            constructorArguments: args,
+        });
+    } catch (e: any) {
+        console.log(e);
+    }
 
-  console.log("FAssetsSwapAndRedeem deployed to:", fassetsSwapAndRedeemAddress);
+    console.log("FAssetsSwapAndRedeem deployed to:", fassetsSwapAndRedeemAddress);
 
-  return swapAndRedeem;
+    return swapAndRedeem;
 }
 
 async function main() {
-  // 2. Deploy and verify the `SwapAndRedeem` smart contract
-  const swapAndRedeem: SwapAndRedeemInstance = await deployAndVerifyContract();
-
-  // 3. Calculate Required Amounts
-  const swapAndRedeemAddress = await swapAndRedeem.address;
-  const amounts =
-    await swapAndRedeem.calculateRedemptionAmountIn(LOTS_TO_REDEEM);
-  const amountIn = amounts.amountIn;
-  const amountOut = amounts.amountOut;
-  console.log("Amount of tokens out (FXRP): ", amountOut.toString());
-  console.log("Amount of tokens in (WCFLR): ", amountIn.toString());
-
-  // 4. Approve spending WCFLR tokens
-  const ERC20 = artifacts.require("ERC20");
-  const wcflr: ERC20Instance = await ERC20.at(SWAP_PATH[0]);
-
-  const approveTx = await wcflr.approve(swapAndRedeemAddress, amountOut);
-  console.log("Approve transaction: ", approveTx);
-
-  // 5. Swap WCFLR for FXRP and redeem to underlying XRP token on XRP Ledger
-  const swapResult = await swapAndRedeemAddress.swapAndRedeem(
-    LOTS_TO_REDEEM,
-    UNDERLYING_ADDRESS,
-  );
-  console.log("Swap and redeem transaction: ", swapResult);
+    // 2. Deploy and verify the `SwapAndRedeem` smart contract
+    const swapAndRedeem: SwapAndRedeemInstance = await deployAndVerifyContract();
+
+    // 3. Calculate Required Amounts
+    const swapAndRedeemAddress = await swapAndRedeem.address;
+    const amounts = await swapAndRedeem.calculateRedemptionAmountIn(LOTS_TO_REDEEM);
+    const amountIn = amounts.amountIn;
+    const amountOut = amounts.amountOut;
+    console.log("Amount of tokens out (FXRP): ", amountOut.toString());
+    console.log("Amount of tokens in (WCFLR): ", amountIn.toString());
+
+    // 4. Approve spending WCFLR tokens
+    // Get WCFLR token
+    const ERC20 = artifacts.require("ERC20");
+    const wcflr: ERC20Instance = await ERC20.at(WC2FLR);
+
+    const approveTx = await wcflr.approve(swapAndRedeemAddress, amountOut);
+    console.log("Approve transaction: ", approveTx);
+
+    // 5. Swap WCFLR for FXRP and redeem to underlying XRP token on XRP Ledger
+    const swapResult = await swapAndRedeem.swapAndRedeem(LOTS_TO_REDEEM, UNDERLYING_ADDRESS);
+    console.log("Swap and redeem transaction: ", swapResult);
 }
 
-main().catch((error) => {
-  console.error(error);
-  process.exitCode = 1;
+main().catch(error => {
+    console.error(error);
+    process.exitCode = 1;
 });

examples/developer-hub-solidity/FAssetsSwapAndRedeem.sol

@@ -4,8 +4,9 @@ pragma solidity ^0.8.25;
 // 1. Required Imports
 import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 
-import {IAssetManager} from "@flarenetwork/flare-periphery-contracts/coston/IAssetManager.sol";
-import {AssetManagerSettings} from "@flarenetwork/flare-periphery-contracts/coston/userInterfaces/data/AssetManagerSettings.sol";
+import {ContractRegistry} from "@flarenetwork/flare-periphery-contracts/coston2/ContractRegistry.sol";
+import {IAssetManager} from "@flarenetwork/flare-periphery-contracts/coston2/IAssetManager.sol";
+import {AssetManagerSettings} from "@flarenetwork/flare-periphery-contracts/coston2/data/AssetManagerSettings.sol";
 
 // 2. Interfaces
 
@@ -33,26 +34,23 @@ contract SwapAndRedeem {
 
     // Uniswap V2 Router interface to communicate with BlazeSwap
     ISwapRouter public immutable router;
-    // FAssets asset manager interface
-    IAssetManager public immutable assetManager;
     // FAssets token (FXRP)
     IERC20 public immutable token;
 
     // Path to swap WCFLR for FXRP
     address[] public swapPath;
 
-    constructor(
-        address _router,
-        address _assetManager,
-        address[] memory _swapPath
-    ) {
+    constructor(address _router, address[] memory _swapPath) {
         router = ISwapRouter(_router);
-        assetManager = IAssetManager(_assetManager);
         swapPath = _swapPath;
 
         token = IERC20(_swapPath[0]);
     }
 
+    function getAssetManager() public view returns (IAssetManager) {
+        return ContractRegistry.getAssetManagerFXRP();
+    }
+
     // 4. Main Function: `swapAndRedeem`
 
     // Swap WCFLR for FXRP and redeem FAssets
@@ -138,7 +136,8 @@ contract SwapAndRedeem {
     function calculateRedemptionAmountIn(
         uint256 _lots
     ) public view returns (uint256 amountOut, uint256 amountIn) {
-        AssetManagerSettings.Data memory settings = assetManager.getSettings();
+        AssetManagerSettings.Data memory settings = getAssetManager()
+            .getSettings();
         uint256 lotSizeAMG = settings.lotSizeAMG;
 
         // Calculate the amount of WCFLR needed to swap to FXRP
@@ -150,6 +149,8 @@ contract SwapAndRedeem {
         return (amounts[0], amounts[1]);
     }
 
+    // 6. Helper Function: `_redeem`
+
     // Redeem FAssets from FXRP to the redeemer's underlying XRPL address
     // @param _lots: number of lots to redeem
     // @param _redeemerUnderlyingAddressString: redeemer underlying address string (XRP address)
@@ -159,7 +160,7 @@ contract SwapAndRedeem {
         string memory _redeemerUnderlyingAddressString
     ) internal returns (uint256) {
         return
-            assetManager.redeem(
+            getAssetManager().redeem(
                 _lots,
                 _redeemerUnderlyingAddressString,
                 // The account that is allowed to execute redemption default (besides redeemer and agent).