feat: allow to select voting network via generator (bgd-labs#335)

* feat: allow to select voting network via generator * Update generator/common.ts Co-authored-by: Lukas <[email protected]> * fix: default votingPortal polygon and fix test --------- Co-authored-by: Lukas <[email protected]>
AaveChan · May 13, 2024 · 410c8c5 · 410c8c5
1 parent 4c1a1b2
commit 410c8c5
Show file tree

Hide file tree

Showing 8 changed files with 48 additions and 3 deletions.
diff --git a/generator/cli.ts b/generator/cli.ts
@@ -1,7 +1,7 @@
 import path from 'path';
 import {Command, Option} from 'commander';
 import {CHAIN_TO_CHAIN_ID, getDate, getPoolChain, isV2Pool, pascalCase} from './common';
-import {input, checkbox} from '@inquirer/prompts';
+import {input, checkbox, select} from '@inquirer/prompts';
 import {
   CodeArtifact,
   ConfigFile,
@@ -12,6 +12,7 @@ import {
   PoolCache,
   PoolConfigs,
   PoolIdentifier,
+  VOTING_NETWORK,
 } from './types';
 import {flashBorrower} from './features/flashBorrower';
 import {capsUpdates} from './features/capsUpdates';
@@ -39,6 +40,12 @@ program
   .addOption(new Option('-a, --author <string>', 'author'))
   .addOption(new Option('-d, --discussion <string>', 'forum link'))
   .addOption(new Option('-s, --snapshot <string>', 'snapshot link'))
+  .addOption(
+    new Option(
+      '-v, --votingNetwork <votingNetwork...>',
+      'network where voting should take place for the proposal',
+    ).choices(Object.values(VOTING_NETWORK)),
+  )
   .addOption(new Option('-c, --configFile <string>', 'path to config file'))
   .allowExcessArguments(false)
   .parse(process.argv);
@@ -194,6 +201,17 @@ if (options.configFile) {
     });
   }
 
+  if (!options.votingNetwork) {
+    options.votingNetwork = await select({
+      message: 'Select network where voting should takes place for the proposal',
+      choices: Object.values(VOTING_NETWORK).map((v) => ({
+        name: v != VOTING_NETWORK.POLYGON ? v : VOTING_NETWORK.POLYGON + ' (DEFAULT)',
+        value: v,
+      })),
+      default: VOTING_NETWORK.POLYGON,
+    });
+  }
+
   for (const pool of options.pools) {
     await fetchPoolOptions(pool);
   }

diff --git a/generator/common.ts b/generator/common.ts
@@ -1,5 +1,5 @@
 import * as addressBook from '@bgd-labs/aave-address-book';
