@sovryn-zero/lib-base 0.2.0 → 0.2.2

package/dist/src/constants.d.ts

@@ -1,61 +1,61 @@
-import { Decimal } from "./Decimal";
-/**
- * Total collateral ratio below which recovery mode is triggered.
- *
- * @public
- */
-export declare const CRITICAL_COLLATERAL_RATIO: Decimal;
-/**
- * Collateral ratio below which a Trove can be liquidated in normal mode.
- *
- * @public
- */
-export declare const MINIMUM_COLLATERAL_RATIO: Decimal;
-/**
- * Amount of ZUSD that's reserved for compensating the liquidator of a Trove.
- *
- * @public
- */
-export declare const ZUSD_LIQUIDATION_RESERVE: Decimal;
-/**
- * A Trove must always have at least this much debt on top of the
- * {@link ZUSD_LIQUIDATION_RESERVE | liquidation reserve}.
- *
- * @remarks
- * Any transaction that would result in a Trove with less net debt than this will be reverted.
- *
- * @public
- */
-export declare const ZUSD_MINIMUM_NET_DEBT: Decimal;
-/**
- * A Trove must always have at least this much debt.
- *
- * @remarks
- * Any transaction that would result in a Trove with less debt than this will be reverted.
- *
- * @public
- */
-export declare const ZUSD_MINIMUM_DEBT: Decimal;
-/**
- * Value that the {@link Fees.borrowingRate | borrowing rate} will never decay below.
- *
- * @remarks
- * Note that the borrowing rate can still be lower than this during recovery mode, when it's
- * overridden by zero.
- *
- * @public
- */
-export declare const MINIMUM_BORROWING_RATE: Decimal;
-/**
- * Value that the {@link Fees.borrowingRate | borrowing rate} will never exceed.
- *
- * @public
- */
-export declare const MAXIMUM_BORROWING_RATE: Decimal;
-/**
- * Value that the {@link Fees.redemptionRate | redemption rate} will never decay below.
- *
- * @public
- */
-export declare const MINIMUM_REDEMPTION_RATE: Decimal;
+import { Decimal } from "./Decimal";
+/**
+ * Total collateral ratio below which recovery mode is triggered.
+ *
+ * @public
+ */
+export declare const CRITICAL_COLLATERAL_RATIO: Decimal;
+/**
+ * Collateral ratio below which a Trove can be liquidated in normal mode.
+ *
+ * @public
+ */
+export declare const MINIMUM_COLLATERAL_RATIO: Decimal;
+/**
+ * Amount of ZUSD that's reserved for compensating the liquidator of a Trove.
+ *
+ * @public
+ */
+export declare const ZUSD_LIQUIDATION_RESERVE: Decimal;
+/**
+ * A Trove must always have at least this much debt on top of the
+ * {@link ZUSD_LIQUIDATION_RESERVE | liquidation reserve}.
+ *
+ * @remarks
+ * Any transaction that would result in a Trove with less net debt than this will be reverted.
+ *
+ * @public
+ */
+export declare const ZUSD_MINIMUM_NET_DEBT: Decimal;
+/**
+ * A Trove must always have at least this much debt.
+ *
+ * @remarks
+ * Any transaction that would result in a Trove with less debt than this will be reverted.
+ *
+ * @public
+ */
+export declare const ZUSD_MINIMUM_DEBT: Decimal;
+/**
+ * Value that the {@link Fees.borrowingRate | borrowing rate} will never decay below.
+ *
+ * @remarks
+ * Note that the borrowing rate can still be lower than this during recovery mode, when it's
+ * overridden by zero.
+ *
+ * @public
+ */
+export declare const MINIMUM_BORROWING_RATE: Decimal;
+/**
+ * Value that the {@link Fees.borrowingRate | borrowing rate} will never exceed.
+ *
+ * @public
+ */
+export declare const MAXIMUM_BORROWING_RATE: Decimal;
+/**
+ * Value that the {@link Fees.redemptionRate | redemption rate} will never decay below.
+ *
+ * @public
+ */
+export declare const MINIMUM_REDEMPTION_RATE: Decimal;
 //# sourceMappingURL=constants.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC;;;;GAIG;AACH,eAAO,MAAM,yBAAyB,SAAoB,CAAC;AAE3D;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,SAAoB,CAAC;AAE1D;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,SAAmB,CAAC;AAEzD;;;;;;;;GAQG;AACH,eAAO,MAAM,qBAAqB,SAAoB,CAAC;AAEvD;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB,SAAsD,CAAC;AAErF;;;;;;;;GAQG;AACH,eAAO,MAAM,sBAAsB,SAAqB,CAAC;AAEzD;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,SAAsB,CAAC;AAE1D;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,SAAsB,CAAC"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC;;;;GAIG;AACH,eAAO,MAAM,yBAAyB,SAAoB,CAAC;AAE3D;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,SAAoB,CAAC;AAE1D;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,SAAmB,CAAC;AAEzD;;;;;;;;GAQG;AACH,eAAO,MAAM,qBAAqB,SAAoB,CAAC;AAEvD;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB,SAAsD,CAAC;AAErF;;;;;;;;GAQG;AACH,eAAO,MAAM,sBAAsB,SAAqB,CAAC;AAEzD;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,SAAsB,CAAC;AAE1D;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,SAAqB,CAAC"}

