Class CatalystSDKAbstract

constructor

• new CatalystSDK(catalystNetwork): CatalystSDK

• Parameters

  • catalystNetwork: CatalystNetwork

  Returns CatalystSDK

Optional address

Readonly addresses

catalystNetwork

Static Readonly CATALYST_VERSION

Abstract describerModule

• get describerModule(): IDescriberModule

• Returns IDescriberModule

Abstract registryModule

• get registryModule(): RegistryModule

• Returns RegistryModule

Abstract tokensModule

• get tokensModule(): ITokensModuleExtended

• Returns ITokensModuleExtended

Abstract vaultsModule

• get vaultsModule(): IVaultsModule

• Returns IVaultsModule

Abstract calcReceiveAsset

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

• Determine the asset output from a given swap output

  Parameters

  • vault: string

    target catalyst vault address
  • to: string

    token received from the pool
  • units: bigint

    swap amount in liquidity units

  Returns Promise<bigint>

  output amount in tokens

Abstract calcSendAsset

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

• Determine the liquidity output from a given swap input

  Parameters

  • vault: string

    target catalyst vault address
  • from: string

    token swapped into the pool
  • amount: bigint

    swap amount in tokens

  Returns Promise<bigint>

  output amount in liquidity units

Abstract checkAllowance

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

• Check the amount of tokens a given account has permitted another account to transfer.

  Parameters

  • token: string

    token address to check for allowance
  • owner: string

    holder of tokens
  • spender: string

    mover of tokens

  Returns Promise<bigint>

  the amount of tokens the spender may transfer

Abstract checkBalance

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

• Retrieve token balance for an account

  Parameters

  • token: string

    address to check
  • owner: string

    account to check

  Returns Promise<bigint>

  account balance of tokens

Abstract checkBalances

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

• Retrieve token balances for an account

  Parameters

  • tokens: string[]

    list of addresses to check
  • owner: string

    account to check

  Returns Promise<Record<string, bigint>>

  account balances of requested tokens

Abstract checkPermitAmount

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

• Check the amount of tokens that a given account has permitted another account to spend using permit2.

  Parameters

  • token: string

    token address to check for allowance
  • owner: string

    holder of tokens
  • spender: string

    mover of tokens

  Returns Promise<bigint>

  the max amount of tokens the spender can transfer

Abstract 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>>

  transaction hash for the initiated vault deployment

Abstract depositMixed

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

• Deposit mixed tokens into a given vault. Provided tokens amounts must match the input length and ordinal position of the desired deposit tokens.

  Parameters

  • vault: string

    target vault address
  • tokenAmounts: bigint[]

    array of index correlated deposit values
  • minOut: bigint

    minimum number of liquidity tokens received from deposit

  Returns Promise<SdkResponse>

  transaction hash of the initiated deposit

Abstract ensureAllowance

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

• Check if an account has permission to spend a given amount of tokens, and if not, attempt to increase the allowance for the spender.

  Parameters

  • token: string

    The address of the token contract.
  • owner: string

    The address of the token owner (account that holds the tokens).
  • spender: string

    The address of the account that needs to be approved to spend the tokens.
  • amount: bigint

    The amount of tokens that the spender needs to be allowed to spend.
  • Optional options: TransactionOptions

    Optional. Transaction options for the allowance approval operation.

  Returns Promise<undefined | SdkResponse>

  A Promise that resolves to either: - An SdkResponse object representing the transaction for ensuring the allowance, or - undefined if the allowance was already sufficient or the operation failed.

Abstract ensurePermit2Allowance

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

• Ensures that the Permit2 address has the required allowance for the given token.

  Parameters

  • token: string

    The address of the token for which the allowance should be checked.
  • Optional options: TransactionOptions

    Optional. Transaction options for the allowance approval operation.

  Returns Promise<undefined | SdkResponse>

  A Promise that resolves to either: - An SdkResponse object representing the transaction for ensuring the Permit2 allowance, or - undefined if the allowance was already sufficient or the operation failed.

Abstract estimateGasForExecuteInstructions

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

• Estimates the gas limit required to execute the given instructions on the Catalyst router.

  Parameters

  • instructions: ExecutionInstructions

    Execution instructions encoded for the router
  • Optional gasAmount: bigint

    Optional parameter, required to send native tokens with a transaction
  • Optional options: TransactionOptions

    Optional transaction options

  Returns Promise<bigint>

  Estimated gas limit (a bigint) required for executing the instructions

  Throws

  Error if the estimation fails, which can happen when the source chain is experiencing high traffic

Abstract finishSetup

• finishSetup(vault): Promise<SdkResponse>

• Finish the setup of the requested vault.

  Parameters

  • vault: string

    target vault address

  Returns Promise<SdkResponse>

  transaction hash for the finish setup request

Abstract generatePermitBatchData

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

• Increase the amount of tokens a given account has permitted another account to spend using permit2 for multiple tokens.

  Parameters

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

    An array of objects containing the token address, the amount by which the permit should be increased. Amount is optional and defaults to uint160 max value.
  • spender: string

    The address of the account that is permitted to spend the tokens.

  Returns Promise<PermitBatchData>

  A Promise that resolves to the batch permit data for the increased permit amounts request.

