ionicprotocol · rhlsthrm · Dec 4, 2024 · Dec 4, 2024 · Dec 6, 2024 · Dec 6, 2024
diff --git a/README.md b/README.md
@@ -16,16 +16,24 @@ If you already pulled using just `git clone`, you can use below command to updat
 
 ### Dependencies
 
-- Node [`16.x`](https://nodejs.org/en/download/)
-- Yarn (preinstalled with Node 16)
+- Node [`22.x`](https://nodejs.org/en/download/)
+- Yarn (preinstalled with Node 22)
 - [Foundry](https://book.getfoundry.sh/getting-started/installation.html)
 
 From fresh clone:
 
 - `yarn`
-- `yarn workspace @ionicprotocol/sdk forge install`
+- `yarn workspace @ionicprotocol/contracts hardhat compile`
 - `yarn workspace @ionicprotocol/sdk build`
 
+## Running the UI
+
+After installing the dependencies, run:
+
+- `yarn dev:ui`
+
+Now load the UI at `http://localhost:3000`.
+
 ## Tips
 
 Run _everything_ from the top level.
@@ -34,12 +42,12 @@ Ask for **.env** file from the team and add it under packages/sdk
 
 If you want to add packages to modules, you can do so like:
 
-- `yarn workspace @ionicprotocol/sdk add ethers`
+- `yarn workspace @ionicprotocol/sdk add viem`
 
-To run `forge` commands inside the `sdk` package, run:
+To run `forge` commands inside the `contracts` package, run:
 
-- `yarn workspace @ionicprotocol/sdk forge install <SOME_DEP>`
-- `yarn workspace @ionicprotocol/sdk forge build`
+- `yarn workspace @ionicprotocol/contracts forge install <SOME_DEP>`
+- `yarn workspace @ionicprotocol/contracts forge build`
 - etc
 
 ## Adding a Package
@@ -70,116 +78,4 @@ To run `forge` commands inside the `sdk` package, run:
   }
 }
 - `yarn` from top-level to update dependencies/symlinks.
-```
-
-## Working with Forks
-
-Forking requires access to a archive RPC node. For BSC we had a great experience using an RPC Node from NodeReals MegaNode service - https://nodereal.io/meganode .
-
-For forking Polygon we haven't found a free service to use an archive node yet.
-
-You general purpose forking you have to set `FORK_RPC_URL` and `FORK_CHAIN_ID` in your `packages/sdk/.env` file.
-
-And than start a forked local node by running.
-
-```
-> yarn dev:node:fork
-```
-
-In order to start multiple forks at once we streamlined the process a bit. In your executing shell make sure to set `BSC_RPC_URL` and or `POLYGON_RPC_URL`.
-
-```
-> yarn dev:node:bsc
-// Will start a CHAIN_ID=56 fork using $BSC_RPC_URL at https://localhost:8545
-```
-
-```
-> yarn dev:node:polygon
-// Will start a CHAIN_ID=137 fork using $POLYGON_RPC_URL at https://localhost:8546
-```
-
-The idea is to increase the port number with each fork we want to support.
-
-```
-8545: BSC
-8546: Polygon
-8547: Moonbeam?
-```
-
-For convenience we have a Hardhat task to make some token swaps to on the forked node for you.
-
-```
-> yarn workspace @ionicprotocol/sdk hardhat fork:fund-accounts --network fork
-// Works with https://localhost:8545
-
-> yarn workspace @ionicprotocol/sdk hardhat fork:fund-accounts --network localbsc
-// Works with https://localhost:8545
-
-> yarn workspace @ionicprotocol/sdk hardhat fork:fund-accounts --network localpolygon
-// Works with https://localhost:8546
-```
-
-## Running UI Tests
-
-We are using [ChainSafe/dappeteer](https://github.com/ChainSafe/dappeteer) to test our UI with Metamask. The test are expecting to work on a fork of BSC mainnet for now.
-
-Follow this step to run the UI test locally
-
-1. Start local forked BSC node
-
-```
-> yarn dev:node:fork
-```
-
-2. Start local UI dev server
-
-```
-> yarn dev:ui
-```
-
-3. Fund test accounts
-
-```
-> yarn workspace @ionicprotocol/sdk hardhat fork:fund-accounts --network fork
-```
-
-4. Run dAppateer
-
-```
-> yarn test:ui
-```
-
-### UI Test With WSL2
-
-If you are on windows you need an X-server to run dappeteer.
-These instructions were taken from here: https://www.rickmakes.com/windows-subsystem-for-linux-2-installing-vcxrv-x-server/
-
-Follow these steps before running `yarn test:ui`
-
-1. Download VcXsrv, this is your X-server that will display the GUI
-   https://sourceforge.net/projects/vcxsrv/
-2. Run VcXsrv. Use these settings
-
-```
-Multiple Windows -> Start No Client -> Check All Boxes in Extra Settings -> Finish
-```
-
-If Windows Defender Firewall prompts you, check both Private & Public Networks and Allow Access
-
-3. Find your Windows IP Address by running the following command
-
-```
-cat /etc/resolv.conf
-```
-
-4. Set DISPLAY Variable (replace ip_address with your IP Address found above)
-
-```
-export DISPLAY=ip_address:0.0
-```
-
-5. export opengl Variable
-
-```
-export LIBGL_ALWAYS_INDIRECT=1
-```
+```
diff --git a/packages/contracts/contracts/compound/CToken.sol b/packages/contracts/contracts/compound/CToken.sol
@@ -7,7 +7,6 @@ import { TokenErrorReporter } from "./ErrorReporter.sol";
 import { Exponential } from "./Exponential.sol";
 import { EIP20Interface } from "./EIP20Interface.sol";
 import { InterestRateModel } from "./InterestRateModel.sol";
-import { ComptrollerV3Storage } from "./ComptrollerStorage.sol";
 import { IFeeDistributor } from "./IFeeDistributor.sol";
 import { CTokenOracleProtected } from "./CTokenOracleProtected.sol";
 
@@ -57,8 +56,8 @@ abstract contract CErc20 is CTokenOracleProtected, CTokenSecondExtensionBase, To
     functionSelectors[--fnsCount] = this.seize.selector;
     functionSelectors[--fnsCount] = this.selfTransferOut.selector;
     functionSelectors[--fnsCount] = this.selfTransferIn.selector;
-    functionSelectors[--fnsCount] = this._withdrawIonicFees.selector;
-    functionSelectors[--fnsCount] = this._withdrawAdminFees.selector;
+    functionSelectors[--fnsCount] = this.previewDeposit.selector;
+    functionSelectors[--fnsCount] = this.previewRedeem.selector;
 
     require(fnsCount == 0, "use the correct array length");
     return functionSelectors;
@@ -67,7 +66,42 @@ abstract contract CErc20 is CTokenOracleProtected, CTokenSecondExtensionBase, To
   /*** User Interface ***/
 
   /**
-   * @notice Sender supplies assets into the market and receives cTokens in exchange
+   * @notice Simulate the effects of a deposit at the current block, given current on-chain conditions.
+   * @param assets Exact amount of underlying `asset` token to deposit
+   * @return of the vault issued in exchange to the user for `assets`
+   */
+  function previewDeposit(uint256 assets) public view returns (uint256) {
+    (, uint256 mintedCTokens) = _previewDeposit(assets, asCTokenExtension().exchangeRateCurrent());
+    return mintedCTokens;
+  }
+
+  function _previewDeposit(uint256 assets, uint256 exchangeRateMantissa) internal pure returns (MathError, uint256) {
+    // mintedCTokens is rounded down here - correct
+    return divScalarByExpTruncate(
+      assets,
+      Exp({ mantissa: exchangeRateMantissa })
+    );
+  }
+
+  /**
+   * @notice Simulate the effects of a redemption at the current block, given current on-chain conditions.
+   * @param redeemTokensIn Exact amount of `cTokens` to redeem
+   * @return quantity of underlying returned in exchange for `cTokens`.
+   */
+  function previewRedeem(uint256 redeemTokensIn) public view returns (uint256) {
+    (, uint256 redeemAmount) = _previewRedeem(redeemTokensIn, asCTokenExtension().exchangeRateCurrent());
+    return redeemAmount;
+  }
+
+  function _previewRedeem(uint256 redeemTokensIn, uint256 exchangeRateMantissa) internal pure returns (MathError, uint256) {
+    return mulScalarTruncate(
+      Exp({ mantissa: exchangeRateMantissa }),
+      redeemTokensIn
+    );
+  }
+
+/**
+ * @notice Sender supplies assets into the market and receives cTokens in exchange
    * @dev Accrues interest whether or not the operation succeeds, unless reverted
    * @param mintAmount The amount of the underlying asset to supply
    * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details)
@@ -179,71 +213,6 @@ abstract contract CErc20 is CTokenOracleProtected, CTokenSecondExtensionBase, To
     return doTransferIn(from, amount);
   }
 
-  /**
-   * @notice Accrues interest and reduces Ionic fees by transferring to Ionic
-   * @param withdrawAmount Amount of fees to withdraw
-   * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details)
-   */
-  function _withdrawIonicFees(uint256 withdrawAmount) external override nonReentrant(false) onlyOracleApproved returns (uint256) {
-    asCTokenExtension().accrueInterest();
-
-    if (accrualBlockNumber != block.number) {
-      return fail(Error.MARKET_NOT_FRESH, FailureInfo.WITHDRAW_IONIC_FEES_FRESH_CHECK);
-    }
-
-    if (getCashInternal() < withdrawAmount) {
-      return fail(Error.TOKEN_INSUFFICIENT_CASH, FailureInfo.WITHDRAW_IONIC_FEES_CASH_NOT_AVAILABLE);
-    }
-
-    if (withdrawAmount > totalIonicFees) {
-      return fail(Error.BAD_INPUT, FailureInfo.WITHDRAW_IONIC_FEES_VALIDATION);
-    }
-
-    /////////////////////////
-    // EFFECTS & INTERACTIONS
-    // (No safe failures beyond this point)
-
-    uint256 totalIonicFeesNew = totalIonicFees - withdrawAmount;
-    totalIonicFees = totalIonicFeesNew;
-
-    // doTransferOut reverts if anything goes wrong, since we can't be sure if side effects occurred.
-    doTransferOut(address(ionicAdmin), withdrawAmount);
-
-    return uint256(Error.NO_ERROR);
-  }
-
-  /**
-   * @notice Accrues interest and reduces admin fees by transferring to admin
-   * @param withdrawAmount Amount of fees to withdraw
-   * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details)
-   */
-  function _withdrawAdminFees(uint256 withdrawAmount) external override nonReentrant(false) onlyOracleApproved returns (uint256) {
-    asCTokenExtension().accrueInterest();
-
-    if (accrualBlockNumber != block.number) {
-      return fail(Error.MARKET_NOT_FRESH, FailureInfo.WITHDRAW_ADMIN_FEES_FRESH_CHECK);
-    }
-
-    // Fail gracefully if protocol has insufficient underlying cash
-    if (getCashInternal() < withdrawAmount) {
-      return fail(Error.TOKEN_INSUFFICIENT_CASH, FailureInfo.WITHDRAW_ADMIN_FEES_CASH_NOT_AVAILABLE);
-    }
-
-    if (withdrawAmount > totalAdminFees) {
-      return fail(Error.BAD_INPUT, FailureInfo.WITHDRAW_ADMIN_FEES_VALIDATION);
-    }
-
-    /////////////////////////
-    // EFFECTS & INTERACTIONS
-    // (No safe failures beyond this point)
-    totalAdminFees = totalAdminFees - withdrawAmount;
-
-    // doTransferOut reverts if anything goes wrong, since we can't be sure if side effects occurred.
-    doTransferOut(ComptrollerV3Storage(address(comptroller)).admin(), withdrawAmount);
-
-    return uint256(Error.NO_ERROR);
-  }
-
   /*** Safe Token ***/
 
   /**
@@ -376,9 +345,9 @@ abstract contract CErc20 is CTokenOracleProtected, CTokenSecondExtensionBase, To
      */
 
     // mintTokens is rounded down here - correct
-    (vars.mathErr, vars.mintTokens) = divScalarByExpTruncate(
+    (vars.mathErr, vars.mintTokens) = _previewDeposit(
       vars.actualMintAmount,
-      Exp({ mantissa: vars.exchangeRateMantissa })
+      vars.exchangeRateMantissa
     );
     require(vars.mathErr == MathError.NO_ERROR, "MINT_EXCHANGE_CALCULATION_FAILED");
     require(vars.mintTokens > 0, "MINT_ZERO_CTOKENS_REJECTED");
@@ -475,10 +444,7 @@ abstract contract CErc20 is CTokenOracleProtected, CTokenSecondExtensionBase, To
        */
       vars.redeemTokens = redeemTokensIn;
 
-      (vars.mathErr, vars.redeemAmount) = mulScalarTruncate(
-        Exp({ mantissa: vars.exchangeRateMantissa }),
-        redeemTokensIn
-      );
+      (vars.mathErr, vars.redeemAmount) = _previewRedeem(redeemTokensIn, vars.exchangeRateMantissa);
       if (vars.mathErr != MathError.NO_ERROR) {
         return
           failOpaque(Error.MATH_ERROR, FailureInfo.REDEEM_EXCHANGE_TOKENS_CALCULATION_FAILED, uint256(vars.mathErr));