@sovryn-zero/lib-base 0.1.0

package/dist/src/PopulatableLiquity.d.ts

@@ -0,0 +1,125 @@
+import { Decimal, Decimalish } from "./Decimal";
+import { TroveAdjustmentParams, TroveCreationParams } from "./Trove";
+import { LiquityReceipt, SendableLiquity, SentLiquityTransaction } from "./SendableLiquity";
+import { CollateralGainTransferDetails, LiquidationDetails, RedemptionDetails, StabilityDepositChangeDetails, StabilityPoolGainsWithdrawalDetails, TroveAdjustmentDetails, TroveClosureDetails, TroveCreationDetails } from "./TransactableLiquity";
+/**
+ * A transaction that has been prepared for sending.
+ *
+ * @remarks
+ * Implemented by {@link @sovryn-zero/lib-ethers#PopulatedEthersLiquityTransaction}.
+ *
+ * @public
+ */
+export interface PopulatedLiquityTransaction<P = unknown, T extends SentLiquityTransaction = SentLiquityTransaction> {
+    /** Implementation-specific populated transaction object. */
+    readonly rawPopulatedTransaction: P;
+    /**
+     * Send the transaction.
+     *
+     * @returns An object that implements {@link @sovryn-zero/lib-base#SentLiquityTransaction}.
+     */
+    send(): Promise<T>;
+}
+/**
+ * A redemption transaction that has been prepared for sending.
+ *
+ * @remarks
+ * The Zero protocol fulfills redemptions by repaying the debt of Troves in ascending order of
+ * their collateralization ratio, and taking a portion of their collateral in exchange. Due to the
+ * {@link @sovryn-zero/lib-base#ZUSD_MINIMUM_DEBT | minimum debt} requirement that Troves must fulfill,
+ * some ZUSD amounts are not possible to redeem exactly.
+ *
+ * When {@link @sovryn-zero/lib-base#PopulatableLiquity.redeemZUSD | redeemZUSD()} is called with an
+ * amount that can't be fully redeemed, the amount will be truncated (see the `redeemableZUSDAmount`
+ * property). When this happens, the redeemer can either redeem the truncated amount by sending the
+ * transaction unchanged, or prepare a new transaction by
+ * {@link @sovryn-zero/lib-base#PopulatedRedemption.increaseAmountByMinimumNetDebt | increasing the amount}
+ * to the next lowest possible value, which is the sum of the truncated amount and
+ * {@link @sovryn-zero/lib-base#ZUSD_MINIMUM_NET_DEBT}.
+ *
+ * @public
+ */
+export interface PopulatedRedemption<P = unknown, S = unknown, R = unknown> extends PopulatedLiquityTransaction<P, SentLiquityTransaction<S, LiquityReceipt<R, RedemptionDetails>>> {
+    /** Amount of ZUSD the redeemer is trying to redeem. */
+    readonly attemptedZUSDAmount: Decimal;
+    /** Maximum amount of ZUSD that is currently redeemable from `attemptedZUSDAmount`. */
+    readonly redeemableZUSDAmount: Decimal;
+    /** Whether `redeemableZUSDAmount` is less than `attemptedZUSDAmount`. */
+    readonly isTruncated: boolean;
+    /**
+     * Prepare a new transaction by increasing the attempted amount to the next lowest redeemable
+     * value.
+     *
+     * @param maxRedemptionRate - Maximum acceptable
+     *                            {@link @sovryn-zero/lib-base#Fees.redemptionRate | redemption rate} to
+     *                            use in the new transaction.
+     *
+     * @remarks
+     * If `maxRedemptionRate` is omitted, the original transaction's `maxRedemptionRate` is reused
+     * unless that was also omitted, in which case the current redemption rate (based on the increased
+     * amount) plus 0.1% is used as maximum acceptable rate.
+     */
+    increaseAmountByMinimumNetDebt(maxRedemptionRate?: Decimalish): Promise<PopulatedRedemption<P, S, R>>;
+}
+/** @internal */
+export declare type _PopulatableFrom<T, P> = {
+    [M in keyof T]: T[M] extends (...args: infer A) => Promise<infer U> ? U extends SentLiquityTransaction ? (...args: A) => Promise<PopulatedLiquityTransaction<P, U>> : never : never;
+};
+/**
+ * Prepare Zero transactions for sending.
+ *
+ * @remarks
+ * The functions return an object implementing {@link PopulatedLiquityTransaction}, which can be
+ * used to send the transaction and get a {@link SentLiquityTransaction}.
+ *
+ * Implemented by {@link @sovryn-zero/lib-ethers#PopulatableEthersLiquity}.
+ *
+ * @public
+ */
+export interface PopulatableLiquity<R = unknown, S = unknown, P = unknown> extends _PopulatableFrom<SendableLiquity<R, S>, P> {
+    /** {@inheritDoc TransactableLiquity.openTrove} */
+    openTrove(params: TroveCreationParams<Decimalish>, maxBorrowingRate?: Decimalish): Promise<PopulatedLiquityTransaction<P, SentLiquityTransaction<S, LiquityReceipt<R, TroveCreationDetails>>>>;
+    /** {@inheritDoc TransactableLiquity.closeTrove} */
+    closeTrove(): Promise<PopulatedLiquityTransaction<P, SentLiquityTransaction<S, LiquityReceipt<R, TroveClosureDetails>>>>;
+    /** {@inheritDoc TransactableLiquity.adjustTrove} */
+    adjustTrove(params: TroveAdjustmentParams<Decimalish>, maxBorrowingRate?: Decimalish): Promise<PopulatedLiquityTransaction<P, SentLiquityTransaction<S, LiquityReceipt<R, TroveAdjustmentDetails>>>>;
+    /** {@inheritDoc TransactableLiquity.depositCollateral} */
+    depositCollateral(amount: Decimalish): Promise<PopulatedLiquityTransaction<P, SentLiquityTransaction<S, LiquityReceipt<R, TroveAdjustmentDetails>>>>;
+    /** {@inheritDoc TransactableLiquity.withdrawCollateral} */
+    withdrawCollateral(amount: Decimalish): Promise<PopulatedLiquityTransaction<P, SentLiquityTransaction<S, LiquityReceipt<R, TroveAdjustmentDetails>>>>;
+    /** {@inheritDoc TransactableLiquity.borrowZUSD} */
+    borrowZUSD(amount: Decimalish, maxBorrowingRate?: Decimalish): Promise<PopulatedLiquityTransaction<P, SentLiquityTransaction<S, LiquityReceipt<R, TroveAdjustmentDetails>>>>;
+    /** {@inheritDoc TransactableLiquity.repayZUSD} */
+    repayZUSD(amount: Decimalish): Promise<PopulatedLiquityTransaction<P, SentLiquityTransaction<S, LiquityReceipt<R, TroveAdjustmentDetails>>>>;
+    /** @internal */
+    setPrice(price: Decimalish): Promise<PopulatedLiquityTransaction<P, SentLiquityTransaction<S, LiquityReceipt<R, void>>>>;
+    /** {@inheritDoc TransactableLiquity.liquidate} */
+    liquidate(address: string | string[]): Promise<PopulatedLiquityTransaction<P, SentLiquityTransaction<S, LiquityReceipt<R, LiquidationDetails>>>>;
+    /** {@inheritDoc TransactableLiquity.liquidateUpTo} */
+    liquidateUpTo(maximumNumberOfTrovesToLiquidate: number): Promise<PopulatedLiquityTransaction<P, SentLiquityTransaction<S, LiquityReceipt<R, LiquidationDetails>>>>;
+    /** {@inheritDoc TransactableLiquity.depositZUSDInStabilityPool} */
+    depositZUSDInStabilityPool(amount: Decimalish, frontendTag?: string): Promise<PopulatedLiquityTransaction<P, SentLiquityTransaction<S, LiquityReceipt<R, StabilityDepositChangeDetails>>>>;
+    /** {@inheritDoc TransactableLiquity.withdrawZUSDFromStabilityPool} */
+    withdrawZUSDFromStabilityPool(amount: Decimalish): Promise<PopulatedLiquityTransaction<P, SentLiquityTransaction<S, LiquityReceipt<R, StabilityDepositChangeDetails>>>>;
+    /** {@inheritDoc TransactableLiquity.withdrawGainsFromStabilityPool} */
+    withdrawGainsFromStabilityPool(): Promise<PopulatedLiquityTransaction<P, SentLiquityTransaction<S, LiquityReceipt<R, StabilityPoolGainsWithdrawalDetails>>>>;
+    /** {@inheritDoc TransactableLiquity.transferCollateralGainToTrove} */
+    transferCollateralGainToTrove(): Promise<PopulatedLiquityTransaction<P, SentLiquityTransaction<S, LiquityReceipt<R, CollateralGainTransferDetails>>>>;
+    /** {@inheritDoc TransactableLiquity.sendZUSD} */
+    sendZUSD(toAddress: string, amount: Decimalish): Promise<PopulatedLiquityTransaction<P, SentLiquityTransaction<S, LiquityReceipt<R, void>>>>;
+    /** {@inheritDoc TransactableLiquity.sendZERO} */
+    sendZERO(toAddress: string, amount: Decimalish): Promise<PopulatedLiquityTransaction<P, SentLiquityTransaction<S, LiquityReceipt<R, void>>>>;
+    /** {@inheritDoc TransactableLiquity.redeemZUSD} */
+    redeemZUSD(amount: Decimalish, maxRedemptionRate?: Decimalish): Promise<PopulatedRedemption<P, S, R>>;
+    /** {@inheritDoc TransactableLiquity.claimCollateralSurplus} */
+    claimCollateralSurplus(): Promise<PopulatedLiquityTransaction<P, SentLiquityTransaction<S, LiquityReceipt<R, void>>>>;
+    /** {@inheritDoc TransactableLiquity.stakeZERO} */
+    stakeZERO(amount: Decimalish): Promise<PopulatedLiquityTransaction<P, SentLiquityTransaction<S, LiquityReceipt<R, void>>>>;
+    /** {@inheritDoc TransactableLiquity.unstakeZERO} */
+    unstakeZERO(amount: Decimalish): Promise<PopulatedLiquityTransaction<P, SentLiquityTransaction<S, LiquityReceipt<R, void>>>>;
+    /** {@inheritDoc TransactableLiquity.withdrawGainsFromStaking} */
+    withdrawGainsFromStaking(): Promise<PopulatedLiquityTransaction<P, SentLiquityTransaction<S, LiquityReceipt<R, void>>>>;
+    /** {@inheritDoc TransactableLiquity.registerFrontend} */
+    registerFrontend(kickbackRate: Decimalish): Promise<PopulatedLiquityTransaction<P, SentLiquityTransaction<S, LiquityReceipt<R, void>>>>;
+}
+//# sourceMappingURL=PopulatableLiquity.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PopulatableLiquity.d.ts","sourceRoot":"","sources":["../../src/PopulatableLiquity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAChD,OAAO,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AACrE,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAC;AAE5F,OAAO,EACL,6BAA6B,EAC7B,kBAAkB,EAClB,iBAAiB,EACjB,6BAA6B,EAC7B,mCAAmC,EACnC,sBAAsB,EACtB,mBAAmB,EACnB,oBAAoB,EACrB,MAAM,uBAAuB,CAAC;AAE/B;;;;;;;GAOG;AACH,MAAM,WAAW,2BAA2B,CAC1C,CAAC,GAAG,OAAO,EACX,CAAC,SAAS,sBAAsB,GAAG,sBAAsB;IAEzD,4DAA4D;IAC5D,QAAQ,CAAC,uBAAuB,EAAE,CAAC,CAAC;IAEpC;;;;OAIG;IACH,IAAI,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC;CACpB;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,mBAAmB,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,GAAG,OAAO,EAAE,CAAC,GAAG,OAAO,CACxE,SAAQ,2BAA2B,CACjC,CAAC,EACD,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,iBAAiB,CAAC,CAAC,CAChE;IACD,uDAAuD;IACvD,QAAQ,CAAC,mBAAmB,EAAE,OAAO,CAAC;IAEtC,sFAAsF;IACtF,QAAQ,CAAC,oBAAoB,EAAE,OAAO,CAAC;IAEvC,yEAAyE;IACzE,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;IAE9B;;;;;;;;;;;;OAYG;IACH,8BAA8B,CAC5B,iBAAiB,CAAC,EAAE,UAAU,GAC7B,OAAO,CAAC,mBAAmB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;CAC1C;AAED,gBAAgB;AAChB,oBAAY,gBAAgB,CAAC,CAAC,EAAE,CAAC,IAAI;KAClC,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC,GAC/D,CAAC,SAAS,sBAAsB,GAC9B,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,OAAO,CAAC,2BAA2B,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAC1D,KAAK,GACP,KAAK;CACV,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,WAAW,kBAAkB,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,GAAG,OAAO,EAAE,CAAC,GAAG,OAAO,CACvE,SAAQ,gBAAgB,CAAC,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;IAGlD,kDAAkD;IAClD,SAAS,CACP,MAAM,EAAE,mBAAmB,CAAC,UAAU,CAAC,EACvC,gBAAgB,CAAC,EAAE,UAAU,GAC5B,OAAO,CACR,2BAA2B,CACzB,CAAC,EACD,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,oBAAoB,CAAC,CAAC,CACnE,CACF,CAAC;IAEF,mDAAmD;IACnD,UAAU,IAAI,OAAO,CACnB,2BAA2B,CAAC,CAAC,EAAE,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,mBAAmB,CAAC,CAAC,CAAC,CAClG,CAAC;IAEF,oDAAoD;IACpD,WAAW,CACT,MAAM,EAAE,qBAAqB,CAAC,UAAU,CAAC,EACzC,gBAAgB,CAAC,EAAE,UAAU,GAC5B,OAAO,CACR,2BAA2B,CACzB,CAAC,EACD,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,sBAAsB,CAAC,CAAC,CACrE,CACF,CAAC;IAEF,0DAA0D;IAC1D,iBAAiB,CACf,MAAM,EAAE,UAAU,GACjB,OAAO,CACR,2BAA2B,CACzB,CAAC,EACD,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,sBAAsB,CAAC,CAAC,CACrE,CACF,CAAC;IAEF,2DAA2D;IAC3D,kBAAkB,CAChB,MAAM,EAAE,UAAU,GACjB,OAAO,CACR,2BAA2B,CACzB,CAAC,EACD,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,sBAAsB,CAAC,CAAC,CACrE,CACF,CAAC;IAEF,mDAAmD;IACnD,UAAU,CACR,MAAM,EAAE,UAAU,EAClB,gBAAgB,CAAC,EAAE,UAAU,GAC5B,OAAO,CACR,2BAA2B,CACzB,CAAC,EACD,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,sBAAsB,CAAC,CAAC,CACrE,CACF,CAAC;IAEF,kDAAkD;IAClD,SAAS,CACP,MAAM,EAAE,UAAU,GACjB,OAAO,CACR,2BAA2B,CACzB,CAAC,EACD,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,sBAAsB,CAAC,CAAC,CACrE,CACF,CAAC;IAEF,gBAAgB;IAChB,QAAQ,CACN,KAAK,EAAE,UAAU,GAChB,OAAO,CAAC,2BAA2B,CAAC,CAAC,EAAE,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAE/F,kDAAkD;IAClD,SAAS,CACP,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,GACzB,OAAO,CACR,2BAA2B,CAAC,CAAC,EAAE,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,kBAAkB,CAAC,CAAC,CAAC,CACjG,CAAC;IAEF,sDAAsD;IACtD,aAAa,CACX,gCAAgC,EAAE,MAAM,GACvC,OAAO,CACR,2BAA2B,CAAC,CAAC,EAAE,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,kBAAkB,CAAC,CAAC,CAAC,CACjG,CAAC;IAEF,mEAAmE;IACnE,0BAA0B,CACxB,MAAM,EAAE,UAAU,EAClB,WAAW,CAAC,EAAE,MAAM,GACnB,OAAO,CACR,2BAA2B,CACzB,CAAC,EACD,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,6BAA6B,CAAC,CAAC,CAC5E,CACF,CAAC;IAEF,sEAAsE;IACtE,6BAA6B,CAC3B,MAAM,EAAE,UAAU,GACjB,OAAO,CACR,2BAA2B,CACzB,CAAC,EACD,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,6BAA6B,CAAC,CAAC,CAC5E,CACF,CAAC;IAEF,uEAAuE;IACvE,8BAA8B,IAAI,OAAO,CACvC,2BAA2B,CACzB,CAAC,EACD,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,mCAAmC,CAAC,CAAC,CAClF,CACF,CAAC;IAEF,sEAAsE;IACtE,6BAA6B,IAAI,OAAO,CACtC,2BAA2B,CACzB,CAAC,EACD,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,6BAA6B,CAAC,CAAC,CAC5E,CACF,CAAC;IAEF,iDAAiD;IACjD,QAAQ,CACN,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,UAAU,GACjB,OAAO,CAAC,2BAA2B,CAAC,CAAC,EAAE,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAE/F,iDAAiD;IACjD,QAAQ,CACN,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,UAAU,GACjB,OAAO,CAAC,2BAA2B,CAAC,CAAC,EAAE,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAE/F,mDAAmD;IACnD,UAAU,CACR,MAAM,EAAE,UAAU,EAClB,iBAAiB,CAAC,EAAE,UAAU,GAC7B,OAAO,CAAC,mBAAmB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAEzC,+DAA+D;IAC/D,sBAAsB,IAAI,OAAO,CAC/B,2BAA2B,CAAC,CAAC,EAAE,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CACnF,CAAC;IAEF,kDAAkD;IAClD,SAAS,CACP,MAAM,EAAE,UAAU,GACjB,OAAO,CAAC,2BAA2B,CAAC,CAAC,EAAE,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAE/F,oDAAoD;IACpD,WAAW,CACT,MAAM,EAAE,UAAU,GACjB,OAAO,CAAC,2BAA2B,CAAC,CAAC,EAAE,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAE/F,iEAAiE;IACjE,wBAAwB,IAAI,OAAO,CACjC,2BAA2B,CAAC,CAAC,EAAE,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CACnF,CAAC;IAEF,yDAAyD;IACzD,gBAAgB,CACd,YAAY,EAAE,UAAU,GACvB,OAAO,CAAC,2BAA2B,CAAC,CAAC,EAAE,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;CAChG"}

