@sovryn-zero/lib-base 1.0.0-early.access.2 → 1.0.0-early.access.4

package/dist/src/TransactableZero.d.ts

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"TransactableLiquity.d.ts","sourceRoot":"","sources":["../../src/TransactableLiquity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAChD,OAAO,EAAE,KAAK,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAChG,OAAO,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAC5D,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAElD;;;;GAIG;AACH,qBAAa,sBAAsB,CAAC,CAAC,SAAS,aAAa,GAAG,aAAa,CAAE,SAAQ,KAAK;IACxF,QAAQ,CAAC,aAAa,EAAE,CAAC,CAAC;IAE1B,gBAAgB;gBACJ,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC;CAK5D;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,2CAA2C;IAC3C,MAAM,EAAE,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAErC,qDAAqD;IACrD,QAAQ,EAAE,KAAK,CAAC;IAEhB,iEAAiE;IACjE,GAAG,EAAE,OAAO,CAAC;CACd;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,oCAAoC;IACpC,MAAM,EAAE,qBAAqB,CAAC,OAAO,CAAC,CAAC;IAEvC,sEAAsE;IACtE,QAAQ,EAAE,KAAK,CAAC;IAEhB,iEAAiE;IACjE,GAAG,EAAE,OAAO,CAAC;CACd;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,yCAAyC;IACzC,MAAM,EAAE,kBAAkB,CAAC,OAAO,CAAC,CAAC;CACrC;AAED;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IACjC,iEAAiE;IACjE,mBAAmB,EAAE,MAAM,EAAE,CAAC;IAE9B,uEAAuE;IACvE,eAAe,EAAE,KAAK,CAAC;IAEvB,iEAAiE;IACjE,mBAAmB,EAAE,OAAO,CAAC;IAE7B,yFAAyF;IACzF,yBAAyB,EAAE,OAAO,CAAC;CACpC;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,mDAAmD;IACnD,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;;;;;;;OAQG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAE1B,8EAA8E;IAC9E,eAAe,EAAE,OAAO,CAAC;IAEzB,oFAAoF;IACpF,GAAG,EAAE,OAAO,CAAC;CACd;AAED;;;;;;GAMG;AACH,MAAM,WAAW,mCAAmC;IAClD,0FAA0F;IAC1F,QAAQ,EAAE,OAAO,CAAC;IAElB,qEAAqE;IACrE,cAAc,EAAE,OAAO,CAAC;IAExB,4FAA4F;IAC5F,cAAc,EAAE,OAAO,CAAC;IAExB,oEAAoE;IACpE,UAAU,EAAE,OAAO,CAAC;CACrB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,6BAA8B,SAAQ,mCAAmC;IACxF,+DAA+D;IAC/D,MAAM,EAAE,sBAAsB,CAAC,OAAO,CAAC,CAAC;CACzC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,6BAA8B,SAAQ,mCAAmC;IACxF,yEAAyE;IACzE,QAAQ,EAAE,KAAK,CAAC;CACjB;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;;;;;;;;;;;OAaG;IACH,SAAS,CACP,MAAM,EAAE,mBAAmB,CAAC,UAAU,CAAC,EACvC,gBAAgB,CAAC,EAAE,UAAU,GAC5B,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAEjC;;;;;OAKG;IACH,UAAU,IAAI,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAE3C;;;;;;;;;;;;;;;;;OAiBG;IACH,WAAW,CACT,MAAM,EAAE,qBAAqB,CAAC,UAAU,CAAC,EACzC,gBAAgB,CAAC,EAAE,UAAU,GAC5B,OAAO,CAAC,sBAAsB,CAAC,CAAC;IAEnC;;;;;;;;;;;;;;OAcG;IACH,iBAAiB,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC;IAEvE;;;;;;;;;;;;;;OAcG;IACH,kBAAkB,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC;IAExE;;;;;;;;;;;;;;;;OAgBG;IACH,UAAU,CAAC,MAAM,EAAE,UAAU,EAAE,gBAAgB,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC;IAE/F;;;;;;;;;;;;;;OAcG;IACH,SAAS,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC;IAE/D,gBAAgB;IAChB,QAAQ,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3C;;;;;;;OAOG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAEnE;;;;;;;OAOG;IACH,aAAa,CAAC,gCAAgC,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAErF;;;;;;;;;;;;;;;OAeG;IACH,0BAA0B,CACxB,MAAM,EAAE,UAAU,EAClB,WAAW,CAAC,EAAE,MAAM,GACnB,OAAO,CAAC,6BAA6B,CAAC,CAAC;IAE1C;;;;;;;;;;;;OAYG;IACH,6BAA6B,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,6BAA6B,CAAC,CAAC;IAE1F;;;;;;OAMG;IACH,8BAA8B,IAAI,OAAO,CAAC,mCAAmC,CAAC,CAAC;IAE/E;;;;;;;;;;;;OAYG;IACH,6BAA6B,IAAI,OAAO,CAAC,6BAA6B,CAAC,CAAC;IAExE;;;;;;;;OAQG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/D;;;;;;;;OAQG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/D;;;;;;;;;;;;;OAaG;IACH,UAAU,CAAC,MAAM,EAAE,UAAU,EAAE,iBAAiB,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAE3F;;;;;;;;;OASG;IACH,sBAAsB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAExC;;;;;;;;;;;;OAYG;IACH,SAAS,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7C;;;;;;;;;;;;OAYG;IACH,WAAW,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/C;;;;;;OAMG;IACH,wBAAwB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1C;;;;;;;;OAQG;IACH,gBAAgB,CAAC,YAAY,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC3D"}

