@sovryn-zero/lib-base 0.1.0 → 0.2.0

package/dist/src/SendableLiquity.d.ts

@@ -1,156 +1,156 @@
-import { Decimalish } from "./Decimal";
-import { TroveAdjustmentParams, TroveCreationParams } from "./Trove";
-import { CollateralGainTransferDetails, LiquidationDetails, RedemptionDetails, StabilityDepositChangeDetails, StabilityPoolGainsWithdrawalDetails, TransactableLiquity, TroveAdjustmentDetails, TroveClosureDetails, TroveCreationDetails } from "./TransactableLiquity";
-/**
- * A transaction that has already been sent.
- *
- * @remarks
- * Implemented by {@link @sovryn-zero/lib-ethers#SentEthersLiquityTransaction}.
- *
- * @public
- */
-export interface SentLiquityTransaction<S = unknown, T extends LiquityReceipt = LiquityReceipt> {
-    /** Implementation-specific sent transaction object. */
-    readonly rawSentTransaction: S;
-    /**
-     * Check whether the transaction has been mined, and whether it was successful.
-     *
-     * @remarks
-     * Unlike {@link @sovryn-zero/lib-base#SentLiquityTransaction.waitForReceipt | waitForReceipt()},
-     * this function doesn't wait for the transaction to be mined.
-     */
-    getReceipt(): Promise<T>;
-    /**
-     * Wait for the transaction to be mined, and check whether it was successful.
-     *
-     * @returns Either a {@link @sovryn-zero/lib-base#FailedReceipt} or a
-     *          {@link @sovryn-zero/lib-base#SuccessfulReceipt}.
-     */
-    waitForReceipt(): Promise<Extract<T, MinedReceipt>>;
-}
-/**
- * Indicates that the transaction hasn't been mined yet.
- *
- * @remarks
- * Returned by {@link SentLiquityTransaction.getReceipt}.
- *
- * @public
- */
-export declare type PendingReceipt = {
-    status: "pending";
-};
-/** @internal */
-export declare const _pendingReceipt: PendingReceipt;
-/**
- * Indicates that the transaction has been mined, but it failed.
- *
- * @remarks
- * The `rawReceipt` property is an implementation-specific transaction receipt object.
- *
- * Returned by {@link SentLiquityTransaction.getReceipt} and
- * {@link SentLiquityTransaction.waitForReceipt}.
- *
- * @public
- */
-export declare type FailedReceipt<R = unknown> = {
-    status: "failed";
-    rawReceipt: R;
-};
-/** @internal */
-export declare const _failedReceipt: <R>(rawReceipt: R) => FailedReceipt<R>;
-/**
- * Indicates that the transaction has succeeded.
- *
- * @remarks
- * The `rawReceipt` property is an implementation-specific transaction receipt object.
- *
- * The `details` property may contain more information about the transaction.
- * See the return types of {@link TransactableLiquity} functions for the exact contents of `details`
- * for each type of Zero transaction.
- *
- * Returned by {@link SentLiquityTransaction.getReceipt} and
- * {@link SentLiquityTransaction.waitForReceipt}.
- *
- * @public
- */
-export declare type SuccessfulReceipt<R = unknown, D = unknown> = {
-    status: "succeeded";
-    rawReceipt: R;
-    details: D;
-};
-/** @internal */
-export declare const _successfulReceipt: <R, D>(rawReceipt: R, details: D, toString?: (() => string) | undefined) => SuccessfulReceipt<R, D>;
-/**
- * Either a {@link FailedReceipt} or a {@link SuccessfulReceipt}.
- *
- * @public
- */
-export declare type MinedReceipt<R = unknown, D = unknown> = FailedReceipt<R> | SuccessfulReceipt<R, D>;
-/**
- * One of either a {@link PendingReceipt}, a {@link FailedReceipt} or a {@link SuccessfulReceipt}.
- *
- * @public
- */
-export declare type LiquityReceipt<R = unknown, D = unknown> = PendingReceipt | MinedReceipt<R, D>;
-/** @internal */
-export declare type _SendableFrom<T, R, S> = {
-    [M in keyof T]: T[M] extends (...args: infer A) => Promise<infer D> ? (...args: A) => Promise<SentLiquityTransaction<S, LiquityReceipt<R, D>>> : never;
-};
-/**
- * Send Zero transactions.
- *
- * @remarks
- * The functions return an object implementing {@link SentLiquityTransaction}, which can be used
- * to monitor the transaction and get its details when it succeeds.
- *
- * Implemented by {@link @sovryn-zero/lib-ethers#SendableEthersLiquity}.
- *
- * @public
- */
-export interface SendableLiquity<R = unknown, S = unknown> extends _SendableFrom<TransactableLiquity, R, S> {
-    /** {@inheritDoc TransactableLiquity.openTrove} */
-    openTrove(params: TroveCreationParams<Decimalish>, maxBorrowingRate?: Decimalish): Promise<SentLiquityTransaction<S, LiquityReceipt<R, TroveCreationDetails>>>;
-    /** {@inheritDoc TransactableLiquity.closeTrove} */
-    closeTrove(): Promise<SentLiquityTransaction<S, LiquityReceipt<R, TroveClosureDetails>>>;
-    /** {@inheritDoc TransactableLiquity.adjustTrove} */
-    adjustTrove(params: TroveAdjustmentParams<Decimalish>, maxBorrowingRate?: Decimalish): Promise<SentLiquityTransaction<S, LiquityReceipt<R, TroveAdjustmentDetails>>>;
-    /** {@inheritDoc TransactableLiquity.depositCollateral} */
-    depositCollateral(amount: Decimalish): Promise<SentLiquityTransaction<S, LiquityReceipt<R, TroveAdjustmentDetails>>>;
-    /** {@inheritDoc TransactableLiquity.withdrawCollateral} */
-    withdrawCollateral(amount: Decimalish): Promise<SentLiquityTransaction<S, LiquityReceipt<R, TroveAdjustmentDetails>>>;
-    /** {@inheritDoc TransactableLiquity.borrowZUSD} */
-    borrowZUSD(amount: Decimalish, maxBorrowingRate?: Decimalish): Promise<SentLiquityTransaction<S, LiquityReceipt<R, TroveAdjustmentDetails>>>;
-    /** {@inheritDoc TransactableLiquity.repayZUSD} */
-    repayZUSD(amount: Decimalish): Promise<SentLiquityTransaction<S, LiquityReceipt<R, TroveAdjustmentDetails>>>;
-    /** @internal */
-    setPrice(price: Decimalish): Promise<SentLiquityTransaction<S, LiquityReceipt<R, void>>>;
-    /** {@inheritDoc TransactableLiquity.liquidate} */
-    liquidate(address: string | string[]): Promise<SentLiquityTransaction<S, LiquityReceipt<R, LiquidationDetails>>>;
-    /** {@inheritDoc TransactableLiquity.liquidateUpTo} */
-    liquidateUpTo(maximumNumberOfTrovesToLiquidate: number): Promise<SentLiquityTransaction<S, LiquityReceipt<R, LiquidationDetails>>>;
-    /** {@inheritDoc TransactableLiquity.depositZUSDInStabilityPool} */
-    depositZUSDInStabilityPool(amount: Decimalish, frontendTag?: string): Promise<SentLiquityTransaction<S, LiquityReceipt<R, StabilityDepositChangeDetails>>>;
-    /** {@inheritDoc TransactableLiquity.withdrawZUSDFromStabilityPool} */
-    withdrawZUSDFromStabilityPool(amount: Decimalish): Promise<SentLiquityTransaction<S, LiquityReceipt<R, StabilityDepositChangeDetails>>>;
-    /** {@inheritDoc TransactableLiquity.withdrawGainsFromStabilityPool} */
-    withdrawGainsFromStabilityPool(): Promise<SentLiquityTransaction<S, LiquityReceipt<R, StabilityPoolGainsWithdrawalDetails>>>;
-    /** {@inheritDoc TransactableLiquity.transferCollateralGainToTrove} */
-    transferCollateralGainToTrove(): Promise<SentLiquityTransaction<S, LiquityReceipt<R, CollateralGainTransferDetails>>>;
-    /** {@inheritDoc TransactableLiquity.sendZUSD} */
-    sendZUSD(toAddress: string, amount: Decimalish): Promise<SentLiquityTransaction<S, LiquityReceipt<R, void>>>;
-    /** {@inheritDoc TransactableLiquity.sendZERO} */
-    sendZERO(toAddress: string, amount: Decimalish): Promise<SentLiquityTransaction<S, LiquityReceipt<R, void>>>;
-    /** {@inheritDoc TransactableLiquity.redeemZUSD} */
-    redeemZUSD(amount: Decimalish, maxRedemptionRate?: Decimalish): Promise<SentLiquityTransaction<S, LiquityReceipt<R, RedemptionDetails>>>;
-    /** {@inheritDoc TransactableLiquity.claimCollateralSurplus} */
-    claimCollateralSurplus(): Promise<SentLiquityTransaction<S, LiquityReceipt<R, void>>>;
-    /** {@inheritDoc TransactableLiquity.stakeZERO} */
-    stakeZERO(amount: Decimalish): Promise<SentLiquityTransaction<S, LiquityReceipt<R, void>>>;
-    /** {@inheritDoc TransactableLiquity.unstakeZERO} */
-    unstakeZERO(amount: Decimalish): Promise<SentLiquityTransaction<S, LiquityReceipt<R, void>>>;
-    /** {@inheritDoc TransactableLiquity.withdrawGainsFromStaking} */
-    withdrawGainsFromStaking(): Promise<SentLiquityTransaction<S, LiquityReceipt<R, void>>>;
-    /** {@inheritDoc TransactableLiquity.registerFrontend} */
-    registerFrontend(kickbackRate: Decimalish): Promise<SentLiquityTransaction<S, LiquityReceipt<R, void>>>;
-}
+import { Decimalish } from "./Decimal";
+import { TroveAdjustmentParams, TroveCreationParams } from "./Trove";
+import { CollateralGainTransferDetails, LiquidationDetails, RedemptionDetails, StabilityDepositChangeDetails, StabilityPoolGainsWithdrawalDetails, TransactableLiquity, TroveAdjustmentDetails, TroveClosureDetails, TroveCreationDetails } from "./TransactableLiquity";
+/**
+ * A transaction that has already been sent.
+ *
+ * @remarks
+ * Implemented by {@link @sovryn-zero/lib-ethers#SentEthersLiquityTransaction}.
+ *
+ * @public
+ */
+export interface SentLiquityTransaction<S = unknown, T extends LiquityReceipt = LiquityReceipt> {
+    /** Implementation-specific sent transaction object. */
+    readonly rawSentTransaction: S;
+    /**
+     * Check whether the transaction has been mined, and whether it was successful.
+     *
+     * @remarks
+     * Unlike {@link @sovryn-zero/lib-base#SentLiquityTransaction.waitForReceipt | waitForReceipt()},
+     * this function doesn't wait for the transaction to be mined.
+     */
+    getReceipt(): Promise<T>;
+    /**
+     * Wait for the transaction to be mined, and check whether it was successful.
+     *
+     * @returns Either a {@link @sovryn-zero/lib-base#FailedReceipt} or a
+     *          {@link @sovryn-zero/lib-base#SuccessfulReceipt}.
+     */
+    waitForReceipt(): Promise<Extract<T, MinedReceipt>>;
+}
+/**
+ * Indicates that the transaction hasn't been mined yet.
+ *
+ * @remarks
+ * Returned by {@link SentLiquityTransaction.getReceipt}.
+ *
+ * @public
+ */
+export declare type PendingReceipt = {
+    status: "pending";
+};
+/** @internal */
+export declare const _pendingReceipt: PendingReceipt;
+/**
+ * Indicates that the transaction has been mined, but it failed.
+ *
+ * @remarks
+ * The `rawReceipt` property is an implementation-specific transaction receipt object.
+ *
+ * Returned by {@link SentLiquityTransaction.getReceipt} and
+ * {@link SentLiquityTransaction.waitForReceipt}.
+ *
+ * @public
+ */
+export declare type FailedReceipt<R = unknown> = {
+    status: "failed";
+    rawReceipt: R;
+};
+/** @internal */
+export declare const _failedReceipt: <R>(rawReceipt: R) => FailedReceipt<R>;
+/**
+ * Indicates that the transaction has succeeded.
+ *
+ * @remarks
+ * The `rawReceipt` property is an implementation-specific transaction receipt object.
+ *
+ * The `details` property may contain more information about the transaction.
+ * See the return types of {@link TransactableLiquity} functions for the exact contents of `details`
+ * for each type of Zero transaction.
+ *
+ * Returned by {@link SentLiquityTransaction.getReceipt} and
+ * {@link SentLiquityTransaction.waitForReceipt}.
+ *
+ * @public
+ */
+export declare type SuccessfulReceipt<R = unknown, D = unknown> = {
+    status: "succeeded";
+    rawReceipt: R;
+    details: D;
+};
+/** @internal */
+export declare const _successfulReceipt: <R, D>(rawReceipt: R, details: D, toString?: (() => string) | undefined) => SuccessfulReceipt<R, D>;
+/**
+ * Either a {@link FailedReceipt} or a {@link SuccessfulReceipt}.
+ *
+ * @public
+ */
+export declare type MinedReceipt<R = unknown, D = unknown> = FailedReceipt<R> | SuccessfulReceipt<R, D>;
+/**
+ * One of either a {@link PendingReceipt}, a {@link FailedReceipt} or a {@link SuccessfulReceipt}.
+ *
+ * @public
+ */
+export declare type LiquityReceipt<R = unknown, D = unknown> = PendingReceipt | MinedReceipt<R, D>;
+/** @internal */
+export declare type _SendableFrom<T, R, S> = {
+    [M in keyof T]: T[M] extends (...args: infer A) => Promise<infer D> ? (...args: A) => Promise<SentLiquityTransaction<S, LiquityReceipt<R, D>>> : never;
+};
+/**
+ * Send Zero transactions.
+ *
+ * @remarks
+ * The functions return an object implementing {@link SentLiquityTransaction}, which can be used
+ * to monitor the transaction and get its details when it succeeds.
+ *
+ * Implemented by {@link @sovryn-zero/lib-ethers#SendableEthersLiquity}.
+ *
+ * @public
+ */
+export interface SendableLiquity<R = unknown, S = unknown> extends _SendableFrom<TransactableLiquity, R, S> {
+    /** {@inheritDoc TransactableLiquity.openTrove} */
+    openTrove(params: TroveCreationParams<Decimalish>, maxBorrowingRate?: Decimalish): Promise<SentLiquityTransaction<S, LiquityReceipt<R, TroveCreationDetails>>>;
+    /** {@inheritDoc TransactableLiquity.closeTrove} */
+    closeTrove(): Promise<SentLiquityTransaction<S, LiquityReceipt<R, TroveClosureDetails>>>;
+    /** {@inheritDoc TransactableLiquity.adjustTrove} */
+    adjustTrove(params: TroveAdjustmentParams<Decimalish>, maxBorrowingRate?: Decimalish): Promise<SentLiquityTransaction<S, LiquityReceipt<R, TroveAdjustmentDetails>>>;
+    /** {@inheritDoc TransactableLiquity.depositCollateral} */
+    depositCollateral(amount: Decimalish): Promise<SentLiquityTransaction<S, LiquityReceipt<R, TroveAdjustmentDetails>>>;
+    /** {@inheritDoc TransactableLiquity.withdrawCollateral} */
+    withdrawCollateral(amount: Decimalish): Promise<SentLiquityTransaction<S, LiquityReceipt<R, TroveAdjustmentDetails>>>;
+    /** {@inheritDoc TransactableLiquity.borrowZUSD} */
+    borrowZUSD(amount: Decimalish, maxBorrowingRate?: Decimalish): Promise<SentLiquityTransaction<S, LiquityReceipt<R, TroveAdjustmentDetails>>>;
+    /** {@inheritDoc TransactableLiquity.repayZUSD} */
+    repayZUSD(amount: Decimalish): Promise<SentLiquityTransaction<S, LiquityReceipt<R, TroveAdjustmentDetails>>>;
+    /** @internal */
+    setPrice(price: Decimalish): Promise<SentLiquityTransaction<S, LiquityReceipt<R, void>>>;
+    /** {@inheritDoc TransactableLiquity.liquidate} */
+    liquidate(address: string | string[]): Promise<SentLiquityTransaction<S, LiquityReceipt<R, LiquidationDetails>>>;
+    /** {@inheritDoc TransactableLiquity.liquidateUpTo} */
+    liquidateUpTo(maximumNumberOfTrovesToLiquidate: number): Promise<SentLiquityTransaction<S, LiquityReceipt<R, LiquidationDetails>>>;
+    /** {@inheritDoc TransactableLiquity.depositZUSDInStabilityPool} */
+    depositZUSDInStabilityPool(amount: Decimalish, frontendTag?: string): Promise<SentLiquityTransaction<S, LiquityReceipt<R, StabilityDepositChangeDetails>>>;
+    /** {@inheritDoc TransactableLiquity.withdrawZUSDFromStabilityPool} */
+    withdrawZUSDFromStabilityPool(amount: Decimalish): Promise<SentLiquityTransaction<S, LiquityReceipt<R, StabilityDepositChangeDetails>>>;
+    /** {@inheritDoc TransactableLiquity.withdrawGainsFromStabilityPool} */
+    withdrawGainsFromStabilityPool(): Promise<SentLiquityTransaction<S, LiquityReceipt<R, StabilityPoolGainsWithdrawalDetails>>>;
+    /** {@inheritDoc TransactableLiquity.transferCollateralGainToTrove} */
+    transferCollateralGainToTrove(): Promise<SentLiquityTransaction<S, LiquityReceipt<R, CollateralGainTransferDetails>>>;
+    /** {@inheritDoc TransactableLiquity.sendZUSD} */
+    sendZUSD(toAddress: string, amount: Decimalish): Promise<SentLiquityTransaction<S, LiquityReceipt<R, void>>>;
+    /** {@inheritDoc TransactableLiquity.sendZERO} */
+    sendZERO(toAddress: string, amount: Decimalish): Promise<SentLiquityTransaction<S, LiquityReceipt<R, void>>>;
+    /** {@inheritDoc TransactableLiquity.redeemZUSD} */
+    redeemZUSD(amount: Decimalish, maxRedemptionRate?: Decimalish): Promise<SentLiquityTransaction<S, LiquityReceipt<R, RedemptionDetails>>>;
+    /** {@inheritDoc TransactableLiquity.claimCollateralSurplus} */
+    claimCollateralSurplus(): Promise<SentLiquityTransaction<S, LiquityReceipt<R, void>>>;
+    /** {@inheritDoc TransactableLiquity.stakeZERO} */
+    stakeZERO(amount: Decimalish): Promise<SentLiquityTransaction<S, LiquityReceipt<R, void>>>;
+    /** {@inheritDoc TransactableLiquity.unstakeZERO} */
+    unstakeZERO(amount: Decimalish): Promise<SentLiquityTransaction<S, LiquityReceipt<R, void>>>;
+    /** {@inheritDoc TransactableLiquity.withdrawGainsFromStaking} */
+    withdrawGainsFromStaking(): Promise<SentLiquityTransaction<S, LiquityReceipt<R, void>>>;
+    /** {@inheritDoc TransactableLiquity.registerFrontend} */
+    registerFrontend(kickbackRate: Decimalish): Promise<SentLiquityTransaction<S, LiquityReceipt<R, void>>>;
+}
 //# sourceMappingURL=SendableLiquity.d.ts.map