package/dist/src/PopulatableLiquity.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=PopulatableLiquity.js.map

package/dist/src/PopulatableLiquity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PopulatableLiquity.js","sourceRoot":"","sources":["../../src/PopulatableLiquity.ts"],"names":[],"mappings":""}

package/dist/src/ReadableLiquity.d.ts

@@ -0,0 +1,156 @@
+import { Decimal } from "./Decimal";
+import { Trove, TroveWithPendingRedistribution, UserTrove } from "./Trove";
+import { StabilityDeposit } from "./StabilityDeposit";
+import { Fees } from "./Fees";
+import { ZEROStake } from "./ZEROStake";
+/**
+ * Represents whether an address has been registered as a Zero frontend.
+ *
+ * @remarks
+ * Returned by the {@link ReadableLiquity.getFrontendStatus | getFrontendStatus()} function.
+ *
+ * When `status` is `"registered"`, `kickbackRate` gives the frontend's kickback rate as a
+ * {@link Decimal} between 0 and 1.
+ *
+ * @public
+ */
+export declare type FrontendStatus = {
+    status: "unregistered";
+} | {
+    status: "registered";
+    kickbackRate: Decimal;
+};
+/**
+ * Parameters of the {@link ReadableLiquity.(getTroves:2) | getTroves()} function.
+ *
+ * @public
+ */
+export interface TroveListingParams {
+    /** Number of Troves to retrieve. */
+    readonly first: number;
+    /** How the Troves should be sorted. */
+    readonly sortedBy: "ascendingCollateralRatio" | "descendingCollateralRatio";
+    /** Index of the first Trove to retrieve from the sorted list. */
+    readonly startingAt?: number;
+    /**
+     * When set to `true`, the retrieved Troves won't include the liquidation shares received since
+     * the last time they were directly modified.
+     *
+     * @remarks
+     * Changes the type of returned Troves to {@link TroveWithPendingRedistribution}.
+     */
+    readonly beforeRedistribution?: boolean;
+}
+/**
+ * Read the state of the Zero protocol.
+ *
+ * @remarks
+ * Implemented by {@link @sovryn-zero/lib-ethers#EthersLiquity}.
+ *
+ * @public
+ */
+export interface ReadableLiquity {
+    /**
+     * Get the total collateral and debt per stake that has been liquidated through redistribution.
+     *
+     * @remarks
+     * Needed when dealing with instances of {@link @sovryn-zero/lib-base#TroveWithPendingRedistribution}.
+     */
+    getTotalRedistributed(): Promise<Trove>;
+    /**
+     * Get a Trove in its state after the last direct modification.
+     *
+     * @param address - Address that owns the Trove.
+     *
+     * @remarks
+     * The current state of a Trove can be fetched using
+     * {@link @sovryn-zero/lib-base#ReadableLiquity.getTrove | getTrove()}.
+     */
+    getTroveBeforeRedistribution(address?: string): Promise<TroveWithPendingRedistribution>;
+    /**
+     * Get the current state of a Trove.
+     *
+     * @param address - Address that owns the Trove.
+     */
+    getTrove(address?: string): Promise<UserTrove>;
+    /**
+     * Get number of Troves that are currently open.
+     */
+    getNumberOfTroves(): Promise<number>;
+    /**
+     * Get the current price of the native currency (e.g. Ether) in USD.
+     */
+    getPrice(): Promise<Decimal>;
+    /**
+     * Get the total amount of collateral and debt in the Zero system.
+     */
+    getTotal(): Promise<Trove>;
+    /**
+     * Get the current state of a Stability Deposit.
+     *
+     * @param address - Address that owns the Stability Deposit.
+     */
+    getStabilityDeposit(address?: string): Promise<StabilityDeposit>;
+    /**
+     * Get the remaining ZERO that will be collectively rewarded to stability depositors.
+     */
+    getRemainingStabilityPoolZEROReward(): Promise<Decimal>;
+    /**
+     * Get the total amount of ZUSD currently deposited in the Stability Pool.
+     */
+    getZUSDInStabilityPool(): Promise<Decimal>;
+    /**
+     * Get the amount of ZUSD held by an address.
+     *
+     * @param address - Address whose balance should be retrieved.
+     */
+    getZUSDBalance(address?: string): Promise<Decimal>;
+    /**
+     * Get the amount of ZERO held by an address.
+     *
+     * @param address - Address whose balance should be retrieved.
+     */
+    getZEROBalance(address?: string): Promise<Decimal>;
+    /**
+     * Get the amount of leftover collateral available for withdrawal by an address.
+     *
+     * @remarks
+     * When a Trove gets liquidated or redeemed, any collateral it has above 110% (in case of
+     * liquidation) or 100% collateralization (in case of redemption) gets sent to a pool, where it
+     * can be withdrawn from using
+     * {@link @sovryn-zero/lib-base#TransactableLiquity.claimCollateralSurplus | claimCollateralSurplus()}.
+     */
+    getCollateralSurplusBalance(address?: string): Promise<Decimal>;
+    /** @internal */
+    getTroves(params: TroveListingParams & {
+        beforeRedistribution: true;
+    }): Promise<TroveWithPendingRedistribution[]>;
+    /**
+     * Get a slice from the list of Troves.
+     *
+     * @param params - Controls how the list is sorted, and where the slice begins and ends.
+     * @returns Pairs of owner addresses and their Troves.
+     */
+    getTroves(params: TroveListingParams): Promise<UserTrove[]>;
+    /**
+     * Get a calculator for current fees.
+     */
+    getFees(): Promise<Fees>;
+    /**
+     * Get the current state of an ZERO Stake.
+     *
+     * @param address - Address that owns the ZERO Stake.
+     */
+    getZEROStake(address?: string): Promise<ZEROStake>;
+    /**
+     * Get the total amount of ZERO currently staked.
+     */
+    getTotalStakedZERO(): Promise<Decimal>;
+    /**
+     * Check whether an address is registered as a Zero frontend, and what its kickback rate is.
+     *
+     * @param address - Address to check.
+     */
+    getFrontendStatus(address?: string): Promise<FrontendStatus>;
+}
+//# sourceMappingURL=ReadableLiquity.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ReadableLiquity.d.ts","sourceRoot":"","sources":["../../src/ReadableLiquity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,KAAK,EAAE,8BAA8B,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAC3E,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC;;;;;;;;;;GAUG;AACH,oBAAY,cAAc,GACtB;IAAE,MAAM,EAAE,cAAc,CAAA;CAAE,GAC1B;IAAE,MAAM,EAAE,YAAY,CAAC;IAAC,YAAY,EAAE,OAAO,CAAA;CAAE,CAAC;AAEpD;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,oCAAoC;IACpC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IAEvB,uCAAuC;IACvC,QAAQ,CAAC,QAAQ,EAAE,0BAA0B,GAAG,2BAA2B,CAAC;IAE5E,iEAAiE;IACjE,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAE7B;;;;;;OAMG;IACH,QAAQ,CAAC,oBAAoB,CAAC,EAAE,OAAO,CAAC;CACzC;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;;OAKG;IACH,qBAAqB,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC;IAExC;;;;;;;;OAQG;IACH,4BAA4B,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,8BAA8B,CAAC,CAAC;IAExF;;;;OAIG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IAE/C;;OAEG;IACH,iBAAiB,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAErC;;OAEG;IACH,QAAQ,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAE7B;;OAEG;IACH,QAAQ,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC;IAE3B;;;;OAIG;IACH,mBAAmB,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAEjE;;OAEG;IACH,mCAAmC,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAExD;;OAEG;IACH,sBAAsB,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAE3C;;;;OAIG;IACH,cAAc,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEnD;;;;OAIG;IACH,cAAc,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEnD;;;;;;;;OAQG;IACH,2BAA2B,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEhE,gBAAgB;IAChB,SAAS,CACP,MAAM,EAAE,kBAAkB,GAAG;QAAE,oBAAoB,EAAE,IAAI,CAAA;KAAE,GAC1D,OAAO,CAAC,8BAA8B,EAAE,CAAC,CAAC;IAE7C;;;;;OAKG;IACH,SAAS,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;IAE5D;;OAEG;IACH,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzB;;;;OAIG;IACH,YAAY,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IAEnD;;OAEG;IACH,kBAAkB,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAEvC;;;;OAIG;IACH,iBAAiB,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;CAC9D"}

