refactor(docs): streamline Firelight vault guides by renumbering sections for clarity

Author: fassko

docs/fassets/firelight/deposit.mdx

@@ -44,23 +44,15 @@ The script starts by defining constants and importing the required contract inte
   Taken from the Firelight GitHub [repository](https://github.com/firelight-protocol/firelight-core/blob/main/contracts/FirelightVault.sol).
 - `IERC20`: Standard [ERC-20](https://eips.ethereum.org/EIPS/eip-20) interface for token interactions.
 
-### 2. Get Asset Information
-
-The script retrieves the underlying asset information to format amounts and calculate the deposit amount from the vault:
-
-- **Asset address**: The token address that the vault accepts (e.g., FXRP).
-- **Asset symbol**: The token symbol for display purposes.
-- **Asset decimals**: The number of decimals used by the token.
-
-### 3. Calculate Deposit Amount
+### 2. Calculate Deposit Amount
 
 The script converts the desired deposit amount into the correct units:
 
 ```typescript
 const amount = DEPOSIT_AMOUNT * 10 ** assetDecimals;
 ```
 
-### 4. Check Maximum Deposit Capacity
+### 3. Check Maximum Deposit Capacity
 
 Before depositing, the script checks if the requested amount exceeds the maximum allowed:
 
@@ -72,7 +64,7 @@ The `maxDeposit` function returns the maximum amount of assets that the specifie
 
 If the requested amount exceeds the maximum, the script exits with an error to prevent a failed transaction.
 
-### 5. Approve Token Transfer
+### 4. Approve Token Transfer
 
 Before depositing, the script must approve the vault to spend the deposit amount:
 
@@ -85,7 +77,7 @@ const approveTx = await assetToken.approve(vault.address, amount, {
 This approval is required because the vault needs to transfer assets from the user's account.
 The approval amount should match or exceed the `amount` value to be deposited.
 
-### 6. Deposit Assets
+### 5. Deposit Assets
 
 Finally, the script deposits the assets:
 

docs/fassets/firelight/mint.mdx

@@ -44,23 +44,15 @@ The script starts by defining constants and importing the required contract inte
   Taken from the Firelight GitHub [repository](https://github.com/firelight-protocol/firelight-core/blob/main/contracts/FirelightVault.sol).
 - `IERC20`: Standard [ERC-20](https://eips.ethereum.org/EIPS/eip-20) interface for token interactions.
 
-### 2. Get Asset Information
-
-The script retrieves the underlying asset information to format amounts and calculate the required asset amount for minting shares from the vault:
-
-- **Asset address**: The token address that the vault accepts (e.g., FXRP).
-- **Asset symbol**: The token symbol for display purposes.
-- **Asset decimals**: The number of decimals used by the token.
-
-### 3. Calculate Shares to Mint
+### 2. Calculate Shares to Mint
 
 The script converts the desired number of shares to mint into the correct units:
 
 ```typescript
 const sharesToMint = SHARES_TO_MINT * 10 ** assetDecimalsNum;
 ```
 
-### 4. Check Maximum Mint Capacity
+### 3. Check Maximum Mint Capacity
 
 Before minting, the script checks if the requested amount exceeds the maximum allowed:
 
@@ -72,7 +64,7 @@ The `maxMint` function returns the maximum number of shares that the specified a
 
 If the requested amount exceeds the maximum, the script exits with an error to prevent a failed transaction.
 
-### 5. Calculate Required Assets
+### 4. Calculate Required Assets
 
 The script uses the `previewMint` function to calculate how many assets are needed to mint the desired number of shares:
 
@@ -82,7 +74,7 @@ const assetsNeeded = await vault.previewMint(sharesToMint);
 
 The `previewMint` function is part of the [ERC-4626](https://eips.ethereum.org/EIPS/eip-4626) standard and returns the amount of assets required to mint a specific number of shares, accounting for the current exchange rate between assets and shares.
 
-### 6. Approve Token Transfer
+### 5. Approve Token Transfer
 
 Before minting, the script must approve the vault to spend the required amount of assets:
 
@@ -95,7 +87,7 @@ const approveTx = await assetToken.approve(vault.address, assetsNeeded, {
 This approval is required because the vault needs to transfer assets from the user's account.
 The approval amount should match or exceed the `assetsNeeded` value calculated in the previous step.
 
-### 7. Mint Vault Shares
+### 6. Mint Vault Shares
 
 Finally, the script mints the vault shares:
 

docs/fassets/firelight/redeem.mdx

@@ -45,23 +45,15 @@ The script starts by defining constants and importing the required contract inte
   Taken from the Firelight GitHub [repository](https://github.com/firelight-protocol/firelight-core/blob/main/contracts/FirelightVault.sol).
 - `IERC20`: Standard [ERC-20](https://eips.ethereum.org/EIPS/eip-20) interface for token interactions.
 
-### 2. Get Asset Information
-
-The script retrieves the underlying asset information to format amounts and calculate the redemption amount from the vault:
-
-- **Asset address**: The token address that the vault holds (e.g., FXRP).
-- **Asset symbol**: The token symbol for display purposes.
-- **Asset decimals**: The number of decimals used by the token.
-
-### 3. Calculate Shares to Redeem
+### 2. Calculate Shares to Redeem
 
 The script converts the desired number of shares to redeem into the correct units:
 
 ```typescript
 const sharesToRedeem = SHARES_TO_REDEEM * 10 ** assetDecimalsNum;
 ```
 
-### 4. Check Maximum Redemption Capacity
+### 3. Check Maximum Redemption Capacity
 
 Before redeeming, the script checks if the requested amount exceeds the maximum allowed:
 
@@ -72,7 +64,7 @@ const maxRedeem = await vault.maxRedeem(account);
 The `maxRedeem` function returns the maximum number of shares that the specified account can redeem.
 If the requested amount exceeds the maximum, the script exits with an error to prevent a failed transaction.
 
-### 5. Check User Balance
+### 4. Check User Balance
 
 The script displays the user's current vault share balance and validates that they have sufficient shares:
 
@@ -83,7 +75,7 @@ const userBalance = await vault.balanceOf(account);
 The script then validates that the user has sufficient shares to cover the redemption request.
 This validation ensures the redemption will succeed before attempting the transaction.
 
-### 6. Create Redemption Request
+### 5. Create Redemption Request
 
 Finally, the script creates a redemption request:
 

docs/fassets/firelight/status.mdx

@@ -12,9 +12,9 @@ import FirelightStatus from "!!raw-loader!/examples/developer-hub-javascript/fir
 
 ## Overview
 
-This guide demonstrates how to retrieve and display information about a Firelight vault, including vault metrics, period configuration, user balances, and withdrawal information.
+This guide demonstrates how to retrieve information about a Firelight vault, including vault metrics, period configuration, user balances, and withdrawal information.
 
-The Firelight vault is a [ERC-4626](https://eips.ethereum.org/EIPS/eip-4626) vault architecture that works with [FAssets](/fassets/overview), allowing users to deposit FXRP tokens and earn rewards through a period-based system.
+The Firelight vault is an [ERC-4626](https://eips.ethereum.org/EIPS/eip-4626) vault architecture compatible with [FAssets](/fassets/overview).
 
 ## Prerequisites
 
@@ -32,69 +32,14 @@ The following script retrieves and displays information about the Firelight vaul
 
 ## Script Breakdown
 
-### 1. Script Setup
+The script retrieves the following information:
 
-The script starts by defining the Firelight vault address and importing the required contract interfaces:
-
-- `FIRELIGHT_VAULT_ADDRESS`: The address of the Firelight vault contract on the [Flare Testnet Coston2 network](/network/overview).
-- `IFirelightVault`: The interface for interacting with the Firelight vault contract.
-  Taken from the Firelight GitHub [repository](https://github.com/firelight-protocol/firelight-core/blob/main/contracts/FirelightVault.sol).
-- `IERC20`: Standard [ERC-20](https://eips.ethereum.org/EIPS/eip-20) interface for token interactions.
-
-### 2. Asset Information
-
-The script retrieves basic asset information:
-
-- **Asset address**: The underlying token address (e.g., FXRP).
-- **Asset symbol**: The token symbol (e.g., "FXRP").
-- **Asset decimals**: The number of decimals used by the token.
-
-### 3. Vault Balances
-
-The script displays key vault metrics:
-
-- **Total assets**: The total amount of assets in the vault.
-- **Total supply**: The total number of shares minted by the vault.
-- **Exchange rate**: The current exchange rate between assets and shares, calculated as `totalAssets / totalSupply`.
-
-### 4. Period Configuration
-
-Firelight vaults operate on a [period-based logic](https://docs.firelight.finance/technical-documents#period-based-logic).
-
-The script retrieves:
-
-- **Period configurations count**: Total number of period configurations.
-- **Current period**: The active period number.
-- **Current period start**: Timestamp when the current period started.
-- **Current period end**: Timestamp when the current period ends.
-- **Next period end**: Timestamp when the next period will end.
-- **Current period config**: Configuration details including:
-  - `epoch`: The epoch number.
-  - `duration`: Duration of the period in seconds.
-  - `startingPeriod`: The period when this configuration started.
-
-### 5. User Information
-
-For the connected account, the script displays:
-
-- **User balance (shares)**: The number of vault shares owned by the user.
-- **User balance (assets)**: The equivalent asset value of the user's shares.
-- **Max deposit**: Maximum amount the user can deposit.
-- **Max mint**: Maximum number of shares the user can mint.
-- **Max withdraw**: Maximum amount of assets the user can withdraw.
-- **Max redeem**: Maximum number of shares the user can redeem.
-
-### 6. User Withdrawals and Redemptions
-
-The script checks withdrawal and redemption information for:
-
-- **Current period**: Withdrawals and redemptions requested in the current period.
-- **Previous period**: Withdrawals and redemptions from the previous period.
-
-For each period with pending withdrawals or redemptions, the script displays:
-
-- Period number.
-- Withdrawal or redemption amount in both raw units and formatted token units.
+1. **Asset Information**: Token address, symbol, and decimals.
+2. **Vault Balances**: Total assets, total supply (shares), and exchange rate.
+3. **Period Configuration**: Current period details and timing information.
+   Firelight vaults operate on a [period-based logic](https://docs.firelight.finance/technical-documents#period-based-logic).
+4. **User Information**: User balances (shares and assets), and maximum limits for deposit, mint, withdraw, and redeem.
+5. **User Withdrawals and Redemptions**: Pending withdrawals and redemptions for the current and previous periods.
 
 ## Running the Script
 
@@ -145,9 +90,7 @@ Max redeem: 61
 
 ## Summary
 
-In this guide, you learned how to retrieve status information from a Firelight vault.
-
-This information is essential for building applications that interact with Firelight vaults and for monitoring vault health and user positions.
+In this guide, you learned how to retrieve status information from a Firelight vault, including vault metrics, period configuration, user balances, and withdrawal information.
 
 :::tip[What's next]
 

docs/fassets/firelight/withdraw.mdx

@@ -45,23 +45,15 @@ The script starts by defining constants and importing the required contract inte
   Taken from the Firelight GitHub [repository](https://github.com/firelight-protocol/firelight-core/blob/main/contracts/FirelightVault.sol).
 - `IERC20`: Standard [ERC-20](https://eips.ethereum.org/EIPS/eip-20) interface for token interactions.
 
-### 2. Get Asset Information
-
-The script retrieves the underlying asset information to format amounts and calculate the withdrawal amount from the vault:
-
-- **Asset address**: The token address that the vault holds (e.g., FXRP).
-- **Asset symbol**: The token symbol for display purposes.
-- **Asset decimals**: The number of decimals used by the token.
-
-### 3. Calculate Withdrawal Amount
+### 2. Calculate Withdrawal Amount
 
 The script converts the desired withdrawal amount into the correct units:
 
 ```typescript
 const amount = WITHDRAW_AMOUNT * 10 ** assetDecimalsNum;
 ```
 
-### 4. Check Maximum Withdrawal Capacity
+### 3. Check Maximum Withdrawal Capacity
 
 Before withdrawing, the script checks if the requested amount exceeds the maximum allowed:
 
@@ -73,7 +65,7 @@ The `maxWithdraw` function returns the maximum amount of assets that the specifi
 
 If the requested amount exceeds the maximum, the script exits with an error to prevent a failed transaction.
 
-### 5. Check User Balance and Calculate Shares Needed
+### 4. Check User Balance and Calculate Shares Needed
 
 The script displays the user's current vault share balance and calculates how many shares are needed for the withdrawal:
 
@@ -87,7 +79,7 @@ The `previewWithdraw` function is part of the [ERC-4626](https://eips.ethereum.o
 The script then validates that the user has sufficient shares.
 This validation ensures the withdrawal will succeed before attempting the transaction.
 
-### 6. Create Withdrawal Request
+### 5. Create Withdrawal Request
 
 Finally, the script creates a withdrawal request:
 

examples/developer-hub-javascript/firelight-deposit.ts

@@ -28,15 +28,14 @@ async function main() {
 
   const vault = await IFirelightVault.at(FIRELIGHT_VAULT_ADDRESS);
 
-  // 2. Get Asset Information
   // Get asset address from vault
   const assetAddress = await vault.asset();
   const assetToken = await IERC20.at(assetAddress);
 
   const symbol = await assetToken.symbol();
   const assetDecimals = await assetToken.decimals();
 
-  // 3. Calculate Deposit Amount
+  // 2. Calculate Deposit Amount
   const amount = DEPOSIT_AMOUNT * 10 ** assetDecimals;
 
   console.log("=== Deposit (ERC-4626) ===");
@@ -49,7 +48,7 @@ async function main() {
     `(= ${DEPOSIT_AMOUNT} ${symbol})`,
   );
 
-  // 4. Check Maximum Deposit Capacity
+  // 3. Check Maximum Deposit Capacity
   // Check max deposit capacity
   const maxDeposit = await vault.maxDeposit(account);
   console.log("Max deposit:", maxDeposit.toString());
@@ -60,14 +59,14 @@ async function main() {
     process.exit(1);
   }
 
-  // 5. Approve Token Transfer
+  // 4. Approve Token Transfer
   // Approve + deposit.
   const approveTx = await assetToken.approve(vault.address, amount, {
     from: account,
   });
   console.log("Approve tx:", approveTx.tx);
 
-  // 6. Deposit Assets
+  // 5. Deposit Assets
   const depositTx = await vault.deposit(amount, account, { from: account });
   console.log("Deposit tx:", depositTx.tx);
 }

examples/developer-hub-javascript/firelight-mint.ts

@@ -28,7 +28,6 @@ async function main() {
 
   const vault = await FirelightVault.at(FIRELIGHT_VAULT_ADDRESS);
 
-  // 2. Get Asset Information
   // Get asset address from vault
   const assetAddress = await vault.asset();
   const assetToken = await IERC20.at(assetAddress);
@@ -37,7 +36,7 @@ async function main() {
   const assetDecimals = await assetToken.decimals();
   const assetDecimalsNum = Number(assetDecimals);
 
-  // 3. Calculate Shares to Mint
+  // 2. Calculate Shares to Mint
   const sharesToMint = SHARES_TO_MINT * 10 ** assetDecimalsNum;
 
   console.log("=== Mint vault shares (ERC-4626) ===");
@@ -50,7 +49,7 @@ async function main() {
     `(= ${SHARES_TO_MINT} share${SHARES_TO_MINT > 1 ? "s" : ""})`,
   );
 
-  // 4. Check Maximum Mint Capacity
+  // 3. Check Maximum Mint Capacity
   // Check max mint capacity
   const maxMint = await vault.maxMint(account);
   console.log("Max mint:", maxMint.toString());
@@ -61,19 +60,19 @@ async function main() {
     process.exit(1);
   }
 
-  // 5. Calculate Required Assets
+  // 4. Calculate Required Assets
   // Use previewMint to calculate how much assets we need to approve
   const assetsNeeded = await vault.previewMint(sharesToMint);
   console.log("Assets needed (from previewMint):", assetsNeeded.toString());
 
-  // 6. Approve Token Transfer
+  // 5. Approve Token Transfer
   // Approve + mint vault shares
   const approveTx = await assetToken.approve(vault.address, assetsNeeded, {
     from: account,
   });
   console.log("Approve tx:", approveTx.tx);
 
-  // 7. Mint Vault Shares
+  // 6. Mint Vault Shares
   const mintTx = await vault.mint(sharesToMint, account, { from: account });
   console.log("Mint tx:", mintTx.tx);
 }