@sovryn-zero/lib-base 0.1.0

package/dist/src/Trove.js

@@ -0,0 +1,423 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TroveWithPendingRedistribution = exports.UserTrove = exports._emptyTrove = exports.Trove = exports._normalizeTroveAdjustment = exports._normalizeTroveCreation = void 0;
+const assert_1 = __importDefault(require("assert"));
+const Decimal_1 = require("./Decimal");
+const constants_1 = require("./constants");
+const invalidTroveCreation = (invalidTrove, error) => ({
+    type: "invalidCreation",
+    invalidTrove,
+    error
+});
+const troveCreation = (params) => ({
+    type: "creation",
+    params
+});
+const troveClosure = (params) => ({
+    type: "closure",
+    params
+});
+const troveAdjustment = (params, setToZero) => ({
+    type: "adjustment",
+    params,
+    setToZero
+});
+const valueIsDefined = (entry) => entry[1] !== undefined;
+const allowedTroveCreationKeys = [
+    "depositCollateral",
+    "borrowZUSD"
+];
+function checkAllowedTroveCreationKeys(entries) {
+    const badKeys = entries
+        .filter(([k]) => !allowedTroveCreationKeys.includes(k))
+        .map(([k]) => `'${k}'`);
+    if (badKeys.length > 0) {
+        throw new Error(`TroveCreationParams: property ${badKeys.join(", ")} not allowed`);
+    }
+}
+const troveCreationParamsFromEntries = (entries) => {
+    const params = Object.fromEntries(entries);
+    const missingKeys = allowedTroveCreationKeys.filter(k => !(k in params)).map(k => `'${k}'`);
+    if (missingKeys.length > 0) {
+        throw new Error(`TroveCreationParams: property ${missingKeys.join(", ")} missing`);
+    }
+    return params;
+};
+const decimalize = ([k, v]) => [k, Decimal_1.Decimal.from(v)];
+const nonZero = ([, v]) => !v.isZero;
+/** @internal */
+const _normalizeTroveCreation = (params) => {
+    const definedEntries = Object.entries(params).filter(valueIsDefined);
+    checkAllowedTroveCreationKeys(definedEntries);
+    const nonZeroEntries = definedEntries.map(decimalize);
+    return troveCreationParamsFromEntries(nonZeroEntries);
+};
+exports._normalizeTroveCreation = _normalizeTroveCreation;
+const allowedTroveAdjustmentKeys = [
+    "depositCollateral",
+    "withdrawCollateral",
+    "borrowZUSD",
+    "repayZUSD"
+];
+function checkAllowedTroveAdjustmentKeys(entries) {
+    const badKeys = entries
+        .filter(([k]) => !allowedTroveAdjustmentKeys.includes(k))
+        .map(([k]) => `'${k}'`);
+    if (badKeys.length > 0) {
+        throw new Error(`TroveAdjustmentParams: property ${badKeys.join(", ")} not allowed`);
+    }
+}
+const collateralChangeFrom = ({ depositCollateral, withdrawCollateral }) => {
+    if (depositCollateral !== undefined && withdrawCollateral !== undefined) {
+        throw new Error("TroveAdjustmentParams: 'depositCollateral' and 'withdrawCollateral' " +
+            "can't be present at the same time");
+    }
+    if (depositCollateral !== undefined) {
+        return { depositCollateral };
+    }
+    if (withdrawCollateral !== undefined) {
+        return { withdrawCollateral };
+    }
+};
+const debtChangeFrom = ({ borrowZUSD, repayZUSD }) => {
+    if (borrowZUSD !== undefined && repayZUSD !== undefined) {
+        throw new Error("TroveAdjustmentParams: 'borrowZUSD' and 'repayZUSD' can't be present at the same time");
+    }
+    if (borrowZUSD !== undefined) {
+        return { borrowZUSD };
+    }
+    if (repayZUSD !== undefined) {
+        return { repayZUSD };
+    }
+};
+const troveAdjustmentParamsFromEntries = (entries) => {
+    const params = Object.fromEntries(entries);
+    const collateralChange = collateralChangeFrom(params);
+    const debtChange = debtChangeFrom(params);
+    if (collateralChange !== undefined && debtChange !== undefined) {
+        return { ...collateralChange, ...debtChange };
+    }
+    if (collateralChange !== undefined) {
+        return collateralChange;
+    }
+    if (debtChange !== undefined) {
+        return debtChange;
+    }
+    throw new Error("TroveAdjustmentParams: must include at least one non-zero parameter");
+};
+/** @internal */
+const _normalizeTroveAdjustment = (params) => {
+    const definedEntries = Object.entries(params).filter(valueIsDefined);
+    checkAllowedTroveAdjustmentKeys(definedEntries);
+    const nonZeroEntries = definedEntries.map(decimalize).filter(nonZero);
+    return troveAdjustmentParamsFromEntries(nonZeroEntries);
+};
+exports._normalizeTroveAdjustment = _normalizeTroveAdjustment;
+const applyFee = (borrowingRate, debtIncrease) => debtIncrease.mul(Decimal_1.Decimal.ONE.add(borrowingRate));
+const unapplyFee = (borrowingRate, debtIncrease) => debtIncrease._divCeil(Decimal_1.Decimal.ONE.add(borrowingRate));
+const NOMINAL_COLLATERAL_RATIO_PRECISION = Decimal_1.Decimal.from(100);
+/**
+ * A combination of collateral and debt.
+ *
+ * @public
+ */
+class Trove {
+    /** @internal */
+    constructor(collateral = Decimal_1.Decimal.ZERO, debt = Decimal_1.Decimal.ZERO) {
+        this.collateral = collateral;
+        this.debt = debt;
+    }
+    get isEmpty() {
+        return this.collateral.isZero && this.debt.isZero;
+    }
+    /**
+     * Amount of ZUSD that must be repaid to close this Trove.
+     *
+     * @remarks
+     * This doesn't include the liquidation reserve, which is refunded in case of normal closure.
+     */
+    get netDebt() {
+        if (this.debt.lt(constants_1.ZUSD_LIQUIDATION_RESERVE)) {
+            throw new Error(`netDebt should not be used when debt < ${constants_1.ZUSD_LIQUIDATION_RESERVE}`);
+        }
+        return this.debt.sub(constants_1.ZUSD_LIQUIDATION_RESERVE);
+    }
+    /** @internal */
+    get _nominalCollateralRatio() {
+        return this.collateral.mulDiv(NOMINAL_COLLATERAL_RATIO_PRECISION, this.debt);
+    }
+    /** Calculate the Trove's collateralization ratio at a given price. */
+    collateralRatio(price) {
+        return this.collateral.mulDiv(price, this.debt);
+    }
+    /**
+     * Whether the Trove is undercollateralized at a given price.
+     *
+     * @returns
+     * `true` if the Trove's collateralization ratio is less than the
+     * {@link MINIMUM_COLLATERAL_RATIO}.
+     */
+    collateralRatioIsBelowMinimum(price) {
+        return this.collateralRatio(price).lt(constants_1.MINIMUM_COLLATERAL_RATIO);
+    }
+    /**
+     * Whether the collateralization ratio is less than the {@link CRITICAL_COLLATERAL_RATIO} at a
+     * given price.
+     *
+     * @example
+     * Can be used to check whether the Zero protocol is in recovery mode by using it on the return
+     * value of {@link ReadableLiquity.getTotal | getTotal()}. For example:
+     *
+     * ```typescript
+     * const total = await zero.getTotal();
+     * const price = await zero.getPrice();
+     *
+     * if (total.collateralRatioIsBelowCritical(price)) {
+     *   // Recovery mode is active
+     * }
+     * ```
+     */
+    collateralRatioIsBelowCritical(price) {
+        return this.collateralRatio(price).lt(constants_1.CRITICAL_COLLATERAL_RATIO);
+    }
+    /** Whether the Trove is sufficiently collateralized to be opened during recovery mode. */
+    isOpenableInRecoveryMode(price) {
+        return this.collateralRatio(price).gte(constants_1.CRITICAL_COLLATERAL_RATIO);
+    }
+    /** @internal */
+    toString() {
+        return `{ collateral: ${this.collateral}, debt: ${this.debt} }`;
+    }
+    equals(that) {
+        return this.collateral.eq(that.collateral) && this.debt.eq(that.debt);
+    }
+    add(that) {
+        return new Trove(this.collateral.add(that.collateral), this.debt.add(that.debt));
+    }
+    addCollateral(collateral) {
+        return new Trove(this.collateral.add(collateral), this.debt);
+    }
+    addDebt(debt) {
+        return new Trove(this.collateral, this.debt.add(debt));
+    }
+    subtract(that) {
+        const { collateral, debt } = that;
+        return new Trove(this.collateral.gt(collateral) ? this.collateral.sub(collateral) : Decimal_1.Decimal.ZERO, this.debt.gt(debt) ? this.debt.sub(debt) : Decimal_1.Decimal.ZERO);
+    }
+    subtractCollateral(collateral) {
+        return new Trove(this.collateral.gt(collateral) ? this.collateral.sub(collateral) : Decimal_1.Decimal.ZERO, this.debt);
+    }
+    subtractDebt(debt) {
+        return new Trove(this.collateral, this.debt.gt(debt) ? this.debt.sub(debt) : Decimal_1.Decimal.ZERO);
+    }
+    multiply(multiplier) {
+        return new Trove(this.collateral.mul(multiplier), this.debt.mul(multiplier));
+    }
+    setCollateral(collateral) {
+        return new Trove(Decimal_1.Decimal.from(collateral), this.debt);
+    }
+    setDebt(debt) {
+        return new Trove(this.collateral, Decimal_1.Decimal.from(debt));
+    }
+    _debtChange({ debt }, borrowingRate) {
+        return debt.gt(this.debt)
+            ? { borrowZUSD: unapplyFee(borrowingRate, debt.sub(this.debt)) }
+            : { repayZUSD: this.debt.sub(debt) };
+    }
+    _collateralChange({ collateral }) {
+        return collateral.gt(this.collateral)
+            ? { depositCollateral: collateral.sub(this.collateral) }
+            : { withdrawCollateral: this.collateral.sub(collateral) };
+    }
+    /**
+     * Calculate the difference between this Trove and another.
+     *
+     * @param that - The other Trove.
+     * @param borrowingRate - Borrowing rate to use when calculating a borrowed amount.
+     *
+     * @returns
+     * An object representing the change, or `undefined` if the Troves are equal.
+     */
+    whatChanged(that, borrowingRate = constants_1.MINIMUM_BORROWING_RATE) {
+        var _a;
+        if (this.collateral.eq(that.collateral) && this.debt.eq(that.debt)) {
+            return undefined;
+        }
+        if (this.isEmpty) {
+            if (that.debt.lt(constants_1.ZUSD_LIQUIDATION_RESERVE)) {
+                return invalidTroveCreation(that, "missingLiquidationReserve");
+            }
+            return troveCreation({
+                depositCollateral: that.collateral,
+                borrowZUSD: unapplyFee(borrowingRate, that.netDebt)
+            });
+        }
+        if (that.isEmpty) {
+            return troveClosure(this.netDebt.nonZero
+                ? { withdrawCollateral: this.collateral, repayZUSD: this.netDebt }
+                : { withdrawCollateral: this.collateral });
+        }
+        return this.collateral.eq(that.collateral)
+            ? troveAdjustment(this._debtChange(that, borrowingRate), that.debt.zero && "debt")
+            : this.debt.eq(that.debt)
+                ? troveAdjustment(this._collateralChange(that), that.collateral.zero && "collateral")
+                : troveAdjustment({
+                    ...this._debtChange(that, borrowingRate),
+                    ...this._collateralChange(that)
+                }, (_a = (that.debt.zero && "debt")) !== null && _a !== void 0 ? _a : (that.collateral.zero && "collateral"));
+    }
+    /**
+     * Make a new Trove by applying a {@link TroveChange} to this Trove.
+     *
+     * @param change - The change to apply.
+     * @param borrowingRate - Borrowing rate to use when adding a borrowed amount to the Trove's debt.
+     */
+    apply(change, borrowingRate = constants_1.MINIMUM_BORROWING_RATE) {
+        if (!change) {
+            return this;
+        }
+        switch (change.type) {
+            case "invalidCreation":
+                if (!this.isEmpty) {
+                    throw new Error("Can't create onto existing Trove");
+                }
+                return change.invalidTrove;
+            case "creation": {
+                if (!this.isEmpty) {
+                    throw new Error("Can't create onto existing Trove");
+                }
+                const { depositCollateral, borrowZUSD } = change.params;
+                return new Trove(depositCollateral, constants_1.ZUSD_LIQUIDATION_RESERVE.add(applyFee(borrowingRate, borrowZUSD)));
+            }
+            case "closure":
+                if (this.isEmpty) {
+                    throw new Error("Can't close empty Trove");
+                }
+                return exports._emptyTrove;
+            case "adjustment": {
+                const { setToZero, params: { depositCollateral, withdrawCollateral, borrowZUSD, repayZUSD } } = change;
+                const collateralDecrease = withdrawCollateral !== null && withdrawCollateral !== void 0 ? withdrawCollateral : Decimal_1.Decimal.ZERO;
+                const collateralIncrease = depositCollateral !== null && depositCollateral !== void 0 ? depositCollateral : Decimal_1.Decimal.ZERO;
+                const debtDecrease = repayZUSD !== null && repayZUSD !== void 0 ? repayZUSD : Decimal_1.Decimal.ZERO;
+                const debtIncrease = borrowZUSD ? applyFee(borrowingRate, borrowZUSD) : Decimal_1.Decimal.ZERO;
+                return setToZero === "collateral"
+                    ? this.setCollateral(Decimal_1.Decimal.ZERO).addDebt(debtIncrease).subtractDebt(debtDecrease)
+                    : setToZero === "debt"
+                        ? this.setDebt(Decimal_1.Decimal.ZERO)
+                            .addCollateral(collateralIncrease)
+                            .subtractCollateral(collateralDecrease)
+                        : this.add(new Trove(collateralIncrease, debtIncrease)).subtract(new Trove(collateralDecrease, debtDecrease));
+            }
+        }
+    }
+    /**
+     * Calculate the result of an {@link TransactableLiquity.openTrove | openTrove()} transaction.
+     *
+     * @param params - Parameters of the transaction.
+     * @param borrowingRate - Borrowing rate to use when calculating the Trove's debt.
+     */
+    static create(params, borrowingRate) {
+        return exports._emptyTrove.apply(troveCreation(exports._normalizeTroveCreation(params)), borrowingRate);
+    }
+    /**
+     * Calculate the parameters of an {@link TransactableLiquity.openTrove | openTrove()} transaction
+     * that will result in the given Trove.
+     *
+     * @param that - The Trove to recreate.
+     * @param borrowingRate - Current borrowing rate.
+     */
+    static recreate(that, borrowingRate) {
+        const change = exports._emptyTrove.whatChanged(that, borrowingRate);
+        assert_1.default((change === null || change === void 0 ? void 0 : change.type) === "creation");
+        return change.params;
+    }
+    /**
+     * Calculate the result of an {@link TransactableLiquity.adjustTrove | adjustTrove()} transaction
+     * on this Trove.
+     *
+     * @param params - Parameters of the transaction.
+     * @param borrowingRate - Borrowing rate to use when adding to the Trove's debt.
+     */
+    adjust(params, borrowingRate) {
+        return this.apply(troveAdjustment(exports._normalizeTroveAdjustment(params)), borrowingRate);
+    }
+    /**
+     * Calculate the parameters of an {@link TransactableLiquity.adjustTrove | adjustTrove()}
+     * transaction that will change this Trove into the given Trove.
+     *
+     * @param that - The desired result of the transaction.
+     * @param borrowingRate - Current borrowing rate.
+     */
+    adjustTo(that, borrowingRate) {
+        const change = this.whatChanged(that, borrowingRate);
+        assert_1.default((change === null || change === void 0 ? void 0 : change.type) === "adjustment");
+        return change.params;
+    }
+}
+exports.Trove = Trove;
+/** @internal */
+exports._emptyTrove = new Trove();
+/**
+ * A Trove that is associated with a single owner.
+ *
+ * @remarks
+ * The SDK uses the base {@link Trove} class as a generic container of collateral and debt, for
+ * example to represent the {@link ReadableLiquity.getTotal | total collateral and debt} locked up
+ * in the protocol.
+ *
+ * The `UserTrove` class extends `Trove` with extra information that's only available for Troves
+ * that are associated with a single owner (such as the owner's address, or the Trove's status).
+ *
+ * @public
+ */
+class UserTrove extends Trove {
+    /** @internal */
+    constructor(ownerAddress, status, collateral, debt) {
+        super(collateral, debt);
+        this.ownerAddress = ownerAddress;
+        this.status = status;
+    }
+    equals(that) {
+        return (super.equals(that) && this.ownerAddress === that.ownerAddress && this.status === that.status);
+    }
+    /** @internal */
+    toString() {
+        return (`{ ownerAddress: "${this.ownerAddress}"` +
+            `, collateral: ${this.collateral}` +
+            `, debt: ${this.debt}` +
+            `, status: "${this.status}" }`);
+    }
+}
+exports.UserTrove = UserTrove;
+/**
+ * A Trove in its state after the last direct modification.
+ *
+ * @remarks
+ * The Trove may have received collateral and debt shares from liquidations since then.
+ * Use {@link TroveWithPendingRedistribution.applyRedistribution | applyRedistribution()} to
+ * calculate the Trove's most up-to-date state.
+ *
+ * @public
+ */
+class TroveWithPendingRedistribution extends UserTrove {
+    /** @internal */
+    constructor(ownerAddress, status, collateral, debt, stake = Decimal_1.Decimal.ZERO, snapshotOfTotalRedistributed = exports._emptyTrove) {
+        super(ownerAddress, status, collateral, debt);
+        this.stake = stake;
+        this.snapshotOfTotalRedistributed = snapshotOfTotalRedistributed;
+    }
+    applyRedistribution(totalRedistributed) {
+        const afterRedistribution = this.add(totalRedistributed.subtract(this.snapshotOfTotalRedistributed).multiply(this.stake));
+        return new UserTrove(this.ownerAddress, this.status, afterRedistribution.collateral, afterRedistribution.debt);
+    }
+    equals(that) {
+        return (super.equals(that) &&
+            this.stake.eq(that.stake) &&
+            this.snapshotOfTotalRedistributed.equals(that.snapshotOfTotalRedistributed));
+    }
+}
+exports.TroveWithPendingRedistribution = TroveWithPendingRedistribution;
+//# sourceMappingURL=Trove.js.map