package/dist/src/SendableLiquity.js

@@ -1,20 +1,20 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports._successfulReceipt = exports._failedReceipt = exports._pendingReceipt = void 0;
-/** @internal */
-exports._pendingReceipt = { status: "pending" };
-/** @internal */
-const _failedReceipt = (rawReceipt) => ({
-    status: "failed",
-    rawReceipt
-});
-exports._failedReceipt = _failedReceipt;
-/** @internal */
-const _successfulReceipt = (rawReceipt, details, toString) => ({
-    status: "succeeded",
-    rawReceipt,
-    details,
-    ...(toString ? { toString } : {})
-});
-exports._successfulReceipt = _successfulReceipt;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports._successfulReceipt = exports._failedReceipt = exports._pendingReceipt = void 0;
+/** @internal */
+exports._pendingReceipt = { status: "pending" };
+/** @internal */
+const _failedReceipt = (rawReceipt) => ({
+    status: "failed",
+    rawReceipt
+});
+exports._failedReceipt = _failedReceipt;
+/** @internal */
+const _successfulReceipt = (rawReceipt, details, toString) => ({
+    status: "succeeded",
+    rawReceipt,
+    details,
+    ...(toString ? { toString } : {})
+});
+exports._successfulReceipt = _successfulReceipt;
 //# sourceMappingURL=SendableLiquity.js.map

