getVault

Description:

Returns the master data of the vault

Arguments:

Name	Type	Required	Description
vaultAddress	string	Yes	The address of the vault

Returns:

type Output = {
  apy: number
  baseApy: number
  version: number
  isErc20: boolean
  capacity: string
  createdAt: number
  feePercent: number
  isPrivate: boolean
  isGenesis: boolean
  vaultAdmin: string
  canHarvest: boolean
  totalAssets: string
  performance: number
  isMetaVault: boolean
  feeRecipient: string
  vaultAddress: string
  mevRecipient: string
  queuedShares: string
  exitingAssets: string
  whitelistCount: number
  lastFeePercent: number
  blocklistCount: number
  exitingTickets: string
  imageUrl: string | null
  isSmoothingPool: boolean
  tokenName: string | null
  whitelistManager: string
  whitelistManager: string
  blocklistManager: string
  ejectingSubVault: string
  subVaultsRegistry: string
  depositDataManager: string
  pendingMetaSubVault: string
  tokenSymbol: string | null
  displayName: string | null
  description: string | null
  lastFeeUpdateTimestamp: string
  osTokenConfig: {
    ltvPercent: string
    liqThresholdPercent: string
  }
}

Name	Description
version	Vault version
apy	Current vault apy
baseApy	The vault average weekly base APY (without extra incentives)
isErc20	Does the vault have its own ERC20 token
capacity	Maximum TVL of Vault
createdAt	Date of Creation
feePercent	Commission rate
isPrivate	Whether the vault is private
isGenesis	Is a stakewise vault
isMetaVault	Indicates whether the Vault is a meta vault and has sub vaults
queuedShares	The total number of queued shares
isBlocklist	Whether the vault has blocklist
vaultAdmin	Vault administrator address
totalAssets	TVL of Vault
feeRecipient	Vault fee address
whitelistManager	Whitelist manager
vaultAddress	Address of vault
mevRecipient	Validator fee recipient
whitelistCount	Number of addresses in the whitelist
blocklistCount	Number of addresses in the blocklist
imageUrl	Link for vault logo
blocklistManager	Blocklist manager
depositDataManager	Keys manager address
isSmoothingPool	Smoothing poll or Vault escrow
tokenName	ERC20 token name
tokenSymbol	ERC20 token symbol
displayName	Name of vault
pendingMetaSubVault	The address of the meta vault that is pending to join as a sub vault
ejectingSubVault	The address of the sub vault currently being ejected (for meta vaults)
canHarvest	Defines whether the vault can harvest new rewards
allocatorMaxBoostApy	The average max boost APY earned in this vault by the allocator
description	Description of vault
whitelist	List of authorized users for deposits
blocklist	List of blocked users for deposits
performance	Vault performance indicator (percent)
lastFeeUpdateTimestamp	The timestamp of the last fee update
lastFeePercent	The vault last fee percent
exitingAssets	The total number of assets that are exiting (in V2 vaults)
exitingTickets	The total number of tickets that are exiting (in V2 vaults)
subVaultsRegistry	The address of the SubVaultsRegistry contract (for meta vaults v4+ on Gnosis, v6+ on mainnet/hoodi)
osTokenConfig	contains the ltvPercent, which is the percentage used to calculate how much a user can mint in OsToken shares, and thresholdPercent, which is the liquidation threshold percentage used to calculate the health factor for the OsToken position

Example:

await sdk.vault.getVault({ vaultAddress: '0x...' })

test