@sovryn-zero/lib-base 0.1.0

package/dist/src/_CachedReadableLiquity.js

@@ -0,0 +1,93 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports._CachedReadableLiquity = void 0;
+/** @internal */
+class _CachedReadableLiquity {
+    constructor(readable, cache) {
+        this._readable = readable;
+        this._cache = cache;
+    }
+    async getTotalRedistributed(...extraParams) {
+        var _a;
+        return ((_a = this._cache.getTotalRedistributed(...extraParams)) !== null && _a !== void 0 ? _a : this._readable.getTotalRedistributed(...extraParams));
+    }
+    async getTroveBeforeRedistribution(address, ...extraParams) {
+        var _a;
+        return ((_a = this._cache.getTroveBeforeRedistribution(address, ...extraParams)) !== null && _a !== void 0 ? _a : this._readable.getTroveBeforeRedistribution(address, ...extraParams));
+    }
+    async getTrove(address, ...extraParams) {
+        const [troveBeforeRedistribution, totalRedistributed] = await Promise.all([
+            this.getTroveBeforeRedistribution(address, ...extraParams),
+            this.getTotalRedistributed(...extraParams)
+        ]);
+        return troveBeforeRedistribution.applyRedistribution(totalRedistributed);
+    }
+    async getNumberOfTroves(...extraParams) {
+        var _a;
+        return ((_a = this._cache.getNumberOfTroves(...extraParams)) !== null && _a !== void 0 ? _a : this._readable.getNumberOfTroves(...extraParams));
+    }
+    async getPrice(...extraParams) {
+        var _a;
+        return (_a = this._cache.getPrice(...extraParams)) !== null && _a !== void 0 ? _a : this._readable.getPrice(...extraParams);
+    }
+    async getTotal(...extraParams) {
+        var _a;
+        return (_a = this._cache.getTotal(...extraParams)) !== null && _a !== void 0 ? _a : this._readable.getTotal(...extraParams);
+    }
+    async getStabilityDeposit(address, ...extraParams) {
+        var _a;
+        return ((_a = this._cache.getStabilityDeposit(address, ...extraParams)) !== null && _a !== void 0 ? _a : this._readable.getStabilityDeposit(address, ...extraParams));
+    }
+    async getRemainingStabilityPoolZEROReward(...extraParams) {
+        var _a;
+        return ((_a = this._cache.getRemainingStabilityPoolZEROReward(...extraParams)) !== null && _a !== void 0 ? _a : this._readable.getRemainingStabilityPoolZEROReward(...extraParams));
+    }
+    async getZUSDInStabilityPool(...extraParams) {
+        var _a;
+        return ((_a = this._cache.getZUSDInStabilityPool(...extraParams)) !== null && _a !== void 0 ? _a : this._readable.getZUSDInStabilityPool(...extraParams));
+    }
+    async getZUSDBalance(address, ...extraParams) {
+        var _a;
+        return ((_a = this._cache.getZUSDBalance(address, ...extraParams)) !== null && _a !== void 0 ? _a : this._readable.getZUSDBalance(address, ...extraParams));
+    }
+    async getZEROBalance(address, ...extraParams) {
+        var _a;
+        return ((_a = this._cache.getZEROBalance(address, ...extraParams)) !== null && _a !== void 0 ? _a : this._readable.getZEROBalance(address, ...extraParams));
+    }
+    async getCollateralSurplusBalance(address, ...extraParams) {
+        var _a;
+        return ((_a = this._cache.getCollateralSurplusBalance(address, ...extraParams)) !== null && _a !== void 0 ? _a : this._readable.getCollateralSurplusBalance(address, ...extraParams));
+    }
+    async getTroves(params, ...extraParams) {
+        var _a;
+        const { beforeRedistribution, ...restOfParams } = params;
+        const [totalRedistributed, troves] = await Promise.all([
+            beforeRedistribution ? undefined : this.getTotalRedistributed(...extraParams),
+            (_a = this._cache.getTroves({ beforeRedistribution: true, ...restOfParams }, ...extraParams)) !== null && _a !== void 0 ? _a : this._readable.getTroves({ beforeRedistribution: true, ...restOfParams }, ...extraParams)
+        ]);
+        if (totalRedistributed) {
+            return troves.map(trove => trove.applyRedistribution(totalRedistributed));
+        }
+        else {
+            return troves;
+        }
+    }
+    async getFees(...extraParams) {
+        var _a;
+        return (_a = this._cache.getFees(...extraParams)) !== null && _a !== void 0 ? _a : this._readable.getFees(...extraParams);
+    }
+    async getZEROStake(address, ...extraParams) {
+        var _a;
+        return ((_a = this._cache.getZEROStake(address, ...extraParams)) !== null && _a !== void 0 ? _a : this._readable.getZEROStake(address, ...extraParams));
+    }
+    async getTotalStakedZERO(...extraParams) {
+        var _a;
+        return ((_a = this._cache.getTotalStakedZERO(...extraParams)) !== null && _a !== void 0 ? _a : this._readable.getTotalStakedZERO(...extraParams));
+    }
+    async getFrontendStatus(address, ...extraParams) {
+        var _a;
+        return ((_a = this._cache.getFrontendStatus(address, ...extraParams)) !== null && _a !== void 0 ? _a : this._readable.getFrontendStatus(address, ...extraParams));
+    }
+}
+exports._CachedReadableLiquity = _CachedReadableLiquity;
+//# sourceMappingURL=_CachedReadableLiquity.js.map

