Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LiquidityPoolClient

Controls interaction with the Kolibri Liquidity Pool.

Hierarchy

  • LiquidityPoolClient

Index

Constructors

Properties

Methods

Constructors

constructor

  • new LiquidityPoolClient(nodeUrl: string, wallet: InMemorySigner | TempleWallet, liquidityPoolAddress: string): LiquidityPoolClient

  • Create a new Liquidity Pool Client.

    Parameters

    • nodeUrl: string

      The URL of the node to connect to.

    • wallet: InMemorySigner | TempleWallet

      The wallet which will interact with this Oven.

    • liquidityPoolAddress: string

      The address of the Kolibri Liquidity Pool.

    Returns LiquidityPoolClient

Properties

Readonly liquidityPoolAddress

liquidityPoolAddress: string

Private Readonly tezos

tezos: TezosToolkit

A TezosToolkit

Methods

liquidate

  • liquidate(targetOvenAddress: string): Promise<TransactionWalletOperation | TransactionOperation>

  • Liquidate an Oven using the liquidity pool.

    Parameters

    • targetOvenAddress: string

      The oven to liquidate.

    Returns Promise<TransactionWalletOperation | TransactionOperation>

    The operation hash

Generated using TypeDoc