UNPKG

@byzantine/vault-sdk

Version:

Byzantine Vault SDK for creating and managing vaults on Ethereum for restaking strategies

byzantine.finance

byzantine-finance/vault-sdk

47 lines (46 loc) • 1.95 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
import { ethers } from "ethers"; /** * Check if the vault's shares are tokenized (transferable like ERC20) * @param vaultContract - The vault contract instance * @returns True if the vault's shares are tokenized */ export declare function isTokenized(vaultContract: ethers.Contract): Promise<boolean>; /** * Get the name of the vault share token * @param vaultContract - The vault contract instance * @returns The name of the vault share token */ export declare function getSharesName(vaultContract: ethers.Contract): Promise<string>; /** * Get the symbol of the vault share token * @param vaultContract - The vault contract instance * @returns The symbol of the vault share token */ export declare function getSharesSymbol(vaultContract: ethers.Contract): Promise<string>; /** * Get the total supply of vault shares * @param vaultContract - The vault contract instance * @returns The total supply of shares */ export declare function getTotalShares(vaultContract: ethers.Contract): Promise<bigint>; /** * Get the balance of shares for a specific address * @param vaultContract - The vault contract instance * @param address - The address to check * @returns The balance of shares for the address */ export declare function getSharesBalance(vaultContract: ethers.Contract, address: string): Promise<bigint>; /** * Convert a given amount of assets to shares * @param vaultContract - The vault contract instance * @param assets - The amount of assets to convert * @returns The equivalent amount of shares */ export declare function convertToShares(vaultContract: ethers.Contract, assets: bigint): Promise<bigint>; /** * Convert a given amount of shares to assets * @param vaultContract - The vault contract instance * @param shares - The amount of shares to convert * @returns The equivalent amount of assets */ export declare function convertToAssets(vaultContract: ethers.Contract, shares: bigint): Promise<bigint>;