Class EvmSDK

constructor

• new EvmSDK(options): EvmSDK

• Parameters

  • options: EvmOptions

  Returns EvmSDK

Readonly describerModule

provider

Readonly registryModule

Optional signer

Readonly tokensModule

Readonly vaultsModule

calcReceiveAsset

• calcReceiveAsset(vault, to, units): Promise<bigint>

• See CatalystSDK.calcReceiveAsset

  Parameters

  • vault: string
  • to: string
  • units: bigint

  Returns Promise<bigint>

calcSendAsset

• calcSendAsset(vault, from, amount): Promise<bigint>

• See CatalystSDK.calcSendAsset

  Parameters

  • vault: string
  • from: string
  • amount: bigint

  Returns Promise<bigint>

checkAllowance

• checkAllowance(token, owner, spender): Promise<bigint>

• See CatalystSDK.checkAllowance

  Parameters

  • token: string
  • owner: string
  • spender: string

  Returns Promise<bigint>

checkBalance

• checkBalance(token, owner): Promise<bigint>

• See CatalystSDK.checkBalance

  Parameters

  • token: string
  • owner: string

  Returns Promise<bigint>

checkBalances

• checkBalances(tokens, owner): Promise<Record<string, bigint>>

• See CatalystSDK.checkBalances

  Parameters

  • tokens: string[]
  • owner: string

  Returns Promise<Record<string, bigint>>

checkPermitAmount

• checkPermitAmount(token, owner, spender): Promise<bigint>

• See CatalystSDK.checkPermitAmount

  Parameters

  • token: string
  • owner: string
  • spender: string

  Returns Promise<bigint>

connectSigner

• connectSigner(signer): Promise<void>

• Connect a signer to enable write operations

  Parameters

  • signer: EvmSigner

    evm compliant signer implementation

  Returns Promise<void>

deployVault

• deployVault(options): Promise<SdkResult<string>>

• See CatalystSDK.deployVault

  Parameters

  • options: DeployVaultOptions

  Returns Promise<SdkResult<string>>

depositMixed

• depositMixed(vault, tokenAmounts, minOut): Promise<SdkResponse>

• See CatalystSDK.depositMixed

  Parameters

  • vault: string
  • tokenAmounts: bigint[]
  • minOut: bigint

  Returns Promise<SdkResponse>

ensureAllowance

• ensureAllowance(token, owner, spender, amount, options?): Promise<undefined | SdkResponse>

• See CatalystSDK.ensureAllowance

  Parameters

  • token: string
  • owner: string
  • spender: string
  • amount: bigint
  • Optional options: TransactionOptions

  Returns Promise<undefined | SdkResponse>

ensurePermit2Allowance

• ensurePermit2Allowance(token, options?): Promise<undefined | SdkResponse>

• See CatalystSDK.ensurePermit2Allowance

  Parameters

  • token: string
  • Optional options: TransactionOptions

  Returns Promise<undefined | SdkResponse>

estimateGasForExecuteInstructions

• estimateGasForExecuteInstructions(instructions, gasAmount?, options?): Promise<bigint>

• See CatalystSDK.estimateGasForExecuteInstructions

  Parameters

  • instructions: ExecutionInstructions
  • Optional gasAmount: bigint
  • Optional options: TransactionOptions

  Returns Promise<bigint>

finishSetup

• finishSetup(vault): Promise<SdkResponse>

• See CatalystSDK.finishSetup

  Parameters

  • vault: string

  Returns Promise<SdkResponse>

generatePermitBatchData

• generatePermitBatchData(assets, spender): Promise<PermitBatchData>

• See CatalystSDK.generatePermitBatchData

  Parameters

  • assets: {
        amount?: bigint;
        token: string;
    }[]
  • spender: string

  Returns Promise<PermitBatchData>

generatePermitData

• generatePermitData(token, spender, amount?): Promise<PermitData>

