refactor(docs): enhance Firelight vault scripts

Author: fassko

docs/fassets/firelight/01-status.mdx

@@ -35,14 +35,14 @@ The following script retrieves and displays information about the Firelight vaul
 The `main()` function executes the following steps:
 
 1. **Get the account and vault instance**: Retrieves the signer account and connects to the Firelight vault contract.
-2. **Get vault information**: Fetches vault data, including asset address, balances, and period configuration.
-3. **Get asset token information**: Retrieves the asset token's symbol and decimals.
+2. **Get vault information**: Fetches vault data, including asset address, total assets, total supply, and period configuration.
+3. **Get asset token information**: Retrieves the asset token's symbol and decimals for formatting.
 4. **Log asset information**: Displays the asset address, symbol, and decimals.
-5. **Log vault balances and exchange rate**: Shows total assets, total supply (shares), and the exchange rate.
-6. **Log period configuration**: Displays current period details and timing information.
-   Firelight vaults operate on a [period-based logic](https://docs.firelight.finance/technical-documents#period-based-logic).
-7. **Get and log user information**: Shows user balances (shares and assets), and maximum limits for deposit, mint, withdraw, and redeem.
-8. **Log user withdrawals**: Displays pending withdrawals for the current and previous periods.
+5. **Log vault balances and exchange rate**: Shows total assets, total supply, and the current exchange rate.
+6. **Log period configuration**: Displays period timing and configuration.
+Firelight vaults operate on [period-based logic](https://docs.firelight.finance/technical-documents#period-based-logic).
+7. **Get and log user information**: Shows user balances and maximum limits for deposit, mint, withdraw, and redeem.
+8. **Log user withdrawals**: Displays pending withdrawals for current and previous periods.
 
 ## Running the Script
 

docs/fassets/firelight/02-deposit.mdx

@@ -37,13 +37,13 @@ The following script demonstrates how to deposit assets into the Firelight vault
 The `main()` function executes the following steps:
 
 1. **Get the account**: Retrieves the signer account from the Hardhat environment.
-2. **Get the vault and asset token**: Connects to the Firelight vault contract and retrieves the underlying asset token.
+2. **Get the vault and asset token**: Connects to the vault contract and retrieves the underlying asset token.
 3. **Get asset info**: Fetches the asset token's symbol and decimals.
-4. **Calculate the deposit amount**: Converts the desired deposit amount into the correct units based on token decimals.
-5. **Log deposit info**: Displays the deposit details, including sender, vault, asset, and amount.
-6. **Validate the deposit**: Checks if the requested amount exceeds the maximum allowed deposit using `maxDeposit()`.
-7. **Approve tokens for transfer**: Approves the vault to spend the deposit amount using the ERC-20 `approve()` function.
-8. **Execute the deposit**: Calls the vault's `deposit()` function, which transfers assets and mints shares to the recipient.
+4. **Calculate the deposit amount**: Converts the desired amount into the correct units based on decimals.
+5. **Log deposit info**: Displays the deposit details, including sender, vault, and amount.
+6. **Validate the deposit**: Checks if the amount exceeds the maximum allowed.
+7. **Approve tokens for transfer**: Approves the vault to spend the deposit amount.
+8. **Execute the deposit**: Calls `deposit()` to transfer assets and mint shares.
 
 ## Running the Script
 

docs/fassets/firelight/03-mint.mdx

@@ -37,14 +37,14 @@ The following script demonstrates how to mint vault shares by depositing assets
 The `main()` function executes the following steps:
 
 1. **Get the account**: Retrieves the signer account from the Hardhat environment.
-2. **Get the vault and asset token**: Connects to the Firelight vault contract and retrieves the underlying asset token.
+2. **Get the vault and asset token**: Connects to the vault contract and retrieves the underlying asset token.
 3. **Get asset info**: Fetches the asset token's symbol and decimals.
-4. **Calculate the shares amount to mint**: Converts the desired number of shares into the correct units based on token decimals.
-5. **Log mint info**: Displays the mint details, including sender, vault, asset, and shares amount.
-6. **Validate the mint**: Checks if the requested amount exceeds the maximum allowed using `maxMint()`.
-7. **Calculate assets needed**: Uses `previewMint()` to determine how many assets are required for the desired shares.
-8. **Approve tokens for transfer**: Approves the vault to spend the required assets using the ERC-20 `approve()` function.
-9. **Execute the mint**: Calls the vault's `mint()` function, which transfers assets and mints shares to the recipient.
+4. **Calculate the shares amount to mint**: Converts the desired shares into the correct units based on decimals.
+5. **Log mint info**: Displays the mint details, including sender, vault, and shares.
+6. **Validate the mint**: Checks if the amount exceeds the maximum allowed.
+7. **Calculate assets needed**: Uses `previewMint()` to determine the required assets.
+8. **Approve tokens for transfer**: Approves the vault to spend the required assets.
+9. **Execute the mint**: Calls `mint()` to transfer assets and mint shares.
 
 ## Running the Script
 

docs/fassets/firelight/04-withdraw.mdx

@@ -38,13 +38,13 @@ The following script demonstrates how to create a withdrawal request from the Fi
 The `main()` function executes the following steps:
 
 1. **Get the account**: Retrieves the signer account from the Hardhat environment.
-2. **Get the vault and asset token**: Connects to the Firelight vault contract and retrieves the underlying asset token.
+2. **Get the vault and asset token**: Connects to the vault contract and retrieves the underlying asset token.
 3. **Get asset info**: Fetches the asset token's symbol and decimals.
-4. **Calculate the withdrawal amount**: Converts the desired withdrawal amount into the correct units based on token decimals.
-5. **Log withdraw info**: Displays the withdrawal details, including sender, vault, asset, and amount.
-6. **Validate the withdrawal**: Checks if the requested amount exceeds the maximum allowed using `maxWithdraw()`.
-7. **Check user balance and shares needed**: Verifies the user has sufficient shares using `balanceOf()` and `previewWithdraw()`.
-8. **Execute the withdrawal**: Calls the vault's `withdraw()` function to create a withdrawal request for the current period.
+4. **Calculate the withdrawal amount**: Converts the desired amount into the correct units based on decimals.
+5. **Log withdraw info**: Displays the withdrawal details, including sender, vault, and amount.
+6. **Validate the withdrawal**: Checks if the amount exceeds the maximum allowed.
+7. **Check user balance and shares needed**: Verifies the user has sufficient shares for the withdrawal.
+8. **Execute the withdrawal**: Calls `withdraw()` to create a withdrawal request for the current period.
 
 ## Understanding Withdrawal Process
 

docs/fassets/firelight/05-redeem.mdx

@@ -38,13 +38,13 @@ The following script demonstrates how to create a redemption request from the Fi
 The `main()` function executes the following steps:
 
 1. **Get the account**: Retrieves the signer account from the Hardhat environment.
-2. **Get the vault and asset token**: Connects to the Firelight vault contract and retrieves the underlying asset token.
+2. **Get the vault and asset token**: Connects to the vault contract and retrieves the underlying asset token.
 3. **Get asset info**: Fetches the asset token's symbol and decimals.
-4. **Calculate the shares amount to redeem**: Converts the desired number of shares into the correct units based on token decimals.
-5. **Log redeem info**: Displays the redemption details, including sender, vault, asset, and shares amount.
-6. **Validate the redeem**: Checks if the requested amount exceeds the maximum allowed using `maxRedeem()`.
-7. **Check user balance**: Verifies the user has sufficient shares using `balanceOf()`.
-8. **Execute the redemption**: Calls the vault's `redeem()` function to create a redemption request for the current period.
+4. **Calculate the shares amount to redeem**: Converts the desired shares into the correct units based on decimals.
+5. **Log redeem info**: Displays the redemption details, including sender, vault, and shares.
+6. **Validate the redeem**: Checks if the amount exceeds the maximum allowed.
+7. **Check user balance**: Verifies the user has sufficient shares.
+8. **Execute the redemption**: Calls `redeem()` to create a redemption request for the current period.
 
 ## Understanding Redemption Process
 

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

@@ -6,7 +6,8 @@
  */
 
 import { ethers } from "hardhat";
-import { IFirelightVaultInstance } from "../../typechain-types/contracts/firelight/IFirelightVault";
+import type { IFirelightVaultInstance } from "../../typechain-types/contracts/firelight/IFirelightVault";
+import type { ERC20Instance } from "../../typechain-types/@openzeppelin/contracts/token/ERC20/ERC20";
 import { bnToBigInt } from "../utils/core";
 
 export const FIRELIGHT_VAULT_ADDRESS = "0x91Bfe6A68aB035DFebb6A770FFfB748C03C0E40B";
@@ -26,17 +27,17 @@ async function getAccount() {
 async function getVaultAndAsset() {
     const vault = await IFirelightVault.at(FIRELIGHT_VAULT_ADDRESS) as IFirelightVaultInstance;
     const assetAddress = await vault.asset();
-    const assetToken = await IERC20.at(assetAddress);
+    const assetToken = await IERC20.at(assetAddress) as ERC20Instance;
     return { vault, assetAddress, assetToken };
 }
 
-async function getAssetInfo(assetToken: any) {
+async function getAssetInfo(assetToken: ERC20Instance) {
     const symbol = await assetToken.symbol();
-    const assetDecimals = await assetToken.decimals();
+    const assetDecimals = (await assetToken.decimals()).toNumber();
     return { symbol, assetDecimals };
 }
 
-function logDepositInfo(account: string, assetAddress: string, symbol: string, assetDecimals: any, amount: bigint) {
+function logDepositInfo(account: string, assetAddress: string, symbol: string, assetDecimals: number, amount: bigint) {
     console.log("=== Deposit (ERC-4626) ===");
     console.log("Sender:", account);
     console.log("Vault:", FIRELIGHT_VAULT_ADDRESS);
@@ -53,13 +54,13 @@ async function validateDeposit(vault: IFirelightVaultInstance, account: string,
     }
 }
 
-async function approveTokens(assetToken: any, vault: any, amount: bigint, account: string) {
-    const approveTx = await assetToken.approve(vault.address, amount, { from: account });
+async function approveTokens(assetToken: ERC20Instance, vault: IFirelightVaultInstance, amount: bigint, account: string) {
+    const approveTx = await assetToken.approve(vault.address, amount.toString(), { from: account });
     console.log("Approve tx:", approveTx.tx);
 }
 
-async function executeDeposit(vault: any, amount: bigint, account: string) {
-    const depositTx = await vault.deposit(amount, account, { from: account });
+async function executeDeposit(vault: IFirelightVaultInstance, amount: bigint, account: string) {
+    const depositTx = await vault.deposit(amount.toString(), account, { from: account });
     console.log("Deposit tx:", depositTx.tx);
 }
 
@@ -74,7 +75,7 @@ async function main() {
     const { symbol, assetDecimals } = await getAssetInfo(assetToken);
 
     // 4. Calculate the deposit amount
-    const depositAmount = BigInt(tokensToDeposit * (10 ** Number(assetDecimals)));
+    const depositAmount = BigInt(tokensToDeposit * (10 ** assetDecimals));
 
     // 5. Log deposit info
     logDepositInfo(account, assetAddress, symbol, assetDecimals, depositAmount);

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

@@ -7,7 +7,8 @@
 
 import { ethers } from "hardhat";
 import { bnToBigInt } from "../utils/core";
-import { IFirelightVaultInstance } from "../../typechain-types/contracts/firelight/IFirelightVault";
+import type { IFirelightVaultInstance } from "../../typechain-types/contracts/firelight/IFirelightVault";
+import type { ERC20Instance } from "../../typechain-types/@openzeppelin/contracts/token/ERC20/ERC20";
 
 export const FIRELIGHT_VAULT_ADDRESS = "0x91Bfe6A68aB035DFebb6A770FFfB748C03C0E40B";
 
@@ -26,17 +27,17 @@ async function getAccount() {
 async function getVaultAndAsset() {
     const vault = await FirelightVault.at(FIRELIGHT_VAULT_ADDRESS) as IFirelightVaultInstance;
     const assetAddress = await vault.asset();
-    const assetToken = await IERC20.at(assetAddress);
+    const assetToken = await IERC20.at(assetAddress) as ERC20Instance;
     return { vault, assetAddress, assetToken };
 }
 
-async function getAssetInfo(assetToken: any) {
+async function getAssetInfo(assetToken: ERC20Instance) {
     const symbol = await assetToken.symbol();
-    const assetDecimals = await assetToken.decimals();
+    const assetDecimals = (await assetToken.decimals()).toNumber();
     return { symbol, assetDecimals };
 }
 
-function logMintInfo(account: string, assetAddress: string, symbol: string, assetDecimals: any, sharesAmount: bigint) {
+function logMintInfo(account: string, assetAddress: string, symbol: string, assetDecimals: number, sharesAmount: bigint) {
     console.log("=== Mint vault shares (ERC-4626) ===");
     console.log("Sender:", account);
     console.log("Vault:", FIRELIGHT_VAULT_ADDRESS);
@@ -59,8 +60,8 @@ async function calculateAssetsNeeded(vault: IFirelightVaultInstance, sharesAmoun
     return assetsNeeded;
 }
 
-async function approveTokens(assetToken: any, vault: any, amount: bigint, account: string) {
-    const approveTx = await assetToken.approve(vault.address, amount, { from: account });
+async function approveTokens(assetToken: ERC20Instance, vault: IFirelightVaultInstance, amount: bigint, account: string) {
+    const approveTx = await assetToken.approve(vault.address, amount.toString(), { from: account });
     console.log("Approve tx:", approveTx.tx);
 }
 
@@ -80,7 +81,7 @@ async function main() {
     const { symbol, assetDecimals } = await getAssetInfo(assetToken);
 
     // 4. Calculate the shares amount to mint
-    const sharesAmount = BigInt(sharesToMint * (10 ** Number(assetDecimals)));
+    const sharesAmount = BigInt(sharesToMint * (10 ** assetDecimals));
 
     // 5. Log mint info
     logMintInfo(account, assetAddress, symbol, assetDecimals, sharesAmount);

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

@@ -6,7 +6,8 @@
  */
 
 import { ethers } from "hardhat";
-import { IFirelightVaultInstance } from "../../typechain-types/contracts/firelight/IFirelightVault";
+import type { IFirelightVaultInstance } from "../../typechain-types/contracts/firelight/IFirelightVault";
+import type { ERC20Instance } from "../../typechain-types/@openzeppelin/contracts/token/ERC20/ERC20";
 import { bnToBigInt } from "../utils/core";
 
 export const FIRELIGHT_VAULT_ADDRESS = "0x91Bfe6A68aB035DFebb6A770FFfB748C03C0E40B";
@@ -26,17 +27,17 @@ async function getAccount() {
 async function getVaultAndAsset() {
     const vault = await IFirelightVault.at(FIRELIGHT_VAULT_ADDRESS) as IFirelightVaultInstance;
     const assetAddress = await vault.asset();
-    const assetToken = await IERC20.at(assetAddress);
+    const assetToken = await IERC20.at(assetAddress) as ERC20Instance;
     return { vault, assetAddress, assetToken };
 }
 
-async function getAssetInfo(assetToken: any) {
+async function getAssetInfo(assetToken: ERC20Instance) {
     const symbol = await assetToken.symbol();
-    const assetDecimals = await assetToken.decimals();
+    const assetDecimals = (await assetToken.decimals()).toNumber();
     return { symbol, assetDecimals };
 }
 
-function logRedeemInfo(account: string, assetAddress: string, symbol: string, assetDecimals: any, sharesAmount: bigint) {
+function logRedeemInfo(account: string, assetAddress: string, symbol: string, assetDecimals: number, sharesAmount: bigint) {
     console.log("=== Redeem (ERC-4626) ===");
     console.log("Sender:", account);
     console.log("Vault:", FIRELIGHT_VAULT_ADDRESS);
@@ -53,9 +54,9 @@ async function validateRedeem(vault: IFirelightVaultInstance, account: string, s
     }
 }
 
-async function checkUserBalance(vault: IFirelightVaultInstance, account: string, sharesAmount: bigint, assetDecimals: bigint) {
+async function checkUserBalance(vault: IFirelightVaultInstance, account: string, sharesAmount: bigint, assetDecimals: number) {
     const userBalance = await vault.balanceOf(account);
-    const formattedUserBalance = (Number(userBalance.toString()) / Math.pow(10, Number(assetDecimals))).toFixed(Number(assetDecimals));
+    const formattedUserBalance = (Number(userBalance.toString()) / Math.pow(10, assetDecimals)).toFixed(assetDecimals);
     console.log("User balance (shares):", userBalance.toString(), `(= ${formattedUserBalance} shares)`);
     if (bnToBigInt(userBalance) < sharesAmount) {
         console.error(`Insufficient balance. Need ${sharesAmount.toString()} shares, have ${userBalance.toString()}`);
@@ -79,7 +80,7 @@ async function main() {
     const { symbol, assetDecimals } = await getAssetInfo(assetToken);
 
     // 4. Calculate the shares amount to redeem
-    const sharesAmount = BigInt(sharesToRedeem * (10 ** Number(assetDecimals)));
+    const sharesAmount = BigInt(sharesToRedeem * (10 ** assetDecimals));
 
     // 5. Log redeem info
     logRedeemInfo(account, assetAddress, symbol, assetDecimals, sharesAmount);