refactor(docs): clean up whitespace and improve formatting in FAssets documentation and TypeScript examples

Author: fassko

docs/fassets/developer-guides/1-fassets-get-asset-amanager-address-registry.mdx

@@ -42,4 +42,3 @@ 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).
-

docs/fassets/developer-guides/3-fassets-asset-manager-settings-solidity.mdx

@@ -41,7 +41,7 @@ To get the FAsset lot size, you can use the following smart contract:
 2. Import the interface `IAssetManager` from the [Flare Periphery Contracts package](https://www.npmjs.com/package/@flarenetwork/flare-periphery-contracts), which provides access to the FAssets system.
 3. Create a contract called `FAssetsSettings` that will be used to fetch the FAssets settings from the asset manager.
 4. The `getLotSize` function gets numbers from the FAssets FXRP asset manager settings.
-Using the [`getSettings`](/fassets/reference/IAssetManager#getsettings) function returns the complete asset manager settings that you can find in the [FAssets Operational Parameters](/fassets/operational-parameters/#asset-manager-operational-parameters) documentation:
+   Using the [`getSettings`](/fassets/reference/IAssetManager#getsettings) function returns the complete asset manager settings that you can find in the [FAssets Operational Parameters](/fassets/operational-parameters/#asset-manager-operational-parameters) documentation:
    - `lotSizeAMG`: The smallest amount you can trade (in AMG units).
    - `assetDecimals`: How many decimal places the FAssets asset uses.
 5. The `getLotSize` function returns two values:
@@ -64,23 +64,23 @@ Use the following TypeScript script to deploy the contract and fetch the FAsset
 const FAssetsSettings = artifacts.require("FAssetsSettings");
 
 async function main() {
-    // 2. Deploy the contract
-    const fAssetsSettings = await FAssetsSettings.new();
-    console.log("FAssetsSettings deployed to:", fAssetsSettings.address);
-
-    // 3. Call getSettings function
-    const lotSize = await fAssetsSettings.getLotSize();
-    console.log("Lot size:", lotSize[0]);
-    console.log("Decimals:", lotSize[1]);
-
-    // 4. Convert lot size to XRP
-    const lotSizeFXRP = Number(lotSize[0]) / Math.pow(10, Number(lotSize[1]));
-    console.log("Lot size in XRP", lotSizeFXRP);
+  // 2. Deploy the contract
+  const fAssetsSettings = await FAssetsSettings.new();
+  console.log("FAssetsSettings deployed to:", fAssetsSettings.address);
+
+  // 3. Call getSettings function
+  const lotSize = await fAssetsSettings.getLotSize();
+  console.log("Lot size:", lotSize[0]);
+  console.log("Decimals:", lotSize[1]);
+
+  // 4. Convert lot size to XRP
+  const lotSizeFXRP = Number(lotSize[0]) / Math.pow(10, Number(lotSize[1]));
+  console.log("Lot size in XRP", lotSizeFXRP);
 }
 
-main().catch(error => {
-    console.error(error);
-    process.exitCode = 1;
+main().catch((error) => {
+  console.error(error);
+  process.exitCode = 1;
 });
 ```
 

docs/fassets/developer-guides/6-fassets-minting-executor.mdx

@@ -70,8 +70,8 @@ The following code demonstrates how to reserve collateral by calling the [`reser
 9. Calculate the collateral reservation fee by calling [`collateralReservationFee`](/fassets/reference/IAssetManager#collateralreservationfee).
 10. Set the executor fee the same as the collateral reservation fee to make this example simpler.
 11. Reserve collateral from agent by calling [`reserveCollateral`](/fassets/reference/IAssetManager#reservecollateral) with the executor address.
-   The executor fee is on top of the collateral reservation fee in native tokens.
-   The fee is agreed between the minter and the executor.
+    The executor fee is on top of the collateral reservation fee in native tokens.
+    The fee is agreed between the minter and the executor.
 12. Call `assetMintingDecimals` to determine the XRP token's decimal precision.
 13. Parse the [`CollateralReserved`](/fassets/reference/IAssetManagerEvents#collateralreserved) event to get the collateral reservation ID and other important collateral reservation details.
 14. Calculate the total XRP value required for payment.

docs/fassets/developer-guides/7-fassets-redeem.mdx

@@ -175,19 +175,23 @@ You can find this function in the [Flare Hardhat Starter Kit](/network/guides/ha
 In this guide, we are not focusing on the event parsing.
 :::
 
-### Output the  Redemption Result
+### Output the Redemption Result
 
 The following function is used to output the redemption request information.
 
 ```typescript
-async function printRedemptionRequestInfo(fAssetsRedeem: any, redemptionRequestedEvents: any[]) {
-    console.log("\n=== Redemption Request Information ===");
-    
-    for (const event of redemptionRequestedEvents) {
-        const redemptionRequestInfo = await fAssetsRedeem
-            .getRedemptionRequestInfo(event.decoded.requestId);
-        console.log("Redemption request info:", redemptionRequestInfo);
-    }
+async function printRedemptionRequestInfo(
+  fAssetsRedeem: any,
+  redemptionRequestedEvents: any[],
+) {
+  console.log("\n=== Redemption Request Information ===");
+
+  for (const event of redemptionRequestedEvents) {
+    const redemptionRequestInfo = await fAssetsRedeem.getRedemptionRequestInfo(
+      event.decoded.requestId,
+    );
+    console.log("Redemption request info:", redemptionRequestInfo);
+  }
 }
 ```
 

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

@@ -66,18 +66,22 @@ It initializes the token as the first token in the swap path.
 The `swapAndRedeem` is the core function that executes the swap and redemption flow.
 
 - **1. Validation**
+
   - Ensure the caller has sufficient WCFLR balance.
   - Confirm the contract has enough FXRP allowance for redemption.
 
 - **2. Transfer**
+
   - Move WCFLR from the caller to the contract.
   - Approve the router to spend WCFLR on behalf of the contract.
 
 - **3. Swap**
+
   - Perform the swap from WCFLR to FXRP using the specified swap path.
   - Apply a 10-minute deadline for the swap operation.
 
 - **4. Redemption**
+
   - Redeem the obtained FXRP through the FAssets system.
   - Transfer the resulting XRP to the caller's XRPL address.
 
@@ -105,18 +109,22 @@ To execute the swap and redeem process, you need to deploy the smart contract in
 ### Code Breakdown
 
 - **1. Dependencies and Constants**
+
   - `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.
   - `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).
 
 - **3. Calculate Redemption Amounts**
+
   - Calls `calculateRedemptionAmountIn` to determine the required WCFLR amount.
 
 - **4. Approve Tokens**
+
   - Uses the ERC-20 `approve` method to allow the contract to spend WCFLR.
     :::warning
     In a production environment, you should use a secure method to approve spending the tokens.

examples/developer-hub-javascript/fassetsExecuteMinting.ts

@@ -6,7 +6,8 @@ import { logEvents } from "../../scripts/utils/core";
 // yarn hardhat run scripts/fassets/executeMinting.ts --network coston2
 
 // 1. Environment variables
-const { COSTON2_DA_LAYER_URL, VERIFIER_URL_TESTNET, VERIFIER_API_KEY_TESTNET } = process.env;
+const { COSTON2_DA_LAYER_URL, VERIFIER_URL_TESTNET, VERIFIER_API_KEY_TESTNET } =
+  process.env;
 
 // 2. Collateral reservation ID
 const COLLATERAL_RESERVATION_ID = 10255417;
@@ -20,80 +21,88 @@ const sourceIdBase = "testXRP";
 const verifierUrlBase = VERIFIER_URL_TESTNET;
 const urlTypeBase = "xrp";
 
-const transactionId = "EC0FC5F40FBE6AEAD31138898C71687B2902E462FD1BFEF3FB443BE5E2C018F9";
+const transactionId =
+  "EC0FC5F40FBE6AEAD31138898C71687B2902E462FD1BFEF3FB443BE5E2C018F9";
 const inUtxo = "0";
 const utxo = "0";
 
 // 5. AssetManager contract
 const AssetManager = artifacts.require("IAssetManager");
 
 // 6. Prepare FDC request
-async function prepareFdcRequest(transactionId: string, inUtxo: string, utxo: string) {
-    const requestBody = {
-        transactionId: transactionId,
-        inUtxo: inUtxo,
-        utxo: utxo,
-    };
-
-    const url = `${verifierUrlBase}verifier/${urlTypeBase}/Payment/prepareRequest`;
-
-    return await prepareAttestationRequestBase(
-        url,
-        VERIFIER_API_KEY_TESTNET,
-        attestationTypeBase,
-        sourceIdBase,
-        requestBody
-    );
+async function prepareFdcRequest(
+  transactionId: string,
+  inUtxo: string,
+  utxo: string,
+) {
+  const requestBody = {
+    transactionId: transactionId,
+    inUtxo: inUtxo,
+    utxo: utxo,
+  };
+
+  const url = `${verifierUrlBase}verifier/${urlTypeBase}/Payment/prepareRequest`;
+
+  return await prepareAttestationRequestBase(
+    url,
+    VERIFIER_API_KEY_TESTNET,
+    attestationTypeBase,
+    sourceIdBase,
+    requestBody,
+  );
 }
 
 // 7. Get proof from FDC
 async function getProof(roundId: number) {
-    const request = await prepareFdcRequest(transactionId, inUtxo, utxo);
-    const proofAndData = await fetch(`${COSTON2_DA_LAYER_URL}api/v0/fdc/get-proof-round-id-bytes`, {
-        method: "POST",
-        headers: {
-            "Content-Type": "application/json",
-            "X-API-KEY": VERIFIER_API_KEY_TESTNET,
-        },
-        body: JSON.stringify({
-            votingRoundId: roundId,
-            requestBytes: request.abiEncodedRequest,
-        }),
-    });
-
-    return await proofAndData.json();
+  const request = await prepareFdcRequest(transactionId, inUtxo, utxo);
+  const proofAndData = await fetch(
+    `${COSTON2_DA_LAYER_URL}api/v0/fdc/get-proof-round-id-bytes`,
+    {
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json",
+        "X-API-KEY": VERIFIER_API_KEY_TESTNET,
+      },
+      body: JSON.stringify({
+        votingRoundId: roundId,
+        requestBytes: request.abiEncodedRequest,
+      }),
+    },
+  );
+
+  return await proofAndData.json();
 }
 
 // 8. Parse events
 async function parseEvents(receipt: any) {
-    console.log("\nParsing events...", receipt.rawLogs);
+  console.log("\nParsing events...", receipt.rawLogs);
 
-    logEvents(receipt.rawLogs, "RedemptionTicketCreated", AssetManager.abi);
+  logEvents(receipt.rawLogs, "RedemptionTicketCreated", AssetManager.abi);
 
-    logEvents(receipt.rawLogs, "MintingExecuted", AssetManager.abi);
+  logEvents(receipt.rawLogs, "MintingExecuted", AssetManager.abi);
 }
 
 async function main() {
-    // 9. Get proof from FDC
-    const proof = await getProof(TARGET_ROUND_ID);
-
-    const assetManager: IAssetManagerInstance = await getFXRPAssetManager();
-
-    // 10. Execute minting
-    const tx = await assetManager.executeMinting(
-        {
-            merkleProof: proof.proof,
-            data: proof.response,
-        },
-        COLLATERAL_RESERVATION_ID
-    );
-    console.log("Transaction successful:", tx);
-
-    // 11. Parse execute minting log events
-    await parseEvents(tx.receipt);
+  // 9. Get proof from FDC
+  const proof = await getProof(TARGET_ROUND_ID);
+
+  const assetManager: IAssetManagerInstance = await getFXRPAssetManager();
+
+  // 10. Execute minting
+  const tx = await assetManager.executeMinting(
+    {
+      merkleProof: proof.proof,
+      data: proof.response,
+    },
+    COLLATERAL_RESERVATION_ID,
+  );
+  console.log("Transaction successful:", tx);
+
+  // 11. Parse execute minting log events
+  await parseEvents(tx.receipt);
 }
 
-main().catch(error => {
-    console.error(error);
-    process.exitCode = 1;
+main().catch((error) => {
+  console.error(error);
+  process.exitCode = 1;
 });

examples/developer-hub-javascript/fassetsSwapAndRedeem.ts

@@ -19,55 +19,59 @@ const SwapAndRedeem = artifacts.require("SwapAndRedeem");
 
 // 2. Deploy and verify the `SwapAndRedeem` smart contract
 async function deployAndVerifyContract() {
-    const assetManager = await getAssetManagerFXRP();
-    const fassetAddress = await assetManager.fAsset();
-    const swapPath = [WC2FLR, fassetAddress];
+  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 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: any) {
-        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
-    // 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);
+  // 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;
 });