Class VaultAPI

Hierarchy

BaseAPI
- VaultAPI

Constructors

constructor

new VaultAPI(premia): VaultAPI
Construct a new BaseAPI object.
Parameters
- premia: Premia
  
  An instance of the Premia SDK.
Returns VaultAPI
Inherited from BaseAPI.constructor
- Defined in src/api/baseAPI.ts:17

Properties

`Readonly` premia

premia: Premia

Methods

balanceOfAssets

balanceOfAssets(vaultAddress, owner): Promise<bigint>
Gets the balance of assets for a specific owner in a vault.
Parameters
- vaultAddress: string
  
  The address of the vault.
- owner: string
  
  The address of the owner.
Returns Promise<bigint>
A promise that resolves to a bigint representing the balance of assets for the specified owner in the specified vault.
- Defined in src/api/vaultAPI.ts:466

balanceOfShares

balanceOfShares(vaultAddress, owner): Promise<bigint>
Gets the balance of shares for a specific owner in a vault.
Parameters
- vaultAddress: string
  
  The address of the vault.
- owner: string
  
  The address of the owner.
Returns Promise<bigint>
A promise that resolves to a bigint representing the balance of shares for the specified owner in the specified vault.
- Defined in src/api/vaultAPI.ts:452

cancelQuoteStream

cancelQuoteStream(assets, isCall, isBuy): Promise<void>
Cancels a quote stream for a given parameter set.
Parameters
- assets: string[]
  
  The vault assets for which to cancel quote streams on.
- isCall: boolean
  
  Whether the vault is a call vault.
- isBuy: boolean
  
  Whether the quote is a buy quote.
Returns Promise<void>
A promise that resolves when the quote stream has been cancelled.
- Defined in src/api/vaultAPI.ts:255

convertToAssets

convertToAssets(vaultAddress, shares): Promise<bigint>
Converts a given amount of shares to assets for a specific vault.
Parameters
- vaultAddress: string
  
  The address of the vault.
- shares: BigNumberish
  
  The amount of shares to be converted.
Returns Promise<bigint>
A promise that resolves to a bigint representing the equivalent assets for the specified amount of shares in the specified vault.
- Defined in src/api/vaultAPI.ts:498

convertToShares

convertToShares(vaultAddress, assets): Promise<bigint>
Converts a given amount of assets to shares for a specific vault.
Parameters
- vaultAddress: string
  
  The address of the vault.
- assets: BigNumberish
  
  The amount of assets to be converted.
Returns Promise<bigint>
A promise that resolves to a bigint representing the equivalent shares for the specified amount of assets in the specified vault.
- Defined in src/api/vaultAPI.ts:481

deposit

deposit(vaultAddress, options): Promise<ContractTransactionResponse>
Deposits specified assets into a vault from the receiver's address.

Throws
Will throw an error if the ERC4626 contract is not found for the provided vault address, or if the transaction fails to be sent.
Parameters
- vaultAddress: string
  
  The address of the vault into which the assets are to be deposited.
- options: {
  assets: BigNumberish;
  receiver: string;
  }
  
  An object containing deposit parameters.
  - assets: BigNumberish
    
    The amount of assets to be deposited into the vault.
  - receiver: string
    
    The address of the receiver whose assets will be deposited and shares will be received.
Returns Promise<ContractTransactionResponse>
A promise that resolves to a transaction response. This contains details of the transaction such as block number, transaction hash, etc.
- Defined in src/api/vaultAPI.ts:546

encodeDeposit

encodeDeposit(vaultAddress, options): Promise<ContractTransaction>
Encodes the deposit parameters into a transaction that can be broadcasted to the provider network.

Throws
Will throw an error if the ERC4626 contract is not found for the provided vault address.
Parameters
- vaultAddress: string
  
  The address of the vault where assets will be deposited.