Abstract generatePermitData

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

• Generate the Permit2 signature and permit data for increasing the token transfer amount for a given account for a single token.

  Parameters

  • token: string

    The address of the token for which the permit amount is to be increased.
  • spender: string

    The address of the account that is permitted to spend the tokens.
  • Optional amount: bigint

    Optional. The amount by which the permit should be increased. Defaults to uint160 max value.

  Returns Promise<PermitData>

  A Promise that resolves to the permit data for the increased permit amount request.

Abstract getBalance

• getBalance(address): Promise<bigint>

• Get the connected accountus native token balance.

  Parameters

  • address: string

    Address to get balance

  Returns Promise<bigint>

  Native token balance

Abstract getFeeData

• getFeeData(): Promise<FeeData>

• Get the chain current base gas price.

  Returns Promise<FeeData>

  base gas price in wei

Abstract getUnitCapacity

• getUnitCapacity(vault): Promise<bigint>

• Get the security limit capacity for a given vault.

  Parameters

  • vault: string

    target catalyst vault address

  Returns Promise<bigint>

  security limit of target vault

Abstract increaseAllowance

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

• Increase the amount of tokens a given account has approved another account to transfer.

  Parameters

  • token: string

    token address for which allowance is being increased
  • spender: string

    mover of tokens
  • amount: bigint

    amount of tokens to approve
  • Optional options: TransactionOptions

  Returns Promise<SdkResponse>

  sdk response for the increase allowance request

Abstract revoke

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

• Set the amount of tokens a given account has permitted another account to transfer to zero.

  Parameters

  • token: string

    token address to check for allowance
  • spender: string

    mover of tokens

  Returns Promise<SdkResponse>

  sdk response for the revoke request

Abstract sendAsset

• sendAsset(options): Promise<SdkResponse>

• Initiate a cross chain swap

  Parameters

  • options: SendAssetOptions

    input parameters, see SendAssetOptions

  Returns Promise<SdkResponse>

  transaction hash of the initiated send

Abstract sendAssetFromQuote

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

• Initiate a cross chain swap

  Parameters

  • quote: PriceQuote
  • toAccount: string

    account to swap funds to
  • fallbackUser: string

    account to return funds to in case of swap failure
  • Optional callData: string

    optional call data for post swap integrations

  Returns Promise<SdkResponse>

  transaction hash of the initiated send

Abstract sendAssetWithRouter

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

• Send assets with instructions to the Catalyst router.

  Parameters

  • instructions: ExecutionInstructions

    execution instructions encoded for the router
  • Optional gasAmount: bigint

    optional parameter, required to send native tokens with a transaction
  • Optional options: TransactionOptions

  Returns Promise<SdkResponse>

  transaction hash of the initiated send

Abstract sendAssetWithRouterFromQuote

• sendAssetWithRouterFromQuote(quote): Promise<SdkResponse>

• Send assets with instructions to the Catalyst router from a provided quote.

  Parameters

  • quote: PriceQuote

    price quote provided from api

  Returns Promise<SdkResponse>

  transaction hash of the initiated send

Abstract setConnection

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

• Set a connection to a given vault via a channel ID in the requested state.

  Parameters

  • vault: string

    target catalyst vault
  • toVault: string

    target destination vault
  • channelId: string

    requested channel id to establish connection
  • isActive: boolean

    parameter to activate or deactive the given channel

  Returns Promise<SdkResponse>

  transaction hash for the initiation set connection

Abstract signMessage

• signMessage(message): Promise<string>

• Sign a given message.

  Parameters

  • message: string

    any message string signed using the sdk signing key

  Returns Promise<string>

  string representing a signed variant of the original message

Abstract signTypedData

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

• Sign typed data according to the EIP-712 specification.

  Parameters

  • domain: TypedDataDomain | TypedDataDomain

    The domain separator data for the typed data.
  • types: Record<string, TypedDataField[] | TypedDataField[]>

    The type definitions for the typed data.
  • value: Record<string, any>

    The value of the typed data to be signed.

  Returns Promise<string>

  A promise that resolves to the signed typed value.

Abstract withdrawAll

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

• Withdraw mixed tokens in proportion from a given vault.

  Parameters

  • vault: string

    target vault address
  • poolTokens: bigint

    number of pool tokens to redeem for underlying assets
  • minOut: bigint[]

    array of index correlated withdraw values specifying minimum acceptable withdraw amounts

  Returns Promise<SdkResponse>

  transaction hash of the intiated mixed withdraw

Abstract withdrawMixed

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

• Withdraw mixed tokens in specified ratios from a given vault.

  Parameters

  • vault: string

    target vault address
  • poolTokens: bigint

    number of pool tokens to redeem for underlying assets
  • withdrawRatio: bigint[]

    array of index correlated ratios specifying the weights for withdraw of the specific vault
  • minOut: bigint[]

    array of index correlated ratios specifying minimum acceptable withdraw amounts

  Returns Promise<SdkResponse>

  array of index correlated withdraw values