From a771959af02ac5ad6b48db4bffed24cf126ab488 Mon Sep 17 00:00:00 2001 From: Harsh Pandey Date: Mon, 8 Jan 2024 12:35:47 +0530 Subject: [PATCH] fix: readme --- README.md | 57 +------------------------------------------------------ 1 file changed, 1 insertion(+), 56 deletions(-) diff --git a/README.md b/README.md index cfedd12..6815a70 100644 --- a/README.md +++ b/README.md @@ -1,56 +1 @@ -# BGD forge template - -Basic template with prettier and rest configuration - -To create a new project using this template run - -```shell -$ forge init --template bgd-labs/bgd-forge-template my_new_project -``` - -## Recommended modules - -[bgd-labs/solidity-utils](https://github.com/bgd-labs/solidity-utils) - common contracts we use everywhere, ie transparent proxy and around - -[bgd-labs/aave-address-book](https://github.com/bgd-labs/aave-address-book) - the best and only source about all deployed Aave ecosystem related contracts across all the chains - -[bgd-labs/aave-helpers](https://github.com/bgd-labs/aave-helpers) - useful utils for integration, and not only testing related to Aave ecosystem contracts - -[Rari-Capital/solmate](https://github.com/Rari-Capital/solmate) - one of the best sources of base contracts for ERC20, ERC21, which will work with transparent proxy pattern out of the box - -[OpenZeppelin/openzeppelin-contracts](https://github.com/OpenZeppelin/openzeppelin-contracts) - another very reputable and well organized source of base contracts for tokens, access control and many others - -## Development - -This project uses [Foundry](https://getfoundry.sh). See the [book](https://book.getfoundry.sh/getting-started/installation.html) for detailed instructions on how to install and use Foundry. -The template ships with sensible default so you can use default `foundry` commands without resorting to `MakeFile`. - -### Setup - -```sh -cp .env.example .env -forge install -``` - -### Test - -```sh -forge test -``` - -## Advanced features - -### Diffing - -For contracts upgrading implementations it's quite important to diff the implementation code to spot potential issues and ensure only the intended changes are included. -Therefore the `Makefile` includes some commands to streamline the diffing process. - -#### Download - -You can `download` the current contract code of a deployed contract via `make download chain=polygon address=0x00`. This will download the contract source for specified address to `src/etherscan/chain_address`. This command works for all chains with a etherscan compatible block explorer. - -#### Git diff - -You can `git-diff` a downloaded contract against your src via `make git-diff before=./etherscan/chain_address after=./src out=filename`. This command will diff the two folders via git patience algorithm and write the output to `diffs/filename.md`. - -**Caveat**: If the onchain implementation was verified using flatten, for generating the diff you need to flatten the new contract via `forge flatten` and supply the flattened file instead fo the whole `./src` folder. +# Aave Risk Stewards Phase 2