feat: flag for diff generation (#19)

* feat: add optional flag for diff generation

* chore: use npm

* chore: update workflow file

* fix: ci

* fix: readme

* chore: use ALCHEMY_API_KEY

* Update .env.example

Co-authored-by: Lukas <[email protected]>

* chore: update libs

---------

Co-authored-by: Lukas <[email protected]>

.env.example

@@ -5,32 +5,3 @@ LEDGER_SENDER=
 # Deployment via private key
 PRIVATE_KEY=
 
-# Test rpc_endpoints
-RPC_MAINNET=https://eth.llamarpc.com
-RPC_AVALANCHE=https://api.avax.network/ext/bc/C/rpc
-RPC_OPTIMISM=https://optimism.llamarpc.com
-RPC_POLYGON=https://polygon.llamarpc.com
-RPC_ARBITRUM=https://arbitrum.llamarpc.com
-RPC_FANTOM=https://rpc.ftm.tools
-RPC_HARMONY=https://api.harmony.one
-RPC_METIS=https://andromeda.metis.io/?owner=1088
-RPC_BASE=https://base.llamarpc.com
-RPC_ZKEVM=https://zkevm-rpc.com
-RPC_GNOSIS=https://rpc.ankr.com/gnosis
-RPC_BNB=https://binance.llamarpc.com
-RPC_SCROLL=https://rpc.scroll.io
-RPC_ZKSYNC=https://mainnet.era.zksync.io
-
-# 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=
-ETHERSCAN_API_KEY_SCROLL=
-ETHERSCAN_API_KEY_ZKSYNC=

.github/workflows/main.yml

@@ -8,6 +8,10 @@ on:
   workflow_dispatch:
 
 jobs:
-  test:
+  test-solidity:
     uses: bgd-labs/github-workflows/.github/workflows/foundry-test.yml@main
     secrets: inherit
+  test-js:
+    uses: bgd-labs/github-workflows/.github/workflows/test-node.yml@main
+    if: github.event.pull_request.head.repo.full_name == github.repository
+    secrets: inherit

Makefile

@@ -31,4 +31,4 @@ git-diff :
 deploy-ledger :; FOUNDRY_PROFILE=${chain} forge script $(if $(filter zksync,${chain}),--zksync) ${contract} --rpc-url ${chain} $(if ${dry},--sender 0x25F2226B597E8F9514B3F68F00f494cF4f286491 -vvvv, --ledger --mnemonic-indexes ${MNEMONIC_INDEX} --sender ${LEDGER_SENDER} --verify -vvvv --slow --broadcast)
 deploy-pk :; FOUNDRY_PROFILE=${chain} forge script $(if $(filter zksync,${chain}),--zksync) ${contract} --rpc-url ${chain} $(if ${dry},--sender 0x25F2226B597E8F9514B3F68F00f494cF4f286491 -vvvv, --private-key ${PRIVATE_KEY} --verify -vvvv --slow --broadcast)
 
-run-script:; FOUNDRY_PROFILE=${network} forge script ${contract} --rpc-url ${network} --sig "run(bool)" ${broadcast} -vv
+run-script:; FOUNDRY_PROFILE=${network} forge script ${contract} --rpc-url ${network} --sig "run(bool, bool)" ${broadcast} ${generate_diff} -vv

README.md

@@ -100,7 +100,7 @@ The `AaveStewardsInjector` contract also introduces an `EXPIRATION_PERIOD` to di
 
 ```sh
 cp .env.example .env
-yarn
+npm install
 forge install
 ```
 
@@ -118,13 +118,12 @@ forge test
 
 ### How to I use the generator tooling to bootstrap the update?
 
-Run `yarn generate` on your terminal in order to start the generator. The generator is a CLI tool which will generate the required helper contract which can be then run to submit updates to the risk steward. The generator will generate the helper contract in the `src/contracts/updates` directory.
+Run `npm run generate` on your terminal in order to start the generator. The generator is a CLI tool which will generate the required helper contract which can be then run to submit updates to the risk steward. The generator will generate the helper contract in the `src/contracts/updates` directory.
 
-To get a full list of available commands run `yarn generate --help`
+To get a full list of available commands run `npm run generate --help`
 
 ```sh
-yarn generate --help
-yarn run v1.22.19
+npm run generate --help
 $ tsx generator/cli --help
 Usage: proposal-generator [options]
 
@@ -143,11 +142,11 @@ Options:
   -h, --help                 display help for command
 ```
 
-Running `yarn generate` you should be able to do the risk updates:
+Running `npm run generate` you should be able to do the risk updates:
 
 ```bash
-yarn generate
-yarn run v1.22.19
+npm run generate
+
 $ tsx generator/cli
 ? Chains this proposal targets AaveV3Ethereum
 ? Short title of your steward update that will be used as contract name (please refrain from including author or date) TestRateUpdate
@@ -172,11 +171,11 @@ $ tsx generator/cli
 
 The generator generates the scripts for doing the updates in `src/contracts/updates` directory.
 
-The script can be executed by running: `make run-script network=mainnet contract_path=src/contracts/examples/EthereumExample.sol:EthereumExample broadcast=false` where the bool inside the `broadcast=` determines if the calldata should be sent to safe. The script also emits the calldata for doing the update in the console which can be used on the safe manually as well.
+The script can be executed by running: `make run-script network=mainnet contract_path=src/contracts/examples/EthereumExample.sol:EthereumExample broadcast=false generate_diff=true` where the bool inside the `broadcast=` determines if the calldata should be sent to safe and `generate_diff=` determines if diff report should be generated. The script also emits the calldata for doing the update in the console which can be used on the safe manually as well.
 
 ### Before I will submit anything to sign, how do I test out the update, or get visibility from what will happen?
 
-Running the script generated on the contracts in `src/contracts/updates` directory with `broadcast=false`, there will files written into the diffs directory, which will show the params changed for the asset by the update, with before and after values which can be validated with what update is expected.
+Running the script generated on the contracts in `src/contracts/updates` directory with `generate_diff=true`, there will files written into the diffs directory, which will show the params changed for the asset by the update, with before and after values which can be validated with what update is expected.
 
 ### Once I have full assurance it looks correct, how do I submit to Safe?
 

generator/features/__snapshots__/capUpdates.spec.ts.snap

@@ -34,7 +34,7 @@ import {IAaveV3ConfigEngine} from 'aave-v3-origin/src/contracts/extensions/v3-co
  * @title test
  * @author test
  * - discussion: test
- * - deploy-command: make run-script contract=src/contracts/updates/20231023_AaveV3Ethereum_Test/AaveV3Ethereum_Test_20231023.sol:AaveV3Ethereum_Test_20231023 network=mainnet broadcast=false
+ * - deploy-command: make run-script contract=src/contracts/updates/20231023_AaveV3Ethereum_Test/AaveV3Ethereum_Test_20231023.sol:AaveV3Ethereum_Test_20231023 network=mainnet broadcast=false generate_diff=true
  */
 contract AaveV3Ethereum_Test_20231023 is RiskStewardsEthereum {
   function name() public pure override returns (string memory) {

generator/features/__snapshots__/collateralUpdates.spec.ts.snap

@@ -46,7 +46,7 @@ import {IAaveV3ConfigEngine} from 'aave-v3-origin/src/contracts/extensions/v3-co
  * @title test
  * @author test
  * - discussion: test
- * - deploy-command: make run-script contract=src/contracts/updates/20231023_AaveV3Ethereum_Test/AaveV3Ethereum_Test_20231023.sol:AaveV3Ethereum_Test_20231023 network=mainnet broadcast=false
+ * - deploy-command: make run-script contract=src/contracts/updates/20231023_AaveV3Ethereum_Test/AaveV3Ethereum_Test_20231023.sol:AaveV3Ethereum_Test_20231023 network=mainnet broadcast=false generate_diff=true
  */
 contract AaveV3Ethereum_Test_20231023 is RiskStewardsEthereum {
   function name() public pure override returns (string memory) {

generator/features/__snapshots__/lstPriceCapUpdates.spec.ts.snap

@@ -43,7 +43,7 @@ import {IRiskSteward, IPriceCapAdapter} from '../../../interfaces/IRiskSteward.s
  * @title test
  * @author test
  * - discussion: test
- * - deploy-command: make run-script contract=src/contracts/updates/20231023_AaveV3Ethereum_Test/AaveV3Ethereum_Test_20231023.sol:AaveV3Ethereum_Test_20231023 network=mainnet broadcast=false
+ * - deploy-command: make run-script contract=src/contracts/updates/20231023_AaveV3Ethereum_Test/AaveV3Ethereum_Test_20231023.sol:AaveV3Ethereum_Test_20231023 network=mainnet broadcast=false generate_diff=true
  */
 contract AaveV3Ethereum_Test_20231023 is RiskStewardsEthereum {
   function name() public pure override returns (string memory) {

generator/features/__snapshots__/rateUpdates.spec.ts.snap

@@ -83,7 +83,7 @@ import {IAaveV3ConfigEngine} from 'aave-v3-origin/src/contracts/extensions/v3-co
  * @title test
  * @author test
  * - discussion: test
- * - deploy-command: make run-script contract=src/contracts/updates/20231023_AaveV3Ethereum_Test/AaveV3Ethereum_Test_20231023.sol:AaveV3Ethereum_Test_20231023 network=mainnet broadcast=false
+ * - deploy-command: make run-script contract=src/contracts/updates/20231023_AaveV3Ethereum_Test/AaveV3Ethereum_Test_20231023.sol:AaveV3Ethereum_Test_20231023 network=mainnet broadcast=false generate_diff=true
  */
 contract AaveV3Ethereum_Test_20231023 is RiskStewardsEthereum {
   function name() public pure override returns (string memory) {

generator/features/__snapshots__/stablePriceCapUpdates.spec.ts.snap

@@ -34,7 +34,7 @@ import {IRiskSteward} from '../../../interfaces/IRiskSteward.sol';
  * @title test
  * @author test
  * - discussion: test
- * - deploy-command: make run-script contract=src/contracts/updates/20231023_AaveV3Ethereum_Test/AaveV3Ethereum_Test_20231023.sol:AaveV3Ethereum_Test_20231023 network=mainnet broadcast=false
+ * - deploy-command: make run-script contract=src/contracts/updates/20231023_AaveV3Ethereum_Test/AaveV3Ethereum_Test_20231023.sol:AaveV3Ethereum_Test_20231023 network=mainnet broadcast=false generate_diff=true
  */
 contract AaveV3Ethereum_Test_20231023 is RiskStewardsEthereum {
   function name() public pure override returns (string memory) {

generator/templates/proposal.template.ts

@@ -23,7 +23,7 @@ export const proposalTemplate = (
   * @title ${title || 'TODO'}
   * @author ${author || 'TODO'}
   * - discussion: ${discussion || 'TODO'}
-  * - deploy-command: make run-script contract=src/contracts/updates/${folderName}/${contractName}.sol:${contractName} network=${getChainAlias(chain)} broadcast=false
+  * - deploy-command: make run-script contract=src/contracts/updates/${folderName}/${contractName}.sol:${contractName} network=${getChainAlias(chain)} broadcast=false generate_diff=true
   */
  contract ${contractName} is ${`RiskStewards${chain}`
  } {

package.json

@@ -27,7 +27,7 @@
     "prettier-plugin-solidity": "1.1.3",
     "vitest": "^2.0.4",
     "@bgd-labs/aave-address-book": "^4.3.2",
-    "@bgd-labs/aave-cli": "^1.1.0",
+    "@bgd-labs/aave-cli": "^1.1.12",
     "@bgd-labs/js-utils": "^1.4.2",
     "@inquirer/prompts": "^3.3.0",
     "@inquirer/testing": "^2.1.13",

scripts/RiskStewardsBase.s.sol

@@ -39,9 +39,9 @@ abstract contract RiskStewardsBase is ProtocolV3TestBase {
   /**
    * @notice This script doesn't broadcast as it's intended to be used via safe
    */
-  function run(bool broadcastToSafe) external {
+  function run(bool broadcastToSafe, bool generateDiffReport) external {
     vm.startPrank(STEWARD.RISK_COUNCIL());
-    bytes[] memory callDatas = _simulateAndGenerateDiff();
+    bytes[] memory callDatas = _simulateAndGenerateDiff(generateDiffReport);
     vm.stopPrank();
 
     if (callDatas.length > 1) emit log_string('** multiple calldatas emitted, please execute them all **');
@@ -60,7 +60,7 @@ abstract contract RiskStewardsBase is ProtocolV3TestBase {
     }
   }
 
-  function _simulateAndGenerateDiff() internal returns (bytes[] memory) {
+  function _simulateAndGenerateDiff(bool generateDiffReport) internal returns (bytes[] memory) {
     bytes[] memory callDatas = new bytes[](MAX_TX);
     uint8 txCount;
 
@@ -73,7 +73,8 @@ abstract contract RiskStewardsBase is ProtocolV3TestBase {
     IRiskSteward.PriceCapLstUpdate[] memory lstPriceCapUpdates = lstPriceCapsUpdates();
     IRiskSteward.PriceCapStableUpdate[] memory stablePriceCapUpdates = stablePriceCapsUpdates();
 
-    createConfigurationSnapshot(pre, POOL);
+    bool rateUpdatesPresent = rateUpdates.length != 0;
+    if (generateDiffReport) createConfigurationSnapshot(pre, POOL, true, rateUpdatesPresent, false, false);
 
     if (capUpdates.length != 0) {
       callDatas[txCount] = abi.encodeWithSelector(
@@ -125,8 +126,10 @@ abstract contract RiskStewardsBase is ProtocolV3TestBase {
       txCount++;
     }
 
-    createConfigurationSnapshot(post, POOL);
-    diffReports(pre, post);
+    if (generateDiffReport) {
+      createConfigurationSnapshot(post, POOL, true, rateUpdatesPresent, false, false);
+      diffReports(pre, post);
+    }
 
     // we defined the callDatas with MAX_TX size, we now squash it to the number of txs
     assembly {

src/contracts/examples/ArbitrumExample.sol

@@ -6,7 +6,7 @@ import {IAaveV3ConfigEngine as IEngine} from 'aave-v3-origin/src/contracts/exten
 import {EngineFlags} from 'aave-v3-origin/src/contracts/extensions/v3-config-engine/EngineFlags.sol';
 import {RiskStewardsArbitrum} from '../../../scripts/networks/RiskStewardsArbitrum.s.sol';
 
-// make run-script network=arbitrum contract_path=src/contracts/examples/ArbitrumExample.sol:ArbitrumExample broadcast=false
+// make run-script network=arbitrum contract=src/contracts/examples/ArbitrumExample.sol:ArbitrumExample broadcast=false generate_diff=true
 contract ArbitrumExample is RiskStewardsArbitrum {
   /**
    * @return string name identifier used for the diff

src/contracts/examples/AvalancheExample.sol

@@ -6,7 +6,7 @@ import {IAaveV3ConfigEngine as IEngine} from 'aave-v3-origin/src/contracts/exten
 import {EngineFlags} from 'aave-v3-origin/src/contracts/extensions/v3-config-engine/EngineFlags.sol';
 import {RiskStewardsAvalanche} from '../../../scripts/networks/RiskStewardsAvalanche.s.sol';
 
-// make run-script network=avalanche contract_path=src/contracts/examples/AvalancheExample.sol:AvalancheExample broadcast=false
+// make run-script network=avalanche contract=src/contracts/examples/AvalancheExample.sol:AvalancheExample broadcast=false generate_diff=true
 contract AvalancheExample is RiskStewardsAvalanche {
   /**
    * @return string name identifier used for the diff

src/contracts/examples/BNBExample.sol

@@ -6,7 +6,7 @@ import {IAaveV3ConfigEngine as IEngine} from 'aave-v3-origin/src/contracts/exten
 import {EngineFlags} from 'aave-v3-origin/src/contracts/extensions/v3-config-engine/EngineFlags.sol';
 import {RiskStewardsBNB} from '../../../scripts/networks/RiskStewardsBNB.s.sol';
 
-// make run-script network=bnb contract_path=src/contracts/examples/BNBExample.sol:BNBExample broadcast=false
+// make run-script network=bnb contract=src/contracts/examples/BNBExample.sol:BNBExample broadcast=false generate_diff=true
 contract BNBExample is RiskStewardsBNB {
   /**
    * @return string name identifier used for the diff

src/contracts/examples/BaseExample.sol

@@ -6,7 +6,7 @@ import {IAaveV3ConfigEngine as IEngine} from 'aave-v3-origin/src/contracts/exten
 import {EngineFlags} from 'aave-v3-origin/src/contracts/extensions/v3-config-engine/EngineFlags.sol';
 import {RiskStewardsBaseChain} from '../../../scripts/networks/RiskStewardsBaseChain.s.sol';
 
-// make run-script network=base contract_path=src/contracts/examples/BaseExample.sol:BaseExample broadcast=false
+// make run-script network=base contract=src/contracts/examples/BaseExample.sol:BaseExample broadcast=false generate_diff=true
 contract BaseExample is RiskStewardsBaseChain {
   /**
    * @return string name identifier used for the diff

src/contracts/examples/EthereumExample.sol

@@ -7,7 +7,7 @@ import {EngineFlags} from 'aave-v3-origin/src/contracts/extensions/v3-config-eng
 import {RiskStewardsEthereum} from '../../../scripts/networks/RiskStewardsEthereum.s.sol';
 import {IRiskSteward, IPriceCapAdapter} from '../../interfaces/IRiskSteward.sol';
 
-// make run-script network=mainnet contract_path=src/contracts/examples/EthereumExample.sol:EthereumExample broadcast=false
+// make run-script network=mainnet contract=src/contracts/examples/EthereumExample.sol:EthereumExample broadcast=false generate_diff=true
 contract EthereumExample is RiskStewardsEthereum {
   /**
    * @return string name identifier used for the diff

src/contracts/examples/EthereumLidoExample.sol

@@ -6,7 +6,7 @@ import {IAaveV3ConfigEngine as IEngine} from 'aave-v3-origin/src/contracts/exten
 import {EngineFlags} from 'aave-v3-origin/src/contracts/extensions/v3-config-engine/EngineFlags.sol';
 import {RiskStewardsEthereumLido} from '../../../scripts/networks/RiskStewardsEthereumLido.s.sol';
 
-// make run-script network=mainnet contract_path=src/contracts/examples/EthereumLidoExample.sol:EthereumLidoExample broadcast=false
+// make run-script network=mainnet contract=src/contracts/examples/EthereumLidoExample.sol:EthereumLidoExample broadcast=false generate_diff=true
 contract EthereumLidoExample is RiskStewardsEthereumLido {
   /**
    * @return string name identifier used for the diff

src/contracts/examples/GnosisExample.sol

@@ -6,7 +6,7 @@ import {IAaveV3ConfigEngine as IEngine} from 'aave-v3-origin/src/contracts/exten
 import {EngineFlags} from 'aave-v3-origin/src/contracts/extensions/v3-config-engine/EngineFlags.sol';
 import {RiskStewardsGnosis} from '../../../scripts/networks/RiskStewardsGnosis.s.sol';
 
-// make run-script network=gnosis contract_path=src/contracts/examples/GnosisExample.sol:GnosisExample broadcast=false
+// make run-script network=gnosis contract=src/contracts/examples/GnosisExample.sol:GnosisExample broadcast=false generate_diff=true
 contract GnosisExample is RiskStewardsGnosis {
   /**
    * @return string name identifier used for the diff

src/contracts/examples/MetisExample.sol

@@ -6,7 +6,7 @@ import {IAaveV3ConfigEngine as IEngine} from 'aave-v3-origin/src/contracts/exten
 import {EngineFlags} from 'aave-v3-origin/src/contracts/extensions/v3-config-engine/EngineFlags.sol';
 import {RiskStewardsMetis} from '../../../scripts/networks/RiskStewardsMetis.s.sol';
 
-// make run-script network=metis contract_path=src/contracts/examples/MetisExample.sol:MetisExample broadcast=false
+// make run-script network=metis contract=src/contracts/examples/MetisExample.sol:MetisExample broadcast=false generate_diff=true
 contract MetisExample is RiskStewardsMetis {
   /**
    * @return string name identifier used for the diff

src/contracts/examples/OptimismExample.sol

@@ -6,7 +6,7 @@ import {IAaveV3ConfigEngine as IEngine} from 'aave-v3-origin/src/contracts/exten
 import {EngineFlags} from 'aave-v3-origin/src/contracts/extensions/v3-config-engine/EngineFlags.sol';
 import {RiskStewardsOptimism} from '../../../scripts/networks/RiskStewardsOptimism.s.sol';
 
-// make run-script network=optimism contract_path=src/contracts/examples/OptimismExample.sol:OptimismExample broadcast=false
+// make run-script network=optimism contract=src/contracts/examples/OptimismExample.sol:OptimismExample broadcast=false generate_diff=true
 contract OptimismExample is RiskStewardsOptimism {
   /**
    * @return string name identifier used for the diff

src/contracts/examples/PolygonExample.sol

@@ -6,7 +6,7 @@ import {IAaveV3ConfigEngine as IEngine} from 'aave-v3-origin/src/contracts/exten
 import {EngineFlags} from 'aave-v3-origin/src/contracts/extensions/v3-config-engine/EngineFlags.sol';
 import {RiskStewardsPolygon} from '../../../scripts/networks/RiskStewardsPolygon.s.sol';
 
-// make run-script network=polygon contract_path=src/contracts/examples/PolygonExample.sol:PolygonExample broadcast=false
+// make run-script network=polygon contract=src/contracts/examples/PolygonExample.sol:PolygonExample broadcast=false generate_diff=true
 contract PolygonExample is RiskStewardsPolygon {
   /**
    * @return string name identifier used for the diff

src/contracts/examples/ScrollExample.sol

@@ -6,7 +6,7 @@ import {IAaveV3ConfigEngine as IEngine} from 'aave-v3-origin/src/contracts/exten
 import {EngineFlags} from 'aave-v3-origin/src/contracts/extensions/v3-config-engine/EngineFlags.sol';
 import {RiskStewardsScroll} from '../../../scripts/networks/RiskStewardsScroll.s.sol';
 
-// make run-script network=scroll contract_path=src/contracts/examples/ScrollExample.sol:ScrollExample broadcast=false
+// make run-script network=scroll contract=src/contracts/examples/ScrollExample.sol:ScrollExample broadcast=false generate_diff=true
 contract ScrollExample is RiskStewardsScroll {
   /**
    * @return string name identifier used for the diff