• See CatalystSDK.generatePermitData

  Parameters

  • token: string
  • spender: string
  • Optional amount: bigint

  Returns Promise<PermitData>

getBalance

• getBalance(address): Promise<bigint>

• See CatalystSDK.getBalance

  Parameters

  • address: string

  Returns Promise<bigint>

getFeeData

• getFeeData(): Promise<FeeData>

• See CatalystSDK.getBaseGasPrice

  Returns Promise<FeeData>

getUnitCapacity

• getUnitCapacity(vault): Promise<bigint>

• See CatalystSDK.getUnitCapacity

  Parameters

  • vault: string

  Returns Promise<bigint>

increaseAllowance

• increaseAllowance(token, spender, amount, options?): Promise<SdkResponse>

• See CatalystSDK.increaseAllowance

  Parameters

  • token: string
  • spender: string
  • amount: bigint
  • Optional options: TransactionOptions

  Returns Promise<SdkResponse>

revoke

• revoke(token, spender): Promise<SdkResponse>

• See CatalystSDK.revoke

  Parameters

  • token: string
  • spender: string

  Returns Promise<SdkResponse>

sendAsset

• sendAsset(options): Promise<SdkResponse>

• See CatalystSDK.sendAsset

  Parameters

  • options: SendAssetOptions

  Returns Promise<SdkResponse>

sendAssetFromQuote

• sendAssetFromQuote(quote, toAccount, fallbackUser, callData?): Promise<SdkResponse>

• See CatalystSDK.sendAssetFromQuote

  Parameters

  • quote: PriceQuote
  • toAccount: string
  • fallbackUser: string
  • Optional callData: string

  Returns Promise<SdkResponse>

sendAssetWithRouter

• sendAssetWithRouter(instructions, gasAmount?, options?): Promise<SdkResponse>

• See CatalystSDK.sendAssetWithRouter

  Parameters

  • instructions: ExecutionInstructions
  • Optional gasAmount: bigint
  • Optional options: TransactionOptions

  Returns Promise<SdkResponse>

sendAssetWithRouterFromQuote

• sendAssetWithRouterFromQuote(quote): Promise<SdkResponse>

• See CatalystSDK.sendAssetWithRouterFromQuote

  Parameters

  • quote: PriceQuote

  Returns Promise<SdkResponse>

setConnection

• setConnection(vault, toVault, channelId, isActive): Promise<SdkResponse>

• See CatalystSDK.setConnection

  Parameters

  • vault: string
  • toVault: string
  • channelId: string
  • isActive: boolean

  Returns Promise<SdkResponse>

signMessage

• signMessage(message): Promise<string>

• See CatalystSDK.signMessage

  Parameters

  • message: string

  Returns Promise<string>

signTypedData

• signTypedData(domain, types, value): Promise<string>

• See CatalystSDK.signTypedData

  Parameters

  • domain: TypedDataDomain
  • types: Record<string, TypedDataField[]>
  • value: Record<string, any>

  Returns Promise<string>

updateProvider

• updateProvider(options): void

• Updates a provider utilized by the SDK. This can be used to manually change the network the SDK is connected to, or in the cause of faulty or failing RPC to change the target for requests.

  Parameters

  • options: EvmOptions

    rpc provider options

  Returns void

withdrawAll

• withdrawAll(vault, poolTokens, minOut): Promise<SdkResponse>

• See CatalystSDK.withdrawAll

  Parameters

  • vault: string
  • poolTokens: bigint
  • minOut: bigint[]

  Returns Promise<SdkResponse>

withdrawMixed

• withdrawMixed(vault, poolTokens, withdrawRatio, minOut): Promise<SdkResponse>

• See CatalystSDK.withdrawMixed

  Parameters

  • vault: string
  • poolTokens: bigint
  • withdrawRatio: bigint[]
  • minOut: bigint[]

  Returns Promise<SdkResponse>