package/dist/src/ReadableLiquity.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ReadableLiquity.js.map

package/dist/src/ReadableLiquity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReadableLiquity.js","sourceRoot":"","sources":["../../src/ReadableLiquity.ts"],"names":[],"mappings":""}

package/dist/src/SendableLiquity.d.ts

@@ -0,0 +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>>>;
+}
+//# sourceMappingURL=SendableLiquity.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SendableLiquity.d.ts","sourceRoot":"","sources":["../../src/SendableLiquity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAErE,OAAO,EACL,6BAA6B,EAC7B,kBAAkB,EAClB,iBAAiB,EACjB,6BAA6B,EAC7B,mCAAmC,EACnC,mBAAmB,EACnB,sBAAsB,EACtB,mBAAmB,EACnB,oBAAoB,EACrB,MAAM,uBAAuB,CAAC;AAE/B;;;;;;;GAOG;AACH,MAAM,WAAW,sBAAsB,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,SAAS,cAAc,GAAG,cAAc;IAC5F,uDAAuD;IACvD,QAAQ,CAAC,kBAAkB,EAAE,CAAC,CAAC;IAE/B;;;;;;OAMG;IACH,UAAU,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC;IAEzB;;;;;OAKG;IACH,cAAc,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC;CACrD;AAED;;;;;;;GAOG;AACH,oBAAY,cAAc,GAAG;IAAE,MAAM,EAAE,SAAS,CAAA;CAAE,CAAC;AAEnD,gBAAgB;AAChB,eAAO,MAAM,eAAe,EAAE,cAAsC,CAAC;AAErE;;;;;;;;;;GAUG;AACH,oBAAY,aAAa,CAAC,CAAC,GAAG,OAAO,IAAI;IAAE,MAAM,EAAE,QAAQ,CAAC;IAAC,UAAU,EAAE,CAAC,CAAA;CAAE,CAAC;AAE7E,gBAAgB;AAChB,eAAO,MAAM,cAAc,wCAGzB,CAAC;AAEH;;;;;;;;;;;;;;GAcG;AACH,oBAAY,iBAAiB,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,GAAG,OAAO,IAAI;IACxD,MAAM,EAAE,WAAW,CAAC;IACpB,UAAU,EAAE,CAAC,CAAC;IACd,OAAO,EAAE,CAAC,CAAC;CACZ,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,kBAAkB,sDAGZ,MAAM,yCAMvB,CAAC;AAEH;;;;GAIG;AACH,oBAAY,YAAY,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,GAAG,OAAO,IAAI,aAAa,CAAC,CAAC,CAAC,GAAG,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAEhG;;;;GAIG;AACH,oBAAY,cAAc,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,GAAG,OAAO,IAAI,cAAc,GAAG,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAE3F,gBAAgB;AAChB,oBAAY,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI;KAClC,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC,GAC/D,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,OAAO,CAAC,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,GACxE,KAAK;CACV,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,WAAW,eAAe,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,GAAG,OAAO,CACvD,SAAQ,aAAa,CAAC,mBAAmB,EAAE,CAAC,EAAE,CAAC,CAAC;IAGhD,kDAAkD;IAClD,SAAS,CACP,MAAM,EAAE,mBAAmB,CAAC,UAAU,CAAC,EACvC,gBAAgB,CAAC,EAAE,UAAU,GAC5B,OAAO,CAAC,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,oBAAoB,CAAC,CAAC,CAAC,CAAC;IAE/E,mDAAmD;IACnD,UAAU,IAAI,OAAO,CAAC,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,mBAAmB,CAAC,CAAC,CAAC,CAAC;IAEzF,oDAAoD;IACpD,WAAW,CACT,MAAM,EAAE,qBAAqB,CAAC,UAAU,CAAC,EACzC,gBAAgB,CAAC,EAAE,UAAU,GAC5B,OAAO,CAAC,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,sBAAsB,CAAC,CAAC,CAAC,CAAC;IAEjF,0DAA0D;IAC1D,iBAAiB,CACf,MAAM,EAAE,UAAU,GACjB,OAAO,CAAC,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,sBAAsB,CAAC,CAAC,CAAC,CAAC;IAEjF,2DAA2D;IAC3D,kBAAkB,CAChB,MAAM,EAAE,UAAU,GACjB,OAAO,CAAC,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,sBAAsB,CAAC,CAAC,CAAC,CAAC;IAEjF,mDAAmD;IACnD,UAAU,CACR,MAAM,EAAE,UAAU,EAClB,gBAAgB,CAAC,EAAE,UAAU,GAC5B,OAAO,CAAC,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,sBAAsB,CAAC,CAAC,CAAC,CAAC;IAEjF,kDAAkD;IAClD,SAAS,CACP,MAAM,EAAE,UAAU,GACjB,OAAO,CAAC,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,sBAAsB,CAAC,CAAC,CAAC,CAAC;IAEjF,gBAAgB;IAChB,QAAQ,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IAEzF,kDAAkD;IAClD,SAAS,CACP,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,GACzB,OAAO,CAAC,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,kBAAkB,CAAC,CAAC,CAAC,CAAC;IAE7E,sDAAsD;IACtD,aAAa,CACX,gCAAgC,EAAE,MAAM,GACvC,OAAO,CAAC,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,kBAAkB,CAAC,CAAC,CAAC,CAAC;IAE7E,mEAAmE;IACnE,0BAA0B,CACxB,MAAM,EAAE,UAAU,EAClB,WAAW,CAAC,EAAE,MAAM,GACnB,OAAO,CAAC,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,6BAA6B,CAAC,CAAC,CAAC,CAAC;IAExF,sEAAsE;IACtE,6BAA6B,CAC3B,MAAM,EAAE,UAAU,GACjB,OAAO,CAAC,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,6BAA6B,CAAC,CAAC,CAAC,CAAC;IAExF,uEAAuE;IACvE,8BAA8B,IAAI,OAAO,CACvC,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,mCAAmC,CAAC,CAAC,CAClF,CAAC;IAEF,sEAAsE;IACtE,6BAA6B,IAAI,OAAO,CACtC,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,6BAA6B,CAAC,CAAC,CAC5E,CAAC;IAEF,iDAAiD;IACjD,QAAQ,CACN,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,UAAU,GACjB,OAAO,CAAC,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IAE/D,iDAAiD;IACjD,QAAQ,CACN,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,UAAU,GACjB,OAAO,CAAC,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IAE/D,mDAAmD;IACnD,UAAU,CACR,MAAM,EAAE,UAAU,EAClB,iBAAiB,CAAC,EAAE,UAAU,GAC7B,OAAO,CAAC,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC;IAE5E,+DAA+D;IAC/D,sBAAsB,IAAI,OAAO,CAAC,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IAEtF,kDAAkD;IAClD,SAAS,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IAE3F,oDAAoD;IACpD,WAAW,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IAE7F,iEAAiE;IACjE,wBAAwB,IAAI,OAAO,CAAC,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IAExF,yDAAyD;IACzD,gBAAgB,CACd,YAAY,EAAE,UAAU,GACvB,OAAO,CAAC,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;CAChE"}