- options: {
  assets: BigNumberish;
  receiver: string;
  }
  
  An object containing the parameters for the deposit operation.
  - assets: BigNumberish
    
    The amount of assets to be deposited.
  - receiver: string
    
    The address of the receiver whose assets will be deposited and shares will be received.
Returns Promise<ContractTransaction>
A promise that resolves to a contract transaction for the deposit operation.
- Defined in src/api/vaultAPI.ts:520

encodeRedeem

encodeRedeem(vaultAddress, options): Promise<ContractTransaction>
Encodes a transaction for redeeming shares from a vault.

Method
encodeRedeem
Parameters
- vaultAddress: string
  
  The address of the vault.
- options: {
      owner: string;
      receiver: string;
      shares: BigNumberish;
  }
  
  An object containing the parameters for redeeming shares.
  - owner: string
    
    The address of the owner of the shares.
  - receiver: string
    
    The address to receive the redeemed assets.
  - shares: BigNumberish
    
    The number of shares to redeem.
Returns Promise<ContractTransaction>
A promise that resolves to a ContractTransaction that represents the encoded transaction for redeeming the shares.
- Defined in src/api/vaultAPI.ts:684

encodeTrade

encodeTrade(vaultAddress, options): Promise<ContractTransaction>
Encodes the trade parameters into a contract transaction that can be broadcasted to the provider network.

Throws
Will throw an error if the vault contract is not found for the provided vault address.
Parameters
- vaultAddress: string
  
  The address of the vault.
- options: {
      isBuy: boolean;
      poolKey: PoolKey;
      premiumLimit: BigNumberish;
      referrer?: string;
      size: BigNumberish;
  }
  
  An object containing key trade options.
  - isBuy: boolean
    
    A boolean flag indicating whether the trade is a buy (true) or sell (false).
  - poolKey: PoolKey
    
    The unique identifier for the liquidity pool involved in the trade.
  - premiumLimit: BigNumberish
    
    The maximum premium that the trader is willing to pay for the trade.
  - Optional referrer?: string
    
    (Optional) The address of the referrer. If not provided, the referrer will default to a zero address.
  - size: BigNumberish
    
    The number of contracts to be bought or sold.
Returns Promise<ContractTransaction>
A promise that resolves to an encoded contract transaction. This transaction can be signed and broadcasted to the provider network.
- Defined in src/api/vaultAPI.ts:767

encodeWithdraw

encodeWithdraw(vaultAddress, options): Promise<ContractTransaction>
Encodes the withdrawal parameters into a transaction that can be broadcasted to the provider network.

Throws
Will throw an error if the ERC4626 contract is not found for the provided vault address.
Parameters
- vaultAddress: string
  
  The address of the vault from which assets will be withdrawn.
- options: {
      assets: BigNumberish;
      owner: string;
      receiver: string;
  }
  
  An object containing the parameters for the withdrawal operation.
  - assets: BigNumberish
    
    The amount of assets to be withdrawn.
  - owner: string
    
    The address of the current owner of the assets.
  - receiver: string
    
    The address of the receiver who will get the withdrawn assets.
Returns Promise<ContractTransaction>
A promise that resolves to a contract transaction for the withdrawal operation.
- Defined in src/api/vaultAPI.ts:601

getAllVaultsExtended

getAllVaultsExtended(): Promise<VaultExtended[]>
Retrieves information for all vaults.

This function is cached, meaning that if it is called multiple times within a daily period, it will only perform the operation once and then return the cached result for subsequent calls.

Returns Promise<VaultExtended[]>
A promise that resolves to an array of VaultExtended objects, each containing information about a vault.
- Defined in src/api/vaultAPI.ts:315

getQuote

getQuote(vaultAddress, poolKey, size, isBuy, taker): Promise<bigint>
Retrieves the quote for a specified trade operation in a specific vault.

Throws
Will throw an error if the vault contract is not found for the provided vault address.
Parameters
- vaultAddress: string
  
  The address of the vault where the quote will be retrieved from.
