import { AssetType, ChainId, Timestamp, Token, TokenAmount, TxCall } from "./primitives.js";
import { ChainScopedFilter, Filterable } from "./filters.js";
import { CreditOperationMarket } from "./previews.js";
import { Address } from "viem";
//#region src/model/liquidations.d.ts
/**
 * Optional narrowing of a liquidatable accounts list.
 *
 * Every condition is optional and an omitted one matches any value, so an
 * empty filter is the same as no filter at all. A condition can also be set to
 * `"all"` to say the same thing explicitly, which is what a UI whose state has
 * an "any" option holds, see {@link Filterable}. Conditions combine with AND.
 **/
export interface LiquidatableAccountFilter extends ChainScopedFilter {
  /**
   * Keep only accounts whose underlying — the token of
   * {@link LiquidatableAccount.totalValue} — is of this class.
   **/
  underlyingType?: Filterable<AssetType>;
  /**
   * Keep only accounts of paused credit facades, or only of unpaused ones.
   **/
  paused?: Filterable<boolean>;
  /**
   * Keep only accounts in markets that accept RWA collateral, or only the ones
   * outside them.
   **/
  rwa?: Filterable<boolean>;
  /**
   * Keep only accounts with (`true`) or without (`false`) delayed
   * (phantom-token) withdrawals.
   **/
  delayed?: Filterable<boolean>;
}
/**
 * A credit account that can be liquidated, with amounts precomputed for
 * manual liquidation.
 *
 * The market it lives in is named the same way every other credit result names
 * it — through {@link CreditOperationMarket} — so a liquidation screen labels
 * the manager, its curator and the discount from the row it already holds.
 **/
export interface LiquidatableAccount extends CreditOperationMarket {
  /**
   * Chain the account lives on.
   **/
  chainId: ChainId;
  /**
   * Credit account address.
   **/
  creditAccount: Address;
  /**
   * Main asset being liquidated: the most valuable enabled non-underlying
   * collateral token. For delayed-withdrawal phantom tokens, the source
   * asset (e.g. ACRED) is reported instead of the phantom token. Falls back
   * to the underlying when the account holds no other collateral.
   **/
  asset: Token;
  /**
   * Account total value. The token is the unwrapped asset (e.g. USDC) for
   * RWA credit managers (1:1 with the wrapped underlying), the credit
   * manager underlying otherwise.
   **/
  totalValue: TokenAmount;
  /**
   * Estimated amount the liquidator pays to fully liquidate the account:
   * {@link totalValue} less the premium the liquidator keeps, in the same
   * token.
   *
   * Not `totalValue * (1 - liquidationDiscount)`: {@link liquidationDiscount}
   * also carries the protocol's own liquidation fee, which comes out of what
   * the repayment covers rather than off what the liquidator pays.
   **/
  repaymentAmount: TokenAmount;
  /**
   * Estimated liquidator profit: the premium on {@link totalValue}, i.e.
   * `totalValue - repaymentAmount`, in the same token.
   **/
  estimatedProfit: TokenAmount;
  /**
   * `true` when the account holds a delayed-withdrawal phantom token above
   * dust, i.e. the liquidation transfers withdrawal redeemers into the
   * liquidator's ownership instead of instantly receivable tokens.
   **/
  isDelayed: boolean;
  /**
   * `true` when the credit manager's facade is paused. Liquidations of such
   * accounts only succeed for emergency liquidators approved in the market.
   **/
  paused: boolean;
  /**
   * Whether the account's market accepts real-world-asset collateral. Read
   * from a hardcoded per-chain list rather than from the chain.
   **/
  rwa: boolean;
  /**
   * Whether the account can be partially liquidated with default parameters.
   *
   * Independent of the liquidator: a KYC gate (e.g. Midas greenlist) is
   * reported by {@link LiquidationDetails.isLiquidatorEligible}, not here.
   *
   * A local estimate, not onchain read.
   **/
  isPartiallyLiquidatable: boolean;
}
/**
 * Whether a liquidatable account satisfies every condition of a filter.
 *
 * This is the single definition of what each condition means: every source
 * builds its rows first and runs them through here, so the chain and the
 * backend cannot disagree on what a filter selects.
 *
 * @param account - Row to test.
 * @param filter - Conditions to test against. An absent filter matches
 * anything.
 **/
export declare function matchesLiquidatableAccountFilter(account: LiquidatableAccount, filter?: LiquidatableAccountFilter): boolean;
/**
 * A token received directly from the credit account balance upon liquidation.
 **/
export interface InstantReceivedAsset extends TokenAmount {
  isDelayed: false;
}
/**
 * A token produced by a delayed withdrawal whose redeemer is transferred to
 * the liquidator upon liquidation.
 *
 * The amount is exact for claimable withdrawals, estimated for pending ones.
 **/
