import BN from 'bn.js'; import { Address, AccountMeta, Instruction, ProgramDerivedAddress, Rpc, Slot, SolanaRpcApi, TransactionSigner } from '@solana/kit'; import { AllOracleAccounts, CdnResources, KaminoMarket, KaminoReserve, KVaultGlobalConfig, Reserve } from '../lib'; import { UpdateReserveWhitelistModeKind, VaultConfigFieldKind } from '../@codegen/kvault/types'; import { ReserveWhitelistEntry, VaultState } from '../@codegen/kvault/accounts'; import Decimal from 'decimal.js'; import { ReserveWithAddress } from './reserve'; import { AcceptVaultOwnershipIxs, AllDepositAccounts, AllWithdrawAccounts, APYs, CreateVaultFarm, DepositIxs, DisinvestAllReservesIxs, InitVaultIxs, ReserveAllocationOverview, SyncVaultLUTIxs, UpdateReserveAllocationIxs, UpdateVaultConfigIxs, UserSharesForVault, VaultComputedAllocation, VaultReleaseCheckResult, WithdrawAndBlockReserveIxs, WithdrawIxs } from './vault_types'; import { FarmIncentives, FarmState } from '@kamino-finance/farms-sdk/dist'; import { Farms } from '@kamino-finance/farms-sdk'; export declare const kaminoVaultId: Address<"KvauGMspG5k6rtzrqqn7WNn3oZdyKqLKwK2XWQ8FLjd">; export declare const kaminoVaultStagingId: Address<"stKvQfwRsQiKnLtMNVLHKS3exFJmZFsgfzBPWHECUYK">; export declare const METADATA_SEED = "metadata"; export declare const METADATA_PROGRAM_ID: Address; export declare const INITIAL_DEPOSIT_LAMPORTS = 1000; export declare const DEFAULT_CU_PER_TX = 1400000; /** * KaminoVaultClient is a class that provides a high-level interface to interact with the Kamino Vault program. */ export declare class KaminoVaultClient { private readonly _rpc; private readonly _kaminoVaultProgramId; private readonly _kaminoLendProgramId; private readonly _farmsProgramId?; recentSlotDurationMs: number; private _cdnResources?; private _cdnResourcesPromise?; constructor(rpc: Rpc, recentSlotDurationMs: number, kaminoVaultprogramId?: Address, kaminoLendProgramId?: Address, cdnResources?: CdnResources, farmsProgramId?: Address); getConnection(): Rpc; getProgramID(): Address; getRpc(): Rpc; hasFarm(): void; private loadCdnResourcesOnce; /** * Check if a vault has all the needed criteria to be released * - owner is multisig * - vaultFarm is set and it is a farm that is valid * - FLC farm is set and it is a farm that is valid (warning if not) * - check shares token metadata is set * - Check min deposit is not 0 * - Check the vault has at least one allocation * - Check there are allocations with weight > 0 and cap > 0 (and give warning for each allocation which doesn't have cap == u64::MAX) * - Check CDN (using loadCdnResourcesOnce) that the vaultAdmin exists in the list of admins and has a description * @param vault - the vault to check * @returns - a promise that resolves to the release status of the vault */ checkVaultReleaseStatus(vault: KaminoVault): Promise; /** * Prints a vault in a human readable form * @param vaultPubkey - the address of the vault * @param [vaultState] - optional parameter to pass the vault state directly; this will save a network call * @param [slot] - optional slot to use for calculations; if not provided, the latest confirmed slot will be fetched * @returns - void; prints the vault to the console */ printVault(vaultPubkey: Address, vaultState?: VaultState, slot?: Slot): Promise; /** * This method initializes the kvault global config (one off, needs to be signed by program owner) * @param admin - the admin of the kvault program * @returns - an instruction to initialize the kvault global config */ initKvaultGlobalConfigIx(admin: TransactionSigner): Promise | import("@solana/kit").AccountLookupMeta)[]>>; /** * This method updates the kvault global config * @param mode - the mode to update the global config with * @returns - an instruction to update the global config */ updateGlobalConfigIx(mode: string, value: string): Promise | import("@solana/kit").AccountLookupMeta)[]>>; /** * This method accepts the ownership of the global config * @param admin - the admin of the transaction * @returns - an instruction to accept the ownership of the global config */ acceptGlobalConfigOwnershipIx(admin: TransactionSigner): Promise | import("@solana/kit").AccountLookupMeta)[]>>; /** * This method will create a vault with a given config. The config can be changed later on, but it is recommended to set it up correctly from the start * @param vaultConfig - the config object used to create a vault * @param [useDevnetFarms] - whether to use devnet farms * @param [slot] - optional slot to use for lookup table creation; if not provided, the latest finalized slot will be fetched * @returns vault: the keypair of the vault, used to sign the initialization transaction; initVaultIxs: a struct with ixs to initialize the vault and its lookup table + populateLUTIxs, a list to populate the lookup table which has to be executed in a separate transaction */ createVaultIxs(vaultConfig: KaminoVaultConfig, useDevnetFarms?: boolean, slot?: Slot): Promise<{ vault: TransactionSigner; lut: Address; initVaultIxs: InitVaultIxs; }>; /** * This method creates a farm for a vault * @param signer - the signer of the transaction * @param vaultSharesMint - the mint of the vault shares * @param vaultAddress - the address of the vault (it doesn't need to be already initialized) * @returns a struct with the farm, the setup farm ixs and the update farm ixs */ createVaultFarm(signer: TransactionSigner, vaultAddress: Address, vaultSharesMint: Address, useDevnetFarms?: boolean): Promise; /** * This method creates an instruction to set the shares metadata for a vault * @param rpc * @param vaultAdmin * @param vault - the vault to set the shares metadata for * @param sharesMint * @param baseVaultAuthority * @param tokenName - the name of the token in the vault (symbol; e.g. "USDC" which becomes "kVUSDC") * @param extraName - the extra string appended to the prefix("Kamino Vault USDC ") * @returns - an instruction to set the shares metadata for the vault */ getSetSharesMetadataIx(rpc: Rpc, vaultAdmin: TransactionSigner, vault: Address, sharesMint: Address, baseVaultAuthority: Address, tokenName: string, extraName: string, metadataProgramId?: Address, kvaultProgramId?: Address): Promise | import("@solana/kit").AccountLookupMeta)[]>>; /** * This method updates the vault reserve allocation config for an exiting vault reserve, or adds a new reserve to the vault if it does not exist. * @param vault - vault to be updated * @param reserveAllocationConfig - new reserve allocation config * @param [vaultAdminAuthority] - vault admin - a noop vaultAdminAuthority is provided when absent for multisigs * @returns - a struct with an instruction to update the reserve allocation and an optional list of instructions to update the lookup table for the allocation changes */ updateReserveAllocationIxs(vault: KaminoVault, reserveAllocationConfig: ReserveAllocationConfig, vaultAdminAuthority?: TransactionSigner): Promise; /** * This method updates the unallocated weight and cap of a vault (both are optional, if not provided the current values will be used) * @param vault - the vault to update the unallocated weight and cap for * @param [vaultAdminAuthority] - vault admin - a noop vaultAdminAuthority is provided when absent for multisigs * @param [unallocatedWeight] - the new unallocated weight to set. If not provided, the current unallocated weight will be used * @param [unallocatedCap] - the new unallocated cap to set. If not provided, the current unallocated cap will be used * @returns - a list of instructions to update the unallocated weight and cap */ updateVaultUnallocatedWeightAndCapIxs(vault: KaminoVault, vaultAdminAuthority?: TransactionSigner, unallocatedWeight?: BN, unallocatedCap?: BN): Promise | import("@solana/kit").AccountLookupMeta)[]>[]>; /** * This method withdraws all the funds from a reserve and blocks it from being invested by setting its weight and ctoken allocation to 0 * @param vault - the vault to withdraw the funds from * @param reserve - the reserve to withdraw the funds from * @param [vaultAdminAuthority] - vault admin - a noop vaultAdminAuthority is provided when absent for multisigs * @returns - a struct with an instruction to update the reserve allocation and an optional list of instructions to update the lookup table for the allocation changes */ withdrawEverythingAndBlockInvestReserve(vault: KaminoVault, reserve: Address, vaultAdminAuthority?: TransactionSigner): Promise; /** * This method withdraws all the funds from all the reserves and blocks them from being invested by setting their weight and ctoken allocation to 0 * @param vault - the vault to withdraw the invested funds from * @param [vaultReservesMap] - optional parameter to pass a map of the vault reserves. If not provided, the reserves will be loaded from the vault * @param [payer] - optional parameter to pass a different payer for the transaction. If not provided, the admin of the vault will be used; this is the payer for the invest ixs and it should have an ATA and some lamports (2x no_of_reserves) of the token vault * @returns - a struct with an instruction to update the reserve allocations (set weight and ctoken allocation to 0) and an a list of instructions to disinvest the funds in the reserves */ withdrawEverythingFromAllReservesAndBlockInvest(vault: KaminoVault, vaultReservesMap?: Map, payer?: TransactionSigner): Promise; /** * This method disinvests all the funds from all the reserves and set their weight to 0; for vaults that are managed by external bot/crank, the bot can change the weight and invest in the reserves again * @param vault - the vault to disinvest the invested funds from * @param [vaultReservesMap] - optional parameter to pass a map of the vault reserves. If not provided, the reserves will be loaded from the vault * @param [payer] - optional parameter to pass a different payer for the transaction. If not provided, the admin of the vault will be used; this is the payer for the invest ixs and it should have an ATA and some lamports (2x no_of_reserves) of the token vault * @returns - a struct with an instruction to update the reserve allocations to 0 weight and a list of instructions to disinvest the funds in the reserves */ disinvestAllReservesIxs(vault: KaminoVault, vaultReservesMap?: Map, payer?: TransactionSigner): Promise; /** * This method removes a reserve from the vault allocation strategy if already part of the allocation strategy * @param vault - vault to remove the reserve from * @param reserve - reserve to remove from the vault allocation strategy * @param [vaultAdminAuthority] - vault admin - a noop vaultAdminAuthority is provided when absent for multisigs * @returns - an instruction to remove the reserve from the vault allocation strategy or undefined if the reserve is not part of the allocation strategy */ removeReserveFromAllocationIx(vault: KaminoVault, reserve: Address, vaultAdminAuthority?: TransactionSigner): Promise; /** * Update a field of the vault. If the field is a pubkey it will return an extra instruction to add that account into the lookup table * @param vault the vault to update * @param mode the field to update (based on VaultConfigFieldKind enum) * @param value the value to update the field with * @param [adminAuthority] the signer of the transaction. Optional. If not provided the admin of the vault will be used. It should be used when changing the admin of the vault if we want to build or batch multiple ixs in the same tx. * The global admin should be passed in when wanting to change the AllowAllocationsInWhitelistedReservesOnly or AllowInvestInWhitelistedReservesOnly fields to false * @param [lutIxsSigner] the signer of the transaction to be used for the lookup table instructions. Optional. If not provided the admin of the vault will be used. It should be used when changing the admin of the vault if we want to build or batch multiple ixs in the same tx * @param [skipLutUpdate] if true, the lookup table instructions will not be included in the returned instructions * @param errorOnOverride throw error if vault already has a farm * @returns a struct that contains the instruction to update the field and an optional list of instructions to update the lookup table */ updateVaultConfigIxs(vault: KaminoVault, mode: VaultConfigFieldKind, value: string, adminAuthority?: TransactionSigner, lutIxsSigner?: TransactionSigner, skipLutUpdate?: boolean, errorOnOverride?: boolean): Promise; /** * Update the vault performance fee (in bps). * @param vault - vault to update * @param feeBps - performance fee in basis points * @param [vaultAdminAuthority] - vault admin - a noop vaultAdminAuthority is provided when absent for multisigs * @returns - a struct containing the update instruction and optional LUT updates */ updateVaultPerfFeeIxs(vault: KaminoVault, feeBps: BN | number | string, vaultAdminAuthority?: TransactionSigner): Promise; /** * Update the vault management fee (in bps). * @param vault - vault to update * @param feeBps - management fee in basis points * @param [vaultAdminAuthority] - vault admin - a noop vaultAdminAuthority is provided when absent for multisigs * @returns - a struct containing the update instruction and optional LUT updates */ updateVaultMgmtFeeIxs(vault: KaminoVault, feeBps: BN | number | string, vaultAdminAuthority?: TransactionSigner): Promise; /** * Update the pending admin for the vault (step 1/2 of the ownership transfer). * @param vault - vault to update * @param newAdmin - new pending admin pubkey * @param [vaultAdminAuthority] - vault admin - a noop vaultAdminAuthority is provided when absent for multisigs * @param [lutIxsSigner] - signer for LUT updates when adding the new admin * @param [skipLutUpdate] - if true, the LUT update instructions are not returned * @returns - a struct containing the update instruction and optional LUT updates */ updateVaultPendingAdminIxs(vault: KaminoVault, newAdmin: Address, vaultAdminAuthority?: TransactionSigner, lutIxsSigner?: TransactionSigner, skipLutUpdate?: boolean): Promise; /** * Update the vault name. * @param vault - vault to update * @param name - new vault name * @param [vaultAdminAuthority] - vault admin - a noop vaultAdminAuthority is provided when absent for multisigs * @returns - a struct containing the update instruction and optional LUT updates */ updateVaultNameIxs(vault: KaminoVault, name: string, vaultAdminAuthority?: TransactionSigner): Promise; /** * Update the vault lookup table address. * @param vault - vault to update * @param lookupTable - new LUT address * @param [vaultAdminAuthority] - vault admin - a noop vaultAdminAuthority is provided when absent for multisigs * @returns - a struct containing the update instruction and optional LUT updates */ updateVaultLookupTableIxs(vault: KaminoVault, lookupTable: Address, vaultAdminAuthority?: TransactionSigner): Promise; /** * Update the vault allocation admin. * @param vault - vault to update * @param allocationAdmin - new allocation admin pubkey * @param [vaultAdminAuthority] - vault admin - a noop vaultAdminAuthority is provided when absent for multisigs * @returns - a struct containing the update instruction and optional LUT updates */ updateVaultAllocationAdminIxs(vault: KaminoVault, allocationAdmin: Address, vaultAdminAuthority?: TransactionSigner): Promise; /** * Update the vault unallocated weight. * @param vault - vault to update * @param unallocatedWeight - new unallocated weight * @param [vaultAdminAuthority] - vault admin - a noop vaultAdminAuthority is provided when absent for multisigs * @returns - a struct containing the update instruction and optional LUT updates */ updateVaultUnallocatedWeightIxs(vault: KaminoVault, unallocatedWeight: BN | number | string, vaultAdminAuthority?: TransactionSigner): Promise; /** * Update the vault unallocated tokens cap. * @param vault - vault to update * @param unallocatedTokensCap - new unallocated tokens cap * @param [vaultAdminAuthority] - vault admin - a noop vaultAdminAuthority is provided when absent for multisigs * @returns - a struct containing the update instruction and optional LUT updates */ updateVaultUnallocatedTokensCapIxs(vault: KaminoVault, unallocatedTokensCap: BN | number | string, vaultAdminAuthority?: TransactionSigner): Promise; /** * Update the vault farm address. * @param vault - vault to update * @param farm - farm address * @param [errorOnOverride] - if true, it will throw if the vault already has a farm * @param [vaultAdminAuthority] - vault admin - a noop vaultAdminAuthority is provided when absent for multisigs * @param [lutIxsSigner] - signer for LUT updates when adding the farm * @param [skipLutUpdate] - if true, the LUT update instructions are not returned * @returns - a struct containing the update instruction and optional LUT updates */ updateVaultFarmIxs(vault: KaminoVault, farm: Address, errorOnOverride?: boolean, vaultAdminAuthority?: TransactionSigner, lutIxsSigner?: TransactionSigner, skipLutUpdate?: boolean): Promise; /** * Update the first loss capital farm address. * @param vault - vault to update * @param farm - farm address * @param [vaultAdminAuthority] - vault admin - a noop vaultAdminAuthority is provided when absent for multisigs * @returns - a struct containing the update instruction and optional LUT updates */ updateVaultFirstLossCapitalFarmIxs(vault: KaminoVault, farm: Address, vaultAdminAuthority?: TransactionSigner): Promise; /** * Update the vault min deposit amount (in lamports). * @param vault - vault to update * @param minDepositAmount - new minimum deposit amount * @param [vaultAdminAuthority] - vault admin - a noop vaultAdminAuthority is provided when absent for multisigs * @returns - a struct containing the update instruction and optional LUT updates */ updateVaultMinDepositAmountIxs(vault: KaminoVault, minDepositAmount: BN | number | string, vaultAdminAuthority?: TransactionSigner): Promise; /** * Update the vault min withdraw amount (in lamports). * @param vault - vault to update * @param minWithdrawAmount - new minimum withdraw amount * @param [vaultAdminAuthority] - vault admin - a noop vaultAdminAuthority is provided when absent for multisigs * @returns - a struct containing the update instruction and optional LUT updates */ updateVaultMinWithdrawAmountIxs(vault: KaminoVault, minWithdrawAmount: BN | number | string, vaultAdminAuthority?: TransactionSigner): Promise; /** * Update the vault min invest amount (in lamports). * @param vault - vault to update * @param minInvestAmount - new minimum invest amount * @param [vaultAdminAuthority] - vault admin - a noop vaultAdminAuthority is provided when absent for multisigs * @returns - a struct containing the update instruction and optional LUT updates */ updateVaultMinInvestAmountIxs(vault: KaminoVault, minInvestAmount: BN | number | string, vaultAdminAuthority?: TransactionSigner): Promise; /** * Update the vault min invest delay (in slots). * @param vault - vault to update * @param minInvestDelaySlots - new minimum invest delay in slots * @param [vaultAdminAuthority] - vault admin - a noop vaultAdminAuthority is provided when absent for multisigs * @returns - a struct containing the update instruction and optional LUT updates */ updateVaultMinInvestDelaySlotsIxs(vault: KaminoVault, minInvestDelaySlots: BN | number | string, vaultAdminAuthority?: TransactionSigner): Promise; /** * Update the vault crank fund fee per reserve (in lamports). * @param vault - vault to update * @param crankFundFeePerReserve - new fee per reserve * @param [vaultAdminAuthority] - vault admin - a noop vaultAdminAuthority is provided when absent for multisigs * @returns - a struct containing the update instruction and optional LUT updates */ updateVaultCrankFundFeePerReserveIxs(vault: KaminoVault, crankFundFeePerReserve: BN | number | string, vaultAdminAuthority?: TransactionSigner): Promise; /** * Update the vault withdrawal penalty (in lamports). * @param vault - vault to update * @param withdrawalPenaltyLamports - new withdrawal penalty amount * @param [vaultAdminAuthority] - vault admin - a noop vaultAdminAuthority is provided when absent for multisigs * @returns - a struct containing the update instruction and optional LUT updates */ updateVaultWithdrawalPenaltyLamportsIxs(vault: KaminoVault, withdrawalPenaltyLamports: BN | number | string, vaultAdminAuthority?: TransactionSigner): Promise; /** * Update the vault withdrawal penalty (in bps). * @param vault - vault to update * @param withdrawalPenaltyBps - new withdrawal penalty bps * @param [vaultAdminAuthority] - vault admin - a noop vaultAdminAuthority is provided when absent for multisigs * @returns - a struct containing the update instruction and optional LUT updates */ updateVaultWithdrawalPenaltyBpsIxs(vault: KaminoVault, withdrawalPenaltyBps: BN | number | string, vaultAdminAuthority?: TransactionSigner): Promise; /** * Update whether allocations are restricted to whitelisted reserves only. * @param vault - vault to update * @param allowWhitelistedOnly - true to restrict, false to allow any reserve * @param [adminAuthority] - signer; pass global admin when setting to false * @returns - a struct containing the update instruction and optional LUT updates */ updateVaultAllowAllocationsInWhitelistedReservesOnlyIxs(vault: KaminoVault, allowWhitelistedOnly: boolean | string, adminAuthority?: TransactionSigner): Promise; /** * Update whether invest is restricted to whitelisted reserves only. * @param vault - vault to update * @param allowWhitelistedOnly - true to restrict, false to allow any reserve * @param [adminAuthority] - signer; pass global admin when setting to false * @returns - a struct containing the update instruction and optional LUT updates */ updateVaultAllowInvestInWhitelistedReservesOnlyIxs(vault: KaminoVault, allowWhitelistedOnly: boolean | string, adminAuthority?: TransactionSigner): Promise; updateVaultConfigValidations(mode: VaultConfigFieldKind, value: string, vaultState: VaultState): Promise; /** * Add or update a reserve whitelist entry. This controls whether the reserve is whitelisted for adding/updating * allocations or for invest, depending on the mode parameter. * * @param reserve - Address of the reserve to whitelist * @param mode - The whitelist mode: either 'Invest' or 'AddAllocation' with a value (1 = allow, 0 = deny) * @param globalAdmin - The global admin that signs the transaction * @returns - An instruction to add/update the whitelisted reserve */ addUpdateWhitelistedReserveIx(reserve: Address, mode: UpdateReserveWhitelistModeKind, globalAdmin: TransactionSigner): Promise; /** Sets the farm where the shares can be staked. This is store in vault state and a vault can only have one farm, so the new farm will ovveride the old farm * @param vault - vault to set the farm for * @param farm - the farm where the vault shares can be staked * @param [errorOnOverride] - if true, the function will throw an error if the vault already has a farm. If false, it will override the farm * @param [vaultAdminAuthority] - vault admin - a noop vaultAdminAuthority is provided when absent for multisigs * @param [lutIxsSigner] - the signer of the transaction to be used for the lookup table instructions. Optional. If not provided the admin of the vault will be used. It should be used when changing the admin of the vault if we want to build or batch multiple ixs in the same tx * @param [skipLutUpdate] - if true, the lookup table instructions will not be included in the returned instructions * @returns - a struct that contains the instruction to update the farm and an optional list of instructions to update the lookup table */ setVaultFarmIxs(vault: KaminoVault, farm: Address, errorOnOverride?: boolean, vaultAdminAuthority?: TransactionSigner, lutIxsSigner?: TransactionSigner, skipLutUpdate?: boolean): Promise; /** * This method updates the vault config during vault initialization, within the same transaction * where the vault is created. Use this when the vault state is not yet committed to the chain * and cannot be fetched via RPC. For updates to existing vaults, use updateVaultConfigIxs instead. * * @param admin - the admin that signs the transaction * @param vault - address of vault to be updated * @param mode - the field to be updated * @param value - the new value for the field to be updated (number or pubkey) * @returns - an instruction to update the vault config */ private updateUninitialisedVaultConfigIx; /** * This function creates the instruction for the `pendingAdmin` of the vault to accept to become the owner of the vault (step 2/2 of the ownership transfer) * @param vault - vault to change the ownership for * @param [pendingAdmin] - pending vault admin - a noop vaultAdminAuthority is provided when absent for multisigs * @param [slot] - optional slot to use for lookup table creation; if not provided, the latest finalized slot will be fetched * @returns - an instruction to accept the ownership of the vault and a list of instructions to update the lookup table */ acceptVaultOwnershipIxs(vault: KaminoVault, pendingAdmin?: TransactionSigner, slot?: Slot): Promise; /** * This function creates the instruction for the admin to give up a part of the pending fees (which will be accounted as part of the vault) * @param vault - vault to give up pending fees for * @param maxAmountToGiveUp - the maximum amount of fees to give up, in tokens * @param [vaultAdminAuthority] - vault admin - a noop vaultAdminAuthority is provided when absent for multisigs * @returns - an instruction to give up the specified pending fees */ giveUpPendingFeesIx(vault: KaminoVault, maxAmountToGiveUp: Decimal, vaultAdminAuthority?: TransactionSigner): Promise; /** * This method withdraws all the pending fees from the vault to the owner's token ATA * @param vault - vault for which the admin withdraws the pending fees * @param slot - current slot, used to estimate the interest earned in the different reserves with allocation from the vault * @param [vaultReservesMap] - a hashmap from each reserve pubkey to the reserve state. Optional. If provided the function will be significantly faster as it will not have to fetch the reserves * @param [vaultAdminAuthority] - vault admin - a noop vaultAdminAuthority is provided when absent for multisigs * @returns - list of instructions to withdraw all pending fees, including the ATA creation instructions if needed */ withdrawPendingFeesIxs(vault: KaminoVault, currentSlot?: Slot, vaultReservesMap?: Map, vaultAdminAuthority?: TransactionSigner): Promise; /** * This function creates instructions to deposit into a vault. It will also create ATA creation instructions for the vault shares that the user receives in return * @param user - user to deposit * @param vault - vault to deposit into (if the state is not provided, it will be fetched) * @param tokenAmount - token amount to be deposited, in decimals (will be converted in lamports) * @param [vaultReservesMap] - optional parameter; a hashmap from each reserve pubkey to the reserve state. Optional. If provided the function will be significantly faster as it will not have to fetch the reserves * @param [farmState] - the state of the vault farm, if the vault has a farm. Optional. If not provided, it will be fetched * @returns - an instance of DepositIxs which contains the instructions to deposit in vault and the instructions to stake the shares in the farm if the vault has a farm as well as ixs to stake in the first loss capital farm if the vault has one - only one set on ixs so stake in a farm can be used -> staking can be either done in the farm or in the first loss capital farm */ depositIxs(user: TransactionSigner, vault: KaminoVault, tokenAmount: Decimal, vaultReservesMap?: Map, farmState?: FarmState, payer?: TransactionSigner): Promise; buySharesIxs(user: TransactionSigner, vault: KaminoVault, tokenAmount: Decimal, vaultReservesMap?: Map, farmState?: FarmState, payer?: TransactionSigner): Promise; private buildShareEntryIxs; /** * Returns the accounts needed for a vault deposit instruction, without building the instruction itself. * Includes the deposit accounts, the remaining accounts for vault reserves, and optionally the stake shares instructions if the vault has a farm. * @param user - the user depositing into the vault * @param vault - the vault to deposit into * @param [vaultReservesMap] - optional preloaded reserve states; if not provided they will be fetched * @param [farmState] - optional preloaded farm state; if not provided and the vault has a farm, it will be fetched * @returns the deposit accounts, remaining accounts, and optional stake shares instructions */ getDepositAccounts(user: TransactionSigner, vault: KaminoVault, vaultReservesMap?: Map, farmState?: FarmState): Promise; /** * Returns the accounts needed for a vault withdraw instruction, without building the instruction itself. * If a reserve is provided, builds the full WithdrawAccounts (withdraw from reserve). Otherwise builds WithdrawFromAvailableAccounts (withdraw from available liquidity only). * Also includes remaining accounts for vault reserves and optionally the unstake instructions if the vault has a farm. * @param user - the user withdrawing from the vault * @param vault - the vault to withdraw from * @param [reserve] - optional reserve to withdraw from; if omitted, builds accounts for withdrawing from available liquidity only * @param [vaultReservesMap] - optional preloaded reserve states; if not provided they will be fetched * @param [farmState] - optional preloaded farm state; if not provided and the vault has a farm, it will be fetched * @returns the withdraw accounts, remaining accounts, and optional unstake shares instructions */ getWithdrawAccounts(user: TransactionSigner, vault: KaminoVault, reserve?: ReserveWithAddress, vaultReservesMap?: Map, farmState?: FarmState): Promise; /** * This function creates instructions to stake the shares in the vault farm if the vault has a farm * @param user - user to stake * @param vault - vault to deposit into its farm (if the state is not provided, it will be fetched) * @param [sharesAmount] - token amount to be deposited, in decimals (will be converted in lamports). Optional. If not provided, the user's share balance will be used * @param [farmState] - the state of the vault farm, if the vault has a farm. Optional. If not provided, it will be fetched * @returns - a list of instructions for the user to stake shares into the vault's farm, including the creation of prerequisite accounts if needed */ stakeSharesIxs(user: TransactionSigner, vault: KaminoVault, sharesAmount?: Decimal, farmState?: FarmState): Promise; /** * This function creates instructions to stake the shares in the vault firstLossCapital farm if the vault has a farm * @param user - user to stake * @param vault - vault to deposit into its flc farm (if the state is not provided, it will be fetched) * @param [sharesAmount] - token amount to be deposited, in decimals (will be converted in lamports). Optional. If not provided, the user's share balance will be used * @param [farmState] - the state of the vault flc farm, if the vault has a farm. Optional. If not provided, it will be fetched * @returns - a list of instructions for the user to stake shares into the vault's firstLossCapital farm, including the creation of prerequisite accounts if needed */ stakeSharesInFlcFarmIxs(user: TransactionSigner, vault: KaminoVault, sharesAmount?: Decimal, farmState?: FarmState): Promise; /** * This function will return a struct with the instructions to unstake from the farm if necessary and the instructions for the missing ATA creation instructions, as well as one or multiple withdraw instructions, based on how many reserves it's needed to withdraw from. This might have to be split in multiple transactions * @param user - user to withdraw * @param vault - vault to withdraw from * @param shareAmountToWithdraw - share amount to withdraw (in tokens, not lamports), in order to withdraw everything, any value > user share amount * @param slot - current slot, used to estimate the interest earned in the different reserves with allocation from the vault * @param [vaultReservesMap] - optional parameter; a hashmap from each reserve pubkey to the reserve state. If provided the function will be significantly faster as it will not have to fetch the reserves * @param [farmState] - the state of the vault farm, if the vault has a farm. Optional. If not provided, it will be fetched * @returns an array of instructions to create missing ATAs if needed and the withdraw instructions */ withdrawIxs(user: TransactionSigner, vault: KaminoVault, shareAmountToWithdraw: Decimal, slot: Slot, vaultReservesMap?: Map, farmState?: FarmState, payer?: TransactionSigner): Promise; /** * This function will return the missing ATA creation instructions, as well as one or multiple withdraw instructions, based on how many reserves it's needed to withdraw from. This might have to be split in multiple transactions * @param user - user to sell shares for vault tokens * @param vault - vault to sell shares from * @param shareAmountToWithdraw - share amount to sell (in tokens, not lamports), in order to withdraw everything, any value > user share amount * @param slot - current slot, used to estimate the interest earned in the different reserves with allocation from the vault * @param [vaultReservesMap] - optional parameter; a hashmap from each reserve pubkey to the reserve state. If provided the function will be significantly faster as it will not have to fetch the reserves * @param [farmState] - the state of the vault farm, if the vault has a farm. Optional. If not provided, it will be fetched * @returns an array of instructions to create missing ATAs if needed and the withdraw instructions */ sellSharesIxs(user: TransactionSigner, vault: KaminoVault, shareAmountToWithdraw: Decimal, slot: Slot, vaultReservesMap?: Map, farmState?: FarmState, payer?: TransactionSigner): Promise; private buildShareExitIxs; private withdrawFromAvailableIxs; private buildReserveExitIxs; /** * This will trigger invest by balancing, based on weights, the reserve allocations of the vault. It can either withdraw or deposit into reserves to balance them. This is a function that should be cranked * @param payer wallet that pays the tx * @param vault - vault to invest from * @param skipComputationChecks - if true, the function will skip the computation checks and will invest all the reserves; it is useful for txs where we update reserve allocations and invest atomically * @returns - an array of invest instructions for each invest action required for the vault reserves */ investAllReservesIxs(payer: TransactionSigner, vault: KaminoVault, skipComputationChecks?: boolean): Promise; /** * This will trigger invest by balancing, based on weights, the reserve allocation of the vault. It can either withdraw or deposit into the given reserve to balance it * @param payer wallet pubkey - the instruction is permissionless and does not require the vault admin, due to rounding between cTokens and the underlying, the payer may have to contribute 1 or more lamports of the underlying from their token account * @param vault - vault to invest from * @param reserve - reserve to invest into or disinvest from * @param [vaultReservesMap] - optional parameter; a hashmap from each reserve pubkey to the reserve state. If provided the function will be significantly faster as it will not have to fetch the reserves * @param [createAtaIfNeeded] * @returns - an array of invest instructions for each invest action required for the vault reserves */ investSingleReserveIxs(payer: TransactionSigner, vault: KaminoVault, reserve: ReserveWithAddress, vaultReservesMap?: Map, createAtaIfNeeded?: boolean): Promise; /** Convert a string to a u8 representation to be stored on chain */ encodeVaultName(token: string): Uint8Array; /**Convert an u8 array to a string */ decodeVaultName(token: number[]): string; /** Helper to serialize value as Buffer for updateVaultConfig instruction */ private getValueForModeAsBuffer; private sellIx; private withdrawIx; private withdrawFromAvailableIx; private withdrawPendingFeesIx; /** * Sync a vault for lookup table; create and set the LUT for the vault if needed and fill it with all the needed accounts * @param authority - vault admin * @param vault the vault to sync and set the LUT for if needed * @param [vaultReservesMap] - optional parameter; a hashmap from each reserve pubkey to the reserve state. Optional. If provided the function will be significantly faster as it will not have to fetch the reserves * @param [slot] - optional slot to use for lookup table creation; if not provided, the latest confirmed slot will be fetched * @returns a struct that contains a list of ix to create the LUT and assign it to the vault if needed + a list of ixs to insert all the accounts in the LUT */ syncVaultLookupTableIxs(authority: TransactionSigner, vault: KaminoVault, vaultReservesMap?: Map, slot?: Slot): Promise; private getReserveAccountsToInsertInLut; /** Read the total holdings of a vault and the reserve weights and returns a map from each reserve to how many tokens should be deposited. * @param vaultState - the vault state to calculate the allocation for * @param [slot] - the slot for which to calculate the allocation. Optional. If not provided the function will fetch the current slot * @param [vaultReserves] - a hashmap from each reserve pubkey to the reserve state. Optional. If provided the function will be significantly faster as it will not have to fetch the reserves * @param [currentSlot] - the latest confirmed slot. Optional. If provided the function will be faster as it will not have to fetch the latest slot * @returns - a map from each reserve to how many tokens should be invested into */ getVaultComputedReservesAllocation(vaultState: VaultState, slot?: Slot, vaultReserves?: Map, currentSlot?: Slot): Promise; private computeReservesAllocation; /** * This method returns the user shares balance for a given vault * @param user - user to calculate the shares balance for * @param vault - vault to calculate shares balance for * @returns - user share balance in tokens (not lamports) */ getUserSharesBalanceSingleVault(user: Address, vault: KaminoVault): Promise; /** * This method returns the user shares balance for all existing vaults * @param user - user to calculate the shares balance for * @param [vaultsOverride] - the kamino vaults if already fetched, in order to reduce rpc calls.Optional * @returns - hash map with keys as vault address and value as user share balance in decimal (not lamports) */ getUserSharesBalanceAllVaults(user: Address, vaultsOverride?: Array): Promise>; /** * This method returns the management and performance fee percentages * @param vaultState - vault to retrieve the fees percentages from * @returns - VaultFeesPct containing management and performance fee percentages */ getVaultFeesPct(vaultState: VaultState): VaultFeesPct; /** * This method calculates the token per share value. This will always change based on interest earned from the vault, but calculating it requires a bunch of rpc requests. Caching this for a short duration would be optimal * @param vaultState - vault state to calculate tokensPerShare for * @param [slot] - the slot at which we retrieve the tokens per share. Optional. If not provided, the function will fetch the current slot * @param [vaultReservesMap] - hashmap from each reserve pubkey to the reserve state. Optional. If provided the function will be significantly faster as it will not have to fetch the reserves * @param [currentSlot] - the latest confirmed slot. Optional. If provided the function will be faster as it will not have to fetch the latest slot * @returns - token per share value */ getTokensPerShareSingleVault(vaultOrState: KaminoVault | VaultState, slot?: Slot, vaultReservesMap?: Map, currentSlot?: Slot): Promise; /** * This method calculates the token per share value. This will always change based on interest earned from the vault, but calculating it requires a bunch of rpc requests. Caching this for a short duration would be optimal * @param [vaultsOverride] - a list of vaults to get the tokens per share for; if provided with state it will not fetch the state again. Optional * @param [vaultReservesMap] - optional parameter; a hashmap from each reserve pubkey to the reserve state. Optional. If provided the function will be significantly faster as it will not have to fetch the reserves * @param slot - current slot, used to estimate the interest earned in the different reserves with allocation from the vault * @returns - token per share value */ getTokensPerShareAllVaults(slot: Slot, vaultsOverride?: Array, vaultReservesMap?: Map): Promise>; /** * Get all vaults * @returns an array of all vaults */ getAllVaults(): Promise; /** * Get all vaults for a given token * @param token - the token to get all vaults for * @returns an array of all vaults for the given token */ getAllVaultsForToken(token: Address): Promise>; private getAllVaultsWithFilter; /** * Get a list of kaminoVaults * @param vaults - a list of vaults to get the states for; if not provided, all vaults will be fetched * @returns a list of vaults */ getVaults(vaults?: Array
): Promise>; /** * This will return all the initialized whitelisted reserves accounts, including those that are not whitelisted but just have the PDA initialized * @returns a map from mint to the whitelisted reserves for that mint */ getAllWhitelistedReserves(): Promise>; /** * This will return all the whitelisted reserves for the given mint; if a ReserveWhitelistEntry exists it doesn't mean it is whitelisted, the fields of the struct has to be read; * If multiple mints are needed it is recommended to call getAllWhitelistedReserves instead; * @param mint - the mint to get the whitelisted reserves for * @returns a list of whitelisted reserves */ getAllWhitelistedReservesForMint(mint: Address): Promise; /** * This will return all the whitelisted reserves for the given markets * @param markets - the markets to get the whitelisted reserves for; if not provided, no whitelisted reserves will be fetched; for getting all whitelisted reserves use getAllWhitelistedReserves * @returns a map from market address to a map from reserve address to the whitelisting status */ getAllWhitelistedReservesForMarkets(markets?: KaminoMarket[]): Promise>>; /** * This will return the whitelisting status for the given reserves * @param reserves - the reserves to get the whitelisting status for * @returns a map from reserve address to the whitelisting status */ getReservesWhitelistingStatus(reserves: KaminoReserve[]): Promise>; /** * Fetches the on-chain ReserveWhitelistEntry for each reserve. If the account does not exist, * a default entry with whitelistAddAllocation=0 and whitelistInvest=0 is used. * @param reserves - the reserves to fetch whitelist entries for * @returns a map from reserve address to ReserveWhitelistEntry */ private fetchReservesWhitelistEntries; /** * This will return a map from each vault to the reserves that are not fully whitelisted (allocation + invest) but are part of the vault allocation. * Duplicate vaults (by address) are deduplicated. * @param vaults - the vaults to get the not whitelisted reserves in allocation for * @returns a map from vault address to the list of reserve addresses that are not fully whitelisted */ getReservesNotWhitelistedInAllocations(vaults: KaminoVault[]): Promise>; /** * This will return a map from each vault to the reserves that are not matching the vault whitelisting requirements (allocation and invest) but are part of the vault allocation. * Duplicate vaults (by address) are deduplicated. * @param vaults - the vaults to get the not whitelisted reserves in allocation for * @returns a map from each vault to the reserves that are not whitelisted as requested (allocation + invest) and their whitelisting status */ getReservesAllocationsNotMatchingVaultWhitelistingRequirements(vaults: KaminoVault[]): Promise>>; /** * Collects all reserve addresses across vault allocations, initializes their KaminoReserve state, * and fetches whitelist entries for all of them. Also caches the per-vault allocation maps to avoid * redundant calls. * @param vaults - the vaults to collect allocations from * @returns the per-vault allocation maps and a global reserve-to-whitelist-entry map */ private fetchVaultsAllocationsAndWhitelistStatus; private getVaultsStates; /** * This will return the amount of token invested from the vault into the given reserve * @param vaultState - the kamino vault to get invested amount in reserve for * @param slot - current slot * @param reserve - the reserve state to get vault invested amount in * @returns vault amount supplied in reserve in decimal */ getSuppliedInReserve(vaultState: VaultState, slot: Slot, reserve: KaminoReserve): Decimal; /** * This will return the a map between reserve pubkey and the pct of the vault invested amount in each reserve * @param vaultState - the kamino vault to get reserves distribution for * @returns a map between reserve pubkey and the allocation pct for the reserve */ getAllocationsDistribuionPct(vaultState: VaultState): Map; /** * This will return the a map between reserve pubkey and the allocation overview for the reserve * @param vaultState - the kamino vault to get reserves allocation overview for * @returns a map between reserve pubkey and the allocation overview for the reserve */ getVaultAllocations(vaultState: VaultState): Map; /** * This will return an unsorted hash map of all reserves that the given vault has allocations for, toghether with the amount that can be withdrawn from each of the reserves * @param vault - the kamino vault to get available liquidity to withdraw for * @param slot - current slot *@param [vaultReservesMap] - a hashmap from each reserve pubkey to the reserve state * @returns an HashMap of reserves (key) with the amount available to withdraw for each (value) */ private getReserveAllocationAvailableLiquidityToWithdraw; /** * This will get the list of all reserve pubkeys that the vault has allocations for ex * @param vault - the vault state to load reserves for * @returns a hashmap from each reserve pubkey to the reserve state */ getVaultReserves(vault: VaultState): Address[]; /** * This will load the onchain state for all the reserves that the vault has allocations for * @param vaultState - the vault state to load reserves for * @returns a hashmap from each reserve pubkey to the reserve state */ loadVaultReserves(vaultState: VaultState): Promise>; private loadReserializedReserves; /** * This will load the onchain state for all the reserves that the vaults have allocations for, deduplicating the reserves * @param vaults - the vault states to load reserves for * @param oracleAccounts (optional) all reserve oracle accounts, if not supplied will make an additional rpc call to fetch these accounts * @returns a hashmap from each reserve pubkey to the reserve state */ loadVaultsReserves(vaults: VaultState[], oracleAccounts?: AllOracleAccounts): Promise>; /** * This will retrieve all the tokens that can be used as collateral by the users who borrow the token in the vault alongside details about the min and max loan to value ratio * @param vaultState - the vault state to load reserves for * @param [slot] - the slot for which to retrieve the vault collaterals for. Optional. If not provided the function will fetch the current slot * @param [vaultReservesMap] - hashmap from each reserve pubkey to the reserve state. Optional. If provided the function will be significantly faster as it will not have to fetch the reserves * @param [kaminoMarkets] - a list of all the kamino markets. Optional. If provided the function will be significantly faster as it will not have to fetch the markets * @param oracleAccounts (optional) all reserve oracle accounts, if not supplied will make an additional rpc call to fetch these accounts * @returns a hashmap from each reserve pubkey to the market overview of the collaterals that can be used and the min and max loan to value ratio in that market */ getVaultCollaterals(vaultState: VaultState, slot: Slot, vaultReservesMap?: Map, kaminoMarkets?: KaminoMarket[], oracleAccounts?: AllOracleAccounts): Promise>; /** * This will return an VaultHoldings object which contains the amount available (uninvested) in vault, total amount invested in reseves and a breakdown of the amount invested in each reserve * @param vault - the kamino vault to get available liquidity to withdraw for * @param [slot] - the slot for which to calculate the holdings. Optional. If not provided the function will fetch the current slot * @param [vaultReserves] - a hashmap from each reserve pubkey to the reserve state. Optional. If provided the function will be significantly faster as it will not have to fetch the reserves * @param [currentSlot] - the latest confirmed slot. Optional. If provided the function will be faster as it will not have to fetch the latest slot * @returns an VaultHoldings object representing the amount available (uninvested) in vault, total amount invested in reseves and a breakdown of the amount invested in each reserve */ getVaultHoldings(vault: VaultState, slot?: Slot, vaultReserves?: Map, currentSlot?: Slot): Promise; /** * This will return an VaultOverview object that encapsulates all the information about the vault, including the holdings, reserves details, theoretical APY, utilization ratio and total borrowed amount * @param vault - the kamino vault to get available liquidity to withdraw for * @param price - the price of the token in the vault (e.g. USDC) * @param [slot] - the slot for which to retrieve the vault overview for. Optional. If not provided the function will fetch the current slot * @param [vaultReservesMap] - hashmap from each reserve pubkey to the reserve state. Optional. If provided the function will be significantly faster as it will not have to fetch the reserves * @param [currentSlot] - the latest confirmed slot. Optional. If provided the function will be faster as it will not have to fetch the latest slot * @returns an VaultOverview object with details about the tokens available and invested in the vault, denominated in tokens and USD */ getVaultHoldingsWithPrice(vault: VaultState, price: Decimal, slot?: Slot, vaultReservesMap?: Map, currentSlot?: Slot): Promise; /** Retrieves the maximum instant withdrawable amount for a vault based on the available liquidity in the vault allocations * @param vault - the kamino vault to get the maximum instant withdrawable amount for * @returns the maximum instant withdrawable amount for the vault */ getMaxInstantWithdrawableAmount(vault: KaminoVault, vaultReservesMap?: Map, slot?: Slot): Promise; /** * This will return an VaultOverview object that encapsulates all the information about the vault, including the holdings, reserves details, theoretical APY, utilization ratio and total borrowed amount * @param vault - the kamino vault to get available liquidity to withdraw for * @param vaultTokenPrice - the price of the token in the vault (e.g. USDC) * @param [slot] - the slot for which to retrieve the vault overview for. Optional. If not provided the function will fetch the current slot * @param [vaultReservesMap] - hashmap from each reserve pubkey to the reserve state. Optional. If provided the function will be significantly faster as it will not have to fetch the reserves * @param [kaminoMarkets] - a list of all kamino markets. Optional. If provided the function will be significantly faster as it will not have to fetch the markets * @param [currentSlot] - the latest confirmed slot. Optional. If provided the function will be faster as it will not have to fetch the latest slot * @param [tokensPrices] - a hashmap from a token pubkey to the price of the token in USD. Optional. If some tokens are not in the map, the function will fetch the price * @returns an VaultOverview object with details about the tokens available and invested in the vault, denominated in tokens and USD, along sie APYs */ getVaultOverview(vault: KaminoVault, vaultTokenPrice: Decimal, slot?: Slot, vaultReservesMap?: Map, kaminoMarkets?: KaminoMarket[], currentSlot?: Slot, tokensPrices?: Map): Promise; /** * This will return the withdrawal penalties for a vault * @param vault - the kamino vault to get the withdrawal penalties for * @param globalConfig - the global config to use for the withdrawal penalties. Optional. If not provided, the function will fetch the global config from the connection * @returns the withdrawal penalties for the vault, in lamports and bps; for each withdraw the penalty is computed and the bax between fixed amount and bps amount is taken */ getVaultWithdrawPenalties(vault: KaminoVault, globalConfig?: KVaultGlobalConfig): Promise; /** * This will return an aggregation of the current state of the vault with all the invested amounts and the utilization ratio of the vault * @param vault - the kamino vault to get available liquidity to withdraw for * @param slot - current slot * @param [vaultReservesMap] - hashmap from each reserve pubkey to the reserve state. Optional. If provided the function will be significantly faster as it will not have to fetch the reserves * @returns an VaultReserveTotalBorrowedAndInvested object with the total invested amount, total borrowed amount and the utilization ratio of the vault */ getTotalBorrowedAndInvested(vault: VaultState, slot: Slot, vaultReservesMap?: Map): Promise; /** * This will return a map of the cumulative rewards issued for all the delegated farms * @param [vaults] - the vaults to get the cumulative rewards for; if not provided, the function will get the cumulative rewards for all the vaults * @returns a map of the cumulative rewards issued for all the delegated farms, per token, in lamports */ getCumulativeDelegatedFarmsRewardsIssuedForAllVaults(vaults?: Address[]): Promise>; /** * This will return an overview of each reserve that is part of the vault allocation * @param vault - the kamino vault to get available liquidity to withdraw for * @param slot - current slot * @param [vaultReservesMap] - hashmap from each reserve pubkey to the reserve state. Optional. If provided the function will be significantly faster as it will not have to fetch the reserves * @returns a hashmap from vault reserve pubkey to ReserveOverview object */ getVaultReservesDetails(vault: VaultState, slot: Slot, vaultReserves?: Map): Promise>; /** * This will return the APY of the vault under the assumption that all the available tokens in the vault are all the time invested in the reserves as requested by the weights; for percentage it needs multiplication by 100 * @param vault - the kamino vault to get APY for * @param slot - current slot * @param [vaultReservesMap] - hashmap from each reserve pubkey to the reserve state. Optional. If provided the function will be significantly faster as it will not have to fetch the reserves * @returns a struct containing estimated gross APY and net APY (gross - vault fees) for the vault */ getVaultTheoreticalAPY(vault: VaultState, slot: Slot, vaultReservesMap?: Map): Promise; /** * This will return the APY of the vault based on the current invested amounts; for percentage it needs multiplication by 100 * @param vault - the kamino vault to get APY for * @param slot - current slot * @param [vaultReservesMap] - hashmap from each reserve pubkey to the reserve state. Optional. If provided the function will be significantly faster as it will not have to fetch the reserves * @returns a struct containing estimated gross APY and net APY (gross - vault fees) for the vault */ getVaultActualAPY(vault: VaultState, slot: Slot, vaultReservesMap?: Map): Promise; /** * Retrive the total amount of interest earned by the vault since its inception, up to the last interaction with the vault on chain, including what was charged as fees * @param vaultState the kamino vault state to get total net yield for * @returns a struct containing a Decimal representing the net number of tokens earned by the vault since its inception and the timestamp of the last fee charge */ getVaultCumulativeInterest(vaultState: VaultState): Promise; /** * Simulate the current holdings of the vault and the earned interest * @param vaultState the kamino vault state to get simulated holdings and earnings for * @param [vaultReservesMap] - hashmap from each reserve pubkey to the reserve state. Optional. If provided the function will be significantly faster as it will not have to fetch the reserves * @param [slot] - the current slot. Optional. If not provided it will fetch the current slot * @param [previousNetAUM] - the previous AUM of the vault to compute the earned interest relative to this value. Optional. If not provided the function will estimate the total AUM at the slot of the last state update on chain * @param [currentSlot] - the latest confirmed slot. Optional. If provided the function will be faster as it will not have to fetch the latest slot * @returns a struct of simulated vault holdings and earned interest */ calculateSimulatedHoldingsWithInterest(vaultState: VaultState, vaultReservesMap?: Map, slot?: Slot, previousNetAUM?: Decimal, currentSlot?: Slot): Promise; /** * Simulate the current holdings and compute the fees that would be charged * @param vaultState the kamino vault state to get simulated fees for * @param [simulatedCurrentHoldingsWithInterest] the simulated holdings and interest earned by the vault. Optional * @param [currentTimestamp] the current date. Optional. If not provided it will fetch the current unix timestamp * @param [vaultReservesMap] - hashmap from each reserve pubkey to the reserve state. Optional. If provided the function will be significantly faster as it will not have to fetch the reserves * @param [slot] - the slot at which to compute the fees. Optional. If not provided it will fetch the current slot * @param [previousNetAUM] - the previous AUM of the vault to compute the fees relative to this value. Optional. If not provided the function will estimate the total AUM at the slot of the last state update on chain * @param [currentSlot] - the latest confirmed slot. Optional. If provided the function will be faster as it will not have to fetch the latest slot * @returns a VaultFees struct of simulated management and interest fees */ calculateSimulatedFees(vaultState: VaultState, simulatedCurrentHoldingsWithInterest?: SimulatedVaultHoldingsWithEarnedInterest, currentTimestamp?: Date, vaultReservesMap?: Map, slot?: Slot, previousNetAUM?: Decimal, currentSlot?: Slot): Promise; /** * This will compute the PDA that is used as delegatee in Farms program to compute the user state PDA for vault depositor investing in vault with reserve having a supply farm */ computeUserFarmStateDelegateePDAForUserInVault(farmsProgramId: Address, vault: Address, reserve: Address, user: Address): Promise; /** * Compute the delegatee PDA for the user farm state for a vault delegate farm * @param farmProgramID - the program ID of the farm program * @param vault - the address of the vault * @param farm - the address of the delegated farm * @param user - the address of the user * @returns the PDA of the delegatee user farm state for the delegated farm */ computeUserFarmStateDelegateePDAForUserInDelegatedVaultFarm(farmProgramID: Address, vault: Address, farm: Address, user: Address): Promise; /** * Compute the user state PDA for a user in a delegated vault farm * @param farmProgramID - the program ID of the farm program * @param vault - the address of the vault * @param farm - the address of the delegated farm * @param user - the address of the user * @returns the PDA of the user state for the delegated farm */ computeUserStatePDAForUserInDelegatedVaultFarm(farmProgramID: Address, vault: Address, farm: Address, user: Address): Promise
; computeDelegateeForUserInDelegatedFarm(farmProgramID: Address, vault: Address, farm: Address, user: Address): Promise
; /** * Read the APY of the farm built on top of the vault (farm in vaultState.vaultFarm) * @param vaultOrState - the vault or state to read the farm APY for * @param vaultTokenPrice - the price of the vault token in USD (e.g. 1.0 for USDC) * @param [farmsClient] - the farms client to use. Optional. If not provided, the function will create a new one * @param [slot] - the slot to read the farm APY for. Optional. If not provided, the function will read the current slot * @param tokensPrices cached token prices * @returns the APY of the farm built on top of the vault */ getVaultRewardsAPY(vaultOrState: KaminoVault | VaultState, vaultTokenPrice: Decimal, farmsClient?: Farms, slot?: Slot, tokensPrices?: Map): Promise; /** * Read the APY of the delegated farm providing incentives for vault depositors * @param vault - the vault to read the farm APY for * @param vaultTokenPrice - the price of the vault token in USD (e.g. 1.0 for USDC) * @param [farmsClient] - the farms client to use. Optional. If not provided, the function will create a new one * @param [slot] - the slot to read the farm APY for. Optional. If not provided, the function will read the current slot * @param [tokensPrices] - the prices of the tokens in USD. Optional. If not provided, the function will fetch the prices * @returns the APY of the delegated farm providing incentives for vault depositors */ getVaultDelegatedFarmRewardsAPY(vault: KaminoVault, vaultTokenPrice: Decimal, farmsClient?: Farms, slot?: Slot, tokensPrices?: Map): Promise; /** * Get all the token mints of the vault, vault farm rewards and the allocation rewards * @param vaults - the vaults to get the token mints for * @param [vaultReservesMap] - the vault reserves map to get the reserves for; if not provided, the function will fetch the reserves * @param farmsMap - the farms map to get the farms for * @returns a map of token mints (keys) and number of decimals (values) */ getAllVaultsTokenMintsIncludingRewards(vaults: KaminoVault[], vaultReservesMap?: Map, farmsMap?: Map): Promise>; getVaultReservesFarmsIncentives(vaultOrState: KaminoVault | VaultState, vaultTokenPrice: Decimal, farmsClient?: Farms, slot?: Slot, vaultReservesMap?: Map, tokensPrices?: Map): Promise; getVaultFlcFarmStats(vaultOrState: KaminoVault | VaultState): Promise; isFlcFarmValid(flcFarmState: FarmState, vaultOrState: KaminoVault | VaultState): Promise; getUserPendingRewardsInVaultFarm(user: Address, vault: KaminoVault): Promise>; getUserPendingRewardsInVaultDelegatedFarm(user: Address, vaultAddress: Address): Promise>; getDelegatedFarmForVault(vault: Address): Promise
; /** * gets all the delegated farms addresses * @returns a list of delegated farms addresses */ getAllDelegatedFarms(): Promise; /** * This will return a map of the vault address and the delegated farm address for that vault * @returns a map of the vault address and the delegated farm address for that vault */ getVaultsWithDelegatedFarm(): Promise>; getUserPendingRewardsInVaultReservesFarms(user: Address, vault: KaminoVault, vaultReservesMap?: Map): Promise>; getAllPendingRewardsForUserInVault(user: Address, vault: KaminoVault, vaultReservesMap?: Map): Promise; /** * This function will return the instructions to claim the rewards for the farm of a vault, the delegated farm of the vault and the reserves farms of the vault * @param user - the user to claim the rewards * @param vault - the vault * @param [vaultReservesMap] - the vault reserves map to get the reserves for; if not provided, the function will fetch the reserves * @returns the instructions to claim the rewards for the farm of the vault, the delegated farm of the vault and the reserves farms of the vault */ getClaimAllRewardsForVaultIxs(user: TransactionSigner, vault: KaminoVault, vaultReservesMap?: Map): Promise; /** * This function will return the instructions to claim the rewards for the farm of a vault * @param user - the user to claim the rewards * @param vault - the vault * @returns the instructions to claim the rewards for the farm of the vault */ getClaimVaultFarmRewardsIxs(user: TransactionSigner, vault: KaminoVault): Promise; /** * This function will return the instructions to claim the rewards for the delegated farm of a vault * @param user - the user to claim the rewards * @param vault - the vault * @returns the instructions to claim the rewards for the delegated farm of the vault */ getClaimVaultDelegatedFarmRewardsIxs(user: TransactionSigner, vault: KaminoVault): Promise; /** * This function will return the instructions to claim the rewards for the reserves farms of a vault * @param user - the user to claim the rewards * @param vault - the vault * @param [vaultReservesMap] - the vault reserves map to get the reserves for; if not provided, the function will fetch the reserves * @returns the instructions to claim the rewards for the reserves farms of the vault */ getClaimVaultReservesFarmsRewardsIxs(user: TransactionSigner, vault: KaminoVault, vaultReservesMap?: Map): Promise; private buildRemainingAccountsForVaultReserves; private appendRemainingAccountsForVaultReserves; } export declare class KaminoVault { readonly address: Address; state: VaultState | undefined | null; programId: Address; client: KaminoVaultClient; vaultReservesStateCache: Map | undefined; constructor(rpc: Rpc, vaultAddress: Address, state?: VaultState, programId?: Address, recentSlotDurationMs?: number); static loadWithClientAndState(client: KaminoVaultClient, vaultAddress: Address, state: VaultState): KaminoVault; getState(): Promise; reloadVaultReserves(): Promise; reloadState(): Promise; hasFarm(vaultState?: VaultState): Promise; hasFlcFarm(): Promise; /** * This will return an VaultHoldings object which contains the amount available (uninvested) in vault, total amount invested in reseves and a breakdown of the amount invested in each reserve * @returns an VaultHoldings object representing the amount available (uninvested) in vault, total amount invested in reseves and a breakdown of the amount invested in each reserve */ getVaultHoldings(): Promise; /** * This will return the a map between reserve pubkey and the allocation overview for the reserve * @returns a map between reserve pubkey and the allocation overview for the reserve */ getVaultAllocations(): Promise>; /** * This will return the APY of the vault based on the current invested amounts and the theoretical APY if all the available tokens were invested * @returns a struct containing actualAPY and theoreticalAPY for the vault */ getAPYs(slot?: Slot): Promise; /** * This method returns the exchange rate of the vault (tokens per share) * @returns - Decimal representing the exchange rate (tokens per share) */ getExchangeRate(slot?: Slot): Promise; /** * This method returns the user shares balance for a given vault * @param user - user to calculate the shares balance for * @param vault - vault to calculate shares balance for * @returns - a struct of user share balance (staked in vault farm if the vault has a farm and unstaked) in decimal (not lamports) */ getUserShares(user: Address): Promise; /** * This function creates instructions to deposit into a vault. It will also create ATA creation instructions for the vault shares that the user receives in return * @param user - user to deposit * @param tokenAmount - token amount to be deposited, in decimals (will be converted in lamports) * @param [vaultReservesMap] - optional parameter; a hashmap from each reserve pubkey to the reserve state. Optional. If provided the function will be significantly faster as it will not have to fetch the reserves * @param [farmState] - the state of the vault farm, if the vault has a farm. Optional. If not provided, it will be fetched * @returns - an instance of DepositIxs which contains the instructions to deposit in vault and the instructions to stake the shares in the farm if the vault has a farm */ depositIxs(user: TransactionSigner, tokenAmount: Decimal, vaultReservesMap?: Map, farmState?: FarmState, payer?: TransactionSigner): Promise; /** * This function will return the missing ATA creation instructions, as well as one or multiple withdraw instructions, based on how many reserves it's needed to withdraw from. This might have to be split in multiple transactions * @param user - user to withdraw * @param shareAmount - share amount to withdraw (in tokens, not lamports), in order to withdraw everything, any value > user share amount * @param slot - current slot, used to estimate the interest earned in the different reserves with allocation from the vault * @param [vaultReservesMap] - optional parameter; a hashmap from each reserve pubkey to the reserve state. If provided the function will be significantly faster as it will not have to fetch the reserves * @param [farmState] - the state of the vault farm, if the vault has a farm. Optional. If not provided, it will be fetched * @param [payer] - optional parameter to pass a different payer for ATA creation rent. If not provided, the user will be used * @returns an array of instructions to create missing ATAs if needed and the withdraw instructions */ withdrawIxs(user: TransactionSigner, shareAmount: Decimal, slot?: Slot, vaultReservesMap?: Map, farmState?: FarmState, payer?: TransactionSigner): Promise; } /** * Used to initialize a Kamino Vault */ export declare class KaminoVaultConfig { /** The admin of the vault */ readonly admin: TransactionSigner; /** The token mint for the vault */ readonly tokenMint: Address; /** The token mint program id */ readonly tokenMintProgramId: Address; /** The performance fee rate of the vault, as percents, expressed as a decimal */ readonly performanceFeeRatePercentage: Decimal; /** The management fee rate of the vault, as percents, expressed as a decimal */ readonly managementFeeRatePercentage: Decimal; /** The name to be stored on chain for the vault (max 40 characters). */ readonly name: string; /** The symbol of the vault token to be stored (max 5 characters). E.g. USDC for a vault using USDC as token. */ readonly vaultTokenSymbol: string; /** The name of the vault token to be stored (max 10 characters), after the prefix `Kamino Vault `. E.g. USDC Vault for a vault using USDC as token. */ readonly vaultTokenName: string; constructor(args: { admin: TransactionSigner; tokenMint: Address; tokenMintProgramId: Address; performanceFeeRatePercentage: Decimal; managementFeeRatePercentage: Decimal; name: string; vaultTokenSymbol: string; vaultTokenName: string; }); getPerformanceFeeBps(): number; getManagementFeeBps(): number; } export declare class ReserveAllocationConfig { readonly reserve: ReserveWithAddress; readonly targetAllocationWeight: number; readonly allocationCapDecimal: Decimal; constructor(reserve: ReserveWithAddress, targetAllocationWeight: number, allocationCapDecimal: Decimal); getAllocationCapLamports(): Decimal; getReserveState(): Reserve; getReserveAddress(): Address; } export declare function getCTokenVaultPda(vaultAddress: Address, reserveAddress: Address, kaminoVaultProgramId: Address): Promise
; export declare function getEventAuthorityPda(kaminoVaultProgramId: Address): Promise
; export declare function getKvaultGlobalConfigPda(kaminoVaultProgramId: Address): Promise
; export declare function getReserveWhitelistEntryPda(reserveAddress: Address, kaminoVaultProgramId: Address): Promise
; export type VaultHolder = { holderPubkey: Address; amount: Decimal; }; export type APY = { grossAPY: Decimal; netAPY: Decimal; }; export type VaultAPYs = { theoreticalAPY: APY; actualAPY: APY; }; export declare class VaultHoldings { available: Decimal; invested: Decimal; investedInReserves: Map; pendingFees: Decimal; totalAUMIncludingFees: Decimal; constructor(params: { available: Decimal; invested: Decimal; investedInReserves: Map; pendingFees: Decimal; totalAUMIncludingFees: Decimal; }); asJSON(): { available: string; invested: string; totalAUMIncludingFees: string; pendingFees: string; investedInReserves: { [key: string]: string; }; }; print(): void; } /** * earnedInterest represents the interest earned from now until the slot provided in the future */ export type SimulatedVaultHoldingsWithEarnedInterest = { holdings: VaultHoldings; earnedInterest: Decimal; }; export type VaultHoldingsWithUSDValue = { holdings: VaultHoldings; availableUSD: Decimal; investedUSD: Decimal; investedInReservesUSD: Map; totalUSDIncludingFees: Decimal; pendingFeesUSD: Decimal; }; export type ReserveOverview = { supplyAPY: Decimal; utilizationRatio: Decimal; liquidationThresholdPct: Decimal; totalBorrowedAmount: Decimal; amountBorrowedFromSupplied: Decimal; suppliedAmount: Decimal; market: Address; }; export type VaultReserveTotalBorrowedAndInvested = { totalInvested: Decimal; totalBorrowed: Decimal; utilizationRatio: Decimal; }; export type MarketOverview = { address: Address; reservesAsCollateral: ReserveAsCollateral[]; minLTVPct: Decimal; maxLTVPct: Decimal; }; export type ReserveAsCollateral = { mint: Address; liquidationLTVPct: Decimal; address: Address; }; export type VaultOverview = { holdingsUSD: VaultHoldingsWithUSDValue; reservesOverview: Map; vaultCollaterals: Map; theoreticalSupplyAPY: APYs; actualSupplyAPY: APYs; vaultFarmIncentives: FarmIncentives; reservesFarmsIncentives: VaultReservesFarmsIncentives; delegatedFarmIncentives: FarmIncentives; totalBorrowed: Decimal; totalBorrowedUSD: Decimal; totalSupplied: Decimal; totalSuppliedUSD: Decimal; utilizationRatio: Decimal; flcFarmStats: FlcFarmStats | undefined; withdrawalPenalties: WithdrawPenalties; }; export type VaultReservesFarmsIncentives = { reserveFarmsIncentives: Map; totalIncentivesAPY: Decimal; }; export type FlcFarmStats = { address: Address; farmState: FarmState; totalStakedShares: Decimal; withdrawalCooldownDurationSeconds: number; isPendingUnstake: boolean; pendingUnstakeInfo: FarmPendingUnstakeInfo[]; }; export type FarmPendingUnstakeInfo = { userStateAddress: Address; pendingUnstakeAmountLamports: Decimal; pendingUnstakeAvailableAtTimestamp: number; }; export type VaultFeesPct = { managementFeePct: Decimal; performanceFeePct: Decimal; }; export type VaultFees = { managementFee: Decimal; performanceFee: Decimal; }; export type VaultCumulativeInterestWithTimestamp = { cumulativeInterest: Decimal; timestamp: number; }; export type PendingRewardsForUserInVault = { pendingRewardsInVaultFarm: Map; pendingRewardsInVaultDelegatedFarm: Map; pendingRewardsInVaultReservesFarms: Map; totalPendingRewards: Map; }; export type WithdrawPenalties = { withdrawalPenaltyLamports: Decimal; withdrawalPenaltyBps: Decimal; }; //# sourceMappingURL=vault.d.ts.map