-import {Options, PoolIdentifier, PoolIdentifierV3, V2_POOLS} from './types';
+import {Options, PoolIdentifier, PoolIdentifierV3, V2_POOLS, VOTING_NETWORK} from './types';
 import {
   arbitrum,
   avalanche,
@@ -60,6 +60,15 @@ export function getDate() {
   return `${years}${months <= 9 ? '0' : ''}${months}${day <= 9 ? '0' : ''}${day}`;
 }
 
+export function getVotingPortal(votingNetwork?: VOTING_NETWORK) {
+  if (votingNetwork == VOTING_NETWORK.ETHEREUM) {
+    return 'GovernanceV3Ethereum.VOTING_PORTAL_ETH_ETH';
+  } else if (votingNetwork == VOTING_NETWORK.AVALANCHE) {
+    return 'GovernanceV3Ethereum.VOTING_PORTAL_ETH_AVAX';
+  }
+  return 'GovernanceV3Ethereum.VOTING_PORTAL_ETH_POL'; // default voting network is polygon
+}
+
 /**
  * Prefix with the date for proper sorting
  * @param {*} options

diff --git a/generator/features/__snapshots__/assetListing.spec.ts.snap b/generator/features/__snapshots__/assetListing.spec.ts.snap
@@ -222,6 +222,7 @@ contract AaveV3Ethereum_Test_20231023_Test is ProtocolV3TestBase {
 pragma solidity ^0.8.0;
 
 import {GovV3Helpers, IPayloadsControllerCore, PayloadsControllerUtils} from 'aave-helpers/GovV3Helpers.sol';
+import {GovernanceV3Ethereum} from 'aave-address-book/GovernanceV3Ethereum.sol';
 import {EthereumScript} from 'aave-helpers/ScriptUtils.sol';
 import {AaveV3Ethereum_Test_20231023} from './AaveV3Ethereum_Test_20231023.sol';
 
@@ -267,6 +268,7 @@ contract CreateProposal is EthereumScript {
     GovV3Helpers.createProposal(
       vm,
       payloads,
+      GovernanceV3Ethereum.VOTING_PORTAL_ETH_POL,
       GovV3Helpers.ipfsHashFile(vm, 'src/20231023_AaveV3Ethereum_Test/Test.md')
     );
   }

diff --git a/generator/features/__snapshots__/priceFeedsUpdate.spec.ts.snap b/generator/features/__snapshots__/priceFeedsUpdate.spec.ts.snap
@@ -118,6 +118,7 @@ contract AaveV3Ethereum_Test_20231023_Test is ProtocolV3TestBase {
 pragma solidity ^0.8.0;
 
 import {GovV3Helpers, IPayloadsControllerCore, PayloadsControllerUtils} from 'aave-helpers/GovV3Helpers.sol';
+import {GovernanceV3Ethereum} from 'aave-address-book/GovernanceV3Ethereum.sol';
 import {EthereumScript} from 'aave-helpers/ScriptUtils.sol';
 import {AaveV3Ethereum_Test_20231023} from './AaveV3Ethereum_Test_20231023.sol';
 
@@ -163,6 +164,7 @@ contract CreateProposal is EthereumScript {
     GovV3Helpers.createProposal(
       vm,
       payloads,
+      GovernanceV3Ethereum.VOTING_PORTAL_ETH_POL,
       GovV3Helpers.ipfsHashFile(vm, 'src/20231023_AaveV3Ethereum_Test/Test.md')
     );
   }

diff --git a/generator/features/__snapshots__/rateUpdates.spec.ts.snap b/generator/features/__snapshots__/rateUpdates.spec.ts.snap
@@ -224,6 +224,7 @@ contract AaveV2EthereumAMM_Test_20231023_Test is ProtocolV2TestBase {
 pragma solidity ^0.8.0;
 
 import {GovV3Helpers, IPayloadsControllerCore, PayloadsControllerUtils} from 'aave-helpers/GovV3Helpers.sol';
+import {GovernanceV3Ethereum} from 'aave-address-book/GovernanceV3Ethereum.sol';
 import {EthereumScript} from 'aave-helpers/ScriptUtils.sol';
 import {AaveV2EthereumAMM_Test_20231023} from './AaveV2EthereumAMM_Test_20231023.sol';
 
@@ -271,6 +272,7 @@ contract CreateProposal is EthereumScript {
     GovV3Helpers.createProposal(
       vm,
       payloads,
+      GovernanceV3Ethereum.VOTING_PORTAL_ETH_POL,
       GovV3Helpers.ipfsHashFile(vm, 'src/20231023_AaveV2EthereumAMM_Test/Test.md')
     );
   }

diff --git a/generator/templates/script.template.ts b/generator/templates/script.template.ts
@@ -4,6 +4,7 @@ import {
   generateFolderName,
   getChainAlias,
   getPoolChain,
+  getVotingPortal,
 } from '../common';
 import {Options} from '../types';
 import {prefixWithImports} from '../utils/importsResolver';
@@ -12,6 +13,7 @@ import {prefixWithPragma} from '../utils/constants';
 export function generateScript(options: Options) {
   const folderName = generateFolderName(options);
   const fileName = generateContractName(options);
+  const votingPortal = getVotingPortal(options.votingNetwork);
   let template = '';
   const chains = [...new Set(options.pools.map((pool) => getPoolChain(pool)!))];
 
@@ -105,7 +107,7 @@ contract CreateProposal is EthereumScript {
 
     // create proposal
     vm.startBroadcast();
-    GovV3Helpers.createProposal(vm, payloads, GovV3Helpers.ipfsHashFile(vm, 'src/${folderName}/${
+    GovV3Helpers.createProposal(vm, payloads, ${votingPortal}, GovV3Helpers.ipfsHashFile(vm, 'src/${folderName}/${
       options.shortName
     }.md'));
   }

diff --git a/generator/types.ts b/generator/types.ts
@@ -46,6 +46,7 @@ export interface Options {
   force?: boolean;
   pools: PoolIdentifier[];
   title: string;
+  votingNetwork?: VOTING_NETWORK;
   // automatically generated shortName from title
   shortName: string;
   author: string;
@@ -87,6 +88,12 @@ export enum FEATURE {
   OTHERS = 'OTHERS',
 }
 
+export enum VOTING_NETWORK {
+  POLYGON = 'POLYGON',
+  ETHEREUM = 'ETHEREUM',
+  AVALANCHE = 'AVALANCHE',
+}
+
 export interface FeatureModule<T extends {} = {}> {
   description: string;
   value: FEATURE;

diff --git a/generator/utils/importsResolver.ts b/generator/utils/importsResolver.ts
@@ -101,6 +101,9 @@ export function prefixWithImports(code: string) {
   if (findMatch(code, 'forceApprove')) {
     imports += `import {SafeERC20} from 'solidity-utils/contracts/oz-common/SafeERC20.sol';\n`;
   }
+  if (findMatch(code, 'GovernanceV3Ethereum')) {
+    imports += `import {GovernanceV3Ethereum} from 'aave-address-book/GovernanceV3Ethereum.sol';\n`;
+  }
 
   return imports + code;
 }