- poolKey: PoolKey
  
  The identifier for the pool from which the contracts are to be bought or sold.
- size: BigNumberish
  
  The number of contracts to be bought or sold.
- isBuy: boolean
  
  A boolean indicating whether this operation is a buy (true) or sell (false).
- taker: string
  
  The address of the user who would perform the trade.
Returns Promise<bigint>
A promise that resolves to a quote for the proposed trade operation.
- Defined in src/api/vaultAPI.ts:739

getUtilizationPercent

getUtilizationPercent(vaultAddress): Promise<number>
Returns the utilization percent of total assets in a vault.
Parameters
- vaultAddress: string
  
  {string} The contract address of the vault.
Returns Promise<number>
Promise containing the utilization percent of the assets in the vault.
- Defined in src/api/vaultAPI.ts:60

getVault

getVault(address): Promise<Vault>
Retrieves information for a specific vault using its address.

This function is cached, meaning that if it is called multiple times within a daily period, it will only perform the operation once and then return the cached result for subsequent calls.
Parameters
- address: string
  
  The address of the vault for which information should be retrieved.
Returns Promise<Vault>
A promise that resolves to a VaultExtended object, containing information about the vault at the specified address.
- Defined in src/api/vaultAPI.ts:285

getVaultExtended

getVaultExtended(address): Promise<VaultExtended>
Retrieves extended information for a specific vault using its address.

This function is cached, meaning that if it is called multiple times within a one minute period, it will only perform the operation once and then return the cached result for subsequent calls.
Parameters
- address: string
  
  The address of the vault for which extended information should be retrieved.
Returns Promise<VaultExtended>
A promise that resolves to a VaultExtended object, containing detailed information about the vault at the specified address.
- Defined in src/api/vaultAPI.ts:301

getVaultPosition

getVaultPosition(owner, vaultAddress): Promise<VaultPosition>
Retrieves the vault position for a specific owner and pool.

This function is cached, meaning that if it is called multiple times within a one-minute period, it will only perform the operation once and then return the cached result for subsequent calls.
Parameters
- owner: string
  
  The address of an owner with shares in the vault.
- vaultAddress: string
  
  The address of the vault.
Returns Promise<VaultPosition>
A promise that resolves to a VaultPosition object containing details about the owner's position in the specified vault.
- Defined in src/api/vaultAPI.ts:402

getVaultPositionExtended

getVaultPositionExtended(owner, vaultAddress): Promise<VaultPositionExtended>
Retrieves the extended vault position for a specific owner and pool.

This function is cached, meaning that if it is called multiple times within a one-minute period, it will only perform the operation once and then return the cached result for subsequent calls.
Parameters
- owner: string
  
  The address of an owner with shares in the vault.
- vaultAddress: string
  
  The address of the vault.
Returns Promise<VaultPositionExtended>
A promise that resolves to a VaultPositionExtended object containing extended details about the owner's position in the specified vault.
- Defined in src/api/vaultAPI.ts:420

getVaultPositionsExtendedForUser

getVaultPositionsExtendedForUser(owner): Promise<VaultPositionExtended[]>
Retrieves the vault positions for a specific owner.

This function is cached, meaning that if it is called multiple times within a one-minute period, it will only perform the operation once and then return the cached result for subsequent calls.
Parameters
- owner: string
  
  The address of an owner with shares in the vault.
Returns Promise<VaultPositionExtended[]>
A promise that resolves to an array of VaultPositionExtended objects, each containing detailed information about a vault position associated with the given owner.
- Defined in src/api/vaultAPI.ts:438

getVaults

getVaults(tokenAddress): Promise<Vault[]>
Retrieves extended information for all vaults associated with a given token address.

This function is cached, meaning that if it is called multiple times within a daily period, it will only perform the operation once and then return the cached result for subsequent calls.
Parameters
- tokenAddress: string
  
  The base token address for which vaults should be retrieved.
