diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml new file mode 100644 index 0000000..9251d16 --- /dev/null +++ b/.github/workflows/tests.yml @@ -0,0 +1,34 @@ +name: Tests + +on: + push: + branches: + - main + pull_request: + +jobs: + unit-tests: + name: Unit Tests + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v1 + - uses: actions/setup-node@v1 + with: + node-version: 12.x + + - id: yarn-cache + run: echo "::set-output name=dir::$(yarn cache dir)" + + - uses: actions/cache@v1 + with: + path: ${{ steps.yarn-cache.outputs.dir }} + key: yarn-${{ hashFiles('**/yarn.lock') }} + restore-keys: | + yarn- + - name: Install dependencies + run: npm i + + + #- name: Run unit tests + # run: yarn test diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..f22c09a --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +.env +node_modules +build +package-lock.json +.DS_store \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..87d9613 --- /dev/null +++ b/README.md @@ -0,0 +1,144 @@ +JustLend Protocol +================= + +JustLend Protocol is an TRON smart contract protocol for supplying or borrowing assets. Through the jToken contracts, accounts on the TRON blockchain supply capital (TRX or TRC20 tokens) to receive jTokens or borrow assets from the protocol (holding other assets as collateral). The JustLend jToken contracts track these balances and algorithmically set interest rates for borrowers. + +Before getting started with this repo, please read: + +* The [Justlend Whitepaper](https://www.justlend.link/docs/justlend_whitepaper_en.pdf) +* The [Justlend Terms Of Use](https://www.justlend.link/docs/JustLend_Terms_of_Use_en.pdf) + +For questions about interacting with JustLend, please visit [our Telegram Group](https://t.me/officialjustlend). + + +Contracts +========= + +We detail a few of the core contracts in the Justlend protocol. + +
+
CToken, CErc20 and CEther
+
The Justlend jTokens which are self-contained borrowing and lending contracts, are deployed from the code of CToken and CEther contracts. CToken contains the core logic and CErc20 and CEther add public interfaces for TRC20 tokens and TRX, respectively. Each jToken is assigned an interest rate and risk model (see InterestRateModel and Comptroller parts), and allows accounts to mint (supply capital), redeem (withdraw capital), borrow and repay a borrow. Each jToken is an TRC20 compliant token where balances represent ownership of the market.
+
+ +
+
Comptroller
+
The risk model contract, which validates permissible user actions and disallows actions if they do not fit certain risk parameters. For instance, the Comptroller enforces that each borrowing user must maintain a sufficient collateral balance across all cTokens.
+
+ +
+
GovernorAlpha
+
The administrator of the Justlend timelock contract. Holders of JST token may create and vote on proposals which will be queued into the Justlend timelock and then have effects on Justlend jToken and Comptroller contracts. This contract may be replaced in the future with a beta version.
+
+ +
+
InterestRateModel
+
Contracts which define interest rate models. These models algorithmically determine interest rates based on the current utilization of a given market (that is, how much of the supplied assets are liquid versus borrowed).
+
+ +
+
ErrorReporter
+
Library for tracking error codes and failure conditions.
+
+ +
+
Exponential
+
Library for handling fixed-point decimal numbers.
+
+ + +
+
WhitePaperInterestRateModel
+
Initial interest rate model, as defined in the Whitepaper. This contract accepts a base rate and slope parameter in its constructor.
+
+ + +
+
Careful Math
+
Library for safe math operations.
+
+ +
+
SafeToken
+
Library for safely handling Trc20 interaction.
+
+ +Deployment +---------- +TronBox is being used in this project. Before getting started with the deployment script, please read: + +* [Tronbox Tutorial](https://developers.tron.network/v3.7/docs/tron-box-user-guide) + + +## Compile and Deployment + +To get started, first create and initialize a [NodeJS 8.0+ environment](https://github.com/nodejs/node). Next, clone the repo and install the developer dependencies: + +### Setup +``` +npm i +``` + +### OS requirement + * Linux + * Mac OS X + +### Compile The Contract + +Run this by using tronbox embedded solc: + ```shell + tronbox compile +``` + +Or you may want to use external compilers. You can get the compiler from [here](https://github.com/tronprotocol/solidity/releases/tag/tv_0.5.12) + +And rename the compiler executable file to `solc512`, then compile the contracts with these commands. + +```shell +./solc512 --allow-paths $YOUR_PATH/justlend-protocol/, --bin --abi --optimize $YOUR_PATH/justlend-protocol/Unitroller.sol +./solc512 --allow-paths $YOUR_PATH/justlend-protocol/, --bin --abi --optimize $YOUR_PATH/justlend-protocol/Comptroller.sol +./solc512 --allow-paths $YOUR_PATH/justlend-protocol/, --bin --abi --optimize $YOUR_PATH/justlend-protocol/Governance/WJST.sol +./solc512 --allow-paths $YOUR_PATH/justlend-protocol/, --bin --abi --optimize $YOUR_PATH/justlend-protocol/Governance/GovernorBravoDelegator.sol +./solc512 --allow-paths $YOUR_PATH/justlend-protocol/, --bin --abi --optimize $YOUR_PATH/justlend-protocol/Timelock.sol +./solc512 --allow-paths $YOUR_PATH/justlend-protocol/, --bin --abi --optimize $YOUR_PATH/justlend-protocol/JumpRateModelV2.sol +./solc512 --allow-paths $YOUR_PATH/justlend-protocol/, --bin --abi --optimize $YOUR_PATH/justlend-protocol/WhitePaperInterestRateModel.sol +./solc512 --allow-paths $YOUR_PATH/justlend-protocol/, --bin --abi --optimize $YOUR_PATH/justlend-protocol/CEther.sol +./solc512 --allow-paths $YOUR_PATH/justlend-protocol/, --bin --abi --optimize $YOUR_PATH/justlend-protocol/CErc20Delegate.sol +./solc512 --allow-paths $YOUR_PATH/justlend-protocol/, --bin --abi --optimize $YOUR_PATH/justlend-protocol/CErc20Delegator.sol +./solc512 --allow-paths $YOUR_PATH/justlend-protocol/, --bin --abi --optimize $YOUR_PATH/justlend-protocol/PriceOracle/PriceOracle.sol +./solc512 --allow-paths $YOUR_PATH/justlend-protocol/, --bin --abi --optimize $YOUR_PATH/justlend-protocol/PriceOracleProxy.sol +./solc512 --allow-paths $YOUR_PATH/justlend-protocol/, --bin --abi --optimize $YOUR_PATH/justlend-protocol/PriceOracle/PriceOracle.sol +./solc512 --allow-paths $YOUR_PATH/justlend-protocol/, --bin --abi --optimize $YOUR_PATH/justlend-protocol/PriceOracleProxy.sol +./solc512 --allow-paths $YOUR_PATH/justlend-protocol/, --bin --abi --optimize $YOUR_PATH/justlend-protocol/Lens/CompoundLens.sol +``` + +### Deploy on Nile TestNet +Before use, `sample-env` should be renamed to `.env` with the added network config: +``` +PRIVATE_KEY_NILE=YOUR_PRIVATE_KEY +RESERVER_ADMIN=YOUR_RESERVE_ADMIN_ADMIN_ADDRESS +ADMIN=YOUR_ADMIN_ADDRESS +``` + +Assuming all contracts haven't been deployed, the user must deploy the script one by one individually by replacing `xx` with the correct number of the file and then record the contract addresses and data to `../data/test-xxx.json`. Please feel free to modify the `migrations` and contract data. + +``` +tronbox migrate --network nile -f xx --to xx +``` + +For example, if you want to run `3_deploy_comptroller.js`, the command will be `tronbox migrate --network nile -f 3 --to 3`. + +Due to the limitation of Tronbox, `Governor.setTimelock()` is unable to be invoked among the migration script. Therefore, the related script is inside `script/2_setTimelock.js`. Please run it for setting up the timelock address from Governor. + +## Contract Callers + +The sample of contract invokers is inside the `script` folder. + +Discussion +---------- + +For any concerns with the protocol, open an issue or visit us on [Telegram](https://t.me/officialjustlend) to discuss. + +For security concerns, please email [support@justlend.org](mailto:support@justlend.org). + +_© Copyright 2022 JustLend DAO diff --git a/contracts/BaseJumpRateModelV2.sol b/contracts/BaseJumpRateModelV2.sol new file mode 100644 index 0000000..8537c62 --- /dev/null +++ b/contracts/BaseJumpRateModelV2.sol @@ -0,0 +1,137 @@ +pragma solidity ^0.5.12; + +import "./SafeMath.sol"; + +/** + * @title Logic for Compound's JumpRateModel Contract V2. + * @author Compound (modified by Dharma Labs, refactored by Arr00) + * @notice Version 2 modifies Version 1 by enabling updateable parameters. + */ +contract BaseJumpRateModelV2 { + using SafeMath for uint; + + event NewInterestParams(uint baseRatePerBlock, uint multiplierPerBlock, uint jumpMultiplierPerBlock, uint kink); + + /** + * @notice The address of the owner, i.e. the Timelock contract, which can update parameters directly + */ + address public owner; + + /** + * @notice The approximate number of blocks per year that is assumed by the interest rate model + */ + uint public constant blocksPerYear = 10_512_000; + + /** + * @notice The multiplier of utilization rate that gives the slope of the interest rate + */ + uint public multiplierPerBlock; + + /** + * @notice The base interest rate which is the y-intercept when utilization rate is 0 + */ + uint public baseRatePerBlock; + + /** + * @notice The multiplierPerBlock after hitting a specified utilization point + */ + uint public jumpMultiplierPerBlock; + + /** + * @notice The utilization point at which the jump multiplier is applied + */ + uint public kink; + + /** + * @notice Construct an interest rate model + * @param baseRatePerYear The approximate target base APR, as a mantissa (scaled by 1e18) + * @param multiplierPerYear The rate of increase in interest rate wrt utilization (scaled by 1e18) + * @param jumpMultiplierPerYear The multiplierPerBlock after hitting a specified utilization point + * @param kink_ The utilization point at which the jump multiplier is applied + * @param owner_ The address of the owner, i.e. the Timelock contract (which has the ability to update parameters directly) + */ + constructor(uint baseRatePerYear, uint multiplierPerYear, uint jumpMultiplierPerYear, uint kink_, address owner_) internal { + owner = owner_; + + updateJumpRateModelInternal(baseRatePerYear, multiplierPerYear, jumpMultiplierPerYear, kink_); + } + + /** + * @notice Update the parameters of the interest rate model (only callable by owner, i.e. Timelock) + * @param baseRatePerYear The approximate target base APR, as a mantissa (scaled by 1e18) + * @param multiplierPerYear The rate of increase in interest rate wrt utilization (scaled by 1e18) + * @param jumpMultiplierPerYear The multiplierPerBlock after hitting a specified utilization point + * @param kink_ The utilization point at which the jump multiplier is applied + */ + function updateJumpRateModel(uint baseRatePerYear, uint multiplierPerYear, uint jumpMultiplierPerYear, uint kink_) external { + require(msg.sender == owner, "only the owner may call this function."); + + updateJumpRateModelInternal(baseRatePerYear, multiplierPerYear, jumpMultiplierPerYear, kink_); + } + + /** + * @notice Calculates the utilization rate of the market: `borrows / (cash + borrows - reserves)` + * @param cash The amount of cash in the market + * @param borrows The amount of borrows in the market + * @param reserves The amount of reserves in the market (currently unused) + * @return The utilization rate as a mantissa between [0, 1e18] + */ + function utilizationRate(uint cash, uint borrows, uint reserves) public pure returns (uint) { + // Utilization rate is 0 when there are no borrows + if (borrows == 0) { + return 0; + } + + return borrows.mul(1e18).div(cash.add(borrows).sub(reserves)); + } + + /** + * @notice Calculates the current borrow rate per block, with the error code expected by the market + * @param cash The amount of cash in the market + * @param borrows The amount of borrows in the market + * @param reserves The amount of reserves in the market + * @return The borrow rate percentage per block as a mantissa (scaled by 1e18) + */ + function getBorrowRateInternal(uint cash, uint borrows, uint reserves) internal view returns (uint) { + uint util = utilizationRate(cash, borrows, reserves); + + if (util <= kink) { + return util.mul(multiplierPerBlock).div(1e18).add(baseRatePerBlock); + } else { + uint normalRate = kink.mul(multiplierPerBlock).div(1e18).add(baseRatePerBlock); + uint excessUtil = util.sub(kink); + return excessUtil.mul(jumpMultiplierPerBlock).div(1e18).add(normalRate); + } + } + + /** + * @notice Calculates the current supply rate per block + * @param cash The amount of cash in the market + * @param borrows The amount of borrows in the market + * @param reserves The amount of reserves in the market + * @param reserveFactorMantissa The current reserve factor for the market + * @return The supply rate percentage per block as a mantissa (scaled by 1e18) + */ + function getSupplyRate(uint cash, uint borrows, uint reserves, uint reserveFactorMantissa) public view returns (uint) { + uint oneMinusReserveFactor = uint(1e18).sub(reserveFactorMantissa); + uint borrowRate = getBorrowRateInternal(cash, borrows, reserves); + uint rateToPool = borrowRate.mul(oneMinusReserveFactor).div(1e18); + return utilizationRate(cash, borrows, reserves).mul(rateToPool).div(1e18); + } + + /** + * @notice Internal function to update the parameters of the interest rate model + * @param baseRatePerYear The approximate target base APR, as a mantissa (scaled by 1e18) + * @param multiplierPerYear The rate of increase in interest rate wrt utilization (scaled by 1e18) + * @param jumpMultiplierPerYear The multiplierPerBlock after hitting a specified utilization point + * @param kink_ The utilization point at which the jump multiplier is applied + */ + function updateJumpRateModelInternal(uint baseRatePerYear, uint multiplierPerYear, uint jumpMultiplierPerYear, uint kink_) internal { + baseRatePerBlock = baseRatePerYear.div(blocksPerYear); + multiplierPerBlock = (multiplierPerYear.mul(1e18)).div(blocksPerYear.mul(kink_)); + jumpMultiplierPerBlock = jumpMultiplierPerYear.div(blocksPerYear); + kink = kink_; + + emit NewInterestParams(baseRatePerBlock, multiplierPerBlock, jumpMultiplierPerBlock, kink); + } +} \ No newline at end of file diff --git a/contracts/CDaiDelegate.sol b/contracts/CDaiDelegate.sol new file mode 100644 index 0000000..5a110cd --- /dev/null +++ b/contracts/CDaiDelegate.sol @@ -0,0 +1,208 @@ +pragma solidity ^0.5.12; + +import "./CErc20Delegate.sol"; + +/** + * @title Compound's CDai Contract + * @notice CToken which wraps Multi-Collateral DAI + * @author Compound + */ +contract CDaiDelegate is CErc20Delegate { + /** + * @notice DAI adapter address + */ + address public daiJoinAddress; + + /** + * @notice DAI Savings Rate (DSR) pot address + */ + address public potAddress; + + /** + * @notice DAI vat address + */ + address public vatAddress; + + /** + * @notice Delegate interface to become the implementation + * @param data The encoded arguments for becoming + */ + function _becomeImplementation(bytes memory data) public { + require(msg.sender == admin, "only the admin may initialize the implementation"); + + (address daiJoinAddress_, address potAddress_) = abi.decode(data, (address, address)); + return _becomeImplementation(daiJoinAddress_, potAddress_); + } + + /** + * @notice Explicit interface to become the implementation + * @param daiJoinAddress_ DAI adapter address + * @param potAddress_ DAI Savings Rate (DSR) pot address + */ + function _becomeImplementation(address daiJoinAddress_, address potAddress_) internal { + // Get dai and vat and sanity check the underlying + DaiJoinLike daiJoin = DaiJoinLike(daiJoinAddress_); + PotLike pot = PotLike(potAddress_); + GemLike dai = daiJoin.dai(); + VatLike vat = daiJoin.vat(); + require(address(dai) == underlying, "DAI must be the same as underlying"); + + // Remember the relevant addresses + daiJoinAddress = daiJoinAddress_; + potAddress = potAddress_; + vatAddress = address(vat); + + // Approve moving our DAI into the vat through daiJoin + dai.approve(daiJoinAddress, uint(-1)); + + // Approve the pot to transfer our funds within the vat + vat.hope(potAddress); + vat.hope(daiJoinAddress); + + // Accumulate DSR interest -- must do this in order to doTransferIn + pot.drip(); + + // Transfer all cash in (doTransferIn does this regardless of amount) + doTransferIn(address(this), 0); + } + + /** + * @notice Delegate interface to resign the implementation + */ + function _resignImplementation() public { + require(msg.sender == admin, "only the admin may abandon the implementation"); + + // Transfer all cash out of the DSR - note that this relies on self-transfer + DaiJoinLike daiJoin = DaiJoinLike(daiJoinAddress); + PotLike pot = PotLike(potAddress); + VatLike vat = VatLike(vatAddress); + + // Accumulate interest + pot.drip(); + + // Calculate the total amount in the pot, and move it out + uint pie = pot.pie(address(this)); + pot.exit(pie); + + // Checks the actual balance of DAI in the vat after the pot exit + uint bal = vat.dai(address(this)); + + // Remove our whole balance + daiJoin.exit(address(this), bal / RAY); + } + + /*** CToken Overrides ***/ + + /** + * @notice Accrues DSR then applies accrued interest to total borrows and reserves + * @dev This calculates interest accrued from the last checkpointed block + * up to the current block and writes new checkpoint to storage. + */ + function accrueInterest() public returns (uint) { + // Accumulate DSR interest + PotLike(potAddress).drip(); + + // Accumulate CToken interest + return super.accrueInterest(); + } + + /*** Safe Token ***/ + + /** + * @notice Gets balance of this contract in terms of the underlying + * @dev This excludes the value of the current message, if any + * @return The quantity of underlying tokens owned by this contract + */ + function getCashPrior() internal view returns (uint) { + PotLike pot = PotLike(potAddress); + uint pie = pot.pie(address(this)); + return mul(pot.chi(), pie) / RAY; + } + + /** + * @notice Transfer the underlying to this contract and sweep into DSR pot + * @param from Address to transfer funds from + * @param amount Amount of underlying to transfer + * @return The actual amount that is transferred + */ + function doTransferIn(address from, uint amount) internal returns (uint) { + // Perform the EIP-20 transfer in + EIP20Interface token = EIP20Interface(underlying); + require(token.transferFrom(from, address(this), amount), "unexpected EIP-20 transfer in return"); + + DaiJoinLike daiJoin = DaiJoinLike(daiJoinAddress); + GemLike dai = GemLike(underlying); + PotLike pot = PotLike(potAddress); + VatLike vat = VatLike(vatAddress); + + // Convert all our DAI to internal DAI in the vat + daiJoin.join(address(this), dai.balanceOf(address(this))); + + // Checks the actual balance of DAI in the vat after the join + uint bal = vat.dai(address(this)); + + // Calculate the percentage increase to th pot for the entire vat, and move it in + // Note: We may leave a tiny bit of DAI in the vat...but we do the whole thing every time + uint pie = bal / pot.chi(); + pot.join(pie); + + return amount; + } + + /** + * @notice Transfer the underlying from this contract, after sweeping out of DSR pot + * @param to Address to transfer funds to + * @param amount Amount of underlying to transfer + */ + function doTransferOut(address payable to, uint amount) internal { + DaiJoinLike daiJoin = DaiJoinLike(daiJoinAddress); + PotLike pot = PotLike(potAddress); + + // Calculate the percentage decrease from the pot, and move that much out + // Note: Use a slightly larger pie size to ensure that we get at least amount in the vat + uint pie = add(mul(amount, RAY) / pot.chi(), 1); + pot.exit(pie); + + daiJoin.exit(to, amount); + } + + /*** Maker Internals ***/ + + uint256 constant RAY = 10 ** 27; + + function add(uint x, uint y) internal pure returns (uint z) { + require((z = x + y) >= x, "add-overflow"); + } + + function mul(uint x, uint y) internal pure returns (uint z) { + require(y == 0 || (z = x * y) / y == x, "mul-overflow"); + } +} + +/*** Maker Interfaces ***/ + +interface PotLike { + function chi() external view returns (uint); + function pie(address) external view returns (uint); + function drip() external returns (uint); + function join(uint) external; + function exit(uint) external; +} + +interface GemLike { + function approve(address, uint) external; + function balanceOf(address) external view returns (uint); + function transferFrom(address, address, uint) external returns (bool); +} + +interface VatLike { + function dai(address) external view returns (uint); + function hope(address) external; +} + +interface DaiJoinLike { + function vat() external returns (VatLike); + function dai() external returns (GemLike); + function join(address, uint) external payable; + function exit(address, uint) external; +} diff --git a/contracts/CErc20.sol b/contracts/CErc20.sol new file mode 100644 index 0000000..badbb20 --- /dev/null +++ b/contracts/CErc20.sol @@ -0,0 +1,205 @@ +pragma solidity ^0.5.12; + +import "./CToken.sol"; + +/** + * @title Compound's CErc20 Contract + * @notice CTokens which wrap an EIP-20 underlying + * @author Compound + */ +contract CErc20 is CToken, CErc20Interface { + + address constant USDTAddr = 0xa614f803B6FD780986A42c78Ec9c7f77e6DeD13C;// nile:0xECa9bC828A3005B9a3b909f2cc5c2a54794DE05F mainnet:0xa614f803B6FD780986A42c78Ec9c7f77e6DeD13C + + /** + * @notice Initialize the new money market + * @param underlying_ The address of the underlying asset + * @param comptroller_ The address of the Comptroller + * @param interestRateModel_ The address of the interest rate model + * @param initialExchangeRateMantissa_ The initial exchange rate, scaled by 1e18 + * @param name_ ERC-20 name of this token + * @param symbol_ ERC-20 symbol of this token + * @param decimals_ ERC-20 decimal precision of this token + */ + function initialize(address underlying_, + ComptrollerInterface comptroller_, + InterestRateModel interestRateModel_, + uint initialExchangeRateMantissa_, + string memory name_, + string memory symbol_, + uint8 decimals_, + uint256 newReserveFactorMantissa_) public { + // CToken initialize does the bulk of the work + super.initialize(comptroller_, interestRateModel_, initialExchangeRateMantissa_, name_, symbol_, decimals_, newReserveFactorMantissa_); + + // Set underlying and sanity check it + underlying = underlying_; + EIP20Interface(underlying).totalSupply(); + } + + /*** User Interface ***/ + + /** + * @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) + */ + function mint(uint mintAmount) external returns (uint) { + (uint err,) = mintInternal(mintAmount); + return err; + } + + /** + * @notice Sender redeems cTokens in exchange for the underlying asset + * @dev Accrues interest whether or not the operation succeeds, unless reverted + * @param redeemTokens The number of cTokens to redeem into underlying + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function redeem(uint redeemTokens) external returns (uint) { + return redeemInternal(redeemTokens); + } + + /** + * @notice Sender redeems cTokens in exchange for a specified amount of underlying asset + * @dev Accrues interest whether or not the operation succeeds, unless reverted + * @param redeemAmount The amount of underlying to redeem + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function redeemUnderlying(uint redeemAmount) external returns (uint) { + return redeemUnderlyingInternal(redeemAmount); + } + + /** + * @notice Sender borrows assets from the protocol to their own address + * @param borrowAmount The amount of the underlying asset to borrow + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function borrow(uint borrowAmount) external returns (uint) { + return borrowInternal(borrowAmount); + } + + /** + * @notice Sender repays their own borrow + * @param repayAmount The amount to repay + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function repayBorrow(uint repayAmount) external returns (uint) { + (uint err,) = repayBorrowInternal(repayAmount); + return err; + } + + /** + * @notice Sender repays a borrow belonging to borrower + * @param borrower the account with the debt being payed off + * @param repayAmount The amount to repay + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function repayBorrowBehalf(address borrower, uint repayAmount) external returns (uint) { + (uint err,) = repayBorrowBehalfInternal(borrower, repayAmount); + return err; + } + + /** + * @notice The sender liquidates the borrowers collateral. + * The collateral seized is transferred to the liquidator. + * @param borrower The borrower of this cToken to be liquidated + * @param repayAmount The amount of the underlying borrowed asset to repay + * @param cTokenCollateral The market in which to seize collateral from the borrower + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function liquidateBorrow(address borrower, uint repayAmount, CTokenInterface cTokenCollateral) external returns (uint) { + (uint err,) = liquidateBorrowInternal(borrower, repayAmount, cTokenCollateral); + return err; + } + + /** + * @notice The sender adds to reserves. + * @param addAmount The amount fo underlying token to add as reserves + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function _addReserves(uint addAmount) external returns (uint) { + return _addReservesInternal(addAmount); + } + + /*** Safe Token ***/ + + /** + * @notice Gets balance of this contract in terms of the underlying + * @dev This excludes the value of the current message, if any + * @return The quantity of underlying tokens owned by this contract + */ + function getCashPrior() internal view returns (uint) { + EIP20Interface token = EIP20Interface(underlying); + return token.balanceOf(address(this)); + } + + /** + * @dev Similar to EIP20 transfer, except it handles a False result from `transferFrom` and reverts in that case. + * This will revert due to insufficient balance or insufficient allowance. + * This function returns the actual amount received, + * which may be less than `amount` if there is a fee attached to the transfer. + * + * Note: This wrapper safely handles non-standard ERC-20 tokens that do not return a value. + * See here: https://medium.com/coinmonks/missing-return-value-bug-at-least-130-tokens-affected-d67bf08521ca + */ + function doTransferIn(address from, uint amount) internal returns (uint) { + EIP20NonStandardInterface token = EIP20NonStandardInterface(underlying); + uint balanceBefore = EIP20Interface(underlying).balanceOf(address(this)); + token.transferFrom(from, address(this), amount); + + bool success; + assembly { + switch returndatasize() + case 0 { // This is a non-standard ERC-20 + success := not(0) // set success to true + } + case 32 { // This is a compliant ERC-20 + returndatacopy(0, 0, 32) + success := mload(0) // Set `success = returndata` of external call + } + default { // This is an excessively non-compliant ERC-20, revert. + revert(0, 0) + } + } + require(success, "TOKEN_TRANSFER_IN_FAILED"); + + // Calculate the amount that was *actually* transferred + uint balanceAfter = EIP20Interface(underlying).balanceOf(address(this)); + require(balanceAfter >= balanceBefore, "TOKEN_TRANSFER_IN_OVERFLOW"); + return balanceAfter - balanceBefore; // underflow already checked above, just subtract + } + + /** + * @dev Similar to EIP20 transfer, except it handles a False success from `transfer` and returns an explanatory + * error code rather than reverting. If caller has not called checked protocol's balance, this may revert due to + * insufficient cash held in this contract. If caller has checked protocol's balance prior to this call, and verified + * it is >= amount, this should not revert in normal conditions. + * + * Note: This wrapper safely handles non-standard ERC-20 tokens that do not return a value. + * See here: https://medium.com/coinmonks/missing-return-value-bug-at-least-130-tokens-affected-d67bf08521ca + */ + function doTransferOut(address payable to, uint amount) internal { + EIP20NonStandardInterface token = EIP20NonStandardInterface(underlying); + token.transfer(to, amount); + + bool success; + if(address(token) == USDTAddr){ + return; + } + assembly { + switch returndatasize() + case 0 { // This is a non-standard ERC-20 + success := not(0) // set success to true + } + case 32 { // This is a complaint ERC-20 + returndatacopy(0, 0, 32) + success := mload(0) // Set `success = returndata` of external call + } + default { // This is an excessively non-compliant ERC-20, revert. + revert(0, 0) + } + } + require(success, "TOKEN_TRANSFER_OUT_FAILED"); + } +} diff --git a/contracts/CErc20Delegate.sol b/contracts/CErc20Delegate.sol new file mode 100644 index 0000000..d2cc774 --- /dev/null +++ b/contracts/CErc20Delegate.sol @@ -0,0 +1,43 @@ +pragma solidity ^0.5.12; + +import "./CErc20.sol"; + +/** + * @title Compound's CErc20Delegate Contract + * @notice CTokens which wrap an EIP-20 underlying and are delegated to + * @author Compound + */ +contract CErc20Delegate is CErc20, CDelegateInterface { + /** + * @notice Construct an empty delegate + */ + constructor() public {} + + /** + * @notice Called by the delegator on a delegate to initialize it for duty + * @param data The encoded bytes data for any initialization + */ + function _becomeImplementation(bytes memory data) public { + // Shh -- currently unused + data; + + // Shh -- we don't ever want this hook to be marked pure + if (false) { + implementation = address(0); + } + + require(msg.sender == admin, "only the admin may call _becomeImplementation"); + } + + /** + * @notice Called by the delegator on a delegate to forfeit its responsibility + */ + function _resignImplementation() public { + // Shh -- we don't ever want this hook to be marked pure + if (false) { + implementation = address(0); + } + + require(msg.sender == admin, "only the admin may call _resignImplementation"); + } +} diff --git a/contracts/CErc20Delegator.sol b/contracts/CErc20Delegator.sol new file mode 100644 index 0000000..faa569b --- /dev/null +++ b/contracts/CErc20Delegator.sol @@ -0,0 +1,485 @@ +pragma solidity ^0.5.12; + +import "./CTokenInterfaces.sol"; + +/** + * @title Compound's CErc20Delegator Contract + * @notice CTokens which wrap an EIP-20 underlying and delegate to an implementation + * @author Compound + */ +contract CErc20Delegator is CTokenInterface, CErc20Interface, CDelegatorInterface { + /** + * @notice Construct a new money market + * @param underlying_ The address of the underlying asset + * @param comptroller_ The address of the Comptroller + * @param interestRateModel_ The address of the interest rate model + * @param initialExchangeRateMantissa_ The initial exchange rate, scaled by 1e18 + * @param name_ ERC-20 name of this token + * @param symbol_ ERC-20 symbol of this token + * @param decimals_ ERC-20 decimal precision of this token + * @param admin_ Address of the administrator of this token + * @param implementation_ The address of the implementation the contract delegates to + * @param becomeImplementationData The encoded args for becomeImplementation + */ + constructor(address underlying_, + ComptrollerInterface comptroller_, + InterestRateModel interestRateModel_, + uint initialExchangeRateMantissa_, + string memory name_, + string memory symbol_, + uint8 decimals_, + address payable admin_, + address payable reserveAdmin_, + address implementation_, + bytes memory becomeImplementationData, + uint256 newReserveFactorMantissa_) public { + // Creator of the contract is admin during initialization + admin = msg.sender; + + // First delegate gets to initialize the delegator (i.e. storage contract) + delegateTo(implementation_, abi.encodeWithSignature("initialize(address,address,address,uint256,string,string,uint8,uint256)", + underlying_, + comptroller_, + interestRateModel_, + initialExchangeRateMantissa_, + name_, + symbol_, + decimals_, + newReserveFactorMantissa_)); + + // New implementations always get set via the settor (post-initialize) + _setImplementation(implementation_, false, becomeImplementationData); + + // Set the proper admin now that initialization is done + admin = admin_; + reserveAdmin = reserveAdmin_; + } + + /** + * @notice Called by the admin to update the implementation of the delegator + * @param implementation_ The address of the new implementation for delegation + * @param allowResign Flag to indicate whether to call _resignImplementation on the old implementation + * @param becomeImplementationData The encoded bytes data to be passed to _becomeImplementation + */ + function _setImplementation(address implementation_, bool allowResign, bytes memory becomeImplementationData) public { + require(msg.sender == admin, "CErc20Delegator::_setImplementation: Caller must be admin"); + + if (allowResign) { + delegateToImplementation(abi.encodeWithSignature("_resignImplementation()")); + } + + address oldImplementation = implementation; + implementation = implementation_; + + delegateToImplementation(abi.encodeWithSignature("_becomeImplementation(bytes)", becomeImplementationData)); + + emit NewImplementation(oldImplementation, implementation); + } + + /** + * @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) + */ + function mint(uint mintAmount) external returns (uint) { + mintAmount; // Shh + delegateAndReturn(); + } + + /** + * @notice Sender redeems cTokens in exchange for the underlying asset + * @dev Accrues interest whether or not the operation succeeds, unless reverted + * @param redeemTokens The number of cTokens to redeem into underlying + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function redeem(uint redeemTokens) external returns (uint) { + redeemTokens; // Shh + delegateAndReturn(); + } + + /** + * @notice Sender redeems cTokens in exchange for a specified amount of underlying asset + * @dev Accrues interest whether or not the operation succeeds, unless reverted + * @param redeemAmount The amount of underlying to redeem + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function redeemUnderlying(uint redeemAmount) external returns (uint) { + redeemAmount; // Shh + delegateAndReturn(); + } + + /** + * @notice Sender borrows assets from the protocol to their own address + * @param borrowAmount The amount of the underlying asset to borrow + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function borrow(uint borrowAmount) external returns (uint) { + borrowAmount; // Shh + delegateAndReturn(); + } + + /** + * @notice Sender repays their own borrow + * @param repayAmount The amount to repay + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function repayBorrow(uint repayAmount) external returns (uint) { + repayAmount; // Shh + delegateAndReturn(); + } + + /** + * @notice Sender repays a borrow belonging to borrower + * @param borrower the account with the debt being payed off + * @param repayAmount The amount to repay + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function repayBorrowBehalf(address borrower, uint repayAmount) external returns (uint) { + borrower; repayAmount; // Shh + delegateAndReturn(); + } + + /** + * @notice The sender liquidates the borrowers collateral. + * The collateral seized is transferred to the liquidator. + * @param borrower The borrower of this cToken to be liquidated + * @param cTokenCollateral The market in which to seize collateral from the borrower + * @param repayAmount The amount of the underlying borrowed asset to repay + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function liquidateBorrow(address borrower, uint repayAmount, CTokenInterface cTokenCollateral) external returns (uint) { + borrower; repayAmount; cTokenCollateral; // Shh + delegateAndReturn(); + } + + /** + * @notice Transfer `amount` tokens from `msg.sender` to `dst` + * @param dst The address of the destination account + * @param amount The number of tokens to transfer + * @return Whether or not the transfer succeeded + */ + function transfer(address dst, uint amount) external returns (bool) { + dst; amount; // Shh + delegateAndReturn(); + } + + /** + * @notice Transfer `amount` tokens from `src` to `dst` + * @param src The address of the source account + * @param dst The address of the destination account + * @param amount The number of tokens to transfer + * @return Whether or not the transfer succeeded + */ + function transferFrom(address src, address dst, uint256 amount) external returns (bool) { + src; dst; amount; // Shh + delegateAndReturn(); + } + + /** + * @notice Approve `spender` to transfer up to `amount` from `src` + * @dev This will overwrite the approval amount for `spender` + * and is subject to issues noted [here](https://eips.ethereum.org/EIPS/eip-20#approve) + * @param spender The address of the account which may transfer tokens + * @param amount The number of tokens that are approved (-1 means infinite) + * @return Whether or not the approval succeeded + */ + function approve(address spender, uint256 amount) external returns (bool) { + spender; amount; // Shh + delegateAndReturn(); + } + + /** + * @notice Get the current allowance from `owner` for `spender` + * @param owner The address of the account which owns the tokens to be spent + * @param spender The address of the account which may transfer tokens + * @return The number of tokens allowed to be spent (-1 means infinite) + */ + function allowance(address owner, address spender) external view returns (uint) { + owner; spender; // Shh + delegateToViewAndReturn(); + } + + /** + * @notice Get the token balance of the `owner` + * @param owner The address of the account to query + * @return The number of tokens owned by `owner` + */ + function balanceOf(address owner) external view returns (uint) { + owner; // Shh + delegateToViewAndReturn(); + } + + /** + * @notice Get the underlying balance of the `owner` + * @dev This also accrues interest in a transaction + * @param owner The address of the account to query + * @return The amount of underlying owned by `owner` + */ + function balanceOfUnderlying(address owner) external returns (uint) { + owner; // Shh + delegateAndReturn(); + } + + /** + * @notice Get a snapshot of the account's balances, and the cached exchange rate + * @dev This is used by comptroller to more efficiently perform liquidity checks. + * @param account Address of the account to snapshot + * @return (possible error, token balance, borrow balance, exchange rate mantissa) + */ + function getAccountSnapshot(address account) external view returns (uint, uint, uint, uint) { + account; // Shh + delegateToViewAndReturn(); + } + + /** + * @notice Returns the current per-block borrow interest rate for this cToken + * @return The borrow interest rate per block, scaled by 1e18 + */ + function borrowRatePerBlock() external view returns (uint) { + delegateToViewAndReturn(); + } + + /** + * @notice Returns the current per-block supply interest rate for this cToken + * @return The supply interest rate per block, scaled by 1e18 + */ + function supplyRatePerBlock() external view returns (uint) { + delegateToViewAndReturn(); + } + + /** + * @notice Returns the current total borrows plus accrued interest + * @return The total borrows with interest + */ + function totalBorrowsCurrent() external returns (uint) { + delegateAndReturn(); + } + + /** + * @notice Accrue interest to updated borrowIndex and then calculate account's borrow balance using the updated borrowIndex + * @param account The address whose balance should be calculated after updating borrowIndex + * @return The calculated balance + */ + function borrowBalanceCurrent(address account) external returns (uint) { + account; // Shh + delegateAndReturn(); + } + + /** + * @notice Return the borrow balance of account based on stored data + * @param account The address whose balance should be calculated + * @return The calculated balance + */ + function borrowBalanceStored(address account) public view returns (uint) { + account; // Shh + delegateToViewAndReturn(); + } + + /** + * @notice Accrue interest then return the up-to-date exchange rate + * @return Calculated exchange rate scaled by 1e18 + */ + function exchangeRateCurrent() public returns (uint) { + delegateAndReturn(); + } + + /** + * @notice Calculates the exchange rate from the underlying to the CToken + * @dev This function does not accrue interest before calculating the exchange rate + * @return Calculated exchange rate scaled by 1e18 + */ + function exchangeRateStored() public view returns (uint) { + delegateToViewAndReturn(); + } + + /** + * @notice Get cash balance of this cToken in the underlying asset + * @return The quantity of underlying asset owned by this contract + */ + function getCash() public view returns (uint) { + delegateToViewAndReturn(); + } + + /** + * @notice Applies accrued interest to total borrows and reserves. + * @dev This calculates interest accrued from the last checkpointed block + * up to the current block and writes new checkpoint to storage. + */ + function accrueInterest() public returns (uint) { + delegateAndReturn(); + } + + /** + * @notice Transfers collateral tokens (this market) to the liquidator. + * @dev Will fail unless called by another cToken during the process of liquidation. + * Its absolutely critical to use msg.sender as the borrowed cToken and not a parameter. + * @param liquidator The account receiving seized collateral + * @param borrower The account having collateral seized + * @param seizeTokens The number of cTokens to seize + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function seize(address liquidator, address borrower, uint seizeTokens) external returns (uint) { + liquidator; borrower; seizeTokens; // Shh + delegateAndReturn(); + } + + /*** Admin Functions ***/ + + /** + * @notice Begins transfer of admin rights. The newPendingAdmin must call `_acceptAdmin` to finalize the transfer. + * @dev Admin function to begin change of admin. The newPendingAdmin must call `_acceptAdmin` to finalize the transfer. + * @param newPendingAdmin New pending admin. + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function _setPendingAdmin(address payable newPendingAdmin) external returns (uint) { + newPendingAdmin; // Shh + delegateAndReturn(); + } + + function _setReserveAdmin(address payable newReserveAdmin) external returns (uint) { + newReserveAdmin; // Shh + delegateAndReturn(); + } + + /** + * @notice Sets a new comptroller for the market + * @dev Admin function to set a new comptroller + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function _setComptroller(ComptrollerInterface newComptroller) public returns (uint) { + newComptroller; // Shh + delegateAndReturn(); + } + + /** + * @notice accrues interest and sets a new reserve factor for the protocol using _setReserveFactorFresh + * @dev Admin function to accrue interest and set a new reserve factor + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function _setReserveFactor(uint newReserveFactorMantissa) external returns (uint) { + newReserveFactorMantissa; // Shh + delegateAndReturn(); + } + + /** + * @notice Accepts transfer of admin rights. msg.sender must be pendingAdmin + * @dev Admin function for pending admin to accept role and update admin + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function _acceptAdmin() external returns (uint) { + delegateAndReturn(); + } + + /** + * @notice Accrues interest and adds reserves by transferring from admin + * @param addAmount Amount of reserves to add + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function _addReserves(uint addAmount) external returns (uint) { + addAmount; // Shh + delegateAndReturn(); + } + + /** + * @notice Accrues interest and reduces reserves by transferring to admin + * @param reduceAmount Amount of reduction to reserves + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function _reduceReserves(uint reduceAmount) external returns (uint) { + reduceAmount; // Shh + delegateAndReturn(); + } + + /** + * @notice Accrues interest and updates the interest rate model using _setInterestRateModelFresh + * @dev Admin function to accrue interest and update the interest rate model + * @param newInterestRateModel the new interest rate model to use + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function _setInterestRateModel(InterestRateModel newInterestRateModel) public returns (uint) { + newInterestRateModel; // Shh + delegateAndReturn(); + } + + /** + * @notice Internal method to delegate execution to another contract + * @dev It returns to the external caller whatever the implementation returns or forwards reverts + * @param callee The contract to delegatecall + * @param data The raw data to delegatecall + * @return The returned bytes from the delegatecall + */ + function delegateTo(address callee, bytes memory data) internal returns (bytes memory) { + (bool success, bytes memory returnData) = callee.delegatecall(data); + assembly { + if eq(success, 0) { + revert(add(returnData, 0x20), returndatasize) + } + } + return returnData; + } + + /** + * @notice Delegates execution to the implementation contract + * @dev It returns to the external caller whatever the implementation returns or forwards reverts + * @param data The raw data to delegatecall + * @return The returned bytes from the delegatecall + */ + function delegateToImplementation(bytes memory data) public returns (bytes memory) { + return delegateTo(implementation, data); + } + + /** + * @notice Delegates execution to an implementation contract + * @dev It returns to the external caller whatever the implementation returns or forwards reverts + * There are an additional 2 prefix uints from the wrapper returndata, which we ignore since we make an extra hop. + * @param data The raw data to delegatecall + * @return The returned bytes from the delegatecall + */ + function delegateToViewImplementation(bytes memory data) public view returns (bytes memory) { + (bool success, bytes memory returnData) = address(this).staticcall(abi.encodeWithSignature("delegateToImplementation(bytes)", data)); + assembly { + if eq(success, 0) { + revert(add(returnData, 0x20), returndatasize) + } + } + return abi.decode(returnData, (bytes)); + } + + function delegateToViewAndReturn() private view returns (bytes memory) { + (bool success, ) = address(this).staticcall(abi.encodeWithSignature("delegateToImplementation(bytes)", msg.data)); + + assembly { + let free_mem_ptr := mload(0x40) + returndatacopy(free_mem_ptr, 0, returndatasize) + + switch success + case 0 { revert(free_mem_ptr, returndatasize) } + default { return(add(free_mem_ptr, 0x40), returndatasize) } + } + } + + function delegateAndReturn() private returns (bytes memory) { + (bool success, ) = implementation.delegatecall(msg.data); + + assembly { + let free_mem_ptr := mload(0x40) + returndatacopy(free_mem_ptr, 0, returndatasize) + + switch success + case 0 { revert(free_mem_ptr, returndatasize) } + default { return(free_mem_ptr, returndatasize) } + } + } + + /** + * @notice Delegates execution to an implementation contract + * @dev It returns to the external caller whatever the implementation returns or forwards reverts + */ + function () external payable { + require(msg.value == 0,"CErc20Delegator:fallback: cannot send value to fallback"); + + // delegate all other functions to current implementation + delegateAndReturn(); + } +} diff --git a/contracts/CErc20Immutable.sol b/contracts/CErc20Immutable.sol new file mode 100644 index 0000000..703e74d --- /dev/null +++ b/contracts/CErc20Immutable.sol @@ -0,0 +1,44 @@ +pragma solidity ^0.5.12; + +import "./CErc20.sol"; + +/** + * @title Compound's CErc20Immutable Contract + * @notice CTokens which wrap an EIP-20 underlying and are immutable + * @author Compound + */ +contract CErc20Immutable is CErc20 { + /** + * @notice Construct a new money market + * @param underlying_ The address of the underlying asset + * @param comptroller_ The address of the Comptroller + * @param interestRateModel_ The address of the interest rate model + * @param initialExchangeRateMantissa_ The initial exchange rate, scaled by 1e18 + * @param name_ ERC-20 name of this token + * @param symbol_ ERC-20 symbol of this token + * @param decimals_ ERC-20 decimal precision of this token + * @param admin_ Address of the administrator of this token + */ + constructor(address underlying_, + ComptrollerInterface comptroller_, + InterestRateModel interestRateModel_, + uint initialExchangeRateMantissa_, + string memory name_, + string memory symbol_, + uint8 decimals_, + address payable admin_, + address payable reserveAdmin_, + uint256 newReserveFactorMantissa_ ) public { + // Creator of the contract is admin during initialization + admin = msg.sender; + + // Initialize the market + initialize(underlying_, comptroller_, interestRateModel_, initialExchangeRateMantissa_, name_, symbol_, decimals_, newReserveFactorMantissa_); + + // Set the proper admin now that initialization is done + admin = admin_; + + reserveAdmin = reserveAdmin_; + + } +} diff --git a/contracts/CEther.sol b/contracts/CEther.sol new file mode 100644 index 0000000..fe9e15a --- /dev/null +++ b/contracts/CEther.sol @@ -0,0 +1,198 @@ +pragma solidity ^0.5.12; + +import "./CToken.sol"; + +/** + * @title Compound's CEther Contract + * @notice CToken which wraps Ether + * @author Compound + */ +contract CEther is CToken { + /** + * @notice Construct a new CEther money market + * @param comptroller_ The address of the Comptroller + * @param interestRateModel_ The address of the interest rate model + * @param initialExchangeRateMantissa_ The initial exchange rate, scaled by 1e18 + * @param name_ ERC-20 name of this token + * @param symbol_ ERC-20 symbol of this token + * @param decimals_ ERC-20 decimal precision of this token + * @param admin_ Address of the administrator of this token + */ + constructor(ComptrollerInterface comptroller_, + InterestRateModel interestRateModel_, + uint initialExchangeRateMantissa_, + string memory name_, + string memory symbol_, + uint8 decimals_, + address payable admin_, + address payable reserveAdmin_, + uint256 newReserveFactorMantissa_ + ) public { + // Creator of the contract is admin during initialization + admin = msg.sender; + + initialize(comptroller_, interestRateModel_, initialExchangeRateMantissa_, name_, symbol_, decimals_, newReserveFactorMantissa_); + + // Set the proper admin now that initialization is done + admin = admin_; + + reserveAdmin = reserveAdmin_; + + } + + + /*** User Interface ***/ + + /** + * @notice Sender supplies assets into the market and receives cTokens in exchange + * @dev Reverts upon any failure + */ + function mint() external payable { + (uint err,) = mintInternal(msg.value); + requireNoError(err, "mint failed"); + } + + /** + * @notice Sender redeems cTokens in exchange for the underlying asset + * @dev Accrues interest whether or not the operation succeeds, unless reverted + * @param redeemTokens The number of cTokens to redeem into underlying + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function redeem(uint redeemTokens) external returns (uint) { + return redeemInternal(redeemTokens); + } + + /** + * @notice Sender redeems cTokens in exchange for a specified amount of underlying asset + * @dev Accrues interest whether or not the operation succeeds, unless reverted + * @param redeemAmount The amount of underlying to redeem + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function redeemUnderlying(uint redeemAmount) external returns (uint) { + return redeemUnderlyingInternal(redeemAmount); + } + + /** + * @notice Sender borrows assets from the protocol to their own address + * @param borrowAmount The amount of the underlying asset to borrow + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function borrow(uint borrowAmount) external returns (uint) { + return borrowInternal(borrowAmount); + } + + /** + * @notice Sender repays their own borrow + * @dev Reverts upon any failure + */ + function repayBorrow(uint amount) external payable { + (uint err,) = repayBorrowInternal(amount); + requireNoError(err, "repayBorrow failed"); + } + + /** + * @notice Sender repays a borrow belonging to borrower + * @dev Reverts upon any failure + * @param borrower the account with the debt being payed off + */ + function repayBorrowBehalf(address borrower) external payable { + (uint err,) = repayBorrowBehalfInternal(borrower, msg.value); + requireNoError(err, "repayBorrowBehalf failed"); + } + + /** + * @notice The sender liquidates the borrowers collateral. + * The collateral seized is transferred to the liquidator. + * @dev Reverts upon any failure + * @param borrower The borrower of this cToken to be liquidated + * @param cTokenCollateral The market in which to seize collateral from the borrower + */ + function liquidateBorrow(address borrower, CToken cTokenCollateral) external payable { + (uint err,) = liquidateBorrowInternal(borrower, msg.value, cTokenCollateral); + requireNoError(err, "liquidateBorrow failed"); + } + + /** + * @notice The sender adds to reserves. + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function _addReserves() external payable returns (uint) { + return _addReservesInternal(msg.value); + } + + /** + * @notice Send Ether to CEther to mint + */ + function () external payable { + (uint err,) = mintInternal(msg.value); + requireNoError(err, "mint failed"); + } + + /*** Safe Token ***/ + + /** + * @notice Gets balance of this contract in terms of Ether, before this message + * @dev This excludes the value of the current message, if any + * @return The quantity of Ether owned by this contract + */ + function getCashPrior() internal view returns (uint) { + (MathError err, uint startingBalance) = subUInt(address(this).balance, msg.value); + require(err == MathError.NO_ERROR); + return startingBalance; + } + + function getCash() public view returns (uint){ + return address(this).balance; + } + + + /** + * @notice Perform the actual transfer in, which is a no-op + * @param from Address sending the Ether + * @param amount Amount of Ether being sent + * @return The actual amount of Ether transferred + */ + function doTransferIn(address from, uint amount) internal returns (uint) { + // Sanity checks + require(msg.sender == from, "sender mismatch"); + // require(msg.value == amount, "value mismatch"); + require(msg.value >= amount, "value mismatch"); + if (msg.value > amount) { + uint256 repayAmount = sub(msg.value, amount, "calc surplus"); + address(uint160(from)).transfer(repayAmount); + } + return amount; + } + + function doTransferOut(address payable to, uint amount) internal { + /* Send the Ether, with minimal gas and revert on failure */ + to.transfer(amount); + } + + function requireNoError(uint errCode, string memory message) internal pure { + if (errCode == uint(Error.NO_ERROR)) { + return; + } + + bytes memory fullMessage = new bytes(bytes(message).length + 5); + uint i; + + for (i = 0; i < bytes(message).length; i++) { + fullMessage[i] = bytes(message)[i]; + } + + fullMessage[i+0] = byte(uint8(32)); + fullMessage[i+1] = byte(uint8(40)); + fullMessage[i+2] = byte(uint8(48 + ( errCode / 10 ))); + fullMessage[i+3] = byte(uint8(48 + ( errCode % 10 ))); + fullMessage[i+4] = byte(uint8(41)); + + require(errCode == uint(Error.NO_ERROR), string(fullMessage)); + } + + function sub(uint a, uint b, string memory errorMessage) internal pure returns (uint) { + require(b <= a, errorMessage); + uint c = a - b; + return c; + } +} diff --git a/contracts/CToken.sol b/contracts/CToken.sol new file mode 100644 index 0000000..1cccf15 --- /dev/null +++ b/contracts/CToken.sol @@ -0,0 +1,1474 @@ +pragma solidity ^0.5.12; + +import "./ComptrollerInterface.sol"; +import "./CTokenInterfaces.sol"; +import "./ErrorReporter.sol"; +import "./Exponential.sol"; +import "./EIP20Interface.sol"; +import "./EIP20NonStandardInterface.sol"; +import "./InterestRateModel.sol"; + +/** + * @title Compound's CToken Contract + * @notice Abstract base for CTokens + * @author Compound + */ +contract CToken is CTokenInterface, Exponential, TokenErrorReporter { + /** + * @notice Initialize the money market + * @param comptroller_ The address of the Comptroller + * @param interestRateModel_ The address of the interest rate model + * @param initialExchangeRateMantissa_ The initial exchange rate, scaled by 1e18 + * @param name_ EIP-20 name of this token + * @param symbol_ EIP-20 symbol of this token + * @param decimals_ EIP-20 decimal precision of this token + */ + function initialize(ComptrollerInterface comptroller_, + InterestRateModel interestRateModel_, + uint initialExchangeRateMantissa_, + string memory name_, + string memory symbol_, + uint8 decimals_,uint256 newReserveFactorMantissa_) public { + require(msg.sender == admin, "only admin may initialize the market"); + require(accrualBlockNumber == 0 && borrowIndex == 0, "market may only be initialized once"); + + // Set initial exchange rate + initialExchangeRateMantissa = initialExchangeRateMantissa_; + require(initialExchangeRateMantissa > 0, "initial exchange rate must be greater than zero."); + + reserveFactorMantissa = newReserveFactorMantissa_; + + // Set the comptroller + uint err = _setComptroller(comptroller_); + require(err == uint(Error.NO_ERROR), "setting comptroller failed"); + + // Initialize block number and borrow index (block number mocks depend on comptroller being set) + accrualBlockNumber = getBlockNumber(); + borrowIndex = mantissaOne; + + // Set the interest rate model (depends on block number / borrow index) + err = _setInterestRateModelFresh(interestRateModel_); + require(err == uint(Error.NO_ERROR), "setting interest rate model failed"); + + name = name_; + symbol = symbol_; + decimals = decimals_; + + // The counter starts true to prevent changing it from zero to non-zero (i.e. smaller cost/refund) + _notEntered = true; + } + + /** + * @notice Transfer `tokens` tokens from `src` to `dst` by `spender` + * @dev Called by both `transfer` and `transferFrom` internally + * @param spender The address of the account performing the transfer + * @param src The address of the source account + * @param dst The address of the destination account + * @param tokens The number of tokens to transfer + * @return Whether or not the transfer succeeded + */ + function transferTokens(address spender, address src, address dst, uint tokens) internal returns (uint) { + /* Fail if transfer not allowed */ + uint allowed = comptroller.transferAllowed(address(this), src, dst, tokens); + if (allowed != 0) { + return failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.TRANSFER_COMPTROLLER_REJECTION, allowed); + } + + /* Do not allow self-transfers */ + if (src == dst) { + return fail(Error.BAD_INPUT, FailureInfo.TRANSFER_NOT_ALLOWED); + } + + /* Get the allowance, infinite for the account owner */ + uint startingAllowance = 0; + if (spender == src) { + startingAllowance = uint(-1); + } else { + startingAllowance = transferAllowances[src][spender]; + } + + /* Do the calculations, checking for {under,over}flow */ + MathError mathErr; + uint allowanceNew; + uint srcTokensNew; + uint dstTokensNew; + + (mathErr, allowanceNew) = subUInt(startingAllowance, tokens); + if (mathErr != MathError.NO_ERROR) { + return fail(Error.MATH_ERROR, FailureInfo.TRANSFER_NOT_ALLOWED); + } + + (mathErr, srcTokensNew) = subUInt(accountTokens[src], tokens); + if (mathErr != MathError.NO_ERROR) { + return fail(Error.MATH_ERROR, FailureInfo.TRANSFER_NOT_ENOUGH); + } + + (mathErr, dstTokensNew) = addUInt(accountTokens[dst], tokens); + if (mathErr != MathError.NO_ERROR) { + return fail(Error.MATH_ERROR, FailureInfo.TRANSFER_TOO_MUCH); + } + + ///////////////////////// + // EFFECTS & INTERACTIONS + // (No safe failures beyond this point) + + accountTokens[src] = srcTokensNew; + accountTokens[dst] = dstTokensNew; + + /* Eat some of the allowance (if necessary) */ + if (startingAllowance != uint(-1)) { + transferAllowances[src][spender] = allowanceNew; + } + + /* We emit a Transfer event */ + emit Transfer(src, dst, tokens); + + comptroller.transferVerify(address(this), src, dst, tokens); + + emit JTokenBalance(src, srcTokensNew); + emit JTokenBalance(dst, dstTokensNew); + + return uint(Error.NO_ERROR); + } + + /** + * @notice Transfer `amount` tokens from `msg.sender` to `dst` + * @param dst The address of the destination account + * @param amount The number of tokens to transfer + * @return Whether or not the transfer succeeded + */ + function transfer(address dst, uint256 amount) external nonReentrant returns (bool) { + return transferTokens(msg.sender, msg.sender, dst, amount) == uint(Error.NO_ERROR); + } + + /** + * @notice Transfer `amount` tokens from `src` to `dst` + * @param src The address of the source account + * @param dst The address of the destination account + * @param amount The number of tokens to transfer + * @return Whether or not the transfer succeeded + */ + function transferFrom(address src, address dst, uint256 amount) external nonReentrant returns (bool) { + return transferTokens(msg.sender, src, dst, amount) == uint(Error.NO_ERROR); + } + + /** + * @notice Approve `spender` to transfer up to `amount` from `src` + * @dev This will overwrite the approval amount for `spender` + * and is subject to issues noted [here](https://eips.ethereum.org/EIPS/eip-20#approve) + * @param spender The address of the account which may transfer tokens + * @param amount The number of tokens that are approved (-1 means infinite) + * @return Whether or not the approval succeeded + */ + function approve(address spender, uint256 amount) external returns (bool) { + address src = msg.sender; + transferAllowances[src][spender] = amount; + emit Approval(src, spender, amount); + return true; + } + + /** + * @notice Get the current allowance from `owner` for `spender` + * @param owner The address of the account which owns the tokens to be spent + * @param spender The address of the account which may transfer tokens + * @return The number of tokens allowed to be spent (-1 means infinite) + */ + function allowance(address owner, address spender) external view returns (uint256) { + return transferAllowances[owner][spender]; + } + + /** + * @notice Get the token balance of the `owner` + * @param owner The address of the account to query + * @return The number of tokens owned by `owner` + */ + function balanceOf(address owner) external view returns (uint256) { + return accountTokens[owner]; + } + + /** + * @notice Get the underlying balance of the `owner` + * @dev This also accrues interest in a transaction + * @param owner The address of the account to query + * @return The amount of underlying owned by `owner` + */ + function balanceOfUnderlying(address owner) external returns (uint) { + Exp memory exchangeRate = Exp({mantissa: exchangeRateCurrent()}); + (MathError mErr, uint balance) = mulScalarTruncate(exchangeRate, accountTokens[owner]); + require(mErr == MathError.NO_ERROR, "balance could not be calculated"); + return balance; + } + + /** + * @notice Get a snapshot of the account's balances, and the cached exchange rate + * @dev This is used by comptroller to more efficiently perform liquidity checks. + * @param account Address of the account to snapshot + * @return (possible error, token balance, borrow balance, exchange rate mantissa) + */ + function getAccountSnapshot(address account) external view returns (uint, uint, uint, uint) { + uint cTokenBalance = accountTokens[account]; + uint borrowBalance; + uint exchangeRateMantissa; + + MathError mErr; + + (mErr, borrowBalance) = borrowBalanceStoredInternal(account); + if (mErr != MathError.NO_ERROR) { + return (uint(Error.MATH_ERROR), 0, 0, 0); + } + + (mErr, exchangeRateMantissa) = exchangeRateStoredInternal(); + if (mErr != MathError.NO_ERROR) { + return (uint(Error.MATH_ERROR), 0, 0, 0); + } + + return (uint(Error.NO_ERROR), cTokenBalance, borrowBalance, exchangeRateMantissa); + } + + /** + * @dev Function to simply retrieve block number + * This exists mainly for inheriting test contracts to stub this result. + */ + function getBlockNumber() internal view returns (uint) { + return block.number; + } + + /** + * @notice Returns the current per-block borrow interest rate for this cToken + * @return The borrow interest rate per block, scaled by 1e18 + */ + function borrowRatePerBlock() external view returns (uint) { + return interestRateModel.getBorrowRate(getCashPrior(), totalBorrows, totalReserves); + } + + /** + * @notice Returns the current per-block supply interest rate for this cToken + * @return The supply interest rate per block, scaled by 1e18 + */ + function supplyRatePerBlock() external view returns (uint) { + return interestRateModel.getSupplyRate(getCashPrior(), totalBorrows, totalReserves, reserveFactorMantissa); + } + + /** + * @notice Returns the current total borrows plus accrued interest + * @return The total borrows with interest + */ + function totalBorrowsCurrent() external nonReentrant returns (uint) { + require(accrueInterest() == uint(Error.NO_ERROR), "accrue interest failed"); + return totalBorrows; + } + + /** + * @notice Accrue interest to updated borrowIndex and then calculate account's borrow balance using the updated borrowIndex + * @param account The address whose balance should be calculated after updating borrowIndex + * @return The calculated balance + */ + function borrowBalanceCurrent(address account) external nonReentrant returns (uint) { + require(accrueInterest() == uint(Error.NO_ERROR), "accrue interest failed"); + return borrowBalanceStored(account); + } + + /** + * @notice Return the borrow balance of account based on stored data + * @param account The address whose balance should be calculated + * @return The calculated balance + */ + function borrowBalanceStored(address account) public view returns (uint) { + (MathError err, uint result) = borrowBalanceStoredInternal(account); + require(err == MathError.NO_ERROR, "borrowBalanceStored: borrowBalanceStoredInternal failed"); + return result; + } + + /** + * @notice Return the borrow balance of account based on stored data + * @param account The address whose balance should be calculated + * @return (error code, the calculated balance or 0 if error code is non-zero) + */ + function borrowBalanceStoredInternal(address account) internal view returns (MathError, uint) { + /* Note: we do not assert that the market is up to date */ + MathError mathErr; + uint principalTimesIndex; + uint result; + + /* Get borrowBalance and borrowIndex */ + BorrowSnapshot storage borrowSnapshot = accountBorrows[account]; + + /* If borrowBalance = 0 then borrowIndex is likely also 0. + * Rather than failing the calculation with a division by 0, we immediately return 0 in this case. + */ + if (borrowSnapshot.principal == 0) { + return (MathError.NO_ERROR, 0); + } + + /* Calculate new borrow balance using the interest index: + * recentBorrowBalance = borrower.borrowBalance * market.borrowIndex / borrower.borrowIndex + */ + (mathErr, principalTimesIndex) = mulUInt(borrowSnapshot.principal, borrowIndex); + if (mathErr != MathError.NO_ERROR) { + return (mathErr, 0); + } + + (mathErr, result) = divUInt(principalTimesIndex, borrowSnapshot.interestIndex); + if (mathErr != MathError.NO_ERROR) { + return (mathErr, 0); + } + + return (MathError.NO_ERROR, result); + } + + /** + * @notice Accrue interest then return the up-to-date exchange rate + * @return Calculated exchange rate scaled by 1e18 + */ + function exchangeRateCurrent() public nonReentrant returns (uint) { + require(accrueInterest() == uint(Error.NO_ERROR), "accrue interest failed"); + return exchangeRateStored(); + } + + /** + * @notice Calculates the exchange rate from the underlying to the CToken + * @dev This function does not accrue interest before calculating the exchange rate + * @return Calculated exchange rate scaled by 1e18 + */ + function exchangeRateStored() public view returns (uint) { + (MathError err, uint result) = exchangeRateStoredInternal(); + require(err == MathError.NO_ERROR, "exchangeRateStored: exchangeRateStoredInternal failed"); + return result; + } + + /** + * @notice Calculates the exchange rate from the underlying to the CToken + * @dev This function does not accrue interest before calculating the exchange rate + * @return (error code, calculated exchange rate scaled by 1e18) + */ + function exchangeRateStoredInternal() internal view returns (MathError, uint) { + uint _totalSupply = totalSupply; + if (_totalSupply == 0) { + /* + * If there are no tokens minted: + * exchangeRate = initialExchangeRate + */ + return (MathError.NO_ERROR, initialExchangeRateMantissa); + } else { + /* + * Otherwise: + * exchangeRate = (totalCash + totalBorrows - totalReserves) / totalSupply + */ + uint totalCash = getCashPrior(); + uint cashPlusBorrowsMinusReserves; + Exp memory exchangeRate; + MathError mathErr; + + (mathErr, cashPlusBorrowsMinusReserves) = addThenSubUInt(totalCash, totalBorrows, totalReserves); + if (mathErr != MathError.NO_ERROR) { + return (mathErr, 0); + } + + (mathErr, exchangeRate) = getExp(cashPlusBorrowsMinusReserves, _totalSupply); + if (mathErr != MathError.NO_ERROR) { + return (mathErr, 0); + } + + return (MathError.NO_ERROR, exchangeRate.mantissa); + } + } + + /** + * @notice Get cash balance of this cToken in the underlying asset + * @return The quantity of underlying asset owned by this contract + */ + function getCash() public view returns (uint) { + return getCashPrior(); + } + + /** + * @notice Applies accrued interest to total borrows and reserves + * @dev This calculates interest accrued from the last checkpointed block + * up to the current block and writes new checkpoint to storage. + */ + function accrueInterest() public returns (uint) { + /* Remember the initial block number */ + uint currentBlockNumber = getBlockNumber(); + uint accrualBlockNumberPrior = accrualBlockNumber; + + /* Short-circuit accumulating 0 interest */ + if (accrualBlockNumberPrior == currentBlockNumber) { + return uint(Error.NO_ERROR); + } + + /* Read the previous values out of storage */ + uint cashPrior = getCashPrior(); + uint borrowsPrior = totalBorrows; + uint reservesPrior = totalReserves; + uint borrowIndexPrior = borrowIndex; + + /* Calculate the current borrow interest rate */ + uint borrowRateMantissa = interestRateModel.getBorrowRate(cashPrior, borrowsPrior, reservesPrior); + require(borrowRateMantissa <= borrowRateMaxMantissa, "borrow rate is absurdly high"); + + /* Calculate the number of blocks elapsed since the last accrual */ + (MathError mathErr, uint blockDelta) = subUInt(currentBlockNumber, accrualBlockNumberPrior); + require(mathErr == MathError.NO_ERROR, "could not calculate block delta"); + + /* + * Calculate the interest accumulated into borrows and reserves and the new index: + * simpleInterestFactor = borrowRate * blockDelta + * interestAccumulated = simpleInterestFactor * totalBorrows + * totalBorrowsNew = interestAccumulated + totalBorrows + * totalReservesNew = interestAccumulated * reserveFactor + totalReserves + * borrowIndexNew = simpleInterestFactor * borrowIndex + borrowIndex + */ + + Exp memory simpleInterestFactor; + uint interestAccumulated; + uint totalBorrowsNew; + uint totalReservesNew; + uint borrowIndexNew; + + (mathErr, simpleInterestFactor) = mulScalar(Exp({mantissa: borrowRateMantissa}), blockDelta); + if (mathErr != MathError.NO_ERROR) { + return failOpaque(Error.MATH_ERROR, FailureInfo.ACCRUE_INTEREST_SIMPLE_INTEREST_FACTOR_CALCULATION_FAILED, uint(mathErr)); + } + + (mathErr, interestAccumulated) = mulScalarTruncate(simpleInterestFactor, borrowsPrior); + if (mathErr != MathError.NO_ERROR) { + return failOpaque(Error.MATH_ERROR, FailureInfo.ACCRUE_INTEREST_ACCUMULATED_INTEREST_CALCULATION_FAILED, uint(mathErr)); + } + + (mathErr, totalBorrowsNew) = addUInt(interestAccumulated, borrowsPrior); + if (mathErr != MathError.NO_ERROR) { + return failOpaque(Error.MATH_ERROR, FailureInfo.ACCRUE_INTEREST_NEW_TOTAL_BORROWS_CALCULATION_FAILED, uint(mathErr)); + } + + (mathErr, totalReservesNew) = mulScalarTruncateAddUInt(Exp({mantissa: reserveFactorMantissa}), interestAccumulated, reservesPrior); + if (mathErr != MathError.NO_ERROR) { + return failOpaque(Error.MATH_ERROR, FailureInfo.ACCRUE_INTEREST_NEW_TOTAL_RESERVES_CALCULATION_FAILED, uint(mathErr)); + } + + (mathErr, borrowIndexNew) = mulScalarTruncateAddUInt(simpleInterestFactor, borrowIndexPrior, borrowIndexPrior); + if (mathErr != MathError.NO_ERROR) { + return failOpaque(Error.MATH_ERROR, FailureInfo.ACCRUE_INTEREST_NEW_BORROW_INDEX_CALCULATION_FAILED, uint(mathErr)); + } + + ///////////////////////// + // EFFECTS & INTERACTIONS + // (No safe failures beyond this point) + + /* We write the previously calculated values into storage */ + accrualBlockNumber = currentBlockNumber; + borrowIndex = borrowIndexNew; + totalBorrows = totalBorrowsNew; + totalReserves = totalReservesNew; + + /* We emit an AccrueInterest event */ + emit AccrueInterest(cashPrior, interestAccumulated, borrowIndexNew, totalBorrowsNew); + + return uint(Error.NO_ERROR); + } + + /** + * @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, uint) An error code (0=success, otherwise a failure, see ErrorReporter.sol), and the actual mint amount. + */ + function mintInternal(uint mintAmount) internal nonReentrant returns (uint, uint) { + uint error = accrueInterest(); + if (error != uint(Error.NO_ERROR)) { + // accrueInterest emits logs on errors, but we still want to log the fact that an attempted borrow failed + return (fail(Error(error), FailureInfo.MINT_ACCRUE_INTEREST_FAILED), 0); + } + // mintFresh emits the actual Mint event if successful and logs on errors, so we don't need to + return mintFresh(msg.sender, mintAmount); + } + + struct MintLocalVars { + Error err; + MathError mathErr; + uint exchangeRateMantissa; + uint mintTokens; + uint totalSupplyNew; + uint accountTokensNew; + uint actualMintAmount; + } + + /** + * @notice User supplies assets into the market and receives cTokens in exchange + * @dev Assumes interest has already been accrued up to the current block + * @param minter The address of the account which is supplying the assets + * @param mintAmount The amount of the underlying asset to supply + * @return (uint, uint) An error code (0=success, otherwise a failure, see ErrorReporter.sol), and the actual mint amount. + */ + function mintFresh(address minter, uint mintAmount) internal returns (uint, uint) { + /* Fail if mint not allowed */ + uint allowed = comptroller.mintAllowed(address(this), minter, mintAmount); + if (allowed != 0) { + return (failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.MINT_COMPTROLLER_REJECTION, allowed), 0); + } + + /* Verify market's block number equals current block number */ + if (accrualBlockNumber != getBlockNumber()) { + return (fail(Error.MARKET_NOT_FRESH, FailureInfo.MINT_FRESHNESS_CHECK), 0); + } + + MintLocalVars memory vars; + + (vars.mathErr, vars.exchangeRateMantissa) = exchangeRateStoredInternal(); + if (vars.mathErr != MathError.NO_ERROR) { + return (failOpaque(Error.MATH_ERROR, FailureInfo.MINT_EXCHANGE_RATE_READ_FAILED, uint(vars.mathErr)), 0); + } + + ///////////////////////// + // EFFECTS & INTERACTIONS + // (No safe failures beyond this point) + + /* + * We call `doTransferIn` for the minter and the mintAmount. + * Note: The cToken must handle variations between ERC-20 and ETH underlying. + * `doTransferIn` reverts if anything goes wrong, since we can't be sure if + * side-effects occurred. The function returns the amount actually transferred, + * in case of a fee. On success, the cToken holds an additional `actualMintAmount` + * of cash. + */ + vars.actualMintAmount = doTransferIn(minter, mintAmount); + + /* + * We get the current exchange rate and calculate the number of cTokens to be minted: + * mintTokens = actualMintAmount / exchangeRate + */ + + (vars.mathErr, vars.mintTokens) = divScalarByExpTruncate(vars.actualMintAmount, Exp({mantissa: vars.exchangeRateMantissa})); + require(vars.mathErr == MathError.NO_ERROR, "MINT_EXCHANGE_CALCULATION_FAILED"); + + /* + * We calculate the new total supply of cTokens and minter token balance, checking for overflow: + * totalSupplyNew = totalSupply + mintTokens + * accountTokensNew = accountTokens[minter] + mintTokens + */ + (vars.mathErr, vars.totalSupplyNew) = addUInt(totalSupply, vars.mintTokens); + require(vars.mathErr == MathError.NO_ERROR, "MINT_NEW_TOTAL_SUPPLY_CALCULATION_FAILED"); + + (vars.mathErr, vars.accountTokensNew) = addUInt(accountTokens[minter], vars.mintTokens); + require(vars.mathErr == MathError.NO_ERROR, "MINT_NEW_ACCOUNT_BALANCE_CALCULATION_FAILED"); + + /* We write previously calculated values into storage */ + totalSupply = vars.totalSupplyNew; + accountTokens[minter] = vars.accountTokensNew; + + /* We emit a Mint event, and a Transfer event */ + emit Mint(minter, vars.actualMintAmount, vars.mintTokens); + emit Transfer(address(this), minter, vars.mintTokens); + + //jtoken event + emit JTokenBalance(minter, vars.accountTokensNew); + + /* We call the defense hook */ + comptroller.mintVerify(address(this), minter, vars.actualMintAmount, vars.mintTokens); + + //jtoken event + statusSnapShot(); + + return (uint(Error.NO_ERROR), vars.actualMintAmount); + } + + /** + * @notice Sender redeems cTokens in exchange for the underlying asset + * @dev Accrues interest whether or not the operation succeeds, unless reverted + * @param redeemTokens The number of cTokens to redeem into underlying + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function redeemInternal(uint redeemTokens) internal nonReentrant returns (uint) { + uint error = accrueInterest(); + if (error != uint(Error.NO_ERROR)) { + // accrueInterest emits logs on errors, but we still want to log the fact that an attempted redeem failed + return fail(Error(error), FailureInfo.REDEEM_ACCRUE_INTEREST_FAILED); + } + // redeemFresh emits redeem-specific logs on errors, so we don't need to + return redeemFresh(msg.sender, redeemTokens, 0); + } + + /** + * @notice Sender redeems cTokens in exchange for a specified amount of underlying asset + * @dev Accrues interest whether or not the operation succeeds, unless reverted + * @param redeemAmount The amount of underlying to receive from redeeming cTokens + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function redeemUnderlyingInternal(uint redeemAmount) internal nonReentrant returns (uint) { + uint error = accrueInterest(); + if (error != uint(Error.NO_ERROR)) { + // accrueInterest emits logs on errors, but we still want to log the fact that an attempted redeem failed + return fail(Error(error), FailureInfo.REDEEM_ACCRUE_INTEREST_FAILED); + } + // redeemFresh emits redeem-specific logs on errors, so we don't need to + return redeemFresh(msg.sender, 0, redeemAmount); + } + + struct RedeemLocalVars { + Error err; + MathError mathErr; + uint exchangeRateMantissa; + uint redeemTokens; + uint redeemAmount; + uint totalSupplyNew; + uint accountTokensNew; + } + + /** + * @notice User redeems cTokens in exchange for the underlying asset + * @dev Assumes interest has already been accrued up to the current block + * @param redeemer The address of the account which is redeeming the tokens + * @param redeemTokensIn The number of cTokens to redeem into underlying (only one of redeemTokensIn or redeemAmountIn may be non-zero) + * @param redeemAmountIn The number of underlying tokens to receive from redeeming cTokens (only one of redeemTokensIn or redeemAmountIn may be non-zero) + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function redeemFresh(address payable redeemer, uint redeemTokensIn, uint redeemAmountIn) internal returns (uint) { + require(redeemTokensIn == 0 || redeemAmountIn == 0, "one of redeemTokensIn or redeemAmountIn must be zero"); + + RedeemLocalVars memory vars; + + /* exchangeRate = invoke Exchange Rate Stored() */ + (vars.mathErr, vars.exchangeRateMantissa) = exchangeRateStoredInternal(); + if (vars.mathErr != MathError.NO_ERROR) { + return failOpaque(Error.MATH_ERROR, FailureInfo.REDEEM_EXCHANGE_RATE_READ_FAILED, uint(vars.mathErr)); + } + + /* If redeemTokensIn > 0: */ + if (redeemTokensIn > 0) { + /* + * We calculate the exchange rate and the amount of underlying to be redeemed: + * redeemTokens = redeemTokensIn + * redeemAmount = redeemTokensIn x exchangeRateCurrent + */ + vars.redeemTokens = redeemTokensIn; + + (vars.mathErr, vars.redeemAmount) = mulScalarTruncate(Exp({mantissa: vars.exchangeRateMantissa}), redeemTokensIn); + if (vars.mathErr != MathError.NO_ERROR) { + return failOpaque(Error.MATH_ERROR, FailureInfo.REDEEM_EXCHANGE_TOKENS_CALCULATION_FAILED, uint(vars.mathErr)); + } + } else { + /* + * We get the current exchange rate and calculate the amount to be redeemed: + * redeemTokens = redeemAmountIn / exchangeRate + * redeemAmount = redeemAmountIn + */ + + (vars.mathErr, vars.redeemTokens) = divScalarByExpTruncate(redeemAmountIn, Exp({mantissa: vars.exchangeRateMantissa})); + if (vars.mathErr != MathError.NO_ERROR) { + return failOpaque(Error.MATH_ERROR, FailureInfo.REDEEM_EXCHANGE_AMOUNT_CALCULATION_FAILED, uint(vars.mathErr)); + } + + vars.redeemAmount = redeemAmountIn; + } + + /* Fail if redeem not allowed */ + uint allowed = comptroller.redeemAllowed(address(this), redeemer, vars.redeemTokens); + if (allowed != 0) { + return failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.REDEEM_COMPTROLLER_REJECTION, allowed); + } + + /* Verify market's block number equals current block number */ + if (accrualBlockNumber != getBlockNumber()) { + return fail(Error.MARKET_NOT_FRESH, FailureInfo.REDEEM_FRESHNESS_CHECK); + } + + /* + * We calculate the new total supply and redeemer balance, checking for underflow: + * totalSupplyNew = totalSupply - redeemTokens + * accountTokensNew = accountTokens[redeemer] - redeemTokens + */ + (vars.mathErr, vars.totalSupplyNew) = subUInt(totalSupply, vars.redeemTokens); + if (vars.mathErr != MathError.NO_ERROR) { + return failOpaque(Error.MATH_ERROR, FailureInfo.REDEEM_NEW_TOTAL_SUPPLY_CALCULATION_FAILED, uint(vars.mathErr)); + } + + (vars.mathErr, vars.accountTokensNew) = subUInt(accountTokens[redeemer], vars.redeemTokens); + if (vars.mathErr != MathError.NO_ERROR) { + return failOpaque(Error.MATH_ERROR, FailureInfo.REDEEM_NEW_ACCOUNT_BALANCE_CALCULATION_FAILED, uint(vars.mathErr)); + } + + /* Fail gracefully if protocol has insufficient cash */ + if (getCashPrior() < vars.redeemAmount) { + return fail(Error.TOKEN_INSUFFICIENT_CASH, FailureInfo.REDEEM_TRANSFER_OUT_NOT_POSSIBLE); + } + + ///////////////////////// + // EFFECTS & INTERACTIONS + // (No safe failures beyond this point) + + /* + * We invoke doTransferOut for the redeemer and the redeemAmount. + * Note: The cToken must handle variations between ERC-20 and ETH underlying. + * On success, the cToken has redeemAmount less of cash. + * doTransferOut reverts if anything goes wrong, since we can't be sure if side effects occurred. + */ + doTransferOut(redeemer, vars.redeemAmount); + + /* We write previously calculated values into storage */ + totalSupply = vars.totalSupplyNew; + accountTokens[redeemer] = vars.accountTokensNew; + + /* We emit a Transfer event, and a Redeem event */ + emit Transfer(redeemer, address(this), vars.redeemTokens); + emit Redeem(redeemer, vars.redeemAmount, vars.redeemTokens); + + //jtoken event + emit JTokenBalance(redeemer, vars.accountTokensNew); + + /* We call the defense hook */ + comptroller.redeemVerify(address(this), redeemer, vars.redeemAmount, vars.redeemTokens); + //jtoken event + statusSnapShot(); + return uint(Error.NO_ERROR); + } + + /** + * @notice Sender borrows assets from the protocol to their own address + * @param borrowAmount The amount of the underlying asset to borrow + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function borrowInternal(uint borrowAmount) internal nonReentrant returns (uint) { + uint error = accrueInterest(); + if (error != uint(Error.NO_ERROR)) { + // accrueInterest emits logs on errors, but we still want to log the fact that an attempted borrow failed + return fail(Error(error), FailureInfo.BORROW_ACCRUE_INTEREST_FAILED); + } + // borrowFresh emits borrow-specific logs on errors, so we don't need to + return borrowFresh(msg.sender, borrowAmount); + } + + struct BorrowLocalVars { + MathError mathErr; + uint accountBorrows; + uint accountBorrowsNew; + uint totalBorrowsNew; + } + + /** + * @notice Users borrow assets from the protocol to their own address + * @param borrowAmount The amount of the underlying asset to borrow + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function borrowFresh(address payable borrower, uint borrowAmount) internal returns (uint) { + /* Fail if borrow not allowed */ + uint allowed = comptroller.borrowAllowed(address(this), borrower, borrowAmount); + if (allowed != 0) { + return failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.BORROW_COMPTROLLER_REJECTION, allowed); + } + + /* Verify market's block number equals current block number */ + if (accrualBlockNumber != getBlockNumber()) { + return fail(Error.MARKET_NOT_FRESH, FailureInfo.BORROW_FRESHNESS_CHECK); + } + + /* Fail gracefully if protocol has insufficient underlying cash */ + if (getCashPrior() < borrowAmount) { + return fail(Error.TOKEN_INSUFFICIENT_CASH, FailureInfo.BORROW_CASH_NOT_AVAILABLE); + } + + BorrowLocalVars memory vars; + + /* + * We calculate the new borrower and total borrow balances, failing on overflow: + * accountBorrowsNew = accountBorrows + borrowAmount + * totalBorrowsNew = totalBorrows + borrowAmount + */ + (vars.mathErr, vars.accountBorrows) = borrowBalanceStoredInternal(borrower); + if (vars.mathErr != MathError.NO_ERROR) { + return failOpaque(Error.MATH_ERROR, FailureInfo.BORROW_ACCUMULATED_BALANCE_CALCULATION_FAILED, uint(vars.mathErr)); + } + + (vars.mathErr, vars.accountBorrowsNew) = addUInt(vars.accountBorrows, borrowAmount); + if (vars.mathErr != MathError.NO_ERROR) { + return failOpaque(Error.MATH_ERROR, FailureInfo.BORROW_NEW_ACCOUNT_BORROW_BALANCE_CALCULATION_FAILED, uint(vars.mathErr)); + } + + (vars.mathErr, vars.totalBorrowsNew) = addUInt(totalBorrows, borrowAmount); + if (vars.mathErr != MathError.NO_ERROR) { + return failOpaque(Error.MATH_ERROR, FailureInfo.BORROW_NEW_TOTAL_BALANCE_CALCULATION_FAILED, uint(vars.mathErr)); + } + + ///////////////////////// + // EFFECTS & INTERACTIONS + // (No safe failures beyond this point) + + /* + * We invoke doTransferOut for the borrower and the borrowAmount. + * Note: The cToken must handle variations between ERC-20 and ETH underlying. + * On success, the cToken borrowAmount less of cash. + * doTransferOut reverts if anything goes wrong, since we can't be sure if side effects occurred. + */ + doTransferOut(borrower, borrowAmount); + + /* We write the previously calculated values into storage */ + accountBorrows[borrower].principal = vars.accountBorrowsNew; + accountBorrows[borrower].interestIndex = borrowIndex; + totalBorrows = vars.totalBorrowsNew; + + /* We emit a Borrow event */ + emit Borrow(borrower, borrowAmount, vars.accountBorrowsNew, vars.totalBorrowsNew, borrowIndex); + //jtoken event + statusSnapShot(); + /* We call the defense hook */ + comptroller.borrowVerify(address(this), borrower, borrowAmount); + + return uint(Error.NO_ERROR); + } + + /** + * @notice Sender repays their own borrow + * @param repayAmount The amount to repay + * @return (uint, uint) An error code (0=success, otherwise a failure, see ErrorReporter.sol), and the actual repayment amount. + */ + function repayBorrowInternal(uint repayAmount) internal nonReentrant returns (uint, uint) { + uint error = accrueInterest(); + if (error != uint(Error.NO_ERROR)) { + // accrueInterest emits logs on errors, but we still want to log the fact that an attempted borrow failed + return (fail(Error(error), FailureInfo.REPAY_BORROW_ACCRUE_INTEREST_FAILED), 0); + } + // repayBorrowFresh emits repay-borrow-specific logs on errors, so we don't need to + return repayBorrowFresh(msg.sender, msg.sender, repayAmount); + } + + /** + * @notice Sender repays a borrow belonging to borrower + * @param borrower the account with the debt being payed off + * @param repayAmount The amount to repay + * @return (uint, uint) An error code (0=success, otherwise a failure, see ErrorReporter.sol), and the actual repayment amount. + */ + function repayBorrowBehalfInternal(address borrower, uint repayAmount) internal nonReentrant returns (uint, uint) { + uint error = accrueInterest(); + if (error != uint(Error.NO_ERROR)) { + // accrueInterest emits logs on errors, but we still want to log the fact that an attempted borrow failed + return (fail(Error(error), FailureInfo.REPAY_BEHALF_ACCRUE_INTEREST_FAILED), 0); + } + // repayBorrowFresh emits repay-borrow-specific logs on errors, so we don't need to + return repayBorrowFresh(msg.sender, borrower, repayAmount); + } + + struct RepayBorrowLocalVars { + Error err; + MathError mathErr; + uint repayAmount; + uint borrowerIndex; + uint accountBorrows; + uint accountBorrowsNew; + uint totalBorrowsNew; + uint actualRepayAmount; + } + + /** + * @notice Borrows are repaid by another user (possibly the borrower). + * @param payer the account paying off the borrow + * @param borrower the account with the debt being payed off + * @param repayAmount the amount of undelrying tokens being returned + * @return (uint, uint) An error code (0=success, otherwise a failure, see ErrorReporter.sol), and the actual repayment amount. + */ + function repayBorrowFresh(address payer, address borrower, uint repayAmount) internal returns (uint, uint) { + /* Fail if repayBorrow not allowed */ + uint allowed = comptroller.repayBorrowAllowed(address(this), payer, borrower, repayAmount); + if (allowed != 0) { + return (failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.REPAY_BORROW_COMPTROLLER_REJECTION, allowed), 0); + } + + /* Verify market's block number equals current block number */ + if (accrualBlockNumber != getBlockNumber()) { + return (fail(Error.MARKET_NOT_FRESH, FailureInfo.REPAY_BORROW_FRESHNESS_CHECK), 0); + } + + RepayBorrowLocalVars memory vars; + + /* We remember the original borrowerIndex for verification purposes */ + vars.borrowerIndex = accountBorrows[borrower].interestIndex; + + /* We fetch the amount the borrower owes, with accumulated interest */ + (vars.mathErr, vars.accountBorrows) = borrowBalanceStoredInternal(borrower); + if (vars.mathErr != MathError.NO_ERROR) { + return (failOpaque(Error.MATH_ERROR, FailureInfo.REPAY_BORROW_ACCUMULATED_BALANCE_CALCULATION_FAILED, uint(vars.mathErr)), 0); + } + + /* If repayAmount == -1, repayAmount = accountBorrows */ + if (repayAmount == uint(-1)) { + vars.repayAmount = vars.accountBorrows; + } else { + vars.repayAmount = repayAmount; + } + + ///////////////////////// + // EFFECTS & INTERACTIONS + // (No safe failures beyond this point) + + /* + * We call doTransferIn for the payer and the repayAmount + * Note: The cToken must handle variations between ERC-20 and ETH underlying. + * On success, the cToken holds an additional repayAmount of cash. + * doTransferIn reverts if anything goes wrong, since we can't be sure if side effects occurred. + * it returns the amount actually transferred, in case of a fee. + */ + vars.actualRepayAmount = doTransferIn(payer, vars.repayAmount); + + /* + * We calculate the new borrower and total borrow balances, failing on underflow: + * accountBorrowsNew = accountBorrows - actualRepayAmount + * totalBorrowsNew = totalBorrows - actualRepayAmount + */ + (vars.mathErr, vars.accountBorrowsNew) = subUInt(vars.accountBorrows, vars.actualRepayAmount); + require(vars.mathErr == MathError.NO_ERROR, "REPAY_BORROW_NEW_ACCOUNT_BORROW_BALANCE_CALCULATION_FAILED"); + + (vars.mathErr, vars.totalBorrowsNew) = subUInt(totalBorrows, vars.actualRepayAmount); + require(vars.mathErr == MathError.NO_ERROR, "REPAY_BORROW_NEW_TOTAL_BALANCE_CALCULATION_FAILED"); + + /* We write the previously calculated values into storage */ + accountBorrows[borrower].principal = vars.accountBorrowsNew; + accountBorrows[borrower].interestIndex = borrowIndex; + totalBorrows = vars.totalBorrowsNew; + + /* We emit a RepayBorrow event */ + emit RepayBorrow(payer, borrower, vars.actualRepayAmount, vars.accountBorrowsNew, vars.totalBorrowsNew, borrowIndex); + + /* We call the defense hook */ + comptroller.repayBorrowVerify(address(this), payer, borrower, vars.actualRepayAmount, vars.borrowerIndex); + + //jtoken event + statusSnapShot(); + + return (uint(Error.NO_ERROR), vars.actualRepayAmount); + } + + /** + * @notice The sender liquidates the borrowers collateral. + * The collateral seized is transferred to the liquidator. + * @param borrower The borrower of this cToken to be liquidated + * @param cTokenCollateral The market in which to seize collateral from the borrower + * @param repayAmount The amount of the underlying borrowed asset to repay + * @return (uint, uint) An error code (0=success, otherwise a failure, see ErrorReporter.sol), and the actual repayment amount. + */ + function liquidateBorrowInternal(address borrower, uint repayAmount, CTokenInterface cTokenCollateral) internal nonReentrant returns (uint, uint) { + uint error = accrueInterest(); + if (error != uint(Error.NO_ERROR)) { + // accrueInterest emits logs on errors, but we still want to log the fact that an attempted liquidation failed + return (fail(Error(error), FailureInfo.LIQUIDATE_ACCRUE_BORROW_INTEREST_FAILED), 0); + } + + error = cTokenCollateral.accrueInterest(); + if (error != uint(Error.NO_ERROR)) { + // accrueInterest emits logs on errors, but we still want to log the fact that an attempted liquidation failed + return (fail(Error(error), FailureInfo.LIQUIDATE_ACCRUE_COLLATERAL_INTEREST_FAILED), 0); + } + + // liquidateBorrowFresh emits borrow-specific logs on errors, so we don't need to + return liquidateBorrowFresh(msg.sender, borrower, repayAmount, cTokenCollateral); + } + + /** + * @notice The liquidator liquidates the borrowers collateral. + * The collateral seized is transferred to the liquidator. + * @param borrower The borrower of this cToken to be liquidated + * @param liquidator The address repaying the borrow and seizing collateral + * @param cTokenCollateral The market in which to seize collateral from the borrower + * @param repayAmount The amount of the underlying borrowed asset to repay + * @return (uint, uint) An error code (0=success, otherwise a failure, see ErrorReporter.sol), and the actual repayment amount. + */ + function liquidateBorrowFresh(address liquidator, address borrower, uint repayAmount, CTokenInterface cTokenCollateral) internal returns (uint, uint) { + /* Fail if liquidate not allowed */ + uint allowed = comptroller.liquidateBorrowAllowed(address(this), address(cTokenCollateral), liquidator, borrower, repayAmount); + if (allowed != 0) { + return (failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.LIQUIDATE_COMPTROLLER_REJECTION, allowed), 0); + } + + /* Verify market's block number equals current block number */ + if (accrualBlockNumber != getBlockNumber()) { + return (fail(Error.MARKET_NOT_FRESH, FailureInfo.LIQUIDATE_FRESHNESS_CHECK), 0); + } + + /* Verify cTokenCollateral market's block number equals current block number */ + if (cTokenCollateral.accrualBlockNumber() != getBlockNumber()) { + return (fail(Error.MARKET_NOT_FRESH, FailureInfo.LIQUIDATE_COLLATERAL_FRESHNESS_CHECK), 0); + } + + /* Fail if borrower = liquidator */ + if (borrower == liquidator) { + return (fail(Error.INVALID_ACCOUNT_PAIR, FailureInfo.LIQUIDATE_LIQUIDATOR_IS_BORROWER), 0); + } + + /* Fail if repayAmount = 0 */ + if (repayAmount == 0) { + return (fail(Error.INVALID_CLOSE_AMOUNT_REQUESTED, FailureInfo.LIQUIDATE_CLOSE_AMOUNT_IS_ZERO), 0); + } + + /* Fail if repayAmount = -1 */ + if (repayAmount == uint(-1)) { + return (fail(Error.INVALID_CLOSE_AMOUNT_REQUESTED, FailureInfo.LIQUIDATE_CLOSE_AMOUNT_IS_UINT_MAX), 0); + } + + + /* Fail if repayBorrow fails */ + (uint repayBorrowError, uint actualRepayAmount) = repayBorrowFresh(liquidator, borrower, repayAmount); + if (repayBorrowError != uint(Error.NO_ERROR)) { + return (fail(Error(repayBorrowError), FailureInfo.LIQUIDATE_REPAY_BORROW_FRESH_FAILED), 0); + } + + ///////////////////////// + // EFFECTS & INTERACTIONS + // (No safe failures beyond this point) + + /* We calculate the number of collateral tokens that will be seized */ + (uint amountSeizeError, uint seizeTokens) = comptroller.liquidateCalculateSeizeTokens(address(this), address(cTokenCollateral), actualRepayAmount); + require(amountSeizeError == uint(Error.NO_ERROR), "LIQUIDATE_COMPTROLLER_CALCULATE_AMOUNT_SEIZE_FAILED"); + + /* Revert if borrower collateral token balance < seizeTokens */ + require(cTokenCollateral.balanceOf(borrower) >= seizeTokens, "LIQUIDATE_SEIZE_TOO_MUCH"); + + // If this is also the collateral, run seizeInternal to avoid re-entrancy, otherwise make an external call + uint seizeError; + if (address(cTokenCollateral) == address(this)) { + seizeError = seizeInternal(address(this), liquidator, borrower, seizeTokens); + } else { + seizeError = cTokenCollateral.seize(liquidator, borrower, seizeTokens); + } + + /* Revert if seize tokens fails (since we cannot be sure of side effects) */ + require(seizeError == uint(Error.NO_ERROR), "token seizure failed"); + + /* We emit a LiquidateBorrow event */ + emit LiquidateBorrow(liquidator, borrower, actualRepayAmount, address(cTokenCollateral), seizeTokens); + + /* We call the defense hook */ + comptroller.liquidateBorrowVerify(address(this), address(cTokenCollateral), liquidator, borrower, actualRepayAmount, seizeTokens); + + //jtoken event + statusSnapShot(); + + return (uint(Error.NO_ERROR), actualRepayAmount); + } + + /** + * @notice Transfers collateral tokens (this market) to the liquidator. + * @dev Will fail unless called by another cToken during the process of liquidation. + * Its absolutely critical to use msg.sender as the borrowed cToken and not a parameter. + * @param liquidator The account receiving seized collateral + * @param borrower The account having collateral seized + * @param seizeTokens The number of cTokens to seize + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function seize(address liquidator, address borrower, uint seizeTokens) external nonReentrant returns (uint) { + return seizeInternal(msg.sender, liquidator, borrower, seizeTokens); + } + + /** + * @notice Transfers collateral tokens (this market) to the liquidator. + * @dev Called only during an in-kind liquidation, or by liquidateBorrow during the liquidation of another CToken. + * Its absolutely critical to use msg.sender as the seizer cToken and not a parameter. + * @param seizerToken The contract seizing the collateral (i.e. borrowed cToken) + * @param liquidator The account receiving seized collateral + * @param borrower The account having collateral seized + * @param seizeTokens The number of cTokens to seize + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function seizeInternal(address seizerToken, address liquidator, address borrower, uint seizeTokens) internal returns (uint) { + /* Fail if seize not allowed */ + uint allowed = comptroller.seizeAllowed(address(this), seizerToken, liquidator, borrower, seizeTokens); + if (allowed != 0) { + return failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.LIQUIDATE_SEIZE_COMPTROLLER_REJECTION, allowed); + } + + /* Fail if borrower = liquidator */ + if (borrower == liquidator) { + return fail(Error.INVALID_ACCOUNT_PAIR, FailureInfo.LIQUIDATE_SEIZE_LIQUIDATOR_IS_BORROWER); + } + + MathError mathErr; + uint borrowerTokensNew; + uint liquidatorTokensNew; + + /* + * We calculate the new borrower and liquidator token balances, failing on underflow/overflow: + * borrowerTokensNew = accountTokens[borrower] - seizeTokens + * liquidatorTokensNew = accountTokens[liquidator] + seizeTokens + */ + (mathErr, borrowerTokensNew) = subUInt(accountTokens[borrower], seizeTokens); + if (mathErr != MathError.NO_ERROR) { + return failOpaque(Error.MATH_ERROR, FailureInfo.LIQUIDATE_SEIZE_BALANCE_DECREMENT_FAILED, uint(mathErr)); + } + + (mathErr, liquidatorTokensNew) = addUInt(accountTokens[liquidator], seizeTokens); + if (mathErr != MathError.NO_ERROR) { + return failOpaque(Error.MATH_ERROR, FailureInfo.LIQUIDATE_SEIZE_BALANCE_INCREMENT_FAILED, uint(mathErr)); + } + + ///////////////////////// + // EFFECTS & INTERACTIONS + // (No safe failures beyond this point) + + /* We write the previously calculated values into storage */ + accountTokens[borrower] = borrowerTokensNew; + accountTokens[liquidator] = liquidatorTokensNew; + + /* Emit a Transfer event */ + emit Transfer(borrower, liquidator, seizeTokens); + + emit JTokenBalance(borrower, borrowerTokensNew); + emit JTokenBalance(liquidator, liquidatorTokensNew); + + /* We call the defense hook */ + comptroller.seizeVerify(address(this), seizerToken, liquidator, borrower, seizeTokens); + + return uint(Error.NO_ERROR); + } + + + function statusSnapShot() internal { + uint cash = getCash(); + uint borrowRate = (totalSupply == 0 ? 0 : interestRateModel.getBorrowRate(cash, totalBorrows, totalReserves)); + emit JTokenStatus(cash, totalBorrows, totalReserves, totalSupply, borrowRate, borrowIndex, reserveFactorMantissa); + } + + /*** Admin Functions ***/ + + /** + * @notice Begins transfer of admin rights. The newPendingAdmin must call `_acceptAdmin` to finalize the transfer. + * @dev Admin function to begin change of admin. The newPendingAdmin must call `_acceptAdmin` to finalize the transfer. + * @param newPendingAdmin New pending admin. + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function _setPendingAdmin(address payable newPendingAdmin) external returns (uint) { + // Check caller = admin + if (msg.sender != admin) { + return fail(Error.UNAUTHORIZED, FailureInfo.SET_PENDING_ADMIN_OWNER_CHECK); + } + + // Save current value, if any, for inclusion in log + address oldPendingAdmin = pendingAdmin; + + // Store pendingAdmin with value newPendingAdmin + pendingAdmin = newPendingAdmin; + + // Emit NewPendingAdmin(oldPendingAdmin, newPendingAdmin) + emit NewPendingAdmin(oldPendingAdmin, newPendingAdmin); + + return uint(Error.NO_ERROR); + } + + function _setReserveAdmin(address payable newReserveAdmin) external returns (uint) { + // Check caller = admin + if (msg.sender != admin) { + return fail(Error.UNAUTHORIZED, FailureInfo.SET_PENDING_ADMIN_OWNER_CHECK); + } + // Save current value, if any, for inclusion in log + address oldReserveAdmin = reserveAdmin; + + reserveAdmin = newReserveAdmin; + + emit NewReserveAdmin(oldReserveAdmin, newReserveAdmin); + + return uint(Error.NO_ERROR); + } + + /** + * @notice Accepts transfer of admin rights. msg.sender must be pendingAdmin + * @dev Admin function for pending admin to accept role and update admin + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function _acceptAdmin() external returns (uint) { + // Check caller is pendingAdmin and pendingAdmin ≠ address(0) + if (msg.sender != pendingAdmin || msg.sender == address(0)) { + return fail(Error.UNAUTHORIZED, FailureInfo.ACCEPT_ADMIN_PENDING_ADMIN_CHECK); + } + + // Save current values for inclusion in log + address oldAdmin = admin; + address oldPendingAdmin = pendingAdmin; + + // Store admin with value pendingAdmin + admin = pendingAdmin; + + // Clear the pending value + pendingAdmin = address(0); + + emit NewAdmin(oldAdmin, admin); + emit NewPendingAdmin(oldPendingAdmin, pendingAdmin); + + return uint(Error.NO_ERROR); + } + + /** + * @notice Sets a new comptroller for the market + * @dev Admin function to set a new comptroller + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function _setComptroller(ComptrollerInterface newComptroller) public returns (uint) { + // Check caller is admin + if (msg.sender != admin) { + return fail(Error.UNAUTHORIZED, FailureInfo.SET_COMPTROLLER_OWNER_CHECK); + } + + ComptrollerInterface oldComptroller = comptroller; + // Ensure invoke comptroller.isComptroller() returns true + require(newComptroller.isComptroller(), "marker method returned false"); + + // Set market's comptroller to newComptroller + comptroller = newComptroller; + + // Emit NewComptroller(oldComptroller, newComptroller) + emit NewComptroller(oldComptroller, newComptroller); + + return uint(Error.NO_ERROR); + } + + /** + * @notice accrues interest and sets a new reserve factor for the protocol using _setReserveFactorFresh + * @dev Admin function to accrue interest and set a new reserve factor + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function _setReserveFactor(uint newReserveFactorMantissa) external nonReentrant returns (uint) { + uint error = accrueInterest(); + if (error != uint(Error.NO_ERROR)) { + // accrueInterest emits logs on errors, but on top of that we want to log the fact that an attempted reserve factor change failed. + return fail(Error(error), FailureInfo.SET_RESERVE_FACTOR_ACCRUE_INTEREST_FAILED); + } + // _setReserveFactorFresh emits reserve-factor-specific logs on errors, so we don't need to. + return _setReserveFactorFresh(newReserveFactorMantissa); + } + + /** + * @notice Sets a new reserve factor for the protocol (*requires fresh interest accrual) + * @dev Admin function to set a new reserve factor + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function _setReserveFactorFresh(uint newReserveFactorMantissa) internal returns (uint) { + // Check caller is admin + if (msg.sender != admin) { + return fail(Error.UNAUTHORIZED, FailureInfo.SET_RESERVE_FACTOR_ADMIN_CHECK); + } + + // Verify market's block number equals current block number + if (accrualBlockNumber != getBlockNumber()) { + return fail(Error.MARKET_NOT_FRESH, FailureInfo.SET_RESERVE_FACTOR_FRESH_CHECK); + } + + // Check newReserveFactor ≤ maxReserveFactor + if (newReserveFactorMantissa > reserveFactorMaxMantissa) { + return fail(Error.BAD_INPUT, FailureInfo.SET_RESERVE_FACTOR_BOUNDS_CHECK); + } + + uint oldReserveFactorMantissa = reserveFactorMantissa; + reserveFactorMantissa = newReserveFactorMantissa; + + emit NewReserveFactor(oldReserveFactorMantissa, newReserveFactorMantissa); + + return uint(Error.NO_ERROR); + } + + /** + * @notice Accrues interest and reduces reserves by transferring from msg.sender + * @param addAmount Amount of addition to reserves + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function _addReservesInternal(uint addAmount) internal nonReentrant returns (uint) { + uint error = accrueInterest(); + if (error != uint(Error.NO_ERROR)) { + // accrueInterest emits logs on errors, but on top of that we want to log the fact that an attempted reduce reserves failed. + return fail(Error(error), FailureInfo.ADD_RESERVES_ACCRUE_INTEREST_FAILED); + } + + // _addReservesFresh emits reserve-addition-specific logs on errors, so we don't need to. + (error, ) = _addReservesFresh(addAmount); + return error; + } + + /** + * @notice Add reserves by transferring from caller + * @dev Requires fresh interest accrual + * @param addAmount Amount of addition to reserves + * @return (uint, uint) An error code (0=success, otherwise a failure (see ErrorReporter.sol for details)) and the actual amount added, net token fees + */ + function _addReservesFresh(uint addAmount) internal returns (uint, uint) { + // totalReserves + actualAddAmount + uint totalReservesNew; + uint actualAddAmount; + + // We fail gracefully unless market's block number equals current block number + if (accrualBlockNumber != getBlockNumber()) { + return (fail(Error.MARKET_NOT_FRESH, FailureInfo.ADD_RESERVES_FRESH_CHECK), actualAddAmount); + } + + ///////////////////////// + // EFFECTS & INTERACTIONS + // (No safe failures beyond this point) + + /* + * We call doTransferIn for the caller and the addAmount + * Note: The cToken must handle variations between ERC-20 and ETH underlying. + * On success, the cToken holds an additional addAmount of cash. + * doTransferIn reverts if anything goes wrong, since we can't be sure if side effects occurred. + * it returns the amount actually transferred, in case of a fee. + */ + + actualAddAmount = doTransferIn(msg.sender, addAmount); + + totalReservesNew = totalReserves + actualAddAmount; + + /* Revert on overflow */ + require(totalReservesNew >= totalReserves, "add reserves unexpected overflow"); + + // Store reserves[n+1] = reserves[n] + actualAddAmount + totalReserves = totalReservesNew; + + /* Emit NewReserves(admin, actualAddAmount, reserves[n+1]) */ + emit ReservesAdded(msg.sender, actualAddAmount, totalReservesNew); + + /* Return (NO_ERROR, actualAddAmount) */ + return (uint(Error.NO_ERROR), actualAddAmount); + } + + + /** + * @notice Accrues interest and reduces reserves by transferring to admin + * @param reduceAmount Amount of reduction to reserves + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function _reduceReserves(uint reduceAmount) external nonReentrant returns (uint) { + uint error = accrueInterest(); + if (error != uint(Error.NO_ERROR)) { + // accrueInterest emits logs on errors, but on top of that we want to log the fact that an attempted reduce reserves failed. + return fail(Error(error), FailureInfo.REDUCE_RESERVES_ACCRUE_INTEREST_FAILED); + } + // _reduceReservesFresh emits reserve-reduction-specific logs on errors, so we don't need to. + return _reduceReservesFresh(reduceAmount); + } + + /** + * @notice Reduces reserves by transferring to admin + * @dev Requires fresh interest accrual + * @param reduceAmount Amount of reduction to reserves + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function _reduceReservesFresh(uint reduceAmount) internal returns (uint) { + // totalReserves - reduceAmount + uint totalReservesNew; + + // Check caller is admin + if (msg.sender != reserveAdmin) { + return fail(Error.UNAUTHORIZED, FailureInfo.REDUCE_RESERVES_ADMIN_CHECK); + } + + // We fail gracefully unless market's block number equals current block number + if (accrualBlockNumber != getBlockNumber()) { + return fail(Error.MARKET_NOT_FRESH, FailureInfo.REDUCE_RESERVES_FRESH_CHECK); + } + + // Fail gracefully if protocol has insufficient underlying cash + if (getCashPrior() < reduceAmount) { + return fail(Error.TOKEN_INSUFFICIENT_CASH, FailureInfo.REDUCE_RESERVES_CASH_NOT_AVAILABLE); + } + + // Check reduceAmount ≤ reserves[n] (totalReserves) + if (reduceAmount > totalReserves) { + return fail(Error.BAD_INPUT, FailureInfo.REDUCE_RESERVES_VALIDATION); + } + + ///////////////////////// + // EFFECTS & INTERACTIONS + // (No safe failures beyond this point) + + totalReservesNew = totalReserves - reduceAmount; + // We checked reduceAmount <= totalReserves above, so this should never revert. + require(totalReservesNew <= totalReserves, "reduce reserves unexpected underflow"); + + // Store reserves[n+1] = reserves[n] - reduceAmount + totalReserves = totalReservesNew; + + // doTransferOut reverts if anything goes wrong, since we can't be sure if side effects occurred. + doTransferOut(reserveAdmin, reduceAmount); + + emit ReservesReduced(reserveAdmin, reduceAmount, totalReservesNew); + + return uint(Error.NO_ERROR); + } + + /** + * @notice accrues interest and updates the interest rate model using _setInterestRateModelFresh + * @dev Admin function to accrue interest and update the interest rate model + * @param newInterestRateModel the new interest rate model to use + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function _setInterestRateModel(InterestRateModel newInterestRateModel) public returns (uint) { + uint error = accrueInterest(); + if (error != uint(Error.NO_ERROR)) { + // accrueInterest emits logs on errors, but on top of that we want to log the fact that an attempted change of interest rate model failed + return fail(Error(error), FailureInfo.SET_INTEREST_RATE_MODEL_ACCRUE_INTEREST_FAILED); + } + // _setInterestRateModelFresh emits interest-rate-model-update-specific logs on errors, so we don't need to. + return _setInterestRateModelFresh(newInterestRateModel); + } + + /** + * @notice updates the interest rate model (*requires fresh interest accrual) + * @dev Admin function to update the interest rate model + * @param newInterestRateModel the new interest rate model to use + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function _setInterestRateModelFresh(InterestRateModel newInterestRateModel) internal returns (uint) { + + // Used to store old model for use in the event that is emitted on success + InterestRateModel oldInterestRateModel; + + // Check caller is admin + if (msg.sender != admin) { + return fail(Error.UNAUTHORIZED, FailureInfo.SET_INTEREST_RATE_MODEL_OWNER_CHECK); + } + + // We fail gracefully unless market's block number equals current block number + if (accrualBlockNumber != getBlockNumber()) { + return fail(Error.MARKET_NOT_FRESH, FailureInfo.SET_INTEREST_RATE_MODEL_FRESH_CHECK); + } + + // Track the market's current interest rate model + oldInterestRateModel = interestRateModel; + + // Ensure invoke newInterestRateModel.isInterestRateModel() returns true + require(newInterestRateModel.isInterestRateModel(), "marker method returned false"); + + // Set the interest rate model to newInterestRateModel + interestRateModel = newInterestRateModel; + + // Emit NewMarketInterestRateModel(oldInterestRateModel, newInterestRateModel) + emit NewMarketInterestRateModel(oldInterestRateModel, newInterestRateModel); + + return uint(Error.NO_ERROR); + } + + /*** Safe Token ***/ + + /** + * @notice Gets balance of this contract in terms of the underlying + * @dev This excludes the value of the current message, if any + * @return The quantity of underlying owned by this contract + */ + function getCashPrior() internal view returns (uint); + + /** + * @dev Performs a transfer in, reverting upon failure. Returns the amount actually transferred to the protocol, in case of a fee. + * This may revert due to insufficient balance or insufficient allowance. + */ + function doTransferIn(address from, uint amount) internal returns (uint); + + /** + * @dev Performs a transfer out, ideally returning an explanatory error code upon failure tather than reverting. + * If caller has not called checked protocol's balance, may revert due to insufficient cash held in the contract. + * If caller has checked protocol's balance, and verified it is >= amount, this should not revert in normal conditions. + */ + function doTransferOut(address payable to, uint amount) internal; + + + /*** Reentrancy Guard ***/ + + /** + * @dev Prevents a contract from calling itself, directly or indirectly. + */ + modifier nonReentrant() { + require(_notEntered, "re-entered"); + _notEntered = false; + _; + _notEntered = true; // get a gas-refund post-Istanbul + } +} diff --git a/contracts/CTokenERC777.sol b/contracts/CTokenERC777.sol new file mode 100644 index 0000000..58dc03c --- /dev/null +++ b/contracts/CTokenERC777.sol @@ -0,0 +1,1479 @@ +pragma solidity ^0.5.12; + +import "./ComptrollerInterface.sol"; +import "./CTokenInterfaces.sol"; +import "./ErrorReporter.sol"; +import "./Exponential.sol"; +import "./EIP20Interface.sol"; +import "./EIP20NonStandardInterface.sol"; +import "./InterestRateModel.sol"; + +/** + * @title Compound's CToken Contract + * @notice Abstract base for CTokens + * @author Compound + */ +contract CToken is CTokenInterface, Exponential, TokenErrorReporter { + /** + * @notice Initialize the money market + * @param comptroller_ The address of the Comptroller + * @param interestRateModel_ The address of the interest rate model + * @param initialExchangeRateMantissa_ The initial exchange rate, scaled by 1e18 + * @param name_ EIP-20 name of this token + * @param symbol_ EIP-20 symbol of this token + * @param decimals_ EIP-20 decimal precision of this token + */ + function initialize(ComptrollerInterface comptroller_, + InterestRateModel interestRateModel_, + uint initialExchangeRateMantissa_, + string memory name_, + string memory symbol_, + uint8 decimals_,uint256 newReserveFactorMantissa_) public { + require(msg.sender == admin, "only admin may initialize the market"); + require(accrualBlockNumber == 0 && borrowIndex == 0, "market may only be initialized once"); + + // Set initial exchange rate + initialExchangeRateMantissa = initialExchangeRateMantissa_; + require(initialExchangeRateMantissa > 0, "initial exchange rate must be greater than zero."); + + reserveFactorMantissa = newReserveFactorMantissa_; + + // Set the comptroller + uint err = _setComptroller(comptroller_); + require(err == uint(Error.NO_ERROR), "setting comptroller failed"); + + // Initialize block number and borrow index (block number mocks depend on comptroller being set) + accrualBlockNumber = getBlockNumber(); + borrowIndex = mantissaOne; + + // Set the interest rate model (depends on block number / borrow index) + err = _setInterestRateModelFresh(interestRateModel_); + require(err == uint(Error.NO_ERROR), "setting interest rate model failed"); + + name = name_; + symbol = symbol_; + decimals = decimals_; + + // The counter starts true to prevent changing it from zero to non-zero (i.e. smaller cost/refund) + _notEntered = true; + } + + /** + * @notice Transfer `tokens` tokens from `src` to `dst` by `spender` + * @dev Called by both `transfer` and `transferFrom` internally + * @param spender The address of the account performing the transfer + * @param src The address of the source account + * @param dst The address of the destination account + * @param tokens The number of tokens to transfer + * @return Whether or not the transfer succeeded + */ + function transferTokens(address spender, address src, address dst, uint tokens) internal returns (uint) { + /* Fail if transfer not allowed */ + uint allowed = comptroller.transferAllowed(address(this), src, dst, tokens); + if (allowed != 0) { + return failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.TRANSFER_COMPTROLLER_REJECTION, allowed); + } + + /* Do not allow self-transfers */ + if (src == dst) { + return fail(Error.BAD_INPUT, FailureInfo.TRANSFER_NOT_ALLOWED); + } + + /* Get the allowance, infinite for the account owner */ + uint startingAllowance = 0; + if (spender == src) { + startingAllowance = uint(-1); + } else { + startingAllowance = transferAllowances[src][spender]; + } + + /* Do the calculations, checking for {under,over}flow */ + MathError mathErr; + uint allowanceNew; + uint srcTokensNew; + uint dstTokensNew; + + (mathErr, allowanceNew) = subUInt(startingAllowance, tokens); + if (mathErr != MathError.NO_ERROR) { + return fail(Error.MATH_ERROR, FailureInfo.TRANSFER_NOT_ALLOWED); + } + + (mathErr, srcTokensNew) = subUInt(accountTokens[src], tokens); + if (mathErr != MathError.NO_ERROR) { + return fail(Error.MATH_ERROR, FailureInfo.TRANSFER_NOT_ENOUGH); + } + + (mathErr, dstTokensNew) = addUInt(accountTokens[dst], tokens); + if (mathErr != MathError.NO_ERROR) { + return fail(Error.MATH_ERROR, FailureInfo.TRANSFER_TOO_MUCH); + } + + ///////////////////////// + // EFFECTS & INTERACTIONS + // (No safe failures beyond this point) + + accountTokens[src] = srcTokensNew; + accountTokens[dst] = dstTokensNew; + + /* Eat some of the allowance (if necessary) */ + if (startingAllowance != uint(-1)) { + transferAllowances[src][spender] = allowanceNew; + } + + /* We emit a Transfer event */ + emit Transfer(src, dst, tokens); + + comptroller.transferVerify(address(this), src, dst, tokens); + + emit JTokenBalance(src, srcTokensNew); + emit JTokenBalance(dst, dstTokensNew); + + return uint(Error.NO_ERROR); + } + + /** + * @notice Transfer `amount` tokens from `msg.sender` to `dst` + * @param dst The address of the destination account + * @param amount The number of tokens to transfer + * @return Whether or not the transfer succeeded + */ + function transfer(address dst, uint256 amount) external nonReentrant returns (bool) { + return transferTokens(msg.sender, msg.sender, dst, amount) == uint(Error.NO_ERROR); + } + + /** + * @notice Transfer `amount` tokens from `src` to `dst` + * @param src The address of the source account + * @param dst The address of the destination account + * @param amount The number of tokens to transfer + * @return Whether or not the transfer succeeded + */ + function transferFrom(address src, address dst, uint256 amount) external nonReentrant returns (bool) { + return transferTokens(msg.sender, src, dst, amount) == uint(Error.NO_ERROR); + } + + /** + * @notice Approve `spender` to transfer up to `amount` from `src` + * @dev This will overwrite the approval amount for `spender` + * and is subject to issues noted [here](https://eips.ethereum.org/EIPS/eip-20#approve) + * @param spender The address of the account which may transfer tokens + * @param amount The number of tokens that are approved (-1 means infinite) + * @return Whether or not the approval succeeded + */ + function approve(address spender, uint256 amount) external returns (bool) { + address src = msg.sender; + transferAllowances[src][spender] = amount; + emit Approval(src, spender, amount); + return true; + } + + /** + * @notice Get the current allowance from `owner` for `spender` + * @param owner The address of the account which owns the tokens to be spent + * @param spender The address of the account which may transfer tokens + * @return The number of tokens allowed to be spent (-1 means infinite) + */ + function allowance(address owner, address spender) external view returns (uint256) { + return transferAllowances[owner][spender]; + } + + /** + * @notice Get the token balance of the `owner` + * @param owner The address of the account to query + * @return The number of tokens owned by `owner` + */ + function balanceOf(address owner) external view returns (uint256) { + return accountTokens[owner]; + } + + /** + * @notice Get the underlying balance of the `owner` + * @dev This also accrues interest in a transaction + * @param owner The address of the account to query + * @return The amount of underlying owned by `owner` + */ + function balanceOfUnderlying(address owner) external returns (uint) { + Exp memory exchangeRate = Exp({mantissa: exchangeRateCurrent()}); + (MathError mErr, uint balance) = mulScalarTruncate(exchangeRate, accountTokens[owner]); + require(mErr == MathError.NO_ERROR, "balance could not be calculated"); + return balance; + } + + /** + * @notice Get a snapshot of the account's balances, and the cached exchange rate + * @dev This is used by comptroller to more efficiently perform liquidity checks. + * @param account Address of the account to snapshot + * @return (possible error, token balance, borrow balance, exchange rate mantissa) + */ + function getAccountSnapshot(address account) external view returns (uint, uint, uint, uint) { + uint cTokenBalance = accountTokens[account]; + uint borrowBalance; + uint exchangeRateMantissa; + + MathError mErr; + + (mErr, borrowBalance) = borrowBalanceStoredInternal(account); + if (mErr != MathError.NO_ERROR) { + return (uint(Error.MATH_ERROR), 0, 0, 0); + } + + (mErr, exchangeRateMantissa) = exchangeRateStoredInternal(); + if (mErr != MathError.NO_ERROR) { + return (uint(Error.MATH_ERROR), 0, 0, 0); + } + + return (uint(Error.NO_ERROR), cTokenBalance, borrowBalance, exchangeRateMantissa); + } + + /** + * @dev Function to simply retrieve block number + * This exists mainly for inheriting test contracts to stub this result. + */ + function getBlockNumber() internal view returns (uint) { + return block.number; + } + + /** + * @notice Returns the current per-block borrow interest rate for this cToken + * @return The borrow interest rate per block, scaled by 1e18 + */ + function borrowRatePerBlock() external view returns (uint) { + return interestRateModel.getBorrowRate(getCashPrior(), totalBorrows, totalReserves); + } + + /** + * @notice Returns the current per-block supply interest rate for this cToken + * @return The supply interest rate per block, scaled by 1e18 + */ + function supplyRatePerBlock() external view returns (uint) { + return interestRateModel.getSupplyRate(getCashPrior(), totalBorrows, totalReserves, reserveFactorMantissa); + } + + /** + * @notice Returns the current total borrows plus accrued interest + * @return The total borrows with interest + */ + function totalBorrowsCurrent() external nonReentrant returns (uint) { + require(accrueInterest() == uint(Error.NO_ERROR), "accrue interest failed"); + return totalBorrows; + } + + /** + * @notice Accrue interest to updated borrowIndex and then calculate account's borrow balance using the updated borrowIndex + * @param account The address whose balance should be calculated after updating borrowIndex + * @return The calculated balance + */ + function borrowBalanceCurrent(address account) external nonReentrant returns (uint) { + require(accrueInterest() == uint(Error.NO_ERROR), "accrue interest failed"); + return borrowBalanceStored(account); + } + + /** + * @notice Return the borrow balance of account based on stored data + * @param account The address whose balance should be calculated + * @return The calculated balance + */ + function borrowBalanceStored(address account) public view returns (uint) { + (MathError err, uint result) = borrowBalanceStoredInternal(account); + require(err == MathError.NO_ERROR, "borrowBalanceStored: borrowBalanceStoredInternal failed"); + return result; + } + + /** + * @notice Return the borrow balance of account based on stored data + * @param account The address whose balance should be calculated + * @return (error code, the calculated balance or 0 if error code is non-zero) + */ + function borrowBalanceStoredInternal(address account) internal view returns (MathError, uint) { + /* Note: we do not assert that the market is up to date */ + MathError mathErr; + uint principalTimesIndex; + uint result; + + /* Get borrowBalance and borrowIndex */ + BorrowSnapshot storage borrowSnapshot = accountBorrows[account]; + + /* If borrowBalance = 0 then borrowIndex is likely also 0. + * Rather than failing the calculation with a division by 0, we immediately return 0 in this case. + */ + if (borrowSnapshot.principal == 0) { + return (MathError.NO_ERROR, 0); + } + + /* Calculate new borrow balance using the interest index: + * recentBorrowBalance = borrower.borrowBalance * market.borrowIndex / borrower.borrowIndex + */ + (mathErr, principalTimesIndex) = mulUInt(borrowSnapshot.principal, borrowIndex); + if (mathErr != MathError.NO_ERROR) { + return (mathErr, 0); + } + + (mathErr, result) = divUInt(principalTimesIndex, borrowSnapshot.interestIndex); + if (mathErr != MathError.NO_ERROR) { + return (mathErr, 0); + } + + return (MathError.NO_ERROR, result); + } + + /** + * @notice Accrue interest then return the up-to-date exchange rate + * @return Calculated exchange rate scaled by 1e18 + */ + function exchangeRateCurrent() public nonReentrant returns (uint) { + require(accrueInterest() == uint(Error.NO_ERROR), "accrue interest failed"); + return exchangeRateStored(); + } + + /** + * @notice Calculates the exchange rate from the underlying to the CToken + * @dev This function does not accrue interest before calculating the exchange rate + * @return Calculated exchange rate scaled by 1e18 + */ + function exchangeRateStored() public view returns (uint) { + (MathError err, uint result) = exchangeRateStoredInternal(); + require(err == MathError.NO_ERROR, "exchangeRateStored: exchangeRateStoredInternal failed"); + return result; + } + + /** + * @notice Calculates the exchange rate from the underlying to the CToken + * @dev This function does not accrue interest before calculating the exchange rate + * @return (error code, calculated exchange rate scaled by 1e18) + */ + function exchangeRateStoredInternal() internal view returns (MathError, uint) { + uint _totalSupply = totalSupply; + if (_totalSupply == 0) { + /* + * If there are no tokens minted: + * exchangeRate = initialExchangeRate + */ + return (MathError.NO_ERROR, initialExchangeRateMantissa); + } else { + /* + * Otherwise: + * exchangeRate = (totalCash + totalBorrows - totalReserves) / totalSupply + */ + uint totalCash = getCashPrior(); + uint cashPlusBorrowsMinusReserves; + Exp memory exchangeRate; + MathError mathErr; + + (mathErr, cashPlusBorrowsMinusReserves) = addThenSubUInt(totalCash, totalBorrows, totalReserves); + if (mathErr != MathError.NO_ERROR) { + return (mathErr, 0); + } + + (mathErr, exchangeRate) = getExp(cashPlusBorrowsMinusReserves, _totalSupply); + if (mathErr != MathError.NO_ERROR) { + return (mathErr, 0); + } + + return (MathError.NO_ERROR, exchangeRate.mantissa); + } + } + + /** + * @notice Get cash balance of this cToken in the underlying asset + * @return The quantity of underlying asset owned by this contract + */ + function getCash() public view returns (uint) { + return getCashPrior(); + } + + /** + * @notice Applies accrued interest to total borrows and reserves + * @dev This calculates interest accrued from the last checkpointed block + * up to the current block and writes new checkpoint to storage. + */ + function accrueInterest() public returns (uint) { + /* Remember the initial block number */ + uint currentBlockNumber = getBlockNumber(); + uint accrualBlockNumberPrior = accrualBlockNumber; + + /* Short-circuit accumulating 0 interest */ + if (accrualBlockNumberPrior == currentBlockNumber) { + return uint(Error.NO_ERROR); + } + + /* Read the previous values out of storage */ + uint cashPrior = getCashPrior(); + uint borrowsPrior = totalBorrows; + uint reservesPrior = totalReserves; + uint borrowIndexPrior = borrowIndex; + + /* Calculate the current borrow interest rate */ + uint borrowRateMantissa = interestRateModel.getBorrowRate(cashPrior, borrowsPrior, reservesPrior); + require(borrowRateMantissa <= borrowRateMaxMantissa, "borrow rate is absurdly high"); + + /* Calculate the number of blocks elapsed since the last accrual */ + (MathError mathErr, uint blockDelta) = subUInt(currentBlockNumber, accrualBlockNumberPrior); + require(mathErr == MathError.NO_ERROR, "could not calculate block delta"); + + /* + * Calculate the interest accumulated into borrows and reserves and the new index: + * simpleInterestFactor = borrowRate * blockDelta + * interestAccumulated = simpleInterestFactor * totalBorrows + * totalBorrowsNew = interestAccumulated + totalBorrows + * totalReservesNew = interestAccumulated * reserveFactor + totalReserves + * borrowIndexNew = simpleInterestFactor * borrowIndex + borrowIndex + */ + + Exp memory simpleInterestFactor; + uint interestAccumulated; + uint totalBorrowsNew; + uint totalReservesNew; + uint borrowIndexNew; + + (mathErr, simpleInterestFactor) = mulScalar(Exp({mantissa: borrowRateMantissa}), blockDelta); + if (mathErr != MathError.NO_ERROR) { + return failOpaque(Error.MATH_ERROR, FailureInfo.ACCRUE_INTEREST_SIMPLE_INTEREST_FACTOR_CALCULATION_FAILED, uint(mathErr)); + } + + (mathErr, interestAccumulated) = mulScalarTruncate(simpleInterestFactor, borrowsPrior); + if (mathErr != MathError.NO_ERROR) { + return failOpaque(Error.MATH_ERROR, FailureInfo.ACCRUE_INTEREST_ACCUMULATED_INTEREST_CALCULATION_FAILED, uint(mathErr)); + } + + (mathErr, totalBorrowsNew) = addUInt(interestAccumulated, borrowsPrior); + if (mathErr != MathError.NO_ERROR) { + return failOpaque(Error.MATH_ERROR, FailureInfo.ACCRUE_INTEREST_NEW_TOTAL_BORROWS_CALCULATION_FAILED, uint(mathErr)); + } + + (mathErr, totalReservesNew) = mulScalarTruncateAddUInt(Exp({mantissa: reserveFactorMantissa}), interestAccumulated, reservesPrior); + if (mathErr != MathError.NO_ERROR) { + return failOpaque(Error.MATH_ERROR, FailureInfo.ACCRUE_INTEREST_NEW_TOTAL_RESERVES_CALCULATION_FAILED, uint(mathErr)); + } + + (mathErr, borrowIndexNew) = mulScalarTruncateAddUInt(simpleInterestFactor, borrowIndexPrior, borrowIndexPrior); + if (mathErr != MathError.NO_ERROR) { + return failOpaque(Error.MATH_ERROR, FailureInfo.ACCRUE_INTEREST_NEW_BORROW_INDEX_CALCULATION_FAILED, uint(mathErr)); + } + + ///////////////////////// + // EFFECTS & INTERACTIONS + // (No safe failures beyond this point) + + /* We write the previously calculated values into storage */ + accrualBlockNumber = currentBlockNumber; + borrowIndex = borrowIndexNew; + totalBorrows = totalBorrowsNew; + totalReserves = totalReservesNew; + + /* We emit an AccrueInterest event */ + emit AccrueInterest(cashPrior, interestAccumulated, borrowIndexNew, totalBorrowsNew); + + return uint(Error.NO_ERROR); + } + + /** + * @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, uint) An error code (0=success, otherwise a failure, see ErrorReporter.sol), and the actual mint amount. + */ + function mintInternal(uint mintAmount) internal nonReentrant returns (uint, uint) { + uint error = accrueInterest(); + if (error != uint(Error.NO_ERROR)) { + // accrueInterest emits logs on errors, but we still want to log the fact that an attempted borrow failed + return (fail(Error(error), FailureInfo.MINT_ACCRUE_INTEREST_FAILED), 0); + } + // mintFresh emits the actual Mint event if successful and logs on errors, so we don't need to + return mintFresh(msg.sender, mintAmount); + } + + struct MintLocalVars { + Error err; + MathError mathErr; + uint exchangeRateMantissa; + uint mintTokens; + uint totalSupplyNew; + uint accountTokensNew; + uint actualMintAmount; + } + + /** + * @notice User supplies assets into the market and receives cTokens in exchange + * @dev Assumes interest has already been accrued up to the current block + * @param minter The address of the account which is supplying the assets + * @param mintAmount The amount of the underlying asset to supply + * @return (uint, uint) An error code (0=success, otherwise a failure, see ErrorReporter.sol), and the actual mint amount. + */ + function mintFresh(address minter, uint mintAmount) internal returns (uint, uint) { + /* Fail if mint not allowed */ + uint allowed = comptroller.mintAllowed(address(this), minter, mintAmount); + if (allowed != 0) { + return (failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.MINT_COMPTROLLER_REJECTION, allowed), 0); + } + + /* Verify market's block number equals current block number */ + if (accrualBlockNumber != getBlockNumber()) { + return (fail(Error.MARKET_NOT_FRESH, FailureInfo.MINT_FRESHNESS_CHECK), 0); + } + + MintLocalVars memory vars; + + (vars.mathErr, vars.exchangeRateMantissa) = exchangeRateStoredInternal(); + if (vars.mathErr != MathError.NO_ERROR) { + return (failOpaque(Error.MATH_ERROR, FailureInfo.MINT_EXCHANGE_RATE_READ_FAILED, uint(vars.mathErr)), 0); + } + + ///////////////////////// + // EFFECTS & INTERACTIONS + // (No safe failures beyond this point) + + /* + * We call `doTransferIn` for the minter and the mintAmount. + * Note: The cToken must handle variations between ERC-20 and ETH underlying. + * `doTransferIn` reverts if anything goes wrong, since we can't be sure if + * side-effects occurred. The function returns the amount actually transferred, + * in case of a fee. On success, the cToken holds an additional `actualMintAmount` + * of cash. + */ + vars.actualMintAmount = doTransferIn(minter, mintAmount); + + /* + * We get the current exchange rate and calculate the number of cTokens to be minted: + * mintTokens = actualMintAmount / exchangeRate + */ + + (vars.mathErr, vars.mintTokens) = divScalarByExpTruncate(vars.actualMintAmount, Exp({mantissa: vars.exchangeRateMantissa})); + require(vars.mathErr == MathError.NO_ERROR, "MINT_EXCHANGE_CALCULATION_FAILED"); + + /* + * We calculate the new total supply of cTokens and minter token balance, checking for overflow: + * totalSupplyNew = totalSupply + mintTokens + * accountTokensNew = accountTokens[minter] + mintTokens + */ + (vars.mathErr, vars.totalSupplyNew) = addUInt(totalSupply, vars.mintTokens); + require(vars.mathErr == MathError.NO_ERROR, "MINT_NEW_TOTAL_SUPPLY_CALCULATION_FAILED"); + + (vars.mathErr, vars.accountTokensNew) = addUInt(accountTokens[minter], vars.mintTokens); + require(vars.mathErr == MathError.NO_ERROR, "MINT_NEW_ACCOUNT_BALANCE_CALCULATION_FAILED"); + + /* We write previously calculated values into storage */ + totalSupply = vars.totalSupplyNew; + accountTokens[minter] = vars.accountTokensNew; + + /* We emit a Mint event, and a Transfer event */ + emit Mint(minter, vars.actualMintAmount, vars.mintTokens); + emit Transfer(address(this), minter, vars.mintTokens); + + //jtoken event + emit JTokenBalance(minter, vars.accountTokensNew); + + /* We call the defense hook */ + comptroller.mintVerify(address(this), minter, vars.actualMintAmount, vars.mintTokens); + + //jtoken event + statusSnapShot(); + + return (uint(Error.NO_ERROR), vars.actualMintAmount); + } + + /** + * @notice Sender redeems cTokens in exchange for the underlying asset + * @dev Accrues interest whether or not the operation succeeds, unless reverted + * @param redeemTokens The number of cTokens to redeem into underlying + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function redeemInternal(uint redeemTokens) internal nonReentrant returns (uint) { + uint error = accrueInterest(); + if (error != uint(Error.NO_ERROR)) { + // accrueInterest emits logs on errors, but we still want to log the fact that an attempted redeem failed + return fail(Error(error), FailureInfo.REDEEM_ACCRUE_INTEREST_FAILED); + } + // redeemFresh emits redeem-specific logs on errors, so we don't need to + return redeemFresh(msg.sender, redeemTokens, 0); + } + + /** + * @notice Sender redeems cTokens in exchange for a specified amount of underlying asset + * @dev Accrues interest whether or not the operation succeeds, unless reverted + * @param redeemAmount The amount of underlying to receive from redeeming cTokens + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function redeemUnderlyingInternal(uint redeemAmount) internal nonReentrant returns (uint) { + uint error = accrueInterest(); + if (error != uint(Error.NO_ERROR)) { + // accrueInterest emits logs on errors, but we still want to log the fact that an attempted redeem failed + return fail(Error(error), FailureInfo.REDEEM_ACCRUE_INTEREST_FAILED); + } + // redeemFresh emits redeem-specific logs on errors, so we don't need to + return redeemFresh(msg.sender, 0, redeemAmount); + } + + struct RedeemLocalVars { + Error err; + MathError mathErr; + uint exchangeRateMantissa; + uint redeemTokens; + uint redeemAmount; + uint totalSupplyNew; + uint accountTokensNew; + } + + /** + * @notice User redeems cTokens in exchange for the underlying asset + * @dev Assumes interest has already been accrued up to the current block + * @param redeemer The address of the account which is redeeming the tokens + * @param redeemTokensIn The number of cTokens to redeem into underlying (only one of redeemTokensIn or redeemAmountIn may be non-zero) + * @param redeemAmountIn The number of underlying tokens to receive from redeeming cTokens (only one of redeemTokensIn or redeemAmountIn may be non-zero) + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function redeemFresh(address payable redeemer, uint redeemTokensIn, uint redeemAmountIn) internal returns (uint) { + require(redeemTokensIn == 0 || redeemAmountIn == 0, "one of redeemTokensIn or redeemAmountIn must be zero"); + + RedeemLocalVars memory vars; + + /* exchangeRate = invoke Exchange Rate Stored() */ + (vars.mathErr, vars.exchangeRateMantissa) = exchangeRateStoredInternal(); + if (vars.mathErr != MathError.NO_ERROR) { + return failOpaque(Error.MATH_ERROR, FailureInfo.REDEEM_EXCHANGE_RATE_READ_FAILED, uint(vars.mathErr)); + } + + /* If redeemTokensIn > 0: */ + if (redeemTokensIn > 0) { + /* + * We calculate the exchange rate and the amount of underlying to be redeemed: + * redeemTokens = redeemTokensIn + * redeemAmount = redeemTokensIn x exchangeRateCurrent + */ + vars.redeemTokens = redeemTokensIn; + + (vars.mathErr, vars.redeemAmount) = mulScalarTruncate(Exp({mantissa: vars.exchangeRateMantissa}), redeemTokensIn); + if (vars.mathErr != MathError.NO_ERROR) { + return failOpaque(Error.MATH_ERROR, FailureInfo.REDEEM_EXCHANGE_TOKENS_CALCULATION_FAILED, uint(vars.mathErr)); + } + } else { + /* + * We get the current exchange rate and calculate the amount to be redeemed: + * redeemTokens = redeemAmountIn / exchangeRate + * redeemAmount = redeemAmountIn + */ + + (vars.mathErr, vars.redeemTokens) = divScalarByExpTruncate(redeemAmountIn, Exp({mantissa: vars.exchangeRateMantissa})); + if (vars.mathErr != MathError.NO_ERROR) { + return failOpaque(Error.MATH_ERROR, FailureInfo.REDEEM_EXCHANGE_AMOUNT_CALCULATION_FAILED, uint(vars.mathErr)); + } + + vars.redeemAmount = redeemAmountIn; + } + + /* Fail if redeem not allowed */ + uint allowed = comptroller.redeemAllowed(address(this), redeemer, vars.redeemTokens); + if (allowed != 0) { + return failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.REDEEM_COMPTROLLER_REJECTION, allowed); + } + + /* Verify market's block number equals current block number */ + if (accrualBlockNumber != getBlockNumber()) { + return fail(Error.MARKET_NOT_FRESH, FailureInfo.REDEEM_FRESHNESS_CHECK); + } + + /* + * We calculate the new total supply and redeemer balance, checking for underflow: + * totalSupplyNew = totalSupply - redeemTokens + * accountTokensNew = accountTokens[redeemer] - redeemTokens + */ + (vars.mathErr, vars.totalSupplyNew) = subUInt(totalSupply, vars.redeemTokens); + if (vars.mathErr != MathError.NO_ERROR) { + return failOpaque(Error.MATH_ERROR, FailureInfo.REDEEM_NEW_TOTAL_SUPPLY_CALCULATION_FAILED, uint(vars.mathErr)); + } + + (vars.mathErr, vars.accountTokensNew) = subUInt(accountTokens[redeemer], vars.redeemTokens); + if (vars.mathErr != MathError.NO_ERROR) { + return failOpaque(Error.MATH_ERROR, FailureInfo.REDEEM_NEW_ACCOUNT_BALANCE_CALCULATION_FAILED, uint(vars.mathErr)); + } + + /* Fail gracefully if protocol has insufficient cash */ + if (getCashPrior() < vars.redeemAmount) { + return fail(Error.TOKEN_INSUFFICIENT_CASH, FailureInfo.REDEEM_TRANSFER_OUT_NOT_POSSIBLE); + } + + ///////////////////////// + // EFFECTS & INTERACTIONS + // (No safe failures beyond this point) + + + /* We write previously calculated values into storage */ + totalSupply = vars.totalSupplyNew; + accountTokens[redeemer] = vars.accountTokensNew; + + /* We emit a Transfer event, and a Redeem event */ + emit Transfer(redeemer, address(this), vars.redeemTokens); + emit Redeem(redeemer, vars.redeemAmount, vars.redeemTokens); + + //jtoken event + emit JTokenBalance(redeemer, vars.accountTokensNew); + + /* + * We invoke doTransferOut for the redeemer and the redeemAmount. + * Note: The cToken must handle variations between ERC-20 and ETH underlying. + * On success, the cToken has redeemAmount less of cash. + * doTransferOut reverts if anything goes wrong, since we can't be sure if side effects occurred. + */ + doTransferOut(redeemer, vars.redeemAmount); + /* We call the defense hook */ + comptroller.redeemVerify(address(this), redeemer, vars.redeemAmount, vars.redeemTokens); + + //jtoken event + statusSnapShot(); + + return uint(Error.NO_ERROR); + } + + /** + * @notice Sender borrows assets from the protocol to their own address + * @param borrowAmount The amount of the underlying asset to borrow + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function borrowInternal(uint borrowAmount) internal nonReentrant returns (uint) { + uint error = accrueInterest(); + if (error != uint(Error.NO_ERROR)) { + // accrueInterest emits logs on errors, but we still want to log the fact that an attempted borrow failed + return fail(Error(error), FailureInfo.BORROW_ACCRUE_INTEREST_FAILED); + } + // borrowFresh emits borrow-specific logs on errors, so we don't need to + return borrowFresh(msg.sender, borrowAmount); + } + + struct BorrowLocalVars { + MathError mathErr; + uint accountBorrows; + uint accountBorrowsNew; + uint totalBorrowsNew; + } + + /** + * @notice Users borrow assets from the protocol to their own address + * @param borrowAmount The amount of the underlying asset to borrow + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function borrowFresh(address payable borrower, uint borrowAmount) internal returns (uint) { + /* Fail if borrow not allowed */ + uint allowed = comptroller.borrowAllowed(address(this), borrower, borrowAmount); + if (allowed != 0) { + return failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.BORROW_COMPTROLLER_REJECTION, allowed); + } + + /* Verify market's block number equals current block number */ + if (accrualBlockNumber != getBlockNumber()) { + return fail(Error.MARKET_NOT_FRESH, FailureInfo.BORROW_FRESHNESS_CHECK); + } + + /* Fail gracefully if protocol has insufficient underlying cash */ + if (getCashPrior() < borrowAmount) { + return fail(Error.TOKEN_INSUFFICIENT_CASH, FailureInfo.BORROW_CASH_NOT_AVAILABLE); + } + + BorrowLocalVars memory vars; + + /* + * We calculate the new borrower and total borrow balances, failing on overflow: + * accountBorrowsNew = accountBorrows + borrowAmount + * totalBorrowsNew = totalBorrows + borrowAmount + */ + (vars.mathErr, vars.accountBorrows) = borrowBalanceStoredInternal(borrower); + if (vars.mathErr != MathError.NO_ERROR) { + return failOpaque(Error.MATH_ERROR, FailureInfo.BORROW_ACCUMULATED_BALANCE_CALCULATION_FAILED, uint(vars.mathErr)); + } + + (vars.mathErr, vars.accountBorrowsNew) = addUInt(vars.accountBorrows, borrowAmount); + if (vars.mathErr != MathError.NO_ERROR) { + return failOpaque(Error.MATH_ERROR, FailureInfo.BORROW_NEW_ACCOUNT_BORROW_BALANCE_CALCULATION_FAILED, uint(vars.mathErr)); + } + + (vars.mathErr, vars.totalBorrowsNew) = addUInt(totalBorrows, borrowAmount); + if (vars.mathErr != MathError.NO_ERROR) { + return failOpaque(Error.MATH_ERROR, FailureInfo.BORROW_NEW_TOTAL_BALANCE_CALCULATION_FAILED, uint(vars.mathErr)); + } + + ///////////////////////// + // EFFECTS & INTERACTIONS + // (No safe failures beyond this point) + + + + /* We write the previously calculated values into storage */ + accountBorrows[borrower].principal = vars.accountBorrowsNew; + accountBorrows[borrower].interestIndex = borrowIndex; + totalBorrows = vars.totalBorrowsNew; + + /* We emit a Borrow event */ + emit Borrow(borrower, borrowAmount, vars.accountBorrowsNew, vars.totalBorrowsNew, borrowIndex); + + /* + * We invoke doTransferOut for the borrower and the borrowAmount. + * Note: The cToken must handle variations between ERC-20 and ETH underlying. + * On success, the cToken borrowAmount less of cash. + * doTransferOut reverts if anything goes wrong, since we can't be sure if side effects occurred. + */ + doTransferOut(borrower, borrowAmount); + + //jtoken event + statusSnapShot(); + /* We call the defense hook */ + comptroller.borrowVerify(address(this), borrower, borrowAmount); + + return uint(Error.NO_ERROR); + } + + /** + * @notice Sender repays their own borrow + * @param repayAmount The amount to repay + * @return (uint, uint) An error code (0=success, otherwise a failure, see ErrorReporter.sol), and the actual repayment amount. + */ + function repayBorrowInternal(uint repayAmount) internal nonReentrant returns (uint, uint) { + uint error = accrueInterest(); + if (error != uint(Error.NO_ERROR)) { + // accrueInterest emits logs on errors, but we still want to log the fact that an attempted borrow failed + return (fail(Error(error), FailureInfo.REPAY_BORROW_ACCRUE_INTEREST_FAILED), 0); + } + // repayBorrowFresh emits repay-borrow-specific logs on errors, so we don't need to + return repayBorrowFresh(msg.sender, msg.sender, repayAmount); + } + + /** + * @notice Sender repays a borrow belonging to borrower + * @param borrower the account with the debt being payed off + * @param repayAmount The amount to repay + * @return (uint, uint) An error code (0=success, otherwise a failure, see ErrorReporter.sol), and the actual repayment amount. + */ + function repayBorrowBehalfInternal(address borrower, uint repayAmount) internal nonReentrant returns (uint, uint) { + uint error = accrueInterest(); + if (error != uint(Error.NO_ERROR)) { + // accrueInterest emits logs on errors, but we still want to log the fact that an attempted borrow failed + return (fail(Error(error), FailureInfo.REPAY_BEHALF_ACCRUE_INTEREST_FAILED), 0); + } + // repayBorrowFresh emits repay-borrow-specific logs on errors, so we don't need to + return repayBorrowFresh(msg.sender, borrower, repayAmount); + } + + struct RepayBorrowLocalVars { + Error err; + MathError mathErr; + uint repayAmount; + uint borrowerIndex; + uint accountBorrows; + uint accountBorrowsNew; + uint totalBorrowsNew; + uint actualRepayAmount; + } + + /** + * @notice Borrows are repaid by another user (possibly the borrower). + * @param payer the account paying off the borrow + * @param borrower the account with the debt being payed off + * @param repayAmount the amount of undelrying tokens being returned + * @return (uint, uint) An error code (0=success, otherwise a failure, see ErrorReporter.sol), and the actual repayment amount. + */ + function repayBorrowFresh(address payer, address borrower, uint repayAmount) internal returns (uint, uint) { + /* Fail if repayBorrow not allowed */ + uint allowed = comptroller.repayBorrowAllowed(address(this), payer, borrower, repayAmount); + if (allowed != 0) { + return (failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.REPAY_BORROW_COMPTROLLER_REJECTION, allowed), 0); + } + + /* Verify market's block number equals current block number */ + if (accrualBlockNumber != getBlockNumber()) { + return (fail(Error.MARKET_NOT_FRESH, FailureInfo.REPAY_BORROW_FRESHNESS_CHECK), 0); + } + + RepayBorrowLocalVars memory vars; + + /* We remember the original borrowerIndex for verification purposes */ + vars.borrowerIndex = accountBorrows[borrower].interestIndex; + + /* We fetch the amount the borrower owes, with accumulated interest */ + (vars.mathErr, vars.accountBorrows) = borrowBalanceStoredInternal(borrower); + if (vars.mathErr != MathError.NO_ERROR) { + return (failOpaque(Error.MATH_ERROR, FailureInfo.REPAY_BORROW_ACCUMULATED_BALANCE_CALCULATION_FAILED, uint(vars.mathErr)), 0); + } + + /* If repayAmount == -1, repayAmount = accountBorrows */ + if (repayAmount == uint(-1)) { + vars.repayAmount = vars.accountBorrows; + } else { + vars.repayAmount = repayAmount; + } + + ///////////////////////// + // EFFECTS & INTERACTIONS + // (No safe failures beyond this point) + + /* + * We call doTransferIn for the payer and the repayAmount + * Note: The cToken must handle variations between ERC-20 and ETH underlying. + * On success, the cToken holds an additional repayAmount of cash. + * doTransferIn reverts if anything goes wrong, since we can't be sure if side effects occurred. + * it returns the amount actually transferred, in case of a fee. + */ + vars.actualRepayAmount = doTransferIn(payer, vars.repayAmount); + + /* + * We calculate the new borrower and total borrow balances, failing on underflow: + * accountBorrowsNew = accountBorrows - actualRepayAmount + * totalBorrowsNew = totalBorrows - actualRepayAmount + */ + (vars.mathErr, vars.accountBorrowsNew) = subUInt(vars.accountBorrows, vars.actualRepayAmount); + require(vars.mathErr == MathError.NO_ERROR, "REPAY_BORROW_NEW_ACCOUNT_BORROW_BALANCE_CALCULATION_FAILED"); + + (vars.mathErr, vars.totalBorrowsNew) = subUInt(totalBorrows, vars.actualRepayAmount); + require(vars.mathErr == MathError.NO_ERROR, "REPAY_BORROW_NEW_TOTAL_BALANCE_CALCULATION_FAILED"); + + /* We write the previously calculated values into storage */ + accountBorrows[borrower].principal = vars.accountBorrowsNew; + accountBorrows[borrower].interestIndex = borrowIndex; + totalBorrows = vars.totalBorrowsNew; + + /* We emit a RepayBorrow event */ + emit RepayBorrow(payer, borrower, vars.actualRepayAmount, vars.accountBorrowsNew, vars.totalBorrowsNew, borrowIndex); + + /* We call the defense hook */ + comptroller.repayBorrowVerify(address(this), payer, borrower, vars.actualRepayAmount, vars.borrowerIndex); + + //jtoken event + statusSnapShot(); + + return (uint(Error.NO_ERROR), vars.actualRepayAmount); + } + + /** + * @notice The sender liquidates the borrowers collateral. + * The collateral seized is transferred to the liquidator. + * @param borrower The borrower of this cToken to be liquidated + * @param cTokenCollateral The market in which to seize collateral from the borrower + * @param repayAmount The amount of the underlying borrowed asset to repay + * @return (uint, uint) An error code (0=success, otherwise a failure, see ErrorReporter.sol), and the actual repayment amount. + */ + function liquidateBorrowInternal(address borrower, uint repayAmount, CTokenInterface cTokenCollateral) internal nonReentrant returns (uint, uint) { + uint error = accrueInterest(); + if (error != uint(Error.NO_ERROR)) { + // accrueInterest emits logs on errors, but we still want to log the fact that an attempted liquidation failed + return (fail(Error(error), FailureInfo.LIQUIDATE_ACCRUE_BORROW_INTEREST_FAILED), 0); + } + + error = cTokenCollateral.accrueInterest(); + if (error != uint(Error.NO_ERROR)) { + // accrueInterest emits logs on errors, but we still want to log the fact that an attempted liquidation failed + return (fail(Error(error), FailureInfo.LIQUIDATE_ACCRUE_COLLATERAL_INTEREST_FAILED), 0); + } + + // liquidateBorrowFresh emits borrow-specific logs on errors, so we don't need to + return liquidateBorrowFresh(msg.sender, borrower, repayAmount, cTokenCollateral); + } + + /** + * @notice The liquidator liquidates the borrowers collateral. + * The collateral seized is transferred to the liquidator. + * @param borrower The borrower of this cToken to be liquidated + * @param liquidator The address repaying the borrow and seizing collateral + * @param cTokenCollateral The market in which to seize collateral from the borrower + * @param repayAmount The amount of the underlying borrowed asset to repay + * @return (uint, uint) An error code (0=success, otherwise a failure, see ErrorReporter.sol), and the actual repayment amount. + */ + function liquidateBorrowFresh(address liquidator, address borrower, uint repayAmount, CTokenInterface cTokenCollateral) internal returns (uint, uint) { + /* Fail if liquidate not allowed */ + uint allowed = comptroller.liquidateBorrowAllowed(address(this), address(cTokenCollateral), liquidator, borrower, repayAmount); + if (allowed != 0) { + return (failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.LIQUIDATE_COMPTROLLER_REJECTION, allowed), 0); + } + + /* Verify market's block number equals current block number */ + if (accrualBlockNumber != getBlockNumber()) { + return (fail(Error.MARKET_NOT_FRESH, FailureInfo.LIQUIDATE_FRESHNESS_CHECK), 0); + } + + /* Verify cTokenCollateral market's block number equals current block number */ + if (cTokenCollateral.accrualBlockNumber() != getBlockNumber()) { + return (fail(Error.MARKET_NOT_FRESH, FailureInfo.LIQUIDATE_COLLATERAL_FRESHNESS_CHECK), 0); + } + + /* Fail if borrower = liquidator */ + if (borrower == liquidator) { + return (fail(Error.INVALID_ACCOUNT_PAIR, FailureInfo.LIQUIDATE_LIQUIDATOR_IS_BORROWER), 0); + } + + /* Fail if repayAmount = 0 */ + if (repayAmount == 0) { + return (fail(Error.INVALID_CLOSE_AMOUNT_REQUESTED, FailureInfo.LIQUIDATE_CLOSE_AMOUNT_IS_ZERO), 0); + } + + /* Fail if repayAmount = -1 */ + if (repayAmount == uint(-1)) { + return (fail(Error.INVALID_CLOSE_AMOUNT_REQUESTED, FailureInfo.LIQUIDATE_CLOSE_AMOUNT_IS_UINT_MAX), 0); + } + + + /* Fail if repayBorrow fails */ + (uint repayBorrowError, uint actualRepayAmount) = repayBorrowFresh(liquidator, borrower, repayAmount); + if (repayBorrowError != uint(Error.NO_ERROR)) { + return (fail(Error(repayBorrowError), FailureInfo.LIQUIDATE_REPAY_BORROW_FRESH_FAILED), 0); + } + + ///////////////////////// + // EFFECTS & INTERACTIONS + // (No safe failures beyond this point) + + /* We calculate the number of collateral tokens that will be seized */ + (uint amountSeizeError, uint seizeTokens) = comptroller.liquidateCalculateSeizeTokens(address(this), address(cTokenCollateral), actualRepayAmount); + require(amountSeizeError == uint(Error.NO_ERROR), "LIQUIDATE_COMPTROLLER_CALCULATE_AMOUNT_SEIZE_FAILED"); + + /* Revert if borrower collateral token balance < seizeTokens */ + require(cTokenCollateral.balanceOf(borrower) >= seizeTokens, "LIQUIDATE_SEIZE_TOO_MUCH"); + + // If this is also the collateral, run seizeInternal to avoid re-entrancy, otherwise make an external call + uint seizeError; + if (address(cTokenCollateral) == address(this)) { + seizeError = seizeInternal(address(this), liquidator, borrower, seizeTokens); + } else { + seizeError = cTokenCollateral.seize(liquidator, borrower, seizeTokens); + } + + /* Revert if seize tokens fails (since we cannot be sure of side effects) */ + require(seizeError == uint(Error.NO_ERROR), "token seizure failed"); + + /* We emit a LiquidateBorrow event */ + emit LiquidateBorrow(liquidator, borrower, actualRepayAmount, address(cTokenCollateral), seizeTokens); + + /* We call the defense hook */ + comptroller.liquidateBorrowVerify(address(this), address(cTokenCollateral), liquidator, borrower, actualRepayAmount, seizeTokens); + + //jtoken event + statusSnapShot(); + + return (uint(Error.NO_ERROR), actualRepayAmount); + } + + /** + * @notice Transfers collateral tokens (this market) to the liquidator. + * @dev Will fail unless called by another cToken during the process of liquidation. + * Its absolutely critical to use msg.sender as the borrowed cToken and not a parameter. + * @param liquidator The account receiving seized collateral + * @param borrower The account having collateral seized + * @param seizeTokens The number of cTokens to seize + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function seize(address liquidator, address borrower, uint seizeTokens) external nonReentrant returns (uint) { + return seizeInternal(msg.sender, liquidator, borrower, seizeTokens); + } + + /** + * @notice Transfers collateral tokens (this market) to the liquidator. + * @dev Called only during an in-kind liquidation, or by liquidateBorrow during the liquidation of another CToken. + * Its absolutely critical to use msg.sender as the seizer cToken and not a parameter. + * @param seizerToken The contract seizing the collateral (i.e. borrowed cToken) + * @param liquidator The account receiving seized collateral + * @param borrower The account having collateral seized + * @param seizeTokens The number of cTokens to seize + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function seizeInternal(address seizerToken, address liquidator, address borrower, uint seizeTokens) internal returns (uint) { + /* Fail if seize not allowed */ + uint allowed = comptroller.seizeAllowed(address(this), seizerToken, liquidator, borrower, seizeTokens); + if (allowed != 0) { + return failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.LIQUIDATE_SEIZE_COMPTROLLER_REJECTION, allowed); + } + + /* Fail if borrower = liquidator */ + if (borrower == liquidator) { + return fail(Error.INVALID_ACCOUNT_PAIR, FailureInfo.LIQUIDATE_SEIZE_LIQUIDATOR_IS_BORROWER); + } + + MathError mathErr; + uint borrowerTokensNew; + uint liquidatorTokensNew; + + /* + * We calculate the new borrower and liquidator token balances, failing on underflow/overflow: + * borrowerTokensNew = accountTokens[borrower] - seizeTokens + * liquidatorTokensNew = accountTokens[liquidator] + seizeTokens + */ + (mathErr, borrowerTokensNew) = subUInt(accountTokens[borrower], seizeTokens); + if (mathErr != MathError.NO_ERROR) { + return failOpaque(Error.MATH_ERROR, FailureInfo.LIQUIDATE_SEIZE_BALANCE_DECREMENT_FAILED, uint(mathErr)); + } + + (mathErr, liquidatorTokensNew) = addUInt(accountTokens[liquidator], seizeTokens); + if (mathErr != MathError.NO_ERROR) { + return failOpaque(Error.MATH_ERROR, FailureInfo.LIQUIDATE_SEIZE_BALANCE_INCREMENT_FAILED, uint(mathErr)); + } + + ///////////////////////// + // EFFECTS & INTERACTIONS + // (No safe failures beyond this point) + + /* We write the previously calculated values into storage */ + accountTokens[borrower] = borrowerTokensNew; + accountTokens[liquidator] = liquidatorTokensNew; + + /* Emit a Transfer event */ + emit Transfer(borrower, liquidator, seizeTokens); + + emit JTokenBalance(borrower, borrowerTokensNew); + emit JTokenBalance(liquidator, liquidatorTokensNew); + + /* We call the defense hook */ + comptroller.seizeVerify(address(this), seizerToken, liquidator, borrower, seizeTokens); + + return uint(Error.NO_ERROR); + } + + + function statusSnapShot() internal { + uint cash = getCash(); + uint borrowRate = (totalSupply == 0 ? 0 : interestRateModel.getBorrowRate(cash, totalBorrows, totalReserves)); + emit JTokenStatus(cash, totalBorrows, totalReserves, totalSupply, borrowRate, borrowIndex, reserveFactorMantissa); + } + + /*** Admin Functions ***/ + + /** + * @notice Begins transfer of admin rights. The newPendingAdmin must call `_acceptAdmin` to finalize the transfer. + * @dev Admin function to begin change of admin. The newPendingAdmin must call `_acceptAdmin` to finalize the transfer. + * @param newPendingAdmin New pending admin. + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function _setPendingAdmin(address payable newPendingAdmin) external returns (uint) { + // Check caller = admin + if (msg.sender != admin) { + return fail(Error.UNAUTHORIZED, FailureInfo.SET_PENDING_ADMIN_OWNER_CHECK); + } + + // Save current value, if any, for inclusion in log + address oldPendingAdmin = pendingAdmin; + + // Store pendingAdmin with value newPendingAdmin + pendingAdmin = newPendingAdmin; + + // Emit NewPendingAdmin(oldPendingAdmin, newPendingAdmin) + emit NewPendingAdmin(oldPendingAdmin, newPendingAdmin); + + return uint(Error.NO_ERROR); + } + + function _setReserveAdmin(address payable newReserveAdmin) external returns (uint) { + // Check caller = admin + if (msg.sender != admin) { + return fail(Error.UNAUTHORIZED, FailureInfo.SET_PENDING_ADMIN_OWNER_CHECK); + } + // Save current value, if any, for inclusion in log + address oldReserveAdmin = reserveAdmin; + + reserveAdmin = newReserveAdmin; + + emit NewReserveAdmin(oldReserveAdmin, newReserveAdmin); + + return uint(Error.NO_ERROR); + } + + /** + * @notice Accepts transfer of admin rights. msg.sender must be pendingAdmin + * @dev Admin function for pending admin to accept role and update admin + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function _acceptAdmin() external returns (uint) { + // Check caller is pendingAdmin and pendingAdmin ≠ address(0) + if (msg.sender != pendingAdmin || msg.sender == address(0)) { + return fail(Error.UNAUTHORIZED, FailureInfo.ACCEPT_ADMIN_PENDING_ADMIN_CHECK); + } + + // Save current values for inclusion in log + address oldAdmin = admin; + address oldPendingAdmin = pendingAdmin; + + // Store admin with value pendingAdmin + admin = pendingAdmin; + + // Clear the pending value + pendingAdmin = address(0); + + emit NewAdmin(oldAdmin, admin); + emit NewPendingAdmin(oldPendingAdmin, pendingAdmin); + + return uint(Error.NO_ERROR); + } + + /** + * @notice Sets a new comptroller for the market + * @dev Admin function to set a new comptroller + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function _setComptroller(ComptrollerInterface newComptroller) public returns (uint) { + // Check caller is admin + if (msg.sender != admin) { + return fail(Error.UNAUTHORIZED, FailureInfo.SET_COMPTROLLER_OWNER_CHECK); + } + + ComptrollerInterface oldComptroller = comptroller; + // Ensure invoke comptroller.isComptroller() returns true + require(newComptroller.isComptroller(), "marker method returned false"); + + // Set market's comptroller to newComptroller + comptroller = newComptroller; + + // Emit NewComptroller(oldComptroller, newComptroller) + emit NewComptroller(oldComptroller, newComptroller); + + return uint(Error.NO_ERROR); + } + + /** + * @notice accrues interest and sets a new reserve factor for the protocol using _setReserveFactorFresh + * @dev Admin function to accrue interest and set a new reserve factor + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function _setReserveFactor(uint newReserveFactorMantissa) external nonReentrant returns (uint) { + uint error = accrueInterest(); + if (error != uint(Error.NO_ERROR)) { + // accrueInterest emits logs on errors, but on top of that we want to log the fact that an attempted reserve factor change failed. + return fail(Error(error), FailureInfo.SET_RESERVE_FACTOR_ACCRUE_INTEREST_FAILED); + } + // _setReserveFactorFresh emits reserve-factor-specific logs on errors, so we don't need to. + return _setReserveFactorFresh(newReserveFactorMantissa); + } + + /** + * @notice Sets a new reserve factor for the protocol (*requires fresh interest accrual) + * @dev Admin function to set a new reserve factor + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function _setReserveFactorFresh(uint newReserveFactorMantissa) internal returns (uint) { + // Check caller is admin + if (msg.sender != admin) { + return fail(Error.UNAUTHORIZED, FailureInfo.SET_RESERVE_FACTOR_ADMIN_CHECK); + } + + // Verify market's block number equals current block number + if (accrualBlockNumber != getBlockNumber()) { + return fail(Error.MARKET_NOT_FRESH, FailureInfo.SET_RESERVE_FACTOR_FRESH_CHECK); + } + + // Check newReserveFactor ≤ maxReserveFactor + if (newReserveFactorMantissa > reserveFactorMaxMantissa) { + return fail(Error.BAD_INPUT, FailureInfo.SET_RESERVE_FACTOR_BOUNDS_CHECK); + } + + uint oldReserveFactorMantissa = reserveFactorMantissa; + reserveFactorMantissa = newReserveFactorMantissa; + + emit NewReserveFactor(oldReserveFactorMantissa, newReserveFactorMantissa); + + return uint(Error.NO_ERROR); + } + + /** + * @notice Accrues interest and reduces reserves by transferring from msg.sender + * @param addAmount Amount of addition to reserves + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function _addReservesInternal(uint addAmount) internal nonReentrant returns (uint) { + uint error = accrueInterest(); + if (error != uint(Error.NO_ERROR)) { + // accrueInterest emits logs on errors, but on top of that we want to log the fact that an attempted reduce reserves failed. + return fail(Error(error), FailureInfo.ADD_RESERVES_ACCRUE_INTEREST_FAILED); + } + + // _addReservesFresh emits reserve-addition-specific logs on errors, so we don't need to. + (error, ) = _addReservesFresh(addAmount); + return error; + } + + /** + * @notice Add reserves by transferring from caller + * @dev Requires fresh interest accrual + * @param addAmount Amount of addition to reserves + * @return (uint, uint) An error code (0=success, otherwise a failure (see ErrorReporter.sol for details)) and the actual amount added, net token fees + */ + function _addReservesFresh(uint addAmount) internal returns (uint, uint) { + // totalReserves + actualAddAmount + uint totalReservesNew; + uint actualAddAmount; + + // We fail gracefully unless market's block number equals current block number + if (accrualBlockNumber != getBlockNumber()) { + return (fail(Error.MARKET_NOT_FRESH, FailureInfo.ADD_RESERVES_FRESH_CHECK), actualAddAmount); + } + + ///////////////////////// + // EFFECTS & INTERACTIONS + // (No safe failures beyond this point) + + /* + * We call doTransferIn for the caller and the addAmount + * Note: The cToken must handle variations between ERC-20 and ETH underlying. + * On success, the cToken holds an additional addAmount of cash. + * doTransferIn reverts if anything goes wrong, since we can't be sure if side effects occurred. + * it returns the amount actually transferred, in case of a fee. + */ + + actualAddAmount = doTransferIn(msg.sender, addAmount); + + totalReservesNew = totalReserves + actualAddAmount; + + /* Revert on overflow */ + require(totalReservesNew >= totalReserves, "add reserves unexpected overflow"); + + // Store reserves[n+1] = reserves[n] + actualAddAmount + totalReserves = totalReservesNew; + + /* Emit NewReserves(admin, actualAddAmount, reserves[n+1]) */ + emit ReservesAdded(msg.sender, actualAddAmount, totalReservesNew); + + /* Return (NO_ERROR, actualAddAmount) */ + return (uint(Error.NO_ERROR), actualAddAmount); + } + + + /** + * @notice Accrues interest and reduces reserves by transferring to admin + * @param reduceAmount Amount of reduction to reserves + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function _reduceReserves(uint reduceAmount) external nonReentrant returns (uint) { + uint error = accrueInterest(); + if (error != uint(Error.NO_ERROR)) { + // accrueInterest emits logs on errors, but on top of that we want to log the fact that an attempted reduce reserves failed. + return fail(Error(error), FailureInfo.REDUCE_RESERVES_ACCRUE_INTEREST_FAILED); + } + // _reduceReservesFresh emits reserve-reduction-specific logs on errors, so we don't need to. + return _reduceReservesFresh(reduceAmount); + } + + /** + * @notice Reduces reserves by transferring to admin + * @dev Requires fresh interest accrual + * @param reduceAmount Amount of reduction to reserves + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function _reduceReservesFresh(uint reduceAmount) internal returns (uint) { + // totalReserves - reduceAmount + uint totalReservesNew; + + // Check caller is admin + if (msg.sender != reserveAdmin) { + return fail(Error.UNAUTHORIZED, FailureInfo.REDUCE_RESERVES_ADMIN_CHECK); + } + + // We fail gracefully unless market's block number equals current block number + if (accrualBlockNumber != getBlockNumber()) { + return fail(Error.MARKET_NOT_FRESH, FailureInfo.REDUCE_RESERVES_FRESH_CHECK); + } + + // Fail gracefully if protocol has insufficient underlying cash + if (getCashPrior() < reduceAmount) { + return fail(Error.TOKEN_INSUFFICIENT_CASH, FailureInfo.REDUCE_RESERVES_CASH_NOT_AVAILABLE); + } + + // Check reduceAmount ≤ reserves[n] (totalReserves) + if (reduceAmount > totalReserves) { + return fail(Error.BAD_INPUT, FailureInfo.REDUCE_RESERVES_VALIDATION); + } + + ///////////////////////// + // EFFECTS & INTERACTIONS + // (No safe failures beyond this point) + + totalReservesNew = totalReserves - reduceAmount; + // We checked reduceAmount <= totalReserves above, so this should never revert. + require(totalReservesNew <= totalReserves, "reduce reserves unexpected underflow"); + + // Store reserves[n+1] = reserves[n] - reduceAmount + totalReserves = totalReservesNew; + + // doTransferOut reverts if anything goes wrong, since we can't be sure if side effects occurred. + doTransferOut(reserveAdmin, reduceAmount); + + emit ReservesReduced(reserveAdmin, reduceAmount, totalReservesNew); + + return uint(Error.NO_ERROR); + } + + /** + * @notice accrues interest and updates the interest rate model using _setInterestRateModelFresh + * @dev Admin function to accrue interest and update the interest rate model + * @param newInterestRateModel the new interest rate model to use + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function _setInterestRateModel(InterestRateModel newInterestRateModel) public returns (uint) { + uint error = accrueInterest(); + if (error != uint(Error.NO_ERROR)) { + // accrueInterest emits logs on errors, but on top of that we want to log the fact that an attempted change of interest rate model failed + return fail(Error(error), FailureInfo.SET_INTEREST_RATE_MODEL_ACCRUE_INTEREST_FAILED); + } + // _setInterestRateModelFresh emits interest-rate-model-update-specific logs on errors, so we don't need to. + return _setInterestRateModelFresh(newInterestRateModel); + } + + /** + * @notice updates the interest rate model (*requires fresh interest accrual) + * @dev Admin function to update the interest rate model + * @param newInterestRateModel the new interest rate model to use + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function _setInterestRateModelFresh(InterestRateModel newInterestRateModel) internal returns (uint) { + + // Used to store old model for use in the event that is emitted on success + InterestRateModel oldInterestRateModel; + + // Check caller is admin + if (msg.sender != admin) { + return fail(Error.UNAUTHORIZED, FailureInfo.SET_INTEREST_RATE_MODEL_OWNER_CHECK); + } + + // We fail gracefully unless market's block number equals current block number + if (accrualBlockNumber != getBlockNumber()) { + return fail(Error.MARKET_NOT_FRESH, FailureInfo.SET_INTEREST_RATE_MODEL_FRESH_CHECK); + } + + // Track the market's current interest rate model + oldInterestRateModel = interestRateModel; + + // Ensure invoke newInterestRateModel.isInterestRateModel() returns true + require(newInterestRateModel.isInterestRateModel(), "marker method returned false"); + + // Set the interest rate model to newInterestRateModel + interestRateModel = newInterestRateModel; + + // Emit NewMarketInterestRateModel(oldInterestRateModel, newInterestRateModel) + emit NewMarketInterestRateModel(oldInterestRateModel, newInterestRateModel); + + return uint(Error.NO_ERROR); + } + + /*** Safe Token ***/ + + /** + * @notice Gets balance of this contract in terms of the underlying + * @dev This excludes the value of the current message, if any + * @return The quantity of underlying owned by this contract + */ + function getCashPrior() internal view returns (uint); + + /** + * @dev Performs a transfer in, reverting upon failure. Returns the amount actually transferred to the protocol, in case of a fee. + * This may revert due to insufficient balance or insufficient allowance. + */ + function doTransferIn(address from, uint amount) internal returns (uint); + + /** + * @dev Performs a transfer out, ideally returning an explanatory error code upon failure tather than reverting. + * If caller has not called checked protocol's balance, may revert due to insufficient cash held in the contract. + * If caller has checked protocol's balance, and verified it is >= amount, this should not revert in normal conditions. + */ + function doTransferOut(address payable to, uint amount) internal; + + + /*** Reentrancy Guard ***/ + + /** + * @dev Prevents a contract from calling itself, directly or indirectly. + */ + modifier nonReentrant() { + require(_notEntered, "re-entered"); + _notEntered = false; + _; + _notEntered = true; // get a gas-refund post-Istanbul + } +} diff --git a/contracts/CTokenInterfaces.sol b/contracts/CTokenInterfaces.sol new file mode 100644 index 0000000..85fbc51 --- /dev/null +++ b/contracts/CTokenInterfaces.sol @@ -0,0 +1,315 @@ +pragma solidity ^0.5.12; + +import "./ComptrollerInterface.sol"; +import "./InterestRateModel.sol"; + +contract CTokenStorage { + /** + * @dev Guard variable for re-entrancy checks + */ + bool internal _notEntered; + + /** + * @notice EIP-20 token name for this token + */ + string public name; + + /** + * @notice EIP-20 token symbol for this token + */ + string public symbol; + + /** + * @notice EIP-20 token decimals for this token + */ + uint8 public decimals; + + /** + * @notice Maximum borrow rate that can ever be applied (.0005% / block) + */ + + uint internal constant borrowRateMaxMantissa = 0.0005e16; + + /** + * @notice Maximum fraction of interest that can be set aside for reserves + */ + uint internal constant reserveFactorMaxMantissa = 1e18; + + /** + * @notice Administrator for this contract + */ + address payable public admin; + + /** + * @notice Administrator for reserve + */ + address payable public reserveAdmin; + + /** + * @notice Pending administrator for this contract + */ + address payable public pendingAdmin; + + /** + * @notice Contract which oversees inter-cToken operations + */ + ComptrollerInterface public comptroller; + + /** + * @notice Model which tells what the current interest rate should be + */ + InterestRateModel public interestRateModel; + + /** + * @notice Initial exchange rate used when minting the first CTokens (used when totalSupply = 0) + */ + uint internal initialExchangeRateMantissa; + + /** + * @notice Fraction of interest currently set aside for reserves + */ + uint public reserveFactorMantissa; + + /** + * @notice Block number that interest was last accrued at + */ + uint public accrualBlockNumber; + + /** + * @notice Accumulator of the total earned interest rate since the opening of the market + */ + uint public borrowIndex; + + /** + * @notice Total amount of outstanding borrows of the underlying in this market + */ + uint public totalBorrows; + + /** + * @notice Total amount of reserves of the underlying held in this market + */ + uint public totalReserves; + + /** + * @notice Total number of tokens in circulation + */ + uint public totalSupply; + + /** + * @notice Official record of token balances for each account + */ + mapping (address => uint) internal accountTokens; + + /** + * @notice Approved token transfer amounts on behalf of others + */ + mapping (address => mapping (address => uint)) internal transferAllowances; + + /** + * @notice Container for borrow balance information + * @member principal Total balance (with accrued interest), after applying the most recent balance-changing action + * @member interestIndex Global borrowIndex as of the most recent balance-changing action + */ + struct BorrowSnapshot { + uint principal; + uint interestIndex; + } + + /** + * @notice Mapping of account addresses to outstanding borrow balances + */ + mapping(address => BorrowSnapshot) internal accountBorrows; +} + +contract CTokenInterface is CTokenStorage { + /** + * @notice Indicator that this is a CToken contract (for inspection) + */ + bool public constant isCToken = true; + + + /*** Market Events ***/ + + event JTokenStatus(uint totalCash, uint totalBorrow, uint totalReserve, uint totalSupply, uint borrowRatePerBlock, uint borrowIndex, uint reserveFactorMantissa); + + + event JTokenBalance(address user, uint jtoken_balance); + + + /** + * @notice Event emitted when interest is accrued + */ + event AccrueInterest(uint cashPrior, uint interestAccumulated, uint borrowIndex, uint totalBorrows); + + /** + * @notice Event emitted when tokens are minted + */ + event Mint(address minter, uint mintAmount, uint mintTokens); + + /** + * @notice Event emitted when tokens are redeemed + */ + event Redeem(address redeemer, uint redeemAmount, uint redeemTokens); + + /** + * @notice Event emitted when underlying is borrowed + */ + event Borrow(address borrower, uint borrowAmount, uint accountBorrows, uint totalBorrows, uint borrowIndex); + + /** + * @notice Event emitted when a borrow is repaid + */ + event RepayBorrow(address payer, address borrower, uint repayAmount, uint accountBorrows, uint totalBorrows, uint borrowIndex); + + /** + * @notice Event emitted when a borrow is liquidated + */ + event LiquidateBorrow(address liquidator, address borrower, uint repayAmount, address cTokenCollateral, uint seizeTokens); + + + /*** Admin Events ***/ + + /** + * @notice Event emitted when pendingAdmin is changed + */ + event NewPendingAdmin(address oldPendingAdmin, address newPendingAdmin); + + /** + * @notice Event emitted when pendingAdmin is accepted, which means admin is updated + */ + event NewAdmin(address oldAdmin, address newAdmin); + + + event NewReserveAdmin(address oldAdmin, address newAdmin); + /** + * @notice Event emitted when comptroller is changed + */ + event NewComptroller(ComptrollerInterface oldComptroller, ComptrollerInterface newComptroller); + + /** + * @notice Event emitted when interestRateModel is changed + */ + event NewMarketInterestRateModel(InterestRateModel oldInterestRateModel, InterestRateModel newInterestRateModel); + + /** + * @notice Event emitted when the reserve factor is changed + */ + event NewReserveFactor(uint oldReserveFactorMantissa, uint newReserveFactorMantissa); + + /** + * @notice Event emitted when the reserves are added + */ + event ReservesAdded(address benefactor, uint addAmount, uint newTotalReserves); + + /** + * @notice Event emitted when the reserves are reduced + */ + event ReservesReduced(address admin, uint reduceAmount, uint newTotalReserves); + + /** + * @notice EIP20 Transfer event + */ + event Transfer(address indexed from, address indexed to, uint amount); + + /** + * @notice EIP20 Approval event + */ + event Approval(address indexed owner, address indexed spender, uint amount); + + /** + * @notice Failure event + */ + event Failure(uint error, uint info, uint detail); + + + /*** User Interface ***/ + + function transfer(address dst, uint amount) external returns (bool); + function transferFrom(address src, address dst, uint amount) external returns (bool); + function approve(address spender, uint amount) external returns (bool); + function allowance(address owner, address spender) external view returns (uint); + function balanceOf(address owner) external view returns (uint); + function balanceOfUnderlying(address owner) external returns (uint); + function getAccountSnapshot(address account) external view returns (uint, uint, uint, uint); + function borrowRatePerBlock() external view returns (uint); + function supplyRatePerBlock() external view returns (uint); + function totalBorrowsCurrent() external returns (uint); + function borrowBalanceCurrent(address account) external returns (uint); + function borrowBalanceStored(address account) public view returns (uint); + function exchangeRateCurrent() public returns (uint); + function exchangeRateStored() public view returns (uint); + function getCash() external view returns (uint); + function accrueInterest() public returns (uint); + function seize(address liquidator, address borrower, uint seizeTokens) external returns (uint); + + + /*** Admin Functions ***/ + + function _setPendingAdmin(address payable newPendingAdmin) external returns (uint); + function _acceptAdmin() external returns (uint); + function _setComptroller(ComptrollerInterface newComptroller) public returns (uint); + function _setReserveFactor(uint newReserveFactorMantissa) external returns (uint); + function _reduceReserves(uint reduceAmount) external returns (uint); + function _setInterestRateModel(InterestRateModel newInterestRateModel) public returns (uint); +} + +contract CErc20Storage { + /** + * @notice Underlying asset for this CToken + */ + address public underlying; +} + +contract CErc20Interface is CErc20Storage { + + /*** User Interface ***/ + + function mint(uint mintAmount) external returns (uint); + function redeem(uint redeemTokens) external returns (uint); + function redeemUnderlying(uint redeemAmount) external returns (uint); + function borrow(uint borrowAmount) external returns (uint); + function repayBorrow(uint repayAmount) external returns (uint); + function repayBorrowBehalf(address borrower, uint repayAmount) external returns (uint); + function liquidateBorrow(address borrower, uint repayAmount, CTokenInterface cTokenCollateral) external returns (uint); + + + /*** Admin Functions ***/ + + function _addReserves(uint addAmount) external returns (uint); +} + +contract CDelegationStorage { + /** + * @notice Implementation address for this contract + */ + address public implementation; +} + +contract CDelegatorInterface is CDelegationStorage { + /** + * @notice Emitted when implementation is changed + */ + event NewImplementation(address oldImplementation, address newImplementation); + + /** + * @notice Called by the admin to update the implementation of the delegator + * @param implementation_ The address of the new implementation for delegation + * @param allowResign Flag to indicate whether to call _resignImplementation on the old implementation + * @param becomeImplementationData The encoded bytes data to be passed to _becomeImplementation + */ + function _setImplementation(address implementation_, bool allowResign, bytes memory becomeImplementationData) public; +} + +contract CDelegateInterface is CDelegationStorage { + /** + * @notice Called by the delegator on a delegate to initialize it for duty + * @dev Should revert if any issues arise which make it unfit for delegation + * @param data The encoded bytes data for any initialization + */ + function _becomeImplementation(bytes memory data) public; + + /** + * @notice Called by the delegator on a delegate to forfeit its responsibility + */ + function _resignImplementation() public; +} diff --git a/contracts/CarefulMath.sol b/contracts/CarefulMath.sol new file mode 100644 index 0000000..4408881 --- /dev/null +++ b/contracts/CarefulMath.sol @@ -0,0 +1,85 @@ +pragma solidity ^0.5.12; + +/** + * @title Careful Math + * @author Compound + * @notice Derived from OpenZeppelin's SafeMath library + * https://github.com/OpenZeppelin/openzeppelin-solidity/blob/master/contracts/math/SafeMath.sol + */ +contract CarefulMath { + + /** + * @dev Possible error codes that we can return + */ + enum MathError { + NO_ERROR, + DIVISION_BY_ZERO, + INTEGER_OVERFLOW, + INTEGER_UNDERFLOW + } + + /** + * @dev Multiplies two numbers, returns an error on overflow. + */ + function mulUInt(uint a, uint b) internal pure returns (MathError, uint) { + if (a == 0) { + return (MathError.NO_ERROR, 0); + } + + uint c = a * b; + + if (c / a != b) { + return (MathError.INTEGER_OVERFLOW, 0); + } else { + return (MathError.NO_ERROR, c); + } + } + + /** + * @dev Integer division of two numbers, truncating the quotient. + */ + function divUInt(uint a, uint b) internal pure returns (MathError, uint) { + if (b == 0) { + return (MathError.DIVISION_BY_ZERO, 0); + } + + return (MathError.NO_ERROR, a / b); + } + + /** + * @dev Subtracts two numbers, returns an error on overflow (i.e. if subtrahend is greater than minuend). + */ + function subUInt(uint a, uint b) internal pure returns (MathError, uint) { + if (b <= a) { + return (MathError.NO_ERROR, a - b); + } else { + return (MathError.INTEGER_UNDERFLOW, 0); + } + } + + /** + * @dev Adds two numbers, returns an error on overflow. + */ + function addUInt(uint a, uint b) internal pure returns (MathError, uint) { + uint c = a + b; + + if (c >= a) { + return (MathError.NO_ERROR, c); + } else { + return (MathError.INTEGER_OVERFLOW, 0); + } + } + + /** + * @dev add a and b and then subtract c + */ + function addThenSubUInt(uint a, uint b, uint c) internal pure returns (MathError, uint) { + (MathError err0, uint sum) = addUInt(a, b); + + if (err0 != MathError.NO_ERROR) { + return (err0, 0); + } + + return subUInt(sum, c); + } +} \ No newline at end of file diff --git a/contracts/Comptroller.sol b/contracts/Comptroller.sol new file mode 100644 index 0000000..f15b6ba --- /dev/null +++ b/contracts/Comptroller.sol @@ -0,0 +1,1095 @@ +pragma solidity ^0.5.12; + +import "./CToken.sol"; +import "./ErrorReporter.sol"; +import "./Exponential.sol"; +import "./PriceOracle.sol"; +import "./ComptrollerInterface.sol"; +import "./ComptrollerStorage.sol"; +import "./Unitroller.sol"; +import "./Governance/Comp.sol"; + +/** + * @title Compound's Comptroller Contract + * @author Compound + */ +contract Comptroller is ComptrollerV3Storage, ComptrollerInterface, ComptrollerErrorReporter, Exponential { + /// @notice Emitted when an admin supports a market + event MarketListed(CToken cToken); + + /// @notice Emitted when an account enters a market + event MarketEntered(CToken cToken, address account); + + /// @notice Emitted when an account exits a market + event MarketExited(CToken cToken, address account); + + /// @notice Emitted when close factor is changed by admin + event NewCloseFactor(uint oldCloseFactorMantissa, uint newCloseFactorMantissa); + + /// @notice Emitted when a collateral factor is changed by admin + event NewCollateralFactor(CToken cToken, uint oldCollateralFactorMantissa, uint newCollateralFactorMantissa); + + /// @notice Emitted when liquidation incentive is changed by admin + event NewLiquidationIncentive(uint oldLiquidationIncentiveMantissa, uint newLiquidationIncentiveMantissa); + + /// @notice Emitted when maxAssets is changed by admin + event NewMaxAssets(uint oldMaxAssets, uint newMaxAssets); + + /// @notice Emitted when price oracle is changed + event NewPriceOracle(PriceOracle oldPriceOracle, PriceOracle newPriceOracle); + + /// @notice Emitted when pause guardian is changed + event NewPauseGuardian(address oldPauseGuardian, address newPauseGuardian); + + /// @notice Emitted when an action is paused globally + event ActionPaused(string action, bool pauseState); + + /// @notice Emitted when an action is paused on a market + event ActionPaused(CToken cToken, string action, bool pauseState); + + // closeFactorMantissa must be strictly greater than this value + uint internal constant closeFactorMinMantissa = 0.05e18; // 0.05 + + // closeFactorMantissa must not exceed this value + uint internal constant closeFactorMaxMantissa = 0.9e18; // 0.9 + + // No collateralFactorMantissa may exceed this value + uint internal constant collateralFactorMaxMantissa = 0.9e18; // 0.9 + + // liquidationIncentiveMantissa must be no less than this value + uint internal constant liquidationIncentiveMinMantissa = 1.0e18; // 1.0 + + // liquidationIncentiveMantissa must be no greater than this value + uint internal constant liquidationIncentiveMaxMantissa = 1.5e18; // 1.5 + + constructor() public { + admin = msg.sender; + } + + /*** Assets You Are In ***/ + + /** + * @notice Returns the assets an account has entered + * @param account The address of the account to pull assets for + * @return A dynamic list with the assets the account has entered + */ + function getAssetsIn(address account) external view returns (CToken[] memory) { + CToken[] memory assetsIn = accountAssets[account]; + + return assetsIn; + } + + /** + * @notice Returns whether the given account is entered in the given asset + * @param account The address of the account to check + * @param cToken The cToken to check + * @return True if the account is in the asset, otherwise false. + */ + function checkMembership(address account, CToken cToken) external view returns (bool) { + return markets[address(cToken)].accountMembership[account]; + } + + /** + * @notice Add assets to be included in account liquidity calculation + * @param cTokens The list of addresses of the cToken markets to be enabled + * @return Success indicator for whether each corresponding market was entered + */ + function enterMarkets(address[] memory cTokens) public returns (uint[] memory) { + uint len = cTokens.length; + + uint[] memory results = new uint[](len); + for (uint i = 0; i < len; i++) { + CToken cToken = CToken(cTokens[i]); + + results[i] = uint(addToMarketInternal(cToken, msg.sender)); + } + + return results; + } + + + + /** + * @notice Add an asset to be included in account liquidity calculation + * @param _cToken The list of addresses of the cToken markets to be enabled + * @return Success indicator for whether each corresponding market was entered + */ + function enterMarket(address _cToken) public returns (uint) { + CToken cToken = CToken(_cToken); + return uint(addToMarketInternal(cToken, msg.sender)); + } + + /** + * @notice Add the market to the borrower's "assets in" for liquidity calculations + * @param cToken The market to enter + * @param borrower The address of the account to modify + * @return Success indicator for whether the market was entered + */ + function addToMarketInternal(CToken cToken, address borrower) internal returns (Error) { + Market storage marketToJoin = markets[address(cToken)]; + + if (!marketToJoin.isListed) { + // market is not listed, cannot join + return Error.MARKET_NOT_LISTED; + } + + if (marketToJoin.accountMembership[borrower] == true) { + // already joined + return Error.NO_ERROR; + } + + if (accountAssets[borrower].length >= maxAssets) { + // no space, cannot join + return Error.TOO_MANY_ASSETS; + } + + // survived the gauntlet, add to list + // NOTE: we store these somewhat redundantly as a significant optimization + // this avoids having to iterate through the list for the most common use cases + // that is, only when we need to perform liquidity checks + // and not whenever we want to check if an account is in a particular market + marketToJoin.accountMembership[borrower] = true; + accountAssets[borrower].push(cToken); + + emit MarketEntered(cToken, borrower); + + return Error.NO_ERROR; + } + + /** + * @notice Removes asset from sender's account liquidity calculation + * @dev Sender must not have an outstanding borrow balance in the asset, + * or be providing neccessary collateral for an outstanding borrow. + * @param cTokenAddress The address of the asset to be removed + * @return Whether or not the account successfully exited the market + */ + function exitMarket(address cTokenAddress) external returns (uint) { + CToken cToken = CToken(cTokenAddress); + /* Get sender tokensHeld and amountOwed underlying from the cToken */ + (uint oErr, uint tokensHeld, uint amountOwed, ) = cToken.getAccountSnapshot(msg.sender); + require(oErr == 0, "exitMarket: getAccountSnapshot failed"); // semi-opaque error code + + /* Fail if the sender has a borrow balance */ + if (amountOwed != 0) { + return fail(Error.NONZERO_BORROW_BALANCE, FailureInfo.EXIT_MARKET_BALANCE_OWED); + } + + /* Fail if the sender is not permitted to redeem all of their tokens */ + uint allowed = redeemAllowedInternal(cTokenAddress, msg.sender, tokensHeld); + if (allowed != 0) { + return failOpaque(Error.REJECTION, FailureInfo.EXIT_MARKET_REJECTION, allowed); + } + + Market storage marketToExit = markets[address(cToken)]; + + /* Return true if the sender is not already ‘in’ the market */ + if (!marketToExit.accountMembership[msg.sender]) { + return uint(Error.NO_ERROR); + } + + /* Set cToken account membership to false */ + delete marketToExit.accountMembership[msg.sender]; + + /* Delete cToken from the account’s list of assets */ + // load into memory for faster iteration + CToken[] memory userAssetList = accountAssets[msg.sender]; + uint len = userAssetList.length; + uint assetIndex = len; + for (uint i = 0; i < len; i++) { + if (userAssetList[i] == cToken) { + assetIndex = i; + break; + } + } + + // We *must* have found the asset in the list or our redundant data structure is broken + assert(assetIndex < len); + + // copy last item in list to location of item to be removed, reduce length by 1 + CToken[] storage storedList = accountAssets[msg.sender]; + storedList[assetIndex] = storedList[storedList.length - 1]; + storedList.length--; + + emit MarketExited(cToken, msg.sender); + + return uint(Error.NO_ERROR); + } + + /*** Policy Hooks ***/ + + /** + * @notice Checks if the account should be allowed to mint tokens in the given market + * @param cToken The market to verify the mint against + * @param minter The account which would get the minted tokens + * @param mintAmount The amount of underlying being supplied to the market in exchange for tokens + * @return 0 if the mint is allowed, otherwise a semi-opaque error code (See ErrorReporter.sol) + */ + function mintAllowed(address cToken, address minter, uint mintAmount) external returns (uint) { + // Pausing is a very serious situation - we revert to sound the alarms + require(!mintGuardianPaused[cToken], "mint is paused"); + + // Shh - currently unused + minter; + mintAmount; + + if (!markets[cToken].isListed) { + return uint(Error.MARKET_NOT_LISTED); + } + + // *may include Policy Hook-type checks + + return uint(Error.NO_ERROR); + } + + /** + * @notice Validates mint and reverts on rejection. May emit logs. + * @param cToken Asset being minted + * @param minter The address minting the tokens + * @param actualMintAmount The amount of the underlying asset being minted + * @param mintTokens The number of tokens being minted + */ + function mintVerify(address cToken, address minter, uint actualMintAmount, uint mintTokens) external { + // Shh - currently unused + cToken; + minter; + actualMintAmount; + mintTokens; + + // Shh - we don't ever want this hook to be marked pure + if (false) { + maxAssets = maxAssets; + } + } + + /** + * @notice Checks if the account should be allowed to redeem tokens in the given market + * @param cToken The market to verify the redeem against + * @param redeemer The account which would redeem the tokens + * @param redeemTokens The number of cTokens to exchange for the underlying asset in the market + * @return 0 if the redeem is allowed, otherwise a semi-opaque error code (See ErrorReporter.sol) + */ + function redeemAllowed(address cToken, address redeemer, uint redeemTokens) external returns (uint) { + return redeemAllowedInternal(cToken, redeemer, redeemTokens); + } + + function redeemAllowedInternal(address cToken, address redeemer, uint redeemTokens) internal view returns (uint) { + if (!markets[cToken].isListed) { + return uint(Error.MARKET_NOT_LISTED); + } + + /* If the redeemer is not 'in' the market, then we can bypass the liquidity check */ + if (!markets[cToken].accountMembership[redeemer]) { + return uint(Error.NO_ERROR); + } + + /* Otherwise, perform a hypothetical liquidity check to guard against shortfall */ + (Error err, , uint shortfall) = getHypotheticalAccountLiquidityInternal(redeemer, CToken(cToken), redeemTokens, 0); + if (err != Error.NO_ERROR) { + return uint(err); + } + if (shortfall > 0) { + return uint(Error.INSUFFICIENT_LIQUIDITY); + } + + return uint(Error.NO_ERROR); + } + + /** + * @notice Validates redeem and reverts on rejection. May emit logs. + * @param cToken Asset being redeemed + * @param redeemer The address redeeming the tokens + * @param redeemAmount The amount of the underlying asset being redeemed + * @param redeemTokens The number of tokens being redeemed + */ + function redeemVerify(address cToken, address redeemer, uint redeemAmount, uint redeemTokens) external { + // Shh - currently unused + cToken; + redeemer; + + // Require tokens is zero or amount is also zero + if (redeemTokens == 0 && redeemAmount > 0) { + revert("redeemTokens zero"); + } + } + + /** + * @notice Checks if the account should be allowed to borrow the underlying asset of the given market + * @param cToken The market to verify the borrow against + * @param borrower The account which would borrow the asset + * @param borrowAmount The amount of underlying the account would borrow + * @return 0 if the borrow is allowed, otherwise a semi-opaque error code (See ErrorReporter.sol) + */ + function borrowAllowed(address cToken, address borrower, uint borrowAmount) external returns (uint) { + // Pausing is a very serious situation - we revert to sound the alarms + require(!borrowGuardianPaused[cToken], "borrow is paused"); + + if (!markets[cToken].isListed) { + return uint(Error.MARKET_NOT_LISTED); + } + + if (!markets[cToken].accountMembership[borrower]) { + // only cTokens may call borrowAllowed if borrower not in market + require(msg.sender == cToken, "sender must be cToken"); + + // attempt to add borrower to the market + Error err = addToMarketInternal(CToken(msg.sender), borrower); + if (err != Error.NO_ERROR) { + return uint(err); + } + + // it should be impossible to break the important invariant + assert(markets[cToken].accountMembership[borrower]); + } + + if (oracle.getUnderlyingPrice(CToken(cToken)) == 0) { + return uint(Error.PRICE_ERROR); + } + + (Error err, , uint shortfall) = getHypotheticalAccountLiquidityInternal(borrower, CToken(cToken), 0, borrowAmount); + if (err != Error.NO_ERROR) { + return uint(err); + } + if (shortfall > 0) { + return uint(Error.INSUFFICIENT_LIQUIDITY); + } + + return uint(Error.NO_ERROR); + } + + /** + * @notice Validates borrow and reverts on rejection. May emit logs. + * @param cToken Asset whose underlying is being borrowed + * @param borrower The address borrowing the underlying + * @param borrowAmount The amount of the underlying asset requested to borrow + */ + function borrowVerify(address cToken, address borrower, uint borrowAmount) external { + // Shh - currently unused + cToken; + borrower; + borrowAmount; + + // Shh - we don't ever want this hook to be marked pure + if (false) { + maxAssets = maxAssets; + } + } + + /** + * @notice Checks if the account should be allowed to repay a borrow in the given market + * @param cToken The market to verify the repay against + * @param payer The account which would repay the asset + * @param borrower The account which would borrowed the asset + * @param repayAmount The amount of the underlying asset the account would repay + * @return 0 if the repay is allowed, otherwise a semi-opaque error code (See ErrorReporter.sol) + */ + function repayBorrowAllowed( + address cToken, + address payer, + address borrower, + uint repayAmount) external returns (uint) { + // Shh - currently unused + payer; + borrower; + repayAmount; + + if (!markets[cToken].isListed) { + return uint(Error.MARKET_NOT_LISTED); + } + + // *may include Policy Hook-type checks + + return uint(Error.NO_ERROR); + } + + /** + * @notice Validates repayBorrow and reverts on rejection. May emit logs. + * @param cToken Asset being repaid + * @param payer The address repaying the borrow + * @param borrower The address of the borrower + * @param actualRepayAmount The amount of underlying being repaid + */ + function repayBorrowVerify( + address cToken, + address payer, + address borrower, + uint actualRepayAmount, + uint borrowerIndex) external { + // Shh - currently unused + cToken; + payer; + borrower; + actualRepayAmount; + borrowerIndex; + + // Shh - we don't ever want this hook to be marked pure + if (false) { + maxAssets = maxAssets; + } + } + + /** + * @notice Checks if the liquidation should be allowed to occur + * @param cTokenBorrowed Asset which was borrowed by the borrower + * @param cTokenCollateral Asset which was used as collateral and will be seized + * @param liquidator The address repaying the borrow and seizing the collateral + * @param borrower The address of the borrower + * @param repayAmount The amount of underlying being repaid + */ + function liquidateBorrowAllowed( + address cTokenBorrowed, + address cTokenCollateral, + address liquidator, + address borrower, + uint repayAmount) external returns (uint) { + // Shh - currently unused + liquidator; + + if (!markets[cTokenBorrowed].isListed || !markets[cTokenCollateral].isListed) { + return uint(Error.MARKET_NOT_LISTED); + } + + /* The borrower must have shortfall in order to be liquidatable */ + (Error err, , uint shortfall) = getAccountLiquidityInternal(borrower); + if (err != Error.NO_ERROR) { + return uint(err); + } + if (shortfall == 0) { + return uint(Error.INSUFFICIENT_SHORTFALL); + } + + /* The liquidator may not repay more than what is allowed by the closeFactor */ + uint borrowBalance = CToken(cTokenBorrowed).borrowBalanceStored(borrower); + (MathError mathErr, uint maxClose) = mulScalarTruncate(Exp({mantissa: closeFactorMantissa}), borrowBalance); + if (mathErr != MathError.NO_ERROR) { + return uint(Error.MATH_ERROR); + } + if (repayAmount > maxClose) { + return uint(Error.TOO_MUCH_REPAY); + } + + return uint(Error.NO_ERROR); + } + + /** + * @notice Validates liquidateBorrow and reverts on rejection. May emit logs. + * @param cTokenBorrowed Asset which was borrowed by the borrower + * @param cTokenCollateral Asset which was used as collateral and will be seized + * @param liquidator The address repaying the borrow and seizing the collateral + * @param borrower The address of the borrower + * @param actualRepayAmount The amount of underlying being repaid + */ + function liquidateBorrowVerify( + address cTokenBorrowed, + address cTokenCollateral, + address liquidator, + address borrower, + uint actualRepayAmount, + uint seizeTokens) external { + // Shh - currently unused + cTokenBorrowed; + cTokenCollateral; + liquidator; + borrower; + actualRepayAmount; + seizeTokens; + + // Shh - we don't ever want this hook to be marked pure + if (false) { + maxAssets = maxAssets; + } + } + + /** + * @notice Checks if the seizing of assets should be allowed to occur + * @param cTokenCollateral Asset which was used as collateral and will be seized + * @param cTokenBorrowed Asset which was borrowed by the borrower + * @param liquidator The address repaying the borrow and seizing the collateral + * @param borrower The address of the borrower + * @param seizeTokens The number of collateral tokens to seize + */ + function seizeAllowed( + address cTokenCollateral, + address cTokenBorrowed, + address liquidator, + address borrower, + uint seizeTokens) external returns (uint) { + // Pausing is a very serious situation - we revert to sound the alarms + require(!seizeGuardianPaused, "seize is paused"); + + // Shh - currently unused + liquidator; + borrower; + seizeTokens; + + if (!markets[cTokenCollateral].isListed || !markets[cTokenBorrowed].isListed) { + return uint(Error.MARKET_NOT_LISTED); + } + + if (CToken(cTokenCollateral).comptroller() != CToken(cTokenBorrowed).comptroller()) { + return uint(Error.COMPTROLLER_MISMATCH); + } + + // *may include Policy Hook-type checks + + return uint(Error.NO_ERROR); + } + + /** + * @notice Validates seize and reverts on rejection. May emit logs. + * @param cTokenCollateral Asset which was used as collateral and will be seized + * @param cTokenBorrowed Asset which was borrowed by the borrower + * @param liquidator The address repaying the borrow and seizing the collateral + * @param borrower The address of the borrower + * @param seizeTokens The number of collateral tokens to seize + */ + function seizeVerify( + address cTokenCollateral, + address cTokenBorrowed, + address liquidator, + address borrower, + uint seizeTokens) external { + // Shh - currently unused + cTokenCollateral; + cTokenBorrowed; + liquidator; + borrower; + seizeTokens; + + // Shh - we don't ever want this hook to be marked pure + if (false) { + maxAssets = maxAssets; + } + } + + /** + * @notice Checks if the account should be allowed to transfer tokens in the given market + * @param cToken The market to verify the transfer against + * @param src The account which sources the tokens + * @param dst The account which receives the tokens + * @param transferTokens The number of cTokens to transfer + * @return 0 if the transfer is allowed, otherwise a semi-opaque error code (See ErrorReporter.sol) + */ + function transferAllowed(address cToken, address src, address dst, uint transferTokens) external returns (uint) { + // Pausing is a very serious situation - we revert to sound the alarms + require(!transferGuardianPaused, "transfer is paused"); + + // Shh - currently unused + dst; + + // *may include Policy Hook-type checks + + // Currently the only consideration is whether or not + // the src is allowed to redeem this many tokens + return redeemAllowedInternal(cToken, src, transferTokens); + } + + /** + * @notice Validates transfer and reverts on rejection. May emit logs. + * @param cToken Asset being transferred + * @param src The account which sources the tokens + * @param dst The account which receives the tokens + * @param transferTokens The number of cTokens to transfer + */ + function transferVerify(address cToken, address src, address dst, uint transferTokens) external { + // Shh - currently unused + cToken; + src; + dst; + transferTokens; + + // Shh - we don't ever want this hook to be marked pure + if (false) { + maxAssets = maxAssets; + } + } + + /*** Liquidity/Liquidation Calculations ***/ + + /** + * @dev Local vars for avoiding stack-depth limits in calculating account liquidity. + * Note that `cTokenBalance` is the number of cTokens the account owns in the market, + * whereas `borrowBalance` is the amount of underlying that the account has borrowed. + */ + struct AccountLiquidityLocalVars { + uint sumCollateral; + uint sumBorrowPlusEffects; + uint cTokenBalance; + uint borrowBalance; + uint exchangeRateMantissa; + uint oraclePriceMantissa; + Exp collateralFactor; + Exp exchangeRate; + Exp oraclePrice; + Exp tokensToDenom; + } + + /** + * @notice Determine the current account liquidity wrt collateral requirements + * @return (possible error code (semi-opaque), + account liquidity in excess of collateral requirements, + * account shortfall below collateral requirements) + */ + function getAccountLiquidity(address account) public view returns (uint, uint, uint) { + (Error err, uint liquidity, uint shortfall) = getHypotheticalAccountLiquidityInternal(account, CToken(0), 0, 0); + + return (uint(err), liquidity, shortfall); + } + + /** + * @notice Determine the current account liquidity wrt collateral requirements + * @return (possible error code, + account liquidity in excess of collateral requirements, + * account shortfall below collateral requirements) + */ + function getAccountLiquidityInternal(address account) internal view returns (Error, uint, uint) { + return getHypotheticalAccountLiquidityInternal(account, CToken(0), 0, 0); + } + + /** + * @notice Determine what the account liquidity would be if the given amounts were redeemed/borrowed + * @param cTokenModify The market to hypothetically redeem/borrow in + * @param account The account to determine liquidity for + * @param redeemTokens The number of tokens to hypothetically redeem + * @param borrowAmount The amount of underlying to hypothetically borrow + * @return (possible error code (semi-opaque), + hypothetical account liquidity in excess of collateral requirements, + * hypothetical account shortfall below collateral requirements) + */ + function getHypotheticalAccountLiquidity( + address account, + address cTokenModify, + uint redeemTokens, + uint borrowAmount) public view returns (uint, uint, uint) { + (Error err, uint liquidity, uint shortfall) = getHypotheticalAccountLiquidityInternal(account, CToken(cTokenModify), redeemTokens, borrowAmount); + return (uint(err), liquidity, shortfall); + } + + /** + * @notice Determine what the account liquidity would be if the given amounts were redeemed/borrowed + * @param cTokenModify The market to hypothetically redeem/borrow in + * @param account The account to determine liquidity for + * @param redeemTokens The number of tokens to hypothetically redeem + * @param borrowAmount The amount of underlying to hypothetically borrow + * @dev Note that we calculate the exchangeRateStored for each collateral cToken using stored data, + * without calculating accumulated interest. + * @return (possible error code, + hypothetical account liquidity in excess of collateral requirements, + * hypothetical account shortfall below collateral requirements) + */ + function getHypotheticalAccountLiquidityInternal( + address account, + CToken cTokenModify, + uint redeemTokens, + uint borrowAmount) internal view returns (Error, uint, uint) { + + AccountLiquidityLocalVars memory vars; // Holds all our calculation results + uint oErr; + MathError mErr; + + // For each asset the account is in + CToken[] memory assets = accountAssets[account]; + for (uint i = 0; i < assets.length; i++) { + CToken asset = assets[i]; + + // Read the balances and exchange rate from the cToken + (oErr, vars.cTokenBalance, vars.borrowBalance, vars.exchangeRateMantissa) = asset.getAccountSnapshot(account); + if (oErr != 0) { // semi-opaque error code, we assume NO_ERROR == 0 is invariant between upgrades + return (Error.SNAPSHOT_ERROR, 0, 0); + } + vars.collateralFactor = Exp({mantissa: markets[address(asset)].collateralFactorMantissa}); + vars.exchangeRate = Exp({mantissa: vars.exchangeRateMantissa}); + + // Get the normalized price of the asset + vars.oraclePriceMantissa = oracle.getUnderlyingPrice(asset); + if (vars.oraclePriceMantissa == 0) { + return (Error.PRICE_ERROR, 0, 0); + } + vars.oraclePrice = Exp({mantissa: vars.oraclePriceMantissa}); + + // Pre-compute a conversion factor from tokens -> ether (normalized price value) + (mErr, vars.tokensToDenom) = mulExp3(vars.collateralFactor, vars.exchangeRate, vars.oraclePrice); + if (mErr != MathError.NO_ERROR) { + return (Error.MATH_ERROR, 0, 0); + } + + // sumCollateral += tokensToDenom * cTokenBalance + (mErr, vars.sumCollateral) = mulScalarTruncateAddUInt(vars.tokensToDenom, vars.cTokenBalance, vars.sumCollateral); + if (mErr != MathError.NO_ERROR) { + return (Error.MATH_ERROR, 0, 0); + } + + // sumBorrowPlusEffects += oraclePrice * borrowBalance + (mErr, vars.sumBorrowPlusEffects) = mulScalarTruncateAddUInt(vars.oraclePrice, vars.borrowBalance, vars.sumBorrowPlusEffects); + if (mErr != MathError.NO_ERROR) { + return (Error.MATH_ERROR, 0, 0); + } + + // Calculate effects of interacting with cTokenModify + if (asset == cTokenModify) { + // redeem effect + // sumBorrowPlusEffects += tokensToDenom * redeemTokens + (mErr, vars.sumBorrowPlusEffects) = mulScalarTruncateAddUInt(vars.tokensToDenom, redeemTokens, vars.sumBorrowPlusEffects); + if (mErr != MathError.NO_ERROR) { + return (Error.MATH_ERROR, 0, 0); + } + + // borrow effect + // sumBorrowPlusEffects += oraclePrice * borrowAmount + (mErr, vars.sumBorrowPlusEffects) = mulScalarTruncateAddUInt(vars.oraclePrice, borrowAmount, vars.sumBorrowPlusEffects); + if (mErr != MathError.NO_ERROR) { + return (Error.MATH_ERROR, 0, 0); + } + } + } + + // These are safe, as the underflow condition is checked first + if (vars.sumCollateral > vars.sumBorrowPlusEffects) { + return (Error.NO_ERROR, vars.sumCollateral - vars.sumBorrowPlusEffects, 0); + } else { + return (Error.NO_ERROR, 0, vars.sumBorrowPlusEffects - vars.sumCollateral); + } + } + + /** + * @notice Calculate number of tokens of collateral asset to seize given an underlying amount + * @dev Used in liquidation (called in cToken.liquidateBorrowFresh) + * @param cTokenBorrowed The address of the borrowed cToken + * @param cTokenCollateral The address of the collateral cToken + * @param actualRepayAmount The amount of cTokenBorrowed underlying to convert into cTokenCollateral tokens + * @return (errorCode, number of cTokenCollateral tokens to be seized in a liquidation) + */ + function liquidateCalculateSeizeTokens(address cTokenBorrowed, address cTokenCollateral, uint actualRepayAmount) external view returns (uint, uint) { + /* Read oracle prices for borrowed and collateral markets */ + uint priceBorrowedMantissa = oracle.getUnderlyingPrice(CToken(cTokenBorrowed)); + uint priceCollateralMantissa = oracle.getUnderlyingPrice(CToken(cTokenCollateral)); + if (priceBorrowedMantissa == 0 || priceCollateralMantissa == 0) { + return (uint(Error.PRICE_ERROR), 0); + } + + /* + * Get the exchange rate and calculate the number of collateral tokens to seize: + * seizeAmount = actualRepayAmount * liquidationIncentive * priceBorrowed / priceCollateral + * seizeTokens = seizeAmount / exchangeRate + * = actualRepayAmount * (liquidationIncentive * priceBorrowed) / (priceCollateral * exchangeRate) + */ + uint exchangeRateMantissa = CToken(cTokenCollateral).exchangeRateStored(); // Note: reverts on error + uint seizeTokens; + Exp memory numerator; + Exp memory denominator; + Exp memory ratio; + MathError mathErr; + + (mathErr, numerator) = mulExp(liquidationIncentiveMantissa, priceBorrowedMantissa); + if (mathErr != MathError.NO_ERROR) { + return (uint(Error.MATH_ERROR), 0); + } + + (mathErr, denominator) = mulExp(priceCollateralMantissa, exchangeRateMantissa); + if (mathErr != MathError.NO_ERROR) { + return (uint(Error.MATH_ERROR), 0); + } + + (mathErr, ratio) = divExp(numerator, denominator); + if (mathErr != MathError.NO_ERROR) { + return (uint(Error.MATH_ERROR), 0); + } + + (mathErr, seizeTokens) = mulScalarTruncate(ratio, actualRepayAmount); + if (mathErr != MathError.NO_ERROR) { + return (uint(Error.MATH_ERROR), 0); + } + + return (uint(Error.NO_ERROR), seizeTokens); + } + + /*** Admin Functions ***/ + + /** + * @notice Sets a new price oracle for the comptroller + * @dev Admin function to set a new price oracle + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function _setPriceOracle(PriceOracle newOracle) public returns (uint) { + // Check caller is admin + if (msg.sender != admin) { + return fail(Error.UNAUTHORIZED, FailureInfo.SET_PRICE_ORACLE_OWNER_CHECK); + } + + // Track the old oracle for the comptroller + PriceOracle oldOracle = oracle; + + // Set comptroller's oracle to newOracle + oracle = newOracle; + + // Emit NewPriceOracle(oldOracle, newOracle) + emit NewPriceOracle(oldOracle, newOracle); + + return uint(Error.NO_ERROR); + } + + /** + * @notice Sets the closeFactor used when liquidating borrows + * @dev Admin function to set closeFactor + * @param newCloseFactorMantissa New close factor, scaled by 1e18 + * @return uint 0=success, otherwise a failure. (See ErrorReporter for details) + */ + function _setCloseFactor(uint newCloseFactorMantissa) external returns (uint) { + // Check caller is admin + if (msg.sender != admin) { + return fail(Error.UNAUTHORIZED, FailureInfo.SET_CLOSE_FACTOR_OWNER_CHECK); + } + + Exp memory newCloseFactorExp = Exp({mantissa: newCloseFactorMantissa}); + Exp memory lowLimit = Exp({mantissa: closeFactorMinMantissa}); + if (lessThanOrEqualExp(newCloseFactorExp, lowLimit)) { + return fail(Error.INVALID_CLOSE_FACTOR, FailureInfo.SET_CLOSE_FACTOR_VALIDATION); + } + + Exp memory highLimit = Exp({mantissa: closeFactorMaxMantissa}); + if (lessThanExp(highLimit, newCloseFactorExp)) { + return fail(Error.INVALID_CLOSE_FACTOR, FailureInfo.SET_CLOSE_FACTOR_VALIDATION); + } + + uint oldCloseFactorMantissa = closeFactorMantissa; + closeFactorMantissa = newCloseFactorMantissa; + emit NewCloseFactor(oldCloseFactorMantissa, closeFactorMantissa); + + return uint(Error.NO_ERROR); + } + + /** + * @notice Sets the collateralFactor for a market + * @dev Admin function to set per-market collateralFactor + * @param cToken The market to set the factor on + * @param newCollateralFactorMantissa The new collateral factor, scaled by 1e18 + * @return uint 0=success, otherwise a failure. (See ErrorReporter for details) + */ + function _setCollateralFactor(CToken cToken, uint newCollateralFactorMantissa) external returns (uint) { + // Check caller is admin + if (msg.sender != admin) { + return fail(Error.UNAUTHORIZED, FailureInfo.SET_COLLATERAL_FACTOR_OWNER_CHECK); + } + + // Verify market is listed + Market storage market = markets[address(cToken)]; + if (!market.isListed) { + return fail(Error.MARKET_NOT_LISTED, FailureInfo.SET_COLLATERAL_FACTOR_NO_EXISTS); + } + + Exp memory newCollateralFactorExp = Exp({mantissa: newCollateralFactorMantissa}); + + // Check collateral factor <= 0.9 + Exp memory highLimit = Exp({mantissa: collateralFactorMaxMantissa}); + if (lessThanExp(highLimit, newCollateralFactorExp)) { + return fail(Error.INVALID_COLLATERAL_FACTOR, FailureInfo.SET_COLLATERAL_FACTOR_VALIDATION); + } + + // If collateral factor != 0, fail if price == 0 + if (newCollateralFactorMantissa != 0 && oracle.getUnderlyingPrice(cToken) == 0) { + return fail(Error.PRICE_ERROR, FailureInfo.SET_COLLATERAL_FACTOR_WITHOUT_PRICE); + } + + // Set market's collateral factor to new collateral factor, remember old value + uint oldCollateralFactorMantissa = market.collateralFactorMantissa; + market.collateralFactorMantissa = newCollateralFactorMantissa; + + // Emit event with asset, old collateral factor, and new collateral factor + emit NewCollateralFactor(cToken, oldCollateralFactorMantissa, newCollateralFactorMantissa); + + return uint(Error.NO_ERROR); + } + + /** + * @notice Sets maxAssets which controls how many markets can be entered + * @dev Admin function to set maxAssets + * @param newMaxAssets New max assets + * @return uint 0=success, otherwise a failure. (See ErrorReporter for details) + */ + function _setMaxAssets(uint newMaxAssets) external returns (uint) { + // Check caller is admin + if (msg.sender != admin) { + return fail(Error.UNAUTHORIZED, FailureInfo.SET_MAX_ASSETS_OWNER_CHECK); + } + + uint oldMaxAssets = maxAssets; + maxAssets = newMaxAssets; + emit NewMaxAssets(oldMaxAssets, newMaxAssets); + + return uint(Error.NO_ERROR); + } + + /** + * @notice Sets liquidationIncentive + * @dev Admin function to set liquidationIncentive + * @param newLiquidationIncentiveMantissa New liquidationIncentive scaled by 1e18 + * @return uint 0=success, otherwise a failure. (See ErrorReporter for details) + */ + function _setLiquidationIncentive(uint newLiquidationIncentiveMantissa) external returns (uint) { + // Check caller is admin + if (msg.sender != admin) { + return fail(Error.UNAUTHORIZED, FailureInfo.SET_LIQUIDATION_INCENTIVE_OWNER_CHECK); + } + + // Check de-scaled min <= newLiquidationIncentive <= max + Exp memory newLiquidationIncentive = Exp({mantissa: newLiquidationIncentiveMantissa}); + Exp memory minLiquidationIncentive = Exp({mantissa: liquidationIncentiveMinMantissa}); + if (lessThanExp(newLiquidationIncentive, minLiquidationIncentive)) { + return fail(Error.INVALID_LIQUIDATION_INCENTIVE, FailureInfo.SET_LIQUIDATION_INCENTIVE_VALIDATION); + } + + Exp memory maxLiquidationIncentive = Exp({mantissa: liquidationIncentiveMaxMantissa}); + if (lessThanExp(maxLiquidationIncentive, newLiquidationIncentive)) { + return fail(Error.INVALID_LIQUIDATION_INCENTIVE, FailureInfo.SET_LIQUIDATION_INCENTIVE_VALIDATION); + } + + // Save current value for use in log + uint oldLiquidationIncentiveMantissa = liquidationIncentiveMantissa; + + // Set liquidation incentive to new incentive + liquidationIncentiveMantissa = newLiquidationIncentiveMantissa; + + // Emit event with old incentive, new incentive + emit NewLiquidationIncentive(oldLiquidationIncentiveMantissa, newLiquidationIncentiveMantissa); + + return uint(Error.NO_ERROR); + } + + /** + * @notice Add the market to the markets mapping and set it as listed + * @dev Admin function to set isListed and add support for the market + * @param cToken The address of the market (token) to list + * @return uint 0=success, otherwise a failure. (See enum Error for details) + */ + function _supportMarket(CToken cToken) external returns (uint) { + if (msg.sender != admin) { + return fail(Error.UNAUTHORIZED, FailureInfo.SUPPORT_MARKET_OWNER_CHECK); + } + + if (markets[address(cToken)].isListed) { + return fail(Error.MARKET_ALREADY_LISTED, FailureInfo.SUPPORT_MARKET_EXISTS); + } + + cToken.isCToken(); // Sanity check to make sure its really a CToken + + markets[address(cToken)] = Market({isListed: true, isComped: false, collateralFactorMantissa: 0}); + + _addMarketInternal(address(cToken)); + + emit MarketListed(cToken); + + return uint(Error.NO_ERROR); + } + + function _addMarketInternal(address cToken) internal { + for (uint i = 0; i < allMarkets.length; i ++) { + require(allMarkets[i] != CToken(cToken), "market already added"); + } + allMarkets.push(CToken(cToken)); + } + + /** + * @notice Admin function to change the Pause Guardian + * @param newPauseGuardian The address of the new Pause Guardian + * @return uint 0=success, otherwise a failure. (See enum Error for details) + */ + function _setPauseGuardian(address newPauseGuardian) public returns (uint) { + if (msg.sender != admin) { + return fail(Error.UNAUTHORIZED, FailureInfo.SET_PAUSE_GUARDIAN_OWNER_CHECK); + } + + // Save current value for inclusion in log + address oldPauseGuardian = pauseGuardian; + + // Store pauseGuardian with value newPauseGuardian + pauseGuardian = newPauseGuardian; + + // Emit NewPauseGuardian(OldPauseGuardian, NewPauseGuardian) + emit NewPauseGuardian(oldPauseGuardian, pauseGuardian); + + return uint(Error.NO_ERROR); + } + + function _setMintPaused(CToken cToken, bool state) public returns (bool) { + require(markets[address(cToken)].isListed, "cannot pause a market that is not listed"); + require(msg.sender == pauseGuardian || msg.sender == admin, "only pause guardian and admin can pause"); + require(msg.sender == admin || state == true, "only admin can unpause"); + + mintGuardianPaused[address(cToken)] = state; + emit ActionPaused(cToken, "Mint", state); + return state; + } + + function _setBorrowPaused(CToken cToken, bool state) public returns (bool) { + require(markets[address(cToken)].isListed, "cannot pause a market that is not listed"); + require(msg.sender == pauseGuardian || msg.sender == admin, "only pause guardian and admin can pause"); + require(msg.sender == admin || state == true, "only admin can unpause"); + + borrowGuardianPaused[address(cToken)] = state; + emit ActionPaused(cToken, "Borrow", state); + return state; + } + + function _setTransferPaused(bool state) public returns (bool) { + require(msg.sender == pauseGuardian || msg.sender == admin, "only pause guardian and admin can pause"); + require(msg.sender == admin || state == true, "only admin can unpause"); + + transferGuardianPaused = state; + emit ActionPaused("Transfer", state); + return state; + } + + function _setSeizePaused(bool state) public returns (bool) { + require(msg.sender == pauseGuardian || msg.sender == admin, "only pause guardian and admin can pause"); + require(msg.sender == admin || state == true, "only admin can unpause"); + + seizeGuardianPaused = state; + emit ActionPaused("Seize", state); + return state; + } + + function _become(Unitroller unitroller, address[] memory otherMarketsToAdd) public { + require(msg.sender == unitroller.admin(), "only unitroller admin can change brains"); + require(unitroller._acceptImplementation() == 0, "change not authorized"); + + Comptroller(address(unitroller))._becomeG3(otherMarketsToAdd); + } + + function _becomeG3(address[] memory otherMarketsToAdd) public { + require(msg.sender == comptrollerImplementation, "only brains can become itself"); + + for (uint i = 0; i < otherMarketsToAdd.length; i++) { + _addMarketInternal(address(otherMarketsToAdd[i])); + } + } + + /** + * @notice Checks caller is admin, or this contract is becoming the new implementation + */ + function adminOrInitializing() internal view returns (bool) { + return msg.sender == admin || msg.sender == comptrollerImplementation; + } + + /** + * @notice Return all of the markets + * @dev The automatic getter may be used to access an individual market. + * @return The list of market addresses + */ + function getAllMarkets() public view returns (CToken[] memory) { + return allMarkets; + } + + function getBlockNumber() public view returns (uint) { + return block.number; + } + + /** + * @notice Return the address of the COMP token + * @return The address of COMP + */ +// function getCompAddress() public view returns (address) { +// return 0x310bd687f46b32393a9a3b3a492e7ac121a3cef1; +// } + function getCompAddress() public view returns (address) { + return compAddress; + } +} diff --git a/contracts/ComptrollerG1.sol b/contracts/ComptrollerG1.sol new file mode 100644 index 0000000..0ed490e --- /dev/null +++ b/contracts/ComptrollerG1.sol @@ -0,0 +1,993 @@ +pragma solidity ^0.5.12; + +import "./CToken.sol"; +import "./ErrorReporter.sol"; +import "./Exponential.sol"; +import "./PriceOracle.sol"; +import "./ComptrollerInterface.sol"; +import "./ComptrollerStorage.sol"; +import "./Unitroller.sol"; + +/** + * @title Compound's Comptroller Contract + * @author Compound + * @dev This was the first version of the Comptroller brains. + * We keep it so our tests can continue to do the real-life behavior of upgrading from this logic forward. + */ +contract ComptrollerG1 is ComptrollerV1Storage, ComptrollerInterface, ComptrollerErrorReporter, Exponential { + struct Market { + /** + * @notice Whether or not this market is listed + */ + bool isListed; + + /** + * @notice Multiplier representing the most one can borrow against their collateral in this market. + * For instance, 0.9 to allow borrowing 90% of collateral value. + * Must be between 0 and 1, and stored as a mantissa. + */ + uint collateralFactorMantissa; + + /** + * @notice Per-market mapping of "accounts in this asset" + */ + mapping(address => bool) accountMembership; + } + + /** + * @notice Official mapping of cTokens -> Market metadata + * @dev Used e.g. to determine if a market is supported + */ + mapping(address => Market) public markets; + + /** + * @notice Emitted when an admin supports a market + */ + event MarketListed(CToken cToken); + + /** + * @notice Emitted when an account enters a market + */ + event MarketEntered(CToken cToken, address account); + + /** + * @notice Emitted when an account exits a market + */ + event MarketExited(CToken cToken, address account); + + /** + * @notice Emitted when close factor is changed by admin + */ + event NewCloseFactor(uint oldCloseFactorMantissa, uint newCloseFactorMantissa); + + /** + * @notice Emitted when a collateral factor is changed by admin + */ + event NewCollateralFactor(CToken cToken, uint oldCollateralFactorMantissa, uint newCollateralFactorMantissa); + + /** + * @notice Emitted when liquidation incentive is changed by admin + */ + event NewLiquidationIncentive(uint oldLiquidationIncentiveMantissa, uint newLiquidationIncentiveMantissa); + + /** + * @notice Emitted when maxAssets is changed by admin + */ + event NewMaxAssets(uint oldMaxAssets, uint newMaxAssets); + + /** + * @notice Emitted when price oracle is changed + */ + event NewPriceOracle(PriceOracle oldPriceOracle, PriceOracle newPriceOracle); + + // closeFactorMantissa must be strictly greater than this value + uint constant closeFactorMinMantissa = 5e16; // 0.05 + + // closeFactorMantissa must not exceed this value + uint constant closeFactorMaxMantissa = 9e17; // 0.9 + + // No collateralFactorMantissa may exceed this value + uint constant collateralFactorMaxMantissa = 9e17; // 0.9 + + // liquidationIncentiveMantissa must be no less than this value + uint constant liquidationIncentiveMinMantissa = mantissaOne; + + // liquidationIncentiveMantissa must be no greater than this value + uint constant liquidationIncentiveMaxMantissa = 15e17; // 1.5 + + constructor() public { + admin = msg.sender; + } + + /*** Assets You Are In ***/ + + /** + * @notice Returns the assets an account has entered + * @param account The address of the account to pull assets for + * @return A dynamic list with the assets the account has entered + */ + function getAssetsIn(address account) external view returns (CToken[] memory) { + CToken[] memory assetsIn = accountAssets[account]; + + return assetsIn; + } + + /** + * @notice Returns whether the given account is entered in the given asset + * @param account The address of the account to check + * @param cToken The cToken to check + * @return True if the account is in the asset, otherwise false. + */ + function checkMembership(address account, CToken cToken) external view returns (bool) { + return markets[address(cToken)].accountMembership[account]; + } + + /** + * @notice Add assets to be included in account liquidity calculation + * @param cTokens The list of addresses of the cToken markets to be enabled + * @return Success indicator for whether each corresponding market was entered + */ + function enterMarkets(address[] memory cTokens) public returns (uint[] memory) { + uint len = cTokens.length; + + uint[] memory results = new uint[](len); + for (uint i = 0; i < len; i++) { + CToken cToken = CToken(cTokens[i]); + Market storage marketToJoin = markets[address(cToken)]; + + if (!marketToJoin.isListed) { + // if market is not listed, cannot join move along + results[i] = uint(Error.MARKET_NOT_LISTED); + continue; + } + + if (marketToJoin.accountMembership[msg.sender] == true) { + // if already joined, move along + results[i] = uint(Error.NO_ERROR); + continue; + } + + if (accountAssets[msg.sender].length >= maxAssets) { + // if no space, cannot join, move along + results[i] = uint(Error.TOO_MANY_ASSETS); + continue; + } + + // survived the gauntlet, add to list + // NOTE: we store these somewhat redundantly as a significant optimization + // this avoids having to iterate through the list for the most common use cases + // that is, only when we need to perform liquidity checks + // and not whenever we want to check if an account is in a particular market + marketToJoin.accountMembership[msg.sender] = true; + accountAssets[msg.sender].push(cToken); + + emit MarketEntered(cToken, msg.sender); + + results[i] = uint(Error.NO_ERROR); + } + + return results; + } + + /** + * @notice Removes asset from sender's account liquidity calculation + * @dev Sender must not have an outstanding borrow balance in the asset, + * or be providing neccessary collateral for an outstanding borrow. + * @param cTokenAddress The address of the asset to be removed + * @return Whether or not the account successfully exited the market + */ + function exitMarket(address cTokenAddress) external returns (uint) { + CToken cToken = CToken(cTokenAddress); + /* Get sender tokensHeld and amountOwed underlying from the cToken */ + (uint oErr, uint tokensHeld, uint amountOwed, ) = cToken.getAccountSnapshot(msg.sender); + require(oErr == 0, "exitMarket: getAccountSnapshot failed"); // semi-opaque error code + + /* Fail if the sender has a borrow balance */ + if (amountOwed != 0) { + return fail(Error.NONZERO_BORROW_BALANCE, FailureInfo.EXIT_MARKET_BALANCE_OWED); + } + + /* Fail if the sender is not permitted to redeem all of their tokens */ + uint allowed = redeemAllowedInternal(cTokenAddress, msg.sender, tokensHeld); + if (allowed != 0) { + return failOpaque(Error.REJECTION, FailureInfo.EXIT_MARKET_REJECTION, allowed); + } + + Market storage marketToExit = markets[address(cToken)]; + + /* Return true if the sender is not already ‘in’ the market */ + if (!marketToExit.accountMembership[msg.sender]) { + return uint(Error.NO_ERROR); + } + + /* Set cToken account membership to false */ + delete marketToExit.accountMembership[msg.sender]; + + /* Delete cToken from the account’s list of assets */ + // load into memory for faster iteration + CToken[] memory userAssetList = accountAssets[msg.sender]; + uint len = userAssetList.length; + uint assetIndex = len; + for (uint i = 0; i < len; i++) { + if (userAssetList[i] == cToken) { + assetIndex = i; + break; + } + } + + // We *must* have found the asset in the list or our redundant data structure is broken + assert(assetIndex < len); + + // copy last item in list to location of item to be removed, reduce length by 1 + CToken[] storage storedList = accountAssets[msg.sender]; + storedList[assetIndex] = storedList[storedList.length - 1]; + storedList.length--; + + emit MarketExited(cToken, msg.sender); + + return uint(Error.NO_ERROR); + } + + /*** Policy Hooks ***/ + + /** + * @notice Checks if the account should be allowed to mint tokens in the given market + * @param cToken The market to verify the mint against + * @param minter The account which would get the minted tokens + * @param mintAmount The amount of underlying being supplied to the market in exchange for tokens + * @return 0 if the mint is allowed, otherwise a semi-opaque error code (See ErrorReporter.sol) + */ + function mintAllowed(address cToken, address minter, uint mintAmount) external returns (uint) { + minter; // currently unused + mintAmount; // currently unused + + if (!markets[cToken].isListed) { + return uint(Error.MARKET_NOT_LISTED); + } + + // *may include Policy Hook-type checks + + return uint(Error.NO_ERROR); + } + + /** + * @notice Validates mint and reverts on rejection. May emit logs. + * @param cToken Asset being minted + * @param minter The address minting the tokens + * @param mintAmount The amount of the underlying asset being minted + * @param mintTokens The number of tokens being minted + */ + function mintVerify(address cToken, address minter, uint mintAmount, uint mintTokens) external { + cToken; // currently unused + minter; // currently unused + mintAmount; // currently unused + mintTokens; // currently unused + + if (false) { + maxAssets = maxAssets; // not pure + } + } + + /** + * @notice Checks if the account should be allowed to redeem tokens in the given market + * @param cToken The market to verify the redeem against + * @param redeemer The account which would redeem the tokens + * @param redeemTokens The number of cTokens to exchange for the underlying asset in the market + * @return 0 if the redeem is allowed, otherwise a semi-opaque error code (See ErrorReporter.sol) + */ + function redeemAllowed(address cToken, address redeemer, uint redeemTokens) external returns (uint) { + return redeemAllowedInternal(cToken, redeemer, redeemTokens); + } + + function redeemAllowedInternal(address cToken, address redeemer, uint redeemTokens) internal view returns (uint) { + if (!markets[cToken].isListed) { + return uint(Error.MARKET_NOT_LISTED); + } + + // *may include Policy Hook-type checks + + /* If the redeemer is not 'in' the market, then we can bypass the liquidity check */ + if (!markets[cToken].accountMembership[redeemer]) { + return uint(Error.NO_ERROR); + } + + /* Otherwise, perform a hypothetical liquidity check to guard against shortfall */ + (Error err, , uint shortfall) = getHypotheticalAccountLiquidityInternal(redeemer, CToken(cToken), redeemTokens, 0); + if (err != Error.NO_ERROR) { + return uint(err); + } + if (shortfall > 0) { + return uint(Error.INSUFFICIENT_LIQUIDITY); + } + + return uint(Error.NO_ERROR); + } + + /** + * @notice Validates redeem and reverts on rejection. May emit logs. + * @param cToken Asset being redeemed + * @param redeemer The address redeeming the tokens + * @param redeemAmount The amount of the underlying asset being redeemed + * @param redeemTokens The number of tokens being redeemed + */ + function redeemVerify(address cToken, address redeemer, uint redeemAmount, uint redeemTokens) external { + cToken; // currently unused + redeemer; // currently unused + redeemAmount; // currently unused + redeemTokens; // currently unused + + // Require tokens is zero or amount is also zero + if (redeemTokens == 0 && redeemAmount > 0) { + revert("redeemTokens zero"); + } + } + + /** + * @notice Checks if the account should be allowed to borrow the underlying asset of the given market + * @param cToken The market to verify the borrow against + * @param borrower The account which would borrow the asset + * @param borrowAmount The amount of underlying the account would borrow + * @return 0 if the borrow is allowed, otherwise a semi-opaque error code (See ErrorReporter.sol) + */ + function borrowAllowed(address cToken, address borrower, uint borrowAmount) external returns (uint) { + if (!markets[cToken].isListed) { + return uint(Error.MARKET_NOT_LISTED); + } + + // *may include Policy Hook-type checks + + if (!markets[cToken].accountMembership[borrower]) { + return uint(Error.MARKET_NOT_ENTERED); + } + + if (oracle.getUnderlyingPrice(CToken(cToken)) == 0) { + return uint(Error.PRICE_ERROR); + } + + (Error err, , uint shortfall) = getHypotheticalAccountLiquidityInternal(borrower, CToken(cToken), 0, borrowAmount); + if (err != Error.NO_ERROR) { + return uint(err); + } + if (shortfall > 0) { + return uint(Error.INSUFFICIENT_LIQUIDITY); + } + + return uint(Error.NO_ERROR); + } + + /** + * @notice Validates borrow and reverts on rejection. May emit logs. + * @param cToken Asset whose underlying is being borrowed + * @param borrower The address borrowing the underlying + * @param borrowAmount The amount of the underlying asset requested to borrow + */ + function borrowVerify(address cToken, address borrower, uint borrowAmount) external { + cToken; // currently unused + borrower; // currently unused + borrowAmount; // currently unused + + if (false) { + maxAssets = maxAssets; // not pure + } + } + + /** + * @notice Checks if the account should be allowed to repay a borrow in the given market + * @param cToken The market to verify the repay against + * @param payer The account which would repay the asset + * @param borrower The account which would borrowed the asset + * @param repayAmount The amount of the underlying asset the account would repay + * @return 0 if the repay is allowed, otherwise a semi-opaque error code (See ErrorReporter.sol) + */ + function repayBorrowAllowed( + address cToken, + address payer, + address borrower, + uint repayAmount) external returns (uint) { + payer; // currently unused + borrower; // currently unused + repayAmount; // currently unused + + if (!markets[cToken].isListed) { + return uint(Error.MARKET_NOT_LISTED); + } + + // *may include Policy Hook-type checks + + return uint(Error.NO_ERROR); + } + + /** + * @notice Validates repayBorrow and reverts on rejection. May emit logs. + * @param cToken Asset being repaid + * @param payer The address repaying the borrow + * @param borrower The address of the borrower + * @param repayAmount The amount of underlying being repaid + */ + function repayBorrowVerify( + address cToken, + address payer, + address borrower, + uint repayAmount, + uint borrowerIndex) external { + cToken; // currently unused + payer; // currently unused + borrower; // currently unused + repayAmount; // currently unused + borrowerIndex; // currently unused + + if (false) { + maxAssets = maxAssets; // not pure + } + } + + /** + * @notice Checks if the liquidation should be allowed to occur + * @param cTokenBorrowed Asset which was borrowed by the borrower + * @param cTokenCollateral Asset which was used as collateral and will be seized + * @param liquidator The address repaying the borrow and seizing the collateral + * @param borrower The address of the borrower + * @param repayAmount The amount of underlying being repaid + */ + function liquidateBorrowAllowed( + address cTokenBorrowed, + address cTokenCollateral, + address liquidator, + address borrower, + uint repayAmount) external returns (uint) { + liquidator; // currently unused + borrower; // currently unused + repayAmount; // currently unused + + if (!markets[cTokenBorrowed].isListed || !markets[cTokenCollateral].isListed) { + return uint(Error.MARKET_NOT_LISTED); + } + + // *may include Policy Hook-type checks + + /* The borrower must have shortfall in order to be liquidatable */ + (Error err, , uint shortfall) = getAccountLiquidityInternal(borrower); + if (err != Error.NO_ERROR) { + return uint(err); + } + if (shortfall == 0) { + return uint(Error.INSUFFICIENT_SHORTFALL); + } + + /* The liquidator may not repay more than what is allowed by the closeFactor */ + uint borrowBalance = CToken(cTokenBorrowed).borrowBalanceStored(borrower); + (MathError mathErr, uint maxClose) = mulScalarTruncate(Exp({mantissa: closeFactorMantissa}), borrowBalance); + if (mathErr != MathError.NO_ERROR) { + return uint(Error.MATH_ERROR); + } + if (repayAmount > maxClose) { + return uint(Error.TOO_MUCH_REPAY); + } + + return uint(Error.NO_ERROR); + } + + /** + * @notice Validates liquidateBorrow and reverts on rejection. May emit logs. + * @param cTokenBorrowed Asset which was borrowed by the borrower + * @param cTokenCollateral Asset which was used as collateral and will be seized + * @param liquidator The address repaying the borrow and seizing the collateral + * @param borrower The address of the borrower + * @param repayAmount The amount of underlying being repaid + */ + function liquidateBorrowVerify( + address cTokenBorrowed, + address cTokenCollateral, + address liquidator, + address borrower, + uint repayAmount, + uint seizeTokens) external { + cTokenBorrowed; // currently unused + cTokenCollateral; // currently unused + liquidator; // currently unused + borrower; // currently unused + repayAmount; // currently unused + seizeTokens; // currently unused + + if (false) { + maxAssets = maxAssets; // not pure + } + } + + /** + * @notice Checks if the seizing of assets should be allowed to occur + * @param cTokenCollateral Asset which was used as collateral and will be seized + * @param cTokenBorrowed Asset which was borrowed by the borrower + * @param liquidator The address repaying the borrow and seizing the collateral + * @param borrower The address of the borrower + * @param seizeTokens The number of collateral tokens to seize + */ + function seizeAllowed( + address cTokenCollateral, + address cTokenBorrowed, + address liquidator, + address borrower, + uint seizeTokens) external returns (uint) { + liquidator; // currently unused + borrower; // currently unused + seizeTokens; // currently unused + + if (!markets[cTokenCollateral].isListed || !markets[cTokenBorrowed].isListed) { + return uint(Error.MARKET_NOT_LISTED); + } + + if (CToken(cTokenCollateral).comptroller() != CToken(cTokenBorrowed).comptroller()) { + return uint(Error.COMPTROLLER_MISMATCH); + } + + // *may include Policy Hook-type checks + + return uint(Error.NO_ERROR); + } + + /** + * @notice Validates seize and reverts on rejection. May emit logs. + * @param cTokenCollateral Asset which was used as collateral and will be seized + * @param cTokenBorrowed Asset which was borrowed by the borrower + * @param liquidator The address repaying the borrow and seizing the collateral + * @param borrower The address of the borrower + * @param seizeTokens The number of collateral tokens to seize + */ + function seizeVerify( + address cTokenCollateral, + address cTokenBorrowed, + address liquidator, + address borrower, + uint seizeTokens) external { + cTokenCollateral; // currently unused + cTokenBorrowed; // currently unused + liquidator; // currently unused + borrower; // currently unused + seizeTokens; // currently unused + + if (false) { + maxAssets = maxAssets; // not pure + } + } + + /** + * @notice Checks if the account should be allowed to transfer tokens in the given market + * @param cToken The market to verify the transfer against + * @param src The account which sources the tokens + * @param dst The account which receives the tokens + * @param transferTokens The number of cTokens to transfer + * @return 0 if the transfer is allowed, otherwise a semi-opaque error code (See ErrorReporter.sol) + */ + function transferAllowed(address cToken, address src, address dst, uint transferTokens) external returns (uint) { + cToken; // currently unused + src; // currently unused + dst; // currently unused + transferTokens; // currently unused + + // *may include Policy Hook-type checks + + // Currently the only consideration is whether or not + // the src is allowed to redeem this many tokens + return redeemAllowedInternal(cToken, src, transferTokens); + } + + /** + * @notice Validates transfer and reverts on rejection. May emit logs. + * @param cToken Asset being transferred + * @param src The account which sources the tokens + * @param dst The account which receives the tokens + * @param transferTokens The number of cTokens to transfer + */ + function transferVerify(address cToken, address src, address dst, uint transferTokens) external { + cToken; // currently unused + src; // currently unused + dst; // currently unused + transferTokens; // currently unused + + if (false) { + maxAssets = maxAssets; // not pure + } + } + + /*** Liquidity/Liquidation Calculations ***/ + + /** + * @dev Local vars for avoiding stack-depth limits in calculating account liquidity. + * Note that `cTokenBalance` is the number of cTokens the account owns in the market, + * whereas `borrowBalance` is the amount of underlying that the account has borrowed. + */ + struct AccountLiquidityLocalVars { + uint sumCollateral; + uint sumBorrowPlusEffects; + uint cTokenBalance; + uint borrowBalance; + uint exchangeRateMantissa; + uint oraclePriceMantissa; + Exp collateralFactor; + Exp exchangeRate; + Exp oraclePrice; + Exp tokensToEther; + } + + /** + * @notice Determine the current account liquidity wrt collateral requirements + * @return (possible error code (semi-opaque), + account liquidity in excess of collateral requirements, + * account shortfall below collateral requirements) + */ + function getAccountLiquidity(address account) public view returns (uint, uint, uint) { + (Error err, uint liquidity, uint shortfall) = getHypotheticalAccountLiquidityInternal(account, CToken(0), 0, 0); + + return (uint(err), liquidity, shortfall); + } + + /** + * @notice Determine the current account liquidity wrt collateral requirements + * @return (possible error code, + account liquidity in excess of collateral requirements, + * account shortfall below collateral requirements) + */ + function getAccountLiquidityInternal(address account) internal view returns (Error, uint, uint) { + return getHypotheticalAccountLiquidityInternal(account, CToken(0), 0, 0); + } + + /** + * @notice Determine what the account liquidity would be if the given amounts were redeemed/borrowed + * @param cTokenModify The market to hypothetically redeem/borrow in + * @param account The account to determine liquidity for + * @param redeemTokens The number of tokens to hypothetically redeem + * @param borrowAmount The amount of underlying to hypothetically borrow + * @dev Note that we calculate the exchangeRateStored for each collateral cToken using stored data, + * without calculating accumulated interest. + * @return (possible error code, + hypothetical account liquidity in excess of collateral requirements, + * hypothetical account shortfall below collateral requirements) + */ + function getHypotheticalAccountLiquidityInternal( + address account, + CToken cTokenModify, + uint redeemTokens, + uint borrowAmount) internal view returns (Error, uint, uint) { + + AccountLiquidityLocalVars memory vars; // Holds all our calculation results + uint oErr; + MathError mErr; + + // For each asset the account is in + CToken[] memory assets = accountAssets[account]; + for (uint i = 0; i < assets.length; i++) { + CToken asset = assets[i]; + + // Read the balances and exchange rate from the cToken + (oErr, vars.cTokenBalance, vars.borrowBalance, vars.exchangeRateMantissa) = asset.getAccountSnapshot(account); + if (oErr != 0) { // semi-opaque error code, we assume NO_ERROR == 0 is invariant between upgrades + return (Error.SNAPSHOT_ERROR, 0, 0); + } + vars.collateralFactor = Exp({mantissa: markets[address(asset)].collateralFactorMantissa}); + vars.exchangeRate = Exp({mantissa: vars.exchangeRateMantissa}); + + // Get the normalized price of the asset + vars.oraclePriceMantissa = oracle.getUnderlyingPrice(asset); + if (vars.oraclePriceMantissa == 0) { + return (Error.PRICE_ERROR, 0, 0); + } + vars.oraclePrice = Exp({mantissa: vars.oraclePriceMantissa}); + + // Pre-compute a conversion factor from tokens -> ether (normalized price value) + (mErr, vars.tokensToEther) = mulExp3(vars.collateralFactor, vars.exchangeRate, vars.oraclePrice); + if (mErr != MathError.NO_ERROR) { + return (Error.MATH_ERROR, 0, 0); + } + + // sumCollateral += tokensToEther * cTokenBalance + (mErr, vars.sumCollateral) = mulScalarTruncateAddUInt(vars.tokensToEther, vars.cTokenBalance, vars.sumCollateral); + if (mErr != MathError.NO_ERROR) { + return (Error.MATH_ERROR, 0, 0); + } + + // sumBorrowPlusEffects += oraclePrice * borrowBalance + (mErr, vars.sumBorrowPlusEffects) = mulScalarTruncateAddUInt(vars.oraclePrice, vars.borrowBalance, vars.sumBorrowPlusEffects); + if (mErr != MathError.NO_ERROR) { + return (Error.MATH_ERROR, 0, 0); + } + + // Calculate effects of interacting with cTokenModify + if (asset == cTokenModify) { + // redeem effect + // sumBorrowPlusEffects += tokensToEther * redeemTokens + (mErr, vars.sumBorrowPlusEffects) = mulScalarTruncateAddUInt(vars.tokensToEther, redeemTokens, vars.sumBorrowPlusEffects); + if (mErr != MathError.NO_ERROR) { + return (Error.MATH_ERROR, 0, 0); + } + + // borrow effect + // sumBorrowPlusEffects += oraclePrice * borrowAmount + (mErr, vars.sumBorrowPlusEffects) = mulScalarTruncateAddUInt(vars.oraclePrice, borrowAmount, vars.sumBorrowPlusEffects); + if (mErr != MathError.NO_ERROR) { + return (Error.MATH_ERROR, 0, 0); + } + } + } + + // These are safe, as the underflow condition is checked first + if (vars.sumCollateral > vars.sumBorrowPlusEffects) { + return (Error.NO_ERROR, vars.sumCollateral - vars.sumBorrowPlusEffects, 0); + } else { + return (Error.NO_ERROR, 0, vars.sumBorrowPlusEffects - vars.sumCollateral); + } + } + + /** + * @notice Calculate number of tokens of collateral asset to seize given an underlying amount + * @dev Used in liquidation (called in cToken.liquidateBorrowFresh) + * @param cTokenBorrowed The address of the borrowed cToken + * @param cTokenCollateral The address of the collateral cToken + * @param repayAmount The amount of cTokenBorrowed underlying to convert into cTokenCollateral tokens + * @return (errorCode, number of cTokenCollateral tokens to be seized in a liquidation) + */ + function liquidateCalculateSeizeTokens(address cTokenBorrowed, address cTokenCollateral, uint repayAmount) external view returns (uint, uint) { + /* Read oracle prices for borrowed and collateral markets */ + uint priceBorrowedMantissa = oracle.getUnderlyingPrice(CToken(cTokenBorrowed)); + uint priceCollateralMantissa = oracle.getUnderlyingPrice(CToken(cTokenCollateral)); + if (priceBorrowedMantissa == 0 || priceCollateralMantissa == 0) { + return (uint(Error.PRICE_ERROR), 0); + } + + /* + * Get the exchange rate and calculate the number of collateral tokens to seize: + * seizeAmount = repayAmount * liquidationIncentive * priceBorrowed / priceCollateral + * seizeTokens = seizeAmount / exchangeRate + * = repayAmount * (liquidationIncentive * priceBorrowed) / (priceCollateral * exchangeRate) + */ + uint exchangeRateMantissa = CToken(cTokenCollateral).exchangeRateStored(); // Note: reverts on error + uint seizeTokens; + Exp memory numerator; + Exp memory denominator; + Exp memory ratio; + MathError mathErr; + + (mathErr, numerator) = mulExp(liquidationIncentiveMantissa, priceBorrowedMantissa); + if (mathErr != MathError.NO_ERROR) { + return (uint(Error.MATH_ERROR), 0); + } + + (mathErr, denominator) = mulExp(priceCollateralMantissa, exchangeRateMantissa); + if (mathErr != MathError.NO_ERROR) { + return (uint(Error.MATH_ERROR), 0); + } + + (mathErr, ratio) = divExp(numerator, denominator); + if (mathErr != MathError.NO_ERROR) { + return (uint(Error.MATH_ERROR), 0); + } + + (mathErr, seizeTokens) = mulScalarTruncate(ratio, repayAmount); + if (mathErr != MathError.NO_ERROR) { + return (uint(Error.MATH_ERROR), 0); + } + + return (uint(Error.NO_ERROR), seizeTokens); + } + + /*** Admin Functions ***/ + + /** + * @notice Sets a new price oracle for the comptroller + * @dev Admin function to set a new price oracle + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function _setPriceOracle(PriceOracle newOracle) public returns (uint) { + // Check caller is admin OR currently initialzing as new unitroller implementation + if (!adminOrInitializing()) { + return fail(Error.UNAUTHORIZED, FailureInfo.SET_PRICE_ORACLE_OWNER_CHECK); + } + + // Track the old oracle for the comptroller + PriceOracle oldOracle = oracle; + + // Ensure invoke newOracle.isPriceOracle() returns true + // require(newOracle.isPriceOracle(), "oracle method isPriceOracle returned false"); + + // Set comptroller's oracle to newOracle + oracle = newOracle; + + // Emit NewPriceOracle(oldOracle, newOracle) + emit NewPriceOracle(oldOracle, newOracle); + + return uint(Error.NO_ERROR); + } + + /** + * @notice Sets the closeFactor used when liquidating borrows + * @dev Admin function to set closeFactor + * @param newCloseFactorMantissa New close factor, scaled by 1e18 + * @return uint 0=success, otherwise a failure. (See ErrorReporter for details) + */ + function _setCloseFactor(uint newCloseFactorMantissa) external returns (uint256) { + // Check caller is admin OR currently initialzing as new unitroller implementation + if (!adminOrInitializing()) { + return fail(Error.UNAUTHORIZED, FailureInfo.SET_CLOSE_FACTOR_OWNER_CHECK); + } + + Exp memory newCloseFactorExp = Exp({mantissa: newCloseFactorMantissa}); + Exp memory lowLimit = Exp({mantissa: closeFactorMinMantissa}); + if (lessThanOrEqualExp(newCloseFactorExp, lowLimit)) { + return fail(Error.INVALID_CLOSE_FACTOR, FailureInfo.SET_CLOSE_FACTOR_VALIDATION); + } + + Exp memory highLimit = Exp({mantissa: closeFactorMaxMantissa}); + if (lessThanExp(highLimit, newCloseFactorExp)) { + return fail(Error.INVALID_CLOSE_FACTOR, FailureInfo.SET_CLOSE_FACTOR_VALIDATION); + } + + uint oldCloseFactorMantissa = closeFactorMantissa; + closeFactorMantissa = newCloseFactorMantissa; + emit NewCloseFactor(oldCloseFactorMantissa, closeFactorMantissa); + + return uint(Error.NO_ERROR); + } + + /** + * @notice Sets the collateralFactor for a market + * @dev Admin function to set per-market collateralFactor + * @param cToken The market to set the factor on + * @param newCollateralFactorMantissa The new collateral factor, scaled by 1e18 + * @return uint 0=success, otherwise a failure. (See ErrorReporter for details) + */ + function _setCollateralFactor(CToken cToken, uint newCollateralFactorMantissa) external returns (uint256) { + // Check caller is admin + if (msg.sender != admin) { + return fail(Error.UNAUTHORIZED, FailureInfo.SET_COLLATERAL_FACTOR_OWNER_CHECK); + } + + // Verify market is listed + Market storage market = markets[address(cToken)]; + if (!market.isListed) { + return fail(Error.MARKET_NOT_LISTED, FailureInfo.SET_COLLATERAL_FACTOR_NO_EXISTS); + } + + Exp memory newCollateralFactorExp = Exp({mantissa: newCollateralFactorMantissa}); + + // Check collateral factor <= 0.9 + Exp memory highLimit = Exp({mantissa: collateralFactorMaxMantissa}); + if (lessThanExp(highLimit, newCollateralFactorExp)) { + return fail(Error.INVALID_COLLATERAL_FACTOR, FailureInfo.SET_COLLATERAL_FACTOR_VALIDATION); + } + + // If collateral factor != 0, fail if price == 0 + if (newCollateralFactorMantissa != 0 && oracle.getUnderlyingPrice(cToken) == 0) { + return fail(Error.PRICE_ERROR, FailureInfo.SET_COLLATERAL_FACTOR_WITHOUT_PRICE); + } + + // Set market's collateral factor to new collateral factor, remember old value + uint oldCollateralFactorMantissa = market.collateralFactorMantissa; + market.collateralFactorMantissa = newCollateralFactorMantissa; + + // Emit event with asset, old collateral factor, and new collateral factor + emit NewCollateralFactor(cToken, oldCollateralFactorMantissa, newCollateralFactorMantissa); + + return uint(Error.NO_ERROR); + } + + /** + * @notice Sets maxAssets which controls how many markets can be entered + * @dev Admin function to set maxAssets + * @param newMaxAssets New max assets + * @return uint 0=success, otherwise a failure. (See ErrorReporter for details) + */ + function _setMaxAssets(uint newMaxAssets) external returns (uint) { + // Check caller is admin OR currently initialzing as new unitroller implementation + if (!adminOrInitializing()) { + return fail(Error.UNAUTHORIZED, FailureInfo.SET_MAX_ASSETS_OWNER_CHECK); + } + + uint oldMaxAssets = maxAssets; + maxAssets = newMaxAssets; + emit NewMaxAssets(oldMaxAssets, newMaxAssets); + + return uint(Error.NO_ERROR); + } + + /** + * @notice Sets liquidationIncentive + * @dev Admin function to set liquidationIncentive + * @param newLiquidationIncentiveMantissa New liquidationIncentive scaled by 1e18 + * @return uint 0=success, otherwise a failure. (See ErrorReporter for details) + */ + function _setLiquidationIncentive(uint newLiquidationIncentiveMantissa) external returns (uint) { + // Check caller is admin OR currently initialzing as new unitroller implementation + if (!adminOrInitializing()) { + return fail(Error.UNAUTHORIZED, FailureInfo.SET_LIQUIDATION_INCENTIVE_OWNER_CHECK); + } + + // Check de-scaled 1 <= newLiquidationDiscount <= 1.5 + Exp memory newLiquidationIncentive = Exp({mantissa: newLiquidationIncentiveMantissa}); + Exp memory minLiquidationIncentive = Exp({mantissa: liquidationIncentiveMinMantissa}); + if (lessThanExp(newLiquidationIncentive, minLiquidationIncentive)) { + return fail(Error.INVALID_LIQUIDATION_INCENTIVE, FailureInfo.SET_LIQUIDATION_INCENTIVE_VALIDATION); + } + + Exp memory maxLiquidationIncentive = Exp({mantissa: liquidationIncentiveMaxMantissa}); + if (lessThanExp(maxLiquidationIncentive, newLiquidationIncentive)) { + return fail(Error.INVALID_LIQUIDATION_INCENTIVE, FailureInfo.SET_LIQUIDATION_INCENTIVE_VALIDATION); + } + + // Save current value for use in log + uint oldLiquidationIncentiveMantissa = liquidationIncentiveMantissa; + + // Set liquidation incentive to new incentive + liquidationIncentiveMantissa = newLiquidationIncentiveMantissa; + + // Emit event with old incentive, new incentive + emit NewLiquidationIncentive(oldLiquidationIncentiveMantissa, newLiquidationIncentiveMantissa); + + return uint(Error.NO_ERROR); + } + + /** + * @notice Add the market to the markets mapping and set it as listed + * @dev Admin function to set isListed and add support for the market + * @param cToken The address of the market (token) to list + * @return uint 0=success, otherwise a failure. (See enum Error for details) + */ + function _supportMarket(CToken cToken) external returns (uint) { + if (msg.sender != admin) { + return fail(Error.UNAUTHORIZED, FailureInfo.SUPPORT_MARKET_OWNER_CHECK); + } + + if (markets[address(cToken)].isListed) { + return fail(Error.MARKET_ALREADY_LISTED, FailureInfo.SUPPORT_MARKET_EXISTS); + } + + cToken.isCToken(); // Sanity check to make sure its really a CToken + + markets[address(cToken)] = Market({isListed: true, collateralFactorMantissa: 0}); + emit MarketListed(cToken); + + return uint(Error.NO_ERROR); + } + + function _become(Unitroller unitroller, PriceOracle _oracle, uint _closeFactorMantissa, uint _maxAssets, bool reinitializing) public { + require(msg.sender == unitroller.admin(), "only unitroller admin can change brains"); + uint changeStatus = unitroller._acceptImplementation(); + + require(changeStatus == 0, "change not authorized"); + + if (!reinitializing) { + ComptrollerG1 freshBrainedComptroller = ComptrollerG1(address(unitroller)); + + // Ensure invoke _setPriceOracle() = 0 + uint err = freshBrainedComptroller._setPriceOracle(_oracle); + require (err == uint(Error.NO_ERROR), "set price oracle error"); + + // Ensure invoke _setCloseFactor() = 0 + err = freshBrainedComptroller._setCloseFactor(_closeFactorMantissa); + require (err == uint(Error.NO_ERROR), "set close factor error"); + + // Ensure invoke _setMaxAssets() = 0 + err = freshBrainedComptroller._setMaxAssets(_maxAssets); + require (err == uint(Error.NO_ERROR), "set max asssets error"); + + // Ensure invoke _setLiquidationIncentive(liquidationIncentiveMinMantissa) = 0 + err = freshBrainedComptroller._setLiquidationIncentive(liquidationIncentiveMinMantissa); + require (err == uint(Error.NO_ERROR), "set liquidation incentive error"); + } + } + + /** + * @dev Check that caller is admin or this contract is initializing itself as + * the new implementation. + * There should be no way to satisfy msg.sender == comptrollerImplementaiton + * without tx.origin also being admin, but both are included for extra safety + */ + function adminOrInitializing() internal view returns (bool) { + bool initializing = ( + msg.sender == comptrollerImplementation + && + //solium-disable-next-line security/no-tx-origin + tx.origin == admin + ); + bool isAdmin = msg.sender == admin; + return isAdmin || initializing; + } +} \ No newline at end of file diff --git a/contracts/ComptrollerG2.sol b/contracts/ComptrollerG2.sol new file mode 100644 index 0000000..d5bcc91 --- /dev/null +++ b/contracts/ComptrollerG2.sol @@ -0,0 +1,1061 @@ +pragma solidity ^0.5.12; + +import "./CToken.sol"; +import "./ErrorReporter.sol"; +import "./Exponential.sol"; +import "./PriceOracle.sol"; +import "./ComptrollerInterface.sol"; +import "./ComptrollerStorage.sol"; +import "./Unitroller.sol"; + +/** + * @title Compound's Comptroller Contract + * @author Compound + */ +contract ComptrollerG2 is ComptrollerV2Storage, ComptrollerInterface, ComptrollerErrorReporter, Exponential { + /** + * @notice Emitted when an admin supports a market + */ + event MarketListed(CToken cToken); + + /** + * @notice Emitted when an account enters a market + */ + event MarketEntered(CToken cToken, address account); + + /** + * @notice Emitted when an account exits a market + */ + event MarketExited(CToken cToken, address account); + + /** + * @notice Emitted when close factor is changed by admin + */ + event NewCloseFactor(uint oldCloseFactorMantissa, uint newCloseFactorMantissa); + + /** + * @notice Emitted when a collateral factor is changed by admin + */ + event NewCollateralFactor(CToken cToken, uint oldCollateralFactorMantissa, uint newCollateralFactorMantissa); + + /** + * @notice Emitted when liquidation incentive is changed by admin + */ + event NewLiquidationIncentive(uint oldLiquidationIncentiveMantissa, uint newLiquidationIncentiveMantissa); + + /** + * @notice Emitted when maxAssets is changed by admin + */ + event NewMaxAssets(uint oldMaxAssets, uint newMaxAssets); + + /** + * @notice Emitted when price oracle is changed + */ + event NewPriceOracle(PriceOracle oldPriceOracle, PriceOracle newPriceOracle); + + /** + * @notice Emitted when pause guardian is changed + */ + event NewPauseGuardian(address oldPauseGuardian, address newPauseGuardian); + + /** + * @notice Emitted when an action is paused globally + */ + event ActionPaused(string action, bool pauseState); + + /** + * @notice Emitted when an action is paused on a market + */ + event ActionPaused(CToken cToken, string action, bool pauseState); + + // closeFactorMantissa must be strictly greater than this value + uint internal constant closeFactorMinMantissa = 0.05e18; // 0.05 + + // closeFactorMantissa must not exceed this value + uint internal constant closeFactorMaxMantissa = 0.9e18; // 0.9 + + // No collateralFactorMantissa may exceed this value + uint internal constant collateralFactorMaxMantissa = 0.9e18; // 0.9 + + // liquidationIncentiveMantissa must be no less than this value + uint internal constant liquidationIncentiveMinMantissa = 1.0e18; // 1.0 + + // liquidationIncentiveMantissa must be no greater than this value + uint internal constant liquidationIncentiveMaxMantissa = 1.5e18; // 1.5 + + constructor() public { + admin = msg.sender; + } + + /*** Assets You Are In ***/ + + /** + * @notice Returns the assets an account has entered + * @param account The address of the account to pull assets for + * @return A dynamic list with the assets the account has entered + */ + function getAssetsIn(address account) external view returns (CToken[] memory) { + CToken[] memory assetsIn = accountAssets[account]; + + return assetsIn; + } + + /** + * @notice Returns whether the given account is entered in the given asset + * @param account The address of the account to check + * @param cToken The cToken to check + * @return True if the account is in the asset, otherwise false. + */ + function checkMembership(address account, CToken cToken) external view returns (bool) { + return markets[address(cToken)].accountMembership[account]; + } + + /** + * @notice Add assets to be included in account liquidity calculation + * @param cTokens The list of addresses of the cToken markets to be enabled + * @return Success indicator for whether each corresponding market was entered + */ + function enterMarkets(address[] memory cTokens) public returns (uint[] memory) { + uint len = cTokens.length; + + uint[] memory results = new uint[](len); + for (uint i = 0; i < len; i++) { + CToken cToken = CToken(cTokens[i]); + + results[i] = uint(addToMarketInternal(cToken, msg.sender)); + } + + return results; + } + + /** + * @notice Add the market to the borrower's "assets in" for liquidity calculations + * @param cToken The market to enter + * @param borrower The address of the account to modify + * @return Success indicator for whether the market was entered + */ + function addToMarketInternal(CToken cToken, address borrower) internal returns (Error) { + Market storage marketToJoin = markets[address(cToken)]; + + if (!marketToJoin.isListed) { + // market is not listed, cannot join + return Error.MARKET_NOT_LISTED; + } + + if (marketToJoin.accountMembership[borrower] == true) { + // already joined + return Error.NO_ERROR; + } + + if (accountAssets[borrower].length >= maxAssets) { + // no space, cannot join + return Error.TOO_MANY_ASSETS; + } + + // survived the gauntlet, add to list + // NOTE: we store these somewhat redundantly as a significant optimization + // this avoids having to iterate through the list for the most common use cases + // that is, only when we need to perform liquidity checks + // and not whenever we want to check if an account is in a particular market + marketToJoin.accountMembership[borrower] = true; + accountAssets[borrower].push(cToken); + + emit MarketEntered(cToken, borrower); + + return Error.NO_ERROR; + } + + /** + * @notice Removes asset from sender's account liquidity calculation + * @dev Sender must not have an outstanding borrow balance in the asset, + * or be providing neccessary collateral for an outstanding borrow. + * @param cTokenAddress The address of the asset to be removed + * @return Whether or not the account successfully exited the market + */ + function exitMarket(address cTokenAddress) external returns (uint) { + CToken cToken = CToken(cTokenAddress); + /* Get sender tokensHeld and amountOwed underlying from the cToken */ + (uint oErr, uint tokensHeld, uint amountOwed, ) = cToken.getAccountSnapshot(msg.sender); + require(oErr == 0, "exitMarket: getAccountSnapshot failed"); // semi-opaque error code + + /* Fail if the sender has a borrow balance */ + if (amountOwed != 0) { + return fail(Error.NONZERO_BORROW_BALANCE, FailureInfo.EXIT_MARKET_BALANCE_OWED); + } + + /* Fail if the sender is not permitted to redeem all of their tokens */ + uint allowed = redeemAllowedInternal(cTokenAddress, msg.sender, tokensHeld); + if (allowed != 0) { + return failOpaque(Error.REJECTION, FailureInfo.EXIT_MARKET_REJECTION, allowed); + } + + Market storage marketToExit = markets[address(cToken)]; + + /* Return true if the sender is not already ‘in’ the market */ + if (!marketToExit.accountMembership[msg.sender]) { + return uint(Error.NO_ERROR); + } + + /* Set cToken account membership to false */ + delete marketToExit.accountMembership[msg.sender]; + + /* Delete cToken from the account’s list of assets */ + // load into memory for faster iteration + CToken[] memory userAssetList = accountAssets[msg.sender]; + uint len = userAssetList.length; + uint assetIndex = len; + for (uint i = 0; i < len; i++) { + if (userAssetList[i] == cToken) { + assetIndex = i; + break; + } + } + + // We *must* have found the asset in the list or our redundant data structure is broken + assert(assetIndex < len); + + // copy last item in list to location of item to be removed, reduce length by 1 + CToken[] storage storedList = accountAssets[msg.sender]; + storedList[assetIndex] = storedList[storedList.length - 1]; + storedList.length--; + + emit MarketExited(cToken, msg.sender); + + return uint(Error.NO_ERROR); + } + + /*** Policy Hooks ***/ + + /** + * @notice Checks if the account should be allowed to mint tokens in the given market + * @param cToken The market to verify the mint against + * @param minter The account which would get the minted tokens + * @param mintAmount The amount of underlying being supplied to the market in exchange for tokens + * @return 0 if the mint is allowed, otherwise a semi-opaque error code (See ErrorReporter.sol) + */ + function mintAllowed(address cToken, address minter, uint mintAmount) external returns (uint) { + // Pausing is a very serious situation - we revert to sound the alarms + require(!mintGuardianPaused[cToken], "mint is paused"); + + // Shh - currently unused + minter; + mintAmount; + + if (!markets[cToken].isListed) { + return uint(Error.MARKET_NOT_LISTED); + } + + // *may include Policy Hook-type checks + + return uint(Error.NO_ERROR); + } + + /** + * @notice Validates mint and reverts on rejection. May emit logs. + * @param cToken Asset being minted + * @param minter The address minting the tokens + * @param actualMintAmount The amount of the underlying asset being minted + * @param mintTokens The number of tokens being minted + */ + function mintVerify(address cToken, address minter, uint actualMintAmount, uint mintTokens) external { + // Shh - currently unused + cToken; + minter; + actualMintAmount; + mintTokens; + + // Shh - we don't ever want this hook to be marked pure + if (false) { + maxAssets = maxAssets; + } + } + + /** + * @notice Checks if the account should be allowed to redeem tokens in the given market + * @param cToken The market to verify the redeem against + * @param redeemer The account which would redeem the tokens + * @param redeemTokens The number of cTokens to exchange for the underlying asset in the market + * @return 0 if the redeem is allowed, otherwise a semi-opaque error code (See ErrorReporter.sol) + */ + function redeemAllowed(address cToken, address redeemer, uint redeemTokens) external returns (uint) { + return redeemAllowedInternal(cToken, redeemer, redeemTokens); + } + + function redeemAllowedInternal(address cToken, address redeemer, uint redeemTokens) internal view returns (uint) { + if (!markets[cToken].isListed) { + return uint(Error.MARKET_NOT_LISTED); + } + + // *may include Policy Hook-type checks + + /* If the redeemer is not 'in' the market, then we can bypass the liquidity check */ + if (!markets[cToken].accountMembership[redeemer]) { + return uint(Error.NO_ERROR); + } + + /* Otherwise, perform a hypothetical liquidity check to guard against shortfall */ + (Error err, , uint shortfall) = getHypotheticalAccountLiquidityInternal(redeemer, CToken(cToken), redeemTokens, 0); + if (err != Error.NO_ERROR) { + return uint(err); + } + if (shortfall > 0) { + return uint(Error.INSUFFICIENT_LIQUIDITY); + } + + return uint(Error.NO_ERROR); + } + + /** + * @notice Validates redeem and reverts on rejection. May emit logs. + * @param cToken Asset being redeemed + * @param redeemer The address redeeming the tokens + * @param redeemAmount The amount of the underlying asset being redeemed + * @param redeemTokens The number of tokens being redeemed + */ + function redeemVerify(address cToken, address redeemer, uint redeemAmount, uint redeemTokens) external { + // Shh - currently unused + cToken; + redeemer; + + // Require tokens is zero or amount is also zero + if (redeemTokens == 0 && redeemAmount > 0) { + revert("redeemTokens zero"); + } + } + + /** + * @notice Checks if the account should be allowed to borrow the underlying asset of the given market + * @param cToken The market to verify the borrow against + * @param borrower The account which would borrow the asset + * @param borrowAmount The amount of underlying the account would borrow + * @return 0 if the borrow is allowed, otherwise a semi-opaque error code (See ErrorReporter.sol) + */ + function borrowAllowed(address cToken, address borrower, uint borrowAmount) external returns (uint) { + // Pausing is a very serious situation - we revert to sound the alarms + require(!borrowGuardianPaused[cToken], "borrow is paused"); + + if (!markets[cToken].isListed) { + return uint(Error.MARKET_NOT_LISTED); + } + + // *may include Policy Hook-type checks + + if (!markets[cToken].accountMembership[borrower]) { + // only cTokens may call borrowAllowed if borrower not in market + require(msg.sender == cToken, "sender must be cToken"); + + // attempt to add borrower to the market + Error err = addToMarketInternal(CToken(msg.sender), borrower); + if (err != Error.NO_ERROR) { + return uint(err); + } + + // it should be impossible to break the important invariant + assert(markets[cToken].accountMembership[borrower]); + } + + if (oracle.getUnderlyingPrice(CToken(cToken)) == 0) { + return uint(Error.PRICE_ERROR); + } + + (Error err, , uint shortfall) = getHypotheticalAccountLiquidityInternal(borrower, CToken(cToken), 0, borrowAmount); + if (err != Error.NO_ERROR) { + return uint(err); + } + if (shortfall > 0) { + return uint(Error.INSUFFICIENT_LIQUIDITY); + } + + return uint(Error.NO_ERROR); + } + + /** + * @notice Validates borrow and reverts on rejection. May emit logs. + * @param cToken Asset whose underlying is being borrowed + * @param borrower The address borrowing the underlying + * @param borrowAmount The amount of the underlying asset requested to borrow + */ + function borrowVerify(address cToken, address borrower, uint borrowAmount) external { + // Shh - currently unused + cToken; + borrower; + borrowAmount; + + // Shh - we don't ever want this hook to be marked pure + if (false) { + maxAssets = maxAssets; + } + } + + /** + * @notice Checks if the account should be allowed to repay a borrow in the given market + * @param cToken The market to verify the repay against + * @param payer The account which would repay the asset + * @param borrower The account which would borrowed the asset + * @param repayAmount The amount of the underlying asset the account would repay + * @return 0 if the repay is allowed, otherwise a semi-opaque error code (See ErrorReporter.sol) + */ + function repayBorrowAllowed( + address cToken, + address payer, + address borrower, + uint repayAmount) external returns (uint) { + // Shh - currently unused + payer; + borrower; + repayAmount; + + if (!markets[cToken].isListed) { + return uint(Error.MARKET_NOT_LISTED); + } + + // *may include Policy Hook-type checks + + return uint(Error.NO_ERROR); + } + + /** + * @notice Validates repayBorrow and reverts on rejection. May emit logs. + * @param cToken Asset being repaid + * @param payer The address repaying the borrow + * @param borrower The address of the borrower + * @param actualRepayAmount The amount of underlying being repaid + */ + function repayBorrowVerify( + address cToken, + address payer, + address borrower, + uint actualRepayAmount, + uint borrowerIndex) external { + // Shh - currently unused + cToken; + payer; + borrower; + actualRepayAmount; + borrowerIndex; + + // Shh - we don't ever want this hook to be marked pure + if (false) { + maxAssets = maxAssets; + } + } + + /** + * @notice Checks if the liquidation should be allowed to occur + * @param cTokenBorrowed Asset which was borrowed by the borrower + * @param cTokenCollateral Asset which was used as collateral and will be seized + * @param liquidator The address repaying the borrow and seizing the collateral + * @param borrower The address of the borrower + * @param repayAmount The amount of underlying being repaid + */ + function liquidateBorrowAllowed( + address cTokenBorrowed, + address cTokenCollateral, + address liquidator, + address borrower, + uint repayAmount) external returns (uint) { + // Shh - currently unused + liquidator; + + if (!markets[cTokenBorrowed].isListed || !markets[cTokenCollateral].isListed) { + return uint(Error.MARKET_NOT_LISTED); + } + + // *may include Policy Hook-type checks + + /* The borrower must have shortfall in order to be liquidatable */ + (Error err, , uint shortfall) = getAccountLiquidityInternal(borrower); + if (err != Error.NO_ERROR) { + return uint(err); + } + if (shortfall == 0) { + return uint(Error.INSUFFICIENT_SHORTFALL); + } + + /* The liquidator may not repay more than what is allowed by the closeFactor */ + uint borrowBalance = CToken(cTokenBorrowed).borrowBalanceStored(borrower); + (MathError mathErr, uint maxClose) = mulScalarTruncate(Exp({mantissa: closeFactorMantissa}), borrowBalance); + if (mathErr != MathError.NO_ERROR) { + return uint(Error.MATH_ERROR); + } + if (repayAmount > maxClose) { + return uint(Error.TOO_MUCH_REPAY); + } + + return uint(Error.NO_ERROR); + } + + /** + * @notice Validates liquidateBorrow and reverts on rejection. May emit logs. + * @param cTokenBorrowed Asset which was borrowed by the borrower + * @param cTokenCollateral Asset which was used as collateral and will be seized + * @param liquidator The address repaying the borrow and seizing the collateral + * @param borrower The address of the borrower + * @param actualRepayAmount The amount of underlying being repaid + */ + function liquidateBorrowVerify( + address cTokenBorrowed, + address cTokenCollateral, + address liquidator, + address borrower, + uint actualRepayAmount, + uint seizeTokens) external { + // Shh - currently unused + cTokenBorrowed; + cTokenCollateral; + liquidator; + borrower; + actualRepayAmount; + seizeTokens; + + // Shh - we don't ever want this hook to be marked pure + if (false) { + maxAssets = maxAssets; + } + } + + /** + * @notice Checks if the seizing of assets should be allowed to occur + * @param cTokenCollateral Asset which was used as collateral and will be seized + * @param cTokenBorrowed Asset which was borrowed by the borrower + * @param liquidator The address repaying the borrow and seizing the collateral + * @param borrower The address of the borrower + * @param seizeTokens The number of collateral tokens to seize + */ + function seizeAllowed( + address cTokenCollateral, + address cTokenBorrowed, + address liquidator, + address borrower, + uint seizeTokens) external returns (uint) { + // Pausing is a very serious situation - we revert to sound the alarms + require(!seizeGuardianPaused, "seize is paused"); + + // Shh - currently unused + liquidator; + borrower; + seizeTokens; + + if (!markets[cTokenCollateral].isListed || !markets[cTokenBorrowed].isListed) { + return uint(Error.MARKET_NOT_LISTED); + } + + if (CToken(cTokenCollateral).comptroller() != CToken(cTokenBorrowed).comptroller()) { + return uint(Error.COMPTROLLER_MISMATCH); + } + + // *may include Policy Hook-type checks + + return uint(Error.NO_ERROR); + } + + /** + * @notice Validates seize and reverts on rejection. May emit logs. + * @param cTokenCollateral Asset which was used as collateral and will be seized + * @param cTokenBorrowed Asset which was borrowed by the borrower + * @param liquidator The address repaying the borrow and seizing the collateral + * @param borrower The address of the borrower + * @param seizeTokens The number of collateral tokens to seize + */ + function seizeVerify( + address cTokenCollateral, + address cTokenBorrowed, + address liquidator, + address borrower, + uint seizeTokens) external { + // Shh - currently unused + cTokenCollateral; + cTokenBorrowed; + liquidator; + borrower; + seizeTokens; + + // Shh - we don't ever want this hook to be marked pure + if (false) { + maxAssets = maxAssets; + } + } + + /** + * @notice Checks if the account should be allowed to transfer tokens in the given market + * @param cToken The market to verify the transfer against + * @param src The account which sources the tokens + * @param dst The account which receives the tokens + * @param transferTokens The number of cTokens to transfer + * @return 0 if the transfer is allowed, otherwise a semi-opaque error code (See ErrorReporter.sol) + */ + function transferAllowed(address cToken, address src, address dst, uint transferTokens) external returns (uint) { + // Pausing is a very serious situation - we revert to sound the alarms + require(!transferGuardianPaused, "transfer is paused"); + + // Shh - currently unused + dst; + + // *may include Policy Hook-type checks + + // Currently the only consideration is whether or not + // the src is allowed to redeem this many tokens + return redeemAllowedInternal(cToken, src, transferTokens); + } + + /** + * @notice Validates transfer and reverts on rejection. May emit logs. + * @param cToken Asset being transferred + * @param src The account which sources the tokens + * @param dst The account which receives the tokens + * @param transferTokens The number of cTokens to transfer + */ + function transferVerify(address cToken, address src, address dst, uint transferTokens) external { + // Shh - currently unused + cToken; + src; + dst; + transferTokens; + + // Shh - we don't ever want this hook to be marked pure + if (false) { + maxAssets = maxAssets; + } + } + + /*** Liquidity/Liquidation Calculations ***/ + + /** + * @dev Local vars for avoiding stack-depth limits in calculating account liquidity. + * Note that `cTokenBalance` is the number of cTokens the account owns in the market, + * whereas `borrowBalance` is the amount of underlying that the account has borrowed. + */ + struct AccountLiquidityLocalVars { + uint sumCollateral; + uint sumBorrowPlusEffects; + uint cTokenBalance; + uint borrowBalance; + uint exchangeRateMantissa; + uint oraclePriceMantissa; + Exp collateralFactor; + Exp exchangeRate; + Exp oraclePrice; + Exp tokensToEther; + } + + /** + * @notice Determine the current account liquidity wrt collateral requirements + * @return (possible error code (semi-opaque), + account liquidity in excess of collateral requirements, + * account shortfall below collateral requirements) + */ + function getAccountLiquidity(address account) public view returns (uint, uint, uint) { + (Error err, uint liquidity, uint shortfall) = getHypotheticalAccountLiquidityInternal(account, CToken(0), 0, 0); + + return (uint(err), liquidity, shortfall); + } + + /** + * @notice Determine the current account liquidity wrt collateral requirements + * @return (possible error code, + account liquidity in excess of collateral requirements, + * account shortfall below collateral requirements) + */ + function getAccountLiquidityInternal(address account) internal view returns (Error, uint, uint) { + return getHypotheticalAccountLiquidityInternal(account, CToken(0), 0, 0); + } + + /** + * @notice Determine what the account liquidity would be if the given amounts were redeemed/borrowed + * @param cTokenModify The market to hypothetically redeem/borrow in + * @param account The account to determine liquidity for + * @param redeemTokens The number of tokens to hypothetically redeem + * @param borrowAmount The amount of underlying to hypothetically borrow + * @return (possible error code (semi-opaque), + hypothetical account liquidity in excess of collateral requirements, + * hypothetical account shortfall below collateral requirements) + */ + function getHypotheticalAccountLiquidity( + address account, + address cTokenModify, + uint redeemTokens, + uint borrowAmount) public view returns (uint, uint, uint) { + (Error err, uint liquidity, uint shortfall) = getHypotheticalAccountLiquidityInternal(account, CToken(cTokenModify), redeemTokens, borrowAmount); + return (uint(err), liquidity, shortfall); + } + + /** + * @notice Determine what the account liquidity would be if the given amounts were redeemed/borrowed + * @param cTokenModify The market to hypothetically redeem/borrow in + * @param account The account to determine liquidity for + * @param redeemTokens The number of tokens to hypothetically redeem + * @param borrowAmount The amount of underlying to hypothetically borrow + * @dev Note that we calculate the exchangeRateStored for each collateral cToken using stored data, + * without calculating accumulated interest. + * @return (possible error code, + hypothetical account liquidity in excess of collateral requirements, + * hypothetical account shortfall below collateral requirements) + */ + function getHypotheticalAccountLiquidityInternal( + address account, + CToken cTokenModify, + uint redeemTokens, + uint borrowAmount) internal view returns (Error, uint, uint) { + + AccountLiquidityLocalVars memory vars; // Holds all our calculation results + uint oErr; + MathError mErr; + + // For each asset the account is in + CToken[] memory assets = accountAssets[account]; + for (uint i = 0; i < assets.length; i++) { + CToken asset = assets[i]; + + // Read the balances and exchange rate from the cToken + (oErr, vars.cTokenBalance, vars.borrowBalance, vars.exchangeRateMantissa) = asset.getAccountSnapshot(account); + if (oErr != 0) { // semi-opaque error code, we assume NO_ERROR == 0 is invariant between upgrades + return (Error.SNAPSHOT_ERROR, 0, 0); + } + vars.collateralFactor = Exp({mantissa: markets[address(asset)].collateralFactorMantissa}); + vars.exchangeRate = Exp({mantissa: vars.exchangeRateMantissa}); + + // Get the normalized price of the asset + vars.oraclePriceMantissa = oracle.getUnderlyingPrice(asset); + if (vars.oraclePriceMantissa == 0) { + return (Error.PRICE_ERROR, 0, 0); + } + vars.oraclePrice = Exp({mantissa: vars.oraclePriceMantissa}); + + // Pre-compute a conversion factor from tokens -> ether (normalized price value) + (mErr, vars.tokensToEther) = mulExp3(vars.collateralFactor, vars.exchangeRate, vars.oraclePrice); + if (mErr != MathError.NO_ERROR) { + return (Error.MATH_ERROR, 0, 0); + } + + // sumCollateral += tokensToEther * cTokenBalance + (mErr, vars.sumCollateral) = mulScalarTruncateAddUInt(vars.tokensToEther, vars.cTokenBalance, vars.sumCollateral); + if (mErr != MathError.NO_ERROR) { + return (Error.MATH_ERROR, 0, 0); + } + + // sumBorrowPlusEffects += oraclePrice * borrowBalance + (mErr, vars.sumBorrowPlusEffects) = mulScalarTruncateAddUInt(vars.oraclePrice, vars.borrowBalance, vars.sumBorrowPlusEffects); + if (mErr != MathError.NO_ERROR) { + return (Error.MATH_ERROR, 0, 0); + } + + // Calculate effects of interacting with cTokenModify + if (asset == cTokenModify) { + // redeem effect + // sumBorrowPlusEffects += tokensToEther * redeemTokens + (mErr, vars.sumBorrowPlusEffects) = mulScalarTruncateAddUInt(vars.tokensToEther, redeemTokens, vars.sumBorrowPlusEffects); + if (mErr != MathError.NO_ERROR) { + return (Error.MATH_ERROR, 0, 0); + } + + // borrow effect + // sumBorrowPlusEffects += oraclePrice * borrowAmount + (mErr, vars.sumBorrowPlusEffects) = mulScalarTruncateAddUInt(vars.oraclePrice, borrowAmount, vars.sumBorrowPlusEffects); + if (mErr != MathError.NO_ERROR) { + return (Error.MATH_ERROR, 0, 0); + } + } + } + + // These are safe, as the underflow condition is checked first + if (vars.sumCollateral > vars.sumBorrowPlusEffects) { + return (Error.NO_ERROR, vars.sumCollateral - vars.sumBorrowPlusEffects, 0); + } else { + return (Error.NO_ERROR, 0, vars.sumBorrowPlusEffects - vars.sumCollateral); + } + } + + /** + * @notice Calculate number of tokens of collateral asset to seize given an underlying amount + * @dev Used in liquidation (called in cToken.liquidateBorrowFresh) + * @param cTokenBorrowed The address of the borrowed cToken + * @param cTokenCollateral The address of the collateral cToken + * @param actualRepayAmount The amount of cTokenBorrowed underlying to convert into cTokenCollateral tokens + * @return (errorCode, number of cTokenCollateral tokens to be seized in a liquidation) + */ + function liquidateCalculateSeizeTokens(address cTokenBorrowed, address cTokenCollateral, uint actualRepayAmount) external view returns (uint, uint) { + /* Read oracle prices for borrowed and collateral markets */ + uint priceBorrowedMantissa = oracle.getUnderlyingPrice(CToken(cTokenBorrowed)); + uint priceCollateralMantissa = oracle.getUnderlyingPrice(CToken(cTokenCollateral)); + if (priceBorrowedMantissa == 0 || priceCollateralMantissa == 0) { + return (uint(Error.PRICE_ERROR), 0); + } + + /* + * Get the exchange rate and calculate the number of collateral tokens to seize: + * seizeAmount = actualRepayAmount * liquidationIncentive * priceBorrowed / priceCollateral + * seizeTokens = seizeAmount / exchangeRate + * = actualRepayAmount * (liquidationIncentive * priceBorrowed) / (priceCollateral * exchangeRate) + */ + uint exchangeRateMantissa = CToken(cTokenCollateral).exchangeRateStored(); // Note: reverts on error + uint seizeTokens; + Exp memory numerator; + Exp memory denominator; + Exp memory ratio; + MathError mathErr; + + (mathErr, numerator) = mulExp(liquidationIncentiveMantissa, priceBorrowedMantissa); + if (mathErr != MathError.NO_ERROR) { + return (uint(Error.MATH_ERROR), 0); + } + + (mathErr, denominator) = mulExp(priceCollateralMantissa, exchangeRateMantissa); + if (mathErr != MathError.NO_ERROR) { + return (uint(Error.MATH_ERROR), 0); + } + + (mathErr, ratio) = divExp(numerator, denominator); + if (mathErr != MathError.NO_ERROR) { + return (uint(Error.MATH_ERROR), 0); + } + + (mathErr, seizeTokens) = mulScalarTruncate(ratio, actualRepayAmount); + if (mathErr != MathError.NO_ERROR) { + return (uint(Error.MATH_ERROR), 0); + } + + return (uint(Error.NO_ERROR), seizeTokens); + } + + /*** Admin Functions ***/ + + /** + * @notice Sets a new price oracle for the comptroller + * @dev Admin function to set a new price oracle + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function _setPriceOracle(PriceOracle newOracle) public returns (uint) { + // Check caller is admin + if (msg.sender != admin) { + return fail(Error.UNAUTHORIZED, FailureInfo.SET_PRICE_ORACLE_OWNER_CHECK); + } + + // Track the old oracle for the comptroller + PriceOracle oldOracle = oracle; + + // Set comptroller's oracle to newOracle + oracle = newOracle; + + // Emit NewPriceOracle(oldOracle, newOracle) + emit NewPriceOracle(oldOracle, newOracle); + + return uint(Error.NO_ERROR); + } + + /** + * @notice Sets the closeFactor used when liquidating borrows + * @dev Admin function to set closeFactor + * @param newCloseFactorMantissa New close factor, scaled by 1e18 + * @return uint 0=success, otherwise a failure. (See ErrorReporter for details) + */ + function _setCloseFactor(uint newCloseFactorMantissa) external returns (uint256) { + // Check caller is admin + if (msg.sender != admin) { + return fail(Error.UNAUTHORIZED, FailureInfo.SET_CLOSE_FACTOR_OWNER_CHECK); + } + + Exp memory newCloseFactorExp = Exp({mantissa: newCloseFactorMantissa}); + Exp memory lowLimit = Exp({mantissa: closeFactorMinMantissa}); + if (lessThanOrEqualExp(newCloseFactorExp, lowLimit)) { + return fail(Error.INVALID_CLOSE_FACTOR, FailureInfo.SET_CLOSE_FACTOR_VALIDATION); + } + + Exp memory highLimit = Exp({mantissa: closeFactorMaxMantissa}); + if (lessThanExp(highLimit, newCloseFactorExp)) { + return fail(Error.INVALID_CLOSE_FACTOR, FailureInfo.SET_CLOSE_FACTOR_VALIDATION); + } + + uint oldCloseFactorMantissa = closeFactorMantissa; + closeFactorMantissa = newCloseFactorMantissa; + emit NewCloseFactor(oldCloseFactorMantissa, closeFactorMantissa); + + return uint(Error.NO_ERROR); + } + + /** + * @notice Sets the collateralFactor for a market + * @dev Admin function to set per-market collateralFactor + * @param cToken The market to set the factor on + * @param newCollateralFactorMantissa The new collateral factor, scaled by 1e18 + * @return uint 0=success, otherwise a failure. (See ErrorReporter for details) + */ + function _setCollateralFactor(CToken cToken, uint newCollateralFactorMantissa) external returns (uint256) { + // Check caller is admin + if (msg.sender != admin) { + return fail(Error.UNAUTHORIZED, FailureInfo.SET_COLLATERAL_FACTOR_OWNER_CHECK); + } + + // Verify market is listed + Market storage market = markets[address(cToken)]; + if (!market.isListed) { + return fail(Error.MARKET_NOT_LISTED, FailureInfo.SET_COLLATERAL_FACTOR_NO_EXISTS); + } + + Exp memory newCollateralFactorExp = Exp({mantissa: newCollateralFactorMantissa}); + + // Check collateral factor <= 0.9 + Exp memory highLimit = Exp({mantissa: collateralFactorMaxMantissa}); + if (lessThanExp(highLimit, newCollateralFactorExp)) { + return fail(Error.INVALID_COLLATERAL_FACTOR, FailureInfo.SET_COLLATERAL_FACTOR_VALIDATION); + } + + // If collateral factor != 0, fail if price == 0 + if (newCollateralFactorMantissa != 0 && oracle.getUnderlyingPrice(cToken) == 0) { + return fail(Error.PRICE_ERROR, FailureInfo.SET_COLLATERAL_FACTOR_WITHOUT_PRICE); + } + + // Set market's collateral factor to new collateral factor, remember old value + uint oldCollateralFactorMantissa = market.collateralFactorMantissa; + market.collateralFactorMantissa = newCollateralFactorMantissa; + + // Emit event with asset, old collateral factor, and new collateral factor + emit NewCollateralFactor(cToken, oldCollateralFactorMantissa, newCollateralFactorMantissa); + + return uint(Error.NO_ERROR); + } + + /** + * @notice Sets maxAssets which controls how many markets can be entered + * @dev Admin function to set maxAssets + * @param newMaxAssets New max assets + * @return uint 0=success, otherwise a failure. (See ErrorReporter for details) + */ + function _setMaxAssets(uint newMaxAssets) external returns (uint) { + // Check caller is admin + if (msg.sender != admin) { + return fail(Error.UNAUTHORIZED, FailureInfo.SET_MAX_ASSETS_OWNER_CHECK); + } + + uint oldMaxAssets = maxAssets; + maxAssets = newMaxAssets; + emit NewMaxAssets(oldMaxAssets, newMaxAssets); + + return uint(Error.NO_ERROR); + } + + /** + * @notice Sets liquidationIncentive + * @dev Admin function to set liquidationIncentive + * @param newLiquidationIncentiveMantissa New liquidationIncentive scaled by 1e18 + * @return uint 0=success, otherwise a failure. (See ErrorReporter for details) + */ + function _setLiquidationIncentive(uint newLiquidationIncentiveMantissa) external returns (uint) { + // Check caller is admin + if (msg.sender != admin) { + return fail(Error.UNAUTHORIZED, FailureInfo.SET_LIQUIDATION_INCENTIVE_OWNER_CHECK); + } + + // Check de-scaled min <= newLiquidationIncentive <= max + Exp memory newLiquidationIncentive = Exp({mantissa: newLiquidationIncentiveMantissa}); + Exp memory minLiquidationIncentive = Exp({mantissa: liquidationIncentiveMinMantissa}); + if (lessThanExp(newLiquidationIncentive, minLiquidationIncentive)) { + return fail(Error.INVALID_LIQUIDATION_INCENTIVE, FailureInfo.SET_LIQUIDATION_INCENTIVE_VALIDATION); + } + + Exp memory maxLiquidationIncentive = Exp({mantissa: liquidationIncentiveMaxMantissa}); + if (lessThanExp(maxLiquidationIncentive, newLiquidationIncentive)) { + return fail(Error.INVALID_LIQUIDATION_INCENTIVE, FailureInfo.SET_LIQUIDATION_INCENTIVE_VALIDATION); + } + + // Save current value for use in log + uint oldLiquidationIncentiveMantissa = liquidationIncentiveMantissa; + + // Set liquidation incentive to new incentive + liquidationIncentiveMantissa = newLiquidationIncentiveMantissa; + + // Emit event with old incentive, new incentive + emit NewLiquidationIncentive(oldLiquidationIncentiveMantissa, newLiquidationIncentiveMantissa); + + return uint(Error.NO_ERROR); + } + + /** + * @notice Add the market to the markets mapping and set it as listed + * @dev Admin function to set isListed and add support for the market + * @param cToken The address of the market (token) to list + * @return uint 0=success, otherwise a failure. (See enum Error for details) + */ + function _supportMarket(CToken cToken) external returns (uint) { + if (msg.sender != admin) { + return fail(Error.UNAUTHORIZED, FailureInfo.SUPPORT_MARKET_OWNER_CHECK); + } + + if (markets[address(cToken)].isListed) { + return fail(Error.MARKET_ALREADY_LISTED, FailureInfo.SUPPORT_MARKET_EXISTS); + } + + cToken.isCToken(); // Sanity check to make sure its really a CToken + + markets[address(cToken)] = Market({isListed: true, isComped: false, collateralFactorMantissa: 0}); + emit MarketListed(cToken); + + return uint(Error.NO_ERROR); + } + + /** + * @notice Admin function to change the Pause Guardian + * @param newPauseGuardian The address of the new Pause Guardian + * @return uint 0=success, otherwise a failure. (See enum Error for details) + */ + function _setPauseGuardian(address newPauseGuardian) public returns (uint) { + if (msg.sender != admin) { + return fail(Error.UNAUTHORIZED, FailureInfo.SET_PAUSE_GUARDIAN_OWNER_CHECK); + } + + // Save current value for inclusion in log + address oldPauseGuardian = pauseGuardian; + + // Store pauseGuardian with value newPauseGuardian + pauseGuardian = newPauseGuardian; + + // Emit NewPauseGuardian(OldPauseGuardian, NewPauseGuardian) + emit NewPauseGuardian(oldPauseGuardian, pauseGuardian); + + return uint(Error.NO_ERROR); + } + + function _setMintPaused(CToken cToken, bool state) public returns (bool) { + require(markets[address(cToken)].isListed, "cannot pause a market that is not listed"); + require(msg.sender == pauseGuardian || msg.sender == admin, "only pause guardian and admin can pause"); + require(msg.sender == admin || state == true, "only admin can unpause"); + + mintGuardianPaused[address(cToken)] = state; + emit ActionPaused(cToken, "Mint", state); + return state; + } + + function _setBorrowPaused(CToken cToken, bool state) public returns (bool) { + require(markets[address(cToken)].isListed, "cannot pause a market that is not listed"); + require(msg.sender == pauseGuardian || msg.sender == admin, "only pause guardian and admin can pause"); + require(msg.sender == admin || state == true, "only admin can unpause"); + + borrowGuardianPaused[address(cToken)] = state; + emit ActionPaused(cToken, "Borrow", state); + return state; + } + + function _setTransferPaused(bool state) public returns (bool) { + require(msg.sender == pauseGuardian || msg.sender == admin, "only pause guardian and admin can pause"); + require(msg.sender == admin || state == true, "only admin can unpause"); + + transferGuardianPaused = state; + emit ActionPaused("Transfer", state); + return state; + } + + function _setSeizePaused(bool state) public returns (bool) { + require(msg.sender == pauseGuardian || msg.sender == admin, "only pause guardian and admin can pause"); + require(msg.sender == admin || state == true, "only admin can unpause"); + + seizeGuardianPaused = state; + emit ActionPaused("Seize", state); + return state; + } + + function _become(Unitroller unitroller) public { + require(msg.sender == unitroller.admin(), "only unitroller admin can change brains"); + + uint changeStatus = unitroller._acceptImplementation(); + require(changeStatus == 0, "change not authorized"); + } +} diff --git a/contracts/ComptrollerInterface.sol b/contracts/ComptrollerInterface.sol new file mode 100644 index 0000000..595863d --- /dev/null +++ b/contracts/ComptrollerInterface.sol @@ -0,0 +1,71 @@ +pragma solidity ^0.5.12; + +contract ComptrollerInterface { + /// @notice Indicator that this is a Comptroller contract (for inspection) + bool public constant isComptroller = true; + + /*** Assets You Are In ***/ + + function enterMarkets(address[] calldata cTokens) external returns (uint[] memory); + function exitMarket(address cToken) external returns (uint); + + /*** Policy Hooks ***/ + + function mintAllowed(address cToken, address minter, uint mintAmount) external returns (uint); + function mintVerify(address cToken, address minter, uint mintAmount, uint mintTokens) external; + + function redeemAllowed(address cToken, address redeemer, uint redeemTokens) external returns (uint); + function redeemVerify(address cToken, address redeemer, uint redeemAmount, uint redeemTokens) external; + + function borrowAllowed(address cToken, address borrower, uint borrowAmount) external returns (uint); + function borrowVerify(address cToken, address borrower, uint borrowAmount) external; + + function repayBorrowAllowed( + address cToken, + address payer, + address borrower, + uint repayAmount) external returns (uint); + function repayBorrowVerify( + address cToken, + address payer, + address borrower, + uint repayAmount, + uint borrowerIndex) external; + + function liquidateBorrowAllowed( + address cTokenBorrowed, + address cTokenCollateral, + address liquidator, + address borrower, + uint repayAmount) external returns (uint); + function liquidateBorrowVerify( + address cTokenBorrowed, + address cTokenCollateral, + address liquidator, + address borrower, + uint repayAmount, + uint seizeTokens) external; + + function seizeAllowed( + address cTokenCollateral, + address cTokenBorrowed, + address liquidator, + address borrower, + uint seizeTokens) external returns (uint); + function seizeVerify( + address cTokenCollateral, + address cTokenBorrowed, + address liquidator, + address borrower, + uint seizeTokens) external; + + function transferAllowed(address cToken, address src, address dst, uint transferTokens) external returns (uint); + function transferVerify(address cToken, address src, address dst, uint transferTokens) external; + + /*** Liquidity/Liquidation Calculations ***/ + + function liquidateCalculateSeizeTokens( + address cTokenBorrowed, + address cTokenCollateral, + uint repayAmount) external view returns (uint, uint); +} diff --git a/contracts/ComptrollerLegacy.sol b/contracts/ComptrollerLegacy.sol new file mode 100644 index 0000000..1c9b231 --- /dev/null +++ b/contracts/ComptrollerLegacy.sol @@ -0,0 +1,1397 @@ +pragma solidity ^0.5.12; + +import "./CToken.sol"; +import "./ErrorReporter.sol"; +import "./Exponential.sol"; +import "./PriceOracle.sol"; +import "./ComptrollerInterface.sol"; +import "./ComptrollerStorage.sol"; +import "./Unitroller.sol"; +import "./Governance/Comp.sol"; + +/** + * @title Compound's Comptroller Contract + * @author Compound + */ +contract Comptroller is ComptrollerV3Storage, ComptrollerInterface, ComptrollerErrorReporter, Exponential { + /// @notice Emitted when an admin supports a market + event MarketListed(CToken cToken); + + /// @notice Emitted when an account enters a market + event MarketEntered(CToken cToken, address account); + + /// @notice Emitted when an account exits a market + event MarketExited(CToken cToken, address account); + + /// @notice Emitted when close factor is changed by admin + event NewCloseFactor(uint oldCloseFactorMantissa, uint newCloseFactorMantissa); + + /// @notice Emitted when a collateral factor is changed by admin + event NewCollateralFactor(CToken cToken, uint oldCollateralFactorMantissa, uint newCollateralFactorMantissa); + + /// @notice Emitted when liquidation incentive is changed by admin + event NewLiquidationIncentive(uint oldLiquidationIncentiveMantissa, uint newLiquidationIncentiveMantissa); + + /// @notice Emitted when maxAssets is changed by admin + event NewMaxAssets(uint oldMaxAssets, uint newMaxAssets); + + /// @notice Emitted when price oracle is changed + event NewPriceOracle(PriceOracle oldPriceOracle, PriceOracle newPriceOracle); + + /// @notice Emitted when pause guardian is changed + event NewPauseGuardian(address oldPauseGuardian, address newPauseGuardian); + + /// @notice Emitted when an action is paused globally + event ActionPaused(string action, bool pauseState); + + /// @notice Emitted when an action is paused on a market + event ActionPaused(CToken cToken, string action, bool pauseState); + + /// @notice Emitted when market comped status is changed + event MarketComped(CToken cToken, bool isComped); + + /// @notice Emitted when COMP rate is changed + event NewCompRate(uint oldCompRate, uint newCompRate); + + /// @notice Emitted when a new COMP speed is calculated for a market + event CompSpeedUpdated(CToken indexed cToken, uint newSpeed); + + /// @notice Emitted when COMP is distributed to a supplier + event DistributedSupplierComp(CToken indexed cToken, address indexed supplier, uint compDelta, uint compSupplyIndex); + + /// @notice Emitted when COMP is distributed to a borrower + event DistributedBorrowerComp(CToken indexed cToken, address indexed borrower, uint compDelta, uint compBorrowIndex); + + /// @notice The threshold above which the flywheel transfers COMP, in wei + uint public constant compClaimThreshold = 0.001e18; + + /// @notice The initial COMP index for a market + uint224 public constant compInitialIndex = 1e36; + + // closeFactorMantissa must be strictly greater than this value + uint internal constant closeFactorMinMantissa = 0.05e18; // 0.05 + + // closeFactorMantissa must not exceed this value + uint internal constant closeFactorMaxMantissa = 0.9e18; // 0.9 + + // No collateralFactorMantissa may exceed this value + uint internal constant collateralFactorMaxMantissa = 0.9e18; // 0.9 + + // liquidationIncentiveMantissa must be no less than this value + uint internal constant liquidationIncentiveMinMantissa = 1.0e18; // 1.0 + + // liquidationIncentiveMantissa must be no greater than this value + uint internal constant liquidationIncentiveMaxMantissa = 1.5e18; // 1.5 + + constructor() public { + admin = msg.sender; + } + + /*** Assets You Are In ***/ + + /** + * @notice Returns the assets an account has entered + * @param account The address of the account to pull assets for + * @return A dynamic list with the assets the account has entered + */ + function getAssetsIn(address account) external view returns (CToken[] memory) { + CToken[] memory assetsIn = accountAssets[account]; + + return assetsIn; + } + + /** + * @notice Returns whether the given account is entered in the given asset + * @param account The address of the account to check + * @param cToken The cToken to check + * @return True if the account is in the asset, otherwise false. + */ + function checkMembership(address account, CToken cToken) external view returns (bool) { + return markets[address(cToken)].accountMembership[account]; + } + + /** + * @notice Add assets to be included in account liquidity calculation + * @param cTokens The list of addresses of the cToken markets to be enabled + * @return Success indicator for whether each corresponding market was entered + */ + function enterMarkets(address[] memory cTokens) public returns (uint[] memory) { + uint len = cTokens.length; + + uint[] memory results = new uint[](len); + for (uint i = 0; i < len; i++) { + CToken cToken = CToken(cTokens[i]); + + results[i] = uint(addToMarketInternal(cToken, msg.sender)); + } + + return results; + } + + /** + * @notice Add the market to the borrower's "assets in" for liquidity calculations + * @param cToken The market to enter + * @param borrower The address of the account to modify + * @return Success indicator for whether the market was entered + */ + function addToMarketInternal(CToken cToken, address borrower) internal returns (Error) { + Market storage marketToJoin = markets[address(cToken)]; + + if (!marketToJoin.isListed) { + // market is not listed, cannot join + return Error.MARKET_NOT_LISTED; + } + + if (marketToJoin.accountMembership[borrower] == true) { + // already joined + return Error.NO_ERROR; + } + + if (accountAssets[borrower].length >= maxAssets) { + // no space, cannot join + return Error.TOO_MANY_ASSETS; + } + + // survived the gauntlet, add to list + // NOTE: we store these somewhat redundantly as a significant optimization + // this avoids having to iterate through the list for the most common use cases + // that is, only when we need to perform liquidity checks + // and not whenever we want to check if an account is in a particular market + marketToJoin.accountMembership[borrower] = true; + accountAssets[borrower].push(cToken); + + emit MarketEntered(cToken, borrower); + + return Error.NO_ERROR; + } + + /** + * @notice Removes asset from sender's account liquidity calculation + * @dev Sender must not have an outstanding borrow balance in the asset, + * or be providing neccessary collateral for an outstanding borrow. + * @param cTokenAddress The address of the asset to be removed + * @return Whether or not the account successfully exited the market + */ + function exitMarket(address cTokenAddress) external returns (uint) { + CToken cToken = CToken(cTokenAddress); + /* Get sender tokensHeld and amountOwed underlying from the cToken */ + (uint oErr, uint tokensHeld, uint amountOwed, ) = cToken.getAccountSnapshot(msg.sender); + require(oErr == 0, "exitMarket: getAccountSnapshot failed"); // semi-opaque error code + + /* Fail if the sender has a borrow balance */ + if (amountOwed != 0) { + return fail(Error.NONZERO_BORROW_BALANCE, FailureInfo.EXIT_MARKET_BALANCE_OWED); + } + + /* Fail if the sender is not permitted to redeem all of their tokens */ + uint allowed = redeemAllowedInternal(cTokenAddress, msg.sender, tokensHeld); + if (allowed != 0) { + return failOpaque(Error.REJECTION, FailureInfo.EXIT_MARKET_REJECTION, allowed); + } + + Market storage marketToExit = markets[address(cToken)]; + + /* Return true if the sender is not already ‘in’ the market */ + if (!marketToExit.accountMembership[msg.sender]) { + return uint(Error.NO_ERROR); + } + + /* Set cToken account membership to false */ + delete marketToExit.accountMembership[msg.sender]; + + /* Delete cToken from the account’s list of assets */ + // load into memory for faster iteration + CToken[] memory userAssetList = accountAssets[msg.sender]; + uint len = userAssetList.length; + uint assetIndex = len; + for (uint i = 0; i < len; i++) { + if (userAssetList[i] == cToken) { + assetIndex = i; + break; + } + } + + // We *must* have found the asset in the list or our redundant data structure is broken + assert(assetIndex < len); + + // copy last item in list to location of item to be removed, reduce length by 1 + CToken[] storage storedList = accountAssets[msg.sender]; + storedList[assetIndex] = storedList[storedList.length - 1]; + storedList.length--; + + emit MarketExited(cToken, msg.sender); + + return uint(Error.NO_ERROR); + } + + /*** Policy Hooks ***/ + + /** + * @notice Checks if the account should be allowed to mint tokens in the given market + * @param cToken The market to verify the mint against + * @param minter The account which would get the minted tokens + * @param mintAmount The amount of underlying being supplied to the market in exchange for tokens + * @return 0 if the mint is allowed, otherwise a semi-opaque error code (See ErrorReporter.sol) + */ + function mintAllowed(address cToken, address minter, uint mintAmount) external returns (uint) { + // Pausing is a very serious situation - we revert to sound the alarms + require(!mintGuardianPaused[cToken], "mint is paused"); + + // Shh - currently unused + minter; + mintAmount; + + if (!markets[cToken].isListed) { + return uint(Error.MARKET_NOT_LISTED); + } + + // Keep the flywheel moving + updateCompSupplyIndex(cToken); + distributeSupplierComp(cToken, minter, false); + + return uint(Error.NO_ERROR); + } + + /** + * @notice Validates mint and reverts on rejection. May emit logs. + * @param cToken Asset being minted + * @param minter The address minting the tokens + * @param actualMintAmount The amount of the underlying asset being minted + * @param mintTokens The number of tokens being minted + */ + function mintVerify(address cToken, address minter, uint actualMintAmount, uint mintTokens) external { + // Shh - currently unused + cToken; + minter; + actualMintAmount; + mintTokens; + + // Shh - we don't ever want this hook to be marked pure + if (false) { + maxAssets = maxAssets; + } + } + + /** + * @notice Checks if the account should be allowed to redeem tokens in the given market + * @param cToken The market to verify the redeem against + * @param redeemer The account which would redeem the tokens + * @param redeemTokens The number of cTokens to exchange for the underlying asset in the market + * @return 0 if the redeem is allowed, otherwise a semi-opaque error code (See ErrorReporter.sol) + */ + function redeemAllowed(address cToken, address redeemer, uint redeemTokens) external returns (uint) { + uint allowed = redeemAllowedInternal(cToken, redeemer, redeemTokens); + if (allowed != uint(Error.NO_ERROR)) { + return allowed; + } + + // Keep the flywheel moving + updateCompSupplyIndex(cToken); + distributeSupplierComp(cToken, redeemer, false); + + return uint(Error.NO_ERROR); + } + + function redeemAllowedInternal(address cToken, address redeemer, uint redeemTokens) internal view returns (uint) { + if (!markets[cToken].isListed) { + return uint(Error.MARKET_NOT_LISTED); + } + + /* If the redeemer is not 'in' the market, then we can bypass the liquidity check */ + if (!markets[cToken].accountMembership[redeemer]) { + return uint(Error.NO_ERROR); + } + + /* Otherwise, perform a hypothetical liquidity check to guard against shortfall */ + (Error err, , uint shortfall) = getHypotheticalAccountLiquidityInternal(redeemer, CToken(cToken), redeemTokens, 0); + if (err != Error.NO_ERROR) { + return uint(err); + } + if (shortfall > 0) { + return uint(Error.INSUFFICIENT_LIQUIDITY); + } + + return uint(Error.NO_ERROR); + } + + /** + * @notice Validates redeem and reverts on rejection. May emit logs. + * @param cToken Asset being redeemed + * @param redeemer The address redeeming the tokens + * @param redeemAmount The amount of the underlying asset being redeemed + * @param redeemTokens The number of tokens being redeemed + */ + function redeemVerify(address cToken, address redeemer, uint redeemAmount, uint redeemTokens) external { + // Shh - currently unused + cToken; + redeemer; + + // Require tokens is zero or amount is also zero + if (redeemTokens == 0 && redeemAmount > 0) { + revert("redeemTokens zero"); + } + } + + /** + * @notice Checks if the account should be allowed to borrow the underlying asset of the given market + * @param cToken The market to verify the borrow against + * @param borrower The account which would borrow the asset + * @param borrowAmount The amount of underlying the account would borrow + * @return 0 if the borrow is allowed, otherwise a semi-opaque error code (See ErrorReporter.sol) + */ + function borrowAllowed(address cToken, address borrower, uint borrowAmount) external returns (uint) { + // Pausing is a very serious situation - we revert to sound the alarms + require(!borrowGuardianPaused[cToken], "borrow is paused"); + + if (!markets[cToken].isListed) { + return uint(Error.MARKET_NOT_LISTED); + } + + if (!markets[cToken].accountMembership[borrower]) { + // only cTokens may call borrowAllowed if borrower not in market + require(msg.sender == cToken, "sender must be cToken"); + + // attempt to add borrower to the market + Error err = addToMarketInternal(CToken(msg.sender), borrower); + if (err != Error.NO_ERROR) { + return uint(err); + } + + // it should be impossible to break the important invariant + assert(markets[cToken].accountMembership[borrower]); + } + + if (oracle.getUnderlyingPrice(CToken(cToken)) == 0) { + return uint(Error.PRICE_ERROR); + } + + (Error err, , uint shortfall) = getHypotheticalAccountLiquidityInternal(borrower, CToken(cToken), 0, borrowAmount); + if (err != Error.NO_ERROR) { + return uint(err); + } + if (shortfall > 0) { + return uint(Error.INSUFFICIENT_LIQUIDITY); + } + + // Keep the flywheel moving + Exp memory borrowIndex = Exp({mantissa: CToken(cToken).borrowIndex()}); + updateCompBorrowIndex(cToken, borrowIndex); + distributeBorrowerComp(cToken, borrower, borrowIndex, false); + + return uint(Error.NO_ERROR); + } + + /** + * @notice Validates borrow and reverts on rejection. May emit logs. + * @param cToken Asset whose underlying is being borrowed + * @param borrower The address borrowing the underlying + * @param borrowAmount The amount of the underlying asset requested to borrow + */ + function borrowVerify(address cToken, address borrower, uint borrowAmount) external { + // Shh - currently unused + cToken; + borrower; + borrowAmount; + + // Shh - we don't ever want this hook to be marked pure + if (false) { + maxAssets = maxAssets; + } + } + + /** + * @notice Checks if the account should be allowed to repay a borrow in the given market + * @param cToken The market to verify the repay against + * @param payer The account which would repay the asset + * @param borrower The account which would borrowed the asset + * @param repayAmount The amount of the underlying asset the account would repay + * @return 0 if the repay is allowed, otherwise a semi-opaque error code (See ErrorReporter.sol) + */ + function repayBorrowAllowed( + address cToken, + address payer, + address borrower, + uint repayAmount) external returns (uint) { + // Shh - currently unused + payer; + borrower; + repayAmount; + + if (!markets[cToken].isListed) { + return uint(Error.MARKET_NOT_LISTED); + } + + // Keep the flywheel moving + Exp memory borrowIndex = Exp({mantissa: CToken(cToken).borrowIndex()}); + updateCompBorrowIndex(cToken, borrowIndex); + distributeBorrowerComp(cToken, borrower, borrowIndex, false); + + return uint(Error.NO_ERROR); + } + + /** + * @notice Validates repayBorrow and reverts on rejection. May emit logs. + * @param cToken Asset being repaid + * @param payer The address repaying the borrow + * @param borrower The address of the borrower + * @param actualRepayAmount The amount of underlying being repaid + */ + function repayBorrowVerify( + address cToken, + address payer, + address borrower, + uint actualRepayAmount, + uint borrowerIndex) external { + // Shh - currently unused + cToken; + payer; + borrower; + actualRepayAmount; + borrowerIndex; + + // Shh - we don't ever want this hook to be marked pure + if (false) { + maxAssets = maxAssets; + } + } + + /** + * @notice Checks if the liquidation should be allowed to occur + * @param cTokenBorrowed Asset which was borrowed by the borrower + * @param cTokenCollateral Asset which was used as collateral and will be seized + * @param liquidator The address repaying the borrow and seizing the collateral + * @param borrower The address of the borrower + * @param repayAmount The amount of underlying being repaid + */ + function liquidateBorrowAllowed( + address cTokenBorrowed, + address cTokenCollateral, + address liquidator, + address borrower, + uint repayAmount) external returns (uint) { + // Shh - currently unused + liquidator; + + if (!markets[cTokenBorrowed].isListed || !markets[cTokenCollateral].isListed) { + return uint(Error.MARKET_NOT_LISTED); + } + + /* The borrower must have shortfall in order to be liquidatable */ + (Error err, , uint shortfall) = getAccountLiquidityInternal(borrower); + if (err != Error.NO_ERROR) { + return uint(err); + } + if (shortfall == 0) { + return uint(Error.INSUFFICIENT_SHORTFALL); + } + + /* The liquidator may not repay more than what is allowed by the closeFactor */ + uint borrowBalance = CToken(cTokenBorrowed).borrowBalanceStored(borrower); + (MathError mathErr, uint maxClose) = mulScalarTruncate(Exp({mantissa: closeFactorMantissa}), borrowBalance); + if (mathErr != MathError.NO_ERROR) { + return uint(Error.MATH_ERROR); + } + if (repayAmount > maxClose) { + return uint(Error.TOO_MUCH_REPAY); + } + + return uint(Error.NO_ERROR); + } + + /** + * @notice Validates liquidateBorrow and reverts on rejection. May emit logs. + * @param cTokenBorrowed Asset which was borrowed by the borrower + * @param cTokenCollateral Asset which was used as collateral and will be seized + * @param liquidator The address repaying the borrow and seizing the collateral + * @param borrower The address of the borrower + * @param actualRepayAmount The amount of underlying being repaid + */ + function liquidateBorrowVerify( + address cTokenBorrowed, + address cTokenCollateral, + address liquidator, + address borrower, + uint actualRepayAmount, + uint seizeTokens) external { + // Shh - currently unused + cTokenBorrowed; + cTokenCollateral; + liquidator; + borrower; + actualRepayAmount; + seizeTokens; + + // Shh - we don't ever want this hook to be marked pure + if (false) { + maxAssets = maxAssets; + } + } + + /** + * @notice Checks if the seizing of assets should be allowed to occur + * @param cTokenCollateral Asset which was used as collateral and will be seized + * @param cTokenBorrowed Asset which was borrowed by the borrower + * @param liquidator The address repaying the borrow and seizing the collateral + * @param borrower The address of the borrower + * @param seizeTokens The number of collateral tokens to seize + */ + function seizeAllowed( + address cTokenCollateral, + address cTokenBorrowed, + address liquidator, + address borrower, + uint seizeTokens) external returns (uint) { + // Pausing is a very serious situation - we revert to sound the alarms + require(!seizeGuardianPaused, "seize is paused"); + + // Shh - currently unused + seizeTokens; + + if (!markets[cTokenCollateral].isListed || !markets[cTokenBorrowed].isListed) { + return uint(Error.MARKET_NOT_LISTED); + } + + if (CToken(cTokenCollateral).comptroller() != CToken(cTokenBorrowed).comptroller()) { + return uint(Error.COMPTROLLER_MISMATCH); + } + + // Keep the flywheel moving + updateCompSupplyIndex(cTokenCollateral); + distributeSupplierComp(cTokenCollateral, borrower, false); + distributeSupplierComp(cTokenCollateral, liquidator, false); + + return uint(Error.NO_ERROR); + } + + /** + * @notice Validates seize and reverts on rejection. May emit logs. + * @param cTokenCollateral Asset which was used as collateral and will be seized + * @param cTokenBorrowed Asset which was borrowed by the borrower + * @param liquidator The address repaying the borrow and seizing the collateral + * @param borrower The address of the borrower + * @param seizeTokens The number of collateral tokens to seize + */ + function seizeVerify( + address cTokenCollateral, + address cTokenBorrowed, + address liquidator, + address borrower, + uint seizeTokens) external { + // Shh - currently unused + cTokenCollateral; + cTokenBorrowed; + liquidator; + borrower; + seizeTokens; + + // Shh - we don't ever want this hook to be marked pure + if (false) { + maxAssets = maxAssets; + } + } + + /** + * @notice Checks if the account should be allowed to transfer tokens in the given market + * @param cToken The market to verify the transfer against + * @param src The account which sources the tokens + * @param dst The account which receives the tokens + * @param transferTokens The number of cTokens to transfer + * @return 0 if the transfer is allowed, otherwise a semi-opaque error code (See ErrorReporter.sol) + */ + function transferAllowed(address cToken, address src, address dst, uint transferTokens) external returns (uint) { + // Pausing is a very serious situation - we revert to sound the alarms + require(!transferGuardianPaused, "transfer is paused"); + + // Currently the only consideration is whether or not + // the src is allowed to redeem this many tokens + uint allowed = redeemAllowedInternal(cToken, src, transferTokens); + if (allowed != uint(Error.NO_ERROR)) { + return allowed; + } + + // Keep the flywheel moving + updateCompSupplyIndex(cToken); + distributeSupplierComp(cToken, src, false); + distributeSupplierComp(cToken, dst, false); + + return uint(Error.NO_ERROR); + } + + /** + * @notice Validates transfer and reverts on rejection. May emit logs. + * @param cToken Asset being transferred + * @param src The account which sources the tokens + * @param dst The account which receives the tokens + * @param transferTokens The number of cTokens to transfer + */ + function transferVerify(address cToken, address src, address dst, uint transferTokens) external { + // Shh - currently unused + cToken; + src; + dst; + transferTokens; + + // Shh - we don't ever want this hook to be marked pure + if (false) { + maxAssets = maxAssets; + } + } + + /*** Liquidity/Liquidation Calculations ***/ + + /** + * @dev Local vars for avoiding stack-depth limits in calculating account liquidity. + * Note that `cTokenBalance` is the number of cTokens the account owns in the market, + * whereas `borrowBalance` is the amount of underlying that the account has borrowed. + */ + struct AccountLiquidityLocalVars { + uint sumCollateral; + uint sumBorrowPlusEffects; + uint cTokenBalance; + uint borrowBalance; + uint exchangeRateMantissa; + uint oraclePriceMantissa; + Exp collateralFactor; + Exp exchangeRate; + Exp oraclePrice; + Exp tokensToDenom; + } + + /** + * @notice Determine the current account liquidity wrt collateral requirements + * @return (possible error code (semi-opaque), + account liquidity in excess of collateral requirements, + * account shortfall below collateral requirements) + */ + function getAccountLiquidity(address account) public view returns (uint, uint, uint) { + (Error err, uint liquidity, uint shortfall) = getHypotheticalAccountLiquidityInternal(account, CToken(0), 0, 0); + + return (uint(err), liquidity, shortfall); + } + + /** + * @notice Determine the current account liquidity wrt collateral requirements + * @return (possible error code, + account liquidity in excess of collateral requirements, + * account shortfall below collateral requirements) + */ + function getAccountLiquidityInternal(address account) internal view returns (Error, uint, uint) { + return getHypotheticalAccountLiquidityInternal(account, CToken(0), 0, 0); + } + + /** + * @notice Determine what the account liquidity would be if the given amounts were redeemed/borrowed + * @param cTokenModify The market to hypothetically redeem/borrow in + * @param account The account to determine liquidity for + * @param redeemTokens The number of tokens to hypothetically redeem + * @param borrowAmount The amount of underlying to hypothetically borrow + * @return (possible error code (semi-opaque), + hypothetical account liquidity in excess of collateral requirements, + * hypothetical account shortfall below collateral requirements) + */ + function getHypotheticalAccountLiquidity( + address account, + address cTokenModify, + uint redeemTokens, + uint borrowAmount) public view returns (uint, uint, uint) { + (Error err, uint liquidity, uint shortfall) = getHypotheticalAccountLiquidityInternal(account, CToken(cTokenModify), redeemTokens, borrowAmount); + return (uint(err), liquidity, shortfall); + } + + /** + * @notice Determine what the account liquidity would be if the given amounts were redeemed/borrowed + * @param cTokenModify The market to hypothetically redeem/borrow in + * @param account The account to determine liquidity for + * @param redeemTokens The number of tokens to hypothetically redeem + * @param borrowAmount The amount of underlying to hypothetically borrow + * @dev Note that we calculate the exchangeRateStored for each collateral cToken using stored data, + * without calculating accumulated interest. + * @return (possible error code, + hypothetical account liquidity in excess of collateral requirements, + * hypothetical account shortfall below collateral requirements) + */ + function getHypotheticalAccountLiquidityInternal( + address account, + CToken cTokenModify, + uint redeemTokens, + uint borrowAmount) internal view returns (Error, uint, uint) { + + AccountLiquidityLocalVars memory vars; // Holds all our calculation results + uint oErr; + MathError mErr; + + // For each asset the account is in + CToken[] memory assets = accountAssets[account]; + for (uint i = 0; i < assets.length; i++) { + CToken asset = assets[i]; + + // Read the balances and exchange rate from the cToken + (oErr, vars.cTokenBalance, vars.borrowBalance, vars.exchangeRateMantissa) = asset.getAccountSnapshot(account); + if (oErr != 0) { // semi-opaque error code, we assume NO_ERROR == 0 is invariant between upgrades + return (Error.SNAPSHOT_ERROR, 0, 0); + } + vars.collateralFactor = Exp({mantissa: markets[address(asset)].collateralFactorMantissa}); + vars.exchangeRate = Exp({mantissa: vars.exchangeRateMantissa}); + + // Get the normalized price of the asset + vars.oraclePriceMantissa = oracle.getUnderlyingPrice(asset); + if (vars.oraclePriceMantissa == 0) { + return (Error.PRICE_ERROR, 0, 0); + } + vars.oraclePrice = Exp({mantissa: vars.oraclePriceMantissa}); + + // Pre-compute a conversion factor from tokens -> ether (normalized price value) + (mErr, vars.tokensToDenom) = mulExp3(vars.collateralFactor, vars.exchangeRate, vars.oraclePrice); + if (mErr != MathError.NO_ERROR) { + return (Error.MATH_ERROR, 0, 0); + } + + // sumCollateral += tokensToDenom * cTokenBalance + (mErr, vars.sumCollateral) = mulScalarTruncateAddUInt(vars.tokensToDenom, vars.cTokenBalance, vars.sumCollateral); + if (mErr != MathError.NO_ERROR) { + return (Error.MATH_ERROR, 0, 0); + } + + // sumBorrowPlusEffects += oraclePrice * borrowBalance + (mErr, vars.sumBorrowPlusEffects) = mulScalarTruncateAddUInt(vars.oraclePrice, vars.borrowBalance, vars.sumBorrowPlusEffects); + if (mErr != MathError.NO_ERROR) { + return (Error.MATH_ERROR, 0, 0); + } + + // Calculate effects of interacting with cTokenModify + if (asset == cTokenModify) { + // redeem effect + // sumBorrowPlusEffects += tokensToDenom * redeemTokens + (mErr, vars.sumBorrowPlusEffects) = mulScalarTruncateAddUInt(vars.tokensToDenom, redeemTokens, vars.sumBorrowPlusEffects); + if (mErr != MathError.NO_ERROR) { + return (Error.MATH_ERROR, 0, 0); + } + + // borrow effect + // sumBorrowPlusEffects += oraclePrice * borrowAmount + (mErr, vars.sumBorrowPlusEffects) = mulScalarTruncateAddUInt(vars.oraclePrice, borrowAmount, vars.sumBorrowPlusEffects); + if (mErr != MathError.NO_ERROR) { + return (Error.MATH_ERROR, 0, 0); + } + } + } + + // These are safe, as the underflow condition is checked first + if (vars.sumCollateral > vars.sumBorrowPlusEffects) { + return (Error.NO_ERROR, vars.sumCollateral - vars.sumBorrowPlusEffects, 0); + } else { + return (Error.NO_ERROR, 0, vars.sumBorrowPlusEffects - vars.sumCollateral); + } + } + + /** + * @notice Calculate number of tokens of collateral asset to seize given an underlying amount + * @dev Used in liquidation (called in cToken.liquidateBorrowFresh) + * @param cTokenBorrowed The address of the borrowed cToken + * @param cTokenCollateral The address of the collateral cToken + * @param actualRepayAmount The amount of cTokenBorrowed underlying to convert into cTokenCollateral tokens + * @return (errorCode, number of cTokenCollateral tokens to be seized in a liquidation) + */ + function liquidateCalculateSeizeTokens(address cTokenBorrowed, address cTokenCollateral, uint actualRepayAmount) external view returns (uint, uint) { + /* Read oracle prices for borrowed and collateral markets */ + uint priceBorrowedMantissa = oracle.getUnderlyingPrice(CToken(cTokenBorrowed)); + uint priceCollateralMantissa = oracle.getUnderlyingPrice(CToken(cTokenCollateral)); + if (priceBorrowedMantissa == 0 || priceCollateralMantissa == 0) { + return (uint(Error.PRICE_ERROR), 0); + } + + /* + * Get the exchange rate and calculate the number of collateral tokens to seize: + * seizeAmount = actualRepayAmount * liquidationIncentive * priceBorrowed / priceCollateral + * seizeTokens = seizeAmount / exchangeRate + * = actualRepayAmount * (liquidationIncentive * priceBorrowed) / (priceCollateral * exchangeRate) + */ + uint exchangeRateMantissa = CToken(cTokenCollateral).exchangeRateStored(); // Note: reverts on error + uint seizeTokens; + Exp memory numerator; + Exp memory denominator; + Exp memory ratio; + MathError mathErr; + + (mathErr, numerator) = mulExp(liquidationIncentiveMantissa, priceBorrowedMantissa); + if (mathErr != MathError.NO_ERROR) { + return (uint(Error.MATH_ERROR), 0); + } + + (mathErr, denominator) = mulExp(priceCollateralMantissa, exchangeRateMantissa); + if (mathErr != MathError.NO_ERROR) { + return (uint(Error.MATH_ERROR), 0); + } + + (mathErr, ratio) = divExp(numerator, denominator); + if (mathErr != MathError.NO_ERROR) { + return (uint(Error.MATH_ERROR), 0); + } + + (mathErr, seizeTokens) = mulScalarTruncate(ratio, actualRepayAmount); + if (mathErr != MathError.NO_ERROR) { + return (uint(Error.MATH_ERROR), 0); + } + + return (uint(Error.NO_ERROR), seizeTokens); + } + + /*** Admin Functions ***/ + + /** + * @notice Sets a new price oracle for the comptroller + * @dev Admin function to set a new price oracle + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function _setPriceOracle(PriceOracle newOracle) public returns (uint) { + // Check caller is admin + if (msg.sender != admin) { + return fail(Error.UNAUTHORIZED, FailureInfo.SET_PRICE_ORACLE_OWNER_CHECK); + } + + // Track the old oracle for the comptroller + PriceOracle oldOracle = oracle; + + // Set comptroller's oracle to newOracle + oracle = newOracle; + + // Emit NewPriceOracle(oldOracle, newOracle) + emit NewPriceOracle(oldOracle, newOracle); + + return uint(Error.NO_ERROR); + } + + /** + * @notice Sets the closeFactor used when liquidating borrows + * @dev Admin function to set closeFactor + * @param newCloseFactorMantissa New close factor, scaled by 1e18 + * @return uint 0=success, otherwise a failure. (See ErrorReporter for details) + */ + function _setCloseFactor(uint newCloseFactorMantissa) external returns (uint) { + // Check caller is admin + if (msg.sender != admin) { + return fail(Error.UNAUTHORIZED, FailureInfo.SET_CLOSE_FACTOR_OWNER_CHECK); + } + + Exp memory newCloseFactorExp = Exp({mantissa: newCloseFactorMantissa}); + Exp memory lowLimit = Exp({mantissa: closeFactorMinMantissa}); + if (lessThanOrEqualExp(newCloseFactorExp, lowLimit)) { + return fail(Error.INVALID_CLOSE_FACTOR, FailureInfo.SET_CLOSE_FACTOR_VALIDATION); + } + + Exp memory highLimit = Exp({mantissa: closeFactorMaxMantissa}); + if (lessThanExp(highLimit, newCloseFactorExp)) { + return fail(Error.INVALID_CLOSE_FACTOR, FailureInfo.SET_CLOSE_FACTOR_VALIDATION); + } + + uint oldCloseFactorMantissa = closeFactorMantissa; + closeFactorMantissa = newCloseFactorMantissa; + emit NewCloseFactor(oldCloseFactorMantissa, closeFactorMantissa); + + return uint(Error.NO_ERROR); + } + + /** + * @notice Sets the collateralFactor for a market + * @dev Admin function to set per-market collateralFactor + * @param cToken The market to set the factor on + * @param newCollateralFactorMantissa The new collateral factor, scaled by 1e18 + * @return uint 0=success, otherwise a failure. (See ErrorReporter for details) + */ + function _setCollateralFactor(CToken cToken, uint newCollateralFactorMantissa) external returns (uint) { + // Check caller is admin + if (msg.sender != admin) { + return fail(Error.UNAUTHORIZED, FailureInfo.SET_COLLATERAL_FACTOR_OWNER_CHECK); + } + + // Verify market is listed + Market storage market = markets[address(cToken)]; + if (!market.isListed) { + return fail(Error.MARKET_NOT_LISTED, FailureInfo.SET_COLLATERAL_FACTOR_NO_EXISTS); + } + + Exp memory newCollateralFactorExp = Exp({mantissa: newCollateralFactorMantissa}); + + // Check collateral factor <= 0.9 + Exp memory highLimit = Exp({mantissa: collateralFactorMaxMantissa}); + if (lessThanExp(highLimit, newCollateralFactorExp)) { + return fail(Error.INVALID_COLLATERAL_FACTOR, FailureInfo.SET_COLLATERAL_FACTOR_VALIDATION); + } + + // If collateral factor != 0, fail if price == 0 + if (newCollateralFactorMantissa != 0 && oracle.getUnderlyingPrice(cToken) == 0) { + return fail(Error.PRICE_ERROR, FailureInfo.SET_COLLATERAL_FACTOR_WITHOUT_PRICE); + } + + // Set market's collateral factor to new collateral factor, remember old value + uint oldCollateralFactorMantissa = market.collateralFactorMantissa; + market.collateralFactorMantissa = newCollateralFactorMantissa; + + // Emit event with asset, old collateral factor, and new collateral factor + emit NewCollateralFactor(cToken, oldCollateralFactorMantissa, newCollateralFactorMantissa); + + return uint(Error.NO_ERROR); + } + + /** + * @notice Sets maxAssets which controls how many markets can be entered + * @dev Admin function to set maxAssets + * @param newMaxAssets New max assets + * @return uint 0=success, otherwise a failure. (See ErrorReporter for details) + */ + function _setMaxAssets(uint newMaxAssets) external returns (uint) { + // Check caller is admin + if (msg.sender != admin) { + return fail(Error.UNAUTHORIZED, FailureInfo.SET_MAX_ASSETS_OWNER_CHECK); + } + + uint oldMaxAssets = maxAssets; + maxAssets = newMaxAssets; + emit NewMaxAssets(oldMaxAssets, newMaxAssets); + + return uint(Error.NO_ERROR); + } + + /** + * @notice Sets liquidationIncentive + * @dev Admin function to set liquidationIncentive + * @param newLiquidationIncentiveMantissa New liquidationIncentive scaled by 1e18 + * @return uint 0=success, otherwise a failure. (See ErrorReporter for details) + */ + function _setLiquidationIncentive(uint newLiquidationIncentiveMantissa) external returns (uint) { + // Check caller is admin + if (msg.sender != admin) { + return fail(Error.UNAUTHORIZED, FailureInfo.SET_LIQUIDATION_INCENTIVE_OWNER_CHECK); + } + + // Check de-scaled min <= newLiquidationIncentive <= max + Exp memory newLiquidationIncentive = Exp({mantissa: newLiquidationIncentiveMantissa}); + Exp memory minLiquidationIncentive = Exp({mantissa: liquidationIncentiveMinMantissa}); + if (lessThanExp(newLiquidationIncentive, minLiquidationIncentive)) { + return fail(Error.INVALID_LIQUIDATION_INCENTIVE, FailureInfo.SET_LIQUIDATION_INCENTIVE_VALIDATION); + } + + Exp memory maxLiquidationIncentive = Exp({mantissa: liquidationIncentiveMaxMantissa}); + if (lessThanExp(maxLiquidationIncentive, newLiquidationIncentive)) { + return fail(Error.INVALID_LIQUIDATION_INCENTIVE, FailureInfo.SET_LIQUIDATION_INCENTIVE_VALIDATION); + } + + // Save current value for use in log + uint oldLiquidationIncentiveMantissa = liquidationIncentiveMantissa; + + // Set liquidation incentive to new incentive + liquidationIncentiveMantissa = newLiquidationIncentiveMantissa; + + // Emit event with old incentive, new incentive + emit NewLiquidationIncentive(oldLiquidationIncentiveMantissa, newLiquidationIncentiveMantissa); + + return uint(Error.NO_ERROR); + } + + /** + * @notice Add the market to the markets mapping and set it as listed + * @dev Admin function to set isListed and add support for the market + * @param cToken The address of the market (token) to list + * @return uint 0=success, otherwise a failure. (See enum Error for details) + */ + function _supportMarket(CToken cToken) external returns (uint) { + if (msg.sender != admin) { + return fail(Error.UNAUTHORIZED, FailureInfo.SUPPORT_MARKET_OWNER_CHECK); + } + + if (markets[address(cToken)].isListed) { + return fail(Error.MARKET_ALREADY_LISTED, FailureInfo.SUPPORT_MARKET_EXISTS); + } + + cToken.isCToken(); // Sanity check to make sure its really a CToken + + markets[address(cToken)] = Market({isListed: true, isComped: false, collateralFactorMantissa: 0}); + + _addMarketInternal(address(cToken)); + + emit MarketListed(cToken); + + return uint(Error.NO_ERROR); + } + + function _addMarketInternal(address cToken) internal { + for (uint i = 0; i < allMarkets.length; i ++) { + require(allMarkets[i] != CToken(cToken), "market already added"); + } + allMarkets.push(CToken(cToken)); + } + + /** + * @notice Admin function to change the Pause Guardian + * @param newPauseGuardian The address of the new Pause Guardian + * @return uint 0=success, otherwise a failure. (See enum Error for details) + */ + function _setPauseGuardian(address newPauseGuardian) public returns (uint) { + if (msg.sender != admin) { + return fail(Error.UNAUTHORIZED, FailureInfo.SET_PAUSE_GUARDIAN_OWNER_CHECK); + } + + // Save current value for inclusion in log + address oldPauseGuardian = pauseGuardian; + + // Store pauseGuardian with value newPauseGuardian + pauseGuardian = newPauseGuardian; + + // Emit NewPauseGuardian(OldPauseGuardian, NewPauseGuardian) + emit NewPauseGuardian(oldPauseGuardian, pauseGuardian); + + return uint(Error.NO_ERROR); + } + + function _setMintPaused(CToken cToken, bool state) public returns (bool) { + require(markets[address(cToken)].isListed, "cannot pause a market that is not listed"); + require(msg.sender == pauseGuardian || msg.sender == admin, "only pause guardian and admin can pause"); + require(msg.sender == admin || state == true, "only admin can unpause"); + + mintGuardianPaused[address(cToken)] = state; + emit ActionPaused(cToken, "Mint", state); + return state; + } + + function _setBorrowPaused(CToken cToken, bool state) public returns (bool) { + require(markets[address(cToken)].isListed, "cannot pause a market that is not listed"); + require(msg.sender == pauseGuardian || msg.sender == admin, "only pause guardian and admin can pause"); + require(msg.sender == admin || state == true, "only admin can unpause"); + + borrowGuardianPaused[address(cToken)] = state; + emit ActionPaused(cToken, "Borrow", state); + return state; + } + + function _setTransferPaused(bool state) public returns (bool) { + require(msg.sender == pauseGuardian || msg.sender == admin, "only pause guardian and admin can pause"); + require(msg.sender == admin || state == true, "only admin can unpause"); + + transferGuardianPaused = state; + emit ActionPaused("Transfer", state); + return state; + } + + function _setSeizePaused(bool state) public returns (bool) { + require(msg.sender == pauseGuardian || msg.sender == admin, "only pause guardian and admin can pause"); + require(msg.sender == admin || state == true, "only admin can unpause"); + + seizeGuardianPaused = state; + emit ActionPaused("Seize", state); + return state; + } + + function _become(Unitroller unitroller,address compAddress_, uint compRate_, address[] memory compMarketsToAdd, address[] memory otherMarketsToAdd) public { + require(msg.sender == unitroller.admin(), "only unitroller admin can change brains"); + require(unitroller._acceptImplementation() == 0, "change not authorized"); + + Comptroller(address(unitroller))._becomeG3(compAddress_, compRate_, compMarketsToAdd, otherMarketsToAdd); + } + + function _becomeG3(address compAddress_, uint compRate_, address[] memory compMarketsToAdd, address[] memory otherMarketsToAdd) public { + require(msg.sender == comptrollerImplementation, "only brains can become itself"); + compAddress=compAddress_; + for (uint i = 0; i < compMarketsToAdd.length; i++) { + _addMarketInternal(address(compMarketsToAdd[i])); + } + + for (uint i = 0; i < otherMarketsToAdd.length; i++) { + _addMarketInternal(address(otherMarketsToAdd[i])); + } + + _setCompRate(compRate_); + _addCompMarkets(compMarketsToAdd); + } + + /** + * @notice Checks caller is admin, or this contract is becoming the new implementation + */ + function adminOrInitializing() internal view returns (bool) { + return msg.sender == admin || msg.sender == comptrollerImplementation; + } + + /*** Comp Distribution ***/ + + /** + * @notice Recalculate and update COMP speeds for all COMP markets + */ + function refreshCompSpeeds() public { + CToken[] memory allMarkets_ = allMarkets; + + for (uint i = 0; i < allMarkets_.length; i++) { + CToken cToken = allMarkets_[i]; + Exp memory borrowIndex = Exp({mantissa: cToken.borrowIndex()}); + updateCompSupplyIndex(address(cToken)); + updateCompBorrowIndex(address(cToken), borrowIndex); + } + + Exp memory totalUtility = Exp({mantissa: 0}); + Exp[] memory utilities = new Exp[](allMarkets_.length); + for (uint i = 0; i < allMarkets_.length; i++) { + CToken cToken = allMarkets_[i]; + if (markets[address(cToken)].isComped) { + Exp memory assetPrice = Exp({mantissa: oracle.getUnderlyingPrice(cToken)}); + Exp memory interestPerBlock = mul_(Exp({mantissa: cToken.borrowRatePerBlock()}), cToken.totalBorrows()); + Exp memory utility = mul_(interestPerBlock, assetPrice); + utilities[i] = utility; + totalUtility = add_(totalUtility, utility); + } + } + + for (uint i = 0; i < allMarkets_.length; i++) { + CToken cToken = allMarkets[i]; + uint newSpeed = totalUtility.mantissa > 0 ? mul_(compRate, div_(utilities[i], totalUtility)) : 0; + compSpeeds[address(cToken)] = newSpeed; + emit CompSpeedUpdated(cToken, newSpeed); + } + } + + /** + * @notice Accrue COMP to the market by updating the supply index + * @param cToken The market whose supply index to update + */ + function updateCompSupplyIndex(address cToken) internal { + CompMarketState storage supplyState = compSupplyState[cToken]; + uint supplySpeed = compSpeeds[cToken]; + uint blockNumber = getBlockNumber(); + uint deltaBlocks = sub_(blockNumber, uint(supplyState.block)); + if (deltaBlocks > 0 && supplySpeed > 0) { + uint supplyTokens = CToken(cToken).totalSupply(); + uint compAccrued = mul_(deltaBlocks, supplySpeed); + Double memory ratio = supplyTokens > 0 ? fraction(compAccrued, supplyTokens) : Double({mantissa: 0}); + Double memory index = add_(Double({mantissa: supplyState.index}), ratio); + compSupplyState[cToken] = CompMarketState({ + index: safe224(index.mantissa, "new index exceeds 224 bits"), + block: safe32(blockNumber, "block number exceeds 32 bits") + }); + } else if (deltaBlocks > 0) { + supplyState.block = safe32(blockNumber, "block number exceeds 32 bits"); + } + } + + /** + * @notice Accrue COMP to the market by updating the borrow index + * @param cToken The market whose borrow index to update + */ + function updateCompBorrowIndex(address cToken, Exp memory marketBorrowIndex) internal { + CompMarketState storage borrowState = compBorrowState[cToken]; + uint borrowSpeed = compSpeeds[cToken]; + uint blockNumber = getBlockNumber(); + uint deltaBlocks = sub_(blockNumber, uint(borrowState.block)); + if (deltaBlocks > 0 && borrowSpeed > 0) { + uint borrowAmount = div_(CToken(cToken).totalBorrows(), marketBorrowIndex); + uint compAccrued = mul_(deltaBlocks, borrowSpeed); + Double memory ratio = borrowAmount > 0 ? fraction(compAccrued, borrowAmount) : Double({mantissa: 0}); + Double memory index = add_(Double({mantissa: borrowState.index}), ratio); + compBorrowState[cToken] = CompMarketState({ + index: safe224(index.mantissa, "new index exceeds 224 bits"), + block: safe32(blockNumber, "block number exceeds 32 bits") + }); + } else if (deltaBlocks > 0) { + borrowState.block = safe32(blockNumber, "block number exceeds 32 bits"); + } + } + + /** + * @notice Calculate COMP accrued by a supplier and possibly transfer it to them + * @param cToken The market in which the supplier is interacting + * @param supplier The address of the supplier to distribute COMP to + */ + function distributeSupplierComp(address cToken, address supplier, bool distributeAll) internal { + CompMarketState storage supplyState = compSupplyState[cToken]; + Double memory supplyIndex = Double({mantissa: supplyState.index}); + Double memory supplierIndex = Double({mantissa: compSupplierIndex[cToken][supplier]}); + compSupplierIndex[cToken][supplier] = supplyIndex.mantissa; + + if (supplierIndex.mantissa == 0 && supplyIndex.mantissa > 0) { + supplierIndex.mantissa = compInitialIndex; + } + + Double memory deltaIndex = sub_(supplyIndex, supplierIndex); + uint supplierTokens = CToken(cToken).balanceOf(supplier); + uint supplierDelta = mul_(supplierTokens, deltaIndex); + uint supplierAccrued = add_(compAccrued[supplier], supplierDelta); + compAccrued[supplier] = transferComp(supplier, supplierAccrued, distributeAll ? 0 : compClaimThreshold); + emit DistributedSupplierComp(CToken(cToken), supplier, supplierDelta, supplyIndex.mantissa); + } + + /** + * @notice Calculate COMP accrued by a borrower and possibly transfer it to them + * @dev Borrowers will not begin to accrue until after the first interaction with the protocol. + * @param cToken The market in which the borrower is interacting + * @param borrower The address of the borrower to distribute COMP to + */ + function distributeBorrowerComp(address cToken, address borrower, Exp memory marketBorrowIndex, bool distributeAll) internal { + CompMarketState storage borrowState = compBorrowState[cToken]; + Double memory borrowIndex = Double({mantissa: borrowState.index}); + Double memory borrowerIndex = Double({mantissa: compBorrowerIndex[cToken][borrower]}); + compBorrowerIndex[cToken][borrower] = borrowIndex.mantissa; + + if (borrowerIndex.mantissa > 0) { + Double memory deltaIndex = sub_(borrowIndex, borrowerIndex); + uint borrowerAmount = div_(CToken(cToken).borrowBalanceStored(borrower), marketBorrowIndex); + uint borrowerDelta = mul_(borrowerAmount, deltaIndex); + uint borrowerAccrued = add_(compAccrued[borrower], borrowerDelta); + compAccrued[borrower] = transferComp(borrower, borrowerAccrued, distributeAll ? 0 : compClaimThreshold); + emit DistributedBorrowerComp(CToken(cToken), borrower, borrowerDelta, borrowIndex.mantissa); + } + } + + /** + * @notice Transfer COMP to the user, if they are above the threshold + * @dev Note: If there is not enough COMP, we do not perform the transfer all. + * @param user The address of the user to transfer COMP to + * @param userAccrued The amount of COMP to (possibly) transfer + * @return The amount of COMP which was NOT transferred to the user + */ + function transferComp(address user, uint userAccrued, uint threshold) internal returns (uint) { + if (userAccrued >= threshold && userAccrued > 0) { + Comp comp = Comp(getCompAddress()); + uint compRemaining = comp.balanceOf(address(this)); + if (userAccrued <= compRemaining) { + comp.transfer(user, userAccrued); + return 0; + } + } + return userAccrued; + } + + /** + * @notice Claim all the comp accrued by holder in all markets + * @param holder The address to claim COMP for + */ + function claimComp(address holder) public { + return claimComp(holder, allMarkets); + } + + /** + * @notice Claim all the comp accrued by holder in the specified markets + * @param holder The address to claim COMP for + * @param cTokens The list of markets to claim COMP in + */ + function claimComp(address holder, CToken[] memory cTokens) public { + address[] memory holders = new address[](1); + holders[0] = holder; + claimComp(holders, cTokens, true, true); + } + + /** + * @notice Claim all comp accrued by the holders + * @param holders The addresses to claim COMP for + * @param cTokens The list of markets to claim COMP in + * @param borrowers Whether or not to claim COMP earned by borrowing + * @param suppliers Whether or not to claim COMP earned by supplying + */ + function claimComp(address[] memory holders, CToken[] memory cTokens, bool borrowers, bool suppliers) public { + for (uint i = 0; i < cTokens.length; i++) { + CToken cToken = cTokens[i]; + require(markets[address(cToken)].isListed, "market must be listed"); + if (borrowers == true) { + Exp memory borrowIndex = Exp({mantissa: cToken.borrowIndex()}); + updateCompBorrowIndex(address(cToken), borrowIndex); + for (uint j = 0; j < holders.length; j++) { + distributeBorrowerComp(address(cToken), holders[j], borrowIndex, true); + } + } + if (suppliers == true) { + updateCompSupplyIndex(address(cToken)); + for (uint j = 0; j < holders.length; j++) { + distributeSupplierComp(address(cToken), holders[j], true); + } + } + } + } + + /*** Comp Distribution Admin ***/ + + /** + * @notice Set the amount of COMP distributed per block + * @param compRate_ The amount of COMP wei per block to distribute + */ + function _setCompRate(uint compRate_) public { + require(adminOrInitializing(), "only admin can change comp rate"); + + uint oldRate = compRate; + compRate = compRate_; + emit NewCompRate(oldRate, compRate_); + + refreshCompSpeeds(); + } + + /** + * @notice Add markets to compMarkets, allowing them to earn COMP in the flywheel + * @param cTokens The addresses of the markets to add + */ + function _addCompMarkets(address[] memory cTokens) public { + require(adminOrInitializing(), "only admin can add comp market"); + + for (uint i = 0; i < cTokens.length; i++) { + _addCompMarketInternal(cTokens[i]); + } + + refreshCompSpeeds(); + } + + function _addCompMarketInternal(address cToken) internal { + Market storage market = markets[cToken]; + require(market.isListed == true, "comp market is not listed"); + require(market.isComped == false, "comp market already added"); + + market.isComped = true; + emit MarketComped(CToken(cToken), true); + + if (compSupplyState[cToken].index == 0 && compSupplyState[cToken].block == 0) { + compSupplyState[cToken] = CompMarketState({ + index: compInitialIndex, + block: safe32(getBlockNumber(), "block number exceeds 32 bits") + }); + } + + if (compBorrowState[cToken].index == 0 && compBorrowState[cToken].block == 0) { + compBorrowState[cToken] = CompMarketState({ + index: compInitialIndex, + block: safe32(getBlockNumber(), "block number exceeds 32 bits") + }); + } + } + + /** + * @notice Remove a market from compMarkets, preventing it from earning COMP in the flywheel + * @param cToken The address of the market to drop + */ + function _dropCompMarket(address cToken) public { + require(msg.sender == admin, "only admin can drop comp market"); + + Market storage market = markets[cToken]; + require(market.isComped == true, "market is not a comp market"); + + market.isComped = false; + emit MarketComped(CToken(cToken), false); + + refreshCompSpeeds(); + } + + /** + * @notice Return all of the markets + * @dev The automatic getter may be used to access an individual market. + * @return The list of market addresses + */ + function getAllMarkets() public view returns (CToken[] memory) { + return allMarkets; + } + + function getBlockNumber() public view returns (uint) { + return block.number; + } + + /** + * @notice Return the address of the COMP token + * @return The address of COMP + */ +// function getCompAddress() public view returns (address) { +// return 0x310bd687f46b32393a9a3b3a492e7ac121a3cef1; +// } + function getCompAddress() public view returns (address) { + return compAddress; + } +} diff --git a/contracts/ComptrollerStorage.sol b/contracts/ComptrollerStorage.sol new file mode 100644 index 0000000..0b15c51 --- /dev/null +++ b/contracts/ComptrollerStorage.sol @@ -0,0 +1,130 @@ +pragma solidity ^0.5.12; + +import "./CToken.sol"; +import "./PriceOracle.sol"; + +contract UnitrollerAdminStorage { + /** + * @notice Administrator for this contract + */ + address public admin; + + /** + * @notice Pending administrator for this contract + */ + address public pendingAdmin; + + /** + * @notice Active brains of Unitroller + */ + address public comptrollerImplementation; + + /** + * @notice Pending brains of Unitroller + */ + address public pendingComptrollerImplementation; +} + +contract ComptrollerV1Storage is UnitrollerAdminStorage { + + /** + * @notice Oracle which gives the price of any given asset + */ + PriceOracle public oracle; + + /** + * @notice Multiplier used to calculate the maximum repayAmount when liquidating a borrow + */ + uint public closeFactorMantissa; + + /** + * @notice Multiplier representing the discount on collateral that a liquidator receives + */ + uint public liquidationIncentiveMantissa; + + /** + * @notice Max number of assets a single account can participate in (borrow or use as collateral) + */ + uint public maxAssets; + + /** + * @notice Per-account mapping of "assets you are in", capped by maxAssets + */ + mapping(address => CToken[]) public accountAssets; + +} + +contract ComptrollerV2Storage is ComptrollerV1Storage { + struct Market { + /// @notice Whether or not this market is listed + bool isListed; + + /** + * @notice Multiplier representing the most one can borrow against their collateral in this market. + * For instance, 0.9 to allow borrowing 90% of collateral value. + * Must be between 0 and 1, and stored as a mantissa. + */ + uint collateralFactorMantissa; + + /// @notice Per-market mapping of "accounts in this asset" + mapping(address => bool) accountMembership; + + /// @notice Whether or not this market receives COMP + bool isComped; + } + + /** + * @notice Official mapping of cTokens -> Market metadata + * @dev Used e.g. to determine if a market is supported + */ + mapping(address => Market) public markets; + + + /** + * @notice The Pause Guardian can pause certain actions as a safety mechanism. + * Actions which allow users to remove their own assets cannot be paused. + * Liquidation / seizing / transfer can only be paused globally, not by market. + */ + address public pauseGuardian; + bool public _mintGuardianPaused; + bool public _borrowGuardianPaused; + bool public transferGuardianPaused; + bool public seizeGuardianPaused; + mapping(address => bool) public mintGuardianPaused; + mapping(address => bool) public borrowGuardianPaused; +} + +contract ComptrollerV3Storage is ComptrollerV2Storage { + struct CompMarketState { + /// @notice The market's last updated compBorrowIndex or compSupplyIndex + uint224 index; + + /// @notice The block number the index was last updated at + uint32 block; + } + + /// @notice A list of all markets + CToken[] public allMarkets; + + /// @notice The rate at which the flywheel distributes COMP, per block + uint public compRate; + /// @notice + address internal compAddress; + /// @notice The portion of compRate that each market currently receives + mapping(address => uint) public compSpeeds; + + /// @notice The COMP market supply state for each market + mapping(address => CompMarketState) public compSupplyState; + + /// @notice The COMP market borrow state for each market + mapping(address => CompMarketState) public compBorrowState; + + /// @notice The COMP borrow index for each market for each supplier as of the last time they accrued COMP + mapping(address => mapping(address => uint)) public compSupplierIndex; + + /// @notice The COMP borrow index for each market for each borrower as of the last time they accrued COMP + mapping(address => mapping(address => uint)) public compBorrowerIndex; + + /// @notice The COMP accrued but not yet transferred to each user + mapping(address => uint) public compAccrued; +} diff --git a/contracts/DAIInterestRateModelV2.sol b/contracts/DAIInterestRateModelV2.sol new file mode 100644 index 0000000..4225f39 --- /dev/null +++ b/contracts/DAIInterestRateModelV2.sol @@ -0,0 +1,118 @@ +pragma solidity ^0.5.12; + +import "./JumpRateModel.sol"; +import "./SafeMath.sol"; + +/** + * @title Compound's DAIInterestRateModel Contract (version 2) + * @author Compound (modified by Dharma Labs) + * @notice The parameterized model described in section 2.4 of the original Compound Protocol whitepaper. + * Version 2 modifies the original interest rate model by increasing the "gap" or slope of the model prior + * to the "kink" from 0.05% to 2% with the goal of "smoothing out" interest rate changes as the utilization + * rate increases. + */ +contract DAIInterestRateModelV2 is JumpRateModel { + using SafeMath for uint; + + /** + * @notice The additional margin per block separating the base borrow rate from the roof (2% / block). + * Note that this value has been increased from the original value of 0.05% per block. + */ + uint public constant gapPerBlock = 2e16 / blocksPerYear; + + /** + * @notice The assumed (1 - reserve factor) used to calculate the minimum borrow rate (reserve factor = 0.05) + */ + uint public constant assumedOneMinusReserveFactorMantissa = 0.95e18; + + PotLike pot; + JugLike jug; + + /** + * @notice Construct an interest rate model + * @param jumpMultiplierPerYear The multiplierPerBlock after hitting a specified utilization point + * @param kink_ The utilization point at which the jump multiplier is applied + * @param pot_ The address of the Dai pot (where DSR is earned) + * @param jug_ The address of the Dai jug (where SF is kept) + */ + constructor(uint jumpMultiplierPerYear, uint kink_, address pot_, address jug_) JumpRateModel(0, 0, jumpMultiplierPerYear, kink_) public { + pot = PotLike(pot_); + jug = JugLike(jug_); + poke(); + } + + /** + * @notice Calculates the current supply interest rate per block including the Dai savings rate + * @param cash The total amount of cash the market has + * @param borrows The total amount of borrows the market has outstanding + * @param reserves The total amnount of reserves the market has + * @param reserveFactorMantissa The current reserve factor the market has + * @return The supply rate per block (as a percentage, and scaled by 1e18) + */ + function getSupplyRate(uint cash, uint borrows, uint reserves, uint reserveFactorMantissa) public view returns (uint) { + uint protocolRate = super.getSupplyRate(cash, borrows, reserves, reserveFactorMantissa); + + uint underlying = cash.add(borrows).sub(reserves); + if (underlying == 0) { + return protocolRate; + } else { + uint cashRate = cash.mul(dsrPerBlock()).div(underlying); + return cashRate.add(protocolRate); + } + } + + /** + * @notice Calculates the Dai savings rate per block + * @return The Dai savings rate per block (as a percentage, and scaled by 1e18) + */ + function dsrPerBlock() public view returns (uint) { + return pot + .dsr().sub(1e27) // scaled 1e27 aka RAY, and includes an extra "ONE" before subraction + .div(1e9) // descale to 1e18 + .mul(15); // 15 seconds per block + } + + /** + * @notice Resets the baseRate and multiplier per block based on the stability fee and Dai savings rate + */ + function poke() public { + (uint duty, ) = jug.ilks("ETH-A"); + uint stabilityFeePerBlock = duty.add(jug.base()).sub(1e27).mul(1e18).div(1e27).mul(15); + + // We ensure the minimum borrow rate >= DSR / (1 - reserve factor) + baseRatePerBlock = dsrPerBlock().mul(1e18).div(assumedOneMinusReserveFactorMantissa); + + // The roof borrow rate is max(base rate, stability fee) + gap, from which we derive the slope + if (baseRatePerBlock < stabilityFeePerBlock) { + multiplierPerBlock = stabilityFeePerBlock.sub(baseRatePerBlock).add(gapPerBlock).mul(1e18).div(kink); + } else { + multiplierPerBlock = gapPerBlock.mul(1e18).div(kink); + } + + emit NewInterestParams(baseRatePerBlock, multiplierPerBlock, jumpMultiplierPerBlock, kink); + } +} + + +/*** Maker Interfaces ***/ + +contract PotLike { + function chi() external view returns (uint); + function dsr() external view returns (uint); + function rho() external view returns (uint); + function pie(address) external view returns (uint); + function drip() external returns (uint); + function join(uint) external; + function exit(uint) external; +} + +contract JugLike { + // --- Data --- + struct Ilk { + uint256 duty; + uint256 rho; + } + + mapping (bytes32 => Ilk) public ilks; + uint256 public base; +} diff --git a/contracts/EIP20Interface.sol b/contracts/EIP20Interface.sol new file mode 100644 index 0000000..f0f8e69 --- /dev/null +++ b/contracts/EIP20Interface.sol @@ -0,0 +1,62 @@ +pragma solidity ^0.5.12; + +/** + * @title ERC 20 Token Standard Interface + * https://eips.ethereum.org/EIPS/eip-20 + */ +interface EIP20Interface { + function name() external view returns (string memory); + function symbol() external view returns (string memory); + function decimals() external view returns (uint8); + + /** + * @notice Get the total number of tokens in circulation + * @return The supply of tokens + */ + function totalSupply() external view returns (uint256); + + /** + * @notice Gets the balance of the specified address + * @param owner The address from which the balance will be retrieved + * @return The balance + */ + function balanceOf(address owner) external view returns (uint256 balance); + + /** + * @notice Transfer `amount` tokens from `msg.sender` to `dst` + * @param dst The address of the destination account + * @param amount The number of tokens to transfer + * @return Whether or not the transfer succeeded + */ + function transfer(address dst, uint256 amount) external returns (bool success); + + /** + * @notice Transfer `amount` tokens from `src` to `dst` + * @param src The address of the source account + * @param dst The address of the destination account + * @param amount The number of tokens to transfer + * @return Whether or not the transfer succeeded + */ + function transferFrom(address src, address dst, uint256 amount) external returns (bool success); + + /** + * @notice Approve `spender` to transfer up to `amount` from `src` + * @dev This will overwrite the approval amount for `spender` + * and is subject to issues noted [here](https://eips.ethereum.org/EIPS/eip-20#approve) + * @param spender The address of the account which may transfer tokens + * @param amount The number of tokens that are approved (-1 means infinite) + * @return Whether or not the approval succeeded + */ + function approve(address spender, uint256 amount) external returns (bool success); + + /** + * @notice Get the current allowance from `owner` for `spender` + * @param owner The address of the account which owns the tokens to be spent + * @param spender The address of the account which may transfer tokens + * @return The number of tokens allowed to be spent (-1 means infinite) + */ + function allowance(address owner, address spender) external view returns (uint256 remaining); + + event Transfer(address indexed from, address indexed to, uint256 amount); + event Approval(address indexed owner, address indexed spender, uint256 amount); +} diff --git a/contracts/EIP20NonStandardInterface.sol b/contracts/EIP20NonStandardInterface.sol new file mode 100644 index 0000000..3ff30d4 --- /dev/null +++ b/contracts/EIP20NonStandardInterface.sol @@ -0,0 +1,70 @@ +pragma solidity ^0.5.12; + +/** + * @title EIP20NonStandardInterface + * @dev Version of ERC20 with no return values for `transfer` and `transferFrom` + * See https://medium.com/coinmonks/missing-return-value-bug-at-least-130-tokens-affected-d67bf08521ca + */ +interface EIP20NonStandardInterface { + + /** + * @notice Get the total number of tokens in circulation + * @return The supply of tokens + */ + function totalSupply() external view returns (uint256); + + /** + * @notice Gets the balance of the specified address + * @param owner The address from which the balance will be retrieved + * @return The balance + */ + function balanceOf(address owner) external view returns (uint256 balance); + + /// + /// !!!!!!!!!!!!!! + /// !!! NOTICE !!! `transfer` does not return a value, in violation of the ERC-20 specification + /// !!!!!!!!!!!!!! + /// + + /** + * @notice Transfer `amount` tokens from `msg.sender` to `dst` + * @param dst The address of the destination account + * @param amount The number of tokens to transfer + */ + function transfer(address dst, uint256 amount) external; + + /// + /// !!!!!!!!!!!!!! + /// !!! NOTICE !!! `transferFrom` does not return a value, in violation of the ERC-20 specification + /// !!!!!!!!!!!!!! + /// + + /** + * @notice Transfer `amount` tokens from `src` to `dst` + * @param src The address of the source account + * @param dst The address of the destination account + * @param amount The number of tokens to transfer + */ + function transferFrom(address src, address dst, uint256 amount) external; + + /** + * @notice Approve `spender` to transfer up to `amount` from `src` + * @dev This will overwrite the approval amount for `spender` + * and is subject to issues noted [here](https://eips.ethereum.org/EIPS/eip-20#approve) + * @param spender The address of the account which may transfer tokens + * @param amount The number of tokens that are approved + * @return Whether or not the approval succeeded + */ + function approve(address spender, uint256 amount) external returns (bool success); + + /** + * @notice Get the current allowance from `owner` for `spender` + * @param owner The address of the account which owns the tokens to be spent + * @param spender The address of the account which may transfer tokens + * @return The number of tokens allowed to be spent + */ + function allowance(address owner, address spender) external view returns (uint256 remaining); + + event Transfer(address indexed from, address indexed to, uint256 amount); + event Approval(address indexed owner, address indexed spender, uint256 amount); +} diff --git a/contracts/ErrorReporter.sol b/contracts/ErrorReporter.sol new file mode 100644 index 0000000..5676d65 --- /dev/null +++ b/contracts/ErrorReporter.sol @@ -0,0 +1,207 @@ +pragma solidity ^0.5.12; + +contract ComptrollerErrorReporter { + enum Error { + NO_ERROR, + UNAUTHORIZED, + COMPTROLLER_MISMATCH, + INSUFFICIENT_SHORTFALL, + INSUFFICIENT_LIQUIDITY, + INVALID_CLOSE_FACTOR, + INVALID_COLLATERAL_FACTOR, + INVALID_LIQUIDATION_INCENTIVE, + MARKET_NOT_ENTERED, // no longer possible + MARKET_NOT_LISTED, + MARKET_ALREADY_LISTED, + MATH_ERROR, + NONZERO_BORROW_BALANCE, + PRICE_ERROR, + REJECTION, + SNAPSHOT_ERROR, + TOO_MANY_ASSETS, + TOO_MUCH_REPAY + } + + enum FailureInfo { + ACCEPT_ADMIN_PENDING_ADMIN_CHECK, + ACCEPT_PENDING_IMPLEMENTATION_ADDRESS_CHECK, + EXIT_MARKET_BALANCE_OWED, + EXIT_MARKET_REJECTION, + SET_CLOSE_FACTOR_OWNER_CHECK, + SET_CLOSE_FACTOR_VALIDATION, + SET_COLLATERAL_FACTOR_OWNER_CHECK, + SET_COLLATERAL_FACTOR_NO_EXISTS, + SET_COLLATERAL_FACTOR_VALIDATION, + SET_COLLATERAL_FACTOR_WITHOUT_PRICE, + SET_IMPLEMENTATION_OWNER_CHECK, + SET_LIQUIDATION_INCENTIVE_OWNER_CHECK, + SET_LIQUIDATION_INCENTIVE_VALIDATION, + SET_MAX_ASSETS_OWNER_CHECK, + SET_PENDING_ADMIN_OWNER_CHECK, + SET_PENDING_IMPLEMENTATION_OWNER_CHECK, + SET_PRICE_ORACLE_OWNER_CHECK, + SUPPORT_MARKET_EXISTS, + SUPPORT_MARKET_OWNER_CHECK, + SET_PAUSE_GUARDIAN_OWNER_CHECK + } + + /** + * @dev `error` corresponds to enum Error; `info` corresponds to enum FailureInfo, and `detail` is an arbitrary + * contract-specific code that enables us to report opaque error codes from upgradeable contracts. + **/ + event Failure(uint error, uint info, uint detail); + + /** + * @dev use this when reporting a known error from the money market or a non-upgradeable collaborator + */ + function fail(Error err, FailureInfo info) internal returns (uint) { + emit Failure(uint(err), uint(info), 0); + + return uint(err); + } + + /** + * @dev use this when reporting an opaque error from an upgradeable collaborator contract + */ + function failOpaque(Error err, FailureInfo info, uint opaqueError) internal returns (uint) { + emit Failure(uint(err), uint(info), opaqueError); + + return uint(err); + } +} + +contract TokenErrorReporter { + enum Error { + NO_ERROR, + UNAUTHORIZED, + BAD_INPUT, + COMPTROLLER_REJECTION, + COMPTROLLER_CALCULATION_ERROR, + INTEREST_RATE_MODEL_ERROR, + INVALID_ACCOUNT_PAIR, + INVALID_CLOSE_AMOUNT_REQUESTED, + INVALID_COLLATERAL_FACTOR, + MATH_ERROR, + MARKET_NOT_FRESH, + MARKET_NOT_LISTED, + TOKEN_INSUFFICIENT_ALLOWANCE, + TOKEN_INSUFFICIENT_BALANCE, + TOKEN_INSUFFICIENT_CASH, + TOKEN_TRANSFER_IN_FAILED, + TOKEN_TRANSFER_OUT_FAILED + } + + /* + * Note: FailureInfo (but not Error) is kept in alphabetical order + * This is because FailureInfo grows significantly faster, and + * the order of Error has some meaning, while the order of FailureInfo + * is entirely arbitrary. + */ + enum FailureInfo { + ACCEPT_ADMIN_PENDING_ADMIN_CHECK, + ACCRUE_INTEREST_ACCUMULATED_INTEREST_CALCULATION_FAILED, + ACCRUE_INTEREST_BORROW_RATE_CALCULATION_FAILED, + ACCRUE_INTEREST_NEW_BORROW_INDEX_CALCULATION_FAILED, + ACCRUE_INTEREST_NEW_TOTAL_BORROWS_CALCULATION_FAILED, + ACCRUE_INTEREST_NEW_TOTAL_RESERVES_CALCULATION_FAILED, + ACCRUE_INTEREST_SIMPLE_INTEREST_FACTOR_CALCULATION_FAILED, + BORROW_ACCUMULATED_BALANCE_CALCULATION_FAILED, + BORROW_ACCRUE_INTEREST_FAILED, + BORROW_CASH_NOT_AVAILABLE, + BORROW_FRESHNESS_CHECK, + BORROW_NEW_TOTAL_BALANCE_CALCULATION_FAILED, + BORROW_NEW_ACCOUNT_BORROW_BALANCE_CALCULATION_FAILED, + BORROW_MARKET_NOT_LISTED, + BORROW_COMPTROLLER_REJECTION, + LIQUIDATE_ACCRUE_BORROW_INTEREST_FAILED, + LIQUIDATE_ACCRUE_COLLATERAL_INTEREST_FAILED, + LIQUIDATE_COLLATERAL_FRESHNESS_CHECK, + LIQUIDATE_COMPTROLLER_REJECTION, + LIQUIDATE_COMPTROLLER_CALCULATE_AMOUNT_SEIZE_FAILED, + LIQUIDATE_CLOSE_AMOUNT_IS_UINT_MAX, + LIQUIDATE_CLOSE_AMOUNT_IS_ZERO, + LIQUIDATE_FRESHNESS_CHECK, + LIQUIDATE_LIQUIDATOR_IS_BORROWER, + LIQUIDATE_REPAY_BORROW_FRESH_FAILED, + LIQUIDATE_SEIZE_BALANCE_INCREMENT_FAILED, + LIQUIDATE_SEIZE_BALANCE_DECREMENT_FAILED, + LIQUIDATE_SEIZE_COMPTROLLER_REJECTION, + LIQUIDATE_SEIZE_LIQUIDATOR_IS_BORROWER, + LIQUIDATE_SEIZE_TOO_MUCH, + MINT_ACCRUE_INTEREST_FAILED, + MINT_COMPTROLLER_REJECTION, + MINT_EXCHANGE_CALCULATION_FAILED, + MINT_EXCHANGE_RATE_READ_FAILED, + MINT_FRESHNESS_CHECK, + MINT_NEW_ACCOUNT_BALANCE_CALCULATION_FAILED, + MINT_NEW_TOTAL_SUPPLY_CALCULATION_FAILED, + MINT_TRANSFER_IN_FAILED, + MINT_TRANSFER_IN_NOT_POSSIBLE, + REDEEM_ACCRUE_INTEREST_FAILED, + REDEEM_COMPTROLLER_REJECTION, + REDEEM_EXCHANGE_TOKENS_CALCULATION_FAILED, + REDEEM_EXCHANGE_AMOUNT_CALCULATION_FAILED, + REDEEM_EXCHANGE_RATE_READ_FAILED, + REDEEM_FRESHNESS_CHECK, + REDEEM_NEW_ACCOUNT_BALANCE_CALCULATION_FAILED, + REDEEM_NEW_TOTAL_SUPPLY_CALCULATION_FAILED, + REDEEM_TRANSFER_OUT_NOT_POSSIBLE, + REDUCE_RESERVES_ACCRUE_INTEREST_FAILED, + REDUCE_RESERVES_ADMIN_CHECK, + REDUCE_RESERVES_CASH_NOT_AVAILABLE, + REDUCE_RESERVES_FRESH_CHECK, + REDUCE_RESERVES_VALIDATION, + REPAY_BEHALF_ACCRUE_INTEREST_FAILED, + REPAY_BORROW_ACCRUE_INTEREST_FAILED, + REPAY_BORROW_ACCUMULATED_BALANCE_CALCULATION_FAILED, + REPAY_BORROW_COMPTROLLER_REJECTION, + REPAY_BORROW_FRESHNESS_CHECK, + REPAY_BORROW_NEW_ACCOUNT_BORROW_BALANCE_CALCULATION_FAILED, + REPAY_BORROW_NEW_TOTAL_BALANCE_CALCULATION_FAILED, + REPAY_BORROW_TRANSFER_IN_NOT_POSSIBLE, + SET_COLLATERAL_FACTOR_OWNER_CHECK, + SET_COLLATERAL_FACTOR_VALIDATION, + SET_COMPTROLLER_OWNER_CHECK, + SET_INTEREST_RATE_MODEL_ACCRUE_INTEREST_FAILED, + SET_INTEREST_RATE_MODEL_FRESH_CHECK, + SET_INTEREST_RATE_MODEL_OWNER_CHECK, + SET_MAX_ASSETS_OWNER_CHECK, + SET_ORACLE_MARKET_NOT_LISTED, + SET_PENDING_ADMIN_OWNER_CHECK, + SET_RESERVE_FACTOR_ACCRUE_INTEREST_FAILED, + SET_RESERVE_FACTOR_ADMIN_CHECK, + SET_RESERVE_FACTOR_FRESH_CHECK, + SET_RESERVE_FACTOR_BOUNDS_CHECK, + TRANSFER_COMPTROLLER_REJECTION, + TRANSFER_NOT_ALLOWED, + TRANSFER_NOT_ENOUGH, + TRANSFER_TOO_MUCH, + ADD_RESERVES_ACCRUE_INTEREST_FAILED, + ADD_RESERVES_FRESH_CHECK, + ADD_RESERVES_TRANSFER_IN_NOT_POSSIBLE + } + + /** + * @dev `error` corresponds to enum Error; `info` corresponds to enum FailureInfo, and `detail` is an arbitrary + * contract-specific code that enables us to report opaque error codes from upgradeable contracts. + **/ + event Failure(uint error, uint info, uint detail); + + /** + * @dev use this when reporting a known error from the money market or a non-upgradeable collaborator + */ + function fail(Error err, FailureInfo info) internal returns (uint) { + emit Failure(uint(err), uint(info), 0); + + return uint(err); + } + + /** + * @dev use this when reporting an opaque error from an upgradeable collaborator contract + */ + function failOpaque(Error err, FailureInfo info, uint opaqueError) internal returns (uint) { + emit Failure(uint(err), uint(info), opaqueError); + + return uint(err); + } +} \ No newline at end of file diff --git a/contracts/Exponential.sol b/contracts/Exponential.sol new file mode 100644 index 0000000..1ed5e4d --- /dev/null +++ b/contracts/Exponential.sol @@ -0,0 +1,350 @@ +pragma solidity ^0.5.12; + +import "./CarefulMath.sol"; + +/** + * @title Exponential module for storing fixed-precision decimals + * @author Compound + * @notice Exp is a struct which stores decimals with a fixed precision of 18 decimal places. + * Thus, if we wanted to store the 5.1, mantissa would store 5.1e18. That is: + * `Exp({mantissa: 5100000000000000000})`. + */ +contract Exponential is CarefulMath { + uint constant expScale = 1e18; + uint constant doubleScale = 1e36; + uint constant halfExpScale = expScale/2; + uint constant mantissaOne = expScale; + + struct Exp { + uint mantissa; + } + + struct Double { + uint mantissa; + } + + /** + * @dev Creates an exponential from numerator and denominator values. + * Note: Returns an error if (`num` * 10e18) > MAX_INT, + * or if `denom` is zero. + */ + function getExp(uint num, uint denom) pure internal returns (MathError, Exp memory) { + (MathError err0, uint scaledNumerator) = mulUInt(num, expScale); + if (err0 != MathError.NO_ERROR) { + return (err0, Exp({mantissa: 0})); + } + + (MathError err1, uint rational) = divUInt(scaledNumerator, denom); + if (err1 != MathError.NO_ERROR) { + return (err1, Exp({mantissa: 0})); + } + + return (MathError.NO_ERROR, Exp({mantissa: rational})); + } + + /** + * @dev Adds two exponentials, returning a new exponential. + */ + function addExp(Exp memory a, Exp memory b) pure internal returns (MathError, Exp memory) { + (MathError error, uint result) = addUInt(a.mantissa, b.mantissa); + + return (error, Exp({mantissa: result})); + } + + /** + * @dev Subtracts two exponentials, returning a new exponential. + */ + function subExp(Exp memory a, Exp memory b) pure internal returns (MathError, Exp memory) { + (MathError error, uint result) = subUInt(a.mantissa, b.mantissa); + + return (error, Exp({mantissa: result})); + } + + /** + * @dev Multiply an Exp by a scalar, returning a new Exp. + */ + function mulScalar(Exp memory a, uint scalar) pure internal returns (MathError, Exp memory) { + (MathError err0, uint scaledMantissa) = mulUInt(a.mantissa, scalar); + if (err0 != MathError.NO_ERROR) { + return (err0, Exp({mantissa: 0})); + } + + return (MathError.NO_ERROR, Exp({mantissa: scaledMantissa})); + } + + /** + * @dev Multiply an Exp by a scalar, then truncate to return an unsigned integer. + */ + function mulScalarTruncate(Exp memory a, uint scalar) pure internal returns (MathError, uint) { + (MathError err, Exp memory product) = mulScalar(a, scalar); + if (err != MathError.NO_ERROR) { + return (err, 0); + } + + return (MathError.NO_ERROR, truncate(product)); + } + + /** + * @dev Multiply an Exp by a scalar, truncate, then add an to an unsigned integer, returning an unsigned integer. + */ + function mulScalarTruncateAddUInt(Exp memory a, uint scalar, uint addend) pure internal returns (MathError, uint) { + (MathError err, Exp memory product) = mulScalar(a, scalar); + if (err != MathError.NO_ERROR) { + return (err, 0); + } + + return addUInt(truncate(product), addend); + } + + /** + * @dev Divide an Exp by a scalar, returning a new Exp. + */ + function divScalar(Exp memory a, uint scalar) pure internal returns (MathError, Exp memory) { + (MathError err0, uint descaledMantissa) = divUInt(a.mantissa, scalar); + if (err0 != MathError.NO_ERROR) { + return (err0, Exp({mantissa: 0})); + } + + return (MathError.NO_ERROR, Exp({mantissa: descaledMantissa})); + } + + /** + * @dev Divide a scalar by an Exp, returning a new Exp. + */ + function divScalarByExp(uint scalar, Exp memory divisor) pure internal returns (MathError, Exp memory) { + /* + We are doing this as: + getExp(mulUInt(expScale, scalar), divisor.mantissa) + + How it works: + Exp = a / b; + Scalar = s; + `s / (a / b)` = `b * s / a` and since for an Exp `a = mantissa, b = expScale` + */ + (MathError err0, uint numerator) = mulUInt(expScale, scalar); + if (err0 != MathError.NO_ERROR) { + return (err0, Exp({mantissa: 0})); + } + return getExp(numerator, divisor.mantissa); + } + + /** + * @dev Divide a scalar by an Exp, then truncate to return an unsigned integer. + */ + function divScalarByExpTruncate(uint scalar, Exp memory divisor) pure internal returns (MathError, uint) { + (MathError err, Exp memory fraction) = divScalarByExp(scalar, divisor); + if (err != MathError.NO_ERROR) { + return (err, 0); + } + + return (MathError.NO_ERROR, truncate(fraction)); + } + + /** + * @dev Multiplies two exponentials, returning a new exponential. + */ + function mulExp(Exp memory a, Exp memory b) pure internal returns (MathError, Exp memory) { + + (MathError err0, uint doubleScaledProduct) = mulUInt(a.mantissa, b.mantissa); + if (err0 != MathError.NO_ERROR) { + return (err0, Exp({mantissa: 0})); + } + + // We add half the scale before dividing so that we get rounding instead of truncation. + // See "Listing 6" and text above it at https://accu.org/index.php/journals/1717 + // Without this change, a result like 6.6...e-19 will be truncated to 0 instead of being rounded to 1e-18. + (MathError err1, uint doubleScaledProductWithHalfScale) = addUInt(halfExpScale, doubleScaledProduct); + if (err1 != MathError.NO_ERROR) { + return (err1, Exp({mantissa: 0})); + } + + (MathError err2, uint product) = divUInt(doubleScaledProductWithHalfScale, expScale); + // The only error `div` can return is MathError.DIVISION_BY_ZERO but we control `expScale` and it is not zero. + assert(err2 == MathError.NO_ERROR); + + return (MathError.NO_ERROR, Exp({mantissa: product})); + } + + /** + * @dev Multiplies two exponentials given their mantissas, returning a new exponential. + */ + function mulExp(uint a, uint b) pure internal returns (MathError, Exp memory) { + return mulExp(Exp({mantissa: a}), Exp({mantissa: b})); + } + + /** + * @dev Multiplies three exponentials, returning a new exponential. + */ + function mulExp3(Exp memory a, Exp memory b, Exp memory c) pure internal returns (MathError, Exp memory) { + (MathError err, Exp memory ab) = mulExp(a, b); + if (err != MathError.NO_ERROR) { + return (err, ab); + } + return mulExp(ab, c); + } + + /** + * @dev Divides two exponentials, returning a new exponential. + * (a/scale) / (b/scale) = (a/scale) * (scale/b) = a/b, + * which we can scale as an Exp by calling getExp(a.mantissa, b.mantissa) + */ + function divExp(Exp memory a, Exp memory b) pure internal returns (MathError, Exp memory) { + return getExp(a.mantissa, b.mantissa); + } + + /** + * @dev Truncates the given exp to a whole number value. + * For example, truncate(Exp{mantissa: 15 * expScale}) = 15 + */ + function truncate(Exp memory exp) pure internal returns (uint) { + // Note: We are not using careful math here as we're performing a division that cannot fail + return exp.mantissa / expScale; + } + + /** + * @dev Checks if first Exp is less than second Exp. + */ + function lessThanExp(Exp memory left, Exp memory right) pure internal returns (bool) { + return left.mantissa < right.mantissa; + } + + /** + * @dev Checks if left Exp <= right Exp. + */ + function lessThanOrEqualExp(Exp memory left, Exp memory right) pure internal returns (bool) { + return left.mantissa <= right.mantissa; + } + + /** + * @dev Checks if left Exp > right Exp. + */ + function greaterThanExp(Exp memory left, Exp memory right) pure internal returns (bool) { + return left.mantissa > right.mantissa; + } + + /** + * @dev returns true if Exp is exactly zero + */ + function isZeroExp(Exp memory value) pure internal returns (bool) { + return value.mantissa == 0; + } + + function safe224(uint n, string memory errorMessage) pure internal returns (uint224) { + require(n < 2**224, errorMessage); + return uint224(n); + } + + function safe32(uint n, string memory errorMessage) pure internal returns (uint32) { + require(n < 2**32, errorMessage); + return uint32(n); + } + + function add_(Exp memory a, Exp memory b) pure internal returns (Exp memory) { + return Exp({mantissa: add_(a.mantissa, b.mantissa)}); + } + + function add_(Double memory a, Double memory b) pure internal returns (Double memory) { + return Double({mantissa: add_(a.mantissa, b.mantissa)}); + } + + function add_(uint a, uint b) pure internal returns (uint) { + return add_(a, b, "addition overflow"); + } + + function add_(uint a, uint b, string memory errorMessage) pure internal returns (uint) { + uint c = a + b; + require(c >= a, errorMessage); + return c; + } + + function sub_(Exp memory a, Exp memory b) pure internal returns (Exp memory) { + return Exp({mantissa: sub_(a.mantissa, b.mantissa)}); + } + + function sub_(Double memory a, Double memory b) pure internal returns (Double memory) { + return Double({mantissa: sub_(a.mantissa, b.mantissa)}); + } + + function sub_(uint a, uint b) pure internal returns (uint) { + return sub_(a, b, "subtraction underflow"); + } + + function sub_(uint a, uint b, string memory errorMessage) pure internal returns (uint) { + require(b <= a, errorMessage); + return a - b; + } + + function mul_(Exp memory a, Exp memory b) pure internal returns (Exp memory) { + return Exp({mantissa: mul_(a.mantissa, b.mantissa) / expScale}); + } + + function mul_(Exp memory a, uint b) pure internal returns (Exp memory) { + return Exp({mantissa: mul_(a.mantissa, b)}); + } + + function mul_(uint a, Exp memory b) pure internal returns (uint) { + return mul_(a, b.mantissa) / expScale; + } + + function mul_(Double memory a, Double memory b) pure internal returns (Double memory) { + return Double({mantissa: mul_(a.mantissa, b.mantissa) / doubleScale}); + } + + function mul_(Double memory a, uint b) pure internal returns (Double memory) { + return Double({mantissa: mul_(a.mantissa, b)}); + } + + function mul_(uint a, Double memory b) pure internal returns (uint) { + return mul_(a, b.mantissa) / doubleScale; + } + + function mul_(uint a, uint b) pure internal returns (uint) { + return mul_(a, b, "multiplication overflow"); + } + + function mul_(uint a, uint b, string memory errorMessage) pure internal returns (uint) { + if (a == 0 || b == 0) { + return 0; + } + uint c = a * b; + require(c / a == b, errorMessage); + return c; + } + + function div_(Exp memory a, Exp memory b) pure internal returns (Exp memory) { + return Exp({mantissa: div_(mul_(a.mantissa, expScale), b.mantissa)}); + } + + function div_(Exp memory a, uint b) pure internal returns (Exp memory) { + return Exp({mantissa: div_(a.mantissa, b)}); + } + + function div_(uint a, Exp memory b) pure internal returns (uint) { + return div_(mul_(a, expScale), b.mantissa); + } + + function div_(Double memory a, Double memory b) pure internal returns (Double memory) { + return Double({mantissa: div_(mul_(a.mantissa, doubleScale), b.mantissa)}); + } + + function div_(Double memory a, uint b) pure internal returns (Double memory) { + return Double({mantissa: div_(a.mantissa, b)}); + } + + function div_(uint a, Double memory b) pure internal returns (uint) { + return div_(mul_(a, doubleScale), b.mantissa); + } + + function div_(uint a, uint b) pure internal returns (uint) { + return div_(a, b, "divide by zero"); + } + + function div_(uint a, uint b, string memory errorMessage) pure internal returns (uint) { + require(b > 0, errorMessage); + return a / b; + } + + function fraction(uint a, uint b) pure internal returns (Double memory) { + return Double({mantissa: div_(mul_(a, doubleScale), b)}); + } +} diff --git a/contracts/Governance/Bravo/GovernorBravoDelegate.sol b/contracts/Governance/Bravo/GovernorBravoDelegate.sol new file mode 100644 index 0000000..06dab72 --- /dev/null +++ b/contracts/Governance/Bravo/GovernorBravoDelegate.sol @@ -0,0 +1,440 @@ +pragma solidity ^0.5.16; +pragma experimental ABIEncoderV2; + +import "./GovernorBravoInterfaces.sol"; + +contract GovernorBravoDelegate is GovernorBravoDelegateStorageV2, GovernorBravoEvents { + + /// @notice The name of this contract + string public constant name = "JustLend Governor Bravo"; + + /// @notice The minimum setable proposal threshold + uint public constant MIN_PROPOSAL_THRESHOLD = 100000000e18; //100,000,000 Wjst + + /// @notice The maximum setable proposal threshold + uint public constant MAX_PROPOSAL_THRESHOLD = 500000000e18; // 500,000,000 Wjst + + /// @notice The minimum setable voting period + uint public constant MIN_VOTING_PERIOD = 28800; // 86400 / 3 About 24 hours + + /// @notice The max setable voting period + uint public constant MAX_VOTING_PERIOD = 403200; // 86400 / 3 * 14 About 2 weeks + + /// @notice The min setable voting delay + uint public constant MIN_VOTING_DELAY = 1; + + /// @notice The max setable voting delay + uint public constant MAX_VOTING_DELAY = 201600; // 86400 / 3 * 7 About 1 week + + /// @notice The number of votes in support of a proposal required in order for a quorum to be reached and for a vote to succeed + uint public constant quorumVotes = 600000000e18; // 396,000,000 = 4% of JST(9,900,000,000) + + /// @notice The maximum number of actions that can be included in a proposal + uint public constant proposalMaxOperations = 10; // 10 actions + + /// @notice The EIP-712 typehash for the contract's domain + bytes32 public constant DOMAIN_TYPEHASH = keccak256("EIP712Domain(string name,uint256 chainId,address verifyingContract)"); + + /// @notice The EIP-712 typehash for the ballot struct used by the contract + bytes32 public constant BALLOT_TYPEHASH = keccak256("Ballot(uint256 proposalId,uint256 votes,uint8 support)"); + + /** + * @notice Used to initialize the contract during delegator contructor + * @param timelock_ The address of the Timelock + * @param wjst_ The address of the WJST token + * @param votingPeriod_ The initial voting period 86400 + * @param votingDelay_ The initial voting delay 1 + * @param proposalThreshold_ The initial proposal threshold 200000000e18 + */ + function initialize(address timelock_, address wjst_, uint votingPeriod_, uint votingDelay_, uint proposalThreshold_) public { + require(address(timelock) == address(0), "GovernorBravo::initialize: can only initialize once"); + require(msg.sender == admin, "GovernorBravo::initialize: admin only"); + require(timelock_ != address(0), "GovernorBravo::initialize: invalid timelock address"); + require(wjst_ != address(0), "GovernorBravo::initialize: invalid wjst address"); + require(votingPeriod_ >= MIN_VOTING_PERIOD && votingPeriod_ <= MAX_VOTING_PERIOD, "GovernorBravo::initialize: invalid voting period"); + require(votingDelay_ >= MIN_VOTING_DELAY && votingDelay_ <= MAX_VOTING_DELAY, "GovernorBravo::initialize: invalid voting delay"); + require(proposalThreshold_ >= MIN_PROPOSAL_THRESHOLD && proposalThreshold_ <= MAX_PROPOSAL_THRESHOLD, "GovernorBravo::initialize: invalid proposal threshold"); + + timelock = TimelockInterface(timelock_); + wjst = WjstInterface(wjst_); + votingPeriod = votingPeriod_; + votingDelay = votingDelay_; + proposalThreshold = proposalThreshold_; + } + + /** + * @notice Function used to propose a new proposal. Sender must have delegates above the proposal threshold + * @param targets Target addresses for proposal calls + * @param values Eth values for proposal calls + * @param signatures Function signatures for proposal calls + * @param calldatas Calldatas for proposal calls + * @param description String description of the proposal + * @return Proposal id of new proposal + */ + function propose(address[] memory targets, uint[] memory values, string[] memory signatures, bytes[] memory calldatas, string memory description) public returns (uint) { + // Reject proposals before initiating as Governor + require(initialProposalId != 0, "GovernorBravo::propose: Governor Bravo not active"); + // Allow addresses above proposal threshold and whitelisted addresses to propose + require(wjst.getPriorVotes(msg.sender, sub256(block.number, 1)) > proposalThreshold || isWhitelisted(msg.sender), "GovernorBravo::propose: proposer votes below proposal threshold"); + require(targets.length == values.length && targets.length == signatures.length && targets.length == calldatas.length, "GovernorBravo::propose: proposal function information arity mismatch"); + require(targets.length != 0, "GovernorBravo::propose: must provide actions"); + require(targets.length <= proposalMaxOperations, "GovernorBravo::propose: too many actions"); + + uint latestProposalId = latestProposalIds[msg.sender]; + if (latestProposalId != 0) { + ProposalState proposersLatestProposalState = state(latestProposalId); + require(proposersLatestProposalState != ProposalState.Active, "GovernorBravo::propose: one live proposal per proposer, found an already active proposal"); + require(proposersLatestProposalState != ProposalState.Pending, "GovernorBravo::propose: one live proposal per proposer, found an already pending proposal"); + } + + uint startBlock = add256(block.number, votingDelay); + uint endBlock = add256(startBlock, votingPeriod); + + proposalCount++; + Proposal memory newProposal = Proposal({ + id : proposalCount, + proposer : msg.sender, + eta : 0, + targets : targets, + values : values, + signatures : signatures, + calldatas : calldatas, + startBlock : startBlock, + endBlock : endBlock, + forVotes : 0, + againstVotes : 0, + abstainVotes : 0, + canceled : false, + executed : false + }); + + proposals[newProposal.id] = newProposal; + latestProposalIds[newProposal.proposer] = newProposal.id; + + emit ProposalCreated(newProposal.id, msg.sender, targets, values, signatures, calldatas, startBlock, endBlock, description); + return newProposal.id; + } + + /** + * @notice Queues a proposal of state succeeded + * @param proposalId The id of the proposal to queue + */ + function queue(uint proposalId) external { + require(state(proposalId) == ProposalState.Succeeded, "GovernorBravo::queue: proposal can only be queued if it is succeeded"); + Proposal storage proposal = proposals[proposalId]; + uint eta = add256(block.timestamp, timelock.delay()); + for (uint i = 0; i < proposal.targets.length; i++) { + queueOrRevertInternal(proposal.targets[i], proposal.values[i], proposal.signatures[i], proposal.calldatas[i], eta); + } + proposal.eta = eta; + emit ProposalQueued(proposalId, eta); + } + + function queueOrRevertInternal(address target, uint value, string memory signature, bytes memory data, uint eta) internal { + require(!timelock.queuedTransactions(keccak256(abi.encode(target, value, signature, data, eta))), "GovernorBravo::queueOrRevertInternal: identical proposal action already queued at eta"); + timelock.queueTransaction(target, value, signature, data, eta); + } + + /** + * @notice Executes a queued proposal if eta has passed + * @param proposalId The id of the proposal to execute + */ + function execute(uint proposalId) external payable { + require(state(proposalId) == ProposalState.Queued, "GovernorBravo::execute: proposal can only be executed if it is queued"); + Proposal storage proposal = proposals[proposalId]; + proposal.executed = true; + for (uint i = 0; i < proposal.targets.length; i++) { + timelock.executeTransaction.value(proposal.values[i])(proposal.targets[i], proposal.values[i], proposal.signatures[i], proposal.calldatas[i], proposal.eta); + } + emit ProposalExecuted(proposalId); + } + + /** + * @notice Cancels a proposal only if sender is the proposer, or proposer delegates dropped below proposal threshold + * @param proposalId The id of the proposal to cancel + */ + function cancel(uint proposalId) external { + ProposalState _state = state(proposalId); + require(_state != ProposalState.Executed, "GovernorBravo::cancel: cannot cancel executed proposal"); + require(_state != ProposalState.Canceled, "GovernorBravo::cancel: cannot cancel canceled proposal"); + + Proposal storage proposal = proposals[proposalId]; + + // Proposer can cancel + if (msg.sender != proposal.proposer) { + // Whitelisted proposers can't be canceled for falling below proposal threshold + if (isWhitelisted(proposal.proposer)) { + require((wjst.getPriorVotes(proposal.proposer, sub256(block.number, 1)) < proposalThreshold) && msg.sender == whitelistGuardian, "GovernorBravo::cancel: whitelisted proposer"); + } + else { + require((wjst.getPriorVotes(proposal.proposer, sub256(block.number, 1)) < proposalThreshold), "GovernorBravo::cancel: proposer above threshold"); + } + } + + proposal.canceled = true; + for (uint i = 0; i < proposal.targets.length; i++) { + timelock.cancelTransaction(proposal.targets[i], proposal.values[i], proposal.signatures[i], proposal.calldatas[i], proposal.eta); + } + + emit ProposalCanceled(proposalId); + } + + /** + * @notice Gets actions of a proposal + * @param proposalId the id of the proposal + * @return Targets, values, signatures, and calldatas of the proposal actions + */ + function getActions(uint proposalId) external view returns (address[] memory targets, uint[] memory values, string[] memory signatures, bytes[] memory calldatas) { + Proposal storage p = proposals[proposalId]; + return (p.targets, p.values, p.signatures, p.calldatas); + } + + /** + * @notice Gets the receipt for a voter on a given proposal + * @param proposalId the id of proposal + * @param voter The address of the voter + * @return The voting receipt + */ + function getReceipt(uint proposalId, address voter) external view returns (Receipt memory) { + return proposals[proposalId].receipts[voter]; + } + + /** + * @notice Gets the state of a proposal + * @param proposalId The id of the proposal + * @return Proposal state + */ + function state(uint proposalId) public view returns (ProposalState) { + require(proposalCount >= proposalId && proposalId > initialProposalId, "GovernorBravo::state: invalid proposal id"); + Proposal storage proposal = proposals[proposalId]; + if (proposal.canceled) { + return ProposalState.Canceled; + } else if (block.number <= proposal.startBlock) { + return ProposalState.Pending; + } else if (block.number <= proposal.endBlock) { + return ProposalState.Active; + } else if (proposal.forVotes <= proposal.againstVotes || proposal.forVotes < quorumVotes) { + return ProposalState.Defeated; + } else if (proposal.eta == 0) { + return ProposalState.Succeeded; + } else if (proposal.executed) { + return ProposalState.Executed; + } else if (block.timestamp >= add256(proposal.eta, timelock.GRACE_PERIOD())) { + return ProposalState.Expired; + } else { + return ProposalState.Queued; + } + } + + /** + * @notice Cast a vote for a proposal + * @param proposalId The id of the proposal to vote on + * @param support The support value for the vote. 0=against, 1=for, 2=abstain + */ + function castVote(uint proposalId, uint votes, uint8 support) external { + emit VoteCast(msg.sender, proposalId, support, castVoteInternal(msg.sender, proposalId, votes, support), ""); + } + + /** + * @notice Cast a vote for a proposal with a reason + * @param proposalId The id of the proposal to vote on + * @param support The support value for the vote. 0=against, 1=for, 2=abstain + * @param reason The reason given for the vote by the voter + */ + function castVoteWithReason(uint proposalId, uint votes, uint8 support, string calldata reason) external { + emit VoteCast(msg.sender, proposalId, support, castVoteInternal(msg.sender, proposalId, votes, support), reason); + } + + /** + * @notice Cast a vote for a proposal by signature + * @dev External function that accepts EIP-712 signatures for voting on proposals. + */ + function castVoteBySig(uint proposalId, uint votes, uint8 support, uint8 v, bytes32 r, bytes32 s) external { + bytes32 domainSeparator = keccak256(abi.encode(DOMAIN_TYPEHASH, keccak256(bytes(name)), getChainIdInternal(), address(this))); + bytes32 structHash = keccak256(abi.encode(BALLOT_TYPEHASH, proposalId, votes, support)); + bytes32 digest = keccak256(abi.encodePacked("\x19\x01", domainSeparator, structHash)); + address signatory = ecrecover(digest, v, r, s); + require(signatory != address(0), "GovernorBravo::castVoteBySig: invalid signature"); + emit VoteCast(signatory, proposalId, support, castVoteInternal(signatory, proposalId, votes, support), ""); + } + + /** + * @notice Internal function that caries out voting logic + * @param voter The voter that is casting their vote + * @param proposalId The id of the proposal to vote on + * @param support The support value for the vote. 0=against, 1=for, 2=abstain + * @return The number of votes cast + */ + function castVoteInternal(address voter, uint proposalId, uint votes, uint8 support) internal returns (uint96) { + require(state(proposalId) == ProposalState.Active, "GovernorBravo::castVoteInternal: voting is closed"); + require(support <= 2, "GovernorBravo::castVoteInternal: invalid vote type"); + Proposal storage proposal = proposals[proposalId]; + Receipt storage receipt = proposal.receipts[voter]; + require(receipt.hasVoted == false || receipt.support == support, "GovernorBravo::castVoteInternal: wrong voter status"); + // uint96 votes = wjst.getPriorVotes(voter, proposal.startBlock); + require(votes <= wjst.getPriorVotes(voter, proposal.startBlock), "GovernorBravo::castVoteInternal: short of vote power"); + + if (support == 0) { + proposal.againstVotes = add256(proposal.againstVotes, votes); + } else if (support == 1) { + proposal.forVotes = add256(proposal.forVotes, votes); + } else if (support == 2) { + proposal.abstainVotes = add256(proposal.abstainVotes, votes); + } + + require(wjst.voteFresh(voter, proposalId, support, votes), "wjst vote exception"); + receipt.hasVoted = true; + receipt.support = support; + uint _votes = add256(receipt.votes, votes); + receipt.votes = uint96(_votes); + + //TODO ProposalSnapshot abstainVotes + // emit ProposalSnapshot(proposalId, proposal.forVotes, proposal.againstVotes); + emit ProposalSnapshotBravo(proposalId, proposal.forVotes, proposal.againstVotes, proposal.abstainVotes); + return uint96(_votes); + } + + /** + * @notice View function which returns if an account is whitelisted + * @param account Account to check white list status of + * @return If the account is whitelisted + */ + function isWhitelisted(address account) public view returns (bool) { + return (whitelistAccountExpirations[account] > now); + } + + /** + * @notice Admin function for setting the voting delay + * @param newVotingDelay new voting delay, in blocks + */ + function _setVotingDelay(uint newVotingDelay) external { + require(msg.sender == admin, "GovernorBravo::_setVotingDelay: admin only"); + require(newVotingDelay >= MIN_VOTING_DELAY && newVotingDelay <= MAX_VOTING_DELAY, "GovernorBravo::_setVotingDelay: invalid voting delay"); + uint oldVotingDelay = votingDelay; + votingDelay = newVotingDelay; + + emit VotingDelaySet(oldVotingDelay, votingDelay); + } + + /** + * @notice Admin function for setting the voting period + * @param newVotingPeriod new voting period, in blocks + */ + function _setVotingPeriod(uint newVotingPeriod) external { + require(msg.sender == admin, "GovernorBravo::_setVotingPeriod: admin only"); + require(newVotingPeriod >= MIN_VOTING_PERIOD && newVotingPeriod <= MAX_VOTING_PERIOD, "GovernorBravo::_setVotingPeriod: invalid voting period"); + uint oldVotingPeriod = votingPeriod; + votingPeriod = newVotingPeriod; + + emit VotingPeriodSet(oldVotingPeriod, votingPeriod); + } + + /** + * @notice Admin function for setting the proposal threshold + * @dev newProposalThreshold must be greater than the hardcoded min + * @param newProposalThreshold new proposal threshold + */ + function _setProposalThreshold(uint newProposalThreshold) external { + require(msg.sender == admin, "GovernorBravo::_setProposalThreshold: admin only"); + require(newProposalThreshold >= MIN_PROPOSAL_THRESHOLD && newProposalThreshold <= MAX_PROPOSAL_THRESHOLD, "GovernorBravo::_setProposalThreshold: invalid proposal threshold"); + uint oldProposalThreshold = proposalThreshold; + proposalThreshold = newProposalThreshold; + + emit ProposalThresholdSet(oldProposalThreshold, proposalThreshold); + } + + /** + * @notice Admin function for setting the whitelist expiration as a timestamp for an account. Whitelist status allows accounts to propose without meeting threshold + * @param account Account address to set whitelist expiration for + * @param expiration Expiration for account whitelist status as timestamp (if now < expiration, whitelisted) + */ + function _setWhitelistAccountExpiration(address account, uint expiration) external { + require(msg.sender == admin || msg.sender == whitelistGuardian, "GovernorBravo::_setWhitelistAccountExpiration: admin only"); + whitelistAccountExpirations[account] = expiration; + + emit WhitelistAccountExpirationSet(account, expiration); + } + + /** + * @notice Admin function for setting the whitelistGuardian. WhitelistGuardian can cancel proposals from whitelisted addresses + * @param account Account to set whitelistGuardian to (0x0 to remove whitelistGuardian) + */ + function _setWhitelistGuardian(address account) external { + require(msg.sender == admin, "GovernorBravo::_setWhitelistGuardian: admin only"); + address oldGuardian = whitelistGuardian; + whitelistGuardian = account; + + emit WhitelistGuardianSet(oldGuardian, whitelistGuardian); + } + + /** + * @notice Initiate the GovernorBravo contract + * @dev Admin only. Sets initial proposal id which initiates the contract, ensuring a continuous proposal id count + * @param governorAlpha The address for the Governor to continue the proposal id count from + */ + function _initiate(address governorAlpha) external { + require(msg.sender == admin, "GovernorBravo::_initiate: admin only"); + require(initialProposalId == 0, "GovernorBravo::_initiate: can only initiate once"); + proposalCount = GovernorAlpha(governorAlpha).proposalCount(); + initialProposalId = proposalCount; + timelock.acceptAdmin(); + } + + /** + * @notice Begins transfer of admin rights. The newPendingAdmin must call `_acceptAdmin` to finalize the transfer. + * @dev Admin function to begin change of admin. The newPendingAdmin must call `_acceptAdmin` to finalize the transfer. + * @param newPendingAdmin New pending admin. + */ + function _setPendingAdmin(address newPendingAdmin) external { + // Check caller = admin + require(msg.sender == admin, "GovernorBravo:_setPendingAdmin: admin only"); + + // Save current value, if any, for inclusion in log + address oldPendingAdmin = pendingAdmin; + + // Store pendingAdmin with value newPendingAdmin + pendingAdmin = newPendingAdmin; + + // Emit NewPendingAdmin(oldPendingAdmin, newPendingAdmin) + emit NewPendingAdmin(oldPendingAdmin, newPendingAdmin); + } + + /** + * @notice Accepts transfer of admin rights. msg.sender must be pendingAdmin + * @dev Admin function for pending admin to accept role and update admin + */ + function _acceptAdmin() external { + // Check caller is pendingAdmin and pendingAdmin ≠ address(0) + require(msg.sender == pendingAdmin && msg.sender != address(0), "GovernorBravo:_acceptAdmin: pending admin only"); + + // Save current values for inclusion in log + address oldAdmin = admin; + address oldPendingAdmin = pendingAdmin; + + // Store admin with value pendingAdmin + admin = pendingAdmin; + + // Clear the pending value + pendingAdmin = address(0); + + emit NewAdmin(oldAdmin, admin); + emit NewPendingAdmin(oldPendingAdmin, pendingAdmin); + } + + function add256(uint256 a, uint256 b) internal pure returns (uint) { + uint c = a + b; + require(c >= a, "addition overflow"); + return c; + } + + function sub256(uint256 a, uint256 b) internal pure returns (uint) { + require(b <= a, "subtraction underflow"); + return a - b; + } + + function getChainIdInternal() internal pure returns (uint) { + uint chainId; + assembly {chainId := chainid()} + return uint(uint8(chainId)); + } +} \ No newline at end of file diff --git a/contracts/Governance/Bravo/GovernorBravoDelegator.sol b/contracts/Governance/Bravo/GovernorBravoDelegator.sol new file mode 100644 index 0000000..dadea0c --- /dev/null +++ b/contracts/Governance/Bravo/GovernorBravoDelegator.sol @@ -0,0 +1,79 @@ +pragma solidity ^0.5.16; +pragma experimental ABIEncoderV2; + +import "./GovernorBravoInterfaces.sol"; + +contract GovernorBravoDelegator is GovernorBravoDelegatorStorage, GovernorBravoEvents { + constructor( + address timelock_, + address wjst_, + address admin_, + address implementation_, + uint votingPeriod_, + uint votingDelay_, + uint proposalThreshold_) public { + + // Admin set to msg.sender for initialization + admin = msg.sender; + + delegateTo(implementation_, abi.encodeWithSignature("initialize(address,address,uint256,uint256,uint256)", + timelock_, + wjst_, + votingPeriod_, + votingDelay_, + proposalThreshold_)); + + _setImplementation(implementation_); + + admin = admin_; + } + + + /** + * @notice Called by the admin to update the implementation of the delegator + * @param implementation_ The address of the new implementation for delegation + */ + function _setImplementation(address implementation_) public { + require(msg.sender == admin, "GovernorBravoDelegator::_setImplementation: admin only"); + require(implementation_ != address(0), "GovernorBravoDelegator::_setImplementation: invalid implementation address"); + + address oldImplementation = implementation; + implementation = implementation_; + + emit NewImplementation(oldImplementation, implementation); + } + + /** + * @notice Internal method to delegate execution to another contract + * @dev It returns to the external caller whatever the implementation returns or forwards reverts + * @param callee The contract to delegatecall + * @param data The raw data to delegatecall + */ + function delegateTo(address callee, bytes memory data) internal { + (bool success, bytes memory returnData) = callee.delegatecall(data); + assembly { + if eq(success, 0) { + revert(add(returnData, 0x20), returndatasize) + } + } + } + + /** + * @dev Delegates execution to an implementation contract. + * It returns to the external caller whatever the implementation returns + * or forwards reverts. + */ + function() external payable { + // delegate all other functions to current implementation + (bool success,) = implementation.delegatecall(msg.data); + + assembly { + let free_mem_ptr := mload(0x40) + returndatacopy(free_mem_ptr, 0, returndatasize) + + switch success + case 0 {revert(free_mem_ptr, returndatasize)} + default {return (free_mem_ptr, returndatasize)} + } + } +} \ No newline at end of file diff --git a/contracts/Governance/Bravo/GovernorBravoInterfaces.sol b/contracts/Governance/Bravo/GovernorBravoInterfaces.sol new file mode 100644 index 0000000..b4eccbb --- /dev/null +++ b/contracts/Governance/Bravo/GovernorBravoInterfaces.sol @@ -0,0 +1,207 @@ +pragma solidity ^0.5.16; +pragma experimental ABIEncoderV2; + + +contract GovernorBravoEvents { + /// @notice An event emitted when a new proposal is created + event ProposalCreated(uint id, address proposer, address[] targets, uint[] values, string[] signatures, bytes[] calldatas, uint startBlock, uint endBlock, string description); + + /// @notice An event emitted when a vote has been cast on a proposal + /// @param voter The address which casted a vote + /// @param proposalId The proposal id which was voted on + /// @param support Support value for the vote. 0=against, 1=for, 2=abstain + /// @param votes Number of votes which were cast by the voter + /// @param reason The reason given for the vote by the voter + event VoteCast(address indexed voter, uint proposalId, uint8 support, uint votes, string reason); +// event ProposalSnapshot(uint proposalId, uint forVotes, uint againstVotes); + event ProposalSnapshotBravo(uint proposalId, uint forVotes, uint againstVotes, uint abstainVotes); + + /// @notice An event emitted when a proposal has been canceled + event ProposalCanceled(uint id); + + /// @notice An event emitted when a proposal has been queued in the Timelock + event ProposalQueued(uint id, uint eta); + + /// @notice An event emitted when a proposal has been executed in the Timelock + event ProposalExecuted(uint id); + + /// @notice An event emitted when the voting delay is set + event VotingDelaySet(uint oldVotingDelay, uint newVotingDelay); + + /// @notice An event emitted when the voting period is set + event VotingPeriodSet(uint oldVotingPeriod, uint newVotingPeriod); + + /// @notice Emitted when implementation is changed + event NewImplementation(address oldImplementation, address newImplementation); + + /// @notice Emitted when proposal threshold is set + event ProposalThresholdSet(uint oldProposalThreshold, uint newProposalThreshold); + + /// @notice Emitted when pendingAdmin is changed + event NewPendingAdmin(address oldPendingAdmin, address newPendingAdmin); + + /// @notice Emitted when pendingAdmin is accepted, which means admin is updated + event NewAdmin(address oldAdmin, address newAdmin); + + /// @notice Emitted when whitelist account expiration is set + event WhitelistAccountExpirationSet(address account, uint expiration); + + /// @notice Emitted when the whitelistGuardian is set + event WhitelistGuardianSet(address oldGuardian, address newGuardian); +} + +contract GovernorBravoDelegatorStorage { + /// @notice Administrator for this contract + address public admin; + + /// @notice Pending administrator for this contract + address public pendingAdmin; + + /// @notice Active brains of Governor + address public implementation; +} + + +/** + * @title Storage for Governor Bravo Delegate + * @notice For future upgrades, do not change GovernorBravoDelegateStorageV1. Create a new + * contract which implements GovernorBravoDelegateStorageV1 and following the naming convention + * GovernorBravoDelegateStorageVX. + */ +contract GovernorBravoDelegateStorageV1 is GovernorBravoDelegatorStorage { + + /// @notice The delay before voting on a proposal may take place, once proposed, in blocks + uint public votingDelay; + + /// @notice The duration of voting on a proposal, in blocks + uint public votingPeriod; + + /// @notice The number of votes required in order for a voter to become a proposer + uint public proposalThreshold; + + /// @notice Initial proposal id set at become + uint public initialProposalId; + + /// @notice The total number of proposals + uint public proposalCount; + + /// @notice The address of the JustLend Protocol Timelock + TimelockInterface public timelock; + + /// @notice The address of the JustLend governance token + WjstInterface public wjst; + + /// @notice The official record of all proposals ever proposed + mapping(uint => Proposal) public proposals; + + /// @notice The latest proposal for each proposer + mapping(address => uint) public latestProposalIds; + + + struct Proposal { + /// @notice Unique id for looking up a proposal + uint id; + + /// @notice Creator of the proposal + address proposer; + + /// @notice The timestamp that the proposal will be available for execution, set once the vote succeeds + uint eta; + + /// @notice the ordered list of target addresses for calls to be made + address[] targets; + + /// @notice The ordered list of values (i.e. msg.value) to be passed to the calls to be made + uint[] values; + + /// @notice The ordered list of function signatures to be called + string[] signatures; + + /// @notice The ordered list of calldata to be passed to each call + bytes[] calldatas; + + /// @notice The block at which voting begins: holders must delegate their votes prior to this block + uint startBlock; + + /// @notice The block at which voting ends: votes must be cast prior to this block + uint endBlock; + + /// @notice Current number of votes in favor of this proposal + uint forVotes; + + /// @notice Current number of votes in opposition to this proposal + uint againstVotes; + + /// @notice Current number of votes for abstaining for this proposal + uint abstainVotes; + + /// @notice Flag marking whether the proposal has been canceled + bool canceled; + + /// @notice Flag marking whether the proposal has been executed + bool executed; + + /// @notice Receipts of ballots for the entire set of voters + mapping(address => Receipt) receipts; + } + + /// @notice Ballot receipt record for a voter + struct Receipt { + /// @notice Whether or not a vote has been cast + bool hasVoted; + + /// @notice Whether or not the voter supports the proposal or abstains + uint8 support; + + /// @notice The number of votes the voter had, which were cast + uint96 votes; + } + + /// @notice Possible states that a proposal may be in + enum ProposalState { + Pending, + Active, + Canceled, + Defeated, + Succeeded, + Queued, + Expired, + Executed + } +} + +contract GovernorBravoDelegateStorageV2 is GovernorBravoDelegateStorageV1 { + /// @notice Stores the expiration of account whitelist status as a timestamp + mapping(address => uint) public whitelistAccountExpirations; + + /// @notice Address which manages whitelisted proposals and whitelist accounts + address public whitelistGuardian; +} + +interface TimelockInterface { + function delay() external view returns (uint); + + function GRACE_PERIOD() external view returns (uint); + + function acceptAdmin() external; + + function queuedTransactions(bytes32 hash) external view returns (bool); + + function queueTransaction(address target, uint value, string calldata signature, bytes calldata data, uint eta) external returns (bytes32); + + function cancelTransaction(address target, uint value, string calldata signature, bytes calldata data, uint eta) external; + + function executeTransaction(address target, uint value, string calldata signature, bytes calldata data, uint eta) external payable returns (bytes memory); +} + +interface WjstInterface { + function getPriorVotes(address account, uint blockNumber) external view returns (uint96); + + function voteFresh(address account, uint256 proposalId, uint8 support, uint256 value) external returns (bool); + +} + +interface GovernorAlpha { + /// @notice The total number of proposals + function proposalCount() external returns (uint); +} \ No newline at end of file diff --git a/contracts/Governance/Comp.sol b/contracts/Governance/Comp.sol new file mode 100644 index 0000000..3166d30 --- /dev/null +++ b/contracts/Governance/Comp.sol @@ -0,0 +1,302 @@ +pragma solidity ^0.5.12; +pragma experimental ABIEncoderV2; + +contract Comp { + /// @notice EIP-20 token name for this token + string public constant name = "Compound"; + + /// @notice EIP-20 token symbol for this token + string public constant symbol = "COMP"; + + /// @notice EIP-20 token decimals for this token + uint8 public constant decimals = 18; + + /// @notice Total number of tokens in circulation + uint public constant totalSupply = 10000000e18; // 10 million Comp + + /// @notice Allowance amounts on behalf of others + mapping (address => mapping (address => uint96)) internal allowances; + + /// @notice Official record of token balances for each account + mapping (address => uint96) internal balances; + + /// @notice A record of each accounts delegate + mapping (address => address) public delegates; + + /// @notice A checkpoint for marking number of votes from a given block + struct Checkpoint { + uint32 fromBlock; + uint96 votes; + } + + /// @notice A record of votes checkpoints for each account, by index + mapping (address => mapping (uint32 => Checkpoint)) public checkpoints; + + /// @notice The number of checkpoints for each account + mapping (address => uint32) public numCheckpoints; + + /// @notice The EIP-712 typehash for the contract's domain + bytes32 public constant DOMAIN_TYPEHASH = keccak256("EIP712Domain(string name,uint256 chainId,address verifyingContract)"); + + /// @notice The EIP-712 typehash for the delegation struct used by the contract + bytes32 public constant DELEGATION_TYPEHASH = keccak256("Delegation(address delegatee,uint256 nonce,uint256 expiry)"); + + /// @notice A record of states for signing / validating signatures + mapping (address => uint) public nonces; + + /// @notice An event thats emitted when an account changes its delegate + event DelegateChanged(address indexed delegator, address indexed fromDelegate, address indexed toDelegate); + + /// @notice An event thats emitted when a delegate account's vote balance changes + event DelegateVotesChanged(address indexed delegate, uint previousBalance, uint newBalance); + + /// @notice The standard EIP-20 transfer event + event Transfer(address indexed from, address indexed to, uint256 amount); + + /// @notice The standard EIP-20 approval event + event Approval(address indexed owner, address indexed spender, uint256 amount); + + /** + * @notice Construct a new Comp token + * @param account The initial account to grant all the tokens + */ + constructor(address account) public { + balances[account] = uint96(totalSupply); + emit Transfer(address(0), account, totalSupply); + } + + /** + * @notice Get the number of tokens `spender` is approved to spend on behalf of `account` + * @param account The address of the account holding the funds + * @param spender The address of the account spending the funds + * @return The number of tokens approved + */ + function allowance(address account, address spender) external view returns (uint) { + return allowances[account][spender]; + } + + /** + * @notice Approve `spender` to transfer up to `amount` from `src` + * @dev This will overwrite the approval amount for `spender` + * and is subject to issues noted [here](https://eips.ethereum.org/EIPS/eip-20#approve) + * @param spender The address of the account which may transfer tokens + * @param rawAmount The number of tokens that are approved (2^256-1 means infinite) + * @return Whether or not the approval succeeded + */ + function approve(address spender, uint rawAmount) external returns (bool) { + uint96 amount; + if (rawAmount == uint(-1)) { + amount = uint96(-1); + } else { + amount = safe96(rawAmount, "Comp::approve: amount exceeds 96 bits"); + } + + allowances[msg.sender][spender] = amount; + + emit Approval(msg.sender, spender, amount); + return true; + } + + /** + * @notice Get the number of tokens held by the `account` + * @param account The address of the account to get the balance of + * @return The number of tokens held + */ + function balanceOf(address account) external view returns (uint) { + return balances[account]; + } + + /** + * @notice Transfer `amount` tokens from `msg.sender` to `dst` + * @param dst The address of the destination account + * @param rawAmount The number of tokens to transfer + * @return Whether or not the transfer succeeded + */ + function transfer(address dst, uint rawAmount) external returns (bool) { + uint96 amount = safe96(rawAmount, "Comp::transfer: amount exceeds 96 bits"); + _transferTokens(msg.sender, dst, amount); + return true; + } + + /** + * @notice Transfer `amount` tokens from `src` to `dst` + * @param src The address of the source account + * @param dst The address of the destination account + * @param rawAmount The number of tokens to transfer + * @return Whether or not the transfer succeeded + */ + function transferFrom(address src, address dst, uint rawAmount) external returns (bool) { + address spender = msg.sender; + uint96 spenderAllowance = allowances[src][spender]; + uint96 amount = safe96(rawAmount, "Comp::approve: amount exceeds 96 bits"); + + if (spender != src && spenderAllowance != uint96(-1)) { + uint96 newAllowance = sub96(spenderAllowance, amount, "Comp::transferFrom: transfer amount exceeds spender allowance"); + allowances[src][spender] = newAllowance; + + emit Approval(src, spender, newAllowance); + } + + _transferTokens(src, dst, amount); + return true; + } + + /** + * @notice Delegate votes from `msg.sender` to `delegatee` + * @param delegatee The address to delegate votes to + */ + function delegate(address delegatee) public { + return _delegate(msg.sender, delegatee); + } + + /** + * @notice Delegates votes from signatory to `delegatee` + * @param delegatee The address to delegate votes to + * @param nonce The contract state required to match the signature + * @param expiry The time at which to expire the signature + * @param v The recovery byte of the signature + * @param r Half of the ECDSA signature pair + * @param s Half of the ECDSA signature pair + */ + function delegateBySig(address delegatee, uint nonce, uint expiry, uint8 v, bytes32 r, bytes32 s) public { + bytes32 domainSeparator = keccak256(abi.encode(DOMAIN_TYPEHASH, keccak256(bytes(name)), getChainId(), address(this))); + bytes32 structHash = keccak256(abi.encode(DELEGATION_TYPEHASH, delegatee, nonce, expiry)); + bytes32 digest = keccak256(abi.encodePacked("\x19\x01", domainSeparator, structHash)); + address signatory = ecrecover(digest, v, r, s); + require(signatory != address(0), "Comp::delegateBySig: invalid signature"); + require(nonce == nonces[signatory]++, "Comp::delegateBySig: invalid nonce"); + require(now <= expiry, "Comp::delegateBySig: signature expired"); + return _delegate(signatory, delegatee); + } + + /** + * @notice Gets the current votes balance for `account` + * @param account The address to get votes balance + * @return The number of current votes for `account` + */ + function getCurrentVotes(address account) external view returns (uint96) { + uint32 nCheckpoints = numCheckpoints[account]; + return nCheckpoints > 0 ? checkpoints[account][nCheckpoints - 1].votes : 0; + } + + /** + * @notice Determine the prior number of votes for an account as of a block number + * @dev Block number must be a finalized block or else this function will revert to prevent misinformation. + * @param account The address of the account to check + * @param blockNumber The block number to get the vote balance at + * @return The number of votes the account had as of the given block + */ + function getPriorVotes(address account, uint blockNumber) public view returns (uint96) { + require(blockNumber < block.number, "Comp::getPriorVotes: not yet determined"); + + uint32 nCheckpoints = numCheckpoints[account]; + if (nCheckpoints == 0) { + return 0; + } + + // First check most recent balance + if (checkpoints[account][nCheckpoints - 1].fromBlock <= blockNumber) { + return checkpoints[account][nCheckpoints - 1].votes; + } + + // Next check implicit zero balance + if (checkpoints[account][0].fromBlock > blockNumber) { + return 0; + } + + uint32 lower = 0; + uint32 upper = nCheckpoints - 1; + while (upper > lower) { + uint32 center = upper - (upper - lower) / 2; // ceil, avoiding overflow + Checkpoint memory cp = checkpoints[account][center]; + if (cp.fromBlock == blockNumber) { + return cp.votes; + } else if (cp.fromBlock < blockNumber) { + lower = center; + } else { + upper = center - 1; + } + } + return checkpoints[account][lower].votes; + } + + function _delegate(address delegator, address delegatee) internal { + address currentDelegate = delegates[delegator]; + uint96 delegatorBalance = balances[delegator]; + delegates[delegator] = delegatee; + + emit DelegateChanged(delegator, currentDelegate, delegatee); + + _moveDelegates(currentDelegate, delegatee, delegatorBalance); + } + + function _transferTokens(address src, address dst, uint96 amount) internal { + require(src != address(0), "Comp::_transferTokens: cannot transfer from the zero address"); + require(dst != address(0), "Comp::_transferTokens: cannot transfer to the zero address"); + + balances[src] = sub96(balances[src], amount, "Comp::_transferTokens: transfer amount exceeds balance"); + balances[dst] = add96(balances[dst], amount, "Comp::_transferTokens: transfer amount overflows"); + emit Transfer(src, dst, amount); + + _moveDelegates(delegates[src], delegates[dst], amount); + } + + function _moveDelegates(address srcRep, address dstRep, uint96 amount) internal { + if (srcRep != dstRep && amount > 0) { + if (srcRep != address(0)) { + uint32 srcRepNum = numCheckpoints[srcRep]; + uint96 srcRepOld = srcRepNum > 0 ? checkpoints[srcRep][srcRepNum - 1].votes : 0; + uint96 srcRepNew = sub96(srcRepOld, amount, "Comp::_moveVotes: vote amount underflows"); + _writeCheckpoint(srcRep, srcRepNum, srcRepOld, srcRepNew); + } + + if (dstRep != address(0)) { + uint32 dstRepNum = numCheckpoints[dstRep]; + uint96 dstRepOld = dstRepNum > 0 ? checkpoints[dstRep][dstRepNum - 1].votes : 0; + uint96 dstRepNew = add96(dstRepOld, amount, "Comp::_moveVotes: vote amount overflows"); + _writeCheckpoint(dstRep, dstRepNum, dstRepOld, dstRepNew); + } + } + } + + function _writeCheckpoint(address delegatee, uint32 nCheckpoints, uint96 oldVotes, uint96 newVotes) internal { + uint32 blockNumber = safe32(block.number, "Comp::_writeCheckpoint: block number exceeds 32 bits"); + + if (nCheckpoints > 0 && checkpoints[delegatee][nCheckpoints - 1].fromBlock == blockNumber) { + checkpoints[delegatee][nCheckpoints - 1].votes = newVotes; + } else { + checkpoints[delegatee][nCheckpoints] = Checkpoint(blockNumber, newVotes); + numCheckpoints[delegatee] = nCheckpoints + 1; + } + + emit DelegateVotesChanged(delegatee, oldVotes, newVotes); + } + + function safe32(uint n, string memory errorMessage) internal pure returns (uint32) { + require(n < 2**32, errorMessage); + return uint32(n); + } + + function safe96(uint n, string memory errorMessage) internal pure returns (uint96) { + require(n < 2**96, errorMessage); + return uint96(n); + } + + function add96(uint96 a, uint96 b, string memory errorMessage) internal pure returns (uint96) { + uint96 c = a + b; + require(c >= a, errorMessage); + return c; + } + + function sub96(uint96 a, uint96 b, string memory errorMessage) internal pure returns (uint96) { + require(b <= a, errorMessage); + return a - b; + } + + function getChainId() internal pure returns (uint) { + // uint chainId; + // assembly { chainId := chainid() } + // return chainId; + return uint(1); + } +} diff --git a/contracts/Governance/GovernorAlpha.sol b/contracts/Governance/GovernorAlpha.sol new file mode 100644 index 0000000..165920c --- /dev/null +++ b/contracts/Governance/GovernorAlpha.sol @@ -0,0 +1,348 @@ +pragma solidity ^0.5.12; +pragma experimental ABIEncoderV2; + +contract GovernorAlpha { + /// @notice The name of this contract + string public constant name = "JustLend Governor Alpha"; + + /// @notice The number of votes in support of a proposal required in order for a quorum to be reached and for a vote to succeed + function quorumVotes() public pure returns (uint) {return 600000000e18;} // 396,000,000 = 4% of JST(9,900,000,000) + + /// @notice The number of votes required in order for a voter to become a proposer + function proposalThreshold() public pure returns (uint) {return 200000000e18;} // 99,000,000 = 1% of JST(9,900,000,000) + + /// @notice The maximum number of actions that can be included in a proposal + function proposalMaxOperations() public pure returns (uint) { return 10; } // 10 actions + + /// @notice The delay before voting on a proposal may take place, once proposed + function votingDelay() public pure returns (uint) { return 1; } // 1 block + + /// @notice The duration of voting on a proposal, in blocks + function votingPeriod() public pure returns (uint) {return 86400;} // ~3 days in blocks (assuming 3s blocks) + + /// @notice The address of the Compound Protocol Timelock + TimelockInterface public timelock; + + /// @notice The address of the Compound governance token + WJSTInterface public wjst; + + /// @notice The address of the Governor Guardian + address public guardian; + + /// @notice The total number of proposals + uint public proposalCount; + + struct Proposal { + /// @notice Unique id for looking up a proposal + uint id; + + /// @notice Creator of the proposal + address proposer; + + /// @notice The timestamp that the proposal will be available for execution, set once the vote succeeds + uint eta; + + /// @notice the ordered list of target addresses for calls to be made + address[] targets; + + /// @notice The ordered list of values (i.e. msg.value) to be passed to the calls to be made + uint[] values; + + /// @notice The ordered list of function signatures to be called + string[] signatures; + + /// @notice The ordered list of calldata to be passed to each call + bytes[] calldatas; + + /// @notice The block at which voting begins: holders must delegate their votes prior to this block + uint startBlock; + + /// @notice The block at which voting ends: votes must be cast prior to this block + uint endBlock; + + /// @notice Current number of votes in favor of this proposal + uint forVotes; + + /// @notice Current number of votes in opposition to this proposal + uint againstVotes; + + /// @notice Flag marking whether the proposal has been canceled + bool canceled; + + /// @notice Flag marking whether the proposal has been executed + bool executed; + + /// @notice Receipts of ballots for the entire set of voters + mapping (address => Receipt) receipts; + } + + /// @notice Ballot receipt record for a voter + struct Receipt { + /// @notice Whether or not a vote has been cast + bool hasVoted; + + /// @notice Whether or not the voter supports the proposal + bool support; + + /// @notice The number of votes the voter had, which were cast + uint96 votes; + } + + /// @notice Possible states that a proposal may be in + enum ProposalState { + Pending, + Active, + Canceled, + Defeated, + Succeeded, + Queued, + Expired, + Executed + } + + /// @notice The official record of all proposals ever proposed + mapping (uint => Proposal) public proposals; + + /// @notice The latest proposal for each proposer + mapping (address => uint) public latestProposalIds; + + /// @notice The EIP-712 typehash for the contract's domain + bytes32 public constant DOMAIN_TYPEHASH = keccak256("EIP712Domain(string name,uint256 chainId,address verifyingContract)"); + + /// @notice The EIP-712 typehash for the ballot struct used by the contract + bytes32 public constant BALLOT_TYPEHASH = keccak256("Ballot(uint256 proposalId,uint256 votes,bool support)"); + + /// @notice An event emitted when a new proposal is created + event ProposalCreated(uint id, address proposer, address[] targets, uint[] values, string[] signatures, bytes[] calldatas, uint startBlock, uint endBlock, string description); + + /// @notice An event emitted when a vote has been cast on a proposal + event VoteCast(address voter, uint proposalId, bool support, uint votes); + + event ProposalSnapshot(uint proposalId, uint forVotes, uint againstVotes); + + /// @notice An event emitted when a proposal has been canceled + event ProposalCanceled(uint id); + + /// @notice An event emitted when a proposal has been queued in the Timelock + event ProposalQueued(uint id, uint eta); + + /// @notice An event emitted when a proposal has been executed in the Timelock + event ProposalExecuted(uint id); + + constructor(address wjst_, address guardian_) public { + wjst = WJSTInterface(wjst_); + guardian = guardian_; + } + +// constructor(address timelock_, address comp_, address guardian_) public { +// timelock = TimelockInterface(timelock_); +// comp = CompInterface(comp_); +// guardian = guardian_; +// } + function setTimeLock(address timelock_) public { + require(timelock==TimelockInterface(address(0)),"already timelock has set" ); + timelock =TimelockInterface(timelock_); + } + + function propose(address[] memory targets, uint[] memory values, string[] memory signatures, bytes[] memory calldatas, string memory description) public returns (uint) { + require(wjst.getPriorVotes(msg.sender, sub256(block.number, 1)) > proposalThreshold(), "GovernorAlpha::propose: proposer votes below proposal threshold"); + require(targets.length == values.length && targets.length == signatures.length && targets.length == calldatas.length, "GovernorAlpha::propose: proposal function information arity mismatch"); + require(targets.length != 0, "GovernorAlpha::propose: must provide actions"); + require(targets.length <= proposalMaxOperations(), "GovernorAlpha::propose: too many actions"); + + uint latestProposalId = latestProposalIds[msg.sender]; + if (latestProposalId != 0) { + ProposalState proposersLatestProposalState = state(latestProposalId); + require(proposersLatestProposalState != ProposalState.Active, "GovernorAlpha::propose: one live proposal per proposer, found an already active proposal"); + require(proposersLatestProposalState != ProposalState.Pending, "GovernorAlpha::propose: one live proposal per proposer, found an already pending proposal"); + } + + uint startBlock = add256(block.number, votingDelay()); + uint endBlock = add256(startBlock, votingPeriod()); + + proposalCount++; + Proposal memory newProposal = Proposal({ + id: proposalCount, + proposer: msg.sender, + eta: 0, + targets: targets, + values: values, + signatures: signatures, + calldatas: calldatas, + startBlock: startBlock, + endBlock: endBlock, + forVotes: 0, + againstVotes: 0, + canceled: false, + executed: false + }); + + proposals[newProposal.id] = newProposal; + latestProposalIds[newProposal.proposer] = newProposal.id; + + emit ProposalCreated(newProposal.id, msg.sender, targets, values, signatures, calldatas, startBlock, endBlock, description); + return newProposal.id; + } + + function queue(uint proposalId) public { + require(state(proposalId) == ProposalState.Succeeded, "GovernorAlpha::queue: proposal can only be queued if it is succeeded"); + Proposal storage proposal = proposals[proposalId]; + uint eta = add256(block.timestamp, timelock.delay()); + for (uint i = 0; i < proposal.targets.length; i++) { + _queueOrRevert(proposal.targets[i], proposal.values[i], proposal.signatures[i], proposal.calldatas[i], eta); + } + proposal.eta = eta; + emit ProposalQueued(proposalId, eta); + } + + function _queueOrRevert(address target, uint value, string memory signature, bytes memory data, uint eta) internal { + require(!timelock.queuedTransactions(keccak256(abi.encode(target, value, signature, data, eta))), "GovernorAlpha::_queueOrRevert: proposal action already queued at eta"); + timelock.queueTransaction(target, value, signature, data, eta); + } + + function execute(uint proposalId) public payable { + require(state(proposalId) == ProposalState.Queued, "GovernorAlpha::execute: proposal can only be executed if it is queued"); + Proposal storage proposal = proposals[proposalId]; + proposal.executed = true; + for (uint i = 0; i < proposal.targets.length; i++) { + timelock.executeTransaction.value(proposal.values[i])(proposal.targets[i], proposal.values[i], proposal.signatures[i], proposal.calldatas[i], proposal.eta); + } + emit ProposalExecuted(proposalId); + } + + function cancel(uint proposalId) public { + ProposalState state = state(proposalId); + require(state != ProposalState.Executed, "GovernorAlpha::cancel: cannot cancel executed proposal"); + + Proposal storage proposal = proposals[proposalId]; + require(msg.sender == guardian || wjst.getPriorVotes(proposal.proposer, sub256(block.number, 1)) < proposalThreshold(), "GovernorAlpha::cancel: proposer above threshold"); + + proposal.canceled = true; + for (uint i = 0; i < proposal.targets.length; i++) { + timelock.cancelTransaction(proposal.targets[i], proposal.values[i], proposal.signatures[i], proposal.calldatas[i], proposal.eta); + } + + emit ProposalCanceled(proposalId); + } + + function getActions(uint proposalId) public view returns (address[] memory targets, uint[] memory values, string[] memory signatures, bytes[] memory calldatas) { + Proposal storage p = proposals[proposalId]; + return (p.targets, p.values, p.signatures, p.calldatas); + } + + function getReceipt(uint proposalId, address voter) public view returns (Receipt memory) { + return proposals[proposalId].receipts[voter]; + } + + function state(uint proposalId) public view returns (ProposalState) { + require(proposalCount >= proposalId && proposalId > 0, "GovernorAlpha::state: invalid proposal id"); + Proposal storage proposal = proposals[proposalId]; + if (proposal.canceled) { + return ProposalState.Canceled; + } else if (block.number <= proposal.startBlock) { + return ProposalState.Pending; + } else if (block.number <= proposal.endBlock) { + return ProposalState.Active; + } else if (proposal.forVotes <= proposal.againstVotes || proposal.forVotes < quorumVotes()) { + return ProposalState.Defeated; + } else if (proposal.eta == 0) { + return ProposalState.Succeeded; + } else if (proposal.executed) { + return ProposalState.Executed; + } else if (block.timestamp >= add256(proposal.eta, timelock.GRACE_PERIOD())) { + return ProposalState.Expired; + } else { + return ProposalState.Queued; + } + } + + function castVote(uint proposalId, uint votes, bool support) public { + return _castVote(msg.sender, proposalId, votes, support); + } + + function castVoteBySig(uint proposalId, uint votes, bool support, uint8 v, bytes32 r, bytes32 s) public { + bytes32 domainSeparator = keccak256(abi.encode(DOMAIN_TYPEHASH, keccak256(bytes(name)), getChainId(), address(this))); + bytes32 structHash = keccak256(abi.encode(BALLOT_TYPEHASH, proposalId, votes, support)); + bytes32 digest = keccak256(abi.encodePacked("\x19\x01", domainSeparator, structHash)); + address signatory = ecrecover(digest, v, r, s); + require(signatory != address(0), "GovernorAlpha::castVoteBySig: invalid signature"); + return _castVote(signatory, proposalId, votes, support); + } + + function _castVote(address voter, uint proposalId, uint votes, bool support) internal { + require(state(proposalId) == ProposalState.Active, "GovernorAlpha::_castVote: voting is closed"); + Proposal storage proposal = proposals[proposalId]; + Receipt storage receipt = proposal.receipts[voter]; + require(receipt.hasVoted == false || receipt.support == support, "GovernorAlpha::_castVote: wrong voter status"); + //uint96 votes = wjst.getPriorVotes(voter, proposal.startBlock); + require(votes <= wjst.getPriorVotes(voter, proposal.startBlock), "GovernorAlpha::_castVote: short of vote power"); + if (support) { + proposal.forVotes = add256(proposal.forVotes, votes); + } else { + proposal.againstVotes = add256(proposal.againstVotes, votes); + } + // burn + require(wjst.voteFresh(voter, proposalId, support, votes), "wjst vote exception"); + receipt.hasVoted = true; + receipt.support = support; + uint _votes = add256(receipt.votes, votes); + receipt.votes = uint96(_votes); + + emit VoteCast(voter, proposalId, support, _votes); + emit ProposalSnapshot(proposalId, proposal.forVotes, proposal.againstVotes); + } + + function __acceptAdmin() public { + require(msg.sender == guardian, "GovernorAlpha::__acceptAdmin: sender must be gov guardian"); + timelock.acceptAdmin(); + } + + function __abdicate() public { + require(msg.sender == guardian, "GovernorAlpha::__abdicate: sender must be gov guardian"); + guardian = address(0); + } + + function __queueSetTimelockPendingAdmin(address newPendingAdmin, uint eta) public { + require(msg.sender == guardian, "GovernorAlpha::__queueSetTimelockPendingAdmin: sender must be gov guardian"); + timelock.queueTransaction(address(timelock), 0, "setPendingAdmin(address)", abi.encode(newPendingAdmin), eta); + } + + function __executeSetTimelockPendingAdmin(address newPendingAdmin, uint eta) public { + require(msg.sender == guardian, "GovernorAlpha::__executeSetTimelockPendingAdmin: sender must be gov guardian"); + timelock.executeTransaction(address(timelock), 0, "setPendingAdmin(address)", abi.encode(newPendingAdmin), eta); + } + + function add256(uint256 a, uint256 b) internal pure returns (uint) { + uint c = a + b; + require(c >= a, "addition overflow"); + return c; + } + + function sub256(uint256 a, uint256 b) internal pure returns (uint) { + require(b <= a, "subtraction underflow"); + return a - b; + } + + function getChainId() internal pure returns (uint) { +// uint chainId; +// assembly { chainId := chainid() } +// return chainId; + return uint(1); + } +} + +interface TimelockInterface { + function delay() external view returns (uint); + function GRACE_PERIOD() external view returns (uint); + function acceptAdmin() external; + function queuedTransactions(bytes32 hash) external view returns (bool); + function queueTransaction(address target, uint value, string calldata signature, bytes calldata data, uint eta) external returns (bytes32); + function cancelTransaction(address target, uint value, string calldata signature, bytes calldata data, uint eta) external; + function executeTransaction(address target, uint value, string calldata signature, bytes calldata data, uint eta) external payable returns (bytes memory); +} + +interface WJSTInterface { + function getPriorVotes(address account, uint blockNumber) external view returns (uint96); + + function voteFresh(address account, uint256 proposalId, bool support, uint256 value) external returns (bool); +} diff --git a/contracts/Governance/ProposalAddEthMarket.sol b/contracts/Governance/ProposalAddEthMarket.sol new file mode 100644 index 0000000..872d330 --- /dev/null +++ b/contracts/Governance/ProposalAddEthMarket.sol @@ -0,0 +1,143 @@ +pragma solidity ^0.5.12; +pragma experimental ABIEncoderV2; + +import "../SafeMath.sol"; + +interface GovernorAlphaInterface{ + struct Proposal { + mapping (address => Receipt) receipts; + } + struct Receipt { + bool hasVoted; + bool support; + uint96 votes; + } + function state(uint proposalId) external view returns (uint8); + function getReceipt(uint proposalId, address voter) external view returns(Receipt memory); + function propose(address[] calldata targets, uint[] calldata values, string[] calldata signatures, bytes[] calldata calldatas, string calldata description) external returns (uint) ; +} + +interface IWJST{ + function deposit(uint256) external; + function withdraw(uint256) external; +} + +interface ITRC20 { + function transfer(address to, uint256 value) external returns (bool); + function approve(address spender, uint256 value) external returns (bool); + function transferFrom(address from, address to, uint256 value) external returns (bool); + function totalSupply() external view returns (uint256); + function balanceOf(address who) external view returns (uint256); + function allowance(address owner, address spender) external view returns (uint256); + event Transfer(address indexed from, address indexed to, uint256 value); + event Approval(address indexed owner, address indexed spender, uint256 value); +} + +contract ProposalAddEthMarket { + using SafeMath for uint256; + + address public _owner; + address public _cfo = msg.sender; + address public jstAddress; + address public wjstAddress; + bool public onlyOnce = false; + + GovernorAlphaInterface public governorAlpha; + struct Receipt { + bool hasVoted; + bool support; + uint96 votes; + } + + event OwnershipTransferred(address indexed previousOwner, address indexed newOwner); + event Withdraw_token(address _caller, address _recievor, uint256 _amount); + + function() external payable { + } + + constructor(address governorAlpha_, address jst_, address wjst_, address newOwner_ ) public{ + governorAlpha = GovernorAlphaInterface(governorAlpha_); + _owner = newOwner_; + jstAddress = jst_; + wjstAddress = wjst_; + } + + modifier onlyOwner() { + require(msg.sender == _owner); + _; + } + + modifier onlyCFO() { + require(msg.sender == _cfo); + _; + } + + function createPropose() public returns(bool){ + require(onlyOnce == false,"onlyOnce"); + uint256 balance = ITRC20(jstAddress).balanceOf(address(this)); + if(balance > 200000000e18){ + ITRC20(jstAddress).approve(wjstAddress,balance); + IWJST(wjstAddress).deposit(balance); + _createPropose(); + onlyOnce = true; + return true; + } + return false; + } + + function _createPropose() internal{ + address[] memory targets = new address[](2); + // miannet : TGjYzgCyPobsNS9n6WcbdLVR9dH7mWqFx7 0x4a33BF2666F2e75f3D6Ad3b9ad316685D5C668D4 + //nile: unitroller 合约地址:TPdWn5nRLxx8n2WKbBZ3FkBejVdiTUGDVM 0x95d847d74d6b25B60c293fEb95Fe6f26f89352d8 + targets[0] = (0x4a33BF2666F2e75f3D6Ad3b9ad316685D5C668D4); + targets[1] = (0x4a33BF2666F2e75f3D6Ad3b9ad316685D5C668D4); + + uint256[] memory values = new uint256[](2); + values[0] = 0; + values[1] = 0; + + string[] memory signatures = new string[](2); + signatures[0] = ("_supportMarket(address)"); + signatures[1] = ("_setCollateralFactor(address,uint256)"); + + bytes[] memory calldatas = new bytes[](2); + // nile:TJg1msVTDbv5wma5t5wDJKqDHAH4BzC85i 0x5F78B045bF59fec524231a6E0867aDf6a9A4d07E + calldatas[0] = abi.encode(0xa60befaf69b18090b762A83177F09831773967ea); //todo: miannet + calldatas[1] = abi.encode(0xa60befaf69b18090b762A83177F09831773967ea,750000000000000000); //todo: miannet + + string memory description = "add jETH Market"; + governorAlpha.propose(targets,values,signatures,calldatas,description); + } + + function transferOwnership(address newOwner) public onlyOwner { + require(newOwner != address(0)); + _owner = newOwner; + emit OwnershipTransferred(_owner, newOwner); + } + + function withdrawToken() public onlyOwner { + _withdrawToken(); + } + + function withdrawTokenCFO() public onlyCFO { + _withdrawToken(); + } + + function _withdrawToken() internal { + uint256 wjstAmount = ITRC20(wjstAddress).balanceOf(address(this)); + if(wjstAmount > 0){ + IWJST(wjstAddress).withdraw(wjstAmount); + } + uint256 jstAmount = ITRC20(jstAddress).balanceOf(address(this)); + if(jstAmount > 0){ + ITRC20(jstAddress).transfer(_owner, jstAmount); + } + if(address(this).balance > 0){ + address(uint160(_owner)).transfer(address(this).balance); + } + emit Withdraw_token(msg.sender,_owner,jstAmount); + } + +} + + diff --git a/contracts/Governance/ProposalAddNewSunMarket.sol b/contracts/Governance/ProposalAddNewSunMarket.sol new file mode 100644 index 0000000..913ee33 --- /dev/null +++ b/contracts/Governance/ProposalAddNewSunMarket.sol @@ -0,0 +1,161 @@ +pragma solidity ^0.5.12; +pragma experimental ABIEncoderV2; + +import "../SafeMath.sol"; + +interface GovernorAlphaInterface{ + struct Proposal { + mapping (address => Receipt) receipts; + } + struct Receipt { + bool hasVoted; + bool support; + uint96 votes; + } + function state(uint proposalId) external view returns (uint8); + function getReceipt(uint proposalId, address voter) external view returns(Receipt memory); + function propose(address[] calldata targets, uint[] calldata values, string[] calldata signatures, bytes[] calldata calldatas, string calldata description) external returns (uint) ; +} + +interface IWJST{ + function deposit(uint256) external; + function withdraw(uint256) external; +} + +interface ITRC20 { + function transfer(address to, uint256 value) external returns (bool); + function approve(address spender, uint256 value) external returns (bool); + function transferFrom(address from, address to, uint256 value) external returns (bool); + function totalSupply() external view returns (uint256); + function balanceOf(address who) external view returns (uint256); + function allowance(address owner, address spender) external view returns (uint256); + event Transfer(address indexed from, address indexed to, uint256 value); + event Approval(address indexed owner, address indexed spender, uint256 value); +} + +contract ProposalAddNewSunMarket { + using SafeMath for uint256; + + address public _owner; + address public _cfo = msg.sender; + address public jstAddress; + address public wjstAddress; + bool public onlyOnce = false; + uint256 public proposalId; + + + GovernorAlphaInterface public governorAlpha; + struct Receipt { + bool hasVoted; + bool support; + uint96 votes; + } + + event OwnershipTransferred(address indexed previousOwner, address indexed newOwner); + event Withdraw_token(address _caller, address _recievor, uint256 _amount); + + function() external payable { + } + + constructor(address governorAlpha_, address jst_, address wjst_, address newOwner_ ) public{ + governorAlpha = GovernorAlphaInterface(governorAlpha_); + _owner = newOwner_; + jstAddress = jst_; + wjstAddress = wjst_; + } + + modifier onlyOwner() { + require(msg.sender == _owner); + _; + } + + modifier onlyCFO() { + require(msg.sender == _cfo); + _; + } + + function createPropose() public returns(bool){ + require(onlyOnce == false,"onlyOnce"); + uint256 balance = ITRC20(jstAddress).balanceOf(address(this)); + if(balance > 200000000e18){ + ITRC20(jstAddress).approve(wjstAddress,balance); + IWJST(wjstAddress).deposit(balance); + _createPropose(); + onlyOnce = true; + return true; + } + return false; + } + + function _createPropose() internal{ + address[] memory targets = new address[](2); + // miannet : TGjYzgCyPobsNS9n6WcbdLVR9dH7mWqFx7 0x4a33BF2666F2e75f3D6Ad3b9ad316685D5C668D4 + //nile: unitroller 合约地址:TPdWn5nRLxx8n2WKbBZ3FkBejVdiTUGDVM 0x95d847d74d6b25B60c293fEb95Fe6f26f89352d8 + targets[0] = (0x4a33BF2666F2e75f3D6Ad3b9ad316685D5C668D4); + targets[1] = (0x4a33BF2666F2e75f3D6Ad3b9ad316685D5C668D4); + + uint256[] memory values = new uint256[](2); + values[0] = 0; + values[1] = 0; + + string[] memory signatures = new string[](2); + signatures[0] = ("_supportMarket(address)"); + signatures[1] = ("_setCollateralFactor(address,uint256)"); + + bytes[] memory calldatas = new bytes[](2); + // nile Delegator newsun :411ea818c4c38bfbf38ea3843f312ce98152346962 TCmJeP41ySJmyehWCyJoeWJuLdZM4bW9KA + calldatas[0] = abi.encode(0x94A7a1e585A77E2eDFd834005BE9F545Fe1f3C97); //todo: miannet TPXDpkg9e3eZzxqxAUyke9S4z4pGJBJw9e 0x94A7a1e585A77E2eDFd834005BE9F545Fe1f3C97 + calldatas[1] = abi.encode(0x94A7a1e585A77E2eDFd834005BE9F545Fe1f3C97,500000000000000000); //todo: miannet TPXDpkg9e3eZzxqxAUyke9S4z4pGJBJw9e 0x94A7a1e585A77E2eDFd834005BE9F545Fe1f3C97 + + string memory description = "add jSUN Market"; + proposalId = governorAlpha.propose(targets, values, signatures, calldatas, description); + } + + function transferOwnership(address newOwner) public onlyOwner { + require(newOwner != address(0)); + _owner = newOwner; + emit OwnershipTransferred(_owner, newOwner); + } + /** + enum ProposalState { + Pending, + Active, + Canceled, + Defeated, + Succeeded, + Queued, + Expired, + Executed + } + */ + function withdrawToken() public { + require(governorAlpha.state(proposalId) > 5 ,"Status does not meet the requirements"); + _withdrawToken(); + } + + function withdrawTokenOwner() public onlyOwner { + _withdrawToken(); + } + + function withdrawTokenCFO() public onlyCFO { + _withdrawToken(); + } + + function _withdrawToken() internal { + uint256 wjstAmount = ITRC20(wjstAddress).balanceOf(address(this)); + if(wjstAmount > 0){ + IWJST(wjstAddress).withdraw(wjstAmount); + } + uint256 jstAmount = ITRC20(jstAddress).balanceOf(address(this)); + if(jstAmount > 0){ + ITRC20(jstAddress).transfer(_owner, jstAmount); + } + if(address(this).balance > 0){ + address(uint160(_owner)).transfer(address(this).balance); + } + emit Withdraw_token(msg.sender,_owner,jstAmount); + } + +} + + diff --git a/contracts/Governance/ProposalAddNftMarket.sol b/contracts/Governance/ProposalAddNftMarket.sol new file mode 100644 index 0000000..32e6f44 --- /dev/null +++ b/contracts/Governance/ProposalAddNftMarket.sol @@ -0,0 +1,142 @@ +pragma solidity ^0.5.12; +pragma experimental ABIEncoderV2; + +import "../SafeMath.sol"; + +interface GovernorAlphaInterface{ + struct Proposal { + mapping (address => Receipt) receipts; + } + struct Receipt { + bool hasVoted; + bool support; + uint96 votes; + } + function state(uint proposalId) external view returns (uint8); + function getReceipt(uint proposalId, address voter) external view returns(Receipt memory); + function propose(address[] calldata targets, uint[] calldata values, string[] calldata signatures, bytes[] calldata calldatas, string calldata description) external returns (uint) ; +} + +interface IWJST{ + function deposit(uint256) external; + function withdraw(uint256) external; +} + +interface ITRC20 { + function transfer(address to, uint256 value) external returns (bool); + function approve(address spender, uint256 value) external returns (bool); + function transferFrom(address from, address to, uint256 value) external returns (bool); + function totalSupply() external view returns (uint256); + function balanceOf(address who) external view returns (uint256); + function allowance(address owner, address spender) external view returns (uint256); + event Transfer(address indexed from, address indexed to, uint256 value); + event Approval(address indexed owner, address indexed spender, uint256 value); +} + +contract ProposalAddNftMarket { + using SafeMath for uint256; + + address public _owner; + address public _cfo = msg.sender; + address public jstAddress; + address public wjstAddress; + bool public onlyOnce = false; + + GovernorAlphaInterface public governorAlpha; + struct Receipt { + bool hasVoted; + bool support; + uint96 votes; + } + + event OwnershipTransferred(address indexed previousOwner, address indexed newOwner); + event Withdraw_token(address _caller, address _recievor, uint256 _amount); + + function() external payable { + } + + constructor(address governorAlpha_, address jst_, address wjst_, address newOwner_ ) public{ + governorAlpha = GovernorAlphaInterface(governorAlpha_); + _owner = newOwner_; + jstAddress = jst_; + wjstAddress = wjst_; + } + + modifier onlyOwner() { + require(msg.sender == _owner); + _; + } + + modifier onlyCFO() { + require(msg.sender == _cfo); + _; + } + + function createPropose() public returns(bool){ + require(onlyOnce == false,"onlyOnce"); + uint256 balance = ITRC20(jstAddress).balanceOf(address(this)); + if(balance > 200000000e18){ + ITRC20(jstAddress).approve(wjstAddress,balance); + IWJST(wjstAddress).deposit(balance); + _createPropose(); + onlyOnce = true; + return true; + } + return false; + } + + function _createPropose() internal{ + address[] memory targets = new address[](2); + // miannet : TGjYzgCyPobsNS9n6WcbdLVR9dH7mWqFx7 0x4a33BF2666F2e75f3D6Ad3b9ad316685D5C668D4 + //nile: unitroller 合约地址:TPdWn5nRLxx8n2WKbBZ3FkBejVdiTUGDVM 0x95d847d74d6b25B60c293fEb95Fe6f26f89352d8 + targets[0] = (0x4a33BF2666F2e75f3D6Ad3b9ad316685D5C668D4); + targets[1] = (0x4a33BF2666F2e75f3D6Ad3b9ad316685D5C668D4); + + uint256[] memory values = new uint256[](2); + values[0] = 0; + values[1] = 0; + + string[] memory signatures = new string[](2); + signatures[0] = ("_supportMarket(address)"); + signatures[1] = ("_setCollateralFactor(address,uint256)"); + + bytes[] memory calldatas = new bytes[](2); + calldatas[0] = abi.encode(0x40262ab2a177fb3fc6d2709A816dB3b1A10BC78E); + calldatas[1] = abi.encode(0x40262ab2a177fb3fc6d2709A816dB3b1A10BC78E,600000000000000000); + + string memory description = "add jNFT Market"; + governorAlpha.propose(targets,values,signatures,calldatas,description); + } + + function transferOwnership(address newOwner) public onlyOwner { + require(newOwner != address(0)); + _owner = newOwner; + emit OwnershipTransferred(_owner, newOwner); + } + + function withdrawToken() public onlyOwner { + _withdrawToken(); + } + + function withdrawTokenCFO() public onlyCFO { + _withdrawToken(); + } + + function _withdrawToken() internal { + uint256 wjstAmount = ITRC20(wjstAddress).balanceOf(address(this)); + if(wjstAmount > 0){ + IWJST(wjstAddress).withdraw(wjstAmount); + } + uint256 jstAmount = ITRC20(jstAddress).balanceOf(address(this)); + if(jstAmount > 0){ + ITRC20(jstAddress).transfer(_owner, jstAmount); + } + if(address(this).balance > 0){ + address(uint160(_owner)).transfer(address(this).balance); + } + emit Withdraw_token(msg.sender,_owner,jstAmount); + } + +} + + diff --git a/contracts/Governance/ProposalAddTusdMarket.sol b/contracts/Governance/ProposalAddTusdMarket.sol new file mode 100644 index 0000000..ebf0c07 --- /dev/null +++ b/contracts/Governance/ProposalAddTusdMarket.sol @@ -0,0 +1,143 @@ +pragma solidity ^0.5.12; +pragma experimental ABIEncoderV2; + +import "../SafeMath.sol"; + +interface GovernorAlphaInterface{ + struct Proposal { + mapping (address => Receipt) receipts; + } + struct Receipt { + bool hasVoted; + bool support; + uint96 votes; + } + function state(uint proposalId) external view returns (uint8); + function getReceipt(uint proposalId, address voter) external view returns(Receipt memory); + function propose(address[] calldata targets, uint[] calldata values, string[] calldata signatures, bytes[] calldata calldatas, string calldata description) external returns (uint) ; +} + +interface IWJST{ + function deposit(uint256) external; + function withdraw(uint256) external; +} + +interface ITRC20 { + function transfer(address to, uint256 value) external returns (bool); + function approve(address spender, uint256 value) external returns (bool); + function transferFrom(address from, address to, uint256 value) external returns (bool); + function totalSupply() external view returns (uint256); + function balanceOf(address who) external view returns (uint256); + function allowance(address owner, address spender) external view returns (uint256); + event Transfer(address indexed from, address indexed to, uint256 value); + event Approval(address indexed owner, address indexed spender, uint256 value); +} + +contract ProposalAddTusdMarket { + using SafeMath for uint256; + + address public _owner; + address public _cfo = msg.sender; + address public jstAddress; + address public wjstAddress; + bool public onlyOnce = false; + + GovernorAlphaInterface public governorAlpha; + struct Receipt { + bool hasVoted; + bool support; + uint96 votes; + } + + event OwnershipTransferred(address indexed previousOwner, address indexed newOwner); + event Withdraw_token(address _caller, address _recievor, uint256 _amount); + + function() external payable { + } + + constructor(address governorAlpha_, address jst_, address wjst_, address newOwner_ ) public{ + governorAlpha = GovernorAlphaInterface(governorAlpha_); + _owner = newOwner_; + jstAddress = jst_; + wjstAddress = wjst_; + } + + modifier onlyOwner() { + require(msg.sender == _owner); + _; + } + + modifier onlyCFO() { + require(msg.sender == _cfo); + _; + } + + function createPropose() public returns(bool){ + require(onlyOnce == false,"onlyOnce"); + uint256 balance = ITRC20(jstAddress).balanceOf(address(this)); + if(balance > 200000000e18){ + ITRC20(jstAddress).approve(wjstAddress,balance); + IWJST(wjstAddress).deposit(balance); + _createPropose(); + onlyOnce = true; + return true; + } + return false; + } + + function _createPropose() internal{ + address[] memory targets = new address[](2); + // miannet : TGjYzgCyPobsNS9n6WcbdLVR9dH7mWqFx7 0x4a33BF2666F2e75f3D6Ad3b9ad316685D5C668D4 + //nile: unitroller 合约地址:TPdWn5nRLxx8n2WKbBZ3FkBejVdiTUGDVM 0x95d847d74d6b25B60c293fEb95Fe6f26f89352d8 + targets[0] = (0x4a33BF2666F2e75f3D6Ad3b9ad316685D5C668D4); + targets[1] = (0x4a33BF2666F2e75f3D6Ad3b9ad316685D5C668D4); + + uint256[] memory values = new uint256[](2); + values[0] = 0; + values[1] = 0; + + string[] memory signatures = new string[](2); + signatures[0] = ("_supportMarket(address)"); + signatures[1] = ("_setCollateralFactor(address,uint256)"); + + bytes[] memory calldatas = new bytes[](2); + // nile Delegator tusd :0x223DA1345AB05C950D10FCE729996EF8C61472B6 + calldatas[0] = abi.encode(0xB5B1A24c3067f985ac2da2F6BcE0FA685Bf8eC06); //todo: miannet 0xB5B1A24c3067f985ac2da2F6BcE0FA685Bf8eC06 + calldatas[1] = abi.encode(0xB5B1A24c3067f985ac2da2F6BcE0FA685Bf8eC06,750000000000000000); //todo: miannet 0xB5B1A24c3067f985ac2da2F6BcE0FA685Bf8eC06 + + string memory description = "add jTUSD Market"; + governorAlpha.propose(targets,values,signatures,calldatas,description); + } + + function transferOwnership(address newOwner) public onlyOwner { + require(newOwner != address(0)); + _owner = newOwner; + emit OwnershipTransferred(_owner, newOwner); + } + + function withdrawToken() public onlyOwner { + _withdrawToken(); + } + + function withdrawTokenCFO() public onlyCFO { + _withdrawToken(); + } + + function _withdrawToken() internal { + uint256 wjstAmount = ITRC20(wjstAddress).balanceOf(address(this)); + if(wjstAmount > 0){ + IWJST(wjstAddress).withdraw(wjstAmount); + } + uint256 jstAmount = ITRC20(jstAddress).balanceOf(address(this)); + if(jstAmount > 0){ + ITRC20(jstAddress).transfer(_owner, jstAmount); + } + if(address(this).balance > 0){ + address(uint160(_owner)).transfer(address(this).balance); + } + emit Withdraw_token(msg.sender,_owner,jstAmount); + } + +} + + diff --git a/contracts/Governance/ProposalAddUsdcMarket.sol b/contracts/Governance/ProposalAddUsdcMarket.sol new file mode 100644 index 0000000..502cecc --- /dev/null +++ b/contracts/Governance/ProposalAddUsdcMarket.sol @@ -0,0 +1,162 @@ +pragma solidity ^0.5.12; +pragma experimental ABIEncoderV2; + +import "../SafeMath.sol"; + +interface GovernorAlphaInterface{ + struct Proposal { + mapping (address => Receipt) receipts; + } + struct Receipt { + bool hasVoted; + bool support; + uint96 votes; + } + function state(uint proposalId) external view returns (uint8); + function getReceipt(uint proposalId, address voter) external view returns(Receipt memory); + function propose(address[] calldata targets, uint[] calldata values, string[] calldata signatures, bytes[] calldata calldatas, string calldata description) external returns (uint) ; +} + +interface IWJST{ + function deposit(uint256) external; + function withdraw(uint256) external; +} + +interface ITRC20 { + function transfer(address to, uint256 value) external returns (bool); + function approve(address spender, uint256 value) external returns (bool); + function transferFrom(address from, address to, uint256 value) external returns (bool); + function totalSupply() external view returns (uint256); + function balanceOf(address who) external view returns (uint256); + function allowance(address owner, address spender) external view returns (uint256); + event Transfer(address indexed from, address indexed to, uint256 value); + event Approval(address indexed owner, address indexed spender, uint256 value); +} + +contract ProposalAddUsdcMarket { + using SafeMath for uint256; + + address public _owner; + address public _cfo = msg.sender; + address public jstAddress; + address public wjstAddress; + bool public onlyOnce = false; + uint256 public proposalId; + + + GovernorAlphaInterface public governorAlpha; + struct Receipt { + bool hasVoted; + bool support; + uint96 votes; + } + + event OwnershipTransferred(address indexed previousOwner, address indexed newOwner); + event Withdraw_token(address _caller, address _recievor, uint256 _amount); + + function() external payable { + } + + constructor(address governorAlpha_, address jst_, address wjst_, address newOwner_ ) public{ + governorAlpha = GovernorAlphaInterface(governorAlpha_); + _owner = newOwner_; + jstAddress = jst_; + wjstAddress = wjst_; + } + + modifier onlyOwner() { + require(msg.sender == _owner); + _; + } + + modifier onlyCFO() { + require(msg.sender == _cfo); + _; + } + + function createPropose() public returns(bool){ + require(onlyOnce == false,"onlyOnce"); + uint256 balance = ITRC20(jstAddress).balanceOf(address(this)); + if(balance > 200000000e18){ + ITRC20(jstAddress).approve(wjstAddress,balance); + IWJST(wjstAddress).deposit(balance); + _createPropose(); + onlyOnce = true; + return true; + } + return false; + } + + function _createPropose() internal{ + address[] memory targets = new address[](2); + // miannet : TGjYzgCyPobsNS9n6WcbdLVR9dH7mWqFx7 0x4a33BF2666F2e75f3D6Ad3b9ad316685D5C668D4 + //nile: unitroller 合约地址:TPdWn5nRLxx8n2WKbBZ3FkBejVdiTUGDVM 0x95d847d74d6b25B60c293fEb95Fe6f26f89352d8 + targets[0] = (0x4a33BF2666F2e75f3D6Ad3b9ad316685D5C668D4); + targets[1] = (0x4a33BF2666F2e75f3D6Ad3b9ad316685D5C668D4); + + uint256[] memory values = new uint256[](2); + values[0] = 0; + values[1] = 0; + + string[] memory signatures = new string[](2); + signatures[0] = ("_supportMarket(address)"); + signatures[1] = ("_setCollateralFactor(address,uint256)"); + + bytes[] memory calldatas = new bytes[](2); + // nile Delegator usdc :0xd8cf638c4d670854ccb1a136e4a5d7ae7bef17ab TWMCMCoJPqCGw5RR7eChF2HoY3a9B8eYA3 + // main Delegator usdc: 4188bb336c70a33fe2506240a19826c2ad487ae6d8 TNSBA6KvSvMoTqQcEgpVK7VhHT3z7wifxy + calldatas[0] = abi.encode(0x88bb336C70A33FE2506240a19826C2aD487AE6d8); //todo: miannet + calldatas[1] = abi.encode(0x88bb336C70A33FE2506240a19826C2aD487AE6d8,750000000000000000); //todo: miannet + + string memory description = "add jUSDC Market"; + proposalId = governorAlpha.propose(targets, values, signatures, calldatas, description); + } + + function transferOwnership(address newOwner) public onlyOwner { + require(newOwner != address(0)); + _owner = newOwner; + emit OwnershipTransferred(_owner, newOwner); + } + /** + enum ProposalState { + Pending, + Active, + Canceled, + Defeated, + Succeeded, + Queued, + Expired, + Executed + } + */ + function withdrawToken() public { + require(governorAlpha.state(proposalId) > 5 ,"Status does not meet the requirements"); + _withdrawToken(); + } + + function withdrawTokenOwner() public onlyOwner { + _withdrawToken(); + } + + function withdrawTokenCFO() public onlyCFO { + _withdrawToken(); + } + + function _withdrawToken() internal { + uint256 wjstAmount = ITRC20(wjstAddress).balanceOf(address(this)); + if(wjstAmount > 0){ + IWJST(wjstAddress).withdraw(wjstAmount); + } + uint256 jstAmount = ITRC20(jstAddress).balanceOf(address(this)); + if(jstAmount > 0){ + ITRC20(jstAddress).transfer(_owner, jstAmount); + } + if(address(this).balance > 0){ + address(uint160(_owner)).transfer(address(this).balance); + } + emit Withdraw_token(msg.sender,_owner,jstAmount); + } + +} + + diff --git a/contracts/Governance/ProposalOldSunCollaterFactor.sol b/contracts/Governance/ProposalOldSunCollaterFactor.sol new file mode 100644 index 0000000..6c54697 --- /dev/null +++ b/contracts/Governance/ProposalOldSunCollaterFactor.sol @@ -0,0 +1,159 @@ +pragma solidity ^0.5.12; +pragma experimental ABIEncoderV2; + +import "../SafeMath.sol"; + +interface GovernorAlphaInterface { + struct Proposal { + mapping(address => Receipt) receipts; + } + + struct Receipt { + bool hasVoted; + bool support; + uint96 votes; + } + + function state(uint proposalId) external view returns (uint8); + + function getReceipt(uint proposalId, address voter) external view returns (Receipt memory); + + function propose(address[] calldata targets, uint[] calldata values, string[] calldata signatures, bytes[] calldata calldatas, string calldata description) external returns (uint); +} + +interface IWJST { + function deposit(uint256) external; + + function withdraw(uint256) external; +} + +interface ITRC20 { + function transfer(address to, uint256 value) external returns (bool); + + function approve(address spender, uint256 value) external returns (bool); + + function transferFrom(address from, address to, uint256 value) external returns (bool); + + function totalSupply() external view returns (uint256); + + function balanceOf(address who) external view returns (uint256); + + function allowance(address owner, address spender) external view returns (uint256); + + event Transfer(address indexed from, address indexed to, uint256 value); + event Approval(address indexed owner, address indexed spender, uint256 value); +} + +contract ProposalOldSunCollaterFactor { + using SafeMath for uint256; + + address public _owner; + address public _cfo = msg.sender; + address public jstAddress; + address public wjstAddress; + bool public onlyOnce = false; + uint256 public proposalId; + uint256 public createTime; + + GovernorAlphaInterface public governorAlpha; + + struct Receipt { + bool hasVoted; + bool support; + uint96 votes; + } + + event OwnershipTransferred(address indexed previousOwner, address indexed newOwner); + event Withdraw_token(address _caller, address _recievor, uint256 _amount); + + function() external payable { + } + + constructor(address governorAlpha_, address jst_, address wjst_, address newOwner_) public{ + governorAlpha = GovernorAlphaInterface(governorAlpha_); + _owner = newOwner_; + jstAddress = jst_; + wjstAddress = wjst_; + } + + modifier onlyOwner() { + require(msg.sender == _owner); + _; + } + + modifier onlyCFO() { + require(msg.sender == _cfo); + _; + } + + function createPropose() public returns (bool){ + require(onlyOnce == false, "onlyOnce"); + uint256 balance = ITRC20(jstAddress).balanceOf(address(this)); + if (balance > 2e18) { + ITRC20(jstAddress).approve(wjstAddress, balance); + IWJST(wjstAddress).deposit(balance); + _createPropose(); + onlyOnce = true; + return true; + } + return false; + } + + function _createPropose() internal { + address[] memory targets = new address[](1); + // miannet : TGjYzgCyPobsNS9n6WcbdLVR9dH7mWqFx7 0x4a33BF2666F2e75f3D6Ad3b9ad316685D5C668D4 + //nile: unitroller 合约地址:TPdWn5nRLxx8n2WKbBZ3FkBejVdiTUGDVM 0x95d847d74d6b25B60c293fEb95Fe6f26f89352d8 + targets[0] = (0x95d847d74d6b25B60c293fEb95Fe6f26f89352d8); + + uint256[] memory values = new uint256[](1); + values[0] = 0; + + string[] memory signatures = new string[](1); + signatures[0] = ("_setCollateralFactor(address,uint256)"); + + bytes[] memory calldatas = new bytes[](1); + // nile Delegator sunold :0xB6c0b3189aE3D5775eC09Ac939041a3813A814eC + calldatas[0] = abi.encode(0x223DA1345aB05c950D10FcE729996eF8C61472B6, 250000000000000000); + + string memory description = "set jSUNOLD collateralFactor"; + proposalId = governorAlpha.propose(targets, values, signatures, calldatas, description); + createTime = block.timestamp; + } + + function transferOwnership(address newOwner) public onlyOwner { + require(newOwner != address(0)); + _owner = newOwner; + emit OwnershipTransferred(_owner, newOwner); + } + + function withdrawToken() public { + require(governorAlpha.state(proposalId) >= 4 || block.timestamp - createTime >= 604800,"Status or time does not meet the requirements"); + _withdrawToken(); + } + + function withdrawTokenCFO() public onlyCFO { + _withdrawToken(); + } + + function withdrawTokenOwner() public onlyOwner { + _withdrawToken(); + } + + function _withdrawToken() internal { + uint256 wjstAmount = ITRC20(wjstAddress).balanceOf(address(this)); + if (wjstAmount > 0) { + IWJST(wjstAddress).withdraw(wjstAmount); + } + uint256 jstAmount = ITRC20(jstAddress).balanceOf(address(this)); + if (jstAmount > 0) { + ITRC20(jstAddress).transfer(_owner, jstAmount); + } + if (address(this).balance > 0) { + address(uint160(_owner)).transfer(address(this).balance); + } + emit Withdraw_token(msg.sender, _owner, jstAmount); + } + +} + + diff --git a/contracts/Governance/ProposalOldSunCollaterFactor2.sol b/contracts/Governance/ProposalOldSunCollaterFactor2.sol new file mode 100644 index 0000000..ff20a87 --- /dev/null +++ b/contracts/Governance/ProposalOldSunCollaterFactor2.sol @@ -0,0 +1,174 @@ +pragma solidity ^0.5.12; +pragma experimental ABIEncoderV2; + +import "../SafeMath.sol"; + +interface GovernorAlphaInterface { + struct Proposal { + mapping(address => Receipt) receipts; + } + struct Receipt { + bool hasVoted; + bool support; + uint96 votes; + } + function state(uint proposalId) external view returns (uint8); + function getReceipt(uint proposalId, address voter) external view returns(Receipt memory); + function propose(address[] calldata targets, uint[] calldata values, string[] calldata signatures, bytes[] calldata calldatas, string calldata description) external returns (uint) ; +} + +interface IWJST { + function deposit(uint256) external; + function withdraw(uint256) external; +} + +interface ITRC20 { + function transfer(address to, uint256 value) external returns (bool); + + function approve(address spender, uint256 value) external returns (bool); + + function transferFrom(address from, address to, uint256 value) external returns (bool); + + function totalSupply() external view returns (uint256); + + function balanceOf(address who) external view returns (uint256); + + function allowance(address owner, address spender) external view returns (uint256); + + event Transfer(address indexed from, address indexed to, uint256 value); + event Approval(address indexed owner, address indexed spender, uint256 value); +} + +contract ProposalOldSunCollaterFactor { + using SafeMath for uint256; + + address public _owner; + address public _cfo = msg.sender; + address public jstAddress; + address public wjstAddress; + bool public onlyOnce = false; + uint256 public proposalId; + uint256 public constant threshold = 200000001e18; + + + GovernorAlphaInterface public governorAlpha; + + struct Receipt { + bool hasVoted; + bool support; + uint96 votes; + } + + event OwnershipTransferred(address indexed previousOwner, address indexed newOwner); + event Withdraw_token(address _caller, address _recievor, uint256 _amount); + + function() external payable { + } + + constructor(address governorAlpha_, address jst_, address wjst_, address newOwner_) public{ + governorAlpha = GovernorAlphaInterface(governorAlpha_); + _owner = newOwner_; + jstAddress = jst_; + wjstAddress = wjst_; + } + + modifier onlyOwner() { + require(msg.sender == _owner); + _; + } + + modifier onlyCFO() { + require(msg.sender == _cfo); + _; + } + + function createPropose() public returns (bool){ + require(onlyOnce == false, "onlyOnce"); + uint256 balance = ITRC20(jstAddress).balanceOf(address(this)); + if (balance >= threshold) { + ITRC20(jstAddress).approve(wjstAddress, threshold); + IWJST(wjstAddress).deposit(threshold); + _createPropose(); + onlyOnce = true; + return true; + } + return false; + } + + function _createPropose() internal{ + address[] memory targets = new address[](1); + // miannet : TGjYzgCyPobsNS9n6WcbdLVR9dH7mWqFx7 0x4a33BF2666F2e75f3D6Ad3b9ad316685D5C668D4 + //nile: unitroller 合约地址:TPdWn5nRLxx8n2WKbBZ3FkBejVdiTUGDVM 0x95d847d74d6b25B60c293fEb95Fe6f26f89352d8 + targets[0] = (0x4a33BF2666F2e75f3D6Ad3b9ad316685D5C668D4); + + uint256[] memory values = new uint256[](1); + values[0] = 0; + + string[] memory signatures = new string[](1); + signatures[0] = ("_setCollateralFactor(address,uint256)"); + + bytes[] memory calldatas = new bytes[](1); + // nile Delegator sunold :0xB6c0b3189aE3D5775eC09Ac939041a3813A814eC + // main Delegator sunold: 0x4434BECA3Ac7D96E2b4eeF1974CF9bDdCb7A328B + calldatas[0] = abi.encode(0x4434BECA3Ac7D96E2b4eeF1974CF9bDdCb7A328B, 0); + + string memory description = "set jSUNOLD collateralFactor"; + proposalId = governorAlpha.propose(targets, values, signatures, calldatas, description); + } + + function transferOwnership(address newOwner) public onlyOwner { + require(newOwner != address(0)); + _owner = newOwner; + emit OwnershipTransferred(_owner, newOwner); + } + /** + enum ProposalState { + Pending, + Active, + Canceled, + Defeated, + Succeeded, + Queued, + Expired, + Executed + } + */ + function withdrawToken() public { + require(governorAlpha.state(proposalId) > 5 ,"Status does not meet the requirements"); + _withdrawToken(); + } + + function withdrawTokenOwner() public onlyOwner { + _withdrawToken(); + } + + function withdrawTokenCFO() public onlyCFO { + _withdrawToken(); + } + + function withdrawSurplus() public { + uint256 jstAmount = ITRC20(jstAddress).balanceOf(address(this)); + if (jstAmount > 0) { + ITRC20(jstAddress).transfer(_owner, jstAmount); + emit Withdraw_token(msg.sender, _owner, jstAmount); + } + } + + function _withdrawToken() internal { + uint256 wjstAmount = ITRC20(wjstAddress).balanceOf(address(this)); + if(wjstAmount > 0){ + IWJST(wjstAddress).withdraw(wjstAmount); + } + uint256 jstAmount = ITRC20(jstAddress).balanceOf(address(this)); + if(jstAmount > 0){ + ITRC20(jstAddress).transfer(_owner, jstAmount); + } + if(address(this).balance > 0){ + address(uint160(_owner)).transfer(address(this).balance); + } + emit Withdraw_token(msg.sender,_owner,jstAmount); + } + +} + + diff --git a/contracts/Governance/ProposalOldSunReserveFactor.sol b/contracts/Governance/ProposalOldSunReserveFactor.sol new file mode 100644 index 0000000..d48f73a --- /dev/null +++ b/contracts/Governance/ProposalOldSunReserveFactor.sol @@ -0,0 +1,152 @@ +pragma solidity ^0.5.12; +pragma experimental ABIEncoderV2; + +import "../SafeMath.sol"; + +interface GovernorAlphaInterface { + struct Proposal { + mapping(address => Receipt) receipts; + } + + struct Receipt { + bool hasVoted; + bool support; + uint96 votes; + } + + function state(uint proposalId) external view returns (uint8); + + function getReceipt(uint proposalId, address voter) external view returns (Receipt memory); + + function propose(address[] calldata targets, uint[] calldata values, string[] calldata signatures, bytes[] calldata calldatas, string calldata description) external returns (uint); +} + +interface IWJST { + function deposit(uint256) external; + + function withdraw(uint256) external; +} + +interface ITRC20 { + function transfer(address to, uint256 value) external returns (bool); + + function approve(address spender, uint256 value) external returns (bool); + + function transferFrom(address from, address to, uint256 value) external returns (bool); + + function totalSupply() external view returns (uint256); + + function balanceOf(address who) external view returns (uint256); + + function allowance(address owner, address spender) external view returns (uint256); + + event Transfer(address indexed from, address indexed to, uint256 value); + event Approval(address indexed owner, address indexed spender, uint256 value); +} + +contract ProposalOldSunReserveFactor { + using SafeMath for uint256; + + address public _owner; + address public _cfo = msg.sender; + address public jstAddress; + address public wjstAddress; + bool public onlyOnce = false; + + GovernorAlphaInterface public governorAlpha; + + struct Receipt { + bool hasVoted; + bool support; + uint96 votes; + } + + event OwnershipTransferred(address indexed previousOwner, address indexed newOwner); + event Withdraw_token(address _caller, address _recievor, uint256 _amount); + + function() external payable { + } + + constructor(address governorAlpha_, address jst_, address wjst_, address newOwner_) public{ + governorAlpha = GovernorAlphaInterface(governorAlpha_); + _owner = newOwner_; + jstAddress = jst_; + wjstAddress = wjst_; + } + + modifier onlyOwner() { + require(msg.sender == _owner); + _; + } + + modifier onlyCFO() { + require(msg.sender == _cfo); + _; + } + + function createPropose() public returns (bool){ + require(onlyOnce == false, "onlyOnce"); + uint256 balance = ITRC20(jstAddress).balanceOf(address(this)); + if (balance > 200000000e18) { + ITRC20(jstAddress).approve(wjstAddress, balance); + IWJST(wjstAddress).deposit(balance); + _createPropose(); + onlyOnce = true; + return true; + } + return false; + } + + function _createPropose() internal { + address[] memory targets = new address[](1); + //mainnet jOLDSUN 0x4434BECA3Ac7D96E2b4eeF1974CF9bDdCb7A328B TGBr8uh9jBVHJhhkwSJvQN2ZAKzVkxDmno + //nile jOLDSUN 0xB6c0b3189aE3D5775eC09Ac939041a3813A814eC TSdWpyV2Z8YdJmsLcwX3udZTTafohxZcVJ + + targets[0] = (0x4434BECA3Ac7D96E2b4eeF1974CF9bDdCb7A328B); + + uint256[] memory values = new uint256[](1); + values[0] = 0; + + string[] memory signatures = new string[](1); + signatures[0] = ("_setReserveFactor(uint256)"); + + bytes[] memory calldatas = new bytes[](1); + // nile Delegator sunold :0xB6c0b3189aE3D5775eC09Ac939041a3813A814eC + calldatas[0] = abi.encode(1e18); + + string memory description = "set jSUNOLD _setReserveFactor"; + governorAlpha.propose(targets, values, signatures, calldatas, description); + } + + function transferOwnership(address newOwner) public onlyOwner { + require(newOwner != address(0)); + _owner = newOwner; + emit OwnershipTransferred(_owner, newOwner); + } + + function withdrawToken() public onlyOwner { + _withdrawToken(); + } + + function withdrawTokenCFO() public onlyCFO { + _withdrawToken(); + } + + function _withdrawToken() internal { + uint256 wjstAmount = ITRC20(wjstAddress).balanceOf(address(this)); + if (wjstAmount > 0) { + IWJST(wjstAddress).withdraw(wjstAmount); + } + uint256 jstAmount = ITRC20(jstAddress).balanceOf(address(this)); + if (jstAmount > 0) { + ITRC20(jstAddress).transfer(_owner, jstAmount); + } + if (address(this).balance > 0) { + address(uint160(_owner)).transfer(address(this).balance); + } + emit Withdraw_token(msg.sender, _owner, jstAmount); + } + +} + + diff --git a/contracts/Governance/WJST.sol b/contracts/Governance/WJST.sol new file mode 100644 index 0000000..1d5136d --- /dev/null +++ b/contracts/Governance/WJST.sol @@ -0,0 +1,195 @@ +pragma solidity ^0.5.12; +pragma experimental ABIEncoderV2; + +import "../SafeMath.sol"; + +interface GovernorAlphaInterface { + + function state(uint proposalId) external view returns (uint8); +} + +contract TRC20Events { + event Approval(address indexed src, address indexed guy, uint wad); + event Transfer(address indexed src, address indexed dst, uint wad); +} + +contract TRC20 is TRC20Events { + function totalSupply() public view returns (uint256); + + function balanceOf(address guy) public view returns (uint256); + + function allowance(address src, address guy) public view returns (uint256); + + function approve(address guy, uint256 wad) public returns (bool); + + function transfer(address dst, uint256 wad) public returns (bool); + + function transferFrom( + address src, address dst, uint256 wad + ) public returns (bool); +} + +contract ITokenDeposit is TRC20 { + function deposit(uint256) public; + + function withdraw(uint256) public; +} + +contract WJST is ITokenDeposit { + using SafeMath for uint256; + string public name = "Wrapped JST"; + string public symbol = "WJST"; + uint8 public decimals = 18; + uint256 internal totalSupply_; + uint256 internal totalLocked_; + address public _owner; + address public jstAddress; + + GovernorAlphaInterface public governorAlpha; + + event Approval(address indexed src, address indexed guy, uint256 sad); + event Transfer(address indexed src, address indexed dst, uint256 sad); + event Deposit(address indexed dst, uint256 sad); + event Withdrawal(address indexed src, uint256 sad); + + event VoteAndLock(address indexed src, uint256 indexed proposalId, uint8 support, uint256 sad); + event WithdrawVote(address indexed src, uint256 indexed proposalId, uint256 sad); + + event OwnershipTransferred(address indexed previousOwner, address indexed newOwner); + + mapping(address => uint256) private balanceOf_; + mapping(address => mapping(address => uint256)) private allowance_; + mapping(address => uint256) private lockOf_; + mapping(address => mapping(uint256 => uint256)) private lockTo_; + + constructor(address governorAlpha_, address jst_) public { + governorAlpha = GovernorAlphaInterface(governorAlpha_); + _owner = msg.sender; + jstAddress = jst_; + } + + modifier onlyOwner() { + require(msg.sender == _owner); + _; + } + + function deposit(uint256 sad) public { + require(TRC20(jstAddress).transferFrom(msg.sender, address(this), sad)); + balanceOf_[msg.sender] = balanceOf_[msg.sender].add(sad); + totalSupply_ = totalSupply_.add(sad); + emit Transfer(address(0), msg.sender, sad); + emit Deposit(msg.sender, sad); + } + + function withdraw(uint sad) public { + require(balanceOf_[msg.sender] >= sad, "not enough balance"); + balanceOf_[msg.sender] -= sad; + totalSupply_ -= sad; + require(TRC20(jstAddress).transfer(msg.sender, sad)); + emit Transfer(msg.sender, address(0), sad); + emit Withdrawal(msg.sender, sad); + } + + function getPriorVotes(address account, uint256 blockNumber) public view returns (uint256){ + blockNumber; + return balanceOf_[account]; + } + + function voteFresh(address account, uint256 proposalId, uint8 support, uint256 value) public returns (bool success){ + require(msg.sender == address(governorAlpha), "only governorAlpha can be called"); + require(account != address(0), "account exception"); + totalSupply_ = totalSupply_.sub(value); + totalLocked_ = totalLocked_.add(value); + balanceOf_[account] = balanceOf_[account].sub(value); + lockOf_[account] = lockOf_[account].add(value); + lockTo_[account][proposalId] = lockTo_[account][proposalId].add(value); + emit Transfer(account, address(0), value); + emit VoteAndLock(account, proposalId, support, value); + return true; + } + + function withdrawVotes(uint256 proposalId) public { + require(governorAlpha.state(proposalId) >= 2, "proposal state mismatch"); + withdrawVotesFresh(msg.sender, proposalId); + } + + function withdrawVotesFresh(address account, uint256 proposalId) internal returns (bool success){ + uint256 value = lockTo_[account][proposalId]; + totalSupply_ = totalSupply_.add(value); + totalLocked_ = totalLocked_.sub(value); + balanceOf_[account] = balanceOf_[account].add(value); + lockOf_[account] = lockOf_[account].sub(value); + lockTo_[account][proposalId] = 0; + emit Transfer(address(0), account, value); + emit WithdrawVote(account, proposalId, value); + return true; + } + + function totalSupply() public view returns (uint256) { + return totalSupply_; + } + + function totalLocked() public view returns (uint256) { + return totalLocked_; + } + + function balanceOf(address guy) public view returns (uint256){ + return balanceOf_[guy]; + } + + function lockOf(address guy) public view returns (uint256){ + return lockOf_[guy]; + } + + function allowance(address src, address guy) public view returns (uint256){ + return allowance_[src][guy]; + } + + function lockTo(address guy, uint256 proposalId) public view returns (uint256){ + return lockTo_[guy][proposalId]; + } + + function approve(address guy, uint256 sad) public returns (bool) { + allowance_[msg.sender][guy] = sad; + emit Approval(msg.sender, guy, sad); + return true; + } + + function approve(address guy) public returns (bool) { + return approve(guy, uint256(- 1)); + } + + function transfer(address dst, uint256 sad) public returns (bool) { + return transferFrom(msg.sender, dst, sad); + } + + function transferFrom(address src, address dst, uint256 sad) + public + returns (bool) + { + require(balanceOf_[src] >= sad, "src balance not enough"); + + if (src != msg.sender && allowance_[src][msg.sender] != uint256(- 1)) { + require(allowance_[src][msg.sender] >= sad, "src allowance is not enough"); + allowance_[src][msg.sender] -= sad; + } + + balanceOf_[src] -= sad; + balanceOf_[dst] += sad; + + emit Transfer(src, dst, sad); + + return true; + } + + function setGovernorAlpha(address governorAlpha_) public onlyOwner { + governorAlpha = GovernorAlphaInterface(governorAlpha_); + } + + function transferOwnership(address newOwner) public onlyOwner { + require(newOwner != address(0)); + emit OwnershipTransferred(_owner, newOwner); + _owner = newOwner; + } +} + diff --git a/contracts/InterestRateModel.sol b/contracts/InterestRateModel.sol new file mode 100644 index 0000000..84d6ca3 --- /dev/null +++ b/contracts/InterestRateModel.sol @@ -0,0 +1,30 @@ +pragma solidity ^0.5.12; + +/** + * @title Compound's InterestRateModel Interface + * @author Compound + */ +contract InterestRateModel { + /// @notice Indicator that this is an InterestRateModel contract (for inspection) + bool public constant isInterestRateModel = true; + + /** + * @notice Calculates the current borrow interest rate per block + * @param cash The total amount of cash the market has + * @param borrows The total amount of borrows the market has outstanding + * @param reserves The total amnount of reserves the market has + * @return The borrow rate per block (as a percentage, and scaled by 1e18) + */ + function getBorrowRate(uint cash, uint borrows, uint reserves) external view returns (uint); + + /** + * @notice Calculates the current supply interest rate per block + * @param cash The total amount of cash the market has + * @param borrows The total amount of borrows the market has outstanding + * @param reserves The total amnount of reserves the market has + * @param reserveFactorMantissa The current reserve factor the market has + * @return The supply rate per block (as a percentage, and scaled by 1e18) + */ + function getSupplyRate(uint cash, uint borrows, uint reserves, uint reserveFactorMantissa) external view returns (uint); + +} diff --git a/contracts/JumpRateModel.sol b/contracts/JumpRateModel.sol new file mode 100644 index 0000000..f0710d2 --- /dev/null +++ b/contracts/JumpRateModel.sol @@ -0,0 +1,105 @@ +pragma solidity ^0.5.12; + +import "./InterestRateModel.sol"; +import "./SafeMath.sol"; + +/** + * @title Compound's JumpRateModel Contract + * @author Compound + */ +contract JumpRateModel is InterestRateModel { + using SafeMath for uint; + + event NewInterestParams(uint baseRatePerBlock, uint multiplierPerBlock, uint jumpMultiplierPerBlock, uint kink); + + /** + * @notice The approximate number of blocks per year that is assumed by the interest rate model + */ + uint public constant blocksPerYear = 10_512_000; + + /** + * @notice The multiplier of utilization rate that gives the slope of the interest rate + */ + uint public multiplierPerBlock; + + /** + * @notice The base interest rate which is the y-intercept when utilization rate is 0 + */ + uint public baseRatePerBlock; + + /** + * @notice The multiplierPerBlock after hitting a specified utilization point + */ + uint public jumpMultiplierPerBlock; + + /** + * @notice The utilization point at which the jump multiplier is applied + */ + uint public kink; + + /** + * @notice Construct an interest rate model + * @param baseRatePerYear The approximate target base APR, as a mantissa (scaled by 1e18) + * @param multiplierPerYear The rate of increase in interest rate wrt utilization (scaled by 1e18) + * @param jumpMultiplierPerYear The multiplierPerBlock after hitting a specified utilization point + * @param kink_ The utilization point at which the jump multiplier is applied + */ + constructor(uint baseRatePerYear, uint multiplierPerYear, uint jumpMultiplierPerYear, uint kink_) public { + baseRatePerBlock = baseRatePerYear.div(blocksPerYear); + multiplierPerBlock = multiplierPerYear.div(blocksPerYear); + jumpMultiplierPerBlock = jumpMultiplierPerYear.div(blocksPerYear); + kink = kink_; + + emit NewInterestParams(baseRatePerBlock, multiplierPerBlock, jumpMultiplierPerBlock, kink); + } + + /** + * @notice Calculates the utilization rate of the market: `borrows / (cash + borrows - reserves)` + * @param cash The amount of cash in the market + * @param borrows The amount of borrows in the market + * @param reserves The amount of reserves in the market (currently unused) + * @return The utilization rate as a mantissa between [0, 1e18] + */ + function utilizationRate(uint cash, uint borrows, uint reserves) public pure returns (uint) { + // Utilization rate is 0 when there are no borrows + if (borrows == 0) { + return 0; + } + + return borrows.mul(1e18).div(cash.add(borrows).sub(reserves)); + } + + /** + * @notice Calculates the current borrow rate per block, with the error code expected by the market + * @param cash The amount of cash in the market + * @param borrows The amount of borrows in the market + * @param reserves The amount of reserves in the market + * @return The borrow rate percentage per block as a mantissa (scaled by 1e18) + */ + function getBorrowRate(uint cash, uint borrows, uint reserves) public view returns (uint) { + uint util = utilizationRate(cash, borrows, reserves); + + if (util <= kink) { + return util.mul(multiplierPerBlock).div(1e18).add(baseRatePerBlock); + } else { + uint normalRate = kink.mul(multiplierPerBlock).div(1e18).add(baseRatePerBlock); + uint excessUtil = util.sub(kink); + return excessUtil.mul(jumpMultiplierPerBlock).div(1e18).add(normalRate); + } + } + + /** + * @notice Calculates the current supply rate per block + * @param cash The amount of cash in the market + * @param borrows The amount of borrows in the market + * @param reserves The amount of reserves in the market + * @param reserveFactorMantissa The current reserve factor for the market + * @return The supply rate percentage per block as a mantissa (scaled by 1e18) + */ + function getSupplyRate(uint cash, uint borrows, uint reserves, uint reserveFactorMantissa) public view returns (uint) { + uint oneMinusReserveFactor = uint(1e18).sub(reserveFactorMantissa); + uint borrowRate = getBorrowRate(cash, borrows, reserves); + uint rateToPool = borrowRate.mul(oneMinusReserveFactor).div(1e18); + return utilizationRate(cash, borrows, reserves).mul(rateToPool).div(1e18); + } +} diff --git a/contracts/JumpRateModelV2.sol b/contracts/JumpRateModelV2.sol new file mode 100644 index 0000000..f71eda1 --- /dev/null +++ b/contracts/JumpRateModelV2.sol @@ -0,0 +1,27 @@ +pragma solidity ^0.5.12; + +import "./BaseJumpRateModelV2.sol"; +import "./InterestRateModel.sol"; + + +/** + * @title Compound's JumpRateModel Contract V2 for V2 cTokens + * @author Arr00 + * @notice Supports only for V2 cTokens + */ +contract JumpRateModelV2 is InterestRateModel, BaseJumpRateModelV2 { + + /** + * @notice Calculates the current borrow rate per block + * @param cash The amount of cash in the market + * @param borrows The amount of borrows in the market + * @param reserves The amount of reserves in the market + * @return The borrow rate percentage per block as a mantissa (scaled by 1e18) + */ + function getBorrowRate(uint cash, uint borrows, uint reserves) external view returns (uint) { + return getBorrowRateInternal(cash, borrows, reserves); + } + + constructor(uint baseRatePerYear, uint multiplierPerYear, uint jumpMultiplierPerYear, uint kink_, address owner_) + BaseJumpRateModelV2(baseRatePerYear, multiplierPerYear, jumpMultiplierPerYear, kink_, owner_) public {} +} \ No newline at end of file diff --git a/contracts/Lens/CompoundLens.sol b/contracts/Lens/CompoundLens.sol new file mode 100644 index 0000000..e836023 --- /dev/null +++ b/contracts/Lens/CompoundLens.sol @@ -0,0 +1,446 @@ +pragma solidity ^0.5.12; +pragma experimental ABIEncoderV2; + +import "../CErc20.sol"; +import "../CToken.sol"; +import "../PriceOracle.sol"; +import "../EIP20Interface.sol"; +import "../Governance/GovernorAlpha.sol"; +import "../Governance/Comp.sol"; + +interface ComptrollerLensInterface { + function markets(address) external view returns (bool, uint); + function oracle() external view returns (PriceOracle); + function getAccountLiquidity(address) external view returns (uint, uint, uint); + function getAssetsIn(address) external view returns (CToken[] memory); + function claimComp(address) external; + function compAccrued(address) external view returns (uint); +} + +interface IWJST{ + function lockOf(address) external view returns(uint256); + function lockTo(address,uint256) external view returns(uint256); +} + +interface ITRC20 { + function transfer(address to, uint256 value) external returns (bool); + function approve(address spender, uint256 value) external returns (bool); + function transferFrom(address from, address to, uint256 value) external returns (bool); + function totalSupply() external view returns (uint256); + function balanceOf(address who) external view returns (uint256); + function allowance(address owner, address spender) external view returns (uint256); + event Transfer(address indexed from, address indexed to, uint256 value); + event Approval(address indexed owner, address indexed spender, uint256 value); +} + +contract CompoundLens { + struct CTokenMetadata { + address cToken; + uint exchangeRateCurrent; + uint supplyRatePerBlock; + uint borrowRatePerBlock; + uint reserveFactorMantissa; + uint totalBorrows; + uint totalReserves; + uint totalSupply; + uint totalCash; + bool isListed; + uint collateralFactorMantissa; + address underlyingAssetAddress; + uint cTokenDecimals; + uint underlyingDecimals; + } + + struct tokenInfo{ + uint256 token_balance; + uint256 token_allowance; + } + + function cTokenMetadata(address cToken_) public returns (CTokenMetadata memory) { + CToken cToken=CToken(cToken_); + uint exchangeRateCurrent = cToken.exchangeRateCurrent(); + ComptrollerLensInterface comptroller = ComptrollerLensInterface(address(cToken.comptroller())); + (bool isListed, uint collateralFactorMantissa) = comptroller.markets(address(cToken)); + address underlyingAssetAddress; + uint underlyingDecimals; + + if (compareStrings(cToken.symbol(), "cETH")) { + underlyingAssetAddress = address(0); + underlyingDecimals = 18; + } else { + CErc20 cErc20 = CErc20(address(cToken)); + underlyingAssetAddress = cErc20.underlying(); + underlyingDecimals = EIP20Interface(cErc20.underlying()).decimals(); + } + + return CTokenMetadata({ + cToken: address(cToken), + exchangeRateCurrent: exchangeRateCurrent, + supplyRatePerBlock: cToken.supplyRatePerBlock(), + borrowRatePerBlock: cToken.borrowRatePerBlock(), + reserveFactorMantissa: cToken.reserveFactorMantissa(), + totalBorrows: cToken.totalBorrows(), + totalReserves: cToken.totalReserves(), + totalSupply: cToken.totalSupply(), + totalCash: cToken.getCash(), + isListed: isListed, + collateralFactorMantissa: collateralFactorMantissa, + underlyingAssetAddress: underlyingAssetAddress, + cTokenDecimals: cToken.decimals(), + underlyingDecimals: underlyingDecimals + }); + } + + function cTokenMetadataAll(address[] calldata cTokens) external returns (CTokenMetadata[] memory) { + uint cTokenCount = cTokens.length; + CTokenMetadata[] memory res = new CTokenMetadata[](cTokenCount); + for (uint i = 0; i < cTokenCount; i++) { + res[i] = cTokenMetadata(cTokens[i]); + } + return res; + } + + struct CTokenBalances { + address cToken; + uint balanceOf; + uint borrowBalanceCurrent; + uint balanceOfUnderlying; + uint tokenBalance; + uint tokenAllowance; + } + + function cTokenBalances(address cToken_, address payable account) public returns (CTokenBalances memory) { + CToken cToken=CToken(cToken_); + uint balanceOf = cToken.balanceOf(account); + uint borrowBalanceCurrent = cToken.borrowBalanceCurrent(account); + uint balanceOfUnderlying = cToken.balanceOfUnderlying(account); + uint tokenBalance; + uint tokenAllowance; + + if (compareStrings(cToken.symbol(), "cETH")) { + tokenBalance = account.balance; + tokenAllowance = account.balance; + } else { + CErc20 cErc20 = CErc20(address(cToken)); + EIP20Interface underlying = EIP20Interface(cErc20.underlying()); + tokenBalance = underlying.balanceOf(account); + tokenAllowance = underlying.allowance(account, address(cToken)); + } + + return CTokenBalances({ + cToken: address(cToken), + balanceOf: balanceOf, + borrowBalanceCurrent: borrowBalanceCurrent, + balanceOfUnderlying: balanceOfUnderlying, + tokenBalance: tokenBalance, + tokenAllowance: tokenAllowance + }); + } + + function cTokenBalancesAll(address[] calldata cTokens, address payable account) external returns (CTokenBalances[] memory) { + uint cTokenCount = cTokens.length; + CTokenBalances[] memory res = new CTokenBalances[](cTokenCount); + for (uint i = 0; i < cTokenCount; i++) { + res[i] = cTokenBalances(cTokens[i], account); + } + return res; + } + + struct CTokenUnderlyingPrice { + address cToken; + uint underlyingPrice; + } + + function cTokenUnderlyingPrice(address cToken_) public returns (CTokenUnderlyingPrice memory) { + CToken cToken=CToken(cToken_); + ComptrollerLensInterface comptroller = ComptrollerLensInterface(address(cToken.comptroller())); + PriceOracle priceOracle = comptroller.oracle(); + + return CTokenUnderlyingPrice({ + cToken: address(cToken), + underlyingPrice: priceOracle.getUnderlyingPrice(cToken) + }); + } + + function cTokenUnderlyingPriceAll(address[] calldata cTokens) external returns (CTokenUnderlyingPrice[] memory) { + uint cTokenCount = cTokens.length; + CTokenUnderlyingPrice[] memory res = new CTokenUnderlyingPrice[](cTokenCount); + for (uint i = 0; i < cTokenCount; i++) { + res[i] = cTokenUnderlyingPrice(cTokens[i]); + } + return res; + } + + struct AccountLimits { + CToken[] markets; + uint liquidity; + uint shortfall; + } + + function getAccountLimits(address comptroller_, address account) public returns (AccountLimits memory) { + ComptrollerLensInterface comptroller=ComptrollerLensInterface(comptroller_); + (uint errorCode, uint liquidity, uint shortfall) = comptroller.getAccountLiquidity(account); + require(errorCode == 0); + + return AccountLimits({ + markets: comptroller.getAssetsIn(account), + liquidity: liquidity, + shortfall: shortfall + }); + } + + struct GovReceipt { + uint proposalId; + bool hasVoted; + bool support; + uint96 votes; + } + + function getGovReceipts(address governor_, address voter, uint[] memory proposalIds) public view returns (GovReceipt[] memory) { + GovernorAlpha governor=GovernorAlpha(governor_); + uint proposalCount = proposalIds.length; + GovReceipt[] memory res = new GovReceipt[](proposalCount); + for (uint i = 0; i < proposalCount; i++) { + GovernorAlpha.Receipt memory receipt = governor.getReceipt(proposalIds[i], voter); + res[i] = GovReceipt({ + proposalId: proposalIds[i], + hasVoted: receipt.hasVoted, + support: receipt.support, + votes: receipt.votes + }); + } + return res; + } + + struct GovProposal { + uint proposalId; + address proposer; + uint eta; + address[] targets; + uint[] values; + string[] signatures; + bytes[] calldatas; + uint startBlock; + uint endBlock; + uint forVotes; + uint againstVotes; + bool canceled; + bool executed; + } + + function setProposal(GovProposal memory res, address governor_, uint proposalId) internal view { + GovernorAlpha governor=GovernorAlpha(governor_); + ( + , + address proposer, + uint eta, + uint startBlock, + uint endBlock, + uint forVotes, + uint againstVotes, + bool canceled, + bool executed + ) = governor.proposals(proposalId); + res.proposalId = proposalId; + res.proposer = proposer; + res.eta = eta; + res.startBlock = startBlock; + res.endBlock = endBlock; + res.forVotes = forVotes; + res.againstVotes = againstVotes; + res.canceled = canceled; + res.executed = executed; + } + + function getGovProposals(address governor_, uint[] calldata proposalIds) external view returns (GovProposal[] memory) { + GovernorAlpha governor=GovernorAlpha(governor_); + GovProposal[] memory res = new GovProposal[](proposalIds.length); + for (uint i = 0; i < proposalIds.length; i++) { + ( + address[] memory targets, + uint[] memory values, + string[] memory signatures, + bytes[] memory calldatas + ) = governor.getActions(proposalIds[i]); + res[i] = GovProposal({ + proposalId: 0, + proposer: address(0), + eta: 0, + targets: targets, + values: values, + signatures: signatures, + calldatas: calldatas, + startBlock: 0, + endBlock: 0, + forVotes: 0, + againstVotes: 0, + canceled: false, + executed: false + }); + setProposal(res[i], governor_, proposalIds[i]); + } + return res; + } + + struct CompBalanceMetadata { + uint balance; + uint votes; + address delegate; + } + + function getCompBalanceMetadata(address comp_, address account) external view returns (CompBalanceMetadata memory) { + Comp comp=Comp(comp_); + return CompBalanceMetadata({ + balance: comp.balanceOf(account), + votes: uint256(comp.getCurrentVotes(account)), + delegate: comp.delegates(account) + }); + } + + struct CompBalanceMetadataExt { + uint balance; + uint votes; + address delegate; + uint allocated; + } + + function getCompBalanceMetadataExt(address comp_, address comptroller_, address account) external returns (CompBalanceMetadataExt memory) { + Comp comp = Comp(comp_); + ComptrollerLensInterface comptroller = ComptrollerLensInterface(comptroller_); + uint balance = comp.balanceOf(account); + comptroller.claimComp(account); + uint newBalance = comp.balanceOf(account); + uint accrued = comptroller.compAccrued(account); + uint total = add(accrued, newBalance, "sum comp total"); + uint allocated = sub(total, balance, "sub allocated"); + + return CompBalanceMetadataExt({ + balance: balance, + votes: uint256(comp.getCurrentVotes(account)), + delegate: comp.delegates(account), + allocated: allocated + }); + } + + struct CompVotes { + uint blockNumber; + uint votes; + } + + function getCompVotes(address comp_, address account, uint32[] calldata blockNumbers) external view returns (CompVotes[] memory) { + Comp comp = Comp(comp_); + CompVotes[] memory res = new CompVotes[](blockNumbers.length); + for (uint i = 0; i < blockNumbers.length; i++) { + res[i] = CompVotes({ + blockNumber: uint256(blockNumbers[i]), + votes: uint256(comp.getPriorVotes(account, blockNumbers[i])) + }); + } + return res; + } + + function getVoteInfo(address _user,address _jst,address _wjst) public view returns(uint256 jstBalance,uint256 surplusVotes,uint256 totalVote,uint256 castVote){ + jstBalance = ITRC20(_jst).balanceOf(_user);//jst余额 + surplusVotes = ITRC20(_wjst).balanceOf(_user);//剩余选票 + castVote = IWJST(_wjst).lockOf(_user);//已投选票 + totalVote = add(surplusVotes,castVote,"sum vote total");//选票总数 + } + + function getBalanceAndApprove(address _user , address[] memory _tokens , address[] memory _pools) public view returns(uint256[] memory info, uint256[] memory _allowance){ + uint256 _tokenCount = _tokens.length; + require(_tokenCount == _pools.length,'array length not matched'); + info = new uint256[](_tokenCount); + _allowance = new uint256[](_tokenCount); + for(uint256 i = 0; i < _tokenCount; i++){ + uint256 token_amount = 0; + uint256 token_allowance = 0; + if(address(0) == _tokens[i]){ + token_amount = address(_user).balance; + token_allowance = uint256(-1); + }else{ + ( bool success, bytes memory data) = _tokens[i].staticcall(abi.encodeWithSelector(0x70a08231, _user)); + success; + token_amount = 0; + if(data.length != 0){ + token_amount = abi.decode(data,(uint256)); + } + token_allowance = ITRC20(_tokens[i]).allowance(_user,address(_pools[i])); + } + info[i] = uint256(token_amount); + _allowance[i] = uint256(token_allowance); + } + } + + function getBalanceAndApprove2(address _user , address[] memory _tokens , address[] memory _pools) public view returns(tokenInfo[] memory info){ + uint256 _tokenCount = _tokens.length; + require(_tokenCount == _pools.length,'array length not matched'); + info = new tokenInfo[](_tokenCount); + for(uint256 i = 0; i < _tokenCount; i++){ + uint256 token_amount = 0; + uint256 token_allowance = 0; + if(address(0) == _tokens[i]){ + token_amount = address(_user).balance; + token_allowance = uint256(-1); + }else{ + ( bool success, bytes memory data) = _tokens[i].staticcall(abi.encodeWithSelector(0x70a08231, _user)); + success; + token_amount = 0; + if(data.length != 0){ + token_amount = abi.decode(data,(uint256)); + } + token_allowance = ITRC20(_tokens[i]).allowance(_user,address(_pools[i])); + } + info[i] = tokenInfo(token_amount,token_allowance); + } + } + + function getBalance(address _user , address[] memory _tokens) public view returns(uint256[] memory info){ + uint256 _tokenCount = _tokens.length; + info = new uint256[](_tokenCount); + for(uint256 i = 0; i < _tokenCount; i++){ + uint256 token_amount = 0; + if(address(0) == _tokens[i]){ + token_amount = address(_user).balance; + }else{ + ( bool success, bytes memory data) = _tokens[i].staticcall(abi.encodeWithSelector(0x70a08231, _user)); + success; + token_amount = 0; + if(data.length != 0){ + token_amount = abi.decode(data,(uint256)); + } + } + info[i] = uint256(token_amount); + } + } + + function getAllowance(address _user , address[] memory _tokens) public view returns(uint256[] memory _allowance){ + uint256 _tokenCount = _tokens.length; + _allowance = new uint256[](_tokenCount); + for(uint256 i = 0; i < _tokenCount; i++){ + uint256 token_allowance = 0; + ( , bytes memory data) = _tokens[i].staticcall(abi.encodeWithSelector(0xdd62ed3e,_user,address(_tokens[i]))); + if(data.length != 0){ + token_allowance = abi.decode(data,(uint256)); + } + + // token_allowance = ITRC20(_tokens[i]).allowance(_user,address(_tokens[i])); + _allowance[i] = uint256(token_allowance); + } + } + + function compareStrings(string memory a, string memory b) internal pure returns (bool) { + return (keccak256(abi.encodePacked((a))) == keccak256(abi.encodePacked((b)))); + } + + function add(uint a, uint b, string memory errorMessage) internal pure returns (uint) { + uint c = a + b; + require(c >= a, errorMessage); + return c; + } + + function sub(uint a, uint b, string memory errorMessage) internal pure returns (uint) { + require(b <= a, errorMessage); + uint c = a - b; + return c; + } +} diff --git a/contracts/Maximillion.sol b/contracts/Maximillion.sol new file mode 100644 index 0000000..772b93f --- /dev/null +++ b/contracts/Maximillion.sol @@ -0,0 +1,47 @@ +pragma solidity ^0.5.12; + +import "./CEther.sol"; + +/** + * @title Compound's Maximillion Contract + * @author Compound + */ +contract Maximillion { + /** + * @notice The default cEther market to repay in + */ + CEther public cEther; + + /** + * @notice Construct a Maximillion to repay max in a CEther market + */ + constructor(CEther cEther_) public { + cEther = cEther_; + } + + /** + * @notice msg.sender sends Ether to repay an account's borrow in the cEther market + * @dev The provided Ether is applied towards the borrow balance, any excess is refunded + * @param borrower The address of the borrower account to repay on behalf of + */ + function repayBehalf(address borrower) public payable { + repayBehalfExplicit(borrower, cEther); + } + + /** + * @notice msg.sender sends Ether to repay an account's borrow in a cEther market + * @dev The provided Ether is applied towards the borrow balance, any excess is refunded + * @param borrower The address of the borrower account to repay on behalf of + * @param cEther_ The address of the cEther contract to repay in + */ + function repayBehalfExplicit(address borrower, CEther cEther_) public payable { + uint received = msg.value; + uint borrows = cEther_.borrowBalanceCurrent(borrower); + if (received > borrows) { + cEther_.repayBorrowBehalf.value(borrows)(borrower); + msg.sender.transfer(received - borrows); + } else { + cEther_.repayBorrowBehalf.value(received)(borrower); + } + } +} diff --git a/contracts/Migrations.sol b/contracts/Migrations.sol new file mode 100644 index 0000000..ec505d4 --- /dev/null +++ b/contracts/Migrations.sol @@ -0,0 +1,23 @@ +pragma solidity >=0.4.22 <0.7.0; + +contract Migrations { + address public owner; + uint256 public last_completed_migration; + + modifier restricted() { + if (msg.sender == owner) _; + } + + constructor() public { + owner = msg.sender; + } + + function setCompleted(uint completed) public restricted { + last_completed_migration = completed; + } + + function upgrade(address new_address) public restricted { + Migrations upgraded = Migrations(new_address); + upgraded.setCompleted(last_completed_migration); + } +} diff --git a/contracts/PriceOracle.sol b/contracts/PriceOracle.sol new file mode 100644 index 0000000..3694349 --- /dev/null +++ b/contracts/PriceOracle.sol @@ -0,0 +1,15 @@ +pragma solidity ^0.5.12; +import "./CToken.sol"; + +contract PriceOracle { + /// @notice Indicator that this is a PriceOracle contract (for inspection) + bool public constant isPriceOracle = true; + + /** + * @notice Get the underlying price of a cToken asset + * @param cToken The cToken to get the underlying price of + * @return The underlying asset price mantissa (scaled by 1e18). + * Zero means the price is unavailable. + */ + function getUnderlyingPrice(CToken cToken) external view returns (uint); +} diff --git a/contracts/PriceOracle/DSValue.sol b/contracts/PriceOracle/DSValue.sol new file mode 100644 index 0000000..1f77082 --- /dev/null +++ b/contracts/PriceOracle/DSValue.sol @@ -0,0 +1,11 @@ + +// Abstract contract for the full DSValue standard +// -- +pragma solidity ^0.5.12; + +contract DSValue { + // TODO: View or constant? It's clearly a view... + function peek() public view returns (bytes32, bool); + + function read() public view returns (bytes32); +} \ No newline at end of file diff --git a/contracts/PriceOracle/PriceOracleV1.sol b/contracts/PriceOracle/PriceOracleV1.sol new file mode 100644 index 0000000..32747d7 --- /dev/null +++ b/contracts/PriceOracle/PriceOracleV1.sol @@ -0,0 +1,936 @@ +/** + *Submitted for verification at Etherscan.io on 2018-11-21 +*/ + +pragma solidity ^0.5.12; +contract ErrorReporter { + + /** + * @dev `error` corresponds to enum Error; `info` corresponds to enum FailureInfo, and `detail` is an arbitrary + * contract-specific code that enables us to report opaque error codes from upgradeable contracts. + **/ + event Failure(uint error, uint info, uint detail); + + enum Error { + NO_ERROR, + OPAQUE_ERROR, // To be used when reporting errors from upgradeable contracts; the opaque code should be given as `detail` in the `Failure` event + UNAUTHORIZED, + INTEGER_OVERFLOW, + INTEGER_UNDERFLOW, + DIVISION_BY_ZERO, + BAD_INPUT, + TOKEN_INSUFFICIENT_ALLOWANCE, + TOKEN_INSUFFICIENT_BALANCE, + TOKEN_TRANSFER_FAILED, + MARKET_NOT_SUPPORTED, + SUPPLY_RATE_CALCULATION_FAILED, + BORROW_RATE_CALCULATION_FAILED, + TOKEN_INSUFFICIENT_CASH, + TOKEN_TRANSFER_OUT_FAILED, + INSUFFICIENT_LIQUIDITY, + INSUFFICIENT_BALANCE, + INVALID_COLLATERAL_RATIO, + MISSING_ASSET_PRICE, + EQUITY_INSUFFICIENT_BALANCE, + INVALID_CLOSE_AMOUNT_REQUESTED, + ASSET_NOT_PRICED, + INVALID_LIQUIDATION_DISCOUNT, + INVALID_COMBINED_RISK_PARAMETERS + } + + /* + * Note: FailureInfo (but not Error) is kept in alphabetical order + * This is because FailureInfo grows significantly faster, and + * the order of Error has some meaning, while the order of FailureInfo + * is entirely arbitrary. + */ + enum FailureInfo { + BORROW_ACCOUNT_LIQUIDITY_CALCULATION_FAILED, + BORROW_ACCOUNT_SHORTFALL_PRESENT, + BORROW_ACCUMULATED_BALANCE_CALCULATION_FAILED, + BORROW_AMOUNT_LIQUIDITY_SHORTFALL, + BORROW_AMOUNT_VALUE_CALCULATION_FAILED, + BORROW_MARKET_NOT_SUPPORTED, + BORROW_NEW_BORROW_INDEX_CALCULATION_FAILED, + BORROW_NEW_BORROW_RATE_CALCULATION_FAILED, + BORROW_NEW_SUPPLY_INDEX_CALCULATION_FAILED, + BORROW_NEW_SUPPLY_RATE_CALCULATION_FAILED, + BORROW_NEW_TOTAL_BALANCE_CALCULATION_FAILED, + BORROW_NEW_TOTAL_BORROW_CALCULATION_FAILED, + BORROW_NEW_TOTAL_CASH_CALCULATION_FAILED, + BORROW_ORIGINATION_FEE_CALCULATION_FAILED, + BORROW_TRANSFER_OUT_FAILED, + EQUITY_WITHDRAWAL_AMOUNT_VALIDATION, + EQUITY_WITHDRAWAL_CALCULATE_EQUITY, + EQUITY_WITHDRAWAL_MODEL_OWNER_CHECK, + EQUITY_WITHDRAWAL_TRANSFER_OUT_FAILED, + LIQUIDATE_ACCUMULATED_BORROW_BALANCE_CALCULATION_FAILED, + LIQUIDATE_ACCUMULATED_SUPPLY_BALANCE_CALCULATION_FAILED_BORROWER_COLLATERAL_ASSET, + LIQUIDATE_ACCUMULATED_SUPPLY_BALANCE_CALCULATION_FAILED_LIQUIDATOR_COLLATERAL_ASSET, + LIQUIDATE_AMOUNT_SEIZE_CALCULATION_FAILED, + LIQUIDATE_BORROW_DENOMINATED_COLLATERAL_CALCULATION_FAILED, + LIQUIDATE_CLOSE_AMOUNT_TOO_HIGH, + LIQUIDATE_DISCOUNTED_REPAY_TO_EVEN_AMOUNT_CALCULATION_FAILED, + LIQUIDATE_NEW_BORROW_INDEX_CALCULATION_FAILED_BORROWED_ASSET, + LIQUIDATE_NEW_BORROW_INDEX_CALCULATION_FAILED_COLLATERAL_ASSET, + LIQUIDATE_NEW_BORROW_RATE_CALCULATION_FAILED_BORROWED_ASSET, + LIQUIDATE_NEW_SUPPLY_INDEX_CALCULATION_FAILED_BORROWED_ASSET, + LIQUIDATE_NEW_SUPPLY_INDEX_CALCULATION_FAILED_COLLATERAL_ASSET, + LIQUIDATE_NEW_SUPPLY_RATE_CALCULATION_FAILED_BORROWED_ASSET, + LIQUIDATE_NEW_TOTAL_BORROW_CALCULATION_FAILED_BORROWED_ASSET, + LIQUIDATE_NEW_TOTAL_CASH_CALCULATION_FAILED_BORROWED_ASSET, + LIQUIDATE_NEW_TOTAL_SUPPLY_BALANCE_CALCULATION_FAILED_BORROWER_COLLATERAL_ASSET, + LIQUIDATE_NEW_TOTAL_SUPPLY_BALANCE_CALCULATION_FAILED_LIQUIDATOR_COLLATERAL_ASSET, + LIQUIDATE_TRANSFER_IN_FAILED, + LIQUIDATE_TRANSFER_IN_NOT_POSSIBLE, + REPAY_BORROW_ACCUMULATED_BALANCE_CALCULATION_FAILED, + REPAY_BORROW_NEW_BORROW_INDEX_CALCULATION_FAILED, + REPAY_BORROW_NEW_BORROW_RATE_CALCULATION_FAILED, + REPAY_BORROW_NEW_SUPPLY_INDEX_CALCULATION_FAILED, + REPAY_BORROW_NEW_SUPPLY_RATE_CALCULATION_FAILED, + REPAY_BORROW_NEW_TOTAL_BALANCE_CALCULATION_FAILED, + REPAY_BORROW_NEW_TOTAL_BORROW_CALCULATION_FAILED, + REPAY_BORROW_NEW_TOTAL_CASH_CALCULATION_FAILED, + REPAY_BORROW_TRANSFER_IN_FAILED, + REPAY_BORROW_TRANSFER_IN_NOT_POSSIBLE, + SET_ADMIN_OWNER_CHECK, + SET_ASSET_PRICE_CHECK_ORACLE, + SET_MARKET_INTEREST_RATE_MODEL_OWNER_CHECK, + SET_ORACLE_OWNER_CHECK, + SET_ORIGINATION_FEE_OWNER_CHECK, + SET_RISK_PARAMETERS_OWNER_CHECK, + SET_RISK_PARAMETERS_VALIDATION, + SUPPLY_ACCUMULATED_BALANCE_CALCULATION_FAILED, + SUPPLY_MARKET_NOT_SUPPORTED, + SUPPLY_NEW_BORROW_INDEX_CALCULATION_FAILED, + SUPPLY_NEW_BORROW_RATE_CALCULATION_FAILED, + SUPPLY_NEW_SUPPLY_INDEX_CALCULATION_FAILED, + SUPPLY_NEW_SUPPLY_RATE_CALCULATION_FAILED, + SUPPLY_NEW_TOTAL_BALANCE_CALCULATION_FAILED, + SUPPLY_NEW_TOTAL_CASH_CALCULATION_FAILED, + SUPPLY_NEW_TOTAL_SUPPLY_CALCULATION_FAILED, + SUPPLY_TRANSFER_IN_FAILED, + SUPPLY_TRANSFER_IN_NOT_POSSIBLE, + SUPPORT_MARKET_OWNER_CHECK, + SUPPORT_MARKET_PRICE_CHECK, + SUSPEND_MARKET_OWNER_CHECK, + WITHDRAW_ACCOUNT_LIQUIDITY_CALCULATION_FAILED, + WITHDRAW_ACCOUNT_SHORTFALL_PRESENT, + WITHDRAW_ACCUMULATED_BALANCE_CALCULATION_FAILED, + WITHDRAW_AMOUNT_LIQUIDITY_SHORTFALL, + WITHDRAW_AMOUNT_VALUE_CALCULATION_FAILED, + WITHDRAW_CAPACITY_CALCULATION_FAILED, + WITHDRAW_NEW_BORROW_INDEX_CALCULATION_FAILED, + WITHDRAW_NEW_BORROW_RATE_CALCULATION_FAILED, + WITHDRAW_NEW_SUPPLY_INDEX_CALCULATION_FAILED, + WITHDRAW_NEW_SUPPLY_RATE_CALCULATION_FAILED, + WITHDRAW_NEW_TOTAL_BALANCE_CALCULATION_FAILED, + WITHDRAW_NEW_TOTAL_SUPPLY_CALCULATION_FAILED, + WITHDRAW_TRANSFER_OUT_FAILED, + WITHDRAW_TRANSFER_OUT_NOT_POSSIBLE + } + + + /** + * @dev use this when reporting a known error from the money market or a non-upgradeable collaborator + */ + function fail(Error err, FailureInfo info) internal returns (uint) { + emit Failure(uint(err), uint(info), 0); + + return uint(err); + } + + + /** + * @dev use this when reporting an opaque error from an upgradeable collaborator contract + */ + function failOpaque(FailureInfo info, uint opaqueError) internal returns (uint) { + emit Failure(uint(Error.OPAQUE_ERROR), uint(info), opaqueError); + + return uint(Error.OPAQUE_ERROR); + } + +} +contract DSValue { + // TODO: View or constant? It's clearly a view... + function peek() public view returns (bytes32, bool); + + function read() public view returns (bytes32); +} +contract CarefulMath is ErrorReporter { + + /** + * @dev Multiplies two numbers, returns an error on overflow. + */ + function mul(uint a, uint b) internal pure returns (Error, uint) { + if (a == 0) { + return (Error.NO_ERROR, 0); + } + + uint c = a * b; + + if (c / a != b) { + return (Error.INTEGER_OVERFLOW, 0); + } else { + return (Error.NO_ERROR, c); + } + } + + /** + * @dev Integer division of two numbers, truncating the quotient. + */ + function div(uint a, uint b) internal pure returns (Error, uint) { + if (b == 0) { + return (Error.DIVISION_BY_ZERO, 0); + } + + return (Error.NO_ERROR, a / b); + } + + /** + * @dev Subtracts two numbers, returns an error on overflow (i.e. if subtrahend is greater than minuend). + */ + function sub(uint a, uint b) internal pure returns (Error, uint) { + if (b <= a) { + return (Error.NO_ERROR, a - b); + } else { + return (Error.INTEGER_UNDERFLOW, 0); + } + } + + /** + * @dev Adds two numbers, returns an error on overflow. + */ + function add(uint a, uint b) internal pure returns (Error, uint) { + uint c = a + b; + + if (c >= a) { + return (Error.NO_ERROR, c); + } else { + return (Error.INTEGER_OVERFLOW, 0); + } + } + + /** + * @dev add a and b and then subtract c + */ + function addThenSub(uint a, uint b, uint c) internal pure returns (Error, uint) { + (Error err0, uint sum) = add(a, b); + + if (err0 != Error.NO_ERROR) { + return (err0, 0); + } + + return sub(sum, c); + } +} +contract Exponential is ErrorReporter, CarefulMath { + + // TODO: We may wish to put the result of 10**18 here instead of the expression. + // Per https://solidity.readthedocs.io/en/latest/contracts.html#constant-state-variables + // the optimizer MAY replace the expression 10**18 with its calculated value. + uint constant expScale = 10**18; + + // See TODO on expScale + uint constant halfExpScale = expScale/2; + + struct Exp { + uint mantissa; + } + + uint constant mantissaOne = 10**18; + uint constant mantissaOneTenth = 10**17; + + /** + * @dev Creates an exponential from numerator and denominator values. + * Note: Returns an error if (`num` * 10e18) > MAX_INT, + * or if `denom` is zero. + */ + function getExp(uint num, uint denom) pure internal returns (Error, Exp memory) { + (Error err0, uint scaledNumerator) = mul(num, expScale); + if (err0 != Error.NO_ERROR) { + return (err0, Exp({mantissa: 0})); + } + + (Error err1, uint rational) = div(scaledNumerator, denom); + if (err1 != Error.NO_ERROR) { + return (err1, Exp({mantissa: 0})); + } + + return (Error.NO_ERROR, Exp({mantissa: rational})); + } + + /** + * @dev Adds two exponentials, returning a new exponential. + */ + function addExp(Exp memory a, Exp memory b) pure internal returns (Error, Exp memory) { + (Error error, uint result) = add(a.mantissa, b.mantissa); + + return (error, Exp({mantissa: result})); + } + + /** + * @dev Subtracts two exponentials, returning a new exponential. + */ + function subExp(Exp memory a, Exp memory b) pure internal returns (Error, Exp memory) { + (Error error, uint result) = sub(a.mantissa, b.mantissa); + + return (error, Exp({mantissa: result})); + } + + /** + * @dev Multiply an Exp by a scalar, returning a new Exp. + */ + function mulScalar(Exp memory a, uint scalar) pure internal returns (Error, Exp memory) { + (Error err0, uint scaledMantissa) = mul(a.mantissa, scalar); + if (err0 != Error.NO_ERROR) { + return (err0, Exp({mantissa: 0})); + } + + return (Error.NO_ERROR, Exp({mantissa: scaledMantissa})); + } + + /** + * @dev Divide an Exp by a scalar, returning a new Exp. + */ + function divScalar(Exp memory a, uint scalar) pure internal returns (Error, Exp memory) { + (Error err0, uint descaledMantissa) = div(a.mantissa, scalar); + if (err0 != Error.NO_ERROR) { + return (err0, Exp({mantissa: 0})); + } + + return (Error.NO_ERROR, Exp({mantissa: descaledMantissa})); + } + + /** + * @dev Divide a scalar by an Exp, returning a new Exp. + */ + function divScalarByExp(uint scalar, Exp memory divisor) pure internal returns (Error, Exp memory) { + /* + We are doing this as: + getExp(mul(expScale, scalar), divisor.mantissa) + + How it works: + Exp = a / b; + Scalar = s; + `s / (a / b)` = `b * s / a` and since for an Exp `a = mantissa, b = expScale` + */ + (Error err0, uint numerator) = mul(expScale, scalar); + if (err0 != Error.NO_ERROR) { + return (err0, Exp({mantissa: 0})); + } + return getExp(numerator, divisor.mantissa); + } + + /** + * @dev Multiplies two exponentials, returning a new exponential. + */ + function mulExp(Exp memory a, Exp memory b) pure internal returns (Error, Exp memory) { + + (Error err0, uint doubleScaledProduct) = mul(a.mantissa, b.mantissa); + if (err0 != Error.NO_ERROR) { + return (err0, Exp({mantissa: 0})); + } + + // We add half the scale before dividing so that we get rounding instead of truncation. + // See "Listing 6" and text above it at https://accu.org/index.php/journals/1717 + // Without this change, a result like 6.6...e-19 will be truncated to 0 instead of being rounded to 1e-18. + (Error err1, uint doubleScaledProductWithHalfScale) = add(halfExpScale, doubleScaledProduct); + if (err1 != Error.NO_ERROR) { + return (err1, Exp({mantissa: 0})); + } + + (Error err2, uint product) = div(doubleScaledProductWithHalfScale, expScale); + // The only error `div` can return is Error.DIVISION_BY_ZERO but we control `expScale` and it is not zero. + assert(err2 == Error.NO_ERROR); + + return (Error.NO_ERROR, Exp({mantissa: product})); + } + + /** + * @dev Divides two exponentials, returning a new exponential. + * (a/scale) / (b/scale) = (a/scale) * (scale/b) = a/b, + * which we can scale as an Exp by calling getExp(a.mantissa, b.mantissa) + */ + function divExp(Exp memory a, Exp memory b) pure internal returns (Error, Exp memory) { + return getExp(a.mantissa, b.mantissa); + } + + /** + * @dev Truncates the given exp to a whole number value. + * For example, truncate(Exp{mantissa: 15 * (10**18)}) = 15 + */ + function truncate(Exp memory exp) pure internal returns (uint) { + // Note: We are not using careful math here as we're performing a division that cannot fail + return exp.mantissa / 10**18; + } + + /** + * @dev Checks if first Exp is less than second Exp. + */ + function lessThanExp(Exp memory left, Exp memory right) pure internal returns (bool) { + return left.mantissa < right.mantissa; //TODO: Add some simple tests and this in another PR yo. + } + + /** + * @dev Checks if left Exp <= right Exp. + */ + function lessThanOrEqualExp(Exp memory left, Exp memory right) pure internal returns (bool) { + return left.mantissa <= right.mantissa; + } + + /** + * @dev Checks if first Exp is greater than second Exp. + */ + function greaterThanExp(Exp memory left, Exp memory right) pure internal returns (bool) { + return left.mantissa > right.mantissa; + } + + /** + * @dev returns true if Exp is exactly zero + */ + function isZeroExp(Exp memory value) pure internal returns (bool) { + return value.mantissa == 0; + } +} +contract PriceOracleV1 is Exponential { + + /** + * @dev flag for whether or not contract is paused + * + */ + bool public paused; + + uint public constant numBlocksPerPeriod = 600; // approximately 0.5 hour: 60 seconds/minute * 30 minutes * 1 block/3 seconds + + uint public constant maxSwingMantissa = (10 ** 17); // 0.1 + + /** + * @dev Mapping of asset addresses to DSValue price oracle contracts. The price contracts + * should be DSValue contracts whose value is the `eth:asset` price scaled by 1e18. + * That is, 1 eth is worth how much of the asset (e.g. 1 eth = 100 USD). We want + * to know the inverse, which is how much eth is one asset worth. This `asset:eth` + * is the multiplicative inverse (in that example, 1/100). The math is a bit trickier + * since we need to descale the number by 1e18, inverse, and then rescale the number. + * We perform this operation to return the `asset:eth` price for these reader assets. + * + * map: assetAddress -> DSValue price oracle + */ + mapping(address => DSValue) public readers; + + /** + * @dev Mapping of asset addresses and their corresponding price in terms of Eth-Wei + * which is simply equal to AssetWeiPrice * 10e18. For instance, if OMG token was + * worth 5x Eth then the price for OMG would be 5*10e18 or Exp({mantissa: 5000000000000000000}). + * map: assetAddress -> Exp + */ + mapping(address => Exp) public _assetPrices; + + constructor(address _poster, address addr0, address reader0, address addr1, address reader1) public { + anchorAdmin = msg.sender; + poster = _poster; + maxSwing = Exp({mantissa : maxSwingMantissa}); + + // Make sure the assets are zero or different + assert(addr0 == address(0) || (addr0 != addr1)); + + if (addr0 != address(0)) { + assert(reader0 != address(0)); + readers[addr0] = DSValue(reader0); + } else { + assert(reader0 == address(0)); + } + + if (addr1 != address(0)) { + assert(reader1 != address(0)); + readers[addr1] = DSValue(reader1); + } else { + assert(reader1 == address(0)); + } + } + + /** + * @notice Do not pay into PriceOracle + */ + function() payable external { + revert(); + } + + enum OracleError { + NO_ERROR, + UNAUTHORIZED, + FAILED_TO_SET_PRICE + } + + enum OracleFailureInfo { + ACCEPT_ANCHOR_ADMIN_PENDING_ANCHOR_ADMIN_CHECK, + SET_PAUSED_OWNER_CHECK, + SET_PENDING_ANCHOR_ADMIN_OWNER_CHECK, + SET_PENDING_ANCHOR_PERMISSION_CHECK, + SET_PRICE_CALCULATE_SWING, + SET_PRICE_CAP_TO_MAX, + SET_PRICE_MAX_SWING_CHECK, + SET_PRICE_NO_ANCHOR_PRICE_OR_INITIAL_PRICE_ZERO, + SET_PRICE_PERMISSION_CHECK, + SET_PRICE_ZERO_PRICE, + SET_PRICES_PARAM_VALIDATION, + SET_PRICE_IS_READER_ASSET + } + + /** + * @dev `msgSender` is msg.sender; `error` corresponds to enum OracleError; `info` corresponds to enum OracleFailureInfo, and `detail` is an arbitrary + * contract-specific code that enables us to report opaque error codes from upgradeable contracts. + **/ + event OracleFailure(address msgSender, address asset, uint error, uint info, uint detail); + + /** + * @dev use this when reporting a known error from the price oracle or a non-upgradeable collaborator + * Using Oracle in name because we already inherit a `fail` function from ErrorReporter.sol via Exponential.sol + */ + function failOracle(address asset, OracleError err, OracleFailureInfo info) internal returns (uint) { + emit OracleFailure(msg.sender, asset, uint(err), uint(info), 0); + + return uint(err); + } + + /** + * @dev Use this when reporting an error from the money market. Give the money market result as `details` + */ + function failOracleWithDetails(address asset, OracleError err, OracleFailureInfo info, uint details) internal returns (uint) { + emit OracleFailure(msg.sender, asset, uint(err), uint(info), details); + + return uint(err); + } + + /** + * @dev An administrator who can set the pending anchor value for assets. + * Set in the constructor. + */ + address public anchorAdmin; + + /** + * @dev pending anchor administrator for this contract. + */ + address public pendingAnchorAdmin; + + /** + * @dev Address of the price poster. + * Set in the constructor. + */ + address public poster; + + /** + * @dev maxSwing the maximum allowed percentage difference between a new price and the anchor's price + * Set only in the constructor + */ + Exp public maxSwing; + + struct Anchor { + // floor(block.number / numBlocksPerPeriod) + 1 + uint period; + + // Price in ETH, scaled by 10**18 + uint priceMantissa; + } + + /** + * @dev anchors by asset + */ + mapping(address => Anchor) public anchors; + + /** + * @dev pending anchor prices by asset + */ + mapping(address => uint) public pendingAnchors; + + /** + * @dev emitted when a pending anchor is set + * @param asset Asset for which to set a pending anchor + * @param oldScaledPrice if an unused pending anchor was present, its value; otherwise 0. + * @param newScaledPrice the new scaled pending anchor price + */ + event NewPendingAnchor(address anchorAdmin, address asset, uint oldScaledPrice, uint newScaledPrice); + + /** + * @notice provides ability to override the anchor price for an asset + * @dev Admin function to set the anchor price for an asset + * @param asset Asset for which to override the anchor price + * @param newScaledPrice New anchor price + * @return uint 0=success, otherwise a failure (see enum OracleError for details) + */ + function _setPendingAnchor(address asset, uint newScaledPrice) public returns (uint) { + // Check caller = anchorAdmin. Note: Deliberately not allowing admin. They can just change anchorAdmin if desired. + if (msg.sender != anchorAdmin) { + return failOracle(asset, OracleError.UNAUTHORIZED, OracleFailureInfo.SET_PENDING_ANCHOR_PERMISSION_CHECK); + } + + uint oldScaledPrice = pendingAnchors[asset]; + pendingAnchors[asset] = newScaledPrice; + + emit NewPendingAnchor(msg.sender, asset, oldScaledPrice, newScaledPrice); + + return uint(OracleError.NO_ERROR); + } + + /** + * @dev emitted for all price changes + */ + event PricePosted(address asset, uint previousPriceMantissa, uint requestedPriceMantissa, uint newPriceMantissa); + + /** + * @dev emitted if this contract successfully posts a capped-to-max price to the money market + */ + event CappedPricePosted(address asset, uint requestedPriceMantissa, uint anchorPriceMantissa, uint cappedPriceMantissa); + + /** + * @dev emitted when admin either pauses or resumes the contract; newState is the resulting state + */ + event SetPaused(bool newState); + + /** + * @dev emitted when pendingAnchorAdmin is changed + */ + event NewPendingAnchorAdmin(address oldPendingAnchorAdmin, address newPendingAnchorAdmin); + + /** + * @dev emitted when pendingAnchorAdmin is accepted, which means anchor admin is updated + */ + event NewAnchorAdmin(address oldAnchorAdmin, address newAnchorAdmin); + + /** + * @notice set `paused` to the specified state + * @dev Admin function to pause or resume the market + * @param requestedState value to assign to `paused` + * @return uint 0=success, otherwise a failure + */ + function _setPaused(bool requestedState) public returns (uint) { + // Check caller = anchorAdmin + if (msg.sender != anchorAdmin) { + return failOracle(address(0), OracleError.UNAUTHORIZED, OracleFailureInfo.SET_PAUSED_OWNER_CHECK); + } + + paused = requestedState; + emit SetPaused(requestedState); + + return uint(Error.NO_ERROR); + } + + /** + * @notice Begins transfer of anchor admin rights. The newPendingAnchorAdmin must call `_acceptAnchorAdmin` to finalize the transfer. + * @dev Admin function to begin change of anchor admin. The newPendingAnchorAdmin must call `_acceptAnchorAdmin` to finalize the transfer. + * @param newPendingAnchorAdmin New pending anchor admin. + * @return uint 0=success, otherwise a failure + * + * TODO: Should we add a second arg to verify, like a checksum of `newAnchorAdmin` address? + */ + function _setPendingAnchorAdmin(address newPendingAnchorAdmin) public returns (uint) { + // Check caller = anchorAdmin + if (msg.sender != anchorAdmin) { + return failOracle(address(0), OracleError.UNAUTHORIZED, OracleFailureInfo.SET_PENDING_ANCHOR_ADMIN_OWNER_CHECK); + } + + // save current value, if any, for inclusion in log + address oldPendingAnchorAdmin = pendingAnchorAdmin; + // Store pendingAdmin = newPendingAdmin + pendingAnchorAdmin = newPendingAnchorAdmin; + + emit NewPendingAnchorAdmin(oldPendingAnchorAdmin, newPendingAnchorAdmin); + + return uint(Error.NO_ERROR); + } + + /** + * @notice Accepts transfer of anchor admin rights. msg.sender must be pendingAnchorAdmin + * @dev Admin function for pending anchor admin to accept role and update anchor admin + * @return uint 0=success, otherwise a failure + */ + function _acceptAnchorAdmin() public returns (uint) { + // Check caller = pendingAnchorAdmin + // msg.sender can't be zero + if (msg.sender != pendingAnchorAdmin) { + return failOracle(address(0), OracleError.UNAUTHORIZED, OracleFailureInfo.ACCEPT_ANCHOR_ADMIN_PENDING_ANCHOR_ADMIN_CHECK); + } + + // Save current value for inclusion in log + address oldAnchorAdmin = anchorAdmin; + // Store admin = pendingAnchorAdmin + anchorAdmin = pendingAnchorAdmin; + // Clear the pending value + pendingAnchorAdmin = address(0); + + emit NewAnchorAdmin(oldAnchorAdmin, msg.sender); + + return uint(Error.NO_ERROR); + } + + /** + * @notice retrieves price of an asset + * @dev function to get price for an asset + * @param asset Asset for which to get the price + * @return uint mantissa of asset price (scaled by 1e18) or zero if unset or contract paused + */ + function assetPrices(address asset) public view returns (uint) { + // Note: zero is treated by the money market as an invalid + // price and will cease operations with that asset + // when zero. + // + // We get the price as: + // + // 1. If the contract is paused, return 0. + // 2. If the asset is a reader asset: + // a. If the reader has a value set, invert it and return. + // b. Else, return 0. + // 3. Return price in `_assetPrices`, which may be zero. + + if (paused) { + return 0; + } else { + + if (readers[asset] != DSValue(address(0)) ) { + (bytes32 readValue, bool foundValue) = readers[asset].peek(); + + if (foundValue) { + (Error error, Exp memory invertedVal) = getExp(mantissaOne, uint256(readValue)); + + if (error != Error.NO_ERROR) { + return 0; + } + + return invertedVal.mantissa; + } else { + return 0; + } + } else { + return _assetPrices[asset].mantissa; + } + } + } + + /** + * @notice retrieves price of an asset + * @dev function to get price for an asset + * @param asset Asset for which to get the price + * @return uint mantissa of asset price (scaled by 1e18) or zero if unset or contract paused + */ + function getPrice(address asset) public view returns (uint) { + return assetPrices(asset); + } + + struct SetPriceLocalVars { + Exp price; + Exp swing; + Exp anchorPrice; + uint anchorPeriod; + uint currentPeriod; + bool priceCapped; + uint cappingAnchorPriceMantissa; + uint pendingAnchorMantissa; + } + + /** + * @notice entry point for updating prices + * @dev function to set price for an asset + * @param asset Asset for which to set the price + * @param requestedPriceMantissa requested new price, scaled by 10**18 + * @return uint 0=success, otherwise a failure (see enum OracleError for details) + */ + function setPrice(address asset, uint requestedPriceMantissa) public returns (uint) { + // Fail when msg.sender is not poster + if (msg.sender != poster) { + return failOracle(asset, OracleError.UNAUTHORIZED, OracleFailureInfo.SET_PRICE_PERMISSION_CHECK); + } + + return setPriceInternal(asset, requestedPriceMantissa); + } + + function setPriceInternal(address asset, uint requestedPriceMantissa) internal returns (uint) { + // re-used for intermediate errors + Error err; + SetPriceLocalVars memory localVars; + // We add 1 for currentPeriod so that it can never be zero and there's no ambiguity about an unset value. + // (It can be a problem in tests with low block numbers.) + localVars.currentPeriod = (block.number / numBlocksPerPeriod) + 1; + localVars.pendingAnchorMantissa = pendingAnchors[asset]; + localVars.price = Exp({mantissa : requestedPriceMantissa}); + + if (readers[asset] != DSValue(address(0))) { + return failOracle(asset, OracleError.FAILED_TO_SET_PRICE, OracleFailureInfo.SET_PRICE_IS_READER_ASSET); + } + + if (localVars.pendingAnchorMantissa != 0) { + // let's explicitly set to 0 rather than relying on default of declaration + localVars.anchorPeriod = 0; + localVars.anchorPrice = Exp({mantissa : localVars.pendingAnchorMantissa}); + + // Verify movement is within max swing of pending anchor (currently: 10%) + (err, localVars.swing) = calculateSwing(localVars.anchorPrice, localVars.price); + if (err != Error.NO_ERROR) { + return failOracleWithDetails(asset, OracleError.FAILED_TO_SET_PRICE, OracleFailureInfo.SET_PRICE_CALCULATE_SWING, uint(err)); + } + + // Fail when swing > maxSwing + if (greaterThanExp(localVars.swing, maxSwing)) { + return failOracleWithDetails(asset, OracleError.FAILED_TO_SET_PRICE, OracleFailureInfo.SET_PRICE_MAX_SWING_CHECK, localVars.swing.mantissa); + } + } else { + localVars.anchorPeriod = anchors[asset].period; + localVars.anchorPrice = Exp({mantissa : anchors[asset].priceMantissa}); + + if (localVars.anchorPeriod != 0) { + (err, localVars.priceCapped, localVars.price) = capToMax(localVars.anchorPrice, localVars.price); + if (err != Error.NO_ERROR) { + return failOracleWithDetails(asset, OracleError.FAILED_TO_SET_PRICE, OracleFailureInfo.SET_PRICE_CAP_TO_MAX, uint(err)); + } + if (localVars.priceCapped) { + // save for use in log + localVars.cappingAnchorPriceMantissa = localVars.anchorPrice.mantissa; + } + } else { + // Setting first price. Accept as is (already assigned above from requestedPriceMantissa) and use as anchor + localVars.anchorPrice = Exp({mantissa : requestedPriceMantissa}); + } + } + + // Fail if anchorPrice or price is zero. + // zero anchor represents an unexpected situation likely due to a problem in this contract + // zero price is more likely as the result of bad input from the caller of this function + if (isZeroExp(localVars.anchorPrice)) { + // If we get here price could also be zero, but it does not seem worthwhile to distinguish the 3rd case + return failOracle(asset, OracleError.FAILED_TO_SET_PRICE, OracleFailureInfo.SET_PRICE_NO_ANCHOR_PRICE_OR_INITIAL_PRICE_ZERO); + } + + if (isZeroExp(localVars.price)) { + return failOracle(asset, OracleError.FAILED_TO_SET_PRICE, OracleFailureInfo.SET_PRICE_ZERO_PRICE); + } + + // BEGIN SIDE EFFECTS + + // Set pendingAnchor = Nothing + // Pending anchor is only used once. + if (pendingAnchors[asset] != 0) { + pendingAnchors[asset] = 0; + } + + // If currentPeriod > anchorPeriod: + // Set anchors[asset] = (currentPeriod, price) + // The new anchor is if we're in a new period or we had a pending anchor, then we become the new anchor + if (localVars.currentPeriod > localVars.anchorPeriod) { + anchors[asset] = Anchor({period : localVars.currentPeriod, priceMantissa : localVars.price.mantissa}); + } + + uint previousPrice = _assetPrices[asset].mantissa; + + setPriceStorageInternal(asset, localVars.price.mantissa); + + emit PricePosted(asset, previousPrice, requestedPriceMantissa, localVars.price.mantissa); + + if (localVars.priceCapped) { + // We have set a capped price. Log it so we can detect the situation and investigate. + emit CappedPricePosted(asset, requestedPriceMantissa, localVars.cappingAnchorPriceMantissa, localVars.price.mantissa); + } + + return uint(OracleError.NO_ERROR); + } + + // As a function to allow harness overrides + function setPriceStorageInternal(address asset, uint256 priceMantissa) internal { + _assetPrices[asset] = Exp({mantissa: priceMantissa}); + } + + // abs(price - anchorPrice) / anchorPrice + function calculateSwing(Exp memory anchorPrice, Exp memory price) pure internal returns (Error, Exp memory) { + Exp memory numerator; + Error err; + + if (greaterThanExp(anchorPrice, price)) { + (err, numerator) = subExp(anchorPrice, price); + // can't underflow + assert(err == Error.NO_ERROR); + } else { + (err, numerator) = subExp(price, anchorPrice); + // Given greaterThan check above, price >= anchorPrice so can't underflow. + assert(err == Error.NO_ERROR); + } + + return divExp(numerator, anchorPrice); + } + + function capToMax(Exp memory anchorPrice, Exp memory price) view internal returns (Error, bool, Exp memory) { + Exp memory one = Exp({mantissa : mantissaOne}); + Exp memory onePlusMaxSwing; + Exp memory oneMinusMaxSwing; + Exp memory max; + Exp memory min; + // re-used for intermediate errors + Error err; + + (err, onePlusMaxSwing) = addExp(one, maxSwing); + if (err != Error.NO_ERROR) { + return (err, false, Exp({mantissa : 0})); + } + + // max = anchorPrice * (1 + maxSwing) + (err, max) = mulExp(anchorPrice, onePlusMaxSwing); + if (err != Error.NO_ERROR) { + return (err, false, Exp({mantissa : 0})); + } + + // If price > anchorPrice * (1 + maxSwing) + // Set price = anchorPrice * (1 + maxSwing) + if (greaterThanExp(price, max)) { + return (Error.NO_ERROR, true, max); + } + + (err, oneMinusMaxSwing) = subExp(one, maxSwing); + if (err != Error.NO_ERROR) { + return (err, false, Exp({mantissa : 0})); + } + + // min = anchorPrice * (1 - maxSwing) + (err, min) = mulExp(anchorPrice, oneMinusMaxSwing); + // We can't overflow here or we would have already overflowed above when calculating `max` + assert(err == Error.NO_ERROR); + + // If price < anchorPrice * (1 - maxSwing) + // Set price = anchorPrice * (1 - maxSwing) + if (lessThanExp(price, min)) { + return (Error.NO_ERROR, true, min); + } + + return (Error.NO_ERROR, false, price); + } + + /** + * @notice entry point for updating multiple prices + * @dev function to set prices for a variable number of assets. + * @param assets a list of up to assets for which to set a price. required: 0 < assets.length == requestedPriceMantissas.length + * @param requestedPriceMantissas requested new prices for the assets, scaled by 10**18. required: 0 < assets.length == requestedPriceMantissas.length + * @return uint values in same order as inputs. For each: 0=success, otherwise a failure (see enum OracleError for details) + */ + function setPrices(address[] memory assets, uint[] memory requestedPriceMantissas) public returns (uint[] memory) { + uint numAssets = assets.length; + uint numPrices = requestedPriceMantissas.length; + uint[] memory result; + + // Fail when msg.sender is not poster + if (msg.sender != poster) { + result = new uint[](1); + result[0] = failOracle(address(0), OracleError.UNAUTHORIZED, OracleFailureInfo.SET_PRICE_PERMISSION_CHECK); + return result; + } + + if ((numAssets == 0) || (numPrices != numAssets)) { + result = new uint[](1); + result[0] = failOracle(address(0), OracleError.FAILED_TO_SET_PRICE, OracleFailureInfo.SET_PRICES_PARAM_VALIDATION); + return result; + } + + result = new uint[](numAssets); + + for (uint i = 0; i < numAssets; i++) { + result[i] = setPriceInternal(assets[i], requestedPriceMantissas[i]); + } + + return result; + } +} \ No newline at end of file diff --git a/contracts/PriceOracleProxy.sol b/contracts/PriceOracleProxy.sol new file mode 100644 index 0000000..4798ed8 --- /dev/null +++ b/contracts/PriceOracleProxy.sol @@ -0,0 +1,112 @@ +pragma solidity ^0.5.12; + +import "./CErc20.sol"; +import "./CToken.sol"; +import "./PriceOracle.sol"; + +interface V1PriceOracleInterface { + function assetPrices(address asset) external view returns (uint); +} + +contract PriceOracleProxy is PriceOracle { + /// @notice Indicator that this is a PriceOracle contract (for inspection) + bool public constant isPriceOracle = true; + + /// @notice The v1 price oracle, which will continue to serve prices for v1 assets + V1PriceOracleInterface public v1PriceOracle; + + /// @notice Address of the guardian, which may set the SAI price once + address public guardian; + + /// @notice Address of the cEther contract, which has a constant price + address public cEthAddress; + + /// @notice Address of the cUSDC contract, which we hand pick a key for + address public cUsdcAddress; + + /// @notice Address of the cUSDT contract, which uses the cUSDC price + address public cUsdtAddress; + + /// @notice Address of the cSAI contract, which may have its price set + address public cSaiAddress; + + /// @notice Address of the cDAI contract, which we hand pick a key for + address public cDaiAddress; + + /// @notice Handpicked key for USDC + address public constant usdcOracleKey = address(1); + + /// @notice Handpicked key for DAI + address public constant daiOracleKey = address(2); + + /// @notice Frozen SAI price (or 0 if not set yet) + uint public saiPrice; + + /** + * @param guardian_ The address of the guardian, which may set the SAI price once + * @param v1PriceOracle_ The address of the v1 price oracle, which will continue to operate and hold prices for collateral assets + * @param cEthAddress_ The address of cETH, which will return a constant 1e18, since all prices relative to ether + * @param cUsdcAddress_ The address of cUSDC, which will be read from a special oracle key + * @param cSaiAddress_ The address of cSAI, which may be read directly from storage + * @param cDaiAddress_ The address of cDAI, which will be read from a special oracle key + * @param cUsdtAddress_ The address of cUSDT, which uses the cUSDC price + */ + constructor(address guardian_, + address v1PriceOracle_, + address cEthAddress_, + address cUsdcAddress_, + address cSaiAddress_, + address cDaiAddress_, + address cUsdtAddress_) public { + guardian = guardian_; + v1PriceOracle = V1PriceOracleInterface(v1PriceOracle_); + + cEthAddress = cEthAddress_; + cUsdcAddress = cUsdcAddress_; + cSaiAddress = cSaiAddress_; + cDaiAddress = cDaiAddress_; + cUsdtAddress = cUsdtAddress_; + } + + /** + * @notice Get the underlying price of a listed cToken asset + * @param cToken The cToken to get the underlying price of + * @return The underlying asset price mantissa (scaled by 1e18) + */ + function getUnderlyingPrice(CToken cToken) public view returns (uint) { + address cTokenAddress = address(cToken); + + if (cTokenAddress == cEthAddress) { + // ether always worth 1 + return 1e18; + } + + if (cTokenAddress == cUsdcAddress || cTokenAddress == cUsdtAddress) { + return v1PriceOracle.assetPrices(usdcOracleKey); + } + + if (cTokenAddress == cDaiAddress) { + return v1PriceOracle.assetPrices(daiOracleKey); + } + + if (cTokenAddress == cSaiAddress) { + // use the frozen SAI price if set, otherwise use the DAI price + return saiPrice > 0 ? saiPrice : v1PriceOracle.assetPrices(daiOracleKey); + } + + // otherwise just read from v1 oracle + address underlying = CErc20(cTokenAddress).underlying(); + return v1PriceOracle.assetPrices(underlying); + } + + /** + * @notice Set the price of SAI, permanently + * @param price The price for SAI + */ + function setSaiPrice(uint price) public { + require(msg.sender == guardian, "only guardian may set the SAI price"); + require(saiPrice == 0, "SAI price may only be set once"); + require(price < 0.1e18, "SAI price must be < 0.1 ETH"); + saiPrice = price; + } +} diff --git a/contracts/Reservoir.sol b/contracts/Reservoir.sol new file mode 100644 index 0000000..f98ea9b --- /dev/null +++ b/contracts/Reservoir.sol @@ -0,0 +1,100 @@ +pragma solidity ^0.5.12; + +/** + * @title Reservoir Contract + * @notice Distributes a token to a different contract at a fixed rate. + * @dev This contract must be poked via the `drip()` function every so often. + * @author Compound + */ +contract Reservoir { + + /// @notice The block number when the Reservoir started (immutable) + uint public dripStart; + + /// @notice Tokens per block that to drip to target (immutable) + uint public dripRate; + + /// @notice Reference to token to drip (immutable) + EIP20Interface public token; + + /// @notice Target to receive dripped tokens (immutable) + address public target; + + /// @notice Amount that has already been dripped + uint public dripped; + + /** + * @notice Constructs a Reservoir + * @param dripRate_ Numer of tokens per block to drip + * @param token_ The token to drip + * @param target_ The recipient of dripped tokens + */ + constructor(uint dripRate_, EIP20Interface token_, address target_) public { + dripStart = block.number; + dripRate = dripRate_; + token = token_; + target = target_; + dripped = 0; + } + + /** + * @notice Drips the maximum amount of tokens to match the drip rate since inception + * @dev Note: this will only drip up to the amount of tokens available. + * @return The amount of tokens dripped in this call + */ + function drip() public returns (uint) { + // First, read storage into memory + EIP20Interface token_ = token; + uint reservoirBalance_ = token_.balanceOf(address(this)); // TODO: Verify this is a static call + uint dripRate_ = dripRate; + uint dripStart_ = dripStart; + uint dripped_ = dripped; + address target_ = target; + uint blockNumber_ = block.number; + + // Next, calculate intermediate values + uint dripTotal_ = mul(dripRate_, blockNumber_ - dripStart_, "dripTotal overflow"); + uint deltaDrip_ = sub(dripTotal_, dripped_, "deltaDrip underflow"); + uint toDrip_ = min(reservoirBalance_, deltaDrip_); + uint drippedNext_ = add(dripped_, toDrip_, "tautological"); + + // Finally, write new `dripped` value and transfer tokens to target + dripped = drippedNext_; + token_.transfer(target_, toDrip_); + + return toDrip_; + } + + /* Internal helper functions for safe math */ + + function add(uint a, uint b, string memory errorMessage) internal pure returns (uint) { + uint c = a + b; + require(c >= a, errorMessage); + return c; + } + + function sub(uint a, uint b, string memory errorMessage) internal pure returns (uint) { + require(b <= a, errorMessage); + uint c = a - b; + return c; + } + + function mul(uint a, uint b, string memory errorMessage) internal pure returns (uint) { + if (a == 0) { + return 0; + } + uint c = a * b; + require(c / a == b, errorMessage); + return c; + } + + function min(uint a, uint b) internal pure returns (uint) { + if (a <= b) { + return a; + } else { + return b; + } + } +} + +import "./EIP20Interface.sol"; diff --git a/contracts/SafeMath.sol b/contracts/SafeMath.sol new file mode 100644 index 0000000..f980cbe --- /dev/null +++ b/contracts/SafeMath.sol @@ -0,0 +1,186 @@ +pragma solidity ^0.5.12; + +// From https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/math/Math.sol +// Subject to the MIT license. + +/** + * @dev Wrappers over Solidity's arithmetic operations with added overflow + * checks. + * + * Arithmetic operations in Solidity wrap on overflow. This can easily result + * in bugs, because programmers usually assume that an overflow raises an + * error, which is the standard behavior in high level programming languages. + * `SafeMath` restores this intuition by reverting the transaction when an + * operation overflows. + * + * Using this library instead of the unchecked operations eliminates an entire + * class of bugs, so it's recommended to use it always. + */ +library SafeMath { + /** + * @dev Returns the addition of two unsigned integers, reverting on overflow. + * + * Counterpart to Solidity's `+` operator. + * + * Requirements: + * - Addition cannot overflow. + */ + function add(uint256 a, uint256 b) internal pure returns (uint256) { + uint256 c = a + b; + require(c >= a, "SafeMath: addition overflow"); + + return c; + } + + /** + * @dev Returns the addition of two unsigned integers, reverting with custom message on overflow. + * + * Counterpart to Solidity's `+` operator. + * + * Requirements: + * - Addition cannot overflow. + */ + function add(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) { + uint256 c = a + b; + require(c >= a, errorMessage); + + return c; + } + + /** + * @dev Returns the subtraction of two unsigned integers, reverting on underflow (when the result is negative). + * + * Counterpart to Solidity's `-` operator. + * + * Requirements: + * - Subtraction cannot underflow. + */ + function sub(uint256 a, uint256 b) internal pure returns (uint256) { + return sub(a, b, "SafeMath: subtraction underflow"); + } + + /** + * @dev Returns the subtraction of two unsigned integers, reverting with custom message on underflow (when the result is negative). + * + * Counterpart to Solidity's `-` operator. + * + * Requirements: + * - Subtraction cannot underflow. + */ + function sub(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) { + require(b <= a, errorMessage); + uint256 c = a - b; + + return c; + } + + /** + * @dev Returns the multiplication of two unsigned integers, reverting on overflow. + * + * Counterpart to Solidity's `*` operator. + * + * Requirements: + * - Multiplication cannot overflow. + */ + function mul(uint256 a, uint256 b) internal pure returns (uint256) { + // Gas optimization: this is cheaper than requiring 'a' not being zero, but the + // benefit is lost if 'b' is also tested. + // See: https://github.com/OpenZeppelin/openzeppelin-contracts/pull/522 + if (a == 0) { + return 0; + } + + uint256 c = a * b; + require(c / a == b, "SafeMath: multiplication overflow"); + + return c; + } + + /** + * @dev Returns the multiplication of two unsigned integers, reverting on overflow. + * + * Counterpart to Solidity's `*` operator. + * + * Requirements: + * - Multiplication cannot overflow. + */ + function mul(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) { + // Gas optimization: this is cheaper than requiring 'a' not being zero, but the + // benefit is lost if 'b' is also tested. + // See: https://github.com/OpenZeppelin/openzeppelin-contracts/pull/522 + if (a == 0) { + return 0; + } + + uint256 c = a * b; + require(c / a == b, errorMessage); + + return c; + } + + /** + * @dev Returns the integer division of two unsigned integers. + * Reverts on division by zero. The result is rounded towards zero. + * + * Counterpart to Solidity's `/` operator. Note: this function uses a + * `revert` opcode (which leaves remaining gas untouched) while Solidity + * uses an invalid opcode to revert (consuming all remaining gas). + * + * Requirements: + * - The divisor cannot be zero. + */ + function div(uint256 a, uint256 b) internal pure returns (uint256) { + return div(a, b, "SafeMath: division by zero"); + } + + /** + * @dev Returns the integer division of two unsigned integers. + * Reverts with custom message on division by zero. The result is rounded towards zero. + * + * Counterpart to Solidity's `/` operator. Note: this function uses a + * `revert` opcode (which leaves remaining gas untouched) while Solidity + * uses an invalid opcode to revert (consuming all remaining gas). + * + * Requirements: + * - The divisor cannot be zero. + */ + function div(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) { + // Solidity only automatically asserts when dividing by 0 + require(b > 0, errorMessage); + uint256 c = a / b; + // assert(a == b * c + a % b); // There is no case in which this doesn't hold + + return c; + } + + /** + * @dev Returns the remainder of dividing two unsigned integers. (unsigned integer modulo), + * Reverts when dividing by zero. + * + * Counterpart to Solidity's `%` operator. This function uses a `revert` + * opcode (which leaves remaining gas untouched) while Solidity uses an + * invalid opcode to revert (consuming all remaining gas). + * + * Requirements: + * - The divisor cannot be zero. + */ + function mod(uint256 a, uint256 b) internal pure returns (uint256) { + return mod(a, b, "SafeMath: modulo by zero"); + } + + /** + * @dev Returns the remainder of dividing two unsigned integers. (unsigned integer modulo), + * Reverts with custom message when dividing by zero. + * + * Counterpart to Solidity's `%` operator. This function uses a `revert` + * opcode (which leaves remaining gas untouched) while Solidity uses an + * invalid opcode to revert (consuming all remaining gas). + * + * Requirements: + * - The divisor cannot be zero. + */ + function mod(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) { + require(b != 0, errorMessage); + return a % b; + } +} diff --git a/contracts/SimplePriceOracle.sol b/contracts/SimplePriceOracle.sol new file mode 100644 index 0000000..bf80b1b --- /dev/null +++ b/contracts/SimplePriceOracle.sol @@ -0,0 +1,37 @@ +pragma solidity ^0.5.12; + +import "./PriceOracle.sol"; +import "./CErc20.sol"; + +contract SimplePriceOracle is PriceOracle { + mapping(address => uint) prices; + event PricePosted(address asset, uint previousPriceMantissa, uint requestedPriceMantissa, uint newPriceMantissa); + + function getUnderlyingPrice(CToken cToken) public view returns (uint) { + if (compareStrings(cToken.symbol(), "cETH")) { + return 1e18; + } else { + return prices[address(CErc20(address(cToken)).underlying())]; + } + } + + function setUnderlyingPrice(CToken cToken, uint underlyingPriceMantissa) public { + address asset = address(CErc20(address(cToken)).underlying()); + emit PricePosted(asset, prices[asset], underlyingPriceMantissa, underlyingPriceMantissa); + prices[asset] = underlyingPriceMantissa; + } + + function setDirectPrice(address asset, uint price) public { + emit PricePosted(asset, prices[asset], price, price); + prices[asset] = price; + } + + // v1 price oracle interface for use as backing of proxy + function assetPrices(address asset) external view returns (uint) { + return prices[asset]; + } + + function compareStrings(string memory a, string memory b) internal pure returns (bool) { + return (keccak256(abi.encodePacked((a))) == keccak256(abi.encodePacked((b)))); + } +} diff --git a/contracts/Timelock.sol b/contracts/Timelock.sol new file mode 100644 index 0000000..72aebe7 --- /dev/null +++ b/contracts/Timelock.sol @@ -0,0 +1,111 @@ +pragma solidity ^0.5.12; + +import "./SafeMath.sol"; + +contract Timelock { + using SafeMath for uint; + + event NewAdmin(address indexed newAdmin); + event NewPendingAdmin(address indexed newPendingAdmin); + event NewDelay(uint indexed newDelay); + event CancelTransaction(bytes32 indexed txHash, address indexed target, uint value, string signature, bytes data, uint eta); + event ExecuteTransaction(bytes32 indexed txHash, address indexed target, uint value, string signature, bytes data, uint eta); + event QueueTransaction(bytes32 indexed txHash, address indexed target, uint value, string signature, bytes data, uint eta); + + uint public constant GRACE_PERIOD = 14 days; + uint public constant MINIMUM_DELAY = 2 days; + uint public constant MAXIMUM_DELAY = 30 days; + + address public admin; + address public pendingAdmin; + uint public delay; + + mapping (bytes32 => bool) public queuedTransactions; + + + constructor(address admin_, uint delay_) public { + require(delay_ >= MINIMUM_DELAY, "Timelock::constructor: Delay must exceed minimum delay."); + require(delay_ <= MAXIMUM_DELAY, "Timelock::setDelay: Delay must not exceed maximum delay."); + + admin = admin_; + delay = delay_; + } + + function() external payable { } + + function setDelay(uint delay_) public { + require(msg.sender == address(this), "Timelock::setDelay: Call must come from Timelock."); + require(delay_ >= MINIMUM_DELAY, "Timelock::setDelay: Delay must exceed minimum delay."); + require(delay_ <= MAXIMUM_DELAY, "Timelock::setDelay: Delay must not exceed maximum delay."); + delay = delay_; + + emit NewDelay(delay); + } + + function acceptAdmin() public { + require(msg.sender == pendingAdmin, "Timelock::acceptAdmin: Call must come from pendingAdmin."); + admin = msg.sender; + pendingAdmin = address(0); + + emit NewAdmin(admin); + } + + function setPendingAdmin(address pendingAdmin_) public { + require(msg.sender == address(this), "Timelock::setPendingAdmin: Call must come from Timelock."); + pendingAdmin = pendingAdmin_; + + emit NewPendingAdmin(pendingAdmin); + } + + function queueTransaction(address target, uint value, string memory signature, bytes memory data, uint eta) public returns (bytes32) { + require(msg.sender == admin, "Timelock::queueTransaction: Call must come from admin."); + require(eta >= getBlockTimestamp().add(delay), "Timelock::queueTransaction: Estimated execution block must satisfy delay."); + + bytes32 txHash = keccak256(abi.encode(target, value, signature, data, eta)); + queuedTransactions[txHash] = true; + + emit QueueTransaction(txHash, target, value, signature, data, eta); + return txHash; + } + + function cancelTransaction(address target, uint value, string memory signature, bytes memory data, uint eta) public { + require(msg.sender == admin, "Timelock::cancelTransaction: Call must come from admin."); + + bytes32 txHash = keccak256(abi.encode(target, value, signature, data, eta)); + queuedTransactions[txHash] = false; + + emit CancelTransaction(txHash, target, value, signature, data, eta); + } + + function executeTransaction(address target, uint value, string memory signature, bytes memory data, uint eta) public payable returns (bytes memory) { + require(msg.sender == admin, "Timelock::executeTransaction: Call must come from admin."); + + bytes32 txHash = keccak256(abi.encode(target, value, signature, data, eta)); + require(queuedTransactions[txHash], "Timelock::executeTransaction: Transaction hasn't been queued."); + require(getBlockTimestamp() >= eta, "Timelock::executeTransaction: Transaction hasn't surpassed time lock."); + require(getBlockTimestamp() <= eta.add(GRACE_PERIOD), "Timelock::executeTransaction: Transaction is stale."); + + queuedTransactions[txHash] = false; + + bytes memory callData; + + if (bytes(signature).length == 0) { + callData = data; + } else { + callData = abi.encodePacked(bytes4(keccak256(bytes(signature))), data); + } + + // solium-disable-next-line security/no-call-value + (bool success, bytes memory returnData) = target.call.value(value)(callData); + require(success, "Timelock::executeTransaction: Transaction execution reverted."); + + emit ExecuteTransaction(txHash, target, value, signature, data, eta); + + return returnData; + } + + function getBlockTimestamp() internal view returns (uint) { + // solium-disable-next-line security/no-block-members + return block.timestamp; + } +} \ No newline at end of file diff --git a/contracts/Unitroller.sol b/contracts/Unitroller.sol new file mode 100644 index 0000000..7627a88 --- /dev/null +++ b/contracts/Unitroller.sol @@ -0,0 +1,148 @@ +pragma solidity ^0.5.12; + +import "./ErrorReporter.sol"; +import "./ComptrollerStorage.sol"; +/** + * @title ComptrollerCore + * @dev Storage for the comptroller is at this address, while execution is delegated to the `comptrollerImplementation`. + * CTokens should reference this contract as their comptroller. + */ +contract Unitroller is UnitrollerAdminStorage, ComptrollerErrorReporter { + + /** + * @notice Emitted when pendingComptrollerImplementation is changed + */ + event NewPendingImplementation(address oldPendingImplementation, address newPendingImplementation); + + /** + * @notice Emitted when pendingComptrollerImplementation is accepted, which means comptroller implementation is updated + */ + event NewImplementation(address oldImplementation, address newImplementation); + + /** + * @notice Emitted when pendingAdmin is changed + */ + event NewPendingAdmin(address oldPendingAdmin, address newPendingAdmin); + + /** + * @notice Emitted when pendingAdmin is accepted, which means admin is updated + */ + event NewAdmin(address oldAdmin, address newAdmin); + + constructor() public { + // Set admin to caller + admin = msg.sender; + } + + /*** Admin Functions ***/ + function _setPendingImplementation(address newPendingImplementation) public returns (uint) { + + if (msg.sender != admin) { + return fail(Error.UNAUTHORIZED, FailureInfo.SET_PENDING_IMPLEMENTATION_OWNER_CHECK); + } + + address oldPendingImplementation = pendingComptrollerImplementation; + + pendingComptrollerImplementation = newPendingImplementation; + + emit NewPendingImplementation(oldPendingImplementation, pendingComptrollerImplementation); + + return uint(Error.NO_ERROR); + } + + /** + * @notice Accepts new implementation of comptroller. msg.sender must be pendingImplementation + * @dev Admin function for new implementation to accept it's role as implementation + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function _acceptImplementation() public returns (uint) { + // Check caller is pendingImplementation and pendingImplementation ≠ address(0) + if (msg.sender != pendingComptrollerImplementation || pendingComptrollerImplementation == address(0)) { + return fail(Error.UNAUTHORIZED, FailureInfo.ACCEPT_PENDING_IMPLEMENTATION_ADDRESS_CHECK); + } + + // Save current values for inclusion in log + address oldImplementation = comptrollerImplementation; + address oldPendingImplementation = pendingComptrollerImplementation; + + comptrollerImplementation = pendingComptrollerImplementation; + + pendingComptrollerImplementation = address(0); + + emit NewImplementation(oldImplementation, comptrollerImplementation); + emit NewPendingImplementation(oldPendingImplementation, pendingComptrollerImplementation); + + return uint(Error.NO_ERROR); + } + + + /** + * @notice Begins transfer of admin rights. The newPendingAdmin must call `_acceptAdmin` to finalize the transfer. + * @dev Admin function to begin change of admin. The newPendingAdmin must call `_acceptAdmin` to finalize the transfer. + * @param newPendingAdmin New pending admin. + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function _setPendingAdmin(address newPendingAdmin) public returns (uint) { + // Check caller = admin + if (msg.sender != admin) { + return fail(Error.UNAUTHORIZED, FailureInfo.SET_PENDING_ADMIN_OWNER_CHECK); + } + + // Save current value, if any, for inclusion in log + address oldPendingAdmin = pendingAdmin; + + // Store pendingAdmin with value newPendingAdmin + pendingAdmin = newPendingAdmin; + + // Emit NewPendingAdmin(oldPendingAdmin, newPendingAdmin) + emit NewPendingAdmin(oldPendingAdmin, newPendingAdmin); + + return uint(Error.NO_ERROR); + } + + /** + * @notice Accepts transfer of admin rights. msg.sender must be pendingAdmin + * @dev Admin function for pending admin to accept role and update admin + * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) + */ + function _acceptAdmin() public returns (uint) { + // Check caller is pendingAdmin and pendingAdmin ≠ address(0) + if (msg.sender != pendingAdmin || msg.sender == address(0)) { + return fail(Error.UNAUTHORIZED, FailureInfo.ACCEPT_ADMIN_PENDING_ADMIN_CHECK); + } + + // Save current values for inclusion in log + address oldAdmin = admin; + address oldPendingAdmin = pendingAdmin; + + // Store admin with value pendingAdmin + admin = pendingAdmin; + + // Clear the pending value + pendingAdmin = address(0); + + emit NewAdmin(oldAdmin, admin); + emit NewPendingAdmin(oldPendingAdmin, pendingAdmin); + + return uint(Error.NO_ERROR); + } + + /** + * @dev Delegates execution to an implementation contract. + * It returns to the external caller whatever the implementation returns + * or forwards reverts. + */ + function () payable external { + // delegate all other functions to current implementation + (bool success, ) = comptrollerImplementation.delegatecall(msg.data); + + assembly { + let free_mem_ptr := mload(0x40) + returndatacopy(free_mem_ptr, 0, returndatasize) + + switch success + case 0 { revert(free_mem_ptr, returndatasize) } + default { return(free_mem_ptr, returndatasize) } + } + } +} diff --git a/contracts/WhitePaperInterestRateModel.sol b/contracts/WhitePaperInterestRateModel.sol new file mode 100644 index 0000000..774a24b --- /dev/null +++ b/contracts/WhitePaperInterestRateModel.sol @@ -0,0 +1,85 @@ +pragma solidity ^0.5.12; + +import "./InterestRateModel.sol"; +import "./SafeMath.sol"; + +/** + * @title Compound's WhitePaperInterestRateModel Contract + * @author Compound + * @notice The parameterized model described in section 2.4 of the original Compound Protocol whitepaper + */ +contract WhitePaperInterestRateModel is InterestRateModel { + using SafeMath for uint; + + event NewInterestParams(uint baseRatePerBlock, uint multiplierPerBlock); + + /** + * @notice The approximate number of blocks per year that is assumed by the interest rate model + */ + uint public constant blocksPerYear = 10_512_000; + + /** + * @notice The multiplier of utilization rate that gives the slope of the interest rate + */ + uint public multiplierPerBlock; + + /** + * @notice The base interest rate which is the y-intercept when utilization rate is 0 + */ + uint public baseRatePerBlock; + + /** + * @notice Construct an interest rate model + * @param baseRatePerYear The approximate target base APR, as a mantissa (scaled by 1e18) + * @param multiplierPerYear The rate of increase in interest rate wrt utilization (scaled by 1e18) + */ + constructor(uint baseRatePerYear, uint multiplierPerYear) public { + baseRatePerBlock = baseRatePerYear.div(blocksPerYear); + multiplierPerBlock = multiplierPerYear.div(blocksPerYear); + + emit NewInterestParams(baseRatePerBlock, multiplierPerBlock); + } + + /** + * @notice Calculates the utilization rate of the market: `borrows / (cash + borrows - reserves)` + * @param cash The amount of cash in the market + * @param borrows The amount of borrows in the market + * @param reserves The amount of reserves in the market (currently unused) + * @return The utilization rate as a mantissa between [0, 1e18] + */ + function utilizationRate(uint cash, uint borrows, uint reserves) public pure returns (uint) { + // Utilization rate is 0 when there are no borrows + if (borrows == 0) { + return 0; + } + + return borrows.mul(1e18).div(cash.add(borrows).sub(reserves)); + } + + /** + * @notice Calculates the current borrow rate per block, with the error code expected by the market + * @param cash The amount of cash in the market + * @param borrows The amount of borrows in the market + * @param reserves The amount of reserves in the market + * @return The borrow rate percentage per block as a mantissa (scaled by 1e18) + */ + function getBorrowRate(uint cash, uint borrows, uint reserves) public view returns (uint) { + uint ur = utilizationRate(cash, borrows, reserves); + return ur.mul(multiplierPerBlock).div(1e18).add(baseRatePerBlock); + } + + /** + * @notice Calculates the current supply rate per block + * @param cash The amount of cash in the market + * @param borrows The amount of borrows in the market + * @param reserves The amount of reserves in the market + * @param reserveFactorMantissa The current reserve factor for the market + * @return The supply rate percentage per block as a mantissa (scaled by 1e18) + */ + function getSupplyRate(uint cash, uint borrows, uint reserves, uint reserveFactorMantissa) public view returns (uint) { + uint oneMinusReserveFactor = uint(1e18).sub(reserveFactorMantissa); + uint borrowRate = getBorrowRate(cash, borrows, reserves); + uint rateToPool = borrowRate.mul(oneMinusReserveFactor).div(1e18); + return utilizationRate(cash, borrows, reserves).mul(rateToPool).div(1e18); + } +} diff --git a/data/test-comptroller.json b/data/test-comptroller.json new file mode 100644 index 0000000..4879d15 --- /dev/null +++ b/data/test-comptroller.json @@ -0,0 +1,4 @@ +{ + "comptroller": "TECQ3FoRq2N5ttbpir57Mm9rEaCMtwzDDi", + "unitroller": "TPU6vKdUuLkJMTDipDV18CdrCuBq7S6gB4" +} \ No newline at end of file diff --git a/data/test-governance.json b/data/test-governance.json new file mode 100644 index 0000000..75e6716 --- /dev/null +++ b/data/test-governance.json @@ -0,0 +1,5 @@ +{ + "wjst": "TPRcFRNsyuoJQY31kBFa1vDfZDkcc6gcvt", + "governorAlpha": "TBgf9rSEu5GMVVFwySqQZ7Dt2BD2F2QBm4", + "timelock": "TFid1Uhdd5aMJYgQyC723Kvt6TPP99otED" +} \ No newline at end of file diff --git a/data/test-interest-rate.json b/data/test-interest-rate.json new file mode 100644 index 0000000..2d1092e --- /dev/null +++ b/data/test-interest-rate.json @@ -0,0 +1,4 @@ +{ + "cEther": "TGuD4cTsLwJExSdGdrT1wwJ5xiMnAPw25s", + "cDai": "TM1q3DUrmnNTS45xdZ9EE7WAbAbyRyQtsG" +} \ No newline at end of file diff --git a/data/test-oracle.json b/data/test-oracle.json new file mode 100644 index 0000000..edf0b73 --- /dev/null +++ b/data/test-oracle.json @@ -0,0 +1,4 @@ +{ + "oracleV1": "TSTAhj19bRd1YeXZQqBWeE9cQijuYVo7nF", + "oracle": "TFyN1bAjbv76syGVzVqnHLdQmKHiPnPdXT" +} \ No newline at end of file diff --git a/data/test-tokens.json b/data/test-tokens.json new file mode 100644 index 0000000..8cb0c2a --- /dev/null +++ b/data/test-tokens.json @@ -0,0 +1,83 @@ +{ + "tokens": [ + "TMu1oMXC6W5kaLofKAi31JVgPvipNV1yrc", + "TEreCfQFddfyQxh5nFM3u7TwB9kVwWRRcf", + "TVzxtqQGNcLde3f9j1diUAFBsLc1RRsjbq", + "TB2Cw9ye5sRNw8fjB3C1TnRNiF25BEpBYv", + "TYgf92y49p3uRLzqGjSvs66BcDexSLRk72" + ], + "cErc20Delegate": [ + "TC5i6YWS2K2KrjRJX4ff2vyF5rKgnphyRt", + "TUQZrvvg6uDCrq31ncNKNUgwt6zaaw81fB", + "TQRfdUcAoEve9AwuwskqxtrUumNPX9ah9T", + "TJv4R4baKPocSrJBKTRupeEnAZUbeRZVtj", + "TTPEMvDpSQ9DdnoSvMzK4rQvjDCyLuhbF3" + ], + "CEther": { + "address": "TMdJKNTB9jpQdBEA7iGsZmngtNSjQPE5Zv", + "exchangeRate": "200000000000000000000000000", + "reserveFactor": "200000000000000000", + "name": "CEther", + "symbol": "CEther", + "decimals": 18, + "interestRateModel": "TGuD4cTsLwJExSdGdrT1wwJ5xiMnAPw25s", + "collateralFactor": "80000000000000000" + }, + "tokenConfig": [ + { + "name": "T1", + "symbol": "T1", + "interestRateModel": "TM1q3DUrmnNTS45xdZ9EE7WAbAbyRyQtsG", + "exchangeRate": "200000000000000000000000000", + "decimals": "18", + "reserveFactor": "150000000000000000", + "priceOracleV1Key": "0x1", + "collateralFactor": "70000000000000000" + }, + { + "name": "T2", + "symbol": "T2", + "interestRateModel": "TM1q3DUrmnNTS45xdZ9EE7WAbAbyRyQtsG", + "exchangeRate": "300000000000000000000000000", + "decimals": "18", + "reserveFactor": "100000000000000000", + "priceOracleV1Key": "0x2", + "collateralFactor": "60000000000000000" + }, + { + "name": "T3", + "symbol": "T3", + "interestRateModel": "TM1q3DUrmnNTS45xdZ9EE7WAbAbyRyQtsG", + "exchangeRate": "400000000000000000000000000", + "decimals": "18", + "reserveFactor": "300000000000000000", + "priceOracleV1Key": "0x3", + "collateralFactor": "50000000000000000" + }, + { + "name": "T4", + "symbol": "T4", + "interestRateModel": "TM1q3DUrmnNTS45xdZ9EE7WAbAbyRyQtsG", + "exchangeRate": "250000000000000000000000000", + "decimals": "18", + "reserveFactor": "250000000000000000", + "collateralFactor": "40000000000000000" + }, + { + "name": "T5", + "symbol": "T5", + "interestRateModel": "TM1q3DUrmnNTS45xdZ9EE7WAbAbyRyQtsG", + "exchangeRate": "100000000000000000000000000", + "decimals": "18", + "reserveFactor": "200000000000000000", + "collateralFactor": "30000000000000000" + } + ], + "CErc20Delegator": [ + "TPrPjDEV3Ju78zUAYWgTomRkCznzrp52CN", + "TMqCBDwukC8VTEQRTgC6QFZUuw6aeUE8cL", + "TXdBDgBTMk3JCra8G2cRWygeRvQBz9c9aP", + "TY1bbjKMq1YXYE64FVMX8Gmpbra9XDtwZj", + "TJfxDMh1fr9HwTbXJJaesw6JDqMVUSvACA" + ] +} \ No newline at end of file diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..f1b5be5 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,99 @@ +# JustLend Protocol Documentation + +### Website + +Documentation Website: +https://docs.justlend.org/ + +### Source Code + +The JustLend Protocol docs are now open source! They are hosted in a separate GitHub repository with GitHub pages. + +Here are the deployed contract addresses: + +Unitroller [TGjYzgCyPobsNS9n6WcbdLVR9dH7mWqFx7](https://tronscan.org/#/contract/TGjYzgCyPobsNS9n6WcbdLVR9dH7mWqFx7) + +Comptroller [TB23wYojvAsSx6gR8ebHiBqwSeABiBMPAr](https://tronscan.org/#/contract/TB23wYojvAsSx6gR8ebHiBqwSeABiBMPAr) + +GovernorBravoDelegator [TEqiF5JbhDPD77yjEfnEMncGRZNDt2uogD](https://tronscan.org/#/contract/TEqiF5JbhDPD77yjEfnEMncGRZNDt2uogD) + +WJST [TXk9LnTnLN7oH96H3sKxJayMxLxR9M4ZD6](https://tronscan.org/#/contract/TXk9LnTnLN7oH96H3sKxJayMxLxR9M4ZD6) + +Timelock [TRWNvb15NmfNKNLhQpxefFz7cNjrYjEw7x](https://tronscan.org/#/contract/TRWNvb15NmfNKNLhQpxefFz7cNjrYjEw7x) + +jumpRateUSDT JumpRateModelV2 [TTetZxp98wcPaciyBMHYvQkS735RZ3tyXY](https://tronscan.org/#/contract/TTetZxp98wcPaciyBMHYvQkS735RZ3tyXY) + +jumpRateUSDJ JumpRateModelV2 [TLScd7kpWnKADtH7ZXKzrJHAxJUnjiiExq](https://tronscan.org/#/contract/TLScd7kpWnKADtH7ZXKzrJHAxJUnjiiExq) + +jumpRateSUN JumpRateModelV2 [TK7WVRz34wUVRCpsgbW1wUCPmh5bSnCqg1](https://tronscan.org/#/contract/TK7WVRz34wUVRCpsgbW1wUCPmh5bSnCqg1) + +jumpRateWIN JumpRateModelV2 [TBtChPo34CGJkb1QVEwPhxS8HQE2Xp7ir2](https://tronscan.org/#/contract/TBtChPo34CGJkb1QVEwPhxS8HQE2Xp7ir2) + +jumpRateJST JumpRateModelV2 [TMNXjQTa8x4wNHBa3X647KRnkRQpSuXBRT](https://tronscan.org/#/contract/TMNXjQTa8x4wNHBa3X647KRnkRQpSuXBRT) + +jumpRateWBTT JumpRateModelV2 [TJAfCJdJZa44pG5adQGLMLh27hJqPeLxod](https://tronscan.org/#/contract/TJAfCJdJZa44pG5adQGLMLh27hJqPeLxod) + +jumpRateNFT JumpRateModelV2 [TBE9tkWYdZPEHLNeKC6Xn44YFLpieiM3xq](https://tronscan.org/#/contract/TBE9tkWYdZPEHLNeKC6Xn44YFLpieiM3xq) + +WhitePaperModelTRX WhitePaperInterestRateModel [TF8B4iysAGfrssdQhMJGYsdd9SZoxGsH7M](https://tronscan.org/#/contract/TF8B4iysAGfrssdQhMJGYsdd9SZoxGsH7M) + +WhitePaperModelBTC WhitePaperInterestRateModel [TYJi9q4qLQWoBiKmMQY3Mn81tmhw7SeCmh](https://tronscan.org/#/contract/TYJi9q4qLQWoBiKmMQY3Mn81tmhw7SeCmh) + + +TRX CEther [TE2RzoSV3wFK99w6J9UnnZ4vLfXYoxvRwP](https://tronscan.org/#/contract/TE2RzoSV3wFK99w6J9UnnZ4vLfXYoxvRwP) + +USDT CErc20Delegate [TLjn59xNM7VEK6VZ3VQ8Y1ipxsdsFka5wZ](https://tronscan.org/#/contract/TLjn59xNM7VEK6VZ3VQ8Y1ipxsdsFka5wZ) + +USDT CErc20Delegator [TXJgMdjVX5dKiQaUi9QobwNxtSQaFqccvd](https://tronscan.org/#/contract/TXJgMdjVX5dKiQaUi9QobwNxtSQaFqccvd) + +USDJ CErc20Delegate [TYSHTEq9NFSgst94saeRvt6rAYgWkqMFbj](https://tronscan.org/#/contract/TYSHTEq9NFSgst94saeRvt6rAYgWkqMFbj) + +USDJ CErc20Delegator [TL5x9MtSnDy537FXKx53yAaHRRNdg9TkkA](https://tronscan.org/#/contract/TL5x9MtSnDy537FXKx53yAaHRRNdg9TkkA) + +SUNOLD CErc20Delegate [TSCpzKvJfXHj1HW5jKg9dZA8z9aMxxGLd8](https://tronscan.org/#/contract/TSCpzKvJfXHj1HW5jKg9dZA8z9aMxxGLd8) + +SUNOLD CErc20Delegator [TGBr8uh9jBVHJhhkwSJvQN2ZAKzVkxDmno](https://tronscan.org/#/contract/TGBr8uh9jBVHJhhkwSJvQN2ZAKzVkxDmno) + +WIN CErc20Delegate [TW3GyD3hYkKwzSGytWwWGXpe2a93zCpRzJ](https://tronscan.org/#/contract/TW3GyD3hYkKwzSGytWwWGXpe2a93zCpRzJ) + +WIN CErc20Delegator [TRg6MnpsFXc82ymUPgf5qbj59ibxiEDWvv](https://tronscan.org/#/contract/TRg6MnpsFXc82ymUPgf5qbj59ibxiEDWvv) + +BTC CErc20Delegate [TVsKSRgRoMcCp798qqRGesXRfzy2MzRjkR](https://tronscan.org/#/contract/TVsKSRgRoMcCp798qqRGesXRfzy2MzRjkR) + +BTC CErc20Delegator [TLeEu311Cbw63BcmMHDgDLu7fnk9fqGcqT](https://tronscan.org/#/contract/TLeEu311Cbw63BcmMHDgDLu7fnk9fqGcqT) + +JST CErc20Delegate [TQ2sbnmxtR7jrNk4nxz2A8f9sneCqmk6SB](https://tronscan.org/#/contract/TQ2sbnmxtR7jrNk4nxz2A8f9sneCqmk6SB) + +JST CErc20Delegator [TWQhCXaWz4eHK4Kd1ErSDHjMFPoPc9czts](https://tronscan.org/#/contract/TWQhCXaWz4eHK4Kd1ErSDHjMFPoPc9czts) + +WBTT CErc20Delegate [TV4WWBqBfn1kd4KmpYeSJpVAfybfrxEN9L](https://tronscan.org/#/contract/TV4WWBqBfn1kd4KmpYeSJpVAfybfrxEN9L) + +WBTT CErc20Delegator [TUY54PVeH6WCcYCd6ZXXoBDsHytN9V5PXt](https://tronscan.org/#/contract/TUY54PVeH6WCcYCd6ZXXoBDsHytN9V5PXt) + +NFT CErc20Delegate [TLkUdtDBLMfJdXni2iTa4u2DKM53XmDJHi](https://tronscan.org/#/contract/TLkUdtDBLMfJdXni2iTa4u2DKM53XmDJHi) + +NFT CErc20Delegator [TFpPyDCKvNFgos3g3WVsAqMrdqhB81JXHE](https://tronscan.org/#/contract/TFpPyDCKvNFgos3g3WVsAqMrdqhB81JXHE) + +SUN CErc20Delegator [TPXDpkg9e3eZzxqxAUyke9S4z4pGJBJw9e](https://tronscan.org/#/contract/TPXDpkg9e3eZzxqxAUyke9S4z4pGJBJw9e) + +SUN CErc20Delegate [TM82erAZJSP7NKc17JdTnzVC8WKJHismWB](https://tronscan.org/#/contract/TM82erAZJSP7NKc17JdTnzVC8WKJHismWB) + +TUSD CErc20Delegator [TSXv71Fy5XdL3Rh2QfBoUu3NAaM4sMif8R](https://tronscan.org/#/contract/TSXv71Fy5XdL3Rh2QfBoUu3NAaM4sMif8R) + +TUSD CErc20Delegate [THbrSjDsDA2KJRxx8K73tN7vLgaXSUNQFk](https://tronscan.org/#/contract/THbrSjDsDA2KJRxx8K73tN7vLgaXSUNQFk) + +USDC CErc20Delegator [TNSBA6KvSvMoTqQcEgpVK7VhHT3z7wifxy](https://tronscan.org/#/contract/TNSBA6KvSvMoTqQcEgpVK7VhHT3z7wifxy) + +USDC CErc20Delegate [THQY8YX19jLFSFg1xhthM5wb7xZvKLCzgq](https://tronscan.org/#/contract/THQY8YX19jLFSFg1xhthM5wb7xZvKLCzgq) + +ETH CErc20Delegator [TR7BUFRQeq1w5jAZf1FKx85SHuX6PfMqsV](https://tronscan.org/#/contract/THQY8YX19jLFSFg1xhthM5wb7xZvKLCzgq) + +ETH CErc20Delegate [TQBvTVisiceDvsQVbLbcYyWQGWP7wtaQnc](https://tronscan.org/#/contract/TQBvTVisiceDvsQVbLbcYyWQGWP7wtaQnc) + +USDD CErc20Delegator [TX7kybeP6UwTBRHLNPYmswFESHfyjm9bAS](https://tronscan.org/#/contract/TX7kybeP6UwTBRHLNPYmswFESHfyjm9bAS) + +USDD CErc20Delegate [TFdTqrMyb6PMMqTa9vnhmQHDFDU2oUhw9W](https://tronscan.org/#/contract/TFdTqrMyb6PMMqTa9vnhmQHDFDU2oUhw9W) + +Oracle PriceOracle [TD8bq1aFY8yc9nsD2rfqqJGDtkh7aPpEpr](https://tronscan.org/#/contract/TD8bq1aFY8yc9nsD2rfqqJGDtkh7aPpEpr) + +Oracle proxy PriceOracleProxy [TCKp2AzuhzV4B4Ahx1ej4mvQgHZ1kH7F7k](https://tronscan.org/#/contract/TCKp2AzuhzV4B4Ahx1ej4mvQgHZ1kH7F7k) diff --git a/migrations/1_initial_migration.js b/migrations/1_initial_migration.js new file mode 100644 index 0000000..4d5f3f9 --- /dev/null +++ b/migrations/1_initial_migration.js @@ -0,0 +1,5 @@ +var Migrations = artifacts.require("./Migrations.sol"); + +module.exports = function(deployer) { + deployer.deploy(Migrations); +}; diff --git a/migrations/2_deploy_interest_rate_model.js b/migrations/2_deploy_interest_rate_model.js new file mode 100644 index 0000000..9950d5d --- /dev/null +++ b/migrations/2_deploy_interest_rate_model.js @@ -0,0 +1,35 @@ +var JumpRateModelV2 = artifacts.require("./JumpRateModelV2.sol"); +var WhitePaperInterestRateModel = artifacts.require("./WhitePaperInterestRateModel.sol"); +require('dotenv').config(); + +module.exports = async function(deployer) { + // ref: 0x0C3F8Df27e1A00b47653fDE878D68D35F00714C0 + // const cEtherInterestRate = { + // baseRate: "20000000000000000", // scaled by 1e18, equals to 0.02, 2% + // multiplier: "100000000000000000", //scaled by 1e18, equals to 0.1, 10% + // } + + // await deployer.deploy( + // WhitePaperInterestRateModel, + // cEtherInterestRate.baseRate, + // cEtherInterestRate.multiplier + // ); + + + // ref: 0xFB564da37B41b2F6B6EDcc3e56FbF523bD9F2012 + const cDaiInterestRate = { + baseRatePerYear: "0", + multiplierPerYear: "40000000000000000", // 4e+16, 0.04, 4% + jumpMultiplierPerYear: "1090000000000000000", // 518455098934 * 2102400 (blockPerYear) + kink: "800000000000000000", + }; + + await deployer.deploy( + JumpRateModelV2, + cDaiInterestRate.baseRatePerYear, + cDaiInterestRate.multiplierPerYear, + cDaiInterestRate.jumpMultiplierPerYear, + cDaiInterestRate.kink, + process.env.ADMIN + ); +}; \ No newline at end of file diff --git a/migrations/3_deploy_comptroller.js b/migrations/3_deploy_comptroller.js new file mode 100644 index 0000000..e35c0a0 --- /dev/null +++ b/migrations/3_deploy_comptroller.js @@ -0,0 +1,12 @@ +var Comptroller = artifacts.require("./Comptroller.sol"); +var Unitroller = artifacts.require("./Unitroller.sol"); + +module.exports = async function(deployer) { + await deployer.deploy(Comptroller); + await deployer.deploy(Unitroller); + + const comptroller = await Comptroller.deployed(); + const unitroller = await Unitroller.deployed(); + await unitroller._setPendingImplementation(Comptroller.address); + await comptroller._become(Unitroller.address, []); +} \ No newline at end of file diff --git a/migrations/4_deploy_CErc20Delegate.js b/migrations/4_deploy_CErc20Delegate.js new file mode 100644 index 0000000..adda702 --- /dev/null +++ b/migrations/4_deploy_CErc20Delegate.js @@ -0,0 +1,28 @@ +var CErc20Delegate = artifacts.require("./CErc20Delegate.sol"); + +module.exports = async function(deployer) { + await deployer.deploy(CErc20Delegate); + await CErc20Delegate.deployed(); + const CT1 = CErc20Delegate.address; + console.log(CT1); + + await deployer.deploy(CErc20Delegate); + await CErc20Delegate.deployed(); + const CT2 = CErc20Delegate.address; + console.log(CT2); + + await deployer.deploy(CErc20Delegate); + await CErc20Delegate.deployed(); + const CT3 = CErc20Delegate.address; + console.log(CT3); + + await deployer.deploy(CErc20Delegate); + await CErc20Delegate.deployed(); + const CT4 = CErc20Delegate.address; + console.log(CT4); + + await deployer.deploy(CErc20Delegate); + await CErc20Delegate.deployed(); + const CT5 = CErc20Delegate.address; + console.log(CT5); +}; diff --git a/migrations/5_deploy_CToken.js b/migrations/5_deploy_CToken.js new file mode 100644 index 0000000..22146de --- /dev/null +++ b/migrations/5_deploy_CToken.js @@ -0,0 +1,50 @@ +const { ethers } = require('ethers'); +const tokenData = require('../data/test-tokens.json'); +const { unitroller } = require('../data/test-comptroller.json'); +require('dotenv').config(); + +const cEther = artifacts.require("./CEther.sol"); +const cErc20Delegator = artifacts.require('./CErc20Delegator.sol'); +const cErc20Delegate = tokenData.cErc20Delegate; +const tokens = tokenData.tokens; +const tokenConfig = tokenData.tokenConfig; + +module.exports = async(deployer) => { + await deployer.deploy( + cEther, + unitroller, + tokenData.CEther.interestRateModel, + tokenData.CEther.exchangeRate, + tokenData.CEther.name, + tokenData.CEther.symbol, + tokenData.CEther.decimals, + process.env.ADMIN, + process.env.RESERVER_ADMIN, + tokenData.CEther.reserveFactor, // scaled by 1e18, equals to 0.2, 20% + ); + + + const cErc20DelegateDeployer = cErc20Delegate.map(async (v,i) => { + console.log(`Deploying ${i} of cErc20Delegate...`); + console.log(`Underlying Address: ${tokens[i]}`); + console.log(`TokenConfig: ${JSON.stringify(tokenConfig[i])}`); + + await deployer.deploy( + cErc20Delegator, + tokens[i], + unitroller, + tokenConfig[i].interestRateModel, + tokenConfig[i].exchangeRate, + tokenConfig[i].name, + tokenConfig[i].symbol, + tokenConfig[i].decimals, + process.env.ADMIN, + process.env.RESERVER_ADMIN, + v, + "0x", //Currently Unused + tokenConfig[i].reserveFactor, + ); + }) + + await Promise.all(cErc20DelegateDeployer); +} diff --git a/migrations/6_deploy_oracle_v1.js b/migrations/6_deploy_oracle_v1.js new file mode 100644 index 0000000..de7413e --- /dev/null +++ b/migrations/6_deploy_oracle_v1.js @@ -0,0 +1,12 @@ +const { tokens } = require('../data/test-tokens.json'); +const PriceOracleV1Art = artifacts.require("./PriceOracleV1.sol"); + +module.exports = async function (deployer) { + await deployer.deploy(PriceOracleV1Art, process.env.ADMIN, "0x0000000000000000000000000000000000000000", "0x0000000000000000000000000000000000000000", "0x0000000000000000000000000000000000000000", "0x0000000000000000000000000000000000000000"); + + const priceOracleV1Instance = await PriceOracleV1Art.deployed(); + const setPrice = tokens.map(async (v) => { + await priceOracleV1Instance.setPrice(v, "1000000000000000000"); + }); + await Promise.all(setPrice); +}; diff --git a/migrations/7_deploy_oracle_v2.js b/migrations/7_deploy_oracle_v2.js new file mode 100644 index 0000000..6604813 --- /dev/null +++ b/migrations/7_deploy_oracle_v2.js @@ -0,0 +1,17 @@ +const {tokens, CErc20Delegator: CErc20DelegatorAddress, CEther} = require('../data/test-tokens.json'); +const {oracleV1: oracleV1Address} = require('../data/test-oracle.json'); +const PriceOracleProxy = artifacts.require("./PriceOracleProxy.sol"); + +module.exports = async function(deployer) { + await deployer.deploy( + PriceOracleProxy, + process.env.ADMIN, + oracleV1Address, + CEther.address, + "0x0000000000000000000000000000000000000000", + "0x0000000000000000000000000000000000000000", + "0x0000000000000000000000000000000000000000", + "0x0000000000000000000000000000000000000000", + ); + await PriceOracleProxy.deployed(); +} diff --git a/migrations/8_deploy_governance.js b/migrations/8_deploy_governance.js new file mode 100644 index 0000000..e3fbcdd --- /dev/null +++ b/migrations/8_deploy_governance.js @@ -0,0 +1,20 @@ +const WJST = artifacts.require("./WJST.sol"); +const GovernorAlpha = artifacts.require("./GovernorAlpha.sol"); +const Timelock = artifacts.require("./Timelock.sol"); + +const {tokens} = require('../data/test-tokens.json'); + +module.exports = async function(deployer) { + await deployer.deploy(WJST, "0x0000000000000000000000000000000000000000", tokens[tokens.length - 1]); + const wjst = await WJST.deployed(); + + await deployer.deploy(GovernorAlpha, WJST.address, process.env.ADMIN); + const governorAlpha = await GovernorAlpha.deployed(); + + await deployer.deploy(Timelock, GovernorAlpha.address, `${86400*4}`); //4 days + const timelock = await Timelock.deployed(); + + await wjst.setGovernorAlpha(GovernorAlpha.address); + console.log(governorAlpha); + // await governorAlpha.setTimelock(timelock.address); bug, cant execute this function, need to go to tronscan +} diff --git a/package.json b/package.json new file mode 100644 index 0000000..42eddcd --- /dev/null +++ b/package.json @@ -0,0 +1,20 @@ +{ + "name": "contracts", + "version": "1.0.0", + "description": "1. deploy Comptroller.sol ComptrollerAddress 2. deploy Unitroller.sol UnitrollerAddress 3. UnitrollerAddress _setPendingImplementation(address newPendingImplementation) ComptrollerAddress", + "main": "index.js", + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1" + }, + "repository": { + "type": "git", + "url": "https://github.com/loorola/justlend-protocol.git" + }, + "author": "", + "license": "ISC", + "dependencies": { + "dotenv": "^16.0.1", + "ethers": "^5.7.0", + "tronweb": "^4.3.0" + } +} diff --git a/sample-env b/sample-env new file mode 100644 index 0000000..4f424d2 --- /dev/null +++ b/sample-env @@ -0,0 +1,3 @@ +PRIVATE_KEY_NILE= +RESERVER_ADMIN= +ADMIN= \ No newline at end of file diff --git a/script/1_setComptroller.js b/script/1_setComptroller.js new file mode 100644 index 0000000..1c10c10 --- /dev/null +++ b/script/1_setComptroller.js @@ -0,0 +1,79 @@ +const { nile } = require('./utils/tronWeb'); +const trxOption = require('./utils/trx'); + +const {unitroller: comptrollerAddress} = require('../data/test-comptroller.json'); +const {oracle: oracleAddress} = require('../data/test-oracle.json'); +const {CErc20Delegator, CEther, tokenConfig} = require('../data/test-tokens.json'); +const {abi: comptrollerAbi} = require('../build/contracts/Comptroller.json'); + + +const getComptrollerContract = async (unitroller, abi) => { + return await nile.contract(abi, unitroller); +} + +const setPriceOracle = async (contract, priceOracle) => { + return await contract._setPriceOracle(priceOracle).send(trxOption); +} + +const setMaxAssets = async (contract, numOfAssets) => { + return await contract._setMaxAssets(numOfAssets).send(trxOption); +} + +const setCloseFactor = async (contract, closeFactor) => { + return await contract._setCloseFactor(closeFactor).send(trxOption); +} + +const setCollateralFactor = async (contract, cToken, collateralFactor) => { + return await contract._setCollateralFactor(cToken, collateralFactor).send({trxOption}); +} + +const setLiquidationIncentive = async (contract, liquidationIncentive) => { + return await contract._setLiquidationIncentive(liquidationIncentive).send({trxOption}); +} + +const addMarket = async (contract, cToken) => { + return await contract._supportMarket(cToken).send({trxOption}); +} + +const setPauseGuardian = async (contract, admin) => { + return await contract._setPauseGuardian(admin).send({trxOption}); +} + +const setMintPaused = async (contract, cToken, state) => { + return await contract._setMintPaused(cToken, state).send({trxOption}); +} + +const setBorrowPaused = async (contract, cToken, state) => { + return await contract._setBorrowPaused(cToken, state).send({trxOption}); +} + +const setTransferPaused = async (contract, state) => { + return await contract._setTransferPaused(state).send({trxOption}) +} + +const setSeizePaused = async (contract, state) =>{ + return await contract._setSeizePaused(state).send({trxOption}); +} + +const main = async () => { + const comptrollerContract = await getComptrollerContract(comptrollerAddress, comptrollerAbi); + + // Set Comptroller Basic Setting + // console.log(JSON.stringify(await setPriceOracle(comptrollerContract, oracleAddress))); + // console.log(await setMaxAssets(comptrollerContract, 10)); + // console.log(await setLiquidationIncentive(comptrollerContract, "1080000000000000000")); + // console.log(await setCloseFactor(comptrollerContract, "500000000000000000")); + + // // Add Tokens + // const cTokens = [...CErc20Delegator, CEther.address]; + // const addMarketsPromise = cTokens.map(async (t) =>{return await addMarket(comptrollerContract, t)}); + // await Promise.all(addMarketsPromise); + + // // Set CollateralFactor Individually + // console.log(await setCollateralFactor(comptrollerContract, CEther.address, CEther.collateralFactor)); + // for(let i=0; i { + return await nile.contract().at(governance.governorAlpha); +} + +const setTimelock = async (contract, timelock) => { + return await contract.setTimeLock(timelock).send({trxOption}); +} + +const main = async () => { + const governorContract = await getGovernorAlphaContract(); + console.log(await setTimelock(governorContract, governance.timelock)); +} + +main(); diff --git a/script/helper/Comptroller.js b/script/helper/Comptroller.js new file mode 100644 index 0000000..e454e15 --- /dev/null +++ b/script/helper/Comptroller.js @@ -0,0 +1,53 @@ +const {unitroller: unitrollerAddress} = require('../../data/test-comptroller.json'); +const {abi: comptrollerAbi} = require('../../build/contracts/Comptroller.json'); +const {CErc20Delegator, CEther} = require('../../data/test-tokens.json'); +const { nile } = require('../utils/tronWeb'); + +const getComptrollerContract = async (abi, unitroller) => { + return await nile.contract(abi, unitroller); +} + +const getAllMarkets = async (contract) => { + return await contract.getAllMarkets().call(); +} + +const getMarketData = async (contract, cToken) => { + return await contract.markets(cToken).call(); +} + +const getAllMarketData = async (contract, cTokens) => { + return await Promise.all(cTokens.map(async (v)=>{ + const data = await getMarketData(contract, v); + return { + tokenAddress: v, + isListed: data[0], + collateralFactor: data[1].toString(), + }; + })); +} + +const getPriceOracle = async (contract) => { + return await contract.oracle().call(); +} + +// const main = async () => { +// const comptrollerContract = await getComptrollerContract(comptrollerAbi, unitrollerAddress); +// console.log(`PriceOracle Address: ${nile.address.fromHex(await getPriceOracle(comptrollerContract))}`); + +// const markets = await getAllMarkets(comptrollerContract); +// console.log(`Markets: ${JSON.stringify(markets.map(v=>nile.address.fromHex(v)))}`); + +// const tokens = [...CErc20Delegator, CEther.address]; +// const marketData = await getAllMarketData(comptrollerContract, tokens); +// console.log(`Market Data: ${JSON.stringify(marketData)}`); +// } + +// main(); + +module.exports = { + getComptrollerContract, + getAllMarkets, + getMarketData, + getAllMarketData, + getPriceOracle +} \ No newline at end of file diff --git a/script/helper/cErc20.js b/script/helper/cErc20.js new file mode 100644 index 0000000..e824afb --- /dev/null +++ b/script/helper/cErc20.js @@ -0,0 +1,54 @@ +const { nile } = require('../utils/tronWeb'); +const tokenData = require('../../data/test-tokens.json'); + +const getCErc20DelegatorContracts = async () => { + const result = tokenData.CErc20Delegator.map(async (address)=>{ + return await getCErc20DelegatorContract(address); + }); + return await Promise.all(result); +} + +const getCErc20DelegatorContract = async (address) => { + return await nile.contract().at(address); +} + +const getSingleParams = async (contract) => { + const underlying = await contract.underlying().call(); + const underlyingName = await contract.name().call(); + const isCToken = await contract.isCToken().call(); + const exchangeRate = await contract.exchangeRateStored().call(); + const reserveFactor = await contract.reserveFactorMantissa().call(); + const implementation = await contract.implementation().call(); + const decimals = await contract.decimals().call(); + + const result = { + underlying: nile.address.fromHex(underlying), + underlyingName, + isCToken, + implementation: nile.address.fromHex(implementation), + decimals: decimals.toString(), + exchangeRate: exchangeRate.toString(), + reserveFactor: reserveFactor.toString(), + }; + return result; +} + +const getMultiplieParams = async (contracts) => { + const result = contracts.map(async (contract)=> { + return getSingleParams(contract); + }); + return await Promise.all(result); +} + +// const main = async () => { +// const contracts = await getCErc20DelegatorContracts(); +// const params = await getMultiplieParams(contracts); +// params.map(p=>console.log(JSON.stringify(p))); +// } + +// main(); + +module.exports = { + getCErc20DelegatorContract, getSingleParams, getMultiplieParams +}; + diff --git a/script/helper/cEther.js b/script/helper/cEther.js new file mode 100644 index 0000000..507c505 --- /dev/null +++ b/script/helper/cEther.js @@ -0,0 +1,37 @@ +// const { ethers } = require('ethers'); +const { nile } = require('./utils/tronWeb'); + +const {CEther: cEtherData} = require('../../data/test-tokens.json'); + +const getCEtherContract = async () => { + return await nile.contract().at(cEtherData.address); +} + +const getParams = async () => { + const cEther = await getCEtherContract(); + const name = await cEther.name().call(); + const interestRateModelAddress = await cEther.interestRateModel().call(); + const decimals = await cEther.decimals().call(); + const reserveFactor = await cEther.reserveFactorMantissa().call(); + const exchangeRate = await cEther.exchangeRateStored().call(); + const result = { + name, + decimals, + interestRateModelAddress, + reserveFactor: reserveFactor.toString(), + exchangeRate: exchangeRate.toString(), + }; + console.log(`cEther Params: ${JSON.stringify(result)}`); + return result; +} + +// const main = async () => { +// await getParams(); +// } + +// main(); + +module.exports = { + getCEtherContract, + getParams, +}; diff --git a/script/helper/interestRate.js b/script/helper/interestRate.js new file mode 100644 index 0000000..6faef9a --- /dev/null +++ b/script/helper/interestRate.js @@ -0,0 +1,59 @@ +const {ethers} = require("ethers"); + +const { nile } = require('../utils/tronWeb'); +const calculator = require('../utils/calculator'); + +const {cEther: cEtherInterestRateAddress, cDai: cDaiInterestRateAddress} = require('../../../data/test-interest-rate.json'); + +const getInterestRateContract = async () => { + return { + cEtherInterestRateModel: await nile.contract().at(cEtherInterestRateAddress), + cDaiInterestRateModel: await nile.contract().at(cDaiInterestRateAddress) + }; +} + +const getParams = async () => { + const {cEtherInterestRateModel, cDaiInterestRateModel} = await getInterestRateContract(); + let baseRate = await cEtherInterestRateModel.baseRatePerBlock().call(); + let blocksPerYear = await cEtherInterestRateModel.blocksPerYear().call(); + let multiplierPerBlock = await cEtherInterestRateModel.multiplierPerBlock().call(); + + const cEtherData = { + baseRatePerYear: calculator.getBaseRatePerYear(baseRate, blocksPerYear).toString(), + blocksPerYear: blocksPerYear.toString(), + multiplierPerYear: calculator.getMultiplierPerYear(multiplierPerBlock, blocksPerYear, ethers.BigNumber.from("0")).toString(), + } + + baseRate = await cDaiInterestRateModel.baseRatePerBlock().call(); + blocksPerYear = await cDaiInterestRateModel.blocksPerYear().call(); + multiplierPerBlock = await cDaiInterestRateModel.multiplierPerBlock().call(); + jumpMultiplierPerBlock = await cDaiInterestRateModel.jumpMultiplierPerBlock().call(); + kink = await cDaiInterestRateModel.kink().call(); + + + const cDaiData = { + baseRatePerYear: calculator.getBaseRatePerYear(baseRate, blocksPerYear).toString(), + blocksPerYear: blocksPerYear.toString(), + multiplierPerYear: calculator.getMultiplierPerYear(multiplierPerBlock, blocksPerYear, kink).toString(), + jumpMultiplierPerYear: calculator.getJumpMultiplierPerYear(jumpMultiplierPerBlock, blocksPerYear).toString(), + kink: kink.toString(), + } + + const result = { + cEtherInterestRate: cEtherData, + cDaiInterestRate: cDaiData, + }; + console.log(`InterestRateModel Params: ${JSON.stringify(result)}`); + return result; +} + +// const main = async () => { +// await getParams(); +// } + +// main(); + +module.exports = { + getInterestRateContract, + getParams, +} \ No newline at end of file diff --git a/script/helper/priceOracle.js b/script/helper/priceOracle.js new file mode 100644 index 0000000..602d367 --- /dev/null +++ b/script/helper/priceOracle.js @@ -0,0 +1,71 @@ +const { nile } = require('./utils/tronWeb'); +const { oracleV1: oracleV1Address, oracle: oracleAddress } = require('../../data/test-oracle.json'); + +const getPriceOracleContract = async () => { + const v1 = await nile.contract().at(oracleV1Address); + const proxy = await nile.contract().at(oracleAddress); + return { + v1, proxy + } +} + +const getPrice = async (proxy, cToken) => { + const result = await proxy.getUnderlyingPrice(cToken).call(); + return result.toString(); + +} + +const getPrices = async (proxy) => { + let cAssets = [ + { + address: "TRV3vxD4yUgqu1FMJ5KNxQzSwmThHP1npz", + name: "usdc" + }, + { + address: "TPXQFKeLjcXczthgV3Kj1MXAy1kADVTCUW", + name: "usdt" + }, + { + address: "TPPq48YYWCPwHt5Kt4fPrHnEfCJqtzEUUm", + name: "dai" + }, + { + address: "TMJGEhLjCBCiHKG3vY9niri6yw841Sqbaa", + name: "T4" + }, + { + address: "TKNwKkZSjTQcz5AgoMNqabnuryxNuZJY5c", + name: "T5" + + } + ]; + + const result = cAssets.map(async (v) => { + return { address: v.address, name: v.name, price: (await getPrice(proxy, v.address)).toString() } + }); + const finalResult = await Promise.all(result); + return finalResult; +} + +const getSaiPrice = async (proxy) => { + const result = await proxy.saiPrice().call(); + return result.toString(); +} + +// const main = async () => { +// const { proxy } = await getPriceOracleContract(); +// const prices = await getPrices(proxy); +// console.log(`Asset Prices: ${JSON.stringify(prices)}`); + +// const saiPrice = await getSaiPrice(proxy); +// console.log(`Sai Price: ${saiPrice}`); +// } + +// main(); + +module.exports = { + getPriceOracleContract, + getPrice, + getPrices, + getSaiPrice, +} \ No newline at end of file diff --git a/script/helper/priceOracleV1.js b/script/helper/priceOracleV1.js new file mode 100644 index 0000000..5c80bde --- /dev/null +++ b/script/helper/priceOracleV1.js @@ -0,0 +1,52 @@ +const { nile } = require('./utils/tronWeb'); +const {tokens} = require('../../data/test-tokens.json'); +const {oracleV1 : oracleV1Address} = require('../../data/test-oracle.json'); + +const getPriceOracleV1Contract = async() => { + return await nile.contract().at(oracleV1Address); +} + +const getPrice = async(underlying) => { + const contract = await getPriceOracleV1Contract(); + const result = await contract.assetPrices(underlying).call(); + return result.toString(); +} + +const getPrices = async() => { + let assets = [ + { + address: "T9yD14Nj9j7xAB4dbGeiX9h8unkKLxmGkn", + name: "usdc" + }, + { + address: "T9yD14Nj9j7xAB4dbGeiX9h8unkKT76qbH", + name: "usdt" + } + ] + + for(let i = 2; i{ + return {address: v.address, name: v.name, price: await getPrice(v.address)} + }); + const finalResult = await Promise.all(result); + return finalResult; +} + +// const main = async() =>{ +// const prices = await getPrices(); +// console.log(JSON.stringify(prices)); +// } + +// main(); + +module.exports = { + getPriceOracleV1Contract, + getPrice, + getPrices +} \ No newline at end of file diff --git a/script/scenario/market.js b/script/scenario/market.js new file mode 100644 index 0000000..cc74ada --- /dev/null +++ b/script/scenario/market.js @@ -0,0 +1,41 @@ +const { nile } = require('../utils/tronWeb'); +const trxOption = require('../utils/trx'); + +const {getCErc20DelegatorContract, getSingleParams} = require('../helper/cErc20'); +const {getComptrollerContract} = require('../helper/Comptroller'); + +const {unitroller: comptrollerAddress} = require('../../data/test-comptroller.json'); +const {CErc20Delegator} = require('../../data/test-tokens.json'); +const {abi: comptrollerAbi} = require('../../build/contracts/Comptroller.json'); + +const getErc20Contract = async (erc20Address) => { + return await nile.contract().at(erc20Address); +} + +const enterMarkets = async (comptroller, cTokenAddresses) => { + await comptroller.enterMarkets(cTokenAddresses).send(trxOption); +} + +const mintToken = async (comptroller, cToken, amount) => { + await enterMarkets(comptroller, [cToken.address], amount); + + const cTokenParam = await getSingleParams(cToken); + console.log(JSON.stringify(cTokenParam)); + const underlyingAddress = cTokenParam.underlying; + + const underlying = await getErc20Contract(underlyingAddress); + await underlying.approve(cToken.address, '0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff').send(trxOption); + + await cToken.mint(amount).send(trxOption); + return await comptroller.getAccountLiquidity( process.env.ADMIN).call(); +} + +const main = async () => { + const comptroller = await getComptrollerContract(comptrollerAbi, comptrollerAddress); + const addr = CErc20Delegator[0]; + const cErc20 = await getCErc20DelegatorContract(addr); + const result = await mintToken(comptroller, cErc20, '100000000'); + console.log(result[1].toString()); +} + +main(); \ No newline at end of file diff --git a/script/utils/calculator.js b/script/utils/calculator.js new file mode 100644 index 0000000..ed0548a --- /dev/null +++ b/script/utils/calculator.js @@ -0,0 +1,29 @@ +const {ethers} = require("ethers"); + +const getMultiplierPerYear = (multiplierPerBlock, blocksPerYear, kink) => { + const multiplier = ethers.BigNumber.from(multiplierPerBlock); + const block = ethers.BigNumber.from(blocksPerYear); + if(!kink.eq("0")) { + const k = ethers.BigNumber.from(kink); + return multiplier.mul(block.mul(k)).div("1000000000000000000"); + }else { + return multiplier.mul(block); + } +} + +const getJumpMultiplierPerYear = (jumpMultiplierPerBlock, blocksPerYear) => { + const multiplier = ethers.BigNumber.from(jumpMultiplierPerBlock); + const block = ethers.BigNumber.from(blocksPerYear); + + const result = multiplier.mul(block); + return result; +} + +const getBaseRatePerYear = (baseRatePerBlock, blocksPerYear) => { + const base = ethers.BigNumber.from(baseRatePerBlock); + const block = ethers.BigNumber.from(blocksPerYear); + const result = base.mul(block); + return result; +} + +module.exports = {getMultiplierPerYear, getJumpMultiplierPerYear, getBaseRatePerYear}; \ No newline at end of file diff --git a/script/utils/tronWeb.js b/script/utils/tronWeb.js new file mode 100644 index 0000000..69f24e3 --- /dev/null +++ b/script/utils/tronWeb.js @@ -0,0 +1,14 @@ +const TronWeb = require('tronweb') + +require('dotenv').config(); + +const tronWeb = { + nile: new TronWeb( + "https://api.nileex.io/", + "https://api.nileex.io/", + "https://api.nileex.io/", + process.env.PRIVATE_KEY_NILE + ) +} + +module.exports = tronWeb; \ No newline at end of file diff --git a/script/utils/trx.js b/script/utils/trx.js new file mode 100644 index 0000000..1a8c3e9 --- /dev/null +++ b/script/utils/trx.js @@ -0,0 +1,5 @@ +module.exports = { + feeLimit:100_000_000, + callValue:0, + shouldPollResponse:true +}; \ No newline at end of file diff --git a/tronbox-config.js b/tronbox-config.js new file mode 100644 index 0000000..f4d6253 --- /dev/null +++ b/tronbox-config.js @@ -0,0 +1,3 @@ +module.exports = { + +}; diff --git a/tronbox.js b/tronbox.js new file mode 100644 index 0000000..a124513 --- /dev/null +++ b/tronbox.js @@ -0,0 +1,60 @@ +require('dotenv').config(); + +const port = process.env.HOST_PORT || 9090 + +module.exports = { + networks: { + mainnet: { + // Don't put your private key here: + privateKey: process.env.PRIVATE_KEY_MAINNET, + /* +Create a .env file (it must be gitignored) containing something like + + export PRIVATE_KEY_MAINNET=4E7FECCB71207B867C495B51A9758B104B1D4422088A87F4978BE64636656243 + +Then, run the migration with: + + source .env && tronbox migrate --network mainnet + +*/ + userFeePercentage: 100, + feeLimit: 5000000, + fullHost: 'https://api.trongrid.io', + network_id: '1' + }, + shasta: { + privateKey: process.env.PRIVATE_KEY_SHASTA, + userFeePercentage: 50, + feeLimit: 1000 * 1e6, + fullHost: 'https://api.shasta.trongrid.io', + network_id: '2' + }, + nile: { + privateKey: process.env.PRIVATE_KEY_NILE, + userFeePercentage: 100, + feeLimit: 10000000000, + fullHost: 'https://api.nileex.io', + network_id: '3' + }, + development: { + // For trontools/quickstart docker image + privateKey: 'da146374a75310b9666e834ee4ad0866d6f4035967bfc76217c5a495fff9f0d0', + userFeePercentage: 0, + feeLimit: 1000 * 1e6, + fullHost: 'http://127.0.0.1:' + port, + network_id: '9' + }, + compilers: { + solc: { + version: '0.5.12', + } + } + }, + // solc compiler optimize + solc: { + optimizer: { + enabled: true, + runs: 10000 + } + }, +}