package/dist/src/StabilityDeposit.d.ts

@@ -1,59 +1,59 @@
-import { Decimal, Decimalish } from "./Decimal";
-/**
- * Represents the change between two Stability Deposit states.
- *
- * @public
- */
-export declare type StabilityDepositChange<T> = {
-    depositZUSD: T;
-    withdrawZUSD?: undefined;
-} | {
-    depositZUSD?: undefined;
-    withdrawZUSD: T;
-    withdrawAllZUSD: boolean;
-};
-/**
- * A Stability Deposit and its accrued gains.
- *
- * @public
- */
-export declare class StabilityDeposit {
-    /** Amount of ZUSD in the Stability Deposit at the time of the last direct modification. */
-    readonly initialZUSD: Decimal;
-    /** Amount of ZUSD left in the Stability Deposit. */
-    readonly currentZUSD: Decimal;
-    /** Amount of native currency (e.g. Ether) received in exchange for the used-up ZUSD. */
-    readonly collateralGain: Decimal;
-    /** Amount of ZERO rewarded since the last modification of the Stability Deposit. */
-    readonly zeroReward: Decimal;
-    /**
-     * Address of frontend through which this Stability Deposit was made.
-     *
-     * @remarks
-     * If the Stability Deposit was made through a frontend that doesn't tag deposits, this will be
-     * the zero-address.
-     */
-    readonly frontendTag: string;
-    /** @internal */
-    constructor(initialZUSD: Decimal, currentZUSD: Decimal, collateralGain: Decimal, zeroReward: Decimal, frontendTag: string);
-    get isEmpty(): boolean;
-    /** @internal */
-    toString(): string;
-    /**
-     * Compare to another instance of `StabilityDeposit`.
-     */
-    equals(that: StabilityDeposit): boolean;
-    /**
-     * Calculate the difference between the `currentZUSD` in this Stability Deposit and `thatZUSD`.
-     *
-     * @returns An object representing the change, or `undefined` if the deposited amounts are equal.
-     */
-    whatChanged(thatZUSD: Decimalish): StabilityDepositChange<Decimal> | undefined;
-    /**
-     * Apply a {@link StabilityDepositChange} to this Stability Deposit.
-     *
-     * @returns The new deposited ZUSD amount.
-     */
-    apply(change: StabilityDepositChange<Decimalish> | undefined): Decimal;
-}
+import { Decimal, Decimalish } from "./Decimal";
+/**
+ * Represents the change between two Stability Deposit states.
+ *
+ * @public
+ */
+export declare type StabilityDepositChange<T> = {
+    depositZUSD: T;
+    withdrawZUSD?: undefined;
+} | {
+    depositZUSD?: undefined;
+    withdrawZUSD: T;
+    withdrawAllZUSD: boolean;
+};
+/**
+ * A Stability Deposit and its accrued gains.
+ *
+ * @public
+ */
+export declare class StabilityDeposit {
+    /** Amount of ZUSD in the Stability Deposit at the time of the last direct modification. */
+    readonly initialZUSD: Decimal;
+    /** Amount of ZUSD left in the Stability Deposit. */
+    readonly currentZUSD: Decimal;
+    /** Amount of native currency (e.g. Ether) received in exchange for the used-up ZUSD. */
+    readonly collateralGain: Decimal;
+    /** Amount of ZERO rewarded since the last modification of the Stability Deposit. */
+    readonly zeroReward: Decimal;
+    /**
+     * Address of frontend through which this Stability Deposit was made.
+     *
+     * @remarks
+     * If the Stability Deposit was made through a frontend that doesn't tag deposits, this will be
+     * the zero-address.
+     */
+    readonly frontendTag: string;
+    /** @internal */
+    constructor(initialZUSD: Decimal, currentZUSD: Decimal, collateralGain: Decimal, zeroReward: Decimal, frontendTag: string);
+    get isEmpty(): boolean;
+    /** @internal */
+    toString(): string;
+    /**
+     * Compare to another instance of `StabilityDeposit`.
+     */
+    equals(that: StabilityDeposit): boolean;
+    /**
+     * Calculate the difference between the `currentZUSD` in this Stability Deposit and `thatZUSD`.
+     *
+     * @returns An object representing the change, or `undefined` if the deposited amounts are equal.
+     */
+    whatChanged(thatZUSD: Decimalish): StabilityDepositChange<Decimal> | undefined;
+    /**
+     * Apply a {@link StabilityDepositChange} to this Stability Deposit.
+     *
+     * @returns The new deposited ZUSD amount.
+     */
+    apply(change: StabilityDepositChange<Decimalish> | undefined): Decimal;
+}
 //# sourceMappingURL=StabilityDeposit.d.ts.map

