# Get Firelight Vault Status

> Learn how to get Firelight vault status

> For the complete documentation index, see [llms.txt](/llms.txt). Markdown versions of documentation pages are available by appending `.md` to the page URL.

Source: https://dev.flare.network/fxrp/firelight/status

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 an [ERC-4626](https://eips.ethereum.org/EIPS/eip-4626) vault architecture compatible with [FAssets](/fassets/overview).

## Prerequisites[​](#prerequisites "Direct link to Prerequisites")

-   [Flare Hardhat Starter Kit](/network/guides/hardhat-foundry-starter-kit)
-   [Flare Network Periphery Contracts](https://www.npmjs.com/package/@flarenetwork/flare-periphery-contracts)
-   Understanding of [FAssets](/fassets/overview)

## Firelight Vault Status Script[​](#firelight-vault-status-script "Direct link to Firelight Vault Status Script")

The following script retrieves and displays information about the Firelight vault:

scripts/firelight/status.ts

```
/** * FirelightVault Status Script * * This script displays information about a FirelightVault contract. * It shows vault metrics, period configuration, user balances, and withdrawal information etc. */import { ethers } from "hardhat";import { formatTimestamp, bnToBigInt } from "../utils/core";import type { IFirelightVaultInstance } from "../../typechain-types/contracts/firelight/IFirelightVault";import type { ERC20Instance } from "../../typechain-types/@openzeppelin/contracts/token/ERC20/ERC20";interface PeriodConfig {  epoch: bigint;  duration: bigint;  startingPeriod: bigint;}interface UserInfo {  userBalance: bigint;  userMaxDeposit: bigint;  userMaxMint: bigint;  userMaxWithdraw: bigint;  userMaxRedeem: bigint;  userBalanceAssets: bigint;}interface VaultInfo {  asset: string;  totalAssets: bigint;  totalSupply: bigint;  currentPeriod: bigint;  currentPeriodStart: bigint;  currentPeriodEnd: bigint;  nextPeriodEnd: bigint;  pcLen: bigint;  currentPeriodConfig: PeriodConfig;}export const FIRELIGHT_VAULT_ADDRESS =  "0x91Bfe6A68aB035DFebb6A770FFfB748C03C0E40B";export const IFirelightVault = artifacts.require("IFirelightVault");// @ts-expect-error - Type definitions issue, but works at runtimeconst IERC20 = artifacts.require(  "@openzeppelin/contracts/token/ERC20/ERC20.sol:ERC20",);async function getAccount() {  const [signer] = await ethers.getSigners();  return { signer, account: signer.address };}async function getVault() {  return (await IFirelightVault.at(    FIRELIGHT_VAULT_ADDRESS,  )) as IFirelightVaultInstance;}async function getVaultInfo(  vault: IFirelightVaultInstance,): Promise<VaultInfo> {  const asset = await vault.asset();  const totalAssets = bnToBigInt(await vault.totalAssets());  const totalSupply = bnToBigInt(await vault.totalSupply());  const currentPeriod = bnToBigInt(await vault.currentPeriod());  const currentPeriodStart = bnToBigInt(await vault.currentPeriodStart());  const currentPeriodEnd = bnToBigInt(await vault.currentPeriodEnd());  const nextPeriodEnd = bnToBigInt(await vault.nextPeriodEnd());  const pcLen = bnToBigInt(await vault.periodConfigurationsLength());  const rawPeriodConfig = await vault.currentPeriodConfiguration();  const currentPeriodConfig: PeriodConfig = {    epoch: bnToBigInt(rawPeriodConfig.epoch),    duration: bnToBigInt(rawPeriodConfig.duration),    startingPeriod: bnToBigInt(rawPeriodConfig.startingPeriod),  };  return {    asset,    totalAssets,    totalSupply,    currentPeriod,    currentPeriodStart,    currentPeriodEnd,    nextPeriodEnd,    pcLen,    currentPeriodConfig,  };}async function getAssetInfo(assetToken: ERC20Instance) {  const symbol = await assetToken.symbol();  const assetDecimals = (await assetToken.decimals()).toNumber();  return { symbol, assetDecimals };}function logAssetInfo(  asset: string,  assetSymbol: string,  assetDecimals: number,) {  console.log("\n=== Asset ===");  console.log("Asset address:", asset);  console.log("Asset symbol:", assetSymbol);  console.log("Asset decimals:", assetDecimals.toString());}function logVaultBalances(  totalAssets: bigint,  totalSupply: bigint,  assetSymbol: string,  assetDecimals: number,) {  console.log("\n=== Vault Balances ===");  const formattedTotalAssets = (    Number(totalAssets) / Math.pow(10, assetDecimals)  ).toFixed(assetDecimals);  const formattedTotalSupply = (    Number(totalSupply) / Math.pow(10, assetDecimals)  ).toFixed(assetDecimals);  console.log(    "Total assets (excl. pending withdrawals):",    totalAssets.toString(),    `(${formattedTotalAssets} ${assetSymbol})`,  );  console.log(    "Total supply (shares):",    totalSupply.toString(),    `(${formattedTotalSupply} shares)`,  );  // Calculate exchange rate (assets per share)  if (totalSupply !== 0n) {    // Calculate: (totalAssets * 10^assetDecimals) / totalSupply for precision    const precision = BigInt(10) ** BigInt(assetDecimals);    const rate = (totalAssets * precision) / totalSupply;    const formattedRate = (Number(rate) / Math.pow(10, assetDecimals)).toFixed(      assetDecimals,    );    console.log("Exchange rate:", formattedRate, `${assetSymbol}/share`);  } else {    console.log("Exchange rate: N/A (no shares minted)");  }}function logPeriodConfiguration(  pcLen: bigint,  currentPeriod: bigint,  currentPeriodStart: bigint,  currentPeriodEnd: bigint,  nextPeriodEnd: bigint,  currentPeriodConfig: PeriodConfig,) {  console.log("\n=== Period Configuration ===");  console.log("Period configurations count:", pcLen.toString());  console.log("Current period:", currentPeriod.toString());  console.log("Current period start:", formatTimestamp(currentPeriodStart));  console.log("Current period end:", formatTimestamp(currentPeriodEnd));  console.log("Next period end:", formatTimestamp(nextPeriodEnd));  console.log("Current period config:", {    epoch: currentPeriodConfig.epoch.toString(),    duration: currentPeriodConfig.duration.toString(),    startingPeriod: currentPeriodConfig.startingPeriod.toString(),  });}async function getUserInfo(vault: IFirelightVaultInstance, account: string) {  const userBalanceBN = await vault.balanceOf(account);  const userBalance = bnToBigInt(userBalanceBN);  const userMaxDeposit = bnToBigInt(await vault.maxDeposit(account));  const userMaxMint = bnToBigInt(await vault.maxMint(account));  const userMaxWithdraw = bnToBigInt(await vault.maxWithdraw(account));  const userMaxRedeem = bnToBigInt(await vault.maxRedeem(account));  const userBalanceAssets = bnToBigInt(    await vault.convertToAssets(userBalanceBN),  );  return {    userBalance,    userMaxDeposit,    userMaxMint,    userMaxWithdraw,    userMaxRedeem,    userBalanceAssets,  };}function logUserInfo(  account: string,  userInfo: UserInfo,  assetSymbol: string,  assetDecimals: number,) {  console.log("\n=== User Info ===");  console.log("Account:", account);  const formattedUserBalance = (    Number(userInfo.userBalance.toString()) / Math.pow(10, assetDecimals)  ).toFixed(assetDecimals);  const formattedUserBalanceAssets = (    Number(userInfo.userBalanceAssets.toString()) / Math.pow(10, assetDecimals)  ).toFixed(assetDecimals);  console.log(    "User balance (shares):",    userInfo.userBalance.toString(),    `(${formattedUserBalance} shares)`,  );  console.log(    "User balance (assets):",    userInfo.userBalanceAssets.toString(),    `(${formattedUserBalanceAssets} ${assetSymbol})`,  );  console.log("Max deposit:", userInfo.userMaxDeposit.toString());  console.log("Max mint:", userInfo.userMaxMint.toString());  console.log("Max withdraw:", userInfo.userMaxWithdraw.toString());  console.log("Max redeem:", userInfo.userMaxRedeem.toString());}async function logUserWithdrawals(  vault: IFirelightVaultInstance,  account: string,  currentPeriod: bigint,  assetSymbol: string,  assetDecimals: number,) {  console.log("\n=== User Withdrawals ===");  const periodsToCheck = [currentPeriod];  if (currentPeriod !== 0n) {    periodsToCheck.push(currentPeriod - 1n);  }  for (const period of periodsToCheck) {    try {      const withdrawals = bnToBigInt(        await vault.withdrawalsOf(period.toString(), account, {          from: account,        }),      );      if (withdrawals !== 0n) {        const formattedWithdrawals = (          Number(withdrawals.toString()) / Math.pow(10, assetDecimals)        ).toFixed(assetDecimals);        console.log(          `Period ${period.toString()}: ${withdrawals.toString()} (${formattedWithdrawals} ${assetSymbol})`,        );      }    } catch {      // Silently skip if period doesn't exist or other error    }  }}async function main() {  // 1. Get the account and vault instance  const { account } = await getAccount();  const vault = await getVault();  // 2. Get vault information (asset, balances, period config)  const vaultInfo = await getVaultInfo(vault);  // 3. Get asset token information (symbol, decimals)  const assetToken = (await IERC20.at(vaultInfo.asset)) as ERC20Instance;  const { symbol: assetSymbol, assetDecimals } = await getAssetInfo(assetToken);  // 4. Log asset information  logAssetInfo(vaultInfo.asset, assetSymbol, assetDecimals);  // 5. Log vault balances and exchange rate  logVaultBalances(    vaultInfo.totalAssets,    vaultInfo.totalSupply,    assetSymbol,    assetDecimals,  );  // 6. Log period configuration  logPeriodConfiguration(    vaultInfo.pcLen,    vaultInfo.currentPeriod,    vaultInfo.currentPeriodStart,    vaultInfo.currentPeriodEnd,    vaultInfo.nextPeriodEnd,    vaultInfo.currentPeriodConfig,  );  // 7. Get and log user information (balances and limits)  const userInfo = await getUserInfo(vault, account);  logUserInfo(account, userInfo, assetSymbol, assetDecimals);  // 8. Log user withdrawals for current and previous periods  await logUserWithdrawals(    vault,    account,    vaultInfo.currentPeriod,    assetSymbol,    assetDecimals,  );}main().catch((error) => {  console.error(error);  process.exitCode = 1;});
```

## Script Breakdown[​](#script-breakdown "Direct link to Script Breakdown")

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, 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, 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[​](#running-the-script "Direct link to Running the Script")

To run the Firelight vault status script:

1.  Ensure you have the [Flare Hardhat Starter Kit](/network/guides/hardhat-foundry-starter-kit) set up.
2.  Update the `FIRELIGHT_VAULT_ADDRESS` constant with the correct vault address for your network.
3.  Run the script using Hardhat:

```
yarn hardhat run scripts/firelight/status.ts --network coston2
```

## Output[​](#output "Direct link to Output")

The script outputs the following information:

```
=== Asset ===Asset address: 0x0b6A3645c240605887a5532109323A3E12273dc7Asset symbol: FTestXRPAsset decimals: 6=== Vault Balances ===Total assets (excl. pending withdrawals): 7990061 (7.990061 FTestXRP)Total supply (shares): 7990061 (7.990061 shares)Exchange rate: 1.000000 FTestXRP/share=== Period Configuration ===Period configurations count: 1Current period: 108Current period start: 1766966751 (2025-12-29T00:05:51.000Z)Current period end: 1767053151 (2025-12-30T00:05:51.000Z)Next period end: 1767139551 (2025-12-31T00:05:51.000Z)Current period config: { epoch: '1757635551', duration: '86400', startingPeriod: '0' }=== User Info ===Account: 0x0d09ff7630588E05E2449aBD3dDD1D8d146bc5c2User balance (shares): 61 (0.000061 shares)User balance (assets): 61 (0.000061 FTestXRP)Max deposit: 115792089237316195423570985008687907853269984665640564039457584007913129639935Max mint: 115792089237316195423570985008687907853269984665640564039457584007913129639935Max withdraw: 61Max redeem: 61=== User Withdrawals ===
```

## Summary[​](#summary "Direct link to Summary")

In this guide, you learned how to retrieve status information from a Firelight vault, including vault metrics, period configuration, user balances, and withdrawal information.

What's next

To continue your Firelight development journey, you can:

-   Learn how to [deposit assets into a Firelight vault](/fxrp/firelight/deposit).
-   Learn how to [mint Firelight vault shares](/fxrp/firelight/mint) by specifying the number of shares.
-   Learn how to [withdraw assets from a Firelight vault](/fxrp/firelight/withdraw).
-   Learn how to [redeem assets from a Firelight vault](/fxrp/firelight/redeem).
-   Explore the [FAssets system overview](/fassets/overview) to understand the broader ecosystem.