updating state mocks, incorperating dollar amount in euclidian distance calcs, starting adding tests for new state/setter/getter functions

Author: cinquemb

protocol/contracts/dao/Auction.sol

@@ -70,7 +70,9 @@ contract Auction is Comptroller {
             uint256 minMaturity = getCouponAuctionMinMaturity();
             uint256 maxMaturity = getCouponAuctionMaxMaturity();
             uint256 minYield = getCouponAuctionMinYield();
-            uint256 maxYield = getCouponAuctionMaxYield();            
+            uint256 maxYield = getCouponAuctionMaxYield(); 
+            uint256 minDollarAmount = getCouponAuctionMinDollarAmount();
+            uint256 maxDollarAmount = getCouponAuctionMinDollarAmount();            
 
             // loop over bids and compute distance
             for (uint256 i = 0; i < getCouponAuctionBids(); i++) {
@@ -86,11 +88,16 @@ contract Auction is Comptroller {
                 uint256 maturityRel = couponMaturityEpoch.div(
                     maxMaturity.sub(minMaturity)
                 );
+                uint256 dollarRelMax = dollarAmount.div(
+                    maxDollarAmount.sub(minDollarAmount)
+                );
+                uint256 dollarRel = Decimal.one().sub(dollarRelMax).asUint256();
 
                 uint256 yieldRelSquared = Decimal.zero().add(yieldRel).pow(2).asUint256();
                 uint256 maturityRelSquared = Decimal.zero().add(maturityRel).pow(2).asUint256();
+                uint256 dollarRelSquared = Decimal.zero().add(dollarRel).pow(2).asUint256();
 
-                uint256 sumSquared = yieldRelSquared.add(maturityRelSquared);
+                uint256 sumSquared = yieldRelSquared.add(maturityRelSquared).add(dollarRelSquared);
                 uint256 distance = sqrt(sumSquared);
                 getCouponBidderState(getCouponBidderStateIndex(i)).distance = distance;
                 bids.push(getCouponBidderState(getCouponBidderStateIndex(i)));

protocol/contracts/dao/Getters.sol

@@ -239,6 +239,14 @@ contract Getters is State {
         return _state.epochs[epoch()].auction.maxYield;
     }
 
+    function getCouponAuctionMinDollarAmount() internal view returns (uint256) {
+        return _state.epochs[epoch()].auction.minDollarAmount;
+    }
+
+    function getCouponAuctionMaxDollarAmount() internal view returns (uint256) {
+        return _state.epochs[epoch()].auction.maxDollarAmount;
+    }
+
     /**
      * Governance
      */

protocol/contracts/dao/Market.sol

@@ -146,6 +146,7 @@ contract Market is Comptroller, Curve {
 
         uint256 epoch = epoch().add(couponEpochExpiry);
         setCouponAuctionRelYield(maxCouponAmount.div(dollarAmount));
+        setCouponAuctionRelDollarAmount(dollarAmount);
         setCouponAuctionRelMaturity(epoch);
         setCouponBidderState(msg.sender, epoch, dollarAmount, maxCouponAmount);
         setCouponBidderStateIndex(getCouponAuctionBids(), msg.sender);

protocol/contracts/dao/Setters.sol

@@ -156,6 +156,8 @@ contract Setters is State, Getters {
         _state.epochs[epoch()].auction.maxMaturity = 0;
         _state.epochs[epoch()].auction.minYield = 1000000000000000000000000;
         _state.epochs[epoch()].auction.maxYield = 0;
+        _state.epochs[epoch()].auction.minDollarAmount = 1000000000000000000000000;
+        _state.epochs[epoch()].auction.maxDollarAmount = 0;
     }
 
     function cancelCouponAuctionAtEpoch(uint256 epoch) internal {
@@ -198,13 +200,22 @@ contract Setters is State, Getters {
             _state.epochs[epoch()].auction.minYield = yield;
         }
     }
+    
     function setCouponAuctionRelMaturity(uint256 couponEpochExpiry) internal {
         if (couponEpochExpiry > _state.epochs[epoch()].auction.maxMaturity) {
             _state.epochs[epoch()].auction.maxMaturity = couponEpochExpiry;
         } else if (couponEpochExpiry < _state.epochs[epoch()].auction.minMaturity) {
             _state.epochs[epoch()].auction.minMaturity = couponEpochExpiry;
         }
     }
+
+    function setCouponAuctionRelDollarAmount(uint256 couponDollarAmount) internal {
+        if (couponDollarAmount > _state.epochs[epoch()].auction.maxDollarAmount) {
+            _state.epochs[epoch()].auction.maxDollarAmount = couponDollarAmount;
+        } else if (couponDollarAmount < _state.epochs[epoch()].auction.minDollarAmount) {
+            _state.epochs[epoch()].auction.minDollarAmount = couponDollarAmount;
+        }
+    }
 
 
     /**

protocol/contracts/dao/State.sol

@@ -69,6 +69,8 @@ contract Epoch {
         uint256 maxMaturity;
         uint256 minYield;
         uint256 maxYield;
+        uint256 minDollarAmount;
+        uint256 maxDollarAmount;
         uint256 _totalBids;
         mapping(uint256 => address) couponBidder;
         mapping(address => CouponBidderState) couponBidderState;

protocol/contracts/mock/MockState.sol

@@ -119,6 +119,49 @@ contract MockState is Setters {
        super.eliminateOutstandingCoupons(epoch);
     }
 
+    function initCouponAuctionE(address auction) external  {
+        super.initCouponAuction(auction);
+    }
+
+    function cancelCouponAuctionAtEpochE(uint256 epoch) external {
+        super.cancelCouponAuctionAtEpoch(epoch);
+    }
+
+    function finishCouponAuctionAtEpochE(uint256 epoch) external {
+        super.finishCouponAuctionAtEpoch(epoch);
+    }
+
+    function setCouponBidderStateE(address bidder, uint256 couponEpochExpiry, uint256 dollarAmount, uint256 maxCouponAmount) external {
+        super.setCouponBidderState(bidder, couponEpochExpiry, dollarAmount, maxCouponAmount);
+    }
+
+    function setCouponBidderStateSelectedE(address bidder) external {
+        super.setCouponBidderStateSelected(bidder);
+    }
+
+    function setCouponBidderStateRejectedE(address bidder) external {
+        super.setCouponBidderStateRejected(bidder);
+    }
+
+    function setCouponBidderStateIndexE(uint256 index, address bidder) external {
+        super.setCouponBidderStateIndex(index, bidder);
+    }
+
+    function incrementCouponAuctionBidsE() external {
+        super.incrementCouponAuctionBids();
+    }
+
+    function setCouponAuctionRelYieldE(uint256 yield) external {
+        super.setCouponAuctionRelYield(yield);
+    }
+    function setCouponAuctionRelMaturityE(uint256 couponEpochExpiry) external {
+        super.setCouponAuctionRelMaturity(couponEpochExpiry);
+    }
+
+    function setCouponAuctionRelDollarAmountE(uint256 couponDollarAmount) external {
+        super.setCouponAuctionRelDollarAmount(couponDollarAmount);
+    }
+
     /**
      * Governance
      */

protocol/test/dao/State.test.js

@@ -750,6 +750,51 @@ describe('State', function () {
     });
   });
 
+  
+  describe('initCouponAuction', function () {
+    describe('when called', function () {
+      beforeEach('call', async function () {
+        // need to create mock auction object and pass into this
+        await this.setters.initCouponAuctionE(1);
+      });
+
+      it('has auction set', async function () {
+        // need to check that auction address exists, non zero and has all the other states initializd properly
+        expect(await this.setters.getCouponAuctionAtEpoch(1)).to.be.bignumber.equal(new BN(91));
+      });
+    });
+  });
+
+  describe('cancelCouponAuctionAtEpoch', function () {
+  });
+
+  describe('finishCouponAuctionAtEpoch', function () {
+  });
+
+  describe('setCouponBidderState', function () {
+  });
+
+  describe('setCouponBidderStateSelected', function () {
+  });
+
+  describe('setCouponBidderStateRejected', function () {
+  });
+
+  describe('setCouponBidderStateIndex', function () {
+  });
+
+  describe('incrementCouponAuctionBids', function () {
+  });
+
+  describe('setCouponAuctionRelYield', function () {
+  });
+
+  describe('setCouponAuctionRelMaturity', function () {
+  });
+
+  describe('setCouponAuctionRelDollarAmount', function () {
+  });
+
   /**
    * Governance
    */