package/dist/src/_CachedReadableLiquity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_CachedReadableLiquity.js","sourceRoot":"","sources":["../../src/_CachedReadableLiquity.ts"],"names":[],"mappings":";;;AA4CA,gBAAgB;AAChB,MAAa,sBAAsB;IAKjC,YAAY,QAA4C,EAAE,KAA2B;QACnF,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAED,KAAK,CAAC,qBAAqB,CAAC,GAAG,WAAc;;QAC3C,OAAO,OACL,IAAI,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,WAAW,CAAC,mCACjD,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAAC,GAAG,WAAW,CAAC,CACrD,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,4BAA4B,CAChC,OAAgB,EAChB,GAAG,WAAc;;QAEjB,OAAO,OACL,IAAI,CAAC,MAAM,CAAC,4BAA4B,CAAC,OAAO,EAAE,GAAG,WAAW,CAAC,mCACjE,IAAI,CAAC,SAAS,CAAC,4BAA4B,CAAC,OAAO,EAAE,GAAG,WAAW,CAAC,CACrE,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,OAAgB,EAAE,GAAG,WAAc;QAChD,MAAM,CAAC,yBAAyB,EAAE,kBAAkB,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YACxE,IAAI,CAAC,4BAA4B,CAAC,OAAO,EAAE,GAAG,WAAW,CAAC;YAC1D,IAAI,CAAC,qBAAqB,CAAC,GAAG,WAAW,CAAC;SAC3C,CAAC,CAAC;QAEH,OAAO,yBAAyB,CAAC,mBAAmB,CAAC,kBAAkB,CAAC,CAAC;IAC3E,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAC,GAAG,WAAc;;QACvC,OAAO,OACL,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,GAAG,WAAW,CAAC,mCAC7C,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC,GAAG,WAAW,CAAC,CACjD,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,GAAG,WAAc;;QAC9B,aAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,WAAW,CAAC,mCAAI,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,WAAW,CAAC,CAAC;IACzF,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,GAAG,WAAc;;QAC9B,aAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,WAAW,CAAC,mCAAI,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,WAAW,CAAC,CAAC;IACzF,CAAC;IAED,KAAK,CAAC,mBAAmB,CAAC,OAAgB,EAAE,GAAG,WAAc;;QAC3D,OAAO,OACL,IAAI,CAAC,MAAM,CAAC,mBAAmB,CAAC,OAAO,EAAE,GAAG,WAAW,CAAC,mCACxD,IAAI,CAAC,SAAS,CAAC,mBAAmB,CAAC,OAAO,EAAE,GAAG,WAAW,CAAC,CAC5D,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,mCAAmC,CAAC,GAAG,WAAc;;QACzD,OAAO,OACL,IAAI,CAAC,MAAM,CAAC,mCAAmC,CAAC,GAAG,WAAW,CAAC,mCAC/D,IAAI,CAAC,SAAS,CAAC,mCAAmC,CAAC,GAAG,WAAW,CAAC,CACnE,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,sBAAsB,CAAC,GAAG,WAAc;;QAC5C,OAAO,OACL,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,GAAG,WAAW,CAAC,mCAClD,IAAI,CAAC,SAAS,CAAC,sBAAsB,CAAC,GAAG,WAAW,CAAC,CACtD,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,OAAgB,EAAE,GAAG,WAAc;;QACtD,OAAO,OACL,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE,GAAG,WAAW,CAAC,mCACnD,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,OAAO,EAAE,GAAG,WAAW,CAAC,CACvD,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,OAAgB,EAAE,GAAG,WAAc;;QACtD,OAAO,OACL,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE,GAAG,WAAW,CAAC,mCACnD,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,OAAO,EAAE,GAAG,WAAW,CAAC,CACvD,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,2BAA2B,CAAC,OAAgB,EAAE,GAAG,WAAc;;QACnE,OAAO,OACL,IAAI,CAAC,MAAM,CAAC,2BAA2B,CAAC,OAAO,EAAE,GAAG,WAAW,CAAC,mCAChE,IAAI,CAAC,SAAS,CAAC,2BAA2B,CAAC,OAAO,EAAE,GAAG,WAAW,CAAC,CACpE,CAAC;IACJ,CAAC;IASD,KAAK,CAAC,SAAS,CAAC,MAA0B,EAAE,GAAG,WAAc;;QAC3D,MAAM,EAAE,oBAAoB,EAAE,GAAG,YAAY,EAAE,GAAG,MAAM,CAAC;QAEzD,MAAM,CAAC,kBAAkB,EAAE,MAAM,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YACrD,oBAAoB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,GAAG,WAAW,CAAC;kBAC7E,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,oBAAoB,EAAE,IAAI,EAAE,GAAG,YAAY,EAAE,EAAE,GAAG,WAAW,CAAC,mCACpF,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,oBAAoB,EAAE,IAAI,EAAE,GAAG,YAAY,EAAE,EAAE,GAAG,WAAW,CAAC;SAC5F,CAAC,CAAC;QAEH,IAAI,kBAAkB,EAAE;YACtB,OAAO,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,mBAAmB,CAAC,kBAAkB,CAAC,CAAC,CAAC;SAC3E;aAAM;YACL,OAAO,MAAM,CAAC;SACf;IACH,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,GAAG,WAAc;;QAC7B,aAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,WAAW,CAAC,mCAAI,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,WAAW,CAAC,CAAC;IACvF,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,OAAgB,EAAE,GAAG,WAAc;;QACpD,OAAO,OACL,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,OAAO,EAAE,GAAG,WAAW,CAAC,mCACjD,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,OAAO,EAAE,GAAG,WAAW,CAAC,CACrD,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,GAAG,WAAc;;QACxC,OAAO,OACL,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,GAAG,WAAW,CAAC,mCAC9C,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,GAAG,WAAW,CAAC,CAClD,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAC,OAAgB,EAAE,GAAG,WAAc;;QACzD,OAAO,OACL,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,OAAO,EAAE,GAAG,WAAW,CAAC,mCACtD,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC,OAAO,EAAE,GAAG,WAAW,CAAC,CAC1D,CAAC;IACJ,CAAC;CACF;AA5ID,wDA4IC"}

package/dist/src/constants.d.ts

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

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

@@ -0,0 +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,SAAsB,CAAC;AAE1D;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,SAAqB,CAAC;AAEzD;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,SAAsB,CAAC"}

package/dist/src/constants.js

@@ -0,0 +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.025);
+/**
+ * Value that the {@link Fees.borrowingRate | borrowing rate} will never exceed.
+ *
+ * @public
+ */
+exports.MAXIMUM_BORROWING_RATE = Decimal_1.Decimal.from(0.05);
+/**
+ * Value that the {@link Fees.redemptionRate | redemption rate} will never decay below.
+ *
+ * @public
+ */
+exports.MINIMUM_REDEMPTION_RATE = Decimal_1.Decimal.from(0.025);
+//# sourceMappingURL=constants.js.map

package/dist/src/constants.js.map

@@ -0,0 +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,KAAK,CAAC,CAAC;AAE1D;;;;GAIG;AACU,QAAA,sBAAsB,GAAG,iBAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAEzD;;;;GAIG;AACU,QAAA,uBAAuB,GAAG,iBAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC"}

package/dist/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.13.2"
+    }
+  ]
+}