package/dist/src/constants.js

@@ -1,64 +1,64 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MINIMUM_REDEMPTION_RATE = exports.MAXIMUM_BORROWING_RATE = exports.MINIMUM_BORROWING_RATE = exports.ZUSD_MINIMUM_DEBT = exports.ZUSD_MINIMUM_NET_DEBT = exports.ZUSD_LIQUIDATION_RESERVE = exports.MINIMUM_COLLATERAL_RATIO = exports.CRITICAL_COLLATERAL_RATIO = void 0;
-const Decimal_1 = require("./Decimal");
-/**
- * Total collateral ratio below which recovery mode is triggered.
- *
- * @public
- */
-exports.CRITICAL_COLLATERAL_RATIO = Decimal_1.Decimal.from(1.5);
-/**
- * Collateral ratio below which a Trove can be liquidated in normal mode.
- *
- * @public
- */
-exports.MINIMUM_COLLATERAL_RATIO = Decimal_1.Decimal.from(1.1);
-/**
- * Amount of ZUSD that's reserved for compensating the liquidator of a Trove.
- *
- * @public
- */
-exports.ZUSD_LIQUIDATION_RESERVE = Decimal_1.Decimal.from(20);
-/**
- * A Trove must always have at least this much debt on top of the
- * {@link ZUSD_LIQUIDATION_RESERVE | liquidation reserve}.
- *
- * @remarks
- * Any transaction that would result in a Trove with less net debt than this will be reverted.
- *
- * @public
- */
-exports.ZUSD_MINIMUM_NET_DEBT = Decimal_1.Decimal.from(180);
-/**
- * A Trove must always have at least this much debt.
- *
- * @remarks
- * Any transaction that would result in a Trove with less debt than this will be reverted.
- *
- * @public
- */
-exports.ZUSD_MINIMUM_DEBT = exports.ZUSD_LIQUIDATION_RESERVE.add(exports.ZUSD_MINIMUM_NET_DEBT);
-/**
- * Value that the {@link Fees.borrowingRate | borrowing rate} will never decay below.
- *
- * @remarks
- * Note that the borrowing rate can still be lower than this during recovery mode, when it's
- * overridden by zero.
- *
- * @public
- */
-exports.MINIMUM_BORROWING_RATE = Decimal_1.Decimal.from(0.05);
-/**
- * Value that the {@link Fees.borrowingRate | borrowing rate} will never exceed.
- *
- * @public
- */
-exports.MAXIMUM_BORROWING_RATE = Decimal_1.Decimal.from(0.075);
-/**
- * Value that the {@link Fees.redemptionRate | redemption rate} will never decay below.
- *
- * @public
- */
-exports.MINIMUM_REDEMPTION_RATE = Decimal_1.Decimal.from(0.019);
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MINIMUM_REDEMPTION_RATE = exports.MAXIMUM_BORROWING_RATE = exports.MINIMUM_BORROWING_RATE = exports.ZUSD_MINIMUM_DEBT = exports.ZUSD_MINIMUM_NET_DEBT = exports.ZUSD_LIQUIDATION_RESERVE = exports.MINIMUM_COLLATERAL_RATIO = exports.CRITICAL_COLLATERAL_RATIO = void 0;
+const Decimal_1 = require("./Decimal");
+/**
+ * Total collateral ratio below which recovery mode is triggered.
+ *
+ * @public
+ */
+exports.CRITICAL_COLLATERAL_RATIO = Decimal_1.Decimal.from(1.5);
+/**
+ * Collateral ratio below which a Trove can be liquidated in normal mode.
+ *
+ * @public
+ */
+exports.MINIMUM_COLLATERAL_RATIO = Decimal_1.Decimal.from(1.1);
+/**
+ * Amount of ZUSD that's reserved for compensating the liquidator of a Trove.
+ *
+ * @public
+ */
+exports.ZUSD_LIQUIDATION_RESERVE = Decimal_1.Decimal.from(20);
+/**
+ * A Trove must always have at least this much debt on top of the
+ * {@link ZUSD_LIQUIDATION_RESERVE | liquidation reserve}.
+ *
+ * @remarks
+ * Any transaction that would result in a Trove with less net debt than this will be reverted.
+ *
+ * @public
+ */
+exports.ZUSD_MINIMUM_NET_DEBT = Decimal_1.Decimal.from(180);
+/**
+ * A Trove must always have at least this much debt.
+ *
+ * @remarks
+ * Any transaction that would result in a Trove with less debt than this will be reverted.
+ *
+ * @public
+ */
+exports.ZUSD_MINIMUM_DEBT = exports.ZUSD_LIQUIDATION_RESERVE.add(exports.ZUSD_MINIMUM_NET_DEBT);
+/**
+ * Value that the {@link Fees.borrowingRate | borrowing rate} will never decay below.
+ *
+ * @remarks
+ * Note that the borrowing rate can still be lower than this during recovery mode, when it's
+ * overridden by zero.
+ *
+ * @public
+ */
+exports.MINIMUM_BORROWING_RATE = Decimal_1.Decimal.from(0.05);
+/**
+ * Value that the {@link Fees.borrowingRate | borrowing rate} will never exceed.
+ *
+ * @public
+ */
+exports.MAXIMUM_BORROWING_RATE = Decimal_1.Decimal.from(0.075);
+/**
+ * Value that the {@link Fees.redemptionRate | redemption rate} will never decay below.
+ *
+ * @public
+ */
+exports.MINIMUM_REDEMPTION_RATE = Decimal_1.Decimal.from(0.01);
 //# sourceMappingURL=constants.js.map

