Liquidation

This section covers the liquidation functionality for underfunded accounts.

liquidate

Liquidates an underfunded account.

function liquidate(address account) external

Parameters

• account (address): The address of the account to liquidate

Description

Allows anyone to liquidate an account that has insufficient funds to cover its streaming obligations. The liquidator receives a reward for performing the liquidation.

Example

// Liquidate an underfunded account
await papayaContract.liquidate("0xunderfunded...");

Related Events

• Liquidated: Emitted when an account is liquidated

Related Errors

• NotLiquidatable: When the account cannot be liquidated

• InsufficientBalance: When the account has insufficient balance for liquidation