Returns Promise<Vault[]>
A promise that resolves to an array of Vault objects, each containing information about a vault associated with the given base address.
- Defined in src/api/vaultAPI.ts:331

getVaultsExtended

getVaultsExtended(tokenAddress): Promise<VaultExtended[]>
Retrieves information for all vaults associated with a given token address.

This function is cached, meaning that if it is called multiple times within a one minute period, it will only perform the operation once and then return the cached result for subsequent calls.
Parameters
- tokenAddress: string
  
  The base token address for which vaults should be retrieved.
Returns Promise<VaultExtended[]>
A promise that resolves to an array of VaultExtended objects, each containing detailed information about a vault associated with the given base address.
- Defined in src/api/vaultAPI.ts:347

getVaultsExtendedForToken

getVaultsExtendedForToken(token, isQuote?): Promise<VaultExtended[]>
Retrieves extended information for all vaults associated with a given token.

This function is cached, meaning that if it is called multiple times within a one minute period, it will only perform the operation once and then return the cached result for subsequent calls.
Parameters
- token: Token
  
  The token for which vaults should be retrieved.
- isQuote: boolean = false
  
  Optional parameter that indicates whether the token is a quote token. Default is false.
Returns Promise<VaultExtended[]>
A promise that resolves to an array of VaultExtended objects, each containing detailed information about a vault associated with the given token.
- Defined in src/api/vaultAPI.ts:384

getVaultsForToken

getVaultsForToken(token, isQuote?): Promise<Vault[]>
Retrieves information for all vaults associated with a given token.

This function is cached, meaning that if it is called multiple times within a daily period, it will only perform the operation once and then return the cached result for subsequent calls.
Parameters
- token: Token
  
  The token for which vaults should be retrieved.
- isQuote: boolean = false
  
  Optional parameter that indicates whether the token is a quote token. Default is false.
Returns Promise<Vault[]>
A promise that resolves to an array of Vault objects, each containing information about a vault associated with the given token.
- Defined in src/api/vaultAPI.ts:364

maxRedeem

maxRedeem(vaultAddress, owner): Promise<bigint>
Gets the maximum amount of shares that can be redeemed by a particular owner from a specified vault.
Parameters
- vaultAddress: string
  
  The address of the vault.
- owner: string
  
  The address of the owner.
Returns Promise<bigint>
A promise that resolves to a bigint representing the maximum amount of shares that can be redeemed by the owner from the vault.
- Defined in src/api/vaultAPI.ts:652

maxWithdraw

maxWithdraw(vaultAddress, owner): Promise<bigint>
Gets the maximum amount that can be withdrawn from a specified vault by a particular owner.
Parameters
- vaultAddress: string
  
  The address of the vault.
- owner: string
  
  The address of the owner.
Returns Promise<bigint>
A promise that resolves to a bigint representing the maximum amount that can be withdrawn by the owner from the vault.
- Defined in src/api/vaultAPI.ts:567

optionType

optionType(isCall): bigint
Converts a boolean into the corresponding bigint for the option type.
Parameters
- isCall: boolean
  
  Whether the trade is a call or a put.
Returns bigint
The corresponding bigint for the trade side
- Defined in src/api/vaultAPI.ts:41

previewRedeem

previewRedeem(vaultAddress, shares): Promise<bigint>
Previews the amount of assets that would be received for a given amount of shares from a specific vault.

Method
previewRedeem
Parameters
- vaultAddress: string
  
  The address of the vault.
- shares: BigNumberish
  
  The amount of shares for which to preview the redemption.
Returns Promise<bigint>
A promise that resolves to a bigint representing the amount of assets that would be received for the given shares amount.
- Defined in src/api/vaultAPI.ts:665

previewWithdraw

previewWithdraw(vaultAddress, assets): Promise<bigint>
Previews the amount of shares that would be withdrawn for a given amount of assets from a specific vault.

Method
previewWithdraw
Parameters
- vaultAddress: string
  
  The address of the vault.
