cloned from contest repo

Unstoppable-DeFi · Mar 3, 2023 · b1303b2 · b1303b2
1 parent 129a339
commit b1303b2
Show file tree

Hide file tree

Showing 58 changed files with 34 additions and 135 deletions.
diff --git a/.github/ISSUE_TEMPLATE/audit-item.md b/.github/ISSUE_TEMPLATE/audit-item.md
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+.pytest_chache/
+tintinweb.vscode-vyper-0.0.15.vsix
diff --git a/.python-version b/.python-version
@@ -0,0 +1 @@
+3.10
diff --git a/.sherlock/contest.json b/.sherlock/contest.json
diff --git a/.sherlock/protocol.json b/.sherlock/protocol.json
diff --git a/README.md b/README.md
@@ -1,58 +1,46 @@
-# Fair funding contest details
+# Fair Funding
 
-- Join [Sherlock Discord](https://discord.gg/MABEWyASkp)
-- Submit findings using the issue page in your private contest repo (label issues as med or high)
-- [Read for more details](https://docs.sherlock.xyz/audits/watsons)
+Fair Funding is a concept that allows crypto projects to be funded while limiting the downside exposure of investors.
+The Fair Funding platform performs an auction every day (similar to NounsDAO) that promises benefits in the funded project.
+Investors bid in the auction and the highest bidder after 24h wins.
+The funds deposited in the auction by the investor are then put into an Alchemix vault and a non-liquidatable, self-repaying loan is taken out against this position.
+The loan is sent to the raising project while the investor retains complete control over his funds at Alchemix with the help of an ERC721 that represents his position. Over time the self-repaying feature of Alchemix will release the funds and the token owners can claim their share until fully repaid.
 
-# Resources
+## Contracts
+- `AuctionHouse.vy` handles the daily auction
+- `Vault.vy` handles the Alchemix integration
+- `MintableERC721.sol` is an OpenZeppelin based ERC721 implementation used to represent the financial positions in the vault
 
-## About Fair Funding
-- [Fair Funding Introduction Article](https://unstoppabledefi.medium.com/fair-funding-in-crypto-bc88d633646)
-- [Fair Funding Campaign Article](https://unstoppabledefi.medium.com/fair-funding-campaign-662131dfa3f6)
 
-## Integrations
-- [Alchemix Finance](https://alchemix.fi)
-- [Alchemix Contracts on Github](https://github.com/alchemix-finance/v2-foundry/tree/master/src)
+## Tests
 
+The Fair Funding platform has been developed almost exclusively test driven with the help of Titanoboa & Vyper.
+A total of 133 tests cover all aspects of the auction, vault and user interactions.
 
-# On-chain context
+We use Poetry (https://python-poetry.org/) for the python env management and Python version `3.10`.
 
+To run the tests run:
 ```
-DEPLOYMENT: Ethereum Mainnet
-ERC20: WETH
-ERC721: MintableERC721 (part of this audit)
-ERC777: none
-FEE-ON-TRANSFER: none
-REBASING TOKENS: none
-ADMIN: trusted
-EXTERNAL-ADMINS: trusted
+poetry shell
+poetry install
+pytest
 ```
 
-## Priviledged Roles
-### `AuctionHouse`: 
-    1) `owner` can start/stop auction, refund highest bidder if needed and set the target vault contract
+If `3.10` is not your default version and you're using `pyenv`, set up your environment first via:
 
-### `Vault`: 
-    1) `is_operator`: can set the Alchemix Alchemist contract as well as the `fund_receiver` and add/remove other operators
-    2) `is_depositor`: can deposit into the vault. In practice this will be the `AuctionHouse` contract.
-    3) `migration_admin`: can set a migration contract and after 30 day timelock execute a migration. In practice this role will be handed over to the Alchemix Multisig and would only need to be used in case something significant changes at Alchemix. Since vault potentially holds an Alchemix position over a long time during which changes at Alchemix could happen, the `migration_admin` has complete control over the vault and its position after giving depositors a 30 day window to liquidate (or transfer with a flashloan) their position if they're not comfortable with the migration. `migration_admin` works under the same security and trust assumptions as the Alchemix (Proxy) Admins.
-
-### `MintableERC721`:
-    1) `owner`: one owner, in practice the `Vault` contract issuing a new token as receipt and control over a deposited position.
-
-
-## Known Issues / Risks
-
-During the auction phase all priviledged roles have to be trusted.  
-Migration admin has to be trusted for the entire time, as long as there is an active position.  
-Alchemix admins, protocol and underlying tokens have to be trusted.
-
-
-# Audit scope
+```
+pyenv install 3.10
+pyenv local 3.10
+poetry env use 3.10
+poetry shell
+poetry install
+pytest
+```
 
-- `fair-funding/contracts/AuctionHouse.vy`
-- `fair-funding/contracts/Vault.vy`
-- `fair-funding/contracts/solidity/MintableERC721.sol`
 
+## Contact
+https://unstoppable.ooo
 
 
+## Security Contact
+[email protected]
diff --git a/fair-funding/contracts/AuctionHouse.vy → contracts/AuctionHouse.vy b/fair-funding/contracts/AuctionHouse.vy → contracts/AuctionHouse.vy
diff --git a/fair-funding/contracts/Vault.vy → contracts/Vault.vy b/fair-funding/contracts/Vault.vy → contracts/Vault.vy
diff --git a/...nding/contracts/interfaces/AlchemistV2.vy → contracts/interfaces/AlchemistV2.vy b/...nding/contracts/interfaces/AlchemistV2.vy → contracts/interfaces/AlchemistV2.vy
diff --git a/...ing/contracts/solidity/MintableERC721.sol → contracts/solidity/MintableERC721.sol b/...ing/contracts/solidity/MintableERC721.sol → contracts/solidity/MintableERC721.sol
diff --git a/...unding/contracts/testing/MockAlchemist.vy → contracts/testing/MockAlchemist.vy b/...unding/contracts/testing/MockAlchemist.vy → contracts/testing/MockAlchemist.vy
diff --git a/...funding/contracts/testing/MockMigrator.vy → contracts/testing/MockMigrator.vy b/...funding/contracts/testing/MockMigrator.vy → contracts/testing/MockMigrator.vy
diff --git a/fair-funding/contracts/testing/MockVault.vy → contracts/testing/MockVault.vy b/fair-funding/contracts/testing/MockVault.vy → contracts/testing/MockVault.vy
diff --git a/...-funding/contracts/testing/token/ERC20.vy → contracts/testing/token/ERC20.vy b/...-funding/contracts/testing/token/ERC20.vy → contracts/testing/token/ERC20.vy
diff --git a/...funding/contracts/testing/token/ERC721.vy → contracts/testing/token/ERC721.vy b/...funding/contracts/testing/token/ERC721.vy → contracts/testing/token/ERC721.vy
diff --git a/fair-funding/contracts/token/ERC20.vy → contracts/token/ERC20.vy b/fair-funding/contracts/token/ERC20.vy → contracts/token/ERC20.vy
diff --git a/fair-funding/contracts/token/ERC721.vy → contracts/token/ERC721.vy b/fair-funding/contracts/token/ERC721.vy → contracts/token/ERC721.vy
diff --git a/fair-funding/.gitignore b/fair-funding/.gitignore
diff --git a/fair-funding/README.md b/fair-funding/README.md
diff --git a/fair-funding/hardhat.config.js → hardhat.config.js b/fair-funding/hardhat.config.js → hardhat.config.js
diff --git a/fair-funding/localtesting.py → localtesting.py b/fair-funding/localtesting.py → localtesting.py
diff --git a/fair-funding/manual_testing.md → manual_testing.md b/fair-funding/manual_testing.md → manual_testing.md
diff --git a/fair-funding/package-lock.json → package-lock.json b/fair-funding/package-lock.json → package-lock.json
diff --git a/fair-funding/package.json → package.json b/fair-funding/package.json → package.json
diff --git a/fair-funding/poetry.lock → poetry.lock b/fair-funding/poetry.lock → poetry.lock
diff --git a/fair-funding/pyproject.toml → pyproject.toml b/fair-funding/pyproject.toml → pyproject.toml
diff --git a/fair-funding/scripts/auction_house_deploy.js → scripts/auction_house_deploy.js b/fair-funding/scripts/auction_house_deploy.js → scripts/auction_house_deploy.js
diff --git a/fair-funding/scripts/vault_deploy.js → scripts/vault_deploy.js b/fair-funding/scripts/vault_deploy.js → scripts/vault_deploy.js
diff --git a/tests/__pycache__/conftest.cpython-310-pytest-7.2.1.pyc b/tests/__pycache__/conftest.cpython-310-pytest-7.2.1.pyc
diff --git a/tests/__pycache__/test_AuctionHouse_bid.cpython-310-pytest-7.2.1.pyc b/tests/__pycache__/test_AuctionHouse_bid.cpython-310-pytest-7.2.1.pyc
diff --git a/tests/__pycache__/test_AuctionHouse_config.cpython-310-pytest-7.2.1.pyc b/tests/__pycache__/test_AuctionHouse_config.cpython-310-pytest-7.2.1.pyc
diff --git a/tests/__pycache__/test_AuctionHouse_events.cpython-310-pytest-7.2.1.pyc b/tests/__pycache__/test_AuctionHouse_events.cpython-310-pytest-7.2.1.pyc
diff --git a/tests/__pycache__/test_AuctionHouse_settle.cpython-310-pytest-7.2.1.pyc b/tests/__pycache__/test_AuctionHouse_settle.cpython-310-pytest-7.2.1.pyc
diff --git a/tests/__pycache__/test_AuctionHouse_setup.cpython-310-pytest-7.2.1.pyc b/tests/__pycache__/test_AuctionHouse_setup.cpython-310-pytest-7.2.1.pyc
diff --git a/tests/__pycache__/test_AuctionHouse_start.cpython-310-pytest-7.2.1.pyc b/tests/__pycache__/test_AuctionHouse_start.cpython-310-pytest-7.2.1.pyc
diff --git a/tests/__pycache__/test_NFT_actions.cpython-310-pytest-7.2.1.pyc b/tests/__pycache__/test_NFT_actions.cpython-310-pytest-7.2.1.pyc
diff --git a/tests/__pycache__/test_Vault_alcx.cpython-310-pytest-7.2.1.pyc b/tests/__pycache__/test_Vault_alcx.cpython-310-pytest-7.2.1.pyc
diff --git a/tests/__pycache__/test_Vault_auth.cpython-310-pytest-7.2.1.pyc b/tests/__pycache__/test_Vault_auth.cpython-310-pytest-7.2.1.pyc
diff --git a/tests/__pycache__/test_Vault_deposit.cpython-310-pytest-7.2.1.pyc b/tests/__pycache__/test_Vault_deposit.cpython-310-pytest-7.2.1.pyc
diff --git a/tests/__pycache__/test_Vault_events.cpython-310-pytest-7.2.1.pyc b/tests/__pycache__/test_Vault_events.cpython-310-pytest-7.2.1.pyc
diff --git a/tests/__pycache__/test_Vault_liquidate.cpython-310-pytest-7.2.1.pyc b/tests/__pycache__/test_Vault_liquidate.cpython-310-pytest-7.2.1.pyc
diff --git a/tests/__pycache__/test_Vault_migrate.cpython-310-pytest-7.2.1.pyc b/tests/__pycache__/test_Vault_migrate.cpython-310-pytest-7.2.1.pyc
diff --git a/tests/__pycache__/test_Vault_setup.cpython-310-pytest-7.2.1.pyc b/tests/__pycache__/test_Vault_setup.cpython-310-pytest-7.2.1.pyc
diff --git a/fair-funding/tests/conftest.py → tests/conftest.py b/fair-funding/tests/conftest.py → tests/conftest.py
diff --git a/fair-funding/tests/test_AuctionHouse_bid.py → tests/test_AuctionHouse_bid.py b/fair-funding/tests/test_AuctionHouse_bid.py → tests/test_AuctionHouse_bid.py
diff --git a/...funding/tests/test_AuctionHouse_config.py → tests/test_AuctionHouse_config.py b/...funding/tests/test_AuctionHouse_config.py → tests/test_AuctionHouse_config.py
diff --git a/...funding/tests/test_AuctionHouse_events.py → tests/test_AuctionHouse_events.py b/...funding/tests/test_AuctionHouse_events.py → tests/test_AuctionHouse_events.py
diff --git a/...funding/tests/test_AuctionHouse_settle.py → tests/test_AuctionHouse_settle.py b/...funding/tests/test_AuctionHouse_settle.py → tests/test_AuctionHouse_settle.py
diff --git a/...-funding/tests/test_AuctionHouse_setup.py → tests/test_AuctionHouse_setup.py b/...-funding/tests/test_AuctionHouse_setup.py → tests/test_AuctionHouse_setup.py
diff --git a/...-funding/tests/test_AuctionHouse_start.py → tests/test_AuctionHouse_start.py b/...-funding/tests/test_AuctionHouse_start.py → tests/test_AuctionHouse_start.py
diff --git a/fair-funding/tests/test_NFT_actions.py → tests/test_NFT_actions.py b/fair-funding/tests/test_NFT_actions.py → tests/test_NFT_actions.py
diff --git a/fair-funding/tests/test_Vault_alcx.py → tests/test_Vault_alcx.py b/fair-funding/tests/test_Vault_alcx.py → tests/test_Vault_alcx.py
diff --git a/fair-funding/tests/test_Vault_auth.py → tests/test_Vault_auth.py b/fair-funding/tests/test_Vault_auth.py → tests/test_Vault_auth.py
diff --git a/fair-funding/tests/test_Vault_deposit.py → tests/test_Vault_deposit.py b/fair-funding/tests/test_Vault_deposit.py → tests/test_Vault_deposit.py
diff --git a/fair-funding/tests/test_Vault_events.py → tests/test_Vault_events.py b/fair-funding/tests/test_Vault_events.py → tests/test_Vault_events.py
diff --git a/fair-funding/tests/test_Vault_liquidate.py → tests/test_Vault_liquidate.py b/fair-funding/tests/test_Vault_liquidate.py → tests/test_Vault_liquidate.py
diff --git a/fair-funding/tests/test_Vault_migrate.py → tests/test_Vault_migrate.py b/fair-funding/tests/test_Vault_migrate.py → tests/test_Vault_migrate.py
diff --git a/fair-funding/tests/test_Vault_setup.py → tests/test_Vault_setup.py b/fair-funding/tests/test_Vault_setup.py → tests/test_Vault_setup.py
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		.pytest_chache/
		tintinweb.vscode-vyper-0.0.15.vsix