Liquidate Contract
Users use the liquidate contract to liquidate underwater accounts where the health factor has dropped below 1. Users will be able to liquidate loans by selling the liquidated users collateral or by repaying the borrowed asset normally.
Request
1
{
2
userPublicKey: string,
3
timestamp: number,
4
type: ProtocolEventTypes,
5
liquidateeId: string,
6
repayments: BalanceLine[],
7
withdrawals: BalanceLine[],
8
targetPool: string,
9
backstopOrder: string[],
10
collateralRepayments?: RepayPath[]
11
}
Copied!
Fields:
  • liquidateeId: public key of the account being liquidated
  • repayments: array of BalanceLine's that represent the assets and amounts being repaid. assetId's are expected to be liability tokens.
  • withdrawals: array of BalanceLine's that represent the assets and amounts being repaid. assetId's are expected to be pool tokens.
  • targetPool: Id of the pool associated with the assets being repaid.
  • backstopOrder: Array of assetId's.
  • collateralRepayments (OPTIONAL): Array of RepayPath's describing how to structure the pathPayments that will be used to liquidate collateral withdrawn. These are only input if the liquidator is partially or fully liquidating with collateral.

High-Level Contract Process Flow (MAY BE OUT OF DATE)

  1. 1.
    User enters the contract through an event handler which transforms their request.
  2. 2.
    Contract prerequisite data from horizon.
    1. 1.
      Pool Account Data
    2. 2.
      User Account Data
    3. 3.
      User Position Data
  3. 3.
    Contract builds a transaction builder object.
    1. 1.
      This is the object operations will be added to throughout the rest of the contract process flow.
  4. 4.
    Contract populates all withdrawals and repayments for the liquidation based on the maxLiquidation calculations and the users repayment and withdrawal inputs. It also calculates whether or not a backstop repayment is necessary.
  5. 5.
    Contract handle withdrawals.
    1. 1.
      Contract adds claimClaimableBalance operations where the pool claims the withdrawn collateral balances.
      1. 1.
        Contract also calculates all unclaimed YBX issuance associated with these collateral balances.
    2. 2.
      If the user is not fully withdrawing the contract adds a createClaimableBalance operation where the user recreates the collateral position with the remaining collateral.
      1. 1.
        Escrow account sponsors these. The contract also adds payment operations where the user pays XLM to the escrow account so they have the funds to sponsor the claimable balances.
    3. 3.
      If the user is not repaying with collateral the contract adds payment operations where the pool pays all withdrawn pool tokens to the user.
    4. 4.
      If the user is repaying with collateral the contract burns all withdrawn pool tokens.
      1. 1.
        It first calculates the pool tokens' value including the withdrawal fee.
        1. 1.
          Contract adds pathPayment operations where the pool uses the withdrawal fees to repurchase YBX and sends it to the escrow account.
      2. 2.
        Contract adds payment operations where the pool sends the value of the pool token from the pool to the user.
  6. 6.
    The contract handles repayments.
    1. 1.
      Contract adds payment operations where the user pays the repayment to the pool.
      1. 1.
        If the user is repaying with collateral the contract instead adds pathPaymentStrictReceives where the user uses the withdrawn assets to repurchase the repayment asset and sends it to the pool.
    2. 2.
      Contract adds a claimClaimableBalance operation where the pool claims the associated liability balance.
      1. 1.
        Contract adds accrued interest to the relevant liability balance.
      2. 2.
        Contract also calculates all unclaimed YBX issuance associated with these collateral balances.
      3. 3.
        If the liability was not fully repaid the contract adds a createClaimableBalance operation where the pool creates a liabilty claimable balance representing the remaining asset liability.
        1. 1.
          Escrow account sponsors these. The contract also adds payment operations where the user pays XLM to the escrow account so they have the funds to sponsor the claimable balances.
      4. 4.
        Contract calculates the YBX repurchases associated with the interest paid in the repayments and adds pathPaymentStrictSend operations that have the user purchase and send YBX to the escrow account with a portion of their interest payment.
  7. 7.
    If backstop repayments are necessary contract creates pathPaymentStrictReceive operations where the escrow account and issuing account sell YBX for the repayment asset and send it to the pool account.
  8. 8.
    Contract adds a payment option where the distribution account pays any unclaimed YBX from the previous calculations to the liquidated user.
  9. 9.
    Contract adds all necessary Utilization Tracker operations. See Average Utiization Ratios section.
  10. 10.
    Turret builds transaction builder into an XDR and returns it along with a signature.

Diagram

In the base liquidation scenario (no repay with collateral)

Liquidator Account: pays the pool 236.42 USDC and withdraws 716.015 yXLM from the liquidatee's collateral claimable balance (the pool claims it and pays it to the user, then remakes the claimable balance). The pool deletes a portion of the liquidated user's liability claimable balance to reflect the repayment. The liquidated user's new liability balance will be 263.58 USDC, and their new collateral balance will be 901.635 y00XLM.

In the repay with collateral liquidation scenario

Liquidator Account: withdraws 716.015 yXLM from the liquidatee's collateral claimable balance (the pool claims it and pays it to the user, then remakes the claimable balance). This is then converted to XLM and sold for 236.42 USDC, which is paid to the pool. The pool deletes a portion of the liquidated user's liability claimable balance to reflect the repayment. The liquidated user's new liability balance will be 263.58 USDC, and their new collateral balance will be 901.635 y00XLM.