Skip to main content

getStakeBalance

Description:​

Getting user's balance in the vault

Arguments:​

NameTypeRequiredDescription
userAddressstringYesThe user address
vaultAddressstringYesThe address of the vault

Returns:​

type Output = {
assets: bigint
totalEarnedAssets: bigint
totalStakeEarnedAssets: bigint
totalBoostEarnedAssets: bigint
}
NameDescription
assetsBalance in ETH
totalEarnedAssetsTotal earned rewards
totalStakeEarnedAssetsTotal earned assets from staking
totalBoostEarnedAssetsTotal earned assets from boost

Example:​

await sdk.vault.getStakeBalance({
userAddress: '0x...',
vaultAddress: '0x...',
})