package/dist/src/Trove.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Trove.js","sourceRoot":"","sources":["../../src/Trove.ts"],"names":[],"mappings":";;;;;;AAAA,oDAA4B;AAE5B,uCAAgD;AAEhD,2CAKqB;AAkNrB,MAAM,oBAAoB,GAAG,CAC3B,YAAmB,EACnB,KAAyB,EACH,EAAE,CAAC,CAAC;IAC1B,IAAI,EAAE,iBAAiB;IACvB,YAAY;IACZ,KAAK;CACN,CAAC,CAAC;AAEH,MAAM,aAAa,GAAG,CAAI,MAA8B,EAAoB,EAAE,CAAC,CAAC;IAC9E,IAAI,EAAE,UAAU;IAChB,MAAM;CACP,CAAC,CAAC;AAEH,MAAM,YAAY,GAAG,CAAI,MAA6B,EAAmB,EAAE,CAAC,CAAC;IAC3E,IAAI,EAAE,SAAS;IACf,MAAM;CACP,CAAC,CAAC;AAEH,MAAM,eAAe,GAAG,CACtB,MAAgC,EAChC,SAAiC,EACb,EAAE,CAAC,CAAC;IACxB,IAAI,EAAE,YAAY;IAClB,MAAM;IACN,SAAS;CACV,CAAC,CAAC;AAEH,MAAM,cAAc,GAAG,CAAI,KAA8B,EAAwB,EAAE,CACjF,KAAK,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC;AASzB,MAAM,wBAAwB,GAAsC;IAClE,mBAAmB;IACnB,YAAY;CACb,CAAC;AAEF,SAAS,6BAA6B,CACpC,OAAsB;IAEtB,MAAM,OAAO,GAAG,OAAO;SACpB,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAE,wBAAqC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;SACpE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAE1B,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;QACtB,MAAM,IAAI,KAAK,CAAC,iCAAiC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;KACpF;AACH,CAAC;AAED,MAAM,8BAA8B,GAAG,CACrC,OAA+C,EACvB,EAAE;IAC1B,MAAM,MAAM,GAAG,MAAM,CAAC,WAAW,CAAC,OAAO,CAA+C,CAAC;IACzF,MAAM,WAAW,GAAG,wBAAwB,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAE5F,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE;QAC1B,MAAM,IAAI,KAAK,CAAC,iCAAiC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;KACpF;IAED,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CAAI,CAAC,CAAC,EAAE,CAAC,CAAkB,EAAgB,EAAE,CAAC,CAAC,CAAC,EAAE,iBAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;AACtF,MAAM,OAAO,GAAG,CAAI,CAAC,EAAE,CAAC,CAAe,EAAW,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;AAE/D,gBAAgB;AACT,MAAM,uBAAuB,GAAG,CACrC,MAA8C,EAChB,EAAE;IAChC,MAAM,cAAc,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;IACrE,6BAA6B,CAAC,cAAc,CAAC,CAAC;IAC9C,MAAM,cAAc,GAAG,cAAc,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAEtD,OAAO,8BAA8B,CAAC,cAAc,CAAC,CAAC;AACxD,CAAC,CAAC;AARW,QAAA,uBAAuB,2BAQlC;AAEF,MAAM,0BAA0B,GAAwC;IACtE,mBAAmB;IACnB,oBAAoB;IACpB,YAAY;IACZ,WAAW;CACZ,CAAC;AAEF,SAAS,+BAA+B,CACtC,OAAsB;IAEtB,MAAM,OAAO,GAAG,OAAO;SACpB,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAE,0BAAuC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;SACtE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAE1B,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;QACtB,MAAM,IAAI,KAAK,CAAC,mCAAmC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;KACtF;AACH,CAAC;AAED,MAAM,oBAAoB,GAAG,CAAI,EAC/B,iBAAiB,EACjB,kBAAkB,EACoC,EAAoC,EAAE;IAC5F,IAAI,iBAAiB,KAAK,SAAS,IAAI,kBAAkB,KAAK,SAAS,EAAE;QACvE,MAAM,IAAI,KAAK,CACb,sEAAsE;YACpE,mCAAmC,CACtC,CAAC;KACH;IAED,IAAI,iBAAiB,KAAK,SAAS,EAAE;QACnC,OAAO,EAAE,iBAAiB,EAAE,CAAC;KAC9B;IAED,IAAI,kBAAkB,KAAK,SAAS,EAAE;QACpC,OAAO,EAAE,kBAAkB,EAAE,CAAC;KAC/B;AACH,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAI,EACzB,UAAU,EACV,SAAS,EAC6C,EAA8B,EAAE;IACtF,IAAI,UAAU,KAAK,SAAS,IAAI,SAAS,KAAK,SAAS,EAAE;QACvD,MAAM,IAAI,KAAK,CACb,uFAAuF,CACxF,CAAC;KACH;IAED,IAAI,UAAU,KAAK,SAAS,EAAE;QAC5B,OAAO,EAAE,UAAU,EAAE,CAAC;KACvB;IAED,IAAI,SAAS,KAAK,SAAS,EAAE;QAC3B,OAAO,EAAE,SAAS,EAAE,CAAC;KACtB;AACH,CAAC,CAAC;AAEF,MAAM,gCAAgC,GAAG,CACvC,OAAiD,EACvB,EAAE;IAC5B,MAAM,MAAM,GAAG,MAAM,CAAC,WAAW,CAAC,OAAO,CAExC,CAAC;IAEF,MAAM,gBAAgB,GAAG,oBAAoB,CAAC,MAAM,CAAC,CAAC;IACtD,MAAM,UAAU,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;IAE1C,IAAI,gBAAgB,KAAK,SAAS,IAAI,UAAU,KAAK,SAAS,EAAE;QAC9D,OAAO,EAAE,GAAG,gBAAgB,EAAE,GAAG,UAAU,EAAE,CAAC;KAC/C;IAED,IAAI,gBAAgB,KAAK,SAAS,EAAE;QAClC,OAAO,gBAAgB,CAAC;KACzB;IAED,IAAI,UAAU,KAAK,SAAS,EAAE;QAC5B,OAAO,UAAU,CAAC;KACnB;IAED,MAAM,IAAI,KAAK,CAAC,qEAAqE,CAAC,CAAC;AACzF,CAAC,CAAC;AAEF,gBAAgB;AACT,MAAM,yBAAyB,GAAG,CACvC,MAA8C,EACd,EAAE;IAClC,MAAM,cAAc,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;IACrE,+BAA+B,CAAC,cAAc,CAAC,CAAC;IAChD,MAAM,cAAc,GAAG,cAAc,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAEtE,OAAO,gCAAgC,CAAC,cAAc,CAAC,CAAC;AAC1D,CAAC,CAAC;AARW,QAAA,yBAAyB,6BAQpC;AAEF,MAAM,QAAQ,GAAG,CAAC,aAAyB,EAAE,YAAqB,EAAE,EAAE,CACpE,YAAY,CAAC,GAAG,CAAC,iBAAO,CAAC,GAAG,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC;AAEnD,MAAM,UAAU,GAAG,CAAC,aAAyB,EAAE,YAAqB,EAAE,EAAE,CACtE,YAAY,CAAC,QAAQ,CAAC,iBAAO,CAAC,GAAG,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC;AAExD,MAAM,kCAAkC,GAAG,iBAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAE7D;;;;GAIG;AACH,MAAa,KAAK;IAOhB,gBAAgB;IAChB,YAAY,UAAU,GAAG,iBAAO,CAAC,IAAI,EAAE,IAAI,GAAG,iBAAO,CAAC,IAAI;QACxD,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;IACpD,CAAC;IAED;;;;;OAKG;IACH,IAAI,OAAO;QACT,IAAI,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,oCAAwB,CAAC,EAAE;YAC1C,MAAM,IAAI,KAAK,CAAC,0CAA0C,oCAAwB,EAAE,CAAC,CAAC;SACvF;QAED,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,oCAAwB,CAAC,CAAC;IACjD,CAAC;IAED,gBAAgB;IAChB,IAAI,uBAAuB;QACzB,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,kCAAkC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IAC/E,CAAC;IAED,sEAAsE;IACtE,eAAe,CAAC,KAAiB;QAC/B,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;OAMG;IACH,6BAA6B,CAAC,KAAiB;QAC7C,OAAO,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,oCAAwB,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,8BAA8B,CAAC,KAAiB;QAC9C,OAAO,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,qCAAyB,CAAC,CAAC;IACnE,CAAC;IAED,0FAA0F;IAC1F,wBAAwB,CAAC,KAAiB;QACxC,OAAO,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,qCAAyB,CAAC,CAAC;IACpE,CAAC;IAED,gBAAgB;IAChB,QAAQ;QACN,OAAO,iBAAiB,IAAI,CAAC,UAAU,WAAW,IAAI,CAAC,IAAI,IAAI,CAAC;IAClE,CAAC;IAED,MAAM,CAAC,IAAW;QAChB,OAAO,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACxE,CAAC;IAED,GAAG,CAAC,IAAW;QACb,OAAO,IAAI,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACnF,CAAC;IAED,aAAa,CAAC,UAAsB;QAClC,OAAO,IAAI,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IAC/D,CAAC;IAED,OAAO,CAAC,IAAgB;QACtB,OAAO,IAAI,KAAK,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;IACzD,CAAC;IAED,QAAQ,CAAC,IAAW;QAClB,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;QAElC,OAAO,IAAI,KAAK,CACd,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,iBAAO,CAAC,IAAI,EAC/E,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,iBAAO,CAAC,IAAI,CACxD,CAAC;IACJ,CAAC;IAED,kBAAkB,CAAC,UAAsB;QACvC,OAAO,IAAI,KAAK,CACd,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,iBAAO,CAAC,IAAI,EAC/E,IAAI,CAAC,IAAI,CACV,CAAC;IACJ,CAAC;IAED,YAAY,CAAC,IAAgB;QAC3B,OAAO,IAAI,KAAK,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,iBAAO,CAAC,IAAI,CAAC,CAAC;IAC7F,CAAC;IAED,QAAQ,CAAC,UAAsB;QAC7B,OAAO,IAAI,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC;IAC/E,CAAC;IAED,aAAa,CAAC,UAAsB;QAClC,OAAO,IAAI,KAAK,CAAC,iBAAO,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IACxD,CAAC;IAED,OAAO,CAAC,IAAgB;QACtB,OAAO,IAAI,KAAK,CAAC,IAAI,CAAC,UAAU,EAAE,iBAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACxD,CAAC;IAEO,WAAW,CAAC,EAAE,IAAI,EAAS,EAAE,aAAyB;QAC5D,OAAO,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC;YACvB,CAAC,CAAC,EAAE,UAAU,EAAE,UAAU,CAAC,aAAa,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE;YAChE,CAAC,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;IACzC,CAAC;IAEO,iBAAiB,CAAC,EAAE,UAAU,EAAS;QAC7C,OAAO,UAAU,CAAC,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC;YACnC,CAAC,CAAC,EAAE,iBAAiB,EAAE,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE;YACxD,CAAC,CAAC,EAAE,kBAAkB,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;IAC9D,CAAC;IAED;;;;;;;;OAQG;IACH,WAAW,CACT,IAAW,EACX,gBAA4B,kCAAsB;;QAElD,IAAI,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;YAClE,OAAO,SAAS,CAAC;SAClB;QAED,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,IAAI,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,oCAAwB,CAAC,EAAE;gBAC1C,OAAO,oBAAoB,CAAC,IAAI,EAAE,2BAA2B,CAAC,CAAC;aAChE;YAED,OAAO,aAAa,CAAC;gBACnB,iBAAiB,EAAE,IAAI,CAAC,UAAU;gBAClC,UAAU,EAAE,UAAU,CAAC,aAAa,EAAE,IAAI,CAAC,OAAO,CAAC;aACpD,CAAC,CAAC;SACJ;QAED,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,OAAO,YAAY,CACjB,IAAI,CAAC,OAAO,CAAC,OAAO;gBAClB,CAAC,CAAC,EAAE,kBAAkB,EAAE,IAAI,CAAC,UAAU,EAAE,SAAS,EAAE,IAAI,CAAC,OAAO,EAAE;gBAClE,CAAC,CAAC,EAAE,kBAAkB,EAAE,IAAI,CAAC,UAAU,EAAE,CAC5C,CAAC;SACH;QAED,OAAO,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC;YACxC,CAAC,CAAC,eAAe,CAAU,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,aAAa,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,MAAM,CAAC;YAC3F,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC;gBACzB,CAAC,CAAC,eAAe,CAAU,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI,YAAY,CAAC;gBAC9F,CAAC,CAAC,eAAe,CACb;oBACE,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,aAAa,CAAC;oBACxC,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC;iBAChC,QACD,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,MAAM,CAAC,mCAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI,YAAY,CAAC,CACrE,CAAC;IACR,CAAC;IAED;;;;;OAKG;IACH,KAAK,CACH,MAAwC,EACxC,gBAA4B,kCAAsB;QAElD,IAAI,CAAC,MAAM,EAAE;YACX,OAAO,IAAI,CAAC;SACb;QAED,QAAQ,MAAM,CAAC,IAAI,EAAE;YACnB,KAAK,iBAAiB;gBACpB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;oBACjB,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;iBACrD;gBAED,OAAO,MAAM,CAAC,YAAY,CAAC;YAE7B,KAAK,UAAU,CAAC,CAAC;gBACf,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;oBACjB,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;iBACrD;gBAED,MAAM,EAAE,iBAAiB,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC;gBAExD,OAAO,IAAI,KAAK,CACd,iBAAiB,EACjB,oCAAwB,CAAC,GAAG,CAAC,QAAQ,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC,CAClE,CAAC;aACH;YAED,KAAK,SAAS;gBACZ,IAAI,IAAI,CAAC,OAAO,EAAE;oBAChB,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;iBAC5C;gBAED,OAAO,mBAAW,CAAC;YAErB,KAAK,YAAY,CAAC,CAAC;gBACjB,MAAM,EACJ,SAAS,EACT,MAAM,EAAE,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,UAAU,EAAE,SAAS,EAAE,EACzE,GAAG,MAAM,CAAC;gBAEX,MAAM,kBAAkB,GAAG,kBAAkB,aAAlB,kBAAkB,cAAlB,kBAAkB,GAAI,iBAAO,CAAC,IAAI,CAAC;gBAC9D,MAAM,kBAAkB,GAAG,iBAAiB,aAAjB,iBAAiB,cAAjB,iBAAiB,GAAI,iBAAO,CAAC,IAAI,CAAC;gBAC7D,MAAM,YAAY,GAAG,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,iBAAO,CAAC,IAAI,CAAC;gBAC/C,MAAM,YAAY,GAAG,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,iBAAO,CAAC,IAAI,CAAC;gBAErF,OAAO,SAAS,KAAK,YAAY;oBAC/B,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,iBAAO,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,YAAY,CAAC,YAAY,CAAC;oBACnF,CAAC,CAAC,SAAS,KAAK,MAAM;wBACtB,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,iBAAO,CAAC,IAAI,CAAC;6BACvB,aAAa,CAAC,kBAAkB,CAAC;6BACjC,kBAAkB,CAAC,kBAAkB,CAAC;wBAC3C,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,kBAAkB,EAAE,YAAY,CAAC,CAAC,CAAC,QAAQ,CAC5D,IAAI,KAAK,CAAC,kBAAkB,EAAE,YAAY,CAAC,CAC5C,CAAC;aACP;SACF;IACH,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,MAAM,CAAC,MAAuC,EAAE,aAA0B;QAC/E,OAAO,mBAAW,CAAC,KAAK,CAAC,aAAa,CAAC,+BAAuB,CAAC,MAAM,CAAC,CAAC,EAAE,aAAa,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAW,EAAE,aAA0B;QACrD,MAAM,MAAM,GAAG,mBAAW,CAAC,WAAW,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;QAC5D,gBAAM,CAAC,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,IAAI,MAAK,UAAU,CAAC,CAAC;QACpC,OAAO,MAAM,CAAC,MAAM,CAAC;IACvB,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,MAAyC,EAAE,aAA0B;QAC1E,OAAO,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,iCAAyB,CAAC,MAAM,CAAC,CAAC,EAAE,aAAa,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CAAC,IAAW,EAAE,aAA0B;QAC9C,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;QACrD,gBAAM,CAAC,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,IAAI,MAAK,YAAY,CAAC,CAAC;QACtC,OAAO,MAAM,CAAC,MAAM,CAAC;IACvB,CAAC;CACF;AAhTD,sBAgTC;AAED,gBAAgB;AACH,QAAA,WAAW,GAAG,IAAI,KAAK,EAAE,CAAC;AAcvC;;;;;;;;;;;;GAYG;AACH,MAAa,SAAU,SAAQ,KAAK;IAOlC,gBAAgB;IAChB,YAAY,YAAoB,EAAE,MAAuB,EAAE,UAAoB,EAAE,IAAc;QAC7F,KAAK,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;QAExB,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,MAAM,CAAC,IAAe;QACpB,OAAO,CACL,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,YAAY,KAAK,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM,CAC7F,CAAC;IACJ,CAAC;IAED,gBAAgB;IAChB,QAAQ;QACN,OAAO,CACL,oBAAoB,IAAI,CAAC,YAAY,GAAG;YACxC,iBAAiB,IAAI,CAAC,UAAU,EAAE;YAClC,WAAW,IAAI,CAAC,IAAI,EAAE;YACtB,cAAc,IAAI,CAAC,MAAM,KAAK,CAC/B,CAAC;IACJ,CAAC;CACF;AA9BD,8BA8BC;AAED;;;;;;;;;GASG;AACH,MAAa,8BAA+B,SAAQ,SAAS;IAI3D,gBAAgB;IAChB,YACE,YAAoB,EACpB,MAAuB,EACvB,UAAoB,EACpB,IAAc,EACd,KAAK,GAAG,iBAAO,CAAC,IAAI,EACpB,4BAA4B,GAAG,mBAAW;QAE1C,KAAK,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;QAE9C,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,4BAA4B,GAAG,4BAA4B,CAAC;IACnE,CAAC;IAED,mBAAmB,CAAC,kBAAyB;QAC3C,MAAM,mBAAmB,GAAG,IAAI,CAAC,GAAG,CAClC,kBAAkB,CAAC,QAAQ,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CACpF,CAAC;QAEF,OAAO,IAAI,SAAS,CAClB,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,MAAM,EACX,mBAAmB,CAAC,UAAU,EAC9B,mBAAmB,CAAC,IAAI,CACzB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,IAAoC;QACzC,OAAO,CACL,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC;YAClB,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC;YACzB,IAAI,CAAC,4BAA4B,CAAC,MAAM,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAC5E,CAAC;IACJ,CAAC;CACF;AAvCD,wEAuCC"}

