Foundry test suite

.github/workflows/test.yml

@@ -0,0 +1,50 @@
+name: CI
+
+on:
+ push:
+ pull_request:
+ workflow_dispatch:
+
+env:
+ FOUNDRY_PROFILE: ci
+
+jobs:
+ check:
+ strategy:
+ fail-fast: true
+
+ name: Foundry project
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v4
+ with:
+ submodules: recursive
+
+ - name: Install Foundry
+ uses: foundry-rs/foundry-toolchain@v1
+ with:
+ version: nightly
+
+ - name: Show Forge version
+ run: |
+ forge --version
+
+ - name: Run Forge fmt
+ run: |
+ forge fmt --check
+ id: fmt
+
+ - name: Install npm dependencies
+ run: |
+ npm install
+ id: npmi
+
+ - name: Run Forge build
+ run: |
+ forge build --sizes
+ id: build
+
+ - name: Run Forge tests
+ run: |
+ forge test -vvv
+ id: test

.gitignore

@@ -22,4 +22,12 @@ cache
 artifacts
 
 .DS_Store
-.idea/
+.idea/
+
+# crytic
+crytic-export/
+echidna/
+medusa/
+
+# python
+venv/

.gitmodules

@@ -0,0 +1,9 @@
+[submodule "lib/forge-std"]
+ path = lib/forge-std
+ url = https://github.com/foundry-rs/forge-std
+[submodule "lib/chimera"]
+ path = lib/chimera
+ url = https://github.com/recon-fuzz/chimera
+[submodule "lib/properties"]
+ path = lib/properties
+ url = https://github.com/crytic/properties

README.md

@@ -1,29 +1,73 @@
 # The Standard: Smart Vaults
 
 ## Installation
+### Hardhat
 If you have npm installed, you can install the required project dependencies
 ```
 npm install
 ```
 
+### Foundry
+If you have Foundry installed, you can install the required project dependencies
+```
+forge install
+```
+
 ## Testing
+### Hardhat
 If you are in root, you can run the project's full test suite
 ```
 npx hardhat test
 ```
 Since this project uses Hardhat, you can use its default ways to run tests, should you prefer it.
+
+### Foundry
+```
+forge test
+```
+
 ## Coverage
+### Hardhat
 Run the code coverage suite with
 ```
 npx hardhat coverage
 ```
 
+### Foundry
+```
+forge coverage
+```
+
 ## Contract size benchmark
 Run the contract sizer with
 ```
 npx hardhat size-contracts
 ```
 
+## Format
+Format using the forge formatter with
+```
+forge fmt
+```
+
+## Gas Snapshots
+Output gas usage snapshots with
+```
+forge snapshot
+```
+
+## Anvil
+Run a local chain with
+```
+anvil
+```
+
+## Chisel
+Open a Solidity REPL with
+```
+chisel
+```
+
 ## Documentation
 - [Testnet guide](docs/TESTNET)
 - [Deployed addresses](docs/addresses.json)

contracts/PriceCalculator.sol

@@ -5,10 +5,12 @@ import "@chainlink/contracts/src/v0.8/interfaces/AggregatorV3Interface.sol" as C
 import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
 import "contracts/interfaces/IPriceCalculator.sol";
 
