Function liquidatePTB

liquidatePTB(
    tx: Transaction,
    payAsset: AssetIdentifier,
    payCoinObject: CoinObject,
    collateralAsset: AssetIdentifier,
    liquidateAddress: string | TransactionResult,
    options?: Partial<EnvOption & MarketOption & ServiceEndpointOption>,
): Promise<{ $kind: "NestedResult"; NestedResult: [number, number] }[]>
Create a liquidation transaction in the PTB (Programmable Transaction Block)

This function allows liquidators to liquidate a borrower's position by repaying their debt in exchange for their collateral. The liquidation process uses flash loans to ensure atomic execution of the liquidation transaction.
Parameters
- tx: Transaction
  The transaction block to add the liquidation operation to
- payAsset: AssetIdentifier
  Asset identifier for the debt being repaid
- payCoinObject: CoinObject
  Coin object containing the debt repayment amount
- collateralAsset: AssetIdentifier
  Asset identifier for the collateral being liquidated
- liquidateAddress: string | TransactionResult
  Address of the borrower being liquidated
- Optionaloptions: Partial<EnvOption & MarketOption & ServiceEndpointOption>
  Optional environment configuration
Returns Promise<{ $kind: "NestedResult"; NestedResult: [number, number] }[]>
Tuple containing [collateralBalance, remainDebtBalance] where: - collateralBalance: The collateral received from liquidation - remainDebtBalance: Any remaining debt after liquidation

Throws
Error if either pay asset or collateral asset does not support flash loans
- Defined in packages/lending/src/liquidate.ts:41

Function liquidatePTB

Parameters

Returns Promise<{ $kind: "NestedResult"; NestedResult: [number, number] }[]>

Throws

Settings