feat: add gov v3 helpers (#139)

* feat: add gov v3 helpers

* fix: added helper methods

* fix: patch stdStorage

* fix: make it build

* fix: v2 helper fix

* fix: deduplicate ipfs tools

* fix: stash local changes

* feat: push gov v3helpers

* fix: update aligned with discussion

* feat: add proposal execution flow

* fix: allow overwriting proposals count

* feat: inject payloads

* fix: update to new address book

* fix: change visibility

* feat: initial ready proposal

* feat: implement readyProposal for govv3

* feat: add overload for single proposal

* fix: update scripts

* fix: update ipfs test

* fix: add broken methods

* feat: integrate cli into helpers

* stash: stash local changes

* feat: add overloads

* docs: add a sentence on readme

* Update src/GovV3Helpers.sol

* fix: add voting script

* fix: add readme

* fix: some patches to storage utils

* fix: add activateVoting to test

* fix: remove unncessary tests

* fix: last few patches

* Update src/ChainIds.sol

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

* fix: add sepolia rpc

* fix: typo

* Update src/GovV3Helpers.sol

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

* Update src/GovV3Helpers.sol

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

* fix: update address book

---------

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

.env.example

@@ -11,6 +11,10 @@ RPC_FANTOM=https://rpc.ftm.tools
 RPC_HARMONY=https://api.harmony.one
 RPC_METIS=https://andromeda.metis.io/
 RPC_BASE=https://mainnet.base.org
+RPC_BNB=https://binance.llamarpc.com
+
+# Testnet rpc_endpoints
+RPC_SEPOLIA=wss://ethereum-sepolia.publicnode.com
 
 ETHERSCAN_API_KEY_MAINNET=
 ETHERSCAN_API_KEY_POLYGON=
@@ -19,3 +23,4 @@ ETHERSCAN_API_KEY_FANTOM=
 ETHERSCAN_API_KEY_OPTIMISM=
 ETHERSCAN_API_KEY_ARBITRUM=
 ETHERSCAN_API_KEY_BASE=
+ETHERSCAN_API_KEY_BNB=

Makefile

@@ -55,4 +55,7 @@ deploy-config-engine-v2-ava :; forge script scripts/AaveV2ConfigEngine.s.sol:Dep
 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
+	@printf '%s\n%s\n%s\n' "\`\`\`diff" "$$(git diff --no-index --diff-algorithm=patience --ignore-space-at-eol ${before} ${after})" "\`\`\`" > diffs/${out}.md
+
+# Voting scripts
+vote :;  forge script scripts/VotingScripts.s.sol:VoteForProposal --rpc-url mainnet --broadcast --ledger --mnemonic-indexes ${MNEMONIC_INDEX} --sender ${LEDGER_SENDER} --verify -vvvv ${proposalId} ${support}

README.md

@@ -2,10 +2,17 @@
 
 This package contains various contracts which allow you to streamline testing within the aave protocol in foundry.
 
-## GovHelpers
+## GovHelpers (deprecated)
 
 These helpers allow you to create and execute proposals on L1 so you don't have to care about having enough proposition power, timings, etc.
 
+## GovV3Helpers
+
+These helpers allow the creation of proposal for aave governance v3.
+
+The GovernanceV3Helpers also contain scripts to cast a vote directly via foundry.
+To do so just run `make vote proposalId=n support=true/false`.
+
 ## ProxyHelpers
 
 These helpers allow you to fetch the current implementation & admin for a specified proxy.
@@ -19,3 +26,7 @@ These helpers allow you to simulate execution of proposals on governance control
 The ProtocolV3TestBase is intended to be used with proposals that alter a V3 pool. While the `helpers` are libraries, you can use from where ever you want `ProtocolV3TestBase` is intended to be inherited from in your test via `is ProtocolV3TestBase`.
 
 When inheriting from `ProtocolV3TestBase` you have access to methods to create readable configuration snapshots of a pool and e2e tests of a pool.
+
+## ProtocolV2TestBase
+
+Analog to ProtocolV3TestBase but for v2 pools.

foundry.toml

@@ -20,6 +20,8 @@ fantom = "${RPC_FANTOM}"
 harmony = "${RPC_HARMONY}"
 metis = "${RPC_METIS}"
 base = "${RPC_BASE}"
+bnb = "${RPC_BNB}"
+sepolia = "${RPC_SEPOLIA}"
 
 [etherscan]
 mainnet={key="${ETHERSCAN_API_KEY_MAINNET}",chainId=1}
@@ -29,5 +31,6 @@ polygon={key="${ETHERSCAN_API_KEY_POLYGON}",chainId=137}
 arbitrum={key="${ETHERSCAN_API_KEY_ARBITRUM}",chainId=42161}
 fantom={key="${ETHERSCAN_API_KEY_FANTOM}",chainId=250}
 base={key="${ETHERSCAN_API_KEY_BASE}",chain=8453}
-
+bnb={key="${ETHERSCAN_API_KEY_BNB}",chainId=56}
+sepolia={key="${ETHERSCAN_API_KEY_MAINNET}",chainId=11155111}
 # See more config options https://github.com/gakonst/foundry/tree/master/config

scripts/VotingScripts.s.sol

@@ -0,0 +1,14 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+import {IVotingMachineWithProofs} from 'aave-address-book/governance-v3/IVotingMachineWithProofs.sol';
+import '../src/ScriptUtils.sol';
+import {GovV3Helpers} from '../src/GovV3Helpers.sol';
+
+contract VoteForProposal is EthereumScript {
+  function run(uint256 proposalId, bool support) external broadcast {
+    IVotingMachineWithProofs.VotingBalanceProof[] memory votingBalanceProofs = GovV3Helpers
+      .getVotingProofs(vm, proposalId, msg.sender);
+    GovV3Helpers.vote(vm, proposalId, votingBalanceProofs, support);
+  }
+}

src/ChainIds.sol

@@ -1,10 +1,11 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.0;
+import {Vm} from 'forge-std/Vm.sol';
 
 library ChainIds {
   uint256 internal constant MAINNET = 1;
   uint256 internal constant OPTIMISM = 10;
-  uint256 internal constant BSC = 56;
+  uint256 internal constant BNB = 56;
   uint256 internal constant POLYGON = 137;
   uint256 internal constant FANTOM = 250;
   uint256 internal constant ZK_SYNC = 324;
@@ -16,3 +17,43 @@ library ChainIds {
   uint256 internal constant SEPOLIA = 11155111;
   uint256 internal constant HARMONY = 1666600000;
 }
+
+library ChainHelpers {
+  error UnknownChainId();
+
+  function selectChain(Vm vm, uint256 chainId) internal returns (uint256, uint256) {
+    uint256 previousFork = vm.activeFork();
+    if (chainId == block.chainid) return (previousFork, previousFork);
+    uint256 newFork;
+    if (chainId == ChainIds.MAINNET) {
+      newFork = vm.createFork(vm.rpcUrl('mainnet'));
+    } else if (chainId == ChainIds.OPTIMISM) {
+      newFork = vm.createFork(vm.rpcUrl('optimism'));
+    } else if (chainId == ChainIds.BNB) {
+      newFork = vm.createFork(vm.rpcUrl('bnb'));
+    } else if (chainId == ChainIds.POLYGON) {
+      newFork = vm.createFork(vm.rpcUrl('polygon'));
+    } else if (chainId == ChainIds.FANTOM) {
+      newFork = vm.createFork(vm.rpcUrl('fantom'));
+    } else if (chainId == ChainIds.ZK_SYNC) {
+      newFork = vm.createFork(vm.rpcUrl('zkSync'));
+    } else if (chainId == ChainIds.METIS) {
+      newFork = vm.createFork(vm.rpcUrl('metis'));
+    } else if (chainId == ChainIds.ZK_EVM) {
+      newFork = vm.createFork(vm.rpcUrl('zkEvm'));
+    } else if (chainId == ChainIds.BASE) {
+      newFork = vm.createFork(vm.rpcUrl('base'));
+    } else if (chainId == ChainIds.ARBITRUM) {
+      newFork = vm.createFork(vm.rpcUrl('arbitrum'));
+    } else if (chainId == ChainIds.AVALANCHE) {
+      newFork = vm.createFork(vm.rpcUrl('avalanche'));
+    } else if (chainId == ChainIds.SEPOLIA) {
+      newFork = vm.createFork(vm.rpcUrl('sepolia'));
+    } else if (chainId == ChainIds.HARMONY) {
+      newFork = vm.createFork(vm.rpcUrl('harmony'));
+    } else {
+      revert UnknownChainId();
+    }
+    return (previousFork, newFork);
+  }
+}

src/GovHelpers.sol

@@ -4,6 +4,7 @@ pragma abicoder v2;
 
 import {Vm} from 'forge-std/Vm.sol';
 import {console2} from 'forge-std/console2.sol';
+import {IpfsUtils} from './IpfsUtils.sol';
 import {AaveGovernanceV2, IAaveGovernanceV2, IExecutorWithTimelock} from 'aave-address-book/AaveGovernanceV2.sol';
 import {IPoolAddressesProvider} from 'aave-address-book/AaveV3.sol';
 import {AaveV3Avalanche} from 'aave-address-book/AaveV3Avalanche.sol';
@@ -42,37 +43,8 @@ library GovHelpers {
     bool withDelegatecall;
   }
 
-  function ipfsHashFile(Vm vm, string memory filePath, bool upload) internal returns (bytes32) {
-    string[] memory inputs = new string[](8);
-    inputs[0] = 'npx';
-    inputs[1] = '--yes';
-    inputs[2] = '-s';
-    inputs[3] = '@bgd-labs/[email protected]';
-    inputs[4] = 'ipfs';
-    inputs[5] = filePath;
-    inputs[6] = '-u';
-    inputs[7] = vm.toString(upload);
-    bytes memory bs58Hash = vm.ffi(inputs);
-    // currenty there is no better way as ffi silently fails
-    // revisit once https://github.com/foundry-rs/foundry/pull/4908 progresses
-    require(
-      bs58Hash.length != 0,
-      'CALCULATED_HASH_IS_ZERO_CHECK_IF_YARN_DEPENDENCIES_ARE_INSTALLED'
-    );
-    console2.logString('Info: This preview will only work when the file has been uploaded to ipfs');
-    console2.logString(
-      string(
-        abi.encodePacked(
-          'Preview: https://app.aave.com/governance/ipfs-preview/?ipfsHash=',
-          vm.toString(bs58Hash)
-        )
-      )
-    );
-    return bytes32(bs58Hash);
-  }
-
   function ipfsHashFile(Vm vm, string memory filePath) internal returns (bytes32) {
-    return ipfsHashFile(vm, filePath, false);
+    return IpfsUtils.ipfsHashFile(vm, filePath, false);
   }
 
   function buildMainnet(address payloadAddress) internal pure returns (Payload memory) {