chore: sync with osx-plugin-template-hardhat develop branch

.env.example

@@ -1,15 +1,15 @@
 # GENERAL
 
 ## The network used for testing purposes
-NETWORK_NAME="sepolia" #  ["mainnet", "sepolia", "polygon", "polygonMumbai", "base", "baseSepolia", "arbitrum", "arbitrumSepolia"]
+NETWORK_NAME="sepolia" #  ["mainnet", "sepolia", "polygon", "mumbai","baseMainnet", "baseGoerli", "baseSepolia", "arbitrum", "arbitrumSepolia"]
 
 # CONTRACTS
 
 ## One or multiple hex encoded private keys separated by commas `,` replacing the hardhat default accounts.
 PRIVATE_KEY="0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80" # Default hardhat account 0 private key. DON'T USE FOR DEPLOYMENTS
 
-## Infura credentials
-INFURA_API_KEY="zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz"
+## Alchemy RPC endpoint credentials
+ALCHEMY_API_KEY="zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz"
 
 ## Gas Reporting
 REPORT_GAS='true'

.github/workflows/contracts-tests.yml

@@ -2,7 +2,7 @@ name: 'contracts'
 
 on:
   workflow_dispatch:
-  push:
+  pull_request:
     paths:
       - 'packages/contracts/**'
       - '.github/workflows/contracts-*.yml'
@@ -31,10 +31,10 @@ jobs:
       - name: 'Build the contracts'
         run: 'yarn build'
         env:
-          INFURA_API_KEY: ${{ secrets.INFURA_API_KEY }}
+          ALCHEMY_API_KEY: ${{ secrets.ALCHEMY_API_KEY }}
 
       - 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 }}
+          ALCHEMY_API_KEY: ${{ secrets.ALCHEMY_API_KEY }}

.github/workflows/subgraph-tests.yml

@@ -2,7 +2,7 @@ name: 'subgraph'
 
 on:
   workflow_dispatch:
-  push:
+  pull_request:
     paths:
       - 'packages/subgraph/**'
       - 'packages/contracts/**'
@@ -41,7 +41,7 @@ jobs:
         working-directory: packages/subgraph
         env:
           SUBGRAPH_NETWORK_NAME: ${{ vars.SUBGRAPH_NETWORK_NAME }}
-          INFURA_API_KEY: ${{ secrets.INFURA_API_KEY }}
+          ALCHEMY_API_KEY: ${{ secrets.ALCHEMY_API_KEY }}
 
       - name: 'Test the subgraph'
         run: yarn test

README.md

@@ -68,7 +68,7 @@ yarn lint
 
 To be able to work on the contracts, make sure that you have created an `.env` file from the `.env.example` file and put in the API keys for
 