package/dist/src/TransactableZero.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransactionFailedError = void 0;
+/**
+ * Thrown by {@link TransactableLiquity} functions in case of transaction failure.
+ *
+ * @public
+ */
+class TransactionFailedError extends Error {
+    /** @internal */
+    constructor(name, message, failedReceipt) {
+        super(message);
+        this.name = name;
+        this.failedReceipt = failedReceipt;
+    }
+}
+exports.TransactionFailedError = TransactionFailedError;
+//# sourceMappingURL=TransactableLiquity.js.map

package/dist/src/TransactableZero.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TransactableLiquity.js","sourceRoot":"","sources":["../../src/TransactableLiquity.ts"],"names":[],"mappings":";;;AAKA;;;;GAIG;AACH,MAAa,sBAAgE,SAAQ,KAAK;IAGxF,gBAAgB;IAChB,YAAY,IAAY,EAAE,OAAe,EAAE,aAAgB;QACzD,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;IACrC,CAAC;CACF;AATD,wDASC"}

package/dist/src/ZeroStore.d.ts

@@ -0,0 +1,209 @@
+import { Decimal } from "./Decimal";
+import { StabilityDeposit } from "./StabilityDeposit";
+import { Trove, TroveWithPendingRedistribution, UserTrove } from "./Trove";
+import { Fees } from "./Fees";
+import { ZEROStake } from "./ZEROStake";
+import { FrontendStatus } from "./ReadableLiquity";
+/**
+ * State variables read from the blockchain.
+ *
+ * @public
+ */
+export interface LiquityStoreBaseState {
+    /** Status of currently used frontend. */
+    frontend: FrontendStatus;
+    /** Status of user's own frontend. */
+    ownFrontend: FrontendStatus;
+    /** Number of Troves that are currently open. */
+    numberOfTroves: number;
+    /** User's native currency balance (e.g. Ether). */
+    accountBalance: Decimal;
+    /** User's ZUSD token balance. */
+    zusdBalance: Decimal;
+    /** User's NUE token balance. */
+    nueBalance: Decimal;
+    /** User's ZERO token balance. */
+    zeroBalance: Decimal;
+    /**
+     * Amount of leftover collateral available for withdrawal to the user.
+     *
+     * @remarks
+     * See {@link ReadableLiquity.getCollateralSurplusBalance | getCollateralSurplusBalance()} for
+     * more information.
+     */
+    collateralSurplusBalance: Decimal;
+    /** Current price of the native currency (e.g. Ether) in USD. */
+    price: Decimal;
+    /** Total amount of ZUSD currently deposited in the Stability Pool. */
+    zusdInStabilityPool: Decimal;
+    /** Total collateral and debt in the Zero system. */
+    total: Trove;
+    /**
+     * Total collateral and debt per stake that has been liquidated through redistribution.
+     *
+     * @remarks
+     * Needed when dealing with instances of {@link TroveWithPendingRedistribution}.
+     */
+    totalRedistributed: Trove;
+    /**
+     * User's Trove in its state after the last direct modification.
+     *
+     * @remarks
+     * The current state of the user's Trove can be found as
+     * {@link LiquityStoreDerivedState.trove | trove}.
+     */
+    troveBeforeRedistribution: TroveWithPendingRedistribution;
+    /** User's stability deposit. */
+    stabilityDeposit: StabilityDeposit;
+    /** Remaining ZERO that will be collectively rewarded to stability depositors. */
+    remainingStabilityPoolZEROReward: Decimal;
+    /** @internal */
+    _feesInNormalMode: Fees;
+    /** User's ZERO stake. */
+    zeroStake: ZEROStake;
+    /** Total amount of ZERO currently staked. */
+    totalStakedZERO: Decimal;
+    /** @internal */
+    _riskiestTroveBeforeRedistribution: TroveWithPendingRedistribution;
+}
+/**
+ * State variables derived from {@link LiquityStoreBaseState}.
+ *
+ * @public
+ */
+export interface LiquityStoreDerivedState {
+    /** Current state of user's Trove */
+    trove: UserTrove;
+    /** Calculator for current fees. */
+    fees: Fees;
+    /**
+     * Current borrowing rate.
+     *
+     * @remarks
+     * A value between 0 and 1.
+     *
+     * @example
+     * For example a value of 0.01 amounts to a borrowing fee of 1% of the borrowed amount.
+     */
+    borrowingRate: Decimal;
+    /**
+     * Current redemption rate.
+     *
+     * @remarks
+     * Note that the actual rate paid by a redemption transaction will depend on the amount of ZUSD
+     * being redeemed.
+     *
+     * Use {@link Fees.redemptionRate} to calculate a precise redemption rate.
+     */
+    redemptionRate: Decimal;
+    /**
+     * Whether there are any Troves with collateral ratio below the
+     * {@link MINIMUM_COLLATERAL_RATIO | minimum}.
+     */
+    haveUndercollateralizedTroves: boolean;
+}
+/**
+ * Type of {@link LiquityStore}'s {@link LiquityStore.state | state}.
+ *
+ * @remarks
+ * It combines all properties of {@link LiquityStoreBaseState} and {@link LiquityStoreDerivedState}
+ * with optional extra state added by the particular `LiquityStore` implementation.
+ *
+ * The type parameter `T` may be used to type the extra state.
+ *
+ * @public
+ */
+export declare type LiquityStoreState<T = unknown> = LiquityStoreBaseState & LiquityStoreDerivedState & T;
+/**
+ * Parameters passed to {@link LiquityStore} listeners.
+ *
+ * @remarks
+ * Use the {@link LiquityStore.subscribe | subscribe()} function to register a listener.
+
+ * @public
+ */
+export interface LiquityStoreListenerParams<T = unknown> {
+    /** The entire previous state. */
+    newState: LiquityStoreState<T>;
+    /** The entire new state. */
+    oldState: LiquityStoreState<T>;
+    /** Only the state variables that have changed. */
+    stateChange: Partial<LiquityStoreState<T>>;
+}
+/**
+ * Abstract base class of Zero data store implementations.
+ *
+ * @remarks
+ * The type parameter `T` may be used to type extra state added to {@link LiquityStoreState} by the
+ * subclass.
+ *
+ * Implemented by {@link @sovryn-zero/lib-ethers#BlockPolledLiquityStore}.
+ *
+ * @public
+ */
+export declare abstract class LiquityStore<T = unknown> {
+    /** Turn console logging on/off. */
+    logging: boolean;
+    /**
+     * Called after the state is fetched for the first time.
+     *
+     * @remarks
+     * See {@link LiquityStore.start | start()}.
+     */
+    onLoaded?: () => void;
+    /** @internal */
+    protected _loaded: boolean;
+    private _baseState?;
+    private _derivedState?;
+    private _extraState?;
+    private _updateTimeoutId;
+    private _listeners;
+    /**
+     * The current store state.
+     *
+     * @remarks
+     * Should not be accessed before the store is loaded. Assign a function to
+     * {@link LiquityStore.onLoaded | onLoaded} to get a callback when this happens.
+     *
+     * See {@link LiquityStoreState} for the list of properties returned.
+     */
+    get state(): LiquityStoreState<T>;
+    /** @internal */
+    protected abstract _doStart(): () => void;
+    /**
+     * Start monitoring the blockchain for Zero state changes.
+     *
+     * @remarks
+     * The {@link LiquityStore.onLoaded | onLoaded} callback will be called after the state is fetched
+     * for the first time.
+     *
+     * Use the {@link LiquityStore.subscribe | subscribe()} function to register listeners.
+     *
+     * @returns Function to stop the monitoring.
+     */
+    start(): () => void;
+    private _cancelUpdateIfScheduled;
+    private _scheduleUpdate;
+    private _logUpdate;
+    private _updateIfChanged;
+    private _silentlyUpdateIfChanged;
+    private _updateFees;
+    private _reduce;
+    private _derive;
+    private _reduceDerived;
+    /** @internal */
+    protected abstract _reduceExtra(extraState: T, extraStateUpdate: Partial<T>): T;
+    private _notify;
+    /**
+     * Register a state change listener.
+     *
+     * @param listener - Function that will be called whenever state changes.
+     * @returns Function to unregister this listener.
+     */
+    subscribe(listener: (params: LiquityStoreListenerParams<T>) => void): () => void;
+    /** @internal */
+    protected _load(baseState: LiquityStoreBaseState, extraState?: T): void;
+    /** @internal */
+    protected _update(baseStateUpdate?: Partial<LiquityStoreBaseState>, extraStateUpdate?: Partial<T>): void;
+}
+//# sourceMappingURL=LiquityStore.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"LiquityStore.d.ts","sourceRoot":"","sources":["../../src/LiquityStore.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,KAAK,EAAE,8BAA8B,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAC3E,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAEnD;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,yCAAyC;IACzC,QAAQ,EAAE,cAAc,CAAC;IAEzB,qCAAqC;IACrC,WAAW,EAAE,cAAc,CAAC;IAE5B,gDAAgD;IAChD,cAAc,EAAE,MAAM,CAAC;IAEvB,mDAAmD;IACnD,cAAc,EAAE,OAAO,CAAC;IAExB,iCAAiC;IACjC,WAAW,EAAE,OAAO,CAAC;IAErB,gCAAgC;IAChC,UAAU,EAAE,OAAO,CAAC;IAEpB,iCAAiC;IACjC,WAAW,EAAE,OAAO,CAAC;IAErB;;;;;;OAMG;IACH,wBAAwB,EAAE,OAAO,CAAC;IAElC,gEAAgE;IAChE,KAAK,EAAE,OAAO,CAAC;IAEf,sEAAsE;IACtE,mBAAmB,EAAE,OAAO,CAAC;IAE7B,oDAAoD;IACpD,KAAK,EAAE,KAAK,CAAC;IAEb;;;;;OAKG;IACH,kBAAkB,EAAE,KAAK,CAAC;IAE1B;;;;;;OAMG;IACH,yBAAyB,EAAE,8BAA8B,CAAC;IAE1D,gCAAgC;IAChC,gBAAgB,EAAE,gBAAgB,CAAC;IAEnC,iFAAiF;IACjF,gCAAgC,EAAE,OAAO,CAAC;IAE1C,gBAAgB;IAChB,iBAAiB,EAAE,IAAI,CAAC;IAExB,yBAAyB;IACzB,SAAS,EAAE,SAAS,CAAC;IAErB,6CAA6C;IAC7C,eAAe,EAAE,OAAO,CAAC;IAEzB,gBAAgB;IAChB,kCAAkC,EAAE,8BAA8B,CAAC;CACpE;AAED;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACvC,oCAAoC;IACpC,KAAK,EAAE,SAAS,CAAC;IAEjB,mCAAmC;IACnC,IAAI,EAAE,IAAI,CAAC;IAEX;;;;;;;;OAQG;IACH,aAAa,EAAE,OAAO,CAAC;IAEvB;;;;;;;;OAQG;IACH,cAAc,EAAE,OAAO,CAAC;IAExB;;;OAGG;IACH,6BAA6B,EAAE,OAAO,CAAC;CACxC;AAED;;;;;;;;;;GAUG;AACH,oBAAY,iBAAiB,CAAC,CAAC,GAAG,OAAO,IAAI,qBAAqB,GAAG,wBAAwB,GAAG,CAAC,CAAC;AAElG;;;;;;;GAOG;AACH,MAAM,WAAW,0BAA0B,CAAC,CAAC,GAAG,OAAO;IACrD,iCAAiC;IACjC,QAAQ,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC;IAE/B,4BAA4B;IAC5B,QAAQ,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC;IAE/B,kDAAkD;IAClD,WAAW,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC;CAC5C;AAuBD;;;;;;;;;;GAUG;AACH,8BAAsB,YAAY,CAAC,CAAC,GAAG,OAAO;IAC5C,mCAAmC;IACnC,OAAO,UAAS;IAEhB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAC;IAEtB,gBAAgB;IAChB,SAAS,CAAC,OAAO,UAAS;IAE1B,OAAO,CAAC,UAAU,CAAC,CAAwB;IAC3C,OAAO,CAAC,aAAa,CAAC,CAA2B;IACjD,OAAO,CAAC,WAAW,CAAC,CAAI;IAExB,OAAO,CAAC,gBAAgB,CAA4C;IACpE,OAAO,CAAC,UAAU,CAA8D;IAEhF;;;;;;;;OAQG;IACH,IAAI,KAAK,IAAI,iBAAiB,CAAC,CAAC,CAAC,CAEhC;IAED,gBAAgB;IAChB,SAAS,CAAC,QAAQ,CAAC,QAAQ,IAAI,MAAM,IAAI;IAEzC;;;;;;;;;;OAUG;IACH,KAAK,IAAI,MAAM,IAAI;IAUnB,OAAO,CAAC,wBAAwB;IAMhC,OAAO,CAAC,eAAe;IASvB,OAAO,CAAC,UAAU;IAQlB,OAAO,CAAC,gBAAgB;IAUxB,OAAO,CAAC,wBAAwB;IAIhC,OAAO,CAAC,WAAW;IAanB,OAAO,CAAC,OAAO;IAiIf,OAAO,CAAC,OAAO;IAqBf,OAAO,CAAC,cAAc;IA8BtB,gBAAgB;IAChB,SAAS,CAAC,QAAQ,CAAC,YAAY,CAAC,UAAU,EAAE,CAAC,EAAE,gBAAgB,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC;IAE/E,OAAO,CAAC,OAAO;IAcf;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,0BAA0B,CAAC,CAAC,CAAC,KAAK,IAAI,GAAG,MAAM,IAAI;IAUhF,gBAAgB;IAChB,SAAS,CAAC,KAAK,CAAC,SAAS,EAAE,qBAAqB,EAAE,UAAU,CAAC,EAAE,CAAC,GAAG,IAAI;IAevE,gBAAgB;IAChB,SAAS,CAAC,OAAO,CACf,eAAe,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,EAChD,gBAAgB,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,GAC5B,IAAI;CAyBR"}