package/dist/src/ZEROStake.d.ts

@@ -0,0 +1,52 @@
+import { Decimal, Decimalish } from "./Decimal";
+/**
+ * Represents the change between two states of an ZERO Stake.
+ *
+ * @public
+ */
+export declare type ZEROStakeChange<T> = {
+    stakeZERO: T;
+    unstakeZERO?: undefined;
+} | {
+    stakeZERO?: undefined;
+    unstakeZERO: T;
+    unstakeAllZERO: boolean;
+};
+/**
+ * Represents a user's ZERO stake and accrued gains.
+ *
+ * @remarks
+ * Returned by the {@link ReadableLiquity.getZEROStake | getZEROStake()} function.
+
+ * @public
+ */
+export declare class ZEROStake {
+    /** The amount of ZERO that's staked. */
+    readonly stakedZERO: Decimal;
+    /** Collateral gain available to withdraw. */
+    readonly collateralGain: Decimal;
+    /** ZUSD gain available to withdraw. */
+    readonly zusdGain: Decimal;
+    /** @internal */
+    constructor(stakedZERO?: Decimal, collateralGain?: Decimal, zusdGain?: Decimal);
+    get isEmpty(): boolean;
+    /** @internal */
+    toString(): string;
+    /**
+     * Compare to another instance of `ZEROStake`.
+     */
+    equals(that: ZEROStake): boolean;
+    /**
+     * Calculate the difference between this `ZEROStake` and `thatStakedZERO`.
+     *
+     * @returns An object representing the change, or `undefined` if the staked amounts are equal.
+     */
+    whatChanged(thatStakedZERO: Decimalish): ZEROStakeChange<Decimal> | undefined;
+    /**
+     * Apply a {@link ZEROStakeChange} to this `ZEROStake`.
+     *
+     * @returns The new staked ZERO amount.
+     */
+    apply(change: ZEROStakeChange<Decimalish> | undefined): Decimal;
+}
+//# sourceMappingURL=ZEROStake.d.ts.map