-- [Infura](https://www.infura.io/) that we use as the web3 provider
+- [Alchemy](https://www.alchemy.com) that we use as the web3 provider
 - [Alchemy Subgraphs](https://www.alchemy.com/subgraphs) that we use as the subgraph provider
 - the block explorer that you want to use depending on the networks that you want to deploy to
 
@@ -268,6 +268,10 @@ and finally the subgraph itself with
 yarn build:subgraph
 ```
 
+When running `yarn build`, it requires a plugin address, which is obtained from the configuration file located
+at `subgraph/manifest/data/<network>.json`, based on the network specified in your `.env` file under the `SUBGRAPH_NETWORK_NAME` variable.
+You do not need to provide a plugin address for building or testing purposes, but it becomes necessary when deploying the subgraph.
+
 During development of the subgraph, you might want to clean outdated files that were build, imported, and generated. To do this, run
 
 ```sh
@@ -300,7 +304,8 @@ yarn coverage
 
 ### Deployment
 
-To deploy the subgraph to the subgraph provider, write your intended subgraph name and version into the `SUBGRAPH_NAME` and `SUBGRAPH_VERSION` variables [in the `.env` file that you created in the beginning](environment-variables) and pick a network name `SUBGRAPH_NETWORK_NAME` [being supported by the subgraph provider](https://docs.alchemy.com/reference/supported-subgraph-chains). Then run
+To deploy the subgraph to the subgraph provider, write your intended subgraph name and version into the `SUBGRAPH_NAME` and `SUBGRAPH_VERSION` variables [in the `.env` file that you created in the beginning](environment-variables) and pick a network name `SUBGRAPH_NETWORK_NAME` [being supported by the subgraph provider](https://docs.alchemy.com/reference/supported-subgraph-chains). Remember to place correctly the Plugin address on the network you are going to deploy to, you can do that by adding it on `subgraph/manifest/data/<network>.json`.
+Then run
 
 ```sh
 yarn deploy

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

@@ -21,7 +21,7 @@ const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   });
 
   console.log(
-    `Deployed contract '${PLUGIN_SETUP_CONTRACT_NAME}' at ${res.address}.`
+    `Deployed '${PLUGIN_SETUP_CONTRACT_NAME}' contract at '${res.address}'`
   );
 };
 

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

@@ -21,6 +21,10 @@ import path from 'path';
 
 type SemVer = [number, number, number];
 
+/**
+ * Upgrades the plugin repo to the latest implementation.
+ * @param {HardhatRuntimeEnvironment} hre
+ */
 const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   const [deployer] = await hre.ethers.getSigners();
   const productionNetworkName: string = getProductionNetworkName(hre);

packages/contracts/hardhat.config.ts

@@ -1,7 +1,6 @@
 import {
-  NetworkConfigs,
-  NetworkConfig,
-  networks,
+  addRpcUrlToNetwork,
+  networks as osxCommonsConfigNetworks,
   SupportedNetworks,
 } from '@aragon/osx-commons-configs';
 import '@nomicfoundation/hardhat-chai-matchers';
@@ -18,14 +17,18 @@ import {
   HardhatNetworkAccountsUserConfig,
   HardhatRuntimeEnvironment,
 } from 'hardhat/types';
+import type {NetworkUserConfig} from 'hardhat/types';
 import {resolve} from 'path';
 import 'solidity-coverage';
 
 const dotenvConfigPath: string = process.env.DOTENV_CONFIG_PATH || '../../.env';
 dotenvConfig({path: resolve(__dirname, dotenvConfigPath), override: true});
 
-if (!process.env.INFURA_API_KEY) {
-  throw new Error('INFURA_API_KEY in .env not set');
+// check alchemy Api key existence
+if (process.env.ALCHEMY_API_KEY) {
+  addRpcUrlToNetwork(process.env.ALCHEMY_API_KEY);
+} else {
+  throw new Error('ALCHEMY_API_KEY in .env not set');
 }
 
 // Fetch the accounts specified in the .env file
@@ -67,15 +70,10 @@ function getHardhatNetworkAccountsConfig(
   return accountsConfig;
 }
 
-type HardhatNetworksExtension = NetworkConfig & {
-  accounts?: string[];
-};
-
 // Add the accounts specified in the `.env` file to the networks from osx-commons-configs
-const osxCommonsConfigNetworks: NetworkConfigs<HardhatNetworksExtension> =
-  networks;
+const networks: {[index: string]: NetworkUserConfig} = osxCommonsConfigNetworks;
 for (const network of Object.keys(networks) as SupportedNetworks[]) {
-  osxCommonsConfigNetworks[network].accounts = specifiedAccounts();
+  networks[network].accounts = specifiedAccounts();
 }
 
 // Extend HardhatRuntimeEnvironment
@@ -110,7 +108,7 @@ const config: HardhatUserConfig = {
         Object.keys(namedAccounts).length
       ),
     },
-    ...osxCommonsConfigNetworks,
+    ...networks,
   },
 
   defaultNetwork: 'hardhat',

packages/contracts/package.json

@@ -19,7 +19,7 @@
     "@openzeppelin/contracts-upgradeable": "^4.9.5"
   },
   "devDependencies": {
-    "@aragon/osx-commons-configs": "0.1.0",
+    "@aragon/osx-commons-configs": "0.4.0",
     "@aragon/osx-commons-sdk": "0.0.1-alpha.5",
     "@aragon/osx-ethers": "1.4.0-alpha.0",
     "@aragon/osx-v1.0.0": "npm:@aragon/[email protected]",

packages/contracts/plugin-settings.ts

@@ -6,6 +6,8 @@ export const PLUGIN_CONTRACT_NAME = 'Multisig';
 export const PLUGIN_SETUP_CONTRACT_NAME = 'MultisigSetup';
 export const PLUGIN_REPO_ENS_SUBDOMAIN_NAME = 'multisig'; // 'multisig.plugin.dao.eth'
 
+// Specify the version of your plugin that you are currently working on. The first version is v1.1.
+// For more details, visit https://devs.aragon.org/docs/osx/how-it-works/framework/plugin-management/plugin-repo.
 export const VERSION: VersionTag = {
   release: 1, // Increment this number ONLY if breaking/incompatible changes were made. Updates between releases are NOT possible.
   build: 3, // Increment this number if non-breaking/compatible changes were made. Updates to newer builds are possible.

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

@@ -101,7 +101,7 @@ async function fixture(): Promise<FixtureResult> {
   await deployments.fixture(tags);
   const [deployer] = await ethers.getSigners();
 
-  // Plugin repo
+  // Plugin Repo
   const {pluginRepo, ensDomain} = await findPluginRepo(env);
   if (pluginRepo === null) {
     throw `PluginRepo '${ensDomain}' does not exist yet.`;

packages/contracts/utils/helpers.ts

@@ -251,5 +251,16 @@ export async function createVersion(
   return tx;
 }
 
+export function generateRandomName(length: number): string {
+  const allowedCharacters = 'abcdefghijklmnopqrstuvwxyz-0123456789';
+  let result = '';
+  for (let i = 0; i < length; i++) {
+    result += allowedCharacters.charAt(
+      Math.floor(Math.random() * allowedCharacters.length)
+    );
+  }
+  return result;
+}
+
 export const AragonOSxAsciiArt =
   "                                          ____   _____      \n     /\\                                  / __ \\ / ____|     \n    /  \\   _ __ __ _  __ _  ___  _ __   | |  | | (_____  __ \n   / /\\ \\ | '__/ _` |/ _` |/ _ \\| '_ \\  | |  | |\\___ \\ \\/ / \n  / ____ \\| | | (_| | (_| | (_) | | | | | |__| |____) >  <  \n /_/    \\_\\_|  \\__,_|\\__, |\\___/|_| |_|  \\____/|_____/_/\\_\\ \n                      __/ |                                 \n                     |___/                                  \n";

packages/contracts/yarn.lock

@@ -2,10 +2,10 @@
 # yarn lockfile v1
 
 
-"@aragon/osx-commons-configs@0.1.0":
-  version "0.1.0"
-  resolved "https://registry.yarnpkg.com/@aragon/osx-commons-configs/-/osx-commons-configs-0.1.0.tgz#21bbc5a964eb144e30033a44cc352d35c62982f9"
-  integrity sha512-qTs/loihwqALBGmhZngORb+p7pjuQJY5UEd8TLNiEW/BGHEpAJPp4GeQu7GSnigRGEKWpPD5W96kfEsaPtLkuQ==
+"@aragon/osx-commons-configs@0.4.0":
+  version "0.4.0"
+  resolved "https://registry.yarnpkg.com/@aragon/osx-commons-configs/-/osx-commons-configs-0.4.0.tgz#5b6ae025de1ccf7f9a135bfbcb0aa822c774acf9"
+  integrity sha512-/2wIQCbv/spMRdOjRXK0RrXG1TK5aMcbD73RvMgMwQwSrKcA1dCntUuSxmTm2W8eEtOzs8E1VPjqZk0cXL4SSQ==
   dependencies:
     tslib "^2.6.2"
 

packages/subgraph/manifest/data/arbitrum.json

@@ -0,0 +1,18 @@
+{
+  "info": "# Do not edit subgraph.yaml,this is a generated file. \n# Instead, edit subgraph.placeholder.yaml and run: yarn manifest",
+  "network": "arbitrum-one",
+  "dataSources": {
+    "PluginSetupProcessors": [
+      {
+        "name": "PluginSetupProcessor",
+        "address": "0x308a1DC5020c4B5d992F5543a7236c465997fecB",
+        "startBlock": 145462184
+      }
+    ],
+    "Plugin": {
+      "name": "MyPlugin",
+      "address": null,
+      "startBlock": 7727664
+    }
+  }
+}

packages/subgraph/manifest/data/arbitrumGoerli.json

@@ -0,0 +1,18 @@
+{
+  "info": "# Do not edit subgraph.yaml,this is a generated file. \n# Instead, edit subgraph.placeholder.yaml and run: yarn manifest",
+  "network": "arbitrum-goerli",
+  "dataSources": {
+    "PluginSetupProcessors": [
+      {
+        "name": "PluginSetupProcessor",
+        "address": "0x308a1DC5020c4B5d992F5543a7236c465997fecB",
+        "startBlock": 51930460
+      }
+    ],
+    "Plugin": {
+      "name": "MyPlugin",
+      "address": null,
+      "startBlock": 7727664
+    }
+  }
+}

packages/subgraph/manifest/data/arbitrumSepolia.json

@@ -0,0 +1,18 @@
+{
+  "info": "# Do not edit subgraph.yaml,this is a generated file. \n# Instead, edit subgraph.placeholder.yaml and run: yarn manifest",
+  "network": "arbitrum-sepolia",
+  "dataSources": {
+    "PluginSetupProcessors": [
+      {
+        "name": "PluginSetupProcessor",
+        "address": "0xC24188a73dc09aA7C721f96Ad8857B469C01dC9f",
+        "startBlock": 2827173
+      }
+    ],
+    "Plugin": {
+      "name": "MyPlugin",
+      "address": null,
+      "startBlock": 7727664
+    }
+  }
+}

packages/subgraph/manifest/data/baseGoerli.json

@@ -0,0 +1,18 @@
+{
+  "info": "# Do not edit subgraph.yaml,this is a generated file. \n# Instead, edit subgraph.placeholder.yaml and run: yarn manifest",
+  "network": "base-testnet",
+  "dataSources": {
+    "PluginSetupProcessors": [
+      {
+        "name": "PluginSetupProcessor",
+        "address": "0x6095b5004c59301f8Bb98768Bd395d0bc637C893",
+        "startBlock": 7890981
+      }
+    ],
+    "Plugin": {
+      "name": "MyPlugin",
+      "address": null,
+      "startBlock": 7727664
+    }
+  }
+}

packages/subgraph/manifest/data/baseMainnet.json

@@ -0,0 +1,18 @@
+{
+  "info": "# Do not edit subgraph.yaml,this is a generated file. \n# Instead, edit subgraph.placeholder.yaml and run: yarn manifest",
+  "network": "base",
+  "dataSources": {
+    "PluginSetupProcessors": [
+      {
+        "name": "PluginSetupProcessor",
+        "address": "0x91a851E9Ed7F2c6d41b15F76e4a88f5A37067cC9",
+        "startBlock": 2094737
+      }
+    ],
+    "Plugin": {
+      "name": "MyPlugin",
+      "address": null,
+      "startBlock": 7727664
+    }
+  }
+}

packages/subgraph/manifest/data/baseSepolia.json

@@ -0,0 +1,18 @@
+{
+  "info": "# Do not edit subgraph.yaml,this is a generated file. \n# Instead, edit subgraph.placeholder.yaml and run: yarn manifest",
+  "network": "base-sepolia",
+  "dataSources": {
+    "PluginSetupProcessors": [
+      {
+        "name": "PluginSetupProcessor",
+        "address": "0xC24188a73dc09aA7C721f96Ad8857B469C01dC9f",
+        "startBlock": 3654401
+      }
+    ],
+    "Plugin": {
+      "name": "MyPlugin",
+      "address": null,
+      "startBlock": 7727664
+    }
+  }
+}

packages/subgraph/manifest/data/goerli.json

@@ -8,6 +8,11 @@
         "address": "0xE8B5d8D66a02CD1b9Bd32a4064D7ABa45F51305e",
         "startBlock": 8548226
       }
-    ]
+    ],
+    "Plugin": {
+      "name": "MyPlugin",
+      "address": null,
+      "startBlock": 7727664
+    }
   }
 }

packages/subgraph/manifest/data/localhost.json

@@ -8,6 +8,11 @@
         "address": "0x2B8C4DD137104d1E869105cd0106e7D9EF955BfE",
         "startBlock": 7727664
       }
-    ]
+    ],
+    "Plugin": {
+      "name": "MyPlugin",
+      "address": null,
+      "startBlock": 7727664
+    }
   }
 }

packages/subgraph/manifest/data/mainnet.json

@@ -8,6 +8,11 @@
         "address": "0xE978942c691e43f65c1B7c7F8f1dc8cDF061B13f",
         "startBlock": 16721812
       }
-    ]
+    ],
+    "Plugin": {
+      "name": "MyPlugin",
+      "address": null,
+      "startBlock": 7727664
+    }
   }
 }

packages/subgraph/manifest/data/mumbai.json

@@ -8,6 +8,11 @@
         "address": "0x9227b311C5cecB416707F1C8B7Ca1b52649AabEc",
         "startBlock": 33514164
       }
-    ]
+    ],
+    "Plugin": {
+      "name": "MyPlugin",
+      "address": null,
+      "startBlock": 7727664
+    }
   }
 }