Initial commit

sakulstra · web-flow · commit ae92e39ea8ea · 2023-10-12T20:40:42.000+02:00
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,17 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# http://editorconfig.org
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[{Makefile,**.mk}]
+# Use tabs for indentation (Makefiles require tabs)
+indent_style = tab
diff --git a/.env.example b/.env.example
@@ -0,0 +1,34 @@
+# Deployment via ledger
+MNEMONIC_INDEX=
+LEDGER_SENDER=
+
+# Deployment via private key
+PRIVATE_KEY=
+
+# Test rpc_endpoints
+RPC_MAINNET=https://rpc.flashbots.net
+RPC_AVALANCHE=https://api.avax.network/ext/bc/C/rpc
+RPC_OPTIMISM=https://mainnet.optimism.io
+RPC_POLYGON=https://polygon-rpc.com
+RPC_ARBITRUM=https://arb1.arbitrum.io/rpc
+RPC_FANTOM=https://rpc.ftm.tools
+RPC_HARMONY=https://api.harmony.one
+RPC_METIS=https://andromeda.metis.io/?owner=1088
+RPC_BASE=https://mainnet.base.org
+RPC_ZKEVM=https://zkevm-rpc.com
+RPC_GNOSIS=https://rpc.gnosischain.com
+RPC_BNB=https://binance.llamarpc.com
+
+# Etherscan api keys for verification & download utils
+ETHERSCAN_API_KEY_MAINNET=
+ETHERSCAN_API_KEY_POLYGON=
+ETHERSCAN_API_KEY_AVALANCHE=
+ETHERSCAN_API_KEY_FANTOM=
+ETHERSCAN_API_KEY_OPTIMISM=
+ETHERSCAN_API_KEY_ARBITRUM=
+ETHERSCAN_API_KEY_BASE=
+ETHERSCAN_API_KEY_ZKEVM=
+ETHERSCAN_API_KEY_GNOSIS=
+ETHERSCAN_API_KEY_BNB=
+
+
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -0,0 +1,12 @@
+name: Main workflow
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  test:
+    uses: bgd-labs/github-workflows/.github/workflows/foundry-test.yml@main
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,17 @@
+# build and cache
+cache/
+out/
+
+# general
+.env
+
+# editors
+.idea
+.vscode
+
+# well, looks strange to ignore package-lock, but we have only pretter and it's temproray
+package-lock.json
+node_modules
+
+# ignore foundry deploy artifacts
+broadcast/
diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "lib/forge-std"]
+	path = lib/forge-std
+	url = https://github.com/foundry-rs/forge-std
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,4 @@
+out
+lib
+cache
+node_modules
diff --git a/.prettierrc b/.prettierrc
@@ -0,0 +1,24 @@
+{
+  "overrides": [
+    {
+      "files": "*.sol",
+      "options": {
+        "printWidth": 100,
+        "tabWidth": 2,
+        "useTabs": false,
+        "singleQuote": true,
+        "bracketSpacing": false
+      }
+    },
+    {
+      "files": "*.ts",
+      "options": {
+        "printWidth": 100,
+        "tabWidth": 2,
+        "useTabs": false,
+        "singleQuote": true,
+        "bracketSpacing": false
+      }
+    }
+  ]
+}
diff --git a/.solhint.json b/.solhint.json
@@ -0,0 +1,10 @@
+{
+  "extends": "solhint:recommended",
+  "rules": {
+    "compiler-version": ["error", "^0.8.0"],
+    "func-visibility": ["warn", { "ignoreConstructors": true }],
+    "compiler-fixed": false,
+    "quotes": ["error", "single"],
+    "indent": [2]
+  }
+}
diff --git a/.solhintignore b/.solhintignore
@@ -0,0 +1 @@
+node_modules
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,7 @@
+Copyright 2022 BGD Labs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/Makefile b/Makefile
@@ -0,0 +1,16 @@
+# include .env file and export its env vars
+# (-include to ignore error if it does not exist)
+-include .env
+
+# deps
+update:; forge update
+
+# Build & test
+build  :; forge build --sizes
+test   :; forge test -vvv
+
+# Utilities
+download :; cast etherscan-source --chain ${chain} -d src/etherscan/${chain}_${address} ${address}
+git-diff :
+	@mkdir -p diffs
+	@printf '%s\n%s\n%s\n' "\`\`\`diff" "$$(git diff --no-index --diff-algorithm=patience --ignore-space-at-eol ${before} ${after})" "\`\`\`" > diffs/${out}.md
diff --git a/README.md b/README.md
@@ -0,0 +1,56 @@
+# 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.
diff --git a/deploy.sh b/deploy.sh
@@ -0,0 +1,5 @@
+# To load the variables in the .env file
+source .env
+
+# To deploy and verify our contract
+forge script script/Ghost.s.sol:Deploy --rpc-url $RPC_URL  --private-key $PRIVATE_KEY --broadcast --verify --etherscan-api-key $ETHERSCAN_API_KEY -vvvv
diff --git a/foundry.toml b/foundry.toml
@@ -0,0 +1,38 @@
+[profile.default]
+src = 'src'
+test = 'tests'
+script = 'scripts'
+out = 'out'
+libs = ['lib']
+remappings = [
+]
+fs_permissions = [{ access = "write", path = "./reports" }]
+
+[rpc_endpoints]
+mainnet = "${RPC_MAINNET}"
+optimism = "${RPC_OPTIMISM}"
+avalanche = "${RPC_AVALANCHE}"
+polygon = "${RPC_POLYGON}"
+arbitrum = "${RPC_ARBITRUM}"
+fantom = "${RPC_FANTOM}"
+harmony = "${RPC_HARMONY}"
+metis = "${RPC_METIS}"
+base = "${RPC_BASE}"
+zkevm = "${RPC_ZKEVM}"
+gnosis = "${RPC_GNOSIS}"
+bnb = "${RPC_BNB}"
+
+[etherscan]
+mainnet = { key="${ETHERSCAN_API_KEY_MAINNET}", chainId=1 }
+optimism = { key="${ETHERSCAN_API_KEY_OPTIMISM}", chainId=10 }
+avalanche = { key="${ETHERSCAN_API_KEY_AVALANCHE}", chainId=43114 }
+polygon = { key="${ETHERSCAN_API_KEY_POLYGON}", chainId=137 }
+arbitrum = { key="${ETHERSCAN_API_KEY_ARBITRUM}", chainId=42161 }
+fantom = { key="${ETHERSCAN_API_KEY_FANTOM}", chainId=250 }
+metis = { key="any", chainId=1088, url='https://andromeda-explorer.metis.io/' }
+base = { key="${ETHERSCAN_API_KEY_BASE}", chainId=8453 }
+zkevm = { key="${ETHERSCAN_API_KEY_ZKEVM}", chainId=1101 }
+gnosis = { key="${ETHERSCAN_API_KEY_GNOSIS}", chainId=100 }
+bnb = { key="${ETHERSCAN_API_KEY_BNB}", chainId=56 }
+
+# See more config options https://github.com/gakonst/foundry/tree/master/config
diff --git a/lib/forge-std b/lib/forge-std
@@ -0,0 +1 @@
+Subproject commit 066ff16c5c03e6f931cd041fd366bc4be1fae82a
diff --git a/package.json b/package.json
@@ -0,0 +1,23 @@
+{
+  "name": "bgd-forge-template",
+  "version": "1.0.0",
+  "scripts": {
+    "lint": "prettier ./",
+    "lint:fix": "npm run lint -- --write"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/bgd-labs/bgd-forge-template.git"
+  },
+  "keywords": [],
+  "author": "BGD labs",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/bgd-labs/bgd-forge-template/issues"
+  },
+  "homepage": "https://github.com/bgd-labs/bgd-forge-template#readme",
+  "devDependencies": {
+    "prettier": "2.8.7",
+    "prettier-plugin-solidity": "1.1.3"
+  }
+}
diff --git a/reports/.empty b/reports/.empty
diff --git a/scripts/Ghost.s.sol b/scripts/Ghost.s.sol
@@ -0,0 +1,13 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+import {Script} from 'forge-std/Script.sol';
+import {Ghost} from '../src/contracts/Ghost.sol';
+
+contract Deploy is Script {
+  function run() external {
+    vm.startBroadcast();
+    new Ghost();
+    vm.stopBroadcast();
+  }
+}
diff --git a/src/contracts/Ghost.sol b/src/contracts/Ghost.sol
@@ -0,0 +1,10 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+import '../interfaces/IGhost.sol';
+
+contract Ghost is IGhost {
+  function boo() external pure returns (string memory) {
+    return 'Boo!';
+  }
+}
diff --git a/src/interfaces/IGhost.sol b/src/interfaces/IGhost.sol
@@ -0,0 +1,6 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+interface IGhost {
+  function boo() external view returns (string memory);
+}
diff --git a/tests/Ghost.t.sol b/tests/Ghost.t.sol
@@ -0,0 +1,18 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+import {Test} from 'forge-std/Test.sol';
+
+import {Ghost} from '../src/contracts/Ghost.sol';
+
+contract GhostTest is Test {
+  Ghost public ghost;
+
+  function setUp() public {
+    ghost = new Ghost();
+  }
+
+  function testBoo() public {
+    assertEq(ghost.boo(), 'Boo!');
+  }
+}
diff --git a/yarn.lock b/yarn.lock
@@ -0,0 +1,53 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+
+"@solidity-parser/parser@^0.16.0":
+  version "0.16.0"
+  resolved "https://registry.yarnpkg.com/@solidity-parser/parser/-/parser-0.16.0.tgz#1fb418c816ca1fc3a1e94b08bcfe623ec4e1add4"
+  integrity sha512-ESipEcHyRHg4Np4SqBCfcXwyxxna1DgFVz69bgpLV8vzl/NP1DtcKsJ4dJZXWQhY/Z4J2LeKBiOkOVZn9ct33Q==
+  dependencies:
+    antlr4ts "^0.5.0-alpha.4"
+
+antlr4ts@^0.5.0-alpha.4:
+  version "0.5.0-alpha.4"
+  resolved "https://registry.yarnpkg.com/antlr4ts/-/antlr4ts-0.5.0-alpha.4.tgz#71702865a87478ed0b40c0709f422cf14d51652a"
+  integrity sha512-WPQDt1B74OfPv/IMS2ekXAKkTZIHl88uMetg6q3OTqgFxZ/dxDXI0EWLyZid/1Pe6hTftyg5N7gel5wNAGxXyQ==
+
+lru-cache@^6.0.0:
+  version "6.0.0"
+  resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-6.0.0.tgz#6d6fe6570ebd96aaf90fcad1dafa3b2566db3a94"
+  integrity sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==
+  dependencies:
+    yallist "^4.0.0"
+
+prettier-plugin-solidity@1.1.3:
+  version "1.1.3"
+  resolved "https://registry.yarnpkg.com/prettier-plugin-solidity/-/prettier-plugin-solidity-1.1.3.tgz#9a35124f578404caf617634a8cab80862d726cba"
+  integrity sha512-fQ9yucPi2sBbA2U2Xjh6m4isUTJ7S7QLc/XDDsktqqxYfTwdYKJ0EnnywXHwCGAaYbQNK+HIYPL1OemxuMsgeg==
+  dependencies:
+    "@solidity-parser/parser" "^0.16.0"
+    semver "^7.3.8"
+    solidity-comments-extractor "^0.0.7"
+
+prettier@2.8.7:
+  version "2.8.7"
+  resolved "https://registry.yarnpkg.com/prettier/-/prettier-2.8.7.tgz#bb79fc8729308549d28fe3a98fce73d2c0656450"
+  integrity sha512-yPngTo3aXUUmyuTjeTUT75txrf+aMh9FiD7q9ZE/i6r0bPb22g4FsE6Y338PQX1bmfy08i9QQCB7/rcUAVntfw==
+
+semver@^7.3.8:
+  version "7.3.8"
+  resolved "https://registry.yarnpkg.com/semver/-/semver-7.3.8.tgz#07a78feafb3f7b32347d725e33de7e2a2df67798"
+  integrity sha512-NB1ctGL5rlHrPJtFDVIVzTyQylMLu9N9VICA6HSFJo8MCGVTMW6gfpicwKmmK/dAjTOrqu5l63JJOpDSrAis3A==
+  dependencies:
+    lru-cache "^6.0.0"
+
+solidity-comments-extractor@^0.0.7:
+  version "0.0.7"
+  resolved "https://registry.yarnpkg.com/solidity-comments-extractor/-/solidity-comments-extractor-0.0.7.tgz#99d8f1361438f84019795d928b931f4e5c39ca19"
+  integrity sha512-wciNMLg/Irp8OKGrh3S2tfvZiZ0NEyILfcRCXCD4mp7SgK/i9gzLfhY2hY7VMCQJ3kH9UB9BzNdibIVMchzyYw==
+
+yallist@^4.0.0:
+  version "4.0.0"
+  resolved "https://registry.yarnpkg.com/yallist/-/yallist-4.0.0.tgz#9bb92790d9c0effec63be73519e11a35019a3a72"
+  integrity sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+[submodule "lib/forge-std"]`
	`2`	`+ path = lib/forge-std`
	`3`	`+ url = https://github.com/foundry-rs/forge-std`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +out
 +lib
 +cache
 +node_modules