package/dist/src/ZEROStake.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ZEROStake.d.ts","sourceRoot":"","sources":["../../src/ZEROStake.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAEhD;;;;GAIG;AACH,oBAAY,eAAe,CAAC,CAAC,IACzB;IAAE,SAAS,EAAE,CAAC,CAAC;IAAC,WAAW,CAAC,EAAE,SAAS,CAAA;CAAE,GACzC;IAAE,SAAS,CAAC,EAAE,SAAS,CAAC;IAAC,WAAW,EAAE,CAAC,CAAC;IAAC,cAAc,EAAE,OAAO,CAAA;CAAE,CAAC;AAEvE;;;;;;;GAOG;AACH,qBAAa,SAAS;IACpB,wCAAwC;IACxC,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAE7B,6CAA6C;IAC7C,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC;IAEjC,uCAAuC;IACvC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAE3B,gBAAgB;gBACJ,UAAU,UAAe,EAAE,cAAc,UAAe,EAAE,QAAQ,UAAe;IAM7F,IAAI,OAAO,IAAI,OAAO,CAErB;IAED,gBAAgB;IAChB,QAAQ,IAAI,MAAM;IAQlB;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO;IAQhC;;;;OAIG;IACH,WAAW,CAAC,cAAc,EAAE,UAAU,GAAG,eAAe,CAAC,OAAO,CAAC,GAAG,SAAS;IAe7E;;;;OAIG;IACH,KAAK,CAAC,MAAM,EAAE,eAAe,CAAC,UAAU,CAAC,GAAG,SAAS,GAAG,OAAO;CAahE"}