package/dist/src/SendableLiquity.js

@@ -0,0 +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;
+//# sourceMappingURL=SendableLiquity.js.map

package/dist/src/SendableLiquity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SendableLiquity.js","sourceRoot":"","sources":["../../src/SendableLiquity.ts"],"names":[],"mappings":";;;AAuDA,gBAAgB;AACH,QAAA,eAAe,GAAmB,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;AAerE,gBAAgB;AACT,MAAM,cAAc,GAAG,CAAI,UAAa,EAAoB,EAAE,CAAC,CAAC;IACrE,MAAM,EAAE,QAAQ;IAChB,UAAU;CACX,CAAC,CAAC;AAHU,QAAA,cAAc,kBAGxB;AAuBH,gBAAgB;AACT,MAAM,kBAAkB,GAAG,CAChC,UAAa,EACb,OAAU,EACV,QAAuB,EACE,EAAE,CAAC,CAAC;IAC7B,MAAM,EAAE,WAAW;IACnB,UAAU;IACV,OAAO;IACP,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;CAClC,CAAC,CAAC;AATU,QAAA,kBAAkB,sBAS5B"}

package/dist/src/StabilityDeposit.d.ts

@@ -0,0 +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;
+}
+//# sourceMappingURL=StabilityDeposit.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"StabilityDeposit.d.ts","sourceRoot":"","sources":["../../src/StabilityDeposit.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAEhD;;;;GAIG;AACH,oBAAY,sBAAsB,CAAC,CAAC,IAChC;IAAE,WAAW,EAAE,CAAC,CAAC;IAAC,YAAY,CAAC,EAAE,SAAS,CAAA;CAAE,GAC5C;IAAE,WAAW,CAAC,EAAE,SAAS,CAAC;IAAC,YAAY,EAAE,CAAC,CAAC;IAAC,eAAe,EAAE,OAAO,CAAA;CAAE,CAAC;AAE3E;;;;GAIG;AACH,qBAAa,gBAAgB;IAC3B,2FAA2F;IAC3F,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;IAE9B,oDAAoD;IACpD,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;IAE9B,wFAAwF;IACxF,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC;IAEjC,oFAAoF;IACpF,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAE7B;;;;;;OAMG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAE7B,gBAAgB;gBAEd,WAAW,EAAE,OAAO,EACpB,WAAW,EAAE,OAAO,EACpB,cAAc,EAAE,OAAO,EACvB,UAAU,EAAE,OAAO,EACnB,WAAW,EAAE,MAAM;IAarB,IAAI,OAAO,IAAI,OAAO,CAOrB;IAED,gBAAgB;IAChB,QAAQ,IAAI,MAAM;IAUlB;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,gBAAgB,GAAG,OAAO;IAUvC;;;;OAIG;IACH,WAAW,CAAC,QAAQ,EAAE,UAAU,GAAG,sBAAsB,CAAC,OAAO,CAAC,GAAG,SAAS;IAY9E;;;;OAIG;IACH,KAAK,CAAC,MAAM,EAAE,sBAAsB,CAAC,UAAU,CAAC,GAAG,SAAS,GAAG,OAAO;CAavE"}

package/dist/src/StabilityDeposit.js

@@ -0,0 +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;
+//# sourceMappingURL=StabilityDeposit.js.map