Fuzz final 4.0.0

.github/workflows/tests.yml

@@ -183,7 +183,7 @@ jobs:
           restore-keys: |
             hardhat-network-fork-${{ runner.os }}-
             hardhat-network-fork-
-      - run: npx hardhat test ./test/plugins/individual-collateral/{aave-v3,compoundv3,curve/cvx}/*.test.ts
+      - run: npx hardhat test ./test/plugins/individual-collateral/{aave-v3,compoundv3,curve/cvx,mountain}/*.test.ts
         env:
           NODE_OPTIONS: '--max-old-space-size=32768'
           TS_NODE_SKIP_IGNORE: true
@@ -314,3 +314,17 @@ jobs:
           FORK_NETWORK: mainnet
           FORK: 1
           PROTO_IMPL: 1
+
+  registry-tests:
+    name: 'Registry Tests'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+          cache: 'yarn'
+      - run: yarn install --immutable
+      - run: yarn test:registries
+        env:
+          NODE_OPTIONS: '--max-old-space-size=32768'

CHANGELOG.md

@@ -4,40 +4,67 @@
 
 This release prepares the core protocol for veRSR through the introduction of 3 registries (`DAOFeeRegistry`, `AssetPluginRegistry`, and `VersionRegistry`) and through restricting component upgrades to be handled by `Main`, where upgrade constraints can be enforced.
 
-The release also expands collateral decimal support from 18 to 27.
+The release also expands collateral decimal support from 18 to 21, with some caveats about minimum token value. See [docs/solidity-style.md](./docs/solidity-style.md#Collateral-decimals) for more details.
+
+Finally, it adds resistance to toxic issuance by charging more when the collateral is under peg.
 
 ## Upgrade Steps
 
-TODO
+Upgrade to 4.0.0 is expected to occur by spell. This section is still TODO, but some important notes for steps that should be hit:
 
-Make sure distributor table sums to >10000.
+- Distributor table must sum to >=10000
+- Opt RTokens into the issuance premium by default
+- Upgrade all collateral plugins and RTokenAsset
+- ...
 
 ## Core Protocol Contracts
 
+All components: make Main the only component that can call `upgradeTo()`
+
 - `AssetRegistry`
   - Prevent registering assets that are not in the `AssetPluginRegistry`
   - Add `validateCurrentAssets() view`
-- `Broker`
-  - Make setters only callable by `Main`
+- `BackingManager`
+  - Switch from sizing trades using the low price to the high price
+- `BasketHandler`
+  - Add `issuancePremium() view returns (uint192)`
+  - Add `setIssuancePremiumEnabled(bool)`, callable by governance. Begins disabled by default for upgraded RTokens
+  - Add `quote(uint192 amount, bool applyIssuancePremium, RoundingMode rounding)`
+  - Modify `quote(uint192 amount, RoundingMode rounding)` to include the issuance premium
+  - Add `price(bool applyIssuancePremium)`
+  - Modify `price()` to include the issuance premium
+  - Remove `lotPrice()`
+  - Minor changes to require error strings
+- `Deployer`
+  - Add `enableIssuancePremium` parameter to `IDeployer.DeploymentParams`
 - `Distributor`
   - Add `setDistributions()` function to parallel `setDistribution()`
-  - Take DAO fee out account in `distribute()` and `totals()`
+  - Take DAO fee into account in `distribute()` and `totals()`
   - Add new revenue share table invariant: must sum to >=10000 (for precision reasons)
 - `Main`
   - Add `versionRegistry()`/`assetPluginRegistry()`/`daoFeeRegistry()` getters
   - Add `setVersionRegistry()`/`setAssetPluginRegistry()`/`setDaoFeeRegistry()` setters
   - Add `upgradeMainTo()` + `upgradeRTokenTo()` functions to handle upgrade of Main + Components
   - Make Main the only caller that can upgrade Main
+- `RevenueTrader`
+  - Switch from sizing trades using the low price to the high price
 
 ## Plugins
 
 ### Assets
 
-No functional change. FLOOR rounding added explicitly to `shiftl_toFix`
+- Support expanded from 18 to 21 decimals, with minimum collateral token value requirement of `$0.001` at-peg.
+- FLOOR rounding added explicitly to `shiftl_toFix` everywhere
+
+#### Collateral
+
+Add `savedPegPrice` to `ICollateral` interface
 
 ### Trading
 
-Small bugfix to `GnosisTrade`. Should prevent donated tokens from causing the trade to revert.
+- `GnosisTrade`
+  - Change units of `worstCasePrice()` from {buyTok/sellTok} to {qBuyTok/qSellTok}
+  - Small fix to prevent donated tokens from being able to cause the trade to revert
 
 ### Facades
 

common/blockchain-utils.ts

@@ -23,13 +23,13 @@ export const getChainId = async (hre: HardhatRuntimeEnvironment): Promise<string
     switch (useEnv('FORK_NETWORK').toLowerCase()) {
       case 'mainnet':
         _chainId = '1'
-        break;
+        break
       case 'base':
         _chainId = '8453'
-        break;
+        break
       case 'arbitrum':
         _chainId = '42161'
-        break;
+        break
     }
   }
   return _chainId

common/configuration.ts

@@ -104,6 +104,10 @@ export interface ITokens {
   bbUSDT?: string
   steakPYUSD?: string
   Re7WETH?: string
+
+  // Mountain
+  USDM?: string
+  wUSDM?: string
 }
 
 export type ITokensKeys = Array<keyof ITokens>
@@ -541,6 +545,8 @@ export const networkConfig: { [key: string]: INetworkConfig } = {
       saArbUSDCn: '', // TODO our wrapper. remove from deployment script after placing here
       aArbUSDT: '0x6ab707aca953edaefbc4fd23ba73294241490620',
       saArbUSDT: '', // TODO our wrapper. remove from deployment script after placing here
+      USDM: '0x59d9356e565ab3a36dd77763fc0d87feaf85508c',
+      wUSDM: '0x57f5e098cad7a3d1eed53991d4d66c45c9af7812',
     },
     chainlinkFeeds: {
       ARB: '0xb2A824043730FE05F3DA2efaFa1CBbe83fa548D6',
@@ -550,6 +556,7 @@ export const networkConfig: { [key: string]: INetworkConfig } = {
       USDT: '0x3f3f5dF88dC9F13eac63DF89EC16ef6e7E25DdE7',
       RSR: '0xcfF9349ec6d027f20fC9360117fef4a1Ad38B488',
       crvUSD: '0x0a32255dd4BB6177C994bAAc73E0606fDD568f66',
+      wUSDM: '0xdC6720c996Fad27256c7fd6E0a271e2A4687eF18',
     },
     GNOSIS_EASY_AUCTION: '0xcD033976a011F41D2AB6ef47984041568F818E73', // our deployment
     COMET_REWARDS: '0x88730d254A2f7e6AC8388c3198aFd694bA9f7fae',
@@ -592,6 +599,7 @@ export interface IConfig {
   withdrawalLeak: BigNumber
   warmupPeriod: BigNumber
   reweightable: boolean
+  enableIssuancePremium: boolean
   tradingDelay: BigNumber
   batchAuctionLength: BigNumber
   dutchAuctionLength: BigNumber

contracts/facade/facets/MaxIssuableFacet.sol

@@ -5,6 +5,7 @@ import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 import "../../interfaces/IBasketHandler.sol";
 import "../../interfaces/IRToken.sol";
 import "../../libraries/Fixed.sol";
+import "../../p1/BasketHandler.sol";
 
 /**
  * @title MaxIssuableFacet
@@ -21,7 +22,8 @@ contract MaxIssuableFacet {
     /// @return {qRTok} How many RToken `account` can issue given current holdings
     /// @custom:static-call
     function maxIssuable(IRToken rToken, address account) external returns (uint256) {
-        (address[] memory erc20s, ) = rToken.main().basketHandler().quote(FIX_ONE, FLOOR);
+        BasketHandlerP1 bh = BasketHandlerP1(address(rToken.main().basketHandler()));
+        (address[] memory erc20s, ) = bh.quote(FIX_ONE, FLOOR);
         uint256[] memory balances = new uint256[](erc20s.length);
         for (uint256 i = 0; i < erc20s.length; ++i) {
             balances[i] = IERC20(erc20s[i]).balanceOf(account);
@@ -45,7 +47,7 @@ contract MaxIssuableFacet {
         main.assetRegistry().refresh();
 
         // Get basket ERC20s
-        IBasketHandler bh = main.basketHandler();
+        BasketHandlerP1 bh = BasketHandlerP1(address(main.basketHandler()));
         (address[] memory erc20s, uint256[] memory quantities) = bh.quote(FIX_ONE, CEIL);
 
         // Compute how many baskets we can mint with the collateral amounts

contracts/facade/facets/ReadFacet.sol

@@ -45,7 +45,7 @@ contract ReadFacet {
 
         // Cache components
         IRToken rTok = rToken;
-        IBasketHandler bh = main.basketHandler();
+        BasketHandlerP1 bh = BasketHandlerP1(address(main.basketHandler()));
         IAssetRegistry reg = main.assetRegistry();
 
         // Poke Main
@@ -69,9 +69,7 @@ contract ReadFacet {
             uint192 mid = (low + high) / 2;
 
             // {UoA} = {tok} * {UoA/Tok}
-            depositsUoA[i] = shiftl_toFix(deposits[i], -int8(asset.erc20Decimals()), FLOOR).mul(
-                mid
-            );
+            depositsUoA[i] = shiftl_toFix(deposits[i], -int8(asset.erc20Decimals()), CEIL).mul(mid);
         }
     }
 
@@ -93,7 +91,7 @@ contract ReadFacet {
 
         // Cache Components
         IRToken rTok = rToken;
-        IBasketHandler bh = main.basketHandler();
+        BasketHandlerP1 bh = BasketHandlerP1(address(main.basketHandler()));
 
         // Poke Main
         main.assetRegistry().refresh();
@@ -175,7 +173,7 @@ contract ReadFacet {
     {
         uint256[] memory deposits;
         IAssetRegistry assetRegistry = rToken.main().assetRegistry();
-        IBasketHandler basketHandler = rToken.main().basketHandler();
+        BasketHandlerP1 basketHandler = BasketHandlerP1(address(rToken.main().basketHandler()));
 
         // solhint-disable-next-line no-empty-blocks
         try rToken.main().furnace().melt() {} catch {} // <3.1.0 RTokens may revert while frozen
@@ -301,7 +299,8 @@ contract ReadFacet {
 
     /// @return tokens The ERC20s backing the RToken
     function basketTokens(IRToken rToken) external view returns (address[] memory tokens) {
-        (tokens, ) = rToken.main().basketHandler().quote(FIX_ONE, RoundingMode.FLOOR);
+        BasketHandlerP1 bh = BasketHandlerP1(address(rToken.main().basketHandler()));
+        (tokens, ) = bh.quote(FIX_ONE, RoundingMode.FLOOR);
     }
 
     /// Returns the backup configuration for a given targetName
@@ -337,10 +336,11 @@ contract ReadFacet {
         uint192 uoaNeeded; // {UoA}
         uint192 uoaHeldInBaskets; // {UoA}
         {
-            (address[] memory basketERC20s, uint256[] memory quantities) = rToken
-            .main()
-            .basketHandler()
-            .quote(basketsNeeded, FLOOR);
+            BasketHandlerP1 bh = BasketHandlerP1(address(rToken.main().basketHandler()));
+            (address[] memory basketERC20s, uint256[] memory quantities) = bh.quote(
+                basketsNeeded,
+                FLOOR
+            );
 
             IAssetRegistry reg = rToken.main().assetRegistry();
             IBackingManager bm = rToken.main().backingManager();

contracts/fuzz/CollateralMock.sol

@@ -123,56 +123,40 @@ contract CollateralMock is OracleErrorMock, AppreciatingFiatCollateral {
     }
 }
 
+// DEPRECATED
 // A CollateralMock that does not use decaying lotPrice()s, but instead just returns the last saved
 // value. Needed for DiffTest, because refresh() doesn't always happen in the same block on both P0
 // and P1.
-contract CollateralNoDecay is CollateralMock {
-    function lotPrice()
-        external
-        view
-        virtual
-        override(Asset, IAsset)
-        returns (uint192 lotLow, uint192 lotHigh)
-    {
-        try this.tryPrice() returns (uint192 low, uint192 high, uint192) {
-            // if the price feed is still functioning, use that
-            return (low, high);
-        } catch (bytes memory errData) {
-            // see: docs/solidity-style.md#Catching-Empty-Data
-            if (errData.length == 0) revert(); // solhint-disable-line reason-string
-            return (savedLowPrice, savedHighPrice);
-        }
-    }
-
-    constructor(
-        // Collateral base-class arguments
-        IERC20Metadata erc20_,
-        uint192 maxTradeVolume_,
-        uint48 priceTimeout_,
-        uint192 oracleError_,
-        uint192 defaultThreshold_,
-        uint48 delayUntilDefault_,
-        bytes32 targetName_,
-        // Price Models
-        PriceModel memory refPerTokModel_, // Ref units per token
-        PriceModel memory targetPerRefModel_, // Target units per ref unit
-        PriceModel memory uoaPerTargetModel_, // Units-of-account per target unit
-        PriceModel memory deviationModel_,
-        uint192 revenueHiding
-    )
-        CollateralMock(
-            erc20_,
-            maxTradeVolume_,
-            priceTimeout_,
-            oracleError_,
-            defaultThreshold_,
-            delayUntilDefault_,
-            targetName_,
-            refPerTokModel_,
-            targetPerRefModel_,
-            uoaPerTargetModel_,
-            deviationModel_,
-            revenueHiding
-        )
-    {}
-}
+// contract CollateralNoDecay is CollateralMock {
+//     constructor(
+//         // Collateral base-class arguments
+//         IERC20Metadata erc20_,
+//         uint192 maxTradeVolume_,
+//         uint48 priceTimeout_,
+//         uint192 oracleError_,
+//         uint192 defaultThreshold_,
+//         uint48 delayUntilDefault_,
+//         bytes32 targetName_,
+//         // Price Models
+//         PriceModel memory refPerTokModel_, // Ref units per token
+//         PriceModel memory targetPerRefModel_, // Target units per ref unit
+//         PriceModel memory uoaPerTargetModel_, // Units-of-account per target unit
+//         PriceModel memory deviationModel_,
+//         uint192 revenueHiding
+//     )
+//         CollateralMock(
+//             erc20_,
+//             maxTradeVolume_,
+//             priceTimeout_,
+//             oracleError_,
+//             defaultThreshold_,
+//             delayUntilDefault_,
+//             targetName_,
+//             refPerTokModel_,
+//             targetPerRefModel_,
+//             uoaPerTargetModel_,
+//             deviationModel_,
+//             revenueHiding
+//         )
+//     {}
+// }

contracts/fuzz/FuzzP0.sol

@@ -129,7 +129,7 @@ contract RTokenP0Fuzz is IRTokenFuzz, RTokenP0 {
             ? basketsNeeded.muluDivu(amount, totalSupply()) // {BU * qRTok / qRTok}
             : uint192(amount); // {qRTok / qRTok}
 
-        return main.basketHandler().quote(baskets, roundingMode);
+        return main.basketHandler().quote(baskets, true, roundingMode);
     }
 
     function _msgSender() internal view virtual override returns (address) {

contracts/fuzz/FuzzP1.sol

@@ -467,7 +467,7 @@ contract RTokenP1Fuzz is IRTokenFuzz, RTokenP1 {
             ? basketsNeeded.muluDivu(amount, totalSupply()) // {BU * qRTok / qRTok}
             : uint192(amount); // {qRTok / qRTok}
 
-        return main.basketHandler().quote(baskets, roundingMode);
+        return main.basketHandler().quote(baskets, true, roundingMode);
     }
 
     function _msgSender() internal view virtual override returns (address) {

contracts/fuzz/MainP0.sol

@@ -208,7 +208,7 @@ contract MainP0Fuzz is IMainFuzz, MainP0 {
             params.minTradeVolume
         );
 
-        basketHandler.init(this, params.warmupPeriod, params.reweightable);
+        basketHandler.init(this, params.warmupPeriod, params.reweightable, params.enableIssuancePremium);
         rsrTrader.init(this, rsr, params.maxTradeSlippage, params.minTradeVolume);
         rTokenTrader.init(
             this,

contracts/fuzz/MainP1.sol

@@ -212,7 +212,7 @@ contract MainP1Fuzz is IMainFuzz, MainP1 {
             params.minTradeVolume
         );
 
-        basketHandler.init(this, params.warmupPeriod, params.reweightable);
+        basketHandler.init(this, params.warmupPeriod, params.reweightable, params.enableIssuancePremium);
         rsrTrader.init(this, rsr, params.maxTradeSlippage, params.minTradeVolume);
         rTokenTrader.init(
             this,

contracts/fuzz/Utils.sol

@@ -30,7 +30,8 @@ function defaultParams() pure returns (DeploymentParams memory params) {
         issuanceThrottle: tParams,
         redemptionThrottle: tParams,
         warmupPeriod: 259200,
-        reweightable: false
+        reweightable: false,
+        enableIssuancePremium: true
     });
 }
 

contracts/fuzz/scenarios/ChaosOps.sol

@@ -937,6 +937,10 @@ contract ChaosOpsScenario {
         main.setLongFreeze(freeze);
     }
 
+    function setIssuancePremiumEnabled(uint256 seed) public {
+        BasketHandlerP1(address(main.basketHandler())).setIssuancePremiumEnabled((seed % 2) == 0);
+    }
+
     // Grant/Revoke Roles
     function grantRole(uint8 which, uint8 userID) public {
         address user = main.someAddr(userID);