package/dist/src/ZEROStake.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ZEROStake = void 0;
+const Decimal_1 = require("./Decimal");
+/**
+ * Represents a user's ZERO stake and accrued gains.
+ *
+ * @remarks
+ * Returned by the {@link ReadableLiquity.getZEROStake | getZEROStake()} function.
+
+ * @public
+ */
+class ZEROStake {
+    /** @internal */
+    constructor(stakedZERO = Decimal_1.Decimal.ZERO, collateralGain = Decimal_1.Decimal.ZERO, zusdGain = Decimal_1.Decimal.ZERO) {
+        this.stakedZERO = stakedZERO;
+        this.collateralGain = collateralGain;
+        this.zusdGain = zusdGain;
+    }
+    get isEmpty() {
+        return this.stakedZERO.isZero && this.collateralGain.isZero && this.zusdGain.isZero;
+    }
+    /** @internal */
+    toString() {
+        return (`{ stakedZERO: ${this.stakedZERO}` +
+            `, collateralGain: ${this.collateralGain}` +
+            `, zusdGain: ${this.zusdGain} }`);
+    }
+    /**
+     * Compare to another instance of `ZEROStake`.
+     */
+    equals(that) {
+        return (this.stakedZERO.eq(that.stakedZERO) &&
+            this.collateralGain.eq(that.collateralGain) &&
+            this.zusdGain.eq(that.zusdGain));
+    }
+    /**
+     * Calculate the difference between this `ZEROStake` and `thatStakedZERO`.
+     *
+     * @returns An object representing the change, or `undefined` if the staked amounts are equal.
+     */
+    whatChanged(thatStakedZERO) {
+        thatStakedZERO = Decimal_1.Decimal.from(thatStakedZERO);
+        if (thatStakedZERO.lt(this.stakedZERO)) {
+            return {
+                unstakeZERO: this.stakedZERO.sub(thatStakedZERO),
+                unstakeAllZERO: thatStakedZERO.isZero
+            };
+        }
+        if (thatStakedZERO.gt(this.stakedZERO)) {
+            return { stakeZERO: thatStakedZERO.sub(this.stakedZERO) };
+        }
+    }
+    /**
+     * Apply a {@link ZEROStakeChange} to this `ZEROStake`.
+     *
+     * @returns The new staked ZERO amount.
+     */
+    apply(change) {
+        if (!change) {
+            return this.stakedZERO;
+        }
+        if (change.unstakeZERO !== undefined) {
+            return change.unstakeAllZERO || this.stakedZERO.lte(change.unstakeZERO)
+                ? Decimal_1.Decimal.ZERO
+                : this.stakedZERO.sub(change.unstakeZERO);
+        }
+        else {
+            return this.stakedZERO.add(change.stakeZERO);
+        }
+    }
+}
+exports.ZEROStake = ZEROStake;
+//# sourceMappingURL=ZEROStake.js.map

