Get Boost Liquidity

getBoostLiquidity

Returns the list of available boost pools and their respective depths.

The returned list can be filtered by feeTierBps or asset, chain

asset
chain
feeTierBps

  async getBoostLiquidity(
    params:
      | { feeTierBps?: number }
      | {
          feeTierBps?: number;
          asset: Asset;
          chain: Chain;
        } = {},
  ): Promise<BoostPoolDepth[]>

Param	Description	Data type
`feeTierBps`(optional)	Allows filtering of the returned list of boost pools based on their fee tier (bps)	`number`
`chain, asset`(optional)	Allows filtering of the returned list of boost pools based on their chain asset	`Chain, Asset`

Example - no filtering

If no chain, asset or feeTierBps is provided, it returns the full list of available boost pools with their respective depths.

console.log(await swapSDK.getBoostLiquidity());

Sample Response

[
  // ...
  {
    availableAmount: 0n,
    feeTierBps: 5,
    chain: 'Ethereum',
    asset: 'FLIP'
  },
  {
    availableAmount: 0n,
    feeTierBps: 10,
    chain: 'Ethereum',
    asset: 'USDT'
  },
  {
    availableAmount: 0n,
    feeTierBps: 5,
    chain: 'Ethereum',
    asset: 'USDC'
  },
  {
    availableAmount: 0n,
    feeTierBps: 5,
    chain: 'Polkadot',
    asset: 'DOT'
  },
  {
    availableAmount: 450695350n,
    feeTierBps: 5,
    chain: 'Bitcoin',
    asset: 'BTC'
  },
  {
    availableAmount: 0n,
    feeTierBps: 5,
    chain: 'Arbitrum',
    asset: 'USDC'
  },
  {
    availableAmount: 0n,
    feeTierBps: 5,
    chain: 'Arbitrum',
    asset: 'ETH'
  },
  // ...
]

Example - filtering by chain asset

If a valid combination of chain, asset is provided, it returns the available boost pools for that specific chain asset.

console.log(await sdk.getBoostLiquidity({
  asset: 'BTC',
  chain: 'Bitcoin',
}));

Sample Response

[
  {
    availableAmount: 300000000n,
    feeTierBps: 30,
    chain: 'Bitcoin',
    asset: 'BTC'
  },
  {
    availableAmount: 450149304n,
    feeTierBps: 10,
    chain: 'Bitcoin',
    asset: 'BTC'
  },
  {
    availableAmount: 450695350n,
    feeTierBps: 5,
    chain: 'Bitcoin',
    asset: 'BTC'
  }
]

Example - filtering by fee tier (bps)

If a feeTierBps is provided, it returns the available boost pools for that specific fee tier.

console.log(await sdk.getBoostLiquidity({
  feeTierBps: 5
}));

Sample Response

[
  // ...
  {
    availableAmount: 450695350n,
    feeTierBps: 5,
    chain: 'Bitcoin',
    asset: 'BTC'
  },
  // ...
]

Working Examples Get channel opening fees