+import {console} from "forge-std/console.sol";
+
 contract PriceCalculator is IPriceCalculator {
  bytes32 private immutable NATIVE;
 
- constructor (bytes32 _native) {
+ constructor(bytes32 _native) {
  NATIVE = _native;
  }
 
@@ -19,13 +21,14 @@ contract PriceCalculator is IPriceCalculator {
  function tokenToUSD(ITokenManager.Token memory _token, uint256 _tokenValue) external view returns (uint256) {
  Chainlink.AggregatorV3Interface tokenUsdClFeed = Chainlink.AggregatorV3Interface(_token.clAddr);
  uint256 scaledCollateral = _tokenValue * 10 ** getTokenScaleDiff(_token.symbol, _token.addr);
- (,int256 _tokenUsdPrice,,,) = tokenUsdClFeed.latestRoundData();
+ (, int256 _tokenUsdPrice,,,) = tokenUsdClFeed.latestRoundData();
  return scaledCollateral * uint256(_tokenUsdPrice) / 10 ** _token.clDec;
  }
 
  function USDToToken(ITokenManager.Token memory _token, uint256 _usdValue) external view returns (uint256) {
  Chainlink.AggregatorV3Interface tokenUsdClFeed = Chainlink.AggregatorV3Interface(_token.clAddr);
  (, int256 tokenUsdPrice,,,) = tokenUsdClFeed.latestRoundData();
- return _usdValue * 10 ** _token.clDec / uint256(tokenUsdPrice) / 10 ** getTokenScaleDiff(_token.symbol, _token.addr);
+ return _usdValue * 10 ** _token.clDec / uint256(tokenUsdPrice)
+ / 10 ** getTokenScaleDiff(_token.symbol, _token.addr);
  }
-}
+}

contracts/SmartVaultDeployerV4.sol

@@ -5,15 +5,15 @@ import "contracts/SmartVaultV4.sol";
 import "contracts/PriceCalculator.sol";
 import "contracts/interfaces/ISmartVaultDeployer.sol";
 
-contract SmartVaultDeployerV4 is ISmartVaultDeployer { 
+contract SmartVaultDeployerV4 is ISmartVaultDeployer {
  bytes32 private immutable NATIVE;
  address private immutable priceCalculator;
 
  constructor(bytes32 _native) {
  NATIVE = _native;
  priceCalculator = address(new PriceCalculator(_native));
  }
- 
+
  function deploy(address _manager, address _owner, address _usds) external returns (address) {
  return address(new SmartVaultV4(NATIVE, _manager, _owner, _usds, priceCalculator));
  }

contracts/SmartVaultIndex.sol

@@ -9,7 +9,7 @@ contract SmartVaultIndex is ISmartVaultIndex, Ownable {
  mapping(address => uint256[]) private tokenIds;
  mapping(uint256 => address payable) private vaultAddresses;
 
- modifier onlyManager {
+ modifier onlyManager() {
  require(msg.sender == manager, "err-unauthorised");
  _;
  }

contracts/SmartVaultManagerV6.sol

@@ -17,9 +17,15 @@ import "contracts/interfaces/IUSDs.sol";
 // TODO describe changes
 // TODO upgraded zz/zz/zz
 //
-contract SmartVaultManagerV6 is ISmartVaultManager, ISmartVaultManagerV2, Initializable, ERC721Upgradeable, OwnableUpgradeable {
+contract SmartVaultManagerV6 is
+ ISmartVaultManager,
+ ISmartVaultManagerV2,
+ Initializable,
+ ERC721Upgradeable,
+ OwnableUpgradeable
+{
  using SafeERC20 for IERC20;
- 
+
  uint256 public constant HUNDRED_PC = 1e5;
 
  address public protocol;
@@ -43,16 +49,32 @@ contract SmartVaultManagerV6 is ISmartVaultManager, ISmartVaultManagerV2, Initia
  event VaultLiquidated(address indexed vaultAddress);
  event VaultTransferred(uint256 indexed tokenId, address from, address to);
 
- struct SmartVaultData { 
- uint256 tokenId; uint256 collateralRate; uint256 mintFeeRate;
- uint256 burnFeeRate; ISmartVault.Status status;
+ struct SmartVaultData {
+ uint256 tokenId;
+ uint256 collateralRate;
+ uint256 mintFeeRate;
+ uint256 burnFeeRate;
+ ISmartVault.Status status;
  }
 
  function initialize(
- uint256 _collateralRate, uint256 _feeRate, address _usds, address _protocol, address _liquidator, address _tokenManager,
- address _smartVaultDeployer, address _smartVaultIndex, address _nftMetadataGenerator, address _yieldManager, uint16 _userVaultLimit,
- address _swapRouter, address _weth
- ) initializer public {
+ uint256 _collateralRate,
+ uint256 _feeRate,
+ address _usds,
+ address _protocol,
+ address _liquidator,
+ address _tokenManager,
+ address _smartVaultDeployer,
+ address _smartVaultIndex,
+ address _nftMetadataGenerator,
+ // address _yieldManager,
+ uint16 _userVaultLimit
+ )
+ // address _swapRouter,
+ // address _weth
+ public
+ initializer
+ {
  __ERC721_init("The Standard Smart Vault Manager (USDs)", "TS-VAULTMAN-USDs");
  __Ownable_init();
  collateralRate = _collateralRate;
@@ -66,13 +88,13 @@ contract SmartVaultManagerV6 is ISmartVaultManager, ISmartVaultManagerV2, Initia
  smartVaultDeployer = _smartVaultDeployer;
  smartVaultIndex = ISmartVaultIndex(_smartVaultIndex);
  nftMetadataGenerator = _nftMetadataGenerator;
- yieldManager = _yieldManager;
+ // yieldManager = _yieldManager;
  userVaultLimit = _userVaultLimit;
- swapRouter = _swapRouter;
- weth = _weth;
+ // swapRouter = _swapRouter;
+ // weth = _weth;
  }
 
- modifier onlyLiquidator {
+ modifier onlyLiquidator() {
  require(msg.sender == liquidator, "err-invalid-liquidator");
  _;
  }
@@ -129,42 +151,42 @@ contract SmartVaultManagerV6 is ISmartVaultManager, ISmartVaultManagerV2, Initia
  }
 
  function setBurnFeeRate(uint256 _rate) external onlyOwner {
- burnFeeRate = _rate; 
+ burnFeeRate = _rate;
  }
 
  function setSwapFeeRate(uint256 _rate) external onlyOwner {
  swapFeeRate = _rate;
  }
 
- function setWethAddress(address _weth) external onlyOwner() {
+ function setWethAddress(address _weth) external onlyOwner {
  weth = _weth;
  }
 
- function setSwapRouter(address _swapRouter) external onlyOwner() {
+ function setSwapRouter(address _swapRouter) external onlyOwner {
  swapRouter = _swapRouter;
  }
 
- function setNFTMetadataGenerator(address _nftMetadataGenerator) external onlyOwner() {
+ function setNFTMetadataGenerator(address _nftMetadataGenerator) external onlyOwner {
  nftMetadataGenerator = _nftMetadataGenerator;
  }
 
- function setSmartVaultDeployer(address _smartVaultDeployer) external onlyOwner() {
+ function setSmartVaultDeployer(address _smartVaultDeployer) external onlyOwner {
  smartVaultDeployer = _smartVaultDeployer;
  }
 
- function setProtocolAddress(address _protocol) external onlyOwner() {
+ function setProtocolAddress(address _protocol) external onlyOwner {
  protocol = _protocol;
  }
 
- function setLiquidatorAddress(address _liquidator) external onlyOwner() {
+ function setLiquidatorAddress(address _liquidator) external onlyOwner {
  liquidator = _liquidator;
  }
 
- function setUserVaultLimit(uint16 _userVaultLimit) external onlyOwner() {
+ function setUserVaultLimit(uint16 _userVaultLimit) external onlyOwner {
  userVaultLimit = _userVaultLimit;
  }
 
- function setYieldManager(address _yieldManager) external onlyOwner() {
+ function setYieldManager(address _yieldManager) external onlyOwner {
  yieldManager = _yieldManager;
  }
 
@@ -175,4 +197,4 @@ contract SmartVaultManagerV6 is ISmartVaultManager, ISmartVaultManagerV2, Initia
  if (address(_from) != address(0)) ISmartVault(smartVaultIndex.getVaultAddress(_tokenId)).setOwner(_to);
  emit VaultTransferred(_tokenId, _from, _to);
  }
-}
+}