package/dist/src/ZEROStake.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ZEROStake.js","sourceRoot":"","sources":["../../src/ZEROStake.ts"],"names":[],"mappings":";;;AAAA,uCAAgD;AAWhD;;;;;;;GAOG;AACH,MAAa,SAAS;IAUpB,gBAAgB;IAChB,YAAY,UAAU,GAAG,iBAAO,CAAC,IAAI,EAAE,cAAc,GAAG,iBAAO,CAAC,IAAI,EAAE,QAAQ,GAAG,iBAAO,CAAC,IAAI;QAC3F,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;IACtF,CAAC;IAED,gBAAgB;IAChB,QAAQ;QACN,OAAO,CACL,iBAAiB,IAAI,CAAC,UAAU,EAAE;YAClC,qBAAqB,IAAI,CAAC,cAAc,EAAE;YAC1C,eAAe,IAAI,CAAC,QAAQ,IAAI,CACjC,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,IAAe;QACpB,OAAO,CACL,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC;YACnC,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC;YAC3C,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAChC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,WAAW,CAAC,cAA0B;QACpC,cAAc,GAAG,iBAAO,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAE9C,IAAI,cAAc,CAAC,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE;YACtC,OAAO;gBACL,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,cAAc,CAAC;gBAChD,cAAc,EAAE,cAAc,CAAC,MAAM;aACtC,CAAC;SACH;QAED,IAAI,cAAc,CAAC,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE;YACtC,OAAO,EAAE,SAAS,EAAE,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;SAC3D;IACH,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAA+C;QACnD,IAAI,CAAC,MAAM,EAAE;YACX,OAAO,IAAI,CAAC,UAAU,CAAC;SACxB;QAED,IAAI,MAAM,CAAC,WAAW,KAAK,SAAS,EAAE;YACpC,OAAO,MAAM,CAAC,cAAc,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC;gBACrE,CAAC,CAAC,iBAAO,CAAC,IAAI;gBACd,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;SAC7C;aAAM;YACL,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;SAC9C;IACH,CAAC;CACF;AA/ED,8BA+EC"}