package/dist/src/constants.js.map

@@ -1 +1 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":";;;AAAA,uCAAoC;AAEpC;;;;GAIG;AACU,QAAA,yBAAyB,GAAG,iBAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAE3D;;;;GAIG;AACU,QAAA,wBAAwB,GAAG,iBAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAE1D;;;;GAIG;AACU,QAAA,wBAAwB,GAAG,iBAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AAEzD;;;;;;;;GAQG;AACU,QAAA,qBAAqB,GAAG,iBAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAEvD;;;;;;;GAOG;AACU,QAAA,iBAAiB,GAAG,gCAAwB,CAAC,GAAG,CAAC,6BAAqB,CAAC,CAAC;AAErF;;;;;;;;GAQG;AACU,QAAA,sBAAsB,GAAG,iBAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAEzD;;;;GAIG;AACU,QAAA,sBAAsB,GAAG,iBAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAE1D;;;;GAIG;AACU,QAAA,uBAAuB,GAAG,iBAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC"}
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":";;;AAAA,uCAAoC;AAEpC;;;;GAIG;AACU,QAAA,yBAAyB,GAAG,iBAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAE3D;;;;GAIG;AACU,QAAA,wBAAwB,GAAG,iBAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAE1D;;;;GAIG;AACU,QAAA,wBAAwB,GAAG,iBAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AAEzD;;;;;;;;GAQG;AACU,QAAA,qBAAqB,GAAG,iBAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAEvD;;;;;;;GAOG;AACU,QAAA,iBAAiB,GAAG,gCAAwB,CAAC,GAAG,CAAC,6BAAqB,CAAC,CAAC;AAErF;;;;;;;;GAQG;AACU,QAAA,sBAAsB,GAAG,iBAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAEzD;;;;GAIG;AACU,QAAA,sBAAsB,GAAG,iBAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAE1D;;;;GAIG;AACU,QAAA,uBAAuB,GAAG,iBAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC"}

