@sovryn-zero/lib-base 0.1.0 → 0.2.1

package/dist/src/Fees.d.ts

@@ -1,82 +1,82 @@
-import { Decimal, Decimalish } from "./Decimal";
-/**
- * Calculator for fees.
- *
- * @remarks
- * Returned by the {@link ReadableLiquity.getFees | getFees()} function.
- *
- * @public
- */
-export declare class Fees {
-    private readonly _baseRateWithoutDecay;
-    private readonly _minuteDecayFactor;
-    private readonly _beta;
-    private readonly _lastFeeOperation;
-    private readonly _timeOfLatestBlock;
-    private readonly _recoveryMode;
-    /** @internal */
-    constructor(baseRateWithoutDecay: Decimalish, minuteDecayFactor: Decimalish, beta: Decimalish, lastFeeOperation: Date, timeOfLatestBlock: Date, recoveryMode: boolean);
-    /** @internal */
-    _setRecoveryMode(recoveryMode: boolean): Fees;
-    /**
-     * Compare to another instance of `Fees`.
-     */
-    equals(that: Fees): boolean;
-    /** @internal */
-    toString(): string;
-    /** @internal */
-    baseRate(when?: Date): Decimal;
-    /**
-     * Calculate the current borrowing rate.
-     *
-     * @param when - Optional timestamp that can be used to calculate what the borrowing rate would
-     *               decay to at a point of time in the future.
-     *
-     * @remarks
-     * By default, the fee is calculated at the time of the latest block. This can be overridden using
-     * the `when` parameter.
-     *
-     * To calculate the borrowing fee in ZUSD, multiply the borrowed ZUSD amount by the borrowing rate.
-     *
-     * @example
-     * ```typescript
-     * const fees = await zero.getFees();
-     *
-     * const borrowedZUSDAmount = 100;
-     * const borrowingRate = fees.borrowingRate();
-     * const borrowingFeeZUSD = borrowingRate.mul(borrowedZUSDAmount);
-     * ```
-     */
-    borrowingRate(when?: Date): Decimal;
-    /**
-     * Calculate the current redemption rate.
-     *
-     * @param redeemedFractionOfSupply - The amount of ZUSD being redeemed divided by the total supply.
-     * @param when - Optional timestamp that can be used to calculate what the redemption rate would
-     *               decay to at a point of time in the future.
-     *
-     * @remarks
-     * By default, the fee is calculated at the time of the latest block. This can be overridden using
-     * the `when` parameter.
-  
-     * Unlike the borrowing rate, the redemption rate depends on the amount being redeemed. To be more
-     * precise, it depends on the fraction of the redeemed amount compared to the total ZUSD supply,
-     * which must be passed as a parameter.
-     *
-     * To calculate the redemption fee in ZUSD, multiply the redeemed ZUSD amount with the redemption
-     * rate.
-     *
-     * @example
-     * ```typescript
-     * const fees = await zero.getFees();
-     * const total = await zero.getTotal();
-     *
-     * const redeemedZUSDAmount = Decimal.from(100);
-     * const redeemedFractionOfSupply = redeemedZUSDAmount.div(total.debt);
-     * const redemptionRate = fees.redemptionRate(redeemedFractionOfSupply);
-     * const redemptionFeeZUSD = redemptionRate.mul(redeemedZUSDAmount);
-     * ```
-     */
-    redemptionRate(redeemedFractionOfSupply?: Decimalish, when?: Date): Decimal;
-}
+import { Decimal, Decimalish } from "./Decimal";
+/**
+ * Calculator for fees.
+ *
+ * @remarks
+ * Returned by the {@link ReadableLiquity.getFees | getFees()} function.
+ *
+ * @public
+ */
+export declare class Fees {
+    private readonly _baseRateWithoutDecay;
+    private readonly _minuteDecayFactor;
+    private readonly _beta;
+    private readonly _lastFeeOperation;
+    private readonly _timeOfLatestBlock;
+    private readonly _recoveryMode;
+    /** @internal */
+    constructor(baseRateWithoutDecay: Decimalish, minuteDecayFactor: Decimalish, beta: Decimalish, lastFeeOperation: Date, timeOfLatestBlock: Date, recoveryMode: boolean);
+    /** @internal */
+    _setRecoveryMode(recoveryMode: boolean): Fees;
+    /**
+     * Compare to another instance of `Fees`.
+     */
+    equals(that: Fees): boolean;
+    /** @internal */
+    toString(): string;
+    /** @internal */
+    baseRate(when?: Date): Decimal;
+    /**
+     * Calculate the current borrowing rate.
+     *
+     * @param when - Optional timestamp that can be used to calculate what the borrowing rate would
+     *               decay to at a point of time in the future.
+     *
+     * @remarks
+     * By default, the fee is calculated at the time of the latest block. This can be overridden using
+     * the `when` parameter.
+     *
+     * To calculate the borrowing fee in ZUSD, multiply the borrowed ZUSD amount by the borrowing rate.
+     *
+     * @example
+     * ```typescript
+     * const fees = await zero.getFees();
+     *
+     * const borrowedZUSDAmount = 100;
+     * const borrowingRate = fees.borrowingRate();
+     * const borrowingFeeZUSD = borrowingRate.mul(borrowedZUSDAmount);
+     * ```
+     */
+    borrowingRate(when?: Date): Decimal;
+    /**
+     * Calculate the current redemption rate.
+     *
+     * @param redeemedFractionOfSupply - The amount of ZUSD being redeemed divided by the total supply.
+     * @param when - Optional timestamp that can be used to calculate what the redemption rate would
+     *               decay to at a point of time in the future.
+     *
+     * @remarks
+     * By default, the fee is calculated at the time of the latest block. This can be overridden using
+     * the `when` parameter.
+  
+     * Unlike the borrowing rate, the redemption rate depends on the amount being redeemed. To be more
+     * precise, it depends on the fraction of the redeemed amount compared to the total ZUSD supply,
+     * which must be passed as a parameter.
+     *
+     * To calculate the redemption fee in ZUSD, multiply the redeemed ZUSD amount with the redemption
+     * rate.
+     *
+     * @example
+     * ```typescript
+     * const fees = await zero.getFees();
+     * const total = await zero.getTotal();
+     *
+     * const redeemedZUSDAmount = Decimal.from(100);
+     * const redeemedFractionOfSupply = redeemedZUSDAmount.div(total.debt);
+     * const redemptionRate = fees.redemptionRate(redeemedFractionOfSupply);
+     * const redemptionFeeZUSD = redemptionRate.mul(redeemedZUSDAmount);
+     * ```
+     */
+    redemptionRate(redeemedFractionOfSupply?: Decimalish, when?: Date): Decimal;
+}
 //# sourceMappingURL=Fees.d.ts.map