package/dist/src/_CachedReadableLiquity.d.ts

@@ -0,0 +1,55 @@
+import { Decimal } from "./Decimal";
+import { Fees } from "./Fees";
+import { ZEROStake } from "./ZEROStake";
+import { StabilityDeposit } from "./StabilityDeposit";
+import { Trove, TroveWithPendingRedistribution, UserTrove } from "./Trove";
+import { FrontendStatus, ReadableLiquity, TroveListingParams } from "./ReadableLiquity";
+/** @internal */
+export declare type _ReadableLiquityWithExtraParamsBase<T extends unknown[]> = {
+    [P in keyof ReadableLiquity]: ReadableLiquity[P] extends (...params: infer A) => infer R ? (...params: [...originalParams: A, ...extraParams: T]) => R : never;
+};
+/** @internal */
+export declare type _LiquityReadCacheBase<T extends unknown[]> = {
+    [P in keyof ReadableLiquity]: ReadableLiquity[P] extends (...args: infer A) => Promise<infer R> ? (...params: [...originalParams: A, ...extraParams: T]) => R | undefined : never;
+};
+/** @internal */
+export interface _ReadableLiquityWithExtraParams<T extends unknown[]> extends _ReadableLiquityWithExtraParamsBase<T> {
+    getTroves(params: TroveListingParams & {
+        beforeRedistribution: true;
+    }, ...extraParams: T): Promise<TroveWithPendingRedistribution[]>;
+    getTroves(params: TroveListingParams, ...extraParams: T): Promise<UserTrove[]>;
+}
+/** @internal */
+export interface _LiquityReadCache<T extends unknown[]> extends _LiquityReadCacheBase<T> {
+    getTroves(params: TroveListingParams & {
+        beforeRedistribution: true;
+    }, ...extraParams: T): TroveWithPendingRedistribution[] | undefined;
+    getTroves(params: TroveListingParams, ...extraParams: T): UserTrove[] | undefined;
+}
+/** @internal */
+export declare class _CachedReadableLiquity<T extends unknown[]> implements _ReadableLiquityWithExtraParams<T> {
+    private _readable;
+    private _cache;
+    constructor(readable: _ReadableLiquityWithExtraParams<T>, cache: _LiquityReadCache<T>);
+    getTotalRedistributed(...extraParams: T): Promise<Trove>;
+    getTroveBeforeRedistribution(address?: string, ...extraParams: T): Promise<TroveWithPendingRedistribution>;
+    getTrove(address?: string, ...extraParams: T): Promise<UserTrove>;
+    getNumberOfTroves(...extraParams: T): Promise<number>;
+    getPrice(...extraParams: T): Promise<Decimal>;
+    getTotal(...extraParams: T): Promise<Trove>;
+    getStabilityDeposit(address?: string, ...extraParams: T): Promise<StabilityDeposit>;
+    getRemainingStabilityPoolZEROReward(...extraParams: T): Promise<Decimal>;
+    getZUSDInStabilityPool(...extraParams: T): Promise<Decimal>;
+    getZUSDBalance(address?: string, ...extraParams: T): Promise<Decimal>;
+    getZEROBalance(address?: string, ...extraParams: T): Promise<Decimal>;
+    getCollateralSurplusBalance(address?: string, ...extraParams: T): Promise<Decimal>;
+    getTroves(params: TroveListingParams & {
+        beforeRedistribution: true;
+    }, ...extraParams: T): Promise<TroveWithPendingRedistribution[]>;
+    getTroves(params: TroveListingParams, ...extraParams: T): Promise<UserTrove[]>;
+    getFees(...extraParams: T): Promise<Fees>;
+    getZEROStake(address?: string, ...extraParams: T): Promise<ZEROStake>;
+    getTotalStakedZERO(...extraParams: T): Promise<Decimal>;
+    getFrontendStatus(address?: string, ...extraParams: T): Promise<FrontendStatus>;
+}
+//# sourceMappingURL=_CachedReadableLiquity.d.ts.map

