@etherisc/gif-next 0.0.2-e802d97-251 → 0.0.2-e81f152-917

package/README.md

@@ -68,7 +68,6 @@ The deploy script will deploy all required contracts and create a test instance
 
 ```bash
 # run deployment on a locally created ganache instance
-export SKIP_VERIFICATION=true
 hh run scripts/deploy_all.ts
 ```
 
@@ -79,9 +78,17 @@ hh run scripts/deploy_all.ts
 hh run --network <networkname> scripts/deploy_all.ts
 ```
 
+The deployment will persist deployment information into the files `deployment_state_<chainid>.json`, `libraries_<chainid>.json` and `verification_log_<chainid>.json`. 
+This data can then be used for verification of the deployed contracts on etherscan/polygonscan.
+
+For the verification of the contracts on etherscan/polygonscan the above files (created by previous deployment) are required and then the following command can be used:
+
+```bash
+hh run --network <networkname> scripts/verify_deployment.ts 
+```
+
 Environment variables:
 
-- `SKIP_VERIFICATION` set to `true` to skip etherscan verification (required for ganacht and anvil)
 - `WEB3_INFURA_PROJECT_ID` set to infura project id (required for mumbai and mainnet)
 - `WALLET_MNEMONIC` the mnemonic of the wallet to use for deployment (required for mumbai and mainnet)
 - `ETHERSCAN_API_KEY` `POLYGONSCAN_API_KEY` the api key for etherscan/polygonscan (required for mumbai and mainnet)
@@ -121,6 +128,27 @@ await provider.getBalance(me)
 
 https://hardhat.org/hardhat-runner/docs/guides/compile-contracts
 
+### Scripts to find syntax bugs in code
+
+#### find methods missing the `restricted` modifier
+
+```bash
+hh run scripts/find_unrestricted_methods.ts.ts
+```
+
+Checks all public/external methods in services and components for methods that are missing the `restricted` modifier but should have one.
+
+The script `find_unrestricted_methods.ts` is based on the ANTLR grammar `Solidity.g4` (from https://github.com/solidity-parser/antlr) and uses the antlr4ng runtime (https://github.com/mike-lischke/antlr4ng).
+To compile grammar to ts classes run `antlr4ng -Dlanguage=TypeScript -o antlr/generated/ -visitor -listener  antlr/Solidity.g4` (requires openjdk to be installed `sudo apt install openjdk-17-jre-headless`).
+
+#### find methods missing the `virtual` keyword
+
+```bash
+hh run scripts/find_missing_virtual_methods.ts.ts
+```
+
+Checks all public/external methods in services and components for methods that are not marked as `virtual` but should be.
+
 ## Forge 
 
 ### Commands
@@ -146,11 +174,28 @@ forge test --mt test_decimals --gas-report
 # provide code coverage report
 forge coverage
 forge coverage --report lcov 
+```
 
+### Aliases 
 
-```
 
-Chisel session
+| Alias | Command |
+| --- | --- |
+| fb | forge build |
+| fbw | forge build --watch |
+| fbc | forge build contracts/ |
+| fbcw | forge build --watch contracts/ |
+| ft | forge test |
+| ftf | forge test --nmt "testFuzz\|test_continuous" |
+| ftt | forge test -vvvv --mt |
+| fttw | forge test -vvvv --watch --mt |
+| ftc | forge test -vvvv --mc |
+| ftcw | forge test -vvvv --watch --mc |
+
+**Important**: All profiles are run using the foundry `ci` profile which disables the optimizer (for speed).
+
+### Chisel session
+
 ```typescript
 import "./contracts/components/Component.sol";
 import "./contracts/components/IPool.sol";

package/artifacts/contracts/authorization/AccessAdmin.sol/AccessAdmin.dbg.json

@@ -0,0 +1,4 @@
+{
+  "_format": "hh-sol-dbg-1",
+  "buildInfo": "../../../build-info/796b4225cec9aa0a306121e509145838.json"
+}