Merge branch 'master' into v0.3.0

.vscode/settings.json

@@ -13,5 +13,22 @@
   "solidity.packageDefaultDependenciesContractsDirectory": "",
   "solidity.enabledAsYouTypeCompilationErrorCheck": true,
   "solidity.validationDelay": 1500,
-  "solidity.packageDefaultDependenciesDirectory": "node_modules"
+  "solidity.packageDefaultDependenciesDirectory": "node_modules",
+  "solidity-va.hover": false,
+  "solidity-va.deco.statevars": true,
+  "solidity-va.deco.arguments": false,
+  "solidity-va.deco.warn.reserved": false,
+  "solidity-va.outline.enable": false,
+  "solidity-va.outline.decorations": false,
+  "solidity-va.outline.extras": false,
+  "solidity-va.outline.var.storage_annotations": false,
+  "solidity-va.outline.pragmas.show": false,
+  "solidity-va.outline.imports.show": false,
+  "solidity-va.parser.parseImports": false,
+  "solidity-va.preview.dot": false,
+  "solidity-va.codelens.enable": true,
+  "solidity-va.mode.active": false,
+  "slither.solcPath": "",
+  "slither.hiddenDetectors": [],
+  "liveServer.settings.port": 5501
 }

README.md

@@ -1,31 +1,33 @@
-# BentoBox
-
-[![Coverage Status](https://coveralls.io/repos/github/sushiswap/bentobox/badge.svg?branch=master)](https://coveralls.io/github/sushiswap/bentobox?branch=master)
-
-Platforms like Compound and Aave allow users to deposit assets as collateral and borrow other assets against this. These protocols have attracted billions of dollars, but they suffer from some major limitations. Taking away these limitations could see much larger adoption. BentoBox aims to do just that.
-
-We solve these issues by having a platform with:
-
-- Isolated lending pairs. Anyone can create a pair, it’s up to users which pairs they find safe enough. Risk is isolated to just that pair.
-- Flexible oracles, both on-chain and off-chain.
-  Liquid interest rates based on a specific target utilization range, such as 70-80%.
-- Contracts optimized for low gas.
-- The supplied assets can be used for flash loans, providing extra revenue for suppliers.
-
-## Docs
-
-[Development](docs/DEVELOPMENT.md)
-
-[Deployment](docs/DEPLOYMENT.md)
-
-## Security
-Audits are being performed by Quantstamp and Peckshield
-
-We use [Slither](https://github.com/crytic/slither) for static analysis. Reports and comments are here:
-
-[BentoBox.sol](docs/Slither_BentoBox.md)
-
-
-## Licence
-
-UNLICENCED
+# BentoBox
+
+[![Coverage Status](https://coveralls.io/repos/github/sushiswap/bentobox/badge.svg?branch=master&service=github)](https://coveralls.io/github/sushiswap/bentobox?branch=master)
+
+Platforms like Compound and Aave allow users to deposit assets as collateral and borrow other assets against this. These protocols have attracted billions of dollars, but they suffer from some major limitations. Taking away these limitations could see much larger adoption. BentoBox aims to do just that.
+
+We solve these issues by having a platform with:
+
+- Isolated lending pairs. Anyone can create a pair, it’s up to users which pairs they find safe enough. Risk is isolated to just that pair.
+- Flexible oracles, both on-chain and off-chain.
+  Liquid interest rates based on a specific target utilization range, such as 70-80%.
+- Contracts optimized for low gas.
+- The supplied assets can be used for flash loans, providing extra revenue for suppliers.
+- Strategies can provide additional revenue
+
+## Docs
+
+[Development](docs/DEVELOPMENT.md)
+
+[Deployment](docs/DEPLOYMENT.md)
+
+## Security
+
+An early version was audited by PeckShield and partially by Quantstamp. The thoroughness wasn't overwhelming,
+which led to the creation of an internal audit checklist (see checks.txt in the docs folder).
+
+Contracts are covered 100% by tests.
+
+Formal verification is done using Certora.
+
+## Licence
+
+UNLICENCED