package/dist/src/_CachedReadableLiquity.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_CachedReadableLiquity.d.ts","sourceRoot":"","sources":["../../src/_CachedReadableLiquity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,KAAK,EAAE,8BAA8B,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAC3E,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAExF,gBAAgB;AAChB,oBAAY,mCAAmC,CAAC,CAAC,SAAS,OAAO,EAAE,IAAI;KACpE,CAAC,IAAI,MAAM,eAAe,GAAG,eAAe,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,MAAM,EAAE,MAAM,CAAC,KAAK,MAAM,CAAC,GACpF,CAAC,GAAG,MAAM,EAAE,CAAC,GAAG,cAAc,EAAE,CAAC,EAAE,GAAG,WAAW,EAAE,CAAC,CAAC,KAAK,CAAC,GAC3D,KAAK;CACV,CAAC;AAEF,gBAAgB;AAChB,oBAAY,qBAAqB,CAAC,CAAC,SAAS,OAAO,EAAE,IAAI;KACtD,CAAC,IAAI,MAAM,eAAe,GAAG,eAAe,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC,GAC3F,CAAC,GAAG,MAAM,EAAE,CAAC,GAAG,cAAc,EAAE,CAAC,EAAE,GAAG,WAAW,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,SAAS,GACvE,KAAK;CACV,CAAC;AAIF,gBAAgB;AAChB,MAAM,WAAW,+BAA+B,CAAC,CAAC,SAAS,OAAO,EAAE,CAClE,SAAQ,mCAAmC,CAAC,CAAC,CAAC;IAC9C,SAAS,CACP,MAAM,EAAE,kBAAkB,GAAG;QAAE,oBAAoB,EAAE,IAAI,CAAA;KAAE,EAC3D,GAAG,WAAW,EAAE,CAAC,GAChB,OAAO,CAAC,8BAA8B,EAAE,CAAC,CAAC;IAE7C,SAAS,CAAC,MAAM,EAAE,kBAAkB,EAAE,GAAG,WAAW,EAAE,CAAC,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;CAChF;AAED,gBAAgB;AAChB,MAAM,WAAW,iBAAiB,CAAC,CAAC,SAAS,OAAO,EAAE,CAAE,SAAQ,qBAAqB,CAAC,CAAC,CAAC;IACtF,SAAS,CACP,MAAM,EAAE,kBAAkB,GAAG;QAAE,oBAAoB,EAAE,IAAI,CAAA;KAAE,EAC3D,GAAG,WAAW,EAAE,CAAC,GAChB,8BAA8B,EAAE,GAAG,SAAS,CAAC;IAEhD,SAAS,CAAC,MAAM,EAAE,kBAAkB,EAAE,GAAG,WAAW,EAAE,CAAC,GAAG,SAAS,EAAE,GAAG,SAAS,CAAC;CACnF;AAED,gBAAgB;AAChB,qBAAa,sBAAsB,CAAC,CAAC,SAAS,OAAO,EAAE,CACrD,YAAW,+BAA+B,CAAC,CAAC,CAAC;IAC7C,OAAO,CAAC,SAAS,CAAqC;IACtD,OAAO,CAAC,MAAM,CAAuB;gBAEzB,QAAQ,EAAE,+BAA+B,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,iBAAiB,CAAC,CAAC,CAAC;IAK/E,qBAAqB,CAAC,GAAG,WAAW,EAAE,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC;IAOxD,4BAA4B,CAChC,OAAO,CAAC,EAAE,MAAM,EAChB,GAAG,WAAW,EAAE,CAAC,GAChB,OAAO,CAAC,8BAA8B,CAAC;IAOpC,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,WAAW,EAAE,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC;IASjE,iBAAiB,CAAC,GAAG,WAAW,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAOrD,QAAQ,CAAC,GAAG,WAAW,EAAE,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAI7C,QAAQ,CAAC,GAAG,WAAW,EAAE,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC;IAI3C,mBAAmB,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,WAAW,EAAE,CAAC,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAOnF,mCAAmC,CAAC,GAAG,WAAW,EAAE,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAOxE,sBAAsB,CAAC,GAAG,WAAW,EAAE,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAO3D,cAAc,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,WAAW,EAAE,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAOrE,cAAc,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,WAAW,EAAE,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAOrE,2BAA2B,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,WAAW,EAAE,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAOxF,SAAS,CACP,MAAM,EAAE,kBAAkB,GAAG;QAAE,oBAAoB,EAAE,IAAI,CAAA;KAAE,EAC3D,GAAG,WAAW,EAAE,CAAC,GAChB,OAAO,CAAC,8BAA8B,EAAE,CAAC;IAE5C,SAAS,CAAC,MAAM,EAAE,kBAAkB,EAAE,GAAG,WAAW,EAAE,CAAC,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAkBxE,OAAO,CAAC,GAAG,WAAW,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAIzC,YAAY,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,WAAW,EAAE,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC;IAOrE,kBAAkB,CAAC,GAAG,WAAW,EAAE,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAOvD,iBAAiB,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,WAAW,EAAE,CAAC,GAAG,OAAO,CAAC,cAAc,CAAC;CAMtF"}