fix: hardhat typescript typing (#347)

* fix: hardhat typescript typing * feat: adds better typing in tests for event handling
aragon · Mar 30, 2023 · d5d589e · d5d589e
1 parent a432f25
commit d5d589e
Show file tree

Hide file tree

Showing 45 changed files with 240 additions and 153 deletions.
diff --git a/packages/contracts/deploy/00_managing-dao/00_managing-dao.ts b/packages/contracts/deploy/00_managing-dao/00_managing-dao.ts
@@ -7,7 +7,7 @@ import {DeployFunction} from 'hardhat-deploy/types';
 const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   console.log(`\nDeploying ManagingDao.`);
 
-  const {deployments, getNamedAccounts, ethers, network} = hre;
+  const {deployments, getNamedAccounts, ethers} = hre;
   const {deploy} = deployments;
   const {deployer} = await getNamedAccounts();
 

diff --git a/packages/contracts/deploy/00_managing-dao/01_managing-dao-permissions.ts b/packages/contracts/deploy/00_managing-dao/01_managing-dao-permissions.ts
@@ -1,8 +1,9 @@
 import {DeployFunction} from 'hardhat-deploy/types';
-import {EHRE, Operation} from '../../utils/types';
+import {HardhatRuntimeEnvironment} from 'hardhat/types';
+import {Operation} from '../../utils/types';
 import {getContractAddress, managePermissions} from '../helpers';
 
-const func: DeployFunction = async function (hre: EHRE) {
+const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   const {getNamedAccounts, ethers} = hre;
   const {deployer} = await getNamedAccounts();
 

diff --git a/packages/contracts/deploy/00_managing-dao/02_managing-dao_conclude.ts b/packages/contracts/deploy/00_managing-dao/02_managing-dao_conclude.ts
@@ -1,7 +1,7 @@
 import {DeployFunction} from 'hardhat-deploy/types';
-import {EHRE} from '../../utils/types';
+import {HardhatRuntimeEnvironment} from 'hardhat/types';
 
-const func: DeployFunction = async function (hre: EHRE) {
+const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   console.log(`Concluding ManagingDao deployment.\n`);
 
   const {deployments} = hre;

diff --git a/packages/contracts/deploy/10_framework/00_ens_registry.ts b/packages/contracts/deploy/10_framework/00_ens_registry.ts
@@ -3,7 +3,7 @@ import {DeployFunction} from 'hardhat-deploy/types';
 
 import {setupENS} from '../../utils/ens';
 
-import {ENS_ADDRESSES, getContractAddress} from '../helpers';
+import {ENS_ADDRESSES} from '../helpers';
 
 // Make sure you own the ENS set in the {{NETWORK}}_ENS_DOMAIN variable in .env
 const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {

diff --git a/packages/contracts/deploy/10_framework/01_ens_subdomains.ts b/packages/contracts/deploy/10_framework/01_ens_subdomains.ts
@@ -1,5 +1,5 @@
 import {DeployFunction} from 'hardhat-deploy/types';
-import {EHRE} from '../../utils/types';
+import {HardhatRuntimeEnvironment} from 'hardhat/types';
 import {
   getContractAddress,
   getENSAddress,
@@ -8,7 +8,7 @@ import {
   transferSubnodeChain,
 } from '../helpers';
 
-const func: DeployFunction = async function (hre: EHRE) {
+const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   const {ethers, network, getNamedAccounts} = hre;
   const {deployer} = await getNamedAccounts();
 

diff --git a/packages/contracts/deploy/10_framework/02_ens_subdomain_registrars.ts b/packages/contracts/deploy/10_framework/02_ens_subdomain_registrars.ts
@@ -1,9 +1,9 @@
 import {DeployFunction} from 'hardhat-deploy/types';
+import {HardhatRuntimeEnvironment} from 'hardhat/types';
 import {DAO} from '../../typechain';
-import {EHRE} from '../../utils/types';
 import {getContractAddress, getENSAddress} from '../helpers';
 
-const func: DeployFunction = async function (hre: EHRE) {
+const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   const {deployments, getNamedAccounts, ethers, network} = hre;
   const {deploy} = deployments;
   const {deployer} = await getNamedAccounts();

diff --git a/packages/contracts/deploy/10_framework/09_ens_conclude.ts b/packages/contracts/deploy/10_framework/09_ens_conclude.ts
@@ -1,7 +1,7 @@
 import {DeployFunction} from 'hardhat-deploy/types';
-import {EHRE} from '../../utils/types';
+import {HardhatRuntimeEnvironment} from 'hardhat/types';
 
-const func: DeployFunction = async function (hre: EHRE) {
+const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   console.log(`Concluding ENS deployment.\n`);
 
   const {deployments} = hre;

diff --git a/packages/contracts/deploy/10_framework/11_dao-registry_conclude.ts b/packages/contracts/deploy/10_framework/11_dao-registry_conclude.ts
@@ -1,7 +1,7 @@
 import {DeployFunction} from 'hardhat-deploy/types';
-import {EHRE} from '../../utils/types';
+import {HardhatRuntimeEnvironment} from 'hardhat/types';
 
-const func: DeployFunction = async function (hre: EHRE) {
+const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   console.log(`Concluding DAO Registry deployment.\n`);
 
   const {deployments} = hre;

diff --git a/packages/contracts/deploy/10_framework/21_plugin-repo-registry_conclude.ts b/packages/contracts/deploy/10_framework/21_plugin-repo-registry_conclude.ts
@@ -1,7 +1,7 @@
 import {DeployFunction} from 'hardhat-deploy/types';
-import {EHRE} from '../../utils/types';
+import {HardhatRuntimeEnvironment} from 'hardhat/types';
 
-const func: DeployFunction = async function (hre: EHRE) {
+const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   console.log(`Concluding Plugin Repo Registry deployment.\n`);
 
   const {deployments} = hre;

diff --git a/packages/contracts/deploy/10_framework/31_repo-factory_conclude.ts b/packages/contracts/deploy/10_framework/31_repo-factory_conclude.ts
@@ -1,8 +1,8 @@
 import {DeployFunction} from 'hardhat-deploy/types';
-import {EHRE} from '../../utils/types';
+import {HardhatRuntimeEnvironment} from 'hardhat/types';
 import {PluginRepoFactory__factory} from '../../typechain';
 
-const func: DeployFunction = async function (hre: EHRE) {
+const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   console.log(`Concluding Plugin Repo Registry deployment.\n`);
 
   const [deployer] = await hre.ethers.getSigners();

diff --git a/packages/contracts/deploy/10_framework/41_plugin-setup-processor_conclude.ts b/packages/contracts/deploy/10_framework/41_plugin-setup-processor_conclude.ts
@@ -1,7 +1,7 @@
 import {DeployFunction} from 'hardhat-deploy/types';
-import {EHRE} from '../../utils/types';
+import {HardhatRuntimeEnvironment} from 'hardhat/types';
 
-const func: DeployFunction = async function (hre: EHRE) {
+const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   console.log(`Concluding Plugin Setup Processor deployment.\n`);
 
   const {deployments} = hre;

diff --git a/packages/contracts/deploy/10_framework/51_dao-factory-conclude.ts b/packages/contracts/deploy/10_framework/51_dao-factory-conclude.ts
@@ -1,8 +1,8 @@
 import {DeployFunction} from 'hardhat-deploy/types';
+import {HardhatRuntimeEnvironment} from 'hardhat/types';
 import {DAOFactory__factory} from '../../typechain';
-import {EHRE} from '../../utils/types';
 
-const func: DeployFunction = async function (hre: EHRE) {
+const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   console.log(`Concluding DAOFactory deployment.\n`);
   const [deployer] = await hre.ethers.getSigners();
 

diff --git a/packages/contracts/deploy/10_framework/99_verifiy_step.ts b/packages/contracts/deploy/10_framework/99_verifiy_step.ts
@@ -6,8 +6,7 @@ import {checkSetManagingDao, getContractAddress} from '../helpers';
 const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   console.log('\nVerifying framework deployment.');
 
-  const {getNamedAccounts, ethers} = hre;
-  const {deployer} = await getNamedAccounts();
+  const {ethers} = hre;
 
   // Get `managingDAO` address.
   const managingDAOAddress = await getContractAddress('DAO', hre);

diff --git a/...ages/contracts/deploy/30_plugins/00_plugin-setups/01_addresslist_voting_setup_conclude.ts b/...ages/contracts/deploy/30_plugins/00_plugin-setups/01_addresslist_voting_setup_conclude.ts
@@ -1,9 +1,9 @@
 import {DeployFunction} from 'hardhat-deploy/types';
+import {HardhatRuntimeEnvironment} from 'hardhat/types';
 import {setTimeout} from 'timers/promises';
 import {AddresslistVotingSetup__factory} from '../../../typechain';
-import {EHRE} from '../../../utils/types';
 
-const func: DeployFunction = async function (hre: EHRE) {
+const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   console.log(`Concluding addresslist voting setup deployment.\n`);
   const [deployer] = await hre.ethers.getSigners();
 

diff --git a/packages/contracts/deploy/30_plugins/00_plugin-setups/11_token_voting_setup_conclude.ts b/packages/contracts/deploy/30_plugins/00_plugin-setups/11_token_voting_setup_conclude.ts
@@ -1,10 +1,10 @@
 import {ethers} from 'ethers';
 import {DeployFunction} from 'hardhat-deploy/types';
 import {TokenVotingSetup__factory} from '../../../typechain';
-import {EHRE} from '../../../utils/types';
 import {setTimeout} from 'timers/promises';
+import {HardhatRuntimeEnvironment} from 'hardhat/types';
 
-const func: DeployFunction = async function (hre: EHRE) {
+const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   console.log(`Concluding token voting setup deployment.\n`);
   const [deployer] = await hre.ethers.getSigners();
 

diff --git a/packages/contracts/deploy/30_plugins/00_plugin-setups/21_admin_setup_conclude.ts b/packages/contracts/deploy/30_plugins/00_plugin-setups/21_admin_setup_conclude.ts
@@ -1,9 +1,9 @@
 import {DeployFunction} from 'hardhat-deploy/types';
 import {AdminSetup__factory} from '../../../typechain';
-import {EHRE} from '../../../utils/types';
 import {setTimeout} from 'timers/promises';
+import {HardhatRuntimeEnvironment} from 'hardhat/types';
 
-const func: DeployFunction = async function (hre: EHRE) {
+const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   console.log(`Concluding admin setup deployment.\n`);
   const [deployer] = await hre.ethers.getSigners();
 

diff --git a/packages/contracts/deploy/30_plugins/00_plugin-setups/31_multisig_setup_conclude.ts b/packages/contracts/deploy/30_plugins/00_plugin-setups/31_multisig_setup_conclude.ts
@@ -1,9 +1,9 @@
 import {DeployFunction} from 'hardhat-deploy/types';
 import {MultisigSetup__factory} from '../../../typechain';
-import {EHRE} from '../../../utils/types';
 import {setTimeout} from 'timers/promises';
+import {HardhatRuntimeEnvironment} from 'hardhat/types';
 
-const func: DeployFunction = async function (hre: EHRE) {
+const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   console.log(`Concluding multisig setup deployment.\n`);
   const [deployer] = await hre.ethers.getSigners();
 

diff --git a/packages/contracts/deploy/30_plugins/00_plugin-setups/40_placeholder_setup.ts b/packages/contracts/deploy/30_plugins/00_plugin-setups/40_placeholder_setup.ts
@@ -3,9 +3,8 @@ import {DeployFunction} from 'hardhat-deploy/types';
 import {uploadToIPFS} from '../../helpers';
 
 import placeholderBuildMetadata from '../../../src/plugins/placeholder-version/build-metadata.json';
-import {EHRE} from '../../../utils/types';
 
-const func: DeployFunction = async function (hre: EHRE) {
+const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   const {deployments, getNamedAccounts} = hre;
   const {deploy} = deployments;
   const {deployer} = await getNamedAccounts();

diff --git a/packages/contracts/deploy/30_plugins/00_plugin-setups/41_placeholder_setup_conclude.ts b/packages/contracts/deploy/30_plugins/00_plugin-setups/41_placeholder_setup_conclude.ts
@@ -1,7 +1,7 @@
 import {DeployFunction} from 'hardhat-deploy/types';
-import {EHRE} from '../../../utils/types';
+import {HardhatRuntimeEnvironment} from 'hardhat/types';
 
-const func: DeployFunction = async function (hre: EHRE) {
+const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   console.log(`Concluding PlaceholdeSetup deployment.\n`);
 
   const {deployments} = hre;

diff --git a/...ontracts/deploy/30_plugins/10_plugin-repos/01_create_address_list_voting_repo_conclude.ts b/...ontracts/deploy/30_plugins/10_plugin-repos/01_create_address_list_voting_repo_conclude.ts
@@ -1,11 +1,11 @@
 import {DeployFunction} from 'hardhat-deploy/types';
+import {HardhatRuntimeEnvironment} from 'hardhat/types';
 import {
   PluginRepoFactory__factory,
   PluginRepo__factory,
 } from '../../../typechain';
-import {EHRE} from '../../../utils/types';
 
-const func: DeployFunction = async function (hre: EHRE) {
+const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   console.log(`Concluding AddresslistVotingSetup deployment.\n`);
   const [deployer] = await hre.ethers.getSigners();
 

diff --git a/packages/contracts/deploy/30_plugins/10_plugin-repos/11_create_token_voting_repo_conclude.ts b/packages/contracts/deploy/30_plugins/10_plugin-repos/11_create_token_voting_repo_conclude.ts
@@ -1,11 +1,11 @@
 import {DeployFunction} from 'hardhat-deploy/types';
+import {HardhatRuntimeEnvironment} from 'hardhat/types';
 import {
   PluginRepoFactory__factory,
   PluginRepo__factory,
 } from '../../../typechain';
-import {EHRE} from '../../../utils/types';
 
-const func: DeployFunction = async function (hre: EHRE) {
+const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   console.log(`Concluding TokenVotingSetup deployment.\n`);
   const [deployer] = await hre.ethers.getSigners();
 

diff --git a/packages/contracts/deploy/30_plugins/10_plugin-repos/21_create_admin_repo_conclude.ts b/packages/contracts/deploy/30_plugins/10_plugin-repos/21_create_admin_repo_conclude.ts
@@ -1,11 +1,11 @@
 import {DeployFunction} from 'hardhat-deploy/types';
+import {HardhatRuntimeEnvironment} from 'hardhat/types';
 import {
   PluginRepoFactory__factory,
   PluginRepo__factory,
 } from '../../../typechain';
-import {EHRE} from '../../../utils/types';
 
-const func: DeployFunction = async function (hre: EHRE) {
+const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   console.log(`Concluding TokenVotingSetup deployment.\n`);
   const [deployer] = await hre.ethers.getSigners();
 

diff --git a/packages/contracts/deploy/30_plugins/10_plugin-repos/31_create_multisig_repo_conclude.ts b/packages/contracts/deploy/30_plugins/10_plugin-repos/31_create_multisig_repo_conclude.ts
@@ -1,11 +1,11 @@
 import {DeployFunction} from 'hardhat-deploy/types';
+import {HardhatRuntimeEnvironment} from 'hardhat/types';
 import {
   PluginRepoFactory__factory,
   PluginRepo__factory,
 } from '../../../typechain';
-import {EHRE} from '../../../utils/types';
 
-const func: DeployFunction = async function (hre: EHRE) {
+const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   console.log(`Concluding AddresslistVotingSetup deployment.\n`);
   const [deployer] = await hre.ethers.getSigners();
 

diff --git a/packages/contracts/deploy/40_finalize-managing-dao/00_grant-permissions.ts b/packages/contracts/deploy/40_finalize-managing-dao/00_grant-permissions.ts
@@ -1,14 +1,14 @@
 import {HardhatRuntimeEnvironment} from 'hardhat/types';
 import {DeployFunction} from 'hardhat-deploy/types';
 
-import {EHRE, Operation} from '../../utils/types';
+import {Operation} from '../../utils/types';
 import {getContractAddress, managePermissions, Permission} from '../helpers';
 import {PluginRepo__factory} from '../../typechain';
 
-const func: DeployFunction = async function (hre: EHRE) {
+const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   console.log(`\nFinalizing ManagingDao.`);
 
-  const {getNamedAccounts, ethers} = hre;
+  const {ethers} = hre;
   const [deployer] = await ethers.getSigners();
 
   // Get `DAORegistry` address.

diff --git a/packages/contracts/deploy/40_finalize-managing-dao/30_install-multisig-on-managing-dao.ts b/packages/contracts/deploy/40_finalize-managing-dao/30_install-multisig-on-managing-dao.ts
@@ -4,11 +4,13 @@ import buildMetadataJson from '../../src/plugins/governance/multisig/build-metad
 import {findEvent} from '../../utils/event';
 
 import {checkPermission, getContractAddress} from '../helpers';
-import {EHRE, Operation} from '../../utils/types';
+import {Operation} from '../../utils/types';
 import {hashHelpers} from '../../utils/psp';
 import {MultisigSetup__factory, Multisig__factory} from '../../typechain';
+import {HardhatRuntimeEnvironment} from 'hardhat/types';
+import {InstallationPreparedEvent} from '../../typechain/PluginSetupProcessor';
 
-const func: DeployFunction = async function (hre: EHRE) {
+const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   const {ethers, network} = hre;
   const [deployer] = await ethers.getSigners();
 
@@ -55,29 +57,37 @@ const func: DeployFunction = async function (hre: EHRE) {
 
   // Install multisig build 2
   const multisigRepoAddress = hre.aragonPluginRepos['multisig'];
-  const versionTag = [1, 2];
-  const pluginSetupRef = [versionTag, multisigRepoAddress];
+  const versionTag = {
+    release: 1,
+    build: 2,
+  };
+  const pluginSetupRef = {
+    pluginSetupRepo: multisigRepoAddress,
+    versionTag,
+  };
 
   // Prepare multisig plugin for managingDAO
   const data = ethers.utils.defaultAbiCoder.encode(
     buildMetadataJson.pluginSetupABI.prepareInstallation,
     [approvers, [listedOnly, minApprovals]]
   );
-  const prepareParams = [pluginSetupRef, data];
-  const prepareTx = await pspContract.prepareInstallation(
-    managingDAOAddress,
-    prepareParams
-  );
+  const prepareTx = await pspContract.prepareInstallation(managingDAOAddress, {
+    data,
+    pluginSetupRef,
+  });
   await prepareTx.wait();
 
   // extract info from prepare event
-  const event = await findEvent(prepareTx, 'InstallationPrepared');
+  const event = await findEvent<InstallationPreparedEvent>(
+    prepareTx,
+    'InstallationPrepared'
+  );
   const installationPreparedEvent = event.args;
 
   hre.managingDAOMultisigPluginAddress = installationPreparedEvent.plugin;
 
   console.log(
-    `Prepared (Multisig: ${installationPreparedEvent.plugin} version ${versionTag}) to be applied on (ManagingDAO: ${managingDAOAddress}), see (tx: ${prepareTx.hash})`
+    `Prepared (Multisig: ${installationPreparedEvent.plugin} version (release: ${versionTag.release} / build: ${versionTag.build}) to be applied on (ManagingDAO: ${managingDAOAddress}), see (tx: ${prepareTx.hash})`
   );
 
   // Adding plugin to verify array
@@ -105,16 +115,14 @@ const func: DeployFunction = async function (hre: EHRE) {
   });
 
   // Apply multisig plugin to the managingDAO
-  const applyParams = [
+  const applyTx = await pspContract.applyInstallation(managingDAOAddress, {
+    helpersHash: hashHelpers(
+      installationPreparedEvent.preparedSetupData.helpers
+    ),
+    permissions: installationPreparedEvent.preparedSetupData.permissions,
+    plugin: installationPreparedEvent.plugin,
     pluginSetupRef,
-    installationPreparedEvent.plugin,
-    installationPreparedEvent.preparedSetupData.permissions,
-    hashHelpers(installationPreparedEvent.preparedSetupData.helpers),
-  ];
-  const applyTx = await pspContract.applyInstallation(
-    managingDAOAddress,
-    applyParams
-  );
+  });
   await applyTx.wait();
 
   await checkPermission(managingDaoContract, {

diff --git a/packages/contracts/deploy/40_finalize-managing-dao/40_revoke-permissions.ts b/packages/contracts/deploy/40_finalize-managing-dao/40_revoke-permissions.ts
@@ -1,11 +1,12 @@
 import {DeployFunction} from 'hardhat-deploy/types';
 
 import {getContractAddress, managePermissions, Permission} from '../helpers';
-import {EHRE, Operation} from '../../utils/types';
+import {Operation} from '../../utils/types';
 import {PluginRepo__factory} from '../../typechain';
+import {HardhatRuntimeEnvironment} from 'hardhat/types';
 
-const func: DeployFunction = async function (hre: EHRE) {
-  const {getNamedAccounts, ethers} = hre;
+const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
+  const {ethers} = hre;
   const [deployer] = await ethers.getSigners();
 
   // Get info from .env

diff --git a/packages/contracts/deploy/99_conclude/00_save-contract-addresses.ts b/packages/contracts/deploy/99_conclude/00_save-contract-addresses.ts
@@ -7,7 +7,7 @@ const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   const {deployments, aragonPluginRepos} = hre;
 
   const deployedContracts = await deployments.all();
-  const deployedContractAddresses = {};
+  const deployedContractAddresses: {[index: string]: string} = {};
 
   for (const deployment in deployedContracts) {
     // skip proxies because they are included twice