Class EvmVaultsModule

Implements

IVaultsModule

Index

Constructors

Properties

Methods

calcReceiveAsset calcSendAsset deployVault depositMixed estimateGasForExecuteInstructions finishSetup getUnitCapacity sendAsset sendAssetFromQuote sendAssetWithRouter sendAssetWithRouterFromQuote setConnection withdrawAll withdrawMixed

Constructors

constructor

new EvmVaultsModule(sdk): EvmVaultsModule
Parameters
- sdk: EvmSDK
Returns EvmVaultsModule
- Defined in catalyst-sdk/src/evm/evm-vaults.module.ts:25

Properties

`Private` sdk

Methods

calcReceiveAsset

calcReceiveAsset(vault, to, units): Promise<bigint>
See CatalystSDK.calcReceiveAsset
Parameters
- vault: string
- to: string
- units: bigint
Returns Promise<bigint>
Implementation of IVaultsModule.calcReceiveAsset
- Defined in catalyst-sdk/src/evm/evm-vaults.module.ts:372

calcSendAsset

calcSendAsset(vault, from, amount): Promise<bigint>
See CatalystSDK.calcSendAsset
Parameters
- vault: string
- from: string
- amount: bigint
Returns Promise<bigint>
Implementation of IVaultsModule.calcSendAsset
- Defined in catalyst-sdk/src/evm/evm-vaults.module.ts:358

deployVault

deployVault(options): Promise<SdkResult<string>>
Deploy a vault with given parameters into the Catalyst liquidity network.
Parameters
- options: DeployVaultOptions
  See DeployVaultOptions
Returns Promise<SdkResult<string>>
Implementation of IVaultsModule.deployVault
- Defined in catalyst-sdk/src/evm/evm-vaults.module.ts:31

depositMixed

depositMixed(vault, tokenAmounts, minOut): Promise<SdkResponse>
See CatalystSDK.depositMixed
Parameters
- vault: string
- tokenAmounts: bigint[]
- minOut: bigint
Returns Promise<SdkResponse>
Implementation of IVaultsModule.depositMixed
- Defined in catalyst-sdk/src/evm/evm-vaults.module.ts:386

estimateGasForExecuteInstructions

estimateGasForExecuteInstructions(instructions, gasAmount?, options?): Promise<bigint>
See CatalystSDK.estimateGasForExecuteInstructions
Parameters
- instructions: ExecutionInstructions
- Optional gasAmount: bigint
- Optional options: TransactionOptions
Returns Promise<bigint>
Implementation of IVaultsModule.estimateGasForExecuteInstructions
- Defined in catalyst-sdk/src/evm/evm-vaults.module.ts:216

finishSetup

finishSetup(vault): Promise<SdkResponse>
See CatalystSDK.finishSetup
Parameters
- vault: string
Returns Promise<SdkResponse>
Implementation of IVaultsModule.finishSetup
- Defined in catalyst-sdk/src/evm/evm-vaults.module.ts:140

getUnitCapacity

getUnitCapacity(vault): Promise<bigint>
See CatalystSDK.getUnitCapacity
Parameters
- vault: string
Returns Promise<bigint>
Implementation of IVaultsModule.getUnitCapacity
- Defined in catalyst-sdk/src/evm/evm-vaults.module.ts:462

sendAsset

sendAsset(__namedParameters): Promise<SdkResponse>
See CatalystSDK.sendAsset
Parameters
- __namedParameters: SendAssetOptions
Returns Promise<SdkResponse>
Implementation of IVaultsModule.sendAsset
- Defined in catalyst-sdk/src/evm/evm-vaults.module.ts:270

sendAssetFromQuote

sendAssetFromQuote(__namedParameters, toAccount, fallbackUser, callData?): Promise<SdkResponse>
See CatalystSDK.sendAssetFromQuote
Parameters
- __namedParameters: PriceQuote
- toAccount: string
- fallbackUser: string
- Optional callData: string
Returns Promise<SdkResponse>
Implementation of IVaultsModule.sendAssetFromQuote
- Defined in catalyst-sdk/src/evm/evm-vaults.module.ts:327

sendAssetWithRouter

sendAssetWithRouter(instructions, gasAmount?, options?): Promise<SdkResponse>
See CatalystSDK.sendAssetWithRouter
Parameters
- instructions: ExecutionInstructions
- Optional gasAmount: bigint
- Optional options: TransactionOptions
Returns Promise<SdkResponse>
Implementation of IVaultsModule.sendAssetWithRouter
- Defined in catalyst-sdk/src/evm/evm-vaults.module.ts:162

sendAssetWithRouterFromQuote

sendAssetWithRouterFromQuote(quote): Promise<SdkResponse>
See CatalystSDK.sendAssetWithRouterFromQuote
Parameters
- quote: PriceQuote
Returns Promise<SdkResponse>
Implementation of IVaultsModule.sendAssetWithRouterFromQuote
- Defined in catalyst-sdk/src/evm/evm-vaults.module.ts:259

setConnection

setConnection(vault, toVault, channelId, isActive): Promise<SdkResponse>
See CatalystSDK.setConnection
Parameters
- vault: string
- toVault: string
- channelId: string
- isActive: boolean
Returns Promise<SdkResponse>
Implementation of IVaultsModule.setConnection
- Defined in catalyst-sdk/src/evm/evm-vaults.module.ts:108

withdrawAll

withdrawAll(vault, poolTokens, minOut): Promise<SdkResponse>
See CatalystSDK.withdrawAll
Parameters
- vault: string
- poolTokens: bigint
- minOut: bigint[]
Returns Promise<SdkResponse>
Implementation of IVaultsModule.withdrawAll
- Defined in catalyst-sdk/src/evm/evm-vaults.module.ts:411

withdrawMixed

withdrawMixed(vault, poolTokens, withdrawRatio, minOut): Promise<SdkResponse>
See CatalystSDK.withdrawMixed
Parameters
- vault: string
- poolTokens: bigint
- withdrawRatio: bigint[]
- minOut: bigint[]
Returns Promise<SdkResponse>
Implementation of IVaultsModule.withdrawMixed
- Defined in catalyst-sdk/src/evm/evm-vaults.module.ts:436