package/etc/lib-base.api.md

@@ -18,8 +18,6 @@ export class _CachedReadableLiquity<T extends unknown[]> implements _ReadableLiq
     // (undocumented)
     getPrice(...extraParams: T): Promise<Decimal>;
     // (undocumented)
-    getRemainingStabilityPoolZEROReward(...extraParams: T): Promise<Decimal>;
-    // (undocumented)
     getStabilityDeposit(address?: string, ...extraParams: T): Promise<StabilityDeposit>;
     // (undocumented)
     getTotal(...extraParams: T): Promise<Trove>;
@@ -255,7 +253,6 @@ export interface LiquityStoreBaseState {
     numberOfTroves: number;
     ownFrontend: FrontendStatus;
     price: Decimal;
-    remainingStabilityPoolZEROReward: Decimal;
     // @internal (undocumented)
     _riskiestTroveBeforeRedistribution: TroveWithPendingRedistribution;
     stabilityDeposit: StabilityDeposit;
@@ -428,7 +425,6 @@ export interface ReadableLiquity {
     getFrontendStatus(address?: string): Promise<FrontendStatus>;
     getNumberOfTroves(): Promise<number>;
     getPrice(): Promise<Decimal>;
-    getRemainingStabilityPoolZEROReward(): Promise<Decimal>;
     getStabilityDeposit(address?: string): Promise<StabilityDeposit>;
     getTotal(): Promise<Trove>;
     getTotalRedistributed(): Promise<Trove>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sovryn-zero/lib-base",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "Sovryn Zero SDK shared interfaces",
   "keywords": [
     "Sovryn",

package/src/LiquityStore.ts

@@ -72,9 +72,6 @@ export interface LiquityStoreBaseState {
   /** User's stability deposit. */
   stabilityDeposit: StabilityDeposit;
 
-  /** Remaining ZERO that will be collectively rewarded to stability depositors. */
-  remainingStabilityPoolZEROReward: Decimal;
-
   /** @internal */
   _feesInNormalMode: Fees;
 
@@ -397,12 +394,6 @@ export abstract class LiquityStore<T = unknown> {
         baseStateUpdate.stabilityDeposit
       ),
 
-      remainingStabilityPoolZEROReward: this._silentlyUpdateIfChanged(
-        eq,
-        baseState.remainingStabilityPoolZEROReward,
-        baseStateUpdate.remainingStabilityPoolZEROReward
-      ),
-
       _feesInNormalMode: this._silentlyUpdateIfChanged(
         equals,
         baseState._feesInNormalMode,

package/src/ReadableLiquity.ts

@@ -101,11 +101,6 @@ export interface ReadableLiquity {
    */
   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.
    */

package/src/_CachedReadableLiquity.ts

@@ -101,13 +101,6 @@ export class _CachedReadableLiquity<T extends unknown[]>
     );
   }
 
-  async getRemainingStabilityPoolZEROReward(...extraParams: T): Promise<Decimal> {
-    return (
-      this._cache.getRemainingStabilityPoolZEROReward(...extraParams) ??
-      this._readable.getRemainingStabilityPoolZEROReward(...extraParams)
-    );
-  }
-
   async getZUSDInStabilityPool(...extraParams: T): Promise<Decimal> {
     return (
       this._cache.getZUSDInStabilityPool(...extraParams) ??

package/src/constants.ts

@@ -65,4 +65,4 @@ export const MAXIMUM_BORROWING_RATE = Decimal.from(0.075);
  *
  * @public
  */
-export const MINIMUM_REDEMPTION_RATE = Decimal.from(0.019);
+export const MINIMUM_REDEMPTION_RATE = Decimal.from(0.01);