@reserve-protocol/dtf-rebalance-lib 0.2.15 → 0.2.17

package/dist/open-auction.d.ts

@@ -51,13 +51,13 @@ export declare const getTargetBasket: (_initialWeights: WeightRange[], _prices:
  *
  * Non-AUCTION_LAUNCHERs should use `folio.openAuctionUnrestricted()`
  *
- * @param rebalance The result of calling folio.getRebalance()
+ * @param rebalance The result of calling folio.getRebalance(), today
  * @param _supply {share} The totalSupply() of the basket, today
  * @param _initialFolio D18{tok/share} Initial balances per share, e.g result of folio.toAssets(1e18, 0) at time rebalance was first proposed
  * @param _targetBasket D18{1} Result of calling `getTargetBasket()`
- * @param _folio D18{tok/share} Current ratio of token per share, e.g result of folio.toAssets(1e18, 0)
+ * @param _folio D18{tok/share} Current ratio of token per share, e.g result of folio.toAssets(1e18, 0), today
  * @param _decimals Decimals of each token
- * @param _prices {USD/wholeTok} USD prices for each *whole* token
+ * @param _prices {USD/wholeTok} USD prices for each *whole* token, today
  * @param _priceError {1} Price error to use for each token during auction pricing; should be smaller than price error during startRebalance
  * @param _finalStageAt {1} The % rebalanced from the initial Folio to determine when is the final stage of the rebalance
  */

package/dist/open-auction.js

@@ -23,6 +23,7 @@ var AuctionRound;
  * @returns D18{1} The target basket
  */
 const getTargetBasket = (_initialWeights, _prices, _decimals) => {
+    console.log("getTargetBasket", _initialWeights, _prices, _decimals);
     if (_initialWeights.length != _prices.length) {
         throw new Error("length mismatch");
     }
@@ -45,13 +46,13 @@ exports.getTargetBasket = getTargetBasket;
  *
  * Non-AUCTION_LAUNCHERs should use `folio.openAuctionUnrestricted()`
  *
- * @param rebalance The result of calling folio.getRebalance()
+ * @param rebalance The result of calling folio.getRebalance(), today
  * @param _supply {share} The totalSupply() of the basket, today
  * @param _initialFolio D18{tok/share} Initial balances per share, e.g result of folio.toAssets(1e18, 0) at time rebalance was first proposed
  * @param _targetBasket D18{1} Result of calling `getTargetBasket()`
- * @param _folio D18{tok/share} Current ratio of token per share, e.g result of folio.toAssets(1e18, 0)
+ * @param _folio D18{tok/share} Current ratio of token per share, e.g result of folio.toAssets(1e18, 0), today
  * @param _decimals Decimals of each token
- * @param _prices {USD/wholeTok} USD prices for each *whole* token
+ * @param _prices {USD/wholeTok} USD prices for each *whole* token, today
  * @param _priceError {1} Price error to use for each token during auction pricing; should be smaller than price error during startRebalance
  * @param _finalStageAt {1} The % rebalanced from the initial Folio to determine when is the final stage of the rebalance
  */
@@ -149,7 +150,7 @@ const getOpenAuction = (rebalance, _supply, _initialFolio = [], _targetBasket =
     // calculate progressions
     // {wholeBU/wholeShare} = D18{BU/share} / D18
     const prevSpotLimit = new utils_1.Decimal(rebalance.limits.spot.toString()).div(numbers_1.D18d);
-    // {wholeTok/wholeBU} = {wholeTok/wholeBU} * {wholeBU/wholeShare}
+    // {wholeTok/wholeShare} = {wholeTok/wholeBU} * {wholeBU/wholeShare}
     const expectedBalances = weightRanges.map((weightRange) => weightRange.spot.mul(prevSpotLimit));
     // {1} = {USD/wholeShare} / {USD/wholeShare}
     let progression = folio
@@ -167,8 +168,7 @@ const getOpenAuction = (rebalance, _supply, _initialFolio = [], _targetBasket =
     // {1} = {USD/wholeShare} / {USD/wholeShare}
     const initialProgression = initialFolio
         .map((initialBalance, i) => {
-        // make sure to include tokens that were already ejected
-        if (!rebalance.inRebalance[i] && rebalance.weights[i].spot > 0n) {
+        if (!rebalance.inRebalance[i]) {
             return numbers_1.ZERO;
         }
         // {wholeTok/wholeShare}
@@ -182,7 +182,7 @@ const getOpenAuction = (rebalance, _supply, _initialFolio = [], _targetBasket =
         if (debug) {
             console.log("progression < initialProgression", progression.toString(), initialProgression.toString());
         }
-        progression = initialProgression; // don't go backwards
+        progression = initialProgression; // don't go backwards, should only happen due to negligible rounding errors
     }
     // {1} = {1} / {1}
     let relativeProgression = initialProgression.eq(numbers_1.ONE)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reserve-protocol/dtf-rebalance-lib",
-  "version": "0.2.15",
+  "version": "0.2.17",
   "description": "Rebalancing library for DTFs in typescript",
   "main": "dist/index.js",
   "module": "dist/index.js",