feat: improvements surfaced from the admin plugin

.github/workflows/contracts-tests.yml

@@ -36,4 +36,5 @@ jobs:
       - name: 'Test the contracts and generate the coverage report'
         run: 'yarn coverage'
         env:
+          NETWORK_NAME: ${{ vars.NETWORK_NAME }}
           INFURA_API_KEY: ${{ secrets.INFURA_API_KEY }}

packages/contracts/deploy/00_info/01_info.ts

@@ -4,6 +4,7 @@ import {
   isLocal,
 } from '../../utils/helpers';
 import {getNetworkByNameOrAlias} from '@aragon/osx-commons-configs';
+import {UnsupportedNetworkError} from '@aragon/osx-commons-sdk';
 import {DeployFunction} from 'hardhat-deploy/types';
 import {HardhatRuntimeEnvironment} from 'hardhat/types';
 import path from 'path';
@@ -26,7 +27,10 @@ const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
     );
 
     // Fork the network provided in the `.env` file
-    const networkConfig = getNetworkByNameOrAlias(productionNetworkName)!;
+    const networkConfig = getNetworkByNameOrAlias(productionNetworkName);
+    if (networkConfig === null) {
+      throw new UnsupportedNetworkError(productionNetworkName);
+    }
     await hre.network.provider.request({
       method: 'hardhat_reset',
       params: [

packages/contracts/deploy/10_create_repo/11_create_repo.ts

@@ -70,7 +70,7 @@ const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   );
 
   console.log(
-    `'${pluginEnsDomain(hre)}' PluginRepo deployed at: ${pluginRepo.address}.`
+    `PluginRepo '${pluginEnsDomain(hre)}' deployed at '${pluginRepo.address}'.`
   );
 
   hre.aragonToVerifyContracts.push({

packages/contracts/deploy/20_new_version/21_setup.ts

@@ -14,11 +14,15 @@ const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   const {deploy} = deployments;
   const {deployer} = await getNamedAccounts();
 
-  await deploy(PLUGIN_SETUP_CONTRACT_NAME, {
+  const res = await deploy(PLUGIN_SETUP_CONTRACT_NAME, {
     from: deployer,
     args: [],
     log: true,
   });
+
+  console.log(
+    `Deployed '${PLUGIN_SETUP_CONTRACT_NAME}' contract at '${res.address}'`
+  );
 };
 
 export default func;

packages/contracts/deploy/30_upgrade_repo/31_upgrade_repo.ts

@@ -3,7 +3,10 @@ import {
   getLatestNetworkDeployment,
   getNetworkNameByAlias,
 } from '@aragon/osx-commons-configs';
-import {PLUGIN_REPO_PERMISSIONS} from '@aragon/osx-commons-sdk';
+import {
+  PLUGIN_REPO_PERMISSIONS,
+  UnsupportedNetworkError,
+} from '@aragon/osx-commons-sdk';
 import {PluginRepo__factory} from '@aragon/osx-ethers';
 import {BytesLike} from 'ethers';
 import {DeployFunction} from 'hardhat-deploy/types';
@@ -15,6 +18,14 @@ type SemVer = [number, number, number];
 const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   const [deployer] = await hre.ethers.getSigners();
   const productionNetworkName: string = getProductionNetworkName(hre);
+  const network = getNetworkNameByAlias(productionNetworkName);
+  if (network === null) {
+    throw new UnsupportedNetworkError(productionNetworkName);
+  }
+  const networkDeployments = getLatestNetworkDeployment(network);
+  if (networkDeployments === null) {
+    throw `Deployments are not available on network ${network}.`;
+  }
 
   // Get PluginRepo
   const {pluginRepo, ensDomain} = await findPluginRepo(hre);
@@ -28,8 +39,7 @@ const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
 
   // Get the latest `PluginRepo` implementation as the upgrade target
   const latestPluginRepoImplementation = PluginRepo__factory.connect(
-    getLatestNetworkDeployment(getNetworkNameByAlias(productionNetworkName)!)!
-      .PluginRepoBase.address,
+    networkDeployments.PluginRepoBase.address,
     deployer
   );
 
@@ -53,11 +63,11 @@ const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   // Re-initialization will happen through a call to `function initializeFrom(uint8[3] calldata _previousProtocolVersion, bytes calldata _initData)`
   // that Aragon might add to the `PluginRepo` contract once it's required.
   /*
-  // Define the `initData` arguments that 
+  // Define the `_initData` arguments 
   const initData: BytesLike[] = [];
   // Encode the call to `function initializeFrom(uint8[3] calldata _previousProtocolVersion, bytes calldata _initData)` with `initData`
   const initializeFromCalldata =
-    newPluginRepoImplementation.interface.encodeFunctionData('initializeFrom', [
+    latestPluginRepoImplementation.interface.encodeFunctionData('initializeFrom', [
       current,
       initData,
     ]);
@@ -102,11 +112,18 @@ func.skip = async (hre: HardhatRuntimeEnvironment) => {
 
   const [deployer] = await hre.ethers.getSigners();
   const productionNetworkName: string = getProductionNetworkName(hre);
+  const network = getNetworkNameByAlias(productionNetworkName);
+  if (network === null) {
+    throw new UnsupportedNetworkError(productionNetworkName);
+  }
+  const networkDeployments = getLatestNetworkDeployment(network);
+  if (networkDeployments === null) {
+    throw `Deployments are not available on network ${network}.`;
+  }
 
   // Get the latest `PluginRepo` implementation as the upgrade target
   const latestPluginRepoImplementation = PluginRepo__factory.connect(
-    getLatestNetworkDeployment(getNetworkNameByAlias(productionNetworkName)!)!
-      .PluginRepoBase.address,
+    networkDeployments.PluginRepoBase.address,
     deployer
   );
 

packages/contracts/test/10_unit-testing/12_plugin-setup.ts

@@ -24,6 +24,8 @@ type FixtureResult = {
   alice: SignerWithAddress;
   bob: SignerWithAddress;
   pluginSetup: MyPluginSetup;
+  prepareInstallationInputs: string;
+  prepareUninstallationInputs: string;
   daoMock: DAOMock;
 };
 
@@ -32,24 +34,36 @@ async function fixture(): Promise<FixtureResult> {
   const daoMock = await new DAOMock__factory(deployer).deploy();
   const pluginSetup = await new MyPluginSetup__factory(deployer).deploy();
 
-  return {deployer, alice, bob, pluginSetup, daoMock};
+  const prepareInstallationInputs = ethers.utils.defaultAbiCoder.encode(
+    getNamedTypesFromMetadata(
+      buildMetadata.pluginSetup.prepareInstallation.inputs
+    ),
+    [defaultInitData.number]
+  );
+
+  const prepareUninstallationInputs = ethers.utils.defaultAbiCoder.encode(
+    getNamedTypesFromMetadata(
+      buildMetadata.pluginSetup.prepareUninstallation.inputs
+    ),
+    []
+  );
+
+  return {
+    deployer,
+    alice,
+    bob,
+    pluginSetup,
+    prepareInstallationInputs,
+    prepareUninstallationInputs,
+    daoMock,
+  };
 }
 
 describe(PLUGIN_SETUP_CONTRACT_NAME, function () {
   describe('prepareInstallation', async () => {
-    let initData: string;
-
-    before(async () => {
-      initData = ethers.utils.defaultAbiCoder.encode(
-        getNamedTypesFromMetadata(
-          buildMetadata.pluginSetup.prepareInstallation.inputs
-        ),
-        [defaultInitData.number]
-      );
-    });
-
     it('returns the plugin, helpers, and permissions', async () => {
-      const {deployer, pluginSetup, daoMock} = await loadFixture(fixture);
+      const {deployer, pluginSetup, prepareInstallationInputs, daoMock} =
+        await loadFixture(fixture);
 
       const nonce = await ethers.provider.getTransactionCount(
         pluginSetup.address
@@ -64,7 +78,7 @@ describe(PLUGIN_SETUP_CONTRACT_NAME, function () {
         preparedSetupData: {helpers, permissions},
       } = await pluginSetup.callStatic.prepareInstallation(
         daoMock.address,
-        initData
+        prepareInstallationInputs
       );
 
       expect(plugin).to.be.equal(anticipatedPluginAddress);
@@ -80,7 +94,10 @@ describe(PLUGIN_SETUP_CONTRACT_NAME, function () {
         ],
       ]);
 
-      await pluginSetup.prepareInstallation(daoMock.address, initData);
+      await pluginSetup.prepareInstallation(
+        daoMock.address,
+        prepareInstallationInputs
+      );
       const myPlugin = new MyPlugin__factory(deployer).attach(plugin);
 
       // initialization is correct
@@ -91,17 +108,17 @@ describe(PLUGIN_SETUP_CONTRACT_NAME, function () {
 
   describe('prepareUninstallation', async () => {
     it('returns the permissions', async () => {
-      const {pluginSetup, daoMock} = await loadFixture(fixture);
+      const {pluginSetup, daoMock, prepareUninstallationInputs} =
+        await loadFixture(fixture);
 
       const dummyAddr = ADDRESS.ZERO;
-      const emptyData = '0x';
 
       const permissions = await pluginSetup.callStatic.prepareUninstallation(
         daoMock.address,
         {
           plugin: dummyAddr,
           currentHelpers: [],
-          data: emptyData,
+          data: prepareUninstallationInputs,
         }
       );
 

packages/contracts/test/20_integration-testing/21_deployment.ts

@@ -1,4 +1,4 @@
-import {METADATA} from '../../plugin-settings';
+import {METADATA, VERSION} from '../../plugin-settings';
 import {getProductionNetworkName, findPluginRepo} from '../../utils/helpers';
 import {
   getLatestNetworkDeployment,
@@ -8,6 +8,7 @@ import {
   DAO_PERMISSIONS,
   PERMISSION_MANAGER_FLAGS,
   PLUGIN_REPO_PERMISSIONS,
+  UnsupportedNetworkError,
   toHex,
   uploadToIPFS,
 } from '@aragon/osx-commons-sdk';
@@ -66,13 +67,13 @@ describe(`Deployment on network '${productionNetworkName}'`, function () {
       const {pluginRepo} = await loadFixture(fixture);
 
       await pluginRepo['getVersion((uint8,uint16))']({
-        release: 1,
-        build: 1,
+        release: VERSION.release,
+        build: VERSION.build,
       });
 
       const results = await pluginRepo['getVersion((uint8,uint16))']({
-        release: 1,
-        build: 1,
+        release: VERSION.release,
+        build: VERSION.build,
       });
 
       const buildMetadataURI = `ipfs://${await uploadToIPFS(
@@ -97,17 +98,26 @@ async function fixture(): Promise<FixtureResult> {
 
   const [deployer] = await ethers.getSigners();
 
-  // Plugin repo registry
-  const pluginRepoRegistry = PluginRepoRegistry__factory.connect(
-    getLatestNetworkDeployment(getNetworkNameByAlias(productionNetworkName)!)!
-      .PluginRepoRegistryProxy.address,
-    deployer
-  );
-
+  // Plugin Repo
   const {pluginRepo, ensDomain} = await findPluginRepo(env);
   if (pluginRepo === null) {
     throw `PluginRepo '${ensDomain}' does not exist yet.`;
   }
 
+  const network = getNetworkNameByAlias(productionNetworkName);
+  if (network === null) {
+    throw new UnsupportedNetworkError(productionNetworkName);
+  }
+  const networkDeployments = getLatestNetworkDeployment(network);
+  if (networkDeployments === null) {
+    throw `Deployments are not available on network ${network}.`;
+  }
+
+  // Plugin repo registry
+  const pluginRepoRegistry = PluginRepoRegistry__factory.connect(
+    networkDeployments.PluginRepoRegistryProxy.address,
+    deployer
+  );
+
   return {deployer, pluginRepo, pluginRepoRegistry};
 }