- assets: BigNumberish
  
  The amount of assets for which to preview the withdrawal.
Returns Promise<bigint>
A promise that resolves to a bigint representing the amount of shares that would be withdrawn for the given assets amount.
- Defined in src/api/vaultAPI.ts:580

quote

quote(poolAddress, size, isBuy, minimumSize?, referrer?, maxSlippagePercent?): Promise<null | FillableQuote>
Returns the best vault quote for a given pool.
Parameters
- poolAddress: string
  
  The address of the pool to stream quotes for.
- size: BigNumberish
  
  The size of the quote to stream.
- isBuy: boolean
  
  Whether the quote is a buy quote.
- Optional minimumSize: BigNumberish
  
  The minimum size of the quote to stream. Only quotes with a size greater than or equal to this will be emitted.
- Optional referrer: string
  
  The referrer address to use for the quote.
- Optional maxSlippagePercent: BigNumberish
  
  The maximum slippage percent to use for the quote.
Returns Promise<null | FillableQuote>
A promise that resolves to the best quote for the given pool.
- Defined in src/api/vaultAPI.ts:91

redeem

redeem(vaultAddress, options): Promise<ContractTransactionResponse>
Redeems shares from a vault and sends the resulting assets to the specified receiver.

Method
redeem
Parameters
- vaultAddress: string
  
  The address of the vault.
- options: {
      owner: string;
      receiver: string;
      shares: BigNumberish;
  }
  
  An object containing the parameters for redeeming shares.
  - owner: string
    
    The address of the owner of the shares.
  - receiver: string
    
    The address to receive the redeemed assets.
  - shares: BigNumberish
    
    The number of shares to redeem.
Returns Promise<ContractTransactionResponse>
A promise that resolves to a ContractTransactionResponse which contains information about the transaction that redeemed the shares.
- Defined in src/api/vaultAPI.ts:711

streamQuotes

streamQuotes(options, callback): Promise<void>
Opens a stream, which will emit a quote every time the best vault quote changes.
Parameters
- options: {
      isBuy: boolean;
      minimumSize?: BigNumberish;
      poolAddress: string;
      size: BigNumberish;
  }
  
  The options object.
  - isBuy: boolean
    
    Whether the quote is a buy quote.
  - Optional minimumSize?: BigNumberish
    
    The minimum size of the quote to stream. Only quotes with a size greater than or equal to this will be emitted.
  - poolAddress: string
    
    The address of the pool to stream quotes for.
  - size: BigNumberish
    
    The size of the quote to stream.
- callback: ((quote) => void)
  
  The callback to call when a new quote is emitted.
  - - (quote): void
    - Parameters
      
      quote: null | FillableQuote
      
      Returns void
Returns Promise<void>
A promise that resolves when the quote stream has been started.
- Defined in src/api/vaultAPI.ts:196

totalAssets

totalAssets(vaultAddress): Promise<bigint>
Returns the total amount of assets in a vault.
Parameters
- vaultAddress: string
  
  {string} The contract address of the vault.
Returns Promise<bigint>
Promise containing the total assets in the vault.
- Defined in src/api/vaultAPI.ts:50

trade

trade(vaultAddress, options): Promise<ContractTransactionResponse>
Performs a trade operation in a specific vault on behalf of a user.

Throws
Will throw an error if the vault contract is not found for the provided vault address, or if the transaction fails to be sent.
Parameters
- vaultAddress: string
  
  The address of the vault where the trade operation will occur.
- options: {
      isBuy: boolean;
      poolKey: PoolKey;
      premiumLimit: BigNumberish;
      referrer?: string;
      size: BigNumberish;
  }
  
  An object containing trade parameters.
  - isBuy: boolean
    
    A boolean indicating whether this operation is a buy (true) or sell (false).
  - poolKey: PoolKey
    
    The unique identifier for the liquidity pool involved in the trade.
  - premiumLimit: BigNumberish
    
    The maximum premium that the trader is willing to pay for the trade.
  - Optional referrer?: string
    
    (Optional) The address of the user who referred this trade.
  - size: BigNumberish
    
    The number of contracts to be bought or sold.
