From 1790e360b6422e15903c349dd33afcade281ba90 Mon Sep 17 00:00:00 2001 From: Pablo Veyrat Date: Mon, 6 Mar 2023 16:33:23 +0100 Subject: [PATCH 1/3] fix: readme of the strategies --- README.md | 33 ++++++++++++++++++++++++++++++--- lib/forge-std | 2 +- 2 files changed, 31 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index dfef9fb..b2e4b54 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,27 @@ [![CI](https://github.com/AngleProtocol/strategies-dev/workflows/CI/badge.svg)](https://github.com/AngleProtocol/strategies-dev/actions?query=workflow%3ACI) -This repository proposes a template that mixes hardhat and foundry frameworks. It also provides templates for EVM compatible smart contracts (in `./contracts/examples`), tests and deployment scripts. +## Documentation + +### To Start With + +Like many yield aggregators, Angle implements yield strategies to provide the best yields to its LPs, and to make a revenue for veANGLE holders. This repo contains the strategies implemented on the Angle Protocol. + +Documentation to understand Angle Protocol's strategies is available [here](https://docs.angle.money/angle-core-module/lending). + +Developers documentation to understand the smart contract architecture is available [here](https://developers.angle.money/core-module-contracts/smart-contracts-docs/adapters). + +### Further Information + +For a broader overview of the protocol and its different modules, you can also check [this overview page](https://developers.angle.money) of our developers documentation. + +Other Angle-related smart contracts can be found in the following repositories: + +- [Angle Borrowing module contracts](https://github.com/AngleProtocol/angle-borrow) +- [Angle Core module contracts](https://github.com/AngleProtocol/angle-core) +- [Angle Direct deposit module contracts](https://github.com/AngleProtocol/angle-amo) + +Otherwise, for more info about the protocol, check out [this portal](https://linktr.ee/angleprotocol) of resources. ## Starting @@ -30,11 +50,11 @@ Warning: always keep your confidential information safe. ## Headers -To automatically create headers, follow: https://github.com/Picodes/headers +To automatically create headers, follow: ## Hardhat Command line completion -Follow these instructions to have hardhat command line arguments completion: https://hardhat.org/hardhat-runner/docs/guides/command-line-completion +Follow these instructions to have hardhat command line arguments completion: ## Foundry Installation @@ -77,6 +97,13 @@ docker run -it --rm -v $(pwd):/app -w /app foundry sh Then you are inside the container and can run Foundry’s commands. +### Compilation + +```bash +yarn hardhat:compile +yarn foundry:compile +``` + ### Tests You can run tests as follows: diff --git a/lib/forge-std b/lib/forge-std index 662ae0d..eb980e1 160000 --- a/lib/forge-std +++ b/lib/forge-std @@ -1 +1 @@ -Subproject commit 662ae0d6936654c5d1fb79fc15f521de28edb60e +Subproject commit eb980e1d4f0e8173ec27da77297ae411840c8ccb From 5629044d73b5e33ba737f5e607e6def93366c04c Mon Sep 17 00:00:00 2001 From: Pablo Veyrat Date: Mon, 6 Mar 2023 16:36:15 +0100 Subject: [PATCH 2/3] add audits and bounty --- README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/README.md b/README.md index b2e4b54..3ae0ee9 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,35 @@ Other Angle-related smart contracts can be found in the following repositories: Otherwise, for more info about the protocol, check out [this portal](https://linktr.ee/angleprotocol) of resources. +## Audits + +Angle smart contracts have been audited by [Chainsecurity](https://docs.angle.money/resources/audits#chainsecurity-july-october-2021) and [Sigma Prime](https://docs.angle.money/resources/audits#sigma-prime-july-october-2021). + +All Angle Protocol related audits can be found in [this page](https://docs.angle.money/resources/audits) of our docs. + +Some strategies in this repo have not been audited, but were forked from other protocols like Yearn. + +## Bug Bounty + +At Angle, we consider the security of our systems a top priority. But even putting top priority status and maximum effort, there is still possibility that vulnerabilities exist. + +We have therefore setup a bug bounty program with the help of Immunefi. The Angle Protocol bug bounty program is focused around our smart contracts with a primary interest in the prevention of: + +- Thefts and freezing of principal of any amount +- Thefts and freezing of unclaimed yield of any amount +- Theft of governance funds +- Governance activity disruption + +For more details, please refer to the [official page of the bounty on Immunefi](https://immunefi.com/bounty/angleprotocol/). + +| Level | | +| :------- | :------------------ | +| Critical | up to USD \$500,000 | +| High | USD \$20,000 | +| Medium | USD \$2,500 | + +All bug reports must include a Proof of Concept demonstrating how the vulnerability can be exploited to be eligible for a reward. This may be a smart contract itself or a transaction. + ## Starting ### Install packages From 58b1383b66555b3fc98ce622817a679ead9ebfcc Mon Sep 17 00:00:00 2001 From: Pablo Veyrat Date: Mon, 6 Mar 2023 16:37:51 +0100 Subject: [PATCH 3/3] rename strategy repo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3ae0ee9..cf78876 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Angle Strategies Angle Project Strategies -[![CI](https://github.com/AngleProtocol/strategies-dev/workflows/CI/badge.svg)](https://github.com/AngleProtocol/strategies-dev/actions?query=workflow%3ACI) +[![CI](https://github.com/AngleProtocol/angle-strategies/workflows/CI/badge.svg)](https://github.com/AngleProtocol/angle-strategies/actions?query=workflow%3ACI) ## Documentation