@sovryn-zero/lib-base 0.2.0 → 0.2.2

package/dist/src/TransactableLiquity.d.ts

@@ -1,414 +1,414 @@
-import { Decimal, Decimalish } from "./Decimal";
-import { Trove, TroveAdjustmentParams, TroveClosureParams, TroveCreationParams } from "./Trove";
-import { StabilityDepositChange } from "./StabilityDeposit";
-import { FailedReceipt } from "./SendableLiquity";
-/**
- * Thrown by {@link TransactableLiquity} functions in case of transaction failure.
- *
- * @public
- */
-export declare class TransactionFailedError<T extends FailedReceipt = FailedReceipt> extends Error {
-    readonly failedReceipt: T;
-    /** @internal */
-    constructor(name: string, message: string, failedReceipt: T);
-}
-/**
- * Details of an {@link TransactableLiquity.openTrove | openTrove()} transaction.
- *
- * @public
- */
-export interface TroveCreationDetails {
-    /** How much was deposited and borrowed. */
-    params: TroveCreationParams<Decimal>;
-    /** The Trove that was created by the transaction. */
-    newTrove: Trove;
-    /** Amount of ZUSD added to the Trove's debt as borrowing fee. */
-    fee: Decimal;
-}
-/**
- * Details of an {@link TransactableLiquity.adjustTrove | adjustTrove()} transaction.
- *
- * @public
- */
-export interface TroveAdjustmentDetails {
-    /** Parameters of the adjustment. */
-    params: TroveAdjustmentParams<Decimal>;
-    /** New state of the adjusted Trove directly after the transaction. */
-    newTrove: Trove;
-    /** Amount of ZUSD added to the Trove's debt as borrowing fee. */
-    fee: Decimal;
-}
-/**
- * Details of a {@link TransactableLiquity.closeTrove | closeTrove()} transaction.
- *
- * @public
- */
-export interface TroveClosureDetails {
-    /** How much was withdrawn and repaid. */
-    params: TroveClosureParams<Decimal>;
-}
-/**
- * Details of a {@link TransactableLiquity.liquidate | liquidate()} or
- * {@link TransactableLiquity.liquidateUpTo | liquidateUpTo()} transaction.
- *
- * @public
- */
-export interface LiquidationDetails {
-    /** Addresses whose Troves were liquidated by the transaction. */
-    liquidatedAddresses: string[];
-    /** Total collateral liquidated and debt cleared by the transaction. */
-    totalLiquidated: Trove;
-    /** Amount of ZUSD paid to the liquidator as gas compensation. */
-    zusdGasCompensation: Decimal;
-    /** Amount of native currency (e.g. Ether) paid to the liquidator as gas compensation. */
-    collateralGasCompensation: Decimal;
-}
-/**
- * Details of a {@link TransactableLiquity.redeemZUSD | redeemZUSD()} transaction.
- *
- * @public
- */
-export interface RedemptionDetails {
-    /** Amount of ZUSD the redeemer tried to redeem. */
-    attemptedZUSDAmount: Decimal;
-    /**
-     * Amount of ZUSD that was actually redeemed by the transaction.
-     *
-     * @remarks
-     * This can end up being lower than `attemptedZUSDAmount` due to interference from another
-     * transaction that modifies the list of Troves.
-     *
-     * @public
-     */
-    actualZUSDAmount: Decimal;
-    /** Amount of collateral (e.g. Ether) taken from Troves by the transaction. */
-    collateralTaken: Decimal;
-    /** Amount of native currency (e.g. Ether) deducted as fee from collateral taken. */
-    fee: Decimal;
-}
-/**
- * Details of a
- * {@link TransactableLiquity.withdrawGainsFromStabilityPool | withdrawGainsFromStabilityPool()}
- * transaction.
- *
- * @public
- */
-export interface StabilityPoolGainsWithdrawalDetails {
-    /** Amount of ZUSD burned from the deposit by liquidations since the last modification. */
-    zusdLoss: Decimal;
-    /** Amount of ZUSD in the deposit directly after this transaction. */
-    newZUSDDeposit: Decimal;
-    /** Amount of native currency (e.g. Ether) paid out to the depositor in this transaction. */
-    collateralGain: Decimal;
-    /** Amount of ZERO rewarded to the depositor in this transaction. */
-    zeroReward: Decimal;
-}
-/**
- * Details of a
- * {@link TransactableLiquity.depositZUSDInStabilityPool | depositZUSDInStabilityPool()} or
- * {@link TransactableLiquity.withdrawZUSDFromStabilityPool | withdrawZUSDFromStabilityPool()}
- * transaction.
- *
- * @public
- */
-export interface StabilityDepositChangeDetails extends StabilityPoolGainsWithdrawalDetails {
-    /** Change that was made to the deposit by this transaction. */
-    change: StabilityDepositChange<Decimal>;
-}
-/**
- * Details of a
- * {@link TransactableLiquity.transferCollateralGainToTrove | transferCollateralGainToTrove()}
- * transaction.
- *
- * @public
- */
-export interface CollateralGainTransferDetails extends StabilityPoolGainsWithdrawalDetails {
-    /** New state of the depositor's Trove directly after the transaction. */
-    newTrove: Trove;
-}
-/**
- * Send Zero transactions and wait for them to succeed.
- *
- * @remarks
- * The functions return the details of the transaction (if any), or throw an implementation-specific
- * subclass of {@link TransactionFailedError} in case of transaction failure.
- *
- * Implemented by {@link @sovryn-zero/lib-ethers#EthersLiquity}.
- *
- * @public
- */
-export interface TransactableLiquity {
-    /**
-     * Open a new Trove by depositing collateral and borrowing ZUSD.
-     *
-     * @param params - How much to deposit and borrow.
-     * @param maxBorrowingRate - Maximum acceptable
-     *                           {@link @sovryn-zero/lib-base#Fees.borrowingRate | borrowing rate}.
-     *
-     * @throws
-     * Throws {@link TransactionFailedError} in case of transaction failure.
-     *
-     * @remarks
-     * If `maxBorrowingRate` is omitted, the current borrowing rate plus 0.5% is used as maximum
-     * acceptable rate.
-     */
-    openTrove(params: TroveCreationParams<Decimalish>, maxBorrowingRate?: Decimalish): Promise<TroveCreationDetails>;
-    /**
-     * Close existing Trove by repaying all debt and withdrawing all collateral.
-     *
-     * @throws
-     * Throws {@link TransactionFailedError} in case of transaction failure.
-     */
-    closeTrove(): Promise<TroveClosureDetails>;
-    /**
-     * Adjust existing Trove by changing its collateral, debt, or both.
-     *
-     * @param params - Parameters of the adjustment.
-     * @param maxBorrowingRate - Maximum acceptable
-     *                           {@link @sovryn-zero/lib-base#Fees.borrowingRate | borrowing rate} if
-     *                           `params` includes `borrowZUSD`.
-     *
-     * @throws
-     * Throws {@link TransactionFailedError} in case of transaction failure.
-     *
-     * @remarks
-     * The transaction will fail if the Trove's debt would fall below
-     * {@link @sovryn-zero/lib-base#ZUSD_MINIMUM_DEBT}.
-     *
-     * If `maxBorrowingRate` is omitted, the current borrowing rate plus 0.5% is used as maximum
-     * acceptable rate.
-     */
-    adjustTrove(params: TroveAdjustmentParams<Decimalish>, maxBorrowingRate?: Decimalish): Promise<TroveAdjustmentDetails>;
-    /**
-     * Adjust existing Trove by depositing more collateral.
-     *
-     * @param amount - The amount of collateral to add to the Trove's existing collateral.
-     *
-     * @throws
-     * Throws {@link TransactionFailedError} in case of transaction failure.
-     *
-     * @remarks
-     * Equivalent to:
-     *
-     * ```typescript
-     * adjustTrove({ depositCollateral: amount })
-     * ```
-     */
-    depositCollateral(amount: Decimalish): Promise<TroveAdjustmentDetails>;
-    /**
-     * Adjust existing Trove by withdrawing some of its collateral.
-     *
-     * @param amount - The amount of collateral to withdraw from the Trove.
-     *
-     * @throws
-     * Throws {@link TransactionFailedError} in case of transaction failure.
-     *
-     * @remarks
-     * Equivalent to:
-     *
-     * ```typescript
-     * adjustTrove({ withdrawCollateral: amount })
-     * ```
-     */
-    withdrawCollateral(amount: Decimalish): Promise<TroveAdjustmentDetails>;
-    /**
-     * Adjust existing Trove by borrowing more ZUSD.
-     *
-     * @param amount - The amount of ZUSD to borrow.
-     * @param maxBorrowingRate - Maximum acceptable
-     *                           {@link @sovryn-zero/lib-base#Fees.borrowingRate | borrowing rate}.
-     *
-     * @throws
-     * Throws {@link TransactionFailedError} in case of transaction failure.
-     *
-     * @remarks
-     * Equivalent to:
-     *
-     * ```typescript
-     * adjustTrove({ borrowZUSD: amount }, maxBorrowingRate)
-     * ```
-     */
-    borrowZUSD(amount: Decimalish, maxBorrowingRate?: Decimalish): Promise<TroveAdjustmentDetails>;
-    /**
-     * Adjust existing Trove by repaying some of its debt.
-     *
-     * @param amount - The amount of ZUSD to repay.
-     *
-     * @throws
-     * Throws {@link TransactionFailedError} in case of transaction failure.
-     *
-     * @remarks
-     * Equivalent to:
-     *
-     * ```typescript
-     * adjustTrove({ repayZUSD: amount })
-     * ```
-     */
-    repayZUSD(amount: Decimalish): Promise<TroveAdjustmentDetails>;
-    /** @internal */
-    setPrice(price: Decimalish): Promise<void>;
-    /**
-     * Liquidate one or more undercollateralized Troves.
-     *
-     * @param address - Address or array of addresses whose Troves to liquidate.
-     *
-     * @throws
-     * Throws {@link TransactionFailedError} in case of transaction failure.
-     */
-    liquidate(address: string | string[]): Promise<LiquidationDetails>;
-    /**
-     * Liquidate the least collateralized Troves up to a maximum number.
-     *
-     * @param maximumNumberOfTrovesToLiquidate - Stop after liquidating this many Troves.
-     *
-     * @throws
-     * Throws {@link TransactionFailedError} in case of transaction failure.
-     */
-    liquidateUpTo(maximumNumberOfTrovesToLiquidate: number): Promise<LiquidationDetails>;
-    /**
-     * Make a new Stability Deposit, or top up existing one.
-     *
-     * @param amount - Amount of ZUSD to add to new or existing deposit.
-     * @param frontendTag - Address that should receive a share of this deposit's ZERO rewards.
-     *
-     * @throws
-     * Throws {@link TransactionFailedError} in case of transaction failure.
-     *
-     * @remarks
-     * The `frontendTag` parameter is only effective when making a new deposit.
-     *
-     * As a side-effect, the transaction will also pay out an existing Stability Deposit's
-     * {@link @sovryn-zero/lib-base#StabilityDeposit.collateralGain | collateral gain} and
-     * {@link @sovryn-zero/lib-base#StabilityDeposit.zeroReward | ZERO reward}.
-     */
-    depositZUSDInStabilityPool(amount: Decimalish, frontendTag?: string): Promise<StabilityDepositChangeDetails>;
-    /**
-     * Withdraw ZUSD from Stability Deposit.
-     *
-     * @param amount - Amount of ZUSD to withdraw.
-     *
-     * @throws
-     * Throws {@link TransactionFailedError} in case of transaction failure.
-     *
-     * @remarks
-     * As a side-effect, the transaction will also pay out the Stability Deposit's
-     * {@link @sovryn-zero/lib-base#StabilityDeposit.collateralGain | collateral gain} and
-     * {@link @sovryn-zero/lib-base#StabilityDeposit.zeroReward | ZERO reward}.
-     */
-    withdrawZUSDFromStabilityPool(amount: Decimalish): Promise<StabilityDepositChangeDetails>;
-    /**
-     * Withdraw {@link @sovryn-zero/lib-base#StabilityDeposit.collateralGain | collateral gain} and
-     * {@link @sovryn-zero/lib-base#StabilityDeposit.zeroReward | ZERO reward} from Stability Deposit.
-     *
-     * @throws
-     * Throws {@link TransactionFailedError} in case of transaction failure.
-     */
-    withdrawGainsFromStabilityPool(): Promise<StabilityPoolGainsWithdrawalDetails>;
-    /**
-     * Transfer {@link @sovryn-zero/lib-base#StabilityDeposit.collateralGain | collateral gain} from
-     * Stability Deposit to Trove.
-     *
-     * @throws
-     * Throws {@link TransactionFailedError} in case of transaction failure.
-     *
-     * @remarks
-     * The collateral gain is transfered to the Trove as additional collateral.
-     *
-     * As a side-effect, the transaction will also pay out the Stability Deposit's
-     * {@link @sovryn-zero/lib-base#StabilityDeposit.zeroReward | ZERO reward}.
-     */
-    transferCollateralGainToTrove(): Promise<CollateralGainTransferDetails>;
-    /**
-     * Send ZUSD tokens to an address.
-     *
-     * @param toAddress - Address of receipient.
-     * @param amount - Amount of ZUSD to send.
-     *
-     * @throws
-     * Throws {@link TransactionFailedError} in case of transaction failure.
-     */
-    sendZUSD(toAddress: string, amount: Decimalish): Promise<void>;
-    /**
-     * Send ZERO tokens to an address.
-     *
-     * @param toAddress - Address of receipient.
-     * @param amount - Amount of ZERO to send.
-     *
-     * @throws
-     * Throws {@link TransactionFailedError} in case of transaction failure.
-     */
-    sendZERO(toAddress: string, amount: Decimalish): Promise<void>;
-    /**
-     * Redeem ZUSD to native currency (e.g. Ether) at face value.
-     *
-     * @param amount - Amount of ZUSD to be redeemed.
-     * @param maxRedemptionRate - Maximum acceptable
-     *                            {@link @sovryn-zero/lib-base#Fees.redemptionRate | redemption rate}.
-     *
-     * @throws
-     * Throws {@link TransactionFailedError} in case of transaction failure.
-     *
-     * @remarks
-     * If `maxRedemptionRate` is omitted, the current redemption rate (based on `amount`) plus 0.1%
-     * is used as maximum acceptable rate.
-     */
-    redeemZUSD(amount: Decimalish, maxRedemptionRate?: Decimalish): Promise<RedemptionDetails>;
-    /**
-     * Claim leftover collateral after a liquidation or redemption.
-     *
-     * @remarks
-     * Use {@link @sovryn-zero/lib-base#ReadableLiquity.getCollateralSurplusBalance | getCollateralSurplusBalance()}
-     * to check the amount of collateral available for withdrawal.
-     *
-     * @throws
-     * Throws {@link TransactionFailedError} in case of transaction failure.
-     */
-    claimCollateralSurplus(): Promise<void>;
-    /**
-     * Stake ZERO to start earning fee revenue or increase existing stake.
-     *
-     * @param amount - Amount of ZERO to add to new or existing stake.
-     *
-     * @throws
-     * Throws {@link TransactionFailedError} in case of transaction failure.
-     *
-     * @remarks
-     * As a side-effect, the transaction will also pay out an existing ZERO stake's
-     * {@link @sovryn-zero/lib-base#ZEROStake.collateralGain | collateral gain} and
-     * {@link @sovryn-zero/lib-base#ZEROStake.zusdGain | ZUSD gain}.
-     */
-    stakeZERO(amount: Decimalish): Promise<void>;
-    /**
-     * Withdraw ZERO from staking.
-     *
-     * @param amount - Amount of ZERO to withdraw.
-     *
-     * @throws
-     * Throws {@link TransactionFailedError} in case of transaction failure.
-     *
-     * @remarks
-     * As a side-effect, the transaction will also pay out the ZERO stake's
-     * {@link @sovryn-zero/lib-base#ZEROStake.collateralGain | collateral gain} and
-     * {@link @sovryn-zero/lib-base#ZEROStake.zusdGain | ZUSD gain}.
-     */
-    unstakeZERO(amount: Decimalish): Promise<void>;
-    /**
-     * Withdraw {@link @sovryn-zero/lib-base#ZEROStake.collateralGain | collateral gain} and
-     * {@link @sovryn-zero/lib-base#ZEROStake.zusdGain | ZUSD gain} from ZERO stake.
-     *
-     * @throws
-     * Throws {@link TransactionFailedError} in case of transaction failure.
-     */
-    withdrawGainsFromStaking(): Promise<void>;
-    /**
-     * Register current wallet address as a Zero frontend.
-     *
-     * @param kickbackRate - The portion of ZERO rewards to pass onto users of the frontend
-     *                       (between 0 and 1).
-     *
-     * @throws
-     * Throws {@link TransactionFailedError} in case of transaction failure.
-     */
-    registerFrontend(kickbackRate: Decimalish): Promise<void>;
-}
+import { Decimal, Decimalish } from "./Decimal";
+import { Trove, TroveAdjustmentParams, TroveClosureParams, TroveCreationParams } from "./Trove";
+import { StabilityDepositChange } from "./StabilityDeposit";
+import { FailedReceipt } from "./SendableLiquity";
+/**
+ * Thrown by {@link TransactableLiquity} functions in case of transaction failure.
+ *
+ * @public
+ */
+export declare class TransactionFailedError<T extends FailedReceipt = FailedReceipt> extends Error {
+    readonly failedReceipt: T;
+    /** @internal */
+    constructor(name: string, message: string, failedReceipt: T);
+}
+/**
+ * Details of an {@link TransactableLiquity.openTrove | openTrove()} transaction.
+ *
+ * @public
+ */
+export interface TroveCreationDetails {
+    /** How much was deposited and borrowed. */
+    params: TroveCreationParams<Decimal>;
+    /** The Trove that was created by the transaction. */
+    newTrove: Trove;
+    /** Amount of ZUSD added to the Trove's debt as borrowing fee. */
+    fee: Decimal;
+}
+/**
+ * Details of an {@link TransactableLiquity.adjustTrove | adjustTrove()} transaction.
+ *
+ * @public
+ */
+export interface TroveAdjustmentDetails {
+    /** Parameters of the adjustment. */
+    params: TroveAdjustmentParams<Decimal>;
+    /** New state of the adjusted Trove directly after the transaction. */
+    newTrove: Trove;
+    /** Amount of ZUSD added to the Trove's debt as borrowing fee. */
+    fee: Decimal;
+}
+/**
+ * Details of a {@link TransactableLiquity.closeTrove | closeTrove()} transaction.
+ *
+ * @public
+ */
+export interface TroveClosureDetails {
+    /** How much was withdrawn and repaid. */
+    params: TroveClosureParams<Decimal>;
+}
+/**
+ * Details of a {@link TransactableLiquity.liquidate | liquidate()} or
+ * {@link TransactableLiquity.liquidateUpTo | liquidateUpTo()} transaction.
+ *
+ * @public
+ */
+export interface LiquidationDetails {
+    /** Addresses whose Troves were liquidated by the transaction. */
+    liquidatedAddresses: string[];
+    /** Total collateral liquidated and debt cleared by the transaction. */
+    totalLiquidated: Trove;
+    /** Amount of ZUSD paid to the liquidator as gas compensation. */
+    zusdGasCompensation: Decimal;
+    /** Amount of native currency (e.g. Ether) paid to the liquidator as gas compensation. */
+    collateralGasCompensation: Decimal;
+}
+/**
+ * Details of a {@link TransactableLiquity.redeemZUSD | redeemZUSD()} transaction.
+ *
+ * @public
+ */
+export interface RedemptionDetails {
+    /** Amount of ZUSD the redeemer tried to redeem. */
+    attemptedZUSDAmount: Decimal;
+    /**
+     * Amount of ZUSD that was actually redeemed by the transaction.
+     *
+     * @remarks
+     * This can end up being lower than `attemptedZUSDAmount` due to interference from another
+     * transaction that modifies the list of Troves.
+     *
+     * @public
+     */
+    actualZUSDAmount: Decimal;
+    /** Amount of collateral (e.g. Ether) taken from Troves by the transaction. */
+    collateralTaken: Decimal;
+    /** Amount of native currency (e.g. Ether) deducted as fee from collateral taken. */
+    fee: Decimal;
+}
+/**
+ * Details of a
+ * {@link TransactableLiquity.withdrawGainsFromStabilityPool | withdrawGainsFromStabilityPool()}
+ * transaction.
+ *
+ * @public
+ */
+export interface StabilityPoolGainsWithdrawalDetails {
+    /** Amount of ZUSD burned from the deposit by liquidations since the last modification. */
+    zusdLoss: Decimal;
+    /** Amount of ZUSD in the deposit directly after this transaction. */
+    newZUSDDeposit: Decimal;
+    /** Amount of native currency (e.g. Ether) paid out to the depositor in this transaction. */
+    collateralGain: Decimal;
+    /** Amount of ZERO rewarded to the depositor in this transaction. */
+    zeroReward: Decimal;
+}
+/**
+ * Details of a
+ * {@link TransactableLiquity.depositZUSDInStabilityPool | depositZUSDInStabilityPool()} or
+ * {@link TransactableLiquity.withdrawZUSDFromStabilityPool | withdrawZUSDFromStabilityPool()}
+ * transaction.
+ *
+ * @public
+ */
+export interface StabilityDepositChangeDetails extends StabilityPoolGainsWithdrawalDetails {
+    /** Change that was made to the deposit by this transaction. */
+    change: StabilityDepositChange<Decimal>;
+}
+/**
+ * Details of a
+ * {@link TransactableLiquity.transferCollateralGainToTrove | transferCollateralGainToTrove()}
+ * transaction.
+ *
+ * @public
+ */
+export interface CollateralGainTransferDetails extends StabilityPoolGainsWithdrawalDetails {
+    /** New state of the depositor's Trove directly after the transaction. */
+    newTrove: Trove;
+}
+/**
+ * Send Zero transactions and wait for them to succeed.
+ *
+ * @remarks
+ * The functions return the details of the transaction (if any), or throw an implementation-specific
+ * subclass of {@link TransactionFailedError} in case of transaction failure.
+ *
+ * Implemented by {@link @sovryn-zero/lib-ethers#EthersLiquity}.
+ *
+ * @public
+ */
+export interface TransactableLiquity {
+    /**
+     * Open a new Trove by depositing collateral and borrowing ZUSD.
+     *
+     * @param params - How much to deposit and borrow.
+     * @param maxBorrowingRate - Maximum acceptable
+     *                           {@link @sovryn-zero/lib-base#Fees.borrowingRate | borrowing rate}.
+     *
+     * @throws
+     * Throws {@link TransactionFailedError} in case of transaction failure.
+     *
+     * @remarks
+     * If `maxBorrowingRate` is omitted, the current borrowing rate plus 0.5% is used as maximum
+     * acceptable rate.
+     */
+    openTrove(params: TroveCreationParams<Decimalish>, maxBorrowingRate?: Decimalish): Promise<TroveCreationDetails>;
+    /**
+     * Close existing Trove by repaying all debt and withdrawing all collateral.
+     *
+     * @throws
+     * Throws {@link TransactionFailedError} in case of transaction failure.
+     */
+    closeTrove(): Promise<TroveClosureDetails>;
+    /**
+     * Adjust existing Trove by changing its collateral, debt, or both.
+     *
+     * @param params - Parameters of the adjustment.
+     * @param maxBorrowingRate - Maximum acceptable
+     *                           {@link @sovryn-zero/lib-base#Fees.borrowingRate | borrowing rate} if
+     *                           `params` includes `borrowZUSD`.
+     *
+     * @throws
+     * Throws {@link TransactionFailedError} in case of transaction failure.
+     *
+     * @remarks
+     * The transaction will fail if the Trove's debt would fall below
+     * {@link @sovryn-zero/lib-base#ZUSD_MINIMUM_DEBT}.
+     *
+     * If `maxBorrowingRate` is omitted, the current borrowing rate plus 0.5% is used as maximum
+     * acceptable rate.
+     */
+    adjustTrove(params: TroveAdjustmentParams<Decimalish>, maxBorrowingRate?: Decimalish): Promise<TroveAdjustmentDetails>;
+    /**
+     * Adjust existing Trove by depositing more collateral.
+     *
+     * @param amount - The amount of collateral to add to the Trove's existing collateral.
+     *
+     * @throws
+     * Throws {@link TransactionFailedError} in case of transaction failure.
+     *
+     * @remarks
+     * Equivalent to:
+     *
+     * ```typescript
+     * adjustTrove({ depositCollateral: amount })
+     * ```
+     */
+    depositCollateral(amount: Decimalish): Promise<TroveAdjustmentDetails>;
+    /**
+     * Adjust existing Trove by withdrawing some of its collateral.
+     *
+     * @param amount - The amount of collateral to withdraw from the Trove.
+     *
+     * @throws
+     * Throws {@link TransactionFailedError} in case of transaction failure.
+     *
+     * @remarks
+     * Equivalent to:
+     *
+     * ```typescript
+     * adjustTrove({ withdrawCollateral: amount })
+     * ```
+     */
+    withdrawCollateral(amount: Decimalish): Promise<TroveAdjustmentDetails>;
+    /**
+     * Adjust existing Trove by borrowing more ZUSD.
+     *
+     * @param amount - The amount of ZUSD to borrow.
+     * @param maxBorrowingRate - Maximum acceptable
+     *                           {@link @sovryn-zero/lib-base#Fees.borrowingRate | borrowing rate}.
+     *
+     * @throws
+     * Throws {@link TransactionFailedError} in case of transaction failure.
+     *
+     * @remarks
+     * Equivalent to:
+     *
+     * ```typescript
+     * adjustTrove({ borrowZUSD: amount }, maxBorrowingRate)
+     * ```
+     */
+    borrowZUSD(amount: Decimalish, maxBorrowingRate?: Decimalish): Promise<TroveAdjustmentDetails>;
+    /**
+     * Adjust existing Trove by repaying some of its debt.
+     *
+     * @param amount - The amount of ZUSD to repay.
+     *
+     * @throws
+     * Throws {@link TransactionFailedError} in case of transaction failure.
+     *
+     * @remarks
+     * Equivalent to:
+     *
+     * ```typescript
+     * adjustTrove({ repayZUSD: amount })
+     * ```
+     */
+    repayZUSD(amount: Decimalish): Promise<TroveAdjustmentDetails>;
+    /** @internal */
+    setPrice(price: Decimalish): Promise<void>;
+    /**
+     * Liquidate one or more undercollateralized Troves.
+     *
+     * @param address - Address or array of addresses whose Troves to liquidate.
+     *
+     * @throws
+     * Throws {@link TransactionFailedError} in case of transaction failure.
+     */
+    liquidate(address: string | string[]): Promise<LiquidationDetails>;
+    /**
+     * Liquidate the least collateralized Troves up to a maximum number.
+     *
+     * @param maximumNumberOfTrovesToLiquidate - Stop after liquidating this many Troves.
+     *
+     * @throws
+     * Throws {@link TransactionFailedError} in case of transaction failure.
+     */
+    liquidateUpTo(maximumNumberOfTrovesToLiquidate: number): Promise<LiquidationDetails>;
+    /**
+     * Make a new Stability Deposit, or top up existing one.
+     *
+     * @param amount - Amount of ZUSD to add to new or existing deposit.
+     * @param frontendTag - Address that should receive a share of this deposit's ZERO rewards.
+     *
+     * @throws
+     * Throws {@link TransactionFailedError} in case of transaction failure.
+     *
+     * @remarks
+     * The `frontendTag` parameter is only effective when making a new deposit.
+     *
+     * As a side-effect, the transaction will also pay out an existing Stability Deposit's
+     * {@link @sovryn-zero/lib-base#StabilityDeposit.collateralGain | collateral gain} and
+     * {@link @sovryn-zero/lib-base#StabilityDeposit.zeroReward | ZERO reward}.
+     */
+    depositZUSDInStabilityPool(amount: Decimalish, frontendTag?: string): Promise<StabilityDepositChangeDetails>;
+    /**
+     * Withdraw ZUSD from Stability Deposit.
+     *
+     * @param amount - Amount of ZUSD to withdraw.
+     *
+     * @throws
+     * Throws {@link TransactionFailedError} in case of transaction failure.
+     *
+     * @remarks
+     * As a side-effect, the transaction will also pay out the Stability Deposit's
+     * {@link @sovryn-zero/lib-base#StabilityDeposit.collateralGain | collateral gain} and
+     * {@link @sovryn-zero/lib-base#StabilityDeposit.zeroReward | ZERO reward}.
+     */
+    withdrawZUSDFromStabilityPool(amount: Decimalish): Promise<StabilityDepositChangeDetails>;
+    /**
+     * Withdraw {@link @sovryn-zero/lib-base#StabilityDeposit.collateralGain | collateral gain} and
+     * {@link @sovryn-zero/lib-base#StabilityDeposit.zeroReward | ZERO reward} from Stability Deposit.
+     *
+     * @throws
+     * Throws {@link TransactionFailedError} in case of transaction failure.
+     */
+    withdrawGainsFromStabilityPool(): Promise<StabilityPoolGainsWithdrawalDetails>;
+    /**
+     * Transfer {@link @sovryn-zero/lib-base#StabilityDeposit.collateralGain | collateral gain} from
+     * Stability Deposit to Trove.
+     *
+     * @throws
+     * Throws {@link TransactionFailedError} in case of transaction failure.
+     *
+     * @remarks
+     * The collateral gain is transfered to the Trove as additional collateral.
+     *
+     * As a side-effect, the transaction will also pay out the Stability Deposit's
+     * {@link @sovryn-zero/lib-base#StabilityDeposit.zeroReward | ZERO reward}.
+     */
+    transferCollateralGainToTrove(): Promise<CollateralGainTransferDetails>;
+    /**
+     * Send ZUSD tokens to an address.
+     *
+     * @param toAddress - Address of receipient.
+     * @param amount - Amount of ZUSD to send.
+     *
+     * @throws
+     * Throws {@link TransactionFailedError} in case of transaction failure.
+     */
+    sendZUSD(toAddress: string, amount: Decimalish): Promise<void>;
+    /**
+     * Send ZERO tokens to an address.
+     *
+     * @param toAddress - Address of receipient.
+     * @param amount - Amount of ZERO to send.
+     *
+     * @throws
+     * Throws {@link TransactionFailedError} in case of transaction failure.
+     */
+    sendZERO(toAddress: string, amount: Decimalish): Promise<void>;
+    /**
+     * Redeem ZUSD to native currency (e.g. Ether) at face value.
+     *
+     * @param amount - Amount of ZUSD to be redeemed.
+     * @param maxRedemptionRate - Maximum acceptable
+     *                            {@link @sovryn-zero/lib-base#Fees.redemptionRate | redemption rate}.
+     *
+     * @throws
+     * Throws {@link TransactionFailedError} in case of transaction failure.
+     *
+     * @remarks
+     * If `maxRedemptionRate` is omitted, the current redemption rate (based on `amount`) plus 0.1%
+     * is used as maximum acceptable rate.
+     */
+    redeemZUSD(amount: Decimalish, maxRedemptionRate?: Decimalish): Promise<RedemptionDetails>;
+    /**
+     * Claim leftover collateral after a liquidation or redemption.
+     *
+     * @remarks
+     * Use {@link @sovryn-zero/lib-base#ReadableLiquity.getCollateralSurplusBalance | getCollateralSurplusBalance()}
+     * to check the amount of collateral available for withdrawal.
+     *
+     * @throws
+     * Throws {@link TransactionFailedError} in case of transaction failure.
+     */
+    claimCollateralSurplus(): Promise<void>;
+    /**
+     * Stake ZERO to start earning fee revenue or increase existing stake.
+     *
+     * @param amount - Amount of ZERO to add to new or existing stake.
+     *
+     * @throws
+     * Throws {@link TransactionFailedError} in case of transaction failure.
+     *
+     * @remarks
+     * As a side-effect, the transaction will also pay out an existing ZERO stake's
+     * {@link @sovryn-zero/lib-base#ZEROStake.collateralGain | collateral gain} and
+     * {@link @sovryn-zero/lib-base#ZEROStake.zusdGain | ZUSD gain}.
+     */
+    stakeZERO(amount: Decimalish): Promise<void>;
+    /**
+     * Withdraw ZERO from staking.
+     *
+     * @param amount - Amount of ZERO to withdraw.
+     *
+     * @throws
+     * Throws {@link TransactionFailedError} in case of transaction failure.
+     *
+     * @remarks
+     * As a side-effect, the transaction will also pay out the ZERO stake's
+     * {@link @sovryn-zero/lib-base#ZEROStake.collateralGain | collateral gain} and
+     * {@link @sovryn-zero/lib-base#ZEROStake.zusdGain | ZUSD gain}.
+     */
+    unstakeZERO(amount: Decimalish): Promise<void>;
+    /**
+     * Withdraw {@link @sovryn-zero/lib-base#ZEROStake.collateralGain | collateral gain} and
+     * {@link @sovryn-zero/lib-base#ZEROStake.zusdGain | ZUSD gain} from ZERO stake.
+     *
+     * @throws
+     * Throws {@link TransactionFailedError} in case of transaction failure.
+     */
+    withdrawGainsFromStaking(): Promise<void>;
+    /**
+     * Register current wallet address as a Zero frontend.
+     *
+     * @param kickbackRate - The portion of ZERO rewards to pass onto users of the frontend
+     *                       (between 0 and 1).
+     *
+     * @throws
+     * Throws {@link TransactionFailedError} in case of transaction failure.
+     */
+    registerFrontend(kickbackRate: Decimalish): Promise<void>;
+}
 //# sourceMappingURL=TransactableLiquity.d.ts.map