export interface DelayedReceivedAsset extends TokenAmount {
  isDelayed: true;
  /**
   * Redeemer contract transferred to the liquidator, from which the token
   * becomes claimable. `undefined` when the compressor does not report one.
   **/
  redeemer?: Address;
  /**
   * Estimated moment a pending withdrawal becomes claimable. `undefined`
   * means the withdrawal is claimable now.
   **/
  claimableAt?: Timestamp;
}
/**
 * A single asset the liquidator receives when liquidating an account.
 **/
export type ReceivedAsset = InstantReceivedAsset | DelayedReceivedAsset;
/**
 * ERC-20 approval the liquidator must grant before sending the liquidation
 * transaction.
 *
 * The token is the one the liquidator pays in: the credit manager underlying
 * for standard and partial liquidations, the unwrapped stablecoin (e.g. USDC)
 * for RWA ones. The value is what the liquidator pays plus a 0.5% buffer: the
 * full liquidation amount is an estimate, and the partial one grows with the
 * interest accrued before the transaction is built.
 **/
export interface LiquidationApproval extends TokenAmount {
  /**
   * Address to approve
   **/
  spender: Address;
}
/**
 * A single delayed-withdrawal position owned by the liquidator.
 **/
export interface LiquidationPosition {
  /**
   * Discriminates this position from the other kinds a wallet can hold.
   **/
  kind: "liquidation";
  /**
   * Display name of the position.
   **/
  name: string;
  /**
   * Chain the withdrawal lives on.
   **/
  chainId: ChainId;
  /**
   * Source asset spent by the delayed withdrawal (e.g. ACRED).
   **/
  sourceToken: Token;
  /**
   * Receivable asset (e.g. USDC) and its amount: exact for claimable
   * withdrawals, estimated for pending ones.
   **/
  output: TokenAmount;
  /**
   * Estimated moment a pending withdrawal becomes claimable. `undefined`
   * means the withdrawal is claimable now.
   **/
  claimableAt?: Timestamp;
  /**
   * Transaction that claims the withdrawal. `undefined` for pending
   * withdrawals and when the compressor reports no claim call.
   **/
  claimTx?: TxCall;
  /**
   * Redeemer contract the withdrawal is claimed from, owned by the liquidator.
   * `undefined` on compressor versions below 313, which do not report it.
   **/
  redeemer?: Address;
}
/**
 * Detailed information about a liquidatable credit account, including
 * the full breakdown of assets the liquidator receives.
 *
 * Describes either a full liquidation, with exact amounts reported by the
 * liquidation compressor, or a partial one, whose amounts are a local estimate
 * from the synced oracle state.
 **/
export interface LiquidationDetails extends LiquidatableAccount {
  /**
   * Exact amount the liquidator pays for the liquidation, superseding
   * the estimate of {@link LiquidatableAccount}. The token is
   * {@link LiquidationApproval}'s, which for RWA markets is the
   * unwrapped stablecoin rather than {@link LiquidatableAccount.totalValue}'s
   * token; it falls back to the latter when nothing is pulled.
   **/
  repaymentAmount: TokenAmount;
  /**
   * Assets the liquidator receives: for a full liquidation, direct credit
   * account balances plus outputs of delayed withdrawals (claimable and
   * pending); for a partial one, the single seized collateral token.
   **/
  receivedAssets: ReceivedAsset[];
  /**
   * Whether the liquidator passes the KYC checks of the liquidated assets.
   * When the liquidator wallet was not provided, `false` only means that the
   * liquidation is KYC-gated, not that a particular wallet was rejected.
   **/
  isLiquidatorEligible: boolean;
  /**
   * `true` when the credit account is frozen by the RWA factory
   * (`isFrozen`) and cannot move its RWA collateral. Always `false` for
   * non-RWA liquidation paths.
   **/
  isCreditAccountFrozen: boolean;
  /**
   * Name of the KYC protocol the liquidator must be whitelisted in
   * (e.g. `"securitize"`). `undefined` when the liquidation is not KYC-gated.
   **/
  kycProtocol?: string;
  /**
   * Token the liquidator must be whitelisted for in {@link kycProtocol}.
   * `undefined` when the liquidation is not KYC-gated, and when the token is
   * not in the SDK's token registry.
   **/
  kycToken?: Token;
  /**
   * ERC-20 approval required before sending the liquidation transaction.
   * `undefined` when the selected liquidation path needs no capital from the
   * liquidator, i.e. {@link repaymentAmount} is zero.
   **/
  approve?: LiquidationApproval;
  /**
   * `true` for the details of a partial liquidation, whose
   * {@link LiquidatableAccount.isPartiallyLiquidatable} reflects the
   * parameters it was requested with.
   **/
  isPartial: boolean;
}
//#endregion