@suilend/sdk 14.3.0 → 16.0.0

package/_generated/suilend/lending-market/functions.d.ts

@@ -247,6 +247,9 @@ export interface BorrowArgs {
  * This function will panic if:
  * * The `lending_market` version is not `CURRENT_VERSION` (EIncorrectVersion).
  * * The borrow amount is zero (ETooSmall).
+ * * The market is paused (EMarketPaused).
+ * * The reserve is paused (EReservePaused).
+ * * Borrow is held by `hold_operation_until` (EOperationHeld).
  * * The `coin_type` of the reserve does not match the type of the asset being borrowed (EWrongType).
  * * The reserve's price is stale (`EPriceStale` from the `reserve` module).
  * * The borrow would exceed the reserve's borrow limit (`EBorrowLimitExceeded` from the `reserve` module).
@@ -306,6 +309,9 @@ export interface BorrowRequestArgs {
  * This function will panic if:
  * * The `lending_market` version is not `CURRENT_VERSION` (EIncorrectVersion).
  * * The borrow amount is zero (ETooSmall).
+ * * The market is paused (EMarketPaused).
+ * * The reserve is paused (EReservePaused).
+ * * Borrow is held by `hold_operation_until` (EOperationHeld).
  * * The `coin_type` of the reserve does not match the type of the asset being borrowed (EWrongType).
  * * The reserve's price is stale (`EPriceStale` from the `reserve` module).
  * * The borrow would exceed the reserve's borrow limit (`EBorrowLimitExceeded` from the `reserve` module).
@@ -381,6 +387,10 @@ export interface WithdrawCtokensArgs {
  * This function will panic if:
  * * The `lending_market` version is not `CURRENT_VERSION` (EIncorrectVersion).
  * * The withdraw amount is zero (ETooSmall).
+ * * The market is paused (EMarketPaused).
+ * * The reserve is paused (EReservePaused).
+ * * Withdraw is held by `hold_operation_until` and the obligation is not exempted by
+ * `set_withdraw_hold_exempt` (EOperationHeld).
  * * The `coin_type` of the reserve does not match the type of the cTokens being withdrawn (EWrongType).
  * * The obligation has stale oracle prices.
  * * The withdrawal would leave the obligation in an unhealthy state.
@@ -423,6 +433,9 @@ export interface LiquidateArgs {
  * This function will panic if:
  * * The `lending_market` version is not `CURRENT_VERSION` (EIncorrectVersion).
  * * The repay amount is zero (ETooSmall).
+ * * The market is paused (EMarketPaused).
+ * * The repay or withdraw reserve is paused (EReservePaused).
+ * * Liquidate is held by `hold_operation_until` (EOperationHeld).
  * * The obligation is not unhealthy.
  * * The obligation has stale oracle prices.
  * * The `coin_type` of the repay reserve does not match the type of the repay coin.
@@ -594,13 +607,6 @@ export interface InitStakerArgs {
  * to participate in staking and earn rewards. It can only be called by the owner of the
  * lending market.
  *
- * # Arguments
- *
- * * `lending_market` - A mutable reference to the `LendingMarket`.
- * * `_` - The `LendingMarketOwnerCap` to authorize the operation.
- * * `sui_reserve_array_index` - The index of the SUI reserve to initialize the staker for.
- * * `treasury_cap` - The `TreasuryCap` for the staker.
- *
  * # Panics
  *
  * This function will panic if:
@@ -639,6 +645,16 @@ export interface RebalanceStakerArgs {
 export declare function rebalanceStaker(tx: Transaction, typeArg: string, args: RebalanceStakerArgs, options?: {
     env?: EnvConfig;
 }): TransactionResult;
+export interface SetStakerValidatorArgs {
+    lendingMarket: TransactionObjectInput;
+    lendingMarketOwnerCap: TransactionObjectInput;
+    suiReserveArrayIndex: bigint | TransactionArgument;
+    validator: string | TransactionArgument;
+    systemState: TransactionObjectInput;
+}
+export declare function setStakerValidator(tx: Transaction, typeArg: string, args: SetStakerValidatorArgs, options?: {
+    env?: EnvConfig;
+}): TransactionResult;
 export interface UnstakeSuiFromStakerArgs {
     lendingMarket: TransactionObjectInput;
     suiReserveArrayIndex: bigint | TransactionArgument;
@@ -681,6 +697,9 @@ export interface MaxBorrowAmountArgs {
 export declare function maxBorrowAmount(tx: Transaction, typeArg: string, args: MaxBorrowAmountArgs, options?: {
     env?: EnvConfig;
 }): TransactionResult;
+export declare function chargesRateLimiter(tx: Transaction, typeArg: string, reserve: TransactionObjectInput, options?: {
+    env?: EnvConfig;
+}): TransactionResult;
 export interface MaxWithdrawAmountArgs {
     rateLimiter: TransactionObjectInput;
     obligation: TransactionObjectInput;
@@ -810,14 +829,30 @@ export interface UpdateReserveConfigArgs {
  * Updates the configuration of a reserve.
  *
  * This function allows the owner of the lending market to update the configuration of a specific reserve.
- * It can only be called by the owner of the lending market.
+ * It can only be called by the owner of the lending market. Un-retiring a reserve clears its
+ * rate-limiter exemption and emits `ReserveRateLimiterExemptEvent`; retiring it again leaves it charged.
  *
- * # Arguments
+ * # Panics
  *
- * * `_` - The `LendingMarketOwnerCap` to authorize the operation.
- * * `lending_market` - A mutable reference to the `LendingMarket`.
- * * `reserve_array_index` - The index of the reserve to update.
- * * `config` - The new configuration for the reserve.
+ * This function will panic if:
+ * * The `lending_market` version is not `CURRENT_VERSION` (EIncorrectVersion).
+ * * `reserve_array_index` is out of bounds.
+ * * The `coin_type` of the reserve does not match the type `T` (EWrongType).
+ */
+export declare function updateReserveConfig(tx: Transaction, typeArgs: [string, string], args: UpdateReserveConfigArgs, options?: {
+    env?: EnvConfig;
+}): TransactionResult;
+export interface SetReserveRateLimiterExemptArgs {
+    lendingMarketOwnerCap: TransactionObjectInput;
+    lendingMarket: TransactionObjectInput;
+    reserveArrayIndex: bigint | TransactionArgument;
+    exempt: boolean | TransactionArgument;
+}
+/**
+ * Exempts a retired reserve's redeems from the market's rate limiter, or charges them
+ * again. An exempt reserve's max withdraw is not capped by the remaining outflow. A
+ * config update that gives the reserve any open or close LTV, deposit limit or borrow
+ * limit clears the exemption, so it never outlives the reserve's retirement.
  *
  * # Panics
  *
@@ -825,8 +860,9 @@ export interface UpdateReserveConfigArgs {
  * * The `lending_market` version is not `CURRENT_VERSION` (EIncorrectVersion).
  * * `reserve_array_index` is out of bounds.
  * * The `coin_type` of the reserve does not match the type `T` (EWrongType).
+ * * `exempt` is true and the reserve is not retired (EReserveNotRetired).
  */
-export declare function updateReserveConfig(tx: Transaction, typeArgs: [string, string], args: UpdateReserveConfigArgs, options?: {
+export declare function setReserveRateLimiterExempt(tx: Transaction, typeArgs: [string, string], args: SetReserveRateLimiterExemptArgs, options?: {
     env?: EnvConfig;
 }): TransactionResult;
 export interface SetReservePriceGuardArgs {
@@ -900,17 +936,6 @@ export interface AddPoolRewardArgs {
  * This function allows the owner of the lending market to incentivize users by adding rewards
  * to a specific reserve. The rewards are distributed over a specified time period.
  *
- * # Arguments
- *
- * * `_` - The `LendingMarketOwnerCap` to authorize the operation.
- * * `lending_market` - A mutable reference to the `LendingMarket`.
- * * `reserve_array_index` - The index of the reserve to add the reward pool to.
- * * `is_deposit_reward` - A boolean indicating whether the reward is for deposits (`true`) or borrows (`false`).
- * * `rewards` - The `Coin` containing the total amount of rewards to be distributed.
- * * `start_time_ms` - The timestamp in milliseconds when the reward distribution starts.
- * * `end_time_ms` - The timestamp in milliseconds when the reward distribution ends.
- * * `clock` - A reference to the `Clock`.
- *
  * # Panics
  *
  * This function will panic if:
@@ -936,15 +961,6 @@ export interface CancelPoolRewardArgs {
  * that is currently active. When a reward pool is cancelled, any unallocated rewards are
  * returned to the owner.
  *
- * # Arguments
- *
- * * `_` - The `LendingMarketOwnerCap` to authorize the operation.
- * * `lending_market` - A mutable reference to the `LendingMarket`.
- * * `reserve_array_index` - The index of the reserve to cancel the reward pool from.
- * * `is_deposit_reward` - A boolean indicating whether the reward is for deposits (`true`) or borrows (`false`).
- * * `reward_index` - The index of the reward pool to cancel.
- * * `clock` - A reference to the `Clock`.
- *
  * # Returns
  *
  * * `Coin<RewardType>` - A `Coin` containing the unallocated rewards from the cancelled pool.
@@ -975,15 +991,6 @@ export interface ClosePoolRewardArgs {
  * due to rounding or other factors are returned to the owner. This function can only be called
  * after the pool's `end_time_ms` has passed.
  *
- * # Arguments
- *
- * * `_` - The `LendingMarketOwnerCap` to authorize the operation.
- * * `lending_market` - A mutable reference to the `LendingMarket`.
- * * `reserve_array_index` - The index of the reserve to close the reward pool from.
- * * `is_deposit_reward` - A boolean indicating whether the reward is for deposits (`true`) or borrows (`false`).
- * * `reward_index` - The index of the reward pool to close.
- * * `clock` - A reference to the `Clock`.
- *
  * # Returns
  *
  * * `Coin<RewardType>` - A `Coin` containing the unallocated rewards from the closed pool.
@@ -1026,13 +1033,6 @@ export interface UpdateRateLimiterConfigArgs {
  * This is an admin-only function that allows the lending market owner to update the rate
  * limiter configuration. The new configuration will replace the existing one.
  *
- * # Arguments
- *
- * * `_` - The `LendingMarketOwnerCap` to authorize the operation.
- * * `lending_market` - A mutable reference to the `LendingMarket`.
- * * `clock` - A reference to the `Clock` to get the current timestamp.
- * * `config` - The new `RateLimiterConfig` to apply.
- *
  * # Panics
  *
  * This function will panic if:
@@ -1054,13 +1054,6 @@ export interface SetFeeReceiversArgs {
  * and their respective weights for distributing protocol fees. The fees are distributed
  * proportionally based on these weights.
  *
- * # Arguments
- *
- * * `_` - The `LendingMarketOwnerCap` to authorize the operation.
- * * `lending_market` - A mutable reference to the `LendingMarket`.
- * * `receivers` - A vector of addresses that will receive the fees.
- * * `weights` - A vector of weights corresponding to each receiver.
- *
  * # Panics
  *
  * This function will panic if:
@@ -1114,12 +1107,6 @@ export interface NewObligationOwnerCapArgs {
  * `ObligationOwnerCap` for an obligation that already exists. This can be useful for
  * recovery purposes or administrative actions where a new capability object is needed.
  *
- * # Arguments
- *
- * * `_` - The `LendingMarketOwnerCap` to authorize the operation.
- * * `lending_market` - A reference to the `LendingMarket`.
- * * `obligation_id` - The ID of the obligation to create a new owner cap for.
- *
  * # Returns
  *
  * * `ObligationOwnerCap<P>` - The newly created ownership capability for the specified obligation.
@@ -1134,7 +1121,7 @@ export declare function newObligationOwnerCap(tx: Transaction, typeArg: string,
     env?: EnvConfig;
 }): TransactionResult;
 export interface NewPauseCapArgs {
-    lendingMarketOwnerCap: TransactionObjectInput;
+    ownerCap: TransactionObjectInput;
     lendingMarket: TransactionObjectInput;
     recipient: string | TransactionArgument;
 }
@@ -1146,6 +1133,7 @@ export interface NewPauseCapArgs {
  *
  * This function will panic if:
  * * The `lending_market` version is not `CURRENT_VERSION` (EIncorrectVersion).
+ * * `owner_cap` was not minted for this `lending_market` (EWrongLendingMarket).
  */
 export declare function newPauseCap(tx: Transaction, typeArg: string, args: NewPauseCapArgs, options?: {
     env?: EnvConfig;
@@ -1190,6 +1178,139 @@ export interface SetReservePausedArgs {
 export declare function setReservePaused(tx: Transaction, typeArg: string, args: SetReservePausedArgs, options?: {
     env?: EnvConfig;
 }): TransactionResult;
+export interface LowerProtocolLiquidationFeeArgs {
+    cap: TransactionObjectInput;
+    lendingMarket: TransactionObjectInput;
+    reserveArrayIndex: bigint | TransactionArgument;
+    protocolLiquidationFeeBps: bigint | TransactionArgument;
+}
+/**
+ * Lowers one reserve's protocol liquidation fee, so liquidators keep more of a capped
+ * bonus and stay paid deeper into a drawdown. Gated on the current-generation
+ * `EmergencyPauseCap` rather than the owner cap so it is reachable within the hour;
+ * it can only lower the fee, so raising it back stays with the owner cap. Only the fee
+ * field changes: the rest of the config is not rebuilt or re-validated against live
+ * oracle state, so the cut still works when confidence has widened. A cut emits
+ * `ProtocolLiquidationFeeLoweredEvent`; passing the current fee changes nothing and emits
+ * nothing.
+ *
+ * # Panics
+ *
+ * This function will panic if:
+ * * The `lending_market` version is not `CURRENT_VERSION` (EIncorrectVersion).
+ * * `cap` was not minted for this `lending_market` (EWrongLendingMarket).
+ * * `cap`'s generation has been superseded by a later `new_pause_cap` call (EStalePauseCap).
+ * * `reserve_array_index` is out of bounds.
+ * * The `coin_type` of the reserve does not match the type `T` (EWrongType).
+ * * `protocol_liquidation_fee_bps` is above the reserve's current fee
+ * (EProtocolLiquidationFeeNotLowered).
+ */
+export declare function lowerProtocolLiquidationFee(tx: Transaction, typeArgs: [string, string], args: LowerProtocolLiquidationFeeArgs, options?: {
+    env?: EnvConfig;
+}): TransactionResult;
+export interface HoldOperationUntilArgs {
+    cap: TransactionObjectInput;
+    lendingMarket: TransactionObjectInput;
+    operation: number | TransactionArgument;
+    untilMs: bigint | TransactionArgument;
+    clock: TransactionObjectInput;
+}
+/**
+ * Holds one operation across the whole market until `until_ms`, independently of the
+ * market and reserve pauses. The hold lapses by itself once the clock reaches `until_ms`;
+ * a later call replaces it, and `until_ms = 0` lifts it at once. Every call starts a new
+ * hold generation for the operation, which ends withdraw exemptions granted under an
+ * earlier call. Holding borrow and liquidate while the market itself is unpaused reopens
+ * repay, deposit, withdraw and redeem first, so positions can be topped up before they can
+ * be liquidated.
+ *
+ * # Panics
+ *
+ * This function will panic if:
+ * * The `lending_market` version is not `CURRENT_VERSION` (EIncorrectVersion).
+ * * `cap` was not minted for this `lending_market` (EWrongLendingMarket).
+ * * `cap`'s generation has been superseded by a later `new_pause_cap` call (EStalePauseCap).
+ * * `operation` is not 0 (borrow), 1 (liquidate) or 2 (withdraw) (EInvalidOperation).
+ * * `until_ms` is more than `MAX_OPERATION_HOLD_MS` past the clock (EHoldTooLong).
+ * * `until_ms` is not 0 and is at or before the clock (EHoldInPast).
+ */
+export declare function holdOperationUntil(tx: Transaction, typeArg: string, args: HoldOperationUntilArgs, options?: {
+    env?: EnvConfig;
+}): TransactionResult;
+export interface SetWithdrawHoldExemptArgs {
+    cap: TransactionObjectInput;
+    lendingMarket: TransactionObjectInput;
+    obligationId: string | TransactionArgument;
+    exempt: boolean | TransactionArgument;
+    clock: TransactionObjectInput;
+}
+/**
+ * Exempts one obligation from the current withdraw hold, or removes its exemption. An
+ * exempt obligation can still `withdraw_ctokens` while that hold lasts. The
+ * exemption records the hold's generation and lapses with it: once the hold ends, or any
+ * later `hold_operation_until` call replaces or lifts it, the obligation is held again
+ * until it is exempted anew, even under a new hold with the same `until_ms`. Setting the
+ * state the obligation already has emits nothing, and removing a lapsed exemption clears
+ * it without an event.
+ *
+ * # Panics
+ *
+ * This function will panic if:
+ * * The `lending_market` version is not `CURRENT_VERSION` (EIncorrectVersion).
+ * * `cap` was not minted for this `lending_market` (EWrongLendingMarket).
+ * * `cap`'s generation has been superseded by a later `new_pause_cap` call (EStalePauseCap).
+ * * The `obligation_id` is not found in the lending market's obligations (EInvalidObligationId).
+ * * `exempt` is true and withdraw is not held (EWithdrawNotHeld).
+ */
+export declare function setWithdrawHoldExempt(tx: Transaction, typeArg: string, args: SetWithdrawHoldExemptArgs, options?: {
+    env?: EnvConfig;
+}): TransactionResult;
+export interface AssertWithdrawNotHeldArgs {
+    lendingMarket: TransactionObjectInput;
+    obligationId: string | TransactionArgument;
+    clock: TransactionObjectInput;
+}
+/**
+ * Aborts with `EOperationHeld` while withdraw is held, unless the obligation is exempt.
+ * Debt-free obligations are held too: otherwise a borrower could repay in full, withdraw
+ * and borrow again in one PTB at the same pushed price.
+ */
+export declare function assertWithdrawNotHeld(tx: Transaction, typeArg: string, args: AssertWithdrawNotHeldArgs, options?: {
+    env?: EnvConfig;
+}): TransactionResult;
+export interface IsWithdrawHoldExemptArgs {
+    lendingMarket: TransactionObjectInput;
+    obligationId: string | TransactionArgument;
+    clock: TransactionObjectInput;
+}
+/** True if `obligation_id` was exempted under the withdraw hold that is active now. */
+export declare function isWithdrawHoldExempt(tx: Transaction, typeArg: string, args: IsWithdrawHoldExemptArgs, options?: {
+    env?: EnvConfig;
+}): TransactionResult;
+export declare function withdrawHoldGeneration(tx: Transaction, typeArg: string, lendingMarket: TransactionObjectInput, options?: {
+    env?: EnvConfig;
+}): TransactionResult;
+/** The operation code that holds borrow. */
+export declare function operationBorrow(tx: Transaction, options?: {
+    env?: EnvConfig;
+}): TransactionResult;
+/** The operation code that holds liquidate. */
+export declare function operationLiquidate(tx: Transaction, options?: {
+    env?: EnvConfig;
+}): TransactionResult;
+/** The operation code that holds withdrawing collateral from obligations. */
+export declare function operationWithdraw(tx: Transaction, options?: {
+    env?: EnvConfig;
+}): TransactionResult;
+export interface IsOperationHeldArgs {
+    lendingMarket: TransactionObjectInput;
+    operation: number | TransactionArgument;
+    clock: TransactionObjectInput;
+}
+/** True while a hold on `operation` has not yet lapsed. Absent the dynamic field, it is not. */
+export declare function isOperationHeld(tx: Transaction, typeArg: string, args: IsOperationHeldArgs, options?: {
+    env?: EnvConfig;
+}): TransactionResult;
 /**
  * True if the market has been paused. Absent the dynamic field, the market is
  * unpaused. Pure: no aborts, no side effects. Public so a UI or bot can check