Returns Promise<ContractTransactionResponse>
A promise that resolves to a transaction response. This contains details of the transaction such as block number, transaction hash, etc.
- Defined in src/api/vaultAPI.ts:808

tradeSide

tradeSide(isBuy): bigint
Converts a boolean into the corresponding bigint for the trade side.
Parameters
- isBuy: boolean
  
  Whether the trade is a buy or a sell.
Returns bigint
The corresponding bigint for the trade side
- Defined in src/api/vaultAPI.ts:31

withdraw

withdraw(vaultAddress, options): Promise<ContractTransactionResponse>
Withdraws specified assets from a vault and sends them to a receiver's address.

Throws
Will throw an error if the ERC4626 contract is not found for the provided vault address, or if the transaction fails to be sent.
Parameters
- vaultAddress: string
  
  The address of the vault from which the assets are to be withdrawn.
- options: {
      assets: BigNumberish;
      owner: string;
      receiver: string;
  }
  
  An object containing withdrawal parameters.
  - assets: BigNumberish
    
    The amount of assets to be withdrawn from the vault.
  - owner: string
    
    The address of the owner initiating the withdrawal. This should be the signer of the transaction.
  - receiver: string
    
    The address of the receiver to which the withdrawn assets will be sent.
Returns Promise<ContractTransactionResponse>
A promise that resolves to a transaction response. This contains details of the transaction such as block number, transaction hash etc.
- Defined in src/api/vaultAPI.ts:630

Class VaultAPI

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

premia: Premia

Returns VaultAPI

Properties

Readonly premia

Methods

balanceOfAssets

Parameters

vaultAddress: string

owner: string

Returns Promise<bigint>

balanceOfShares

Parameters

vaultAddress: string

owner: string

Returns Promise<bigint>

cancelQuoteStream

Parameters

assets: string[]

isCall: boolean

isBuy: boolean

Returns Promise<void>

convertToAssets

Parameters

vaultAddress: string

shares: BigNumberish

Returns Promise<bigint>

convertToShares

Parameters

vaultAddress: string

assets: BigNumberish

Returns Promise<bigint>

deposit

Throws

Parameters

vaultAddress: string

options: { assets: BigNumberish; receiver: string; }

assets: BigNumberish

receiver: string

Returns Promise<ContractTransactionResponse>

encodeDeposit

Throws

Parameters

vaultAddress: string

options: { assets: BigNumberish; receiver: string; }

assets: BigNumberish

receiver: string

Returns Promise<ContractTransaction>

encodeRedeem

Method

Parameters

vaultAddress: string

options: { owner: string; receiver: string; shares: BigNumberish; }

owner: string

receiver: string

shares: BigNumberish

Returns Promise<ContractTransaction>

encodeTrade

Throws

Parameters

vaultAddress: string

options: { isBuy: boolean; poolKey: PoolKey; premiumLimit: BigNumberish; referrer?: string; size: BigNumberish; }

isBuy: boolean

poolKey: PoolKey

premiumLimit: BigNumberish

Optional referrer?: string

size: BigNumberish

Returns Promise<ContractTransaction>

encodeWithdraw

Throws

Parameters

vaultAddress: string

`Readonly` premia

options: {
assets: BigNumberish;
receiver: string;
}

options: {
assets: BigNumberish;
receiver: string;
}

options: {
owner: string;
receiver: string;
shares: BigNumberish;
}

options: {
isBuy: boolean;
poolKey: PoolKey;
premiumLimit: BigNumberish;
referrer?: string;
size: BigNumberish;
}

`Optional` referrer?: string

options: {
assets: BigNumberish;
owner: string;
receiver: string;
}