package/dist/src/StabilityDeposit.js

@@ -1,80 +1,80 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.StabilityDeposit = void 0;
-const Decimal_1 = require("./Decimal");
-/**
- * A Stability Deposit and its accrued gains.
- *
- * @public
- */
-class StabilityDeposit {
-    /** @internal */
-    constructor(initialZUSD, currentZUSD, collateralGain, zeroReward, frontendTag) {
-        this.initialZUSD = initialZUSD;
-        this.currentZUSD = currentZUSD;
-        this.collateralGain = collateralGain;
-        this.zeroReward = zeroReward;
-        this.frontendTag = frontendTag;
-        if (this.currentZUSD.gt(this.initialZUSD)) {
-            throw new Error("currentZUSD can't be greater than initialZUSD");
-        }
-    }
-    get isEmpty() {
-        return (this.initialZUSD.isZero &&
-            this.currentZUSD.isZero &&
-            this.collateralGain.isZero &&
-            this.zeroReward.isZero);
-    }
-    /** @internal */
-    toString() {
-        return (`{ initialZUSD: ${this.initialZUSD}` +
-            `, currentZUSD: ${this.currentZUSD}` +
-            `, collateralGain: ${this.collateralGain}` +
-            `, zeroReward: ${this.zeroReward}` +
-            `, frontendTag: "${this.frontendTag}" }`);
-    }
-    /**
-     * Compare to another instance of `StabilityDeposit`.
-     */
-    equals(that) {
-        return (this.initialZUSD.eq(that.initialZUSD) &&
-            this.currentZUSD.eq(that.currentZUSD) &&
-            this.collateralGain.eq(that.collateralGain) &&
-            this.zeroReward.eq(that.zeroReward) &&
-            this.frontendTag === that.frontendTag);
-    }
-    /**
-     * Calculate the difference between the `currentZUSD` in this Stability Deposit and `thatZUSD`.
-     *
-     * @returns An object representing the change, or `undefined` if the deposited amounts are equal.
-     */
-    whatChanged(thatZUSD) {
-        thatZUSD = Decimal_1.Decimal.from(thatZUSD);
-        if (thatZUSD.lt(this.currentZUSD)) {
-            return { withdrawZUSD: this.currentZUSD.sub(thatZUSD), withdrawAllZUSD: thatZUSD.isZero };
-        }
-        if (thatZUSD.gt(this.currentZUSD)) {
-            return { depositZUSD: thatZUSD.sub(this.currentZUSD) };
-        }
-    }
-    /**
-     * Apply a {@link StabilityDepositChange} to this Stability Deposit.
-     *
-     * @returns The new deposited ZUSD amount.
-     */
-    apply(change) {
-        if (!change) {
-            return this.currentZUSD;
-        }
-        if (change.withdrawZUSD !== undefined) {
-            return change.withdrawAllZUSD || this.currentZUSD.lte(change.withdrawZUSD)
-                ? Decimal_1.Decimal.ZERO
-                : this.currentZUSD.sub(change.withdrawZUSD);
-        }
-        else {
-            return this.currentZUSD.add(change.depositZUSD);
-        }
-    }
-}
-exports.StabilityDeposit = StabilityDeposit;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StabilityDeposit = void 0;
+const Decimal_1 = require("./Decimal");
+/**
+ * A Stability Deposit and its accrued gains.
+ *
+ * @public
+ */
+class StabilityDeposit {
+    /** @internal */
+    constructor(initialZUSD, currentZUSD, collateralGain, zeroReward, frontendTag) {
+        this.initialZUSD = initialZUSD;
+        this.currentZUSD = currentZUSD;
+        this.collateralGain = collateralGain;
+        this.zeroReward = zeroReward;
+        this.frontendTag = frontendTag;
+        if (this.currentZUSD.gt(this.initialZUSD)) {
+            throw new Error("currentZUSD can't be greater than initialZUSD");
+        }
+    }
+    get isEmpty() {
+        return (this.initialZUSD.isZero &&
+            this.currentZUSD.isZero &&
+            this.collateralGain.isZero &&
+            this.zeroReward.isZero);
+    }
+    /** @internal */
+    toString() {
+        return (`{ initialZUSD: ${this.initialZUSD}` +
+            `, currentZUSD: ${this.currentZUSD}` +
+            `, collateralGain: ${this.collateralGain}` +
+            `, zeroReward: ${this.zeroReward}` +
+            `, frontendTag: "${this.frontendTag}" }`);
+    }
+    /**
+     * Compare to another instance of `StabilityDeposit`.
+     */
+    equals(that) {
+        return (this.initialZUSD.eq(that.initialZUSD) &&
+            this.currentZUSD.eq(that.currentZUSD) &&
+            this.collateralGain.eq(that.collateralGain) &&
+            this.zeroReward.eq(that.zeroReward) &&
+            this.frontendTag === that.frontendTag);
+    }
+    /**
+     * Calculate the difference between the `currentZUSD` in this Stability Deposit and `thatZUSD`.
+     *
+     * @returns An object representing the change, or `undefined` if the deposited amounts are equal.
+     */
+    whatChanged(thatZUSD) {
+        thatZUSD = Decimal_1.Decimal.from(thatZUSD);
+        if (thatZUSD.lt(this.currentZUSD)) {
+            return { withdrawZUSD: this.currentZUSD.sub(thatZUSD), withdrawAllZUSD: thatZUSD.isZero };
+        }
+        if (thatZUSD.gt(this.currentZUSD)) {
+            return { depositZUSD: thatZUSD.sub(this.currentZUSD) };
+        }
+    }
+    /**
+     * Apply a {@link StabilityDepositChange} to this Stability Deposit.
+     *
+     * @returns The new deposited ZUSD amount.
+     */
+    apply(change) {
+        if (!change) {
+            return this.currentZUSD;
+        }
+        if (change.withdrawZUSD !== undefined) {
+            return change.withdrawAllZUSD || this.currentZUSD.lte(change.withdrawZUSD)
+                ? Decimal_1.Decimal.ZERO
+                : this.currentZUSD.sub(change.withdrawZUSD);
+        }
+        else {
+            return this.currentZUSD.add(change.depositZUSD);
+        }
+    }
+}
+exports.StabilityDeposit = StabilityDeposit;
 //# sourceMappingURL=StabilityDeposit.js.map