package/dist/src/Fees.js

@@ -1,123 +1,123 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Fees = void 0;
-const assert_1 = __importDefault(require("assert"));
-const Decimal_1 = require("./Decimal");
-const constants_1 = require("./constants");
-/**
- * Calculator for fees.
- *
- * @remarks
- * Returned by the {@link ReadableLiquity.getFees | getFees()} function.
- *
- * @public
- */
-class Fees {
-    /** @internal */
-    constructor(baseRateWithoutDecay, minuteDecayFactor, beta, lastFeeOperation, timeOfLatestBlock, recoveryMode) {
-        this._baseRateWithoutDecay = Decimal_1.Decimal.from(baseRateWithoutDecay);
-        this._minuteDecayFactor = Decimal_1.Decimal.from(minuteDecayFactor);
-        this._beta = Decimal_1.Decimal.from(beta);
-        this._lastFeeOperation = lastFeeOperation;
-        this._timeOfLatestBlock = timeOfLatestBlock;
-        this._recoveryMode = recoveryMode;
-        assert_1.default(this._minuteDecayFactor.lt(1));
-    }
-    /** @internal */
-    _setRecoveryMode(recoveryMode) {
-        return new Fees(this._baseRateWithoutDecay, this._minuteDecayFactor, this._beta, this._lastFeeOperation, this._timeOfLatestBlock, recoveryMode);
-    }
-    /**
-     * Compare to another instance of `Fees`.
-     */
-    equals(that) {
-        return (this._baseRateWithoutDecay.eq(that._baseRateWithoutDecay) &&
-            this._minuteDecayFactor.eq(that._minuteDecayFactor) &&
-            this._beta.eq(that._beta) &&
-            this._lastFeeOperation.getTime() === that._lastFeeOperation.getTime() &&
-            this._timeOfLatestBlock.getTime() === that._timeOfLatestBlock.getTime() &&
-            this._recoveryMode === that._recoveryMode);
-    }
-    /** @internal */
-    toString() {
-        return (`{ baseRateWithoutDecay: ${this._baseRateWithoutDecay}` +
-            `, lastFeeOperation: "${this._lastFeeOperation.toLocaleString()}"` +
-            `, recoveryMode: ${this._recoveryMode} } `);
-    }
-    /** @internal */
-    baseRate(when = this._timeOfLatestBlock) {
-        const millisecondsSinceLastFeeOperation = Math.max(when.getTime() - this._lastFeeOperation.getTime(), 0 // Clamp negative elapsed time to 0, in case the client's time is in the past.
-        // We will calculate slightly higher than actual fees, which is fine.
-        );
-        const minutesSinceLastFeeOperation = Math.floor(millisecondsSinceLastFeeOperation / 60000);
-        return this._minuteDecayFactor.pow(minutesSinceLastFeeOperation).mul(this._baseRateWithoutDecay);
-    }
-    /**
-     * Calculate the current borrowing rate.
-     *
-     * @param when - Optional timestamp that can be used to calculate what the borrowing rate would
-     *               decay to at a point of time in the future.
-     *
-     * @remarks
-     * By default, the fee is calculated at the time of the latest block. This can be overridden using
-     * the `when` parameter.
-     *
-     * To calculate the borrowing fee in ZUSD, multiply the borrowed ZUSD amount by the borrowing rate.
-     *
-     * @example
-     * ```typescript
-     * const fees = await zero.getFees();
-     *
-     * const borrowedZUSDAmount = 100;
-     * const borrowingRate = fees.borrowingRate();
-     * const borrowingFeeZUSD = borrowingRate.mul(borrowedZUSDAmount);
-     * ```
-     */
-    borrowingRate(when) {
-        return this._recoveryMode
-            ? Decimal_1.Decimal.ZERO
-            : Decimal_1.Decimal.min(constants_1.MINIMUM_BORROWING_RATE.add(this.baseRate(when)), constants_1.MAXIMUM_BORROWING_RATE);
-    }
-    /**
-     * Calculate the current redemption rate.
-     *
-     * @param redeemedFractionOfSupply - The amount of ZUSD being redeemed divided by the total supply.
-     * @param when - Optional timestamp that can be used to calculate what the redemption rate would
-     *               decay to at a point of time in the future.
-     *
-     * @remarks
-     * By default, the fee is calculated at the time of the latest block. This can be overridden using
-     * the `when` parameter.
-  
-     * Unlike the borrowing rate, the redemption rate depends on the amount being redeemed. To be more
-     * precise, it depends on the fraction of the redeemed amount compared to the total ZUSD supply,
-     * which must be passed as a parameter.
-     *
-     * To calculate the redemption fee in ZUSD, multiply the redeemed ZUSD amount with the redemption
-     * rate.
-     *
-     * @example
-     * ```typescript
-     * const fees = await zero.getFees();
-     * const total = await zero.getTotal();
-     *
-     * const redeemedZUSDAmount = Decimal.from(100);
-     * const redeemedFractionOfSupply = redeemedZUSDAmount.div(total.debt);
-     * const redemptionRate = fees.redemptionRate(redeemedFractionOfSupply);
-     * const redemptionFeeZUSD = redemptionRate.mul(redeemedZUSDAmount);
-     * ```
-     */
-    redemptionRate(redeemedFractionOfSupply = Decimal_1.Decimal.ZERO, when) {
-        redeemedFractionOfSupply = Decimal_1.Decimal.from(redeemedFractionOfSupply);
-        let baseRate = this.baseRate(when);
-        if (redeemedFractionOfSupply.nonZero) {
-            baseRate = redeemedFractionOfSupply.div(this._beta).add(baseRate);
-        }
-        return Decimal_1.Decimal.min(constants_1.MINIMUM_REDEMPTION_RATE.add(baseRate), Decimal_1.Decimal.ONE);
-    }
-}
-exports.Fees = Fees;
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Fees = void 0;
+const assert_1 = __importDefault(require("assert"));
+const Decimal_1 = require("./Decimal");
+const constants_1 = require("./constants");
+/**
+ * Calculator for fees.
+ *
+ * @remarks
+ * Returned by the {@link ReadableLiquity.getFees | getFees()} function.
+ *
+ * @public
+ */
+class Fees {
+    /** @internal */
+    constructor(baseRateWithoutDecay, minuteDecayFactor, beta, lastFeeOperation, timeOfLatestBlock, recoveryMode) {
+        this._baseRateWithoutDecay = Decimal_1.Decimal.from(baseRateWithoutDecay);
+        this._minuteDecayFactor = Decimal_1.Decimal.from(minuteDecayFactor);
+        this._beta = Decimal_1.Decimal.from(beta);
+        this._lastFeeOperation = lastFeeOperation;
+        this._timeOfLatestBlock = timeOfLatestBlock;
+        this._recoveryMode = recoveryMode;
+        assert_1.default(this._minuteDecayFactor.lt(1));
+    }
+    /** @internal */
+    _setRecoveryMode(recoveryMode) {
+        return new Fees(this._baseRateWithoutDecay, this._minuteDecayFactor, this._beta, this._lastFeeOperation, this._timeOfLatestBlock, recoveryMode);
+    }
+    /**
+     * Compare to another instance of `Fees`.
+     */
+    equals(that) {
+        return (this._baseRateWithoutDecay.eq(that._baseRateWithoutDecay) &&
+            this._minuteDecayFactor.eq(that._minuteDecayFactor) &&
+            this._beta.eq(that._beta) &&
+            this._lastFeeOperation.getTime() === that._lastFeeOperation.getTime() &&
+            this._timeOfLatestBlock.getTime() === that._timeOfLatestBlock.getTime() &&
+            this._recoveryMode === that._recoveryMode);
+    }
+    /** @internal */
+    toString() {
+        return (`{ baseRateWithoutDecay: ${this._baseRateWithoutDecay}` +
+            `, lastFeeOperation: "${this._lastFeeOperation.toLocaleString()}"` +
+            `, recoveryMode: ${this._recoveryMode} } `);
+    }
+    /** @internal */
+    baseRate(when = this._timeOfLatestBlock) {
+        const millisecondsSinceLastFeeOperation = Math.max(when.getTime() - this._lastFeeOperation.getTime(), 0 // Clamp negative elapsed time to 0, in case the client's time is in the past.
+        // We will calculate slightly higher than actual fees, which is fine.
+        );
+        const minutesSinceLastFeeOperation = Math.floor(millisecondsSinceLastFeeOperation / 60000);
+        return this._minuteDecayFactor.pow(minutesSinceLastFeeOperation).mul(this._baseRateWithoutDecay);
+    }
+    /**
+     * Calculate the current borrowing rate.
+     *
+     * @param when - Optional timestamp that can be used to calculate what the borrowing rate would
+     *               decay to at a point of time in the future.
+     *
+     * @remarks
+     * By default, the fee is calculated at the time of the latest block. This can be overridden using
+     * the `when` parameter.
+     *
+     * To calculate the borrowing fee in ZUSD, multiply the borrowed ZUSD amount by the borrowing rate.
+     *
+     * @example
+     * ```typescript
+     * const fees = await zero.getFees();
+     *
+     * const borrowedZUSDAmount = 100;
+     * const borrowingRate = fees.borrowingRate();
+     * const borrowingFeeZUSD = borrowingRate.mul(borrowedZUSDAmount);
+     * ```
+     */
+    borrowingRate(when) {
+        return this._recoveryMode
+            ? Decimal_1.Decimal.ZERO
+            : Decimal_1.Decimal.min(constants_1.MINIMUM_BORROWING_RATE.add(this.baseRate(when)), constants_1.MAXIMUM_BORROWING_RATE);
+    }
+    /**
+     * Calculate the current redemption rate.
+     *
+     * @param redeemedFractionOfSupply - The amount of ZUSD being redeemed divided by the total supply.
+     * @param when - Optional timestamp that can be used to calculate what the redemption rate would
+     *               decay to at a point of time in the future.
+     *
+     * @remarks
+     * By default, the fee is calculated at the time of the latest block. This can be overridden using
+     * the `when` parameter.
+  
+     * Unlike the borrowing rate, the redemption rate depends on the amount being redeemed. To be more
+     * precise, it depends on the fraction of the redeemed amount compared to the total ZUSD supply,
+     * which must be passed as a parameter.
+     *
+     * To calculate the redemption fee in ZUSD, multiply the redeemed ZUSD amount with the redemption
+     * rate.
+     *
+     * @example
+     * ```typescript
+     * const fees = await zero.getFees();
+     * const total = await zero.getTotal();
+     *
+     * const redeemedZUSDAmount = Decimal.from(100);
+     * const redeemedFractionOfSupply = redeemedZUSDAmount.div(total.debt);
+     * const redemptionRate = fees.redemptionRate(redeemedFractionOfSupply);
+     * const redemptionFeeZUSD = redemptionRate.mul(redeemedZUSDAmount);
+     * ```
+     */
+    redemptionRate(redeemedFractionOfSupply = Decimal_1.Decimal.ZERO, when) {
+        redeemedFractionOfSupply = Decimal_1.Decimal.from(redeemedFractionOfSupply);
+        let baseRate = this.baseRate(when);
+        if (redeemedFractionOfSupply.nonZero) {
+            baseRate = redeemedFractionOfSupply.div(this._beta).add(baseRate);
+        }
+        return Decimal_1.Decimal.min(constants_1.MINIMUM_REDEMPTION_RATE.add(baseRate), Decimal_1.Decimal.ONE);
+    }
+}
+exports.Fees = Fees;
 //# sourceMappingURL=Fees.js.map