Feat: add script to merge all proposal actions

.gitignore

@@ -34,6 +34,7 @@ yarn-error.log*
 deployments
 deployed_contracts.json
 managementDAOTX.json
+packages/contracts/scripts/plugin-proposals-data/
 
 # generated
 generated

packages/contracts/deploy/update/to_v1.4.0/01_Info.ts

@@ -0,0 +1,24 @@
+import {DeployFunction} from 'hardhat-deploy/types';
+import {HardhatRuntimeEnvironment} from 'hardhat/types';
+
+const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
+  console.log('\nInfo: Updating to version 1.4.0');
+
+  hre.proposalInfo = {
+    proposalTitle: 'Upgrade OSx Protocol to version 1.4.0',
+    proposalSummary:
+      'Upgrade OSx Protocol to version 1.4.0, and release Admin Plugin v1.2, Multisig v1.3 and TokenVoting v1.3',
+    proposalResources: [
+      {
+        name: 'audit report',
+        url: 'https://github.com/aragon/osx/tree/main/audits',
+      },
+    ],
+    // todo either adjust this values or configure them to get the correct ones from env or json
+    proposalStartDate: 0,
+    proposalEndDate: 1739096365,
+  };
+};
+export default func;
+func.tags = ['Info', 'v1.4.0'];
+func.dependencies = ['Env'];

packages/contracts/deploy/verification/99_conclude/00_save-contract-addresses.ts

@@ -43,11 +43,16 @@ const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   }
 
   const storeInfo = {
+    proposalInfo: hre.proposalInfo,
     deployedContractAddresses,
     managementDAOActions: hre.managementDAOActions,
   };
 
-  await fs.writeFile('deployed_contracts.json', JSON.stringify(storeInfo));
+  await fs.writeFile(
+    'deployed_contracts.json',
+    JSON.stringify(storeInfo, null, 2),
+    'utf-8'
+  );
 };
 export default func;
 func.tags = ['New', 'Conclude', 'ConcludeEnd'];

packages/contracts/hardhat.config.ts

@@ -104,7 +104,12 @@ const config: HardhatUserConfig = {
       gasPrice: 80000000000,
       deploy: ENABLE_DEPLOY_TEST
         ? ['./deploy']
-        : ['./deploy/env', './deploy/new', './deploy/verification'],
+        : [
+            './deploy/env',
+            './deploy/new',
+            './deploy/verification',
+            './deploy/update',
+          ],
     },
     localhost: {
       deploy: ENABLE_DEPLOY_TEST

packages/contracts/package.json

@@ -32,7 +32,8 @@
     "prepublishOnly": "yarn build && yarn build:npm",
     "docgen": "hardhat docgen",
     "docs": "DOCS=true scripts/prepare-docs.sh",
-    "clean": "rm -rf artifacts cache deployments typechain"
+    "clean": "rm -rf artifacts cache deployments typechain",
+    "generate-proposal": "ts-node scripts/generate-manaign-dao-proposal-info.ts"
   },
   "repository": {
     "type": "git",

packages/contracts/scripts/generate-manaign-dao-proposal-info.ts

@@ -0,0 +1,213 @@
+// note using version 1.3.0 due to is the one currently installed on the managing dao change it once it's upgraded
+import {Multisig__factory as Multisig_v1_3_0__factory} from '../typechain/@aragon/osx-v1.3.0/plugins/governance/multisig/Multisig.sol';
+import {uploadToPinata} from '@aragon/osx-commons-sdk';
+import {ethers} from 'ethers';
+import * as fs from 'fs';
+import * as path from 'path';
+
+/**
+ * This script merges the plugin proposals actions inside the `proposalActionsPath` (./plugin-proposals-data) folder
+ * into the `mergedProposalActionsPath` (./merged-proposals.json) file.
+ *
+ * Steps
+ * 1- deploy all needed plugins
+ * 2- copy their deployment script to the `scripts/plugin-proposals-data` folder
+ * 3- deploy the new osx version (this can be done before deploy the plugins) => this will create a `deployed_contracts.json` file
+ * 4- run this script to merge the calldata from each plugin and the framework deployment into a single file
+ */
+
+interface Action {
+  to: string;
+  value: number;
+  data: string;
+  description: string;
+}
+
+interface ProposalAction {
+  to: string;
+  value: number;
+  data: string;
+}
+
+const deployedContractsPath = path.join(
+  __dirname,
+  '../deployed_contracts.json'
+);
+const proposalActionsPath = path.join(__dirname, './plugin-proposals-data');
+
+const mergedProposalActionsPath = path.join(
+  __dirname,
+  './merged-proposals.json'
+);
+
+const calldataPath = path.join(__dirname, './calldata.json');
+
+async function generateProposalJson() {
+  try {
+    // check if the file exists
+    if (!fs.existsSync(deployedContractsPath)) {
+      console.error('deployed_contracts.json file not found');
+      return;
+    }
+
+    const deployedContractsRaw = fs.readFileSync(
+      deployedContractsPath,
+      'utf-8'
+    );
+    // load the osx deployed contracts
+    const deployedContracts = JSON.parse(deployedContractsRaw);
+
+    // creates the folder if it doesn't exist
+    if (!fs.existsSync(proposalActionsPath)) {
+      fs.mkdirSync(proposalActionsPath, {recursive: true});
+      console.error(
+        'plugin-proposals-data folder created, add plugin proposals json to merge them'
+      );
+      return;
+    }
+
+    // read the plugin proposals data
+    const proposalFiles = fs
+      .readdirSync(proposalActionsPath)
+      .filter(file => file.endsWith('.json'));
+
+    if (proposalFiles.length === 0) {
+      console.error('No plugin proposals found in plugin-proposals-data');
+      return;
+    }
+
+    // store each plugin action
+    let tmpAction: Action;
+    for (const file of proposalFiles) {
+      const filePath = path.join(proposalActionsPath, file);
+      const dataRaw = fs.readFileSync(filePath, 'utf-8');
+      const data = JSON.parse(dataRaw);
+
+      tmpAction = {
+        to: data.actions[0].to,
+        value: data.actions[0].value,
+        data: data.actions[0].data,
+        description: data.proposalDescription,
+      };
+
+      deployedContracts.managementDAOActions.push(tmpAction);
+    }
+
+    // write the updated JSON back to a new file
+    fs.writeFileSync(
+      mergedProposalActionsPath,
+      JSON.stringify(deployedContracts, null, 2),
+      'utf-8'
+    );
+
+    console.log(
+      `Successfully created merged-proposals.json with all proposal actions in ${mergedProposalActionsPath}!`
+    );
+  } catch (error) {
+    console.error('Error generating proposal JSON:', error);
+    return;
+  }
+}
+
+export function generateHexCalldataInJson(functionArgs: any[]) {
+  try {
+    const abi = Multisig_v1_3_0__factory.abi;
+    const iface = new ethers.utils.Interface(abi);
+
+    const calldata = iface.encodeFunctionData('createProposal', functionArgs);
+
+    const jsonOutput = {
+      functionName: 'createProposal',
+      functionArgs: functionArgs,
+      calldata: calldata,
+    };
+
+    // write the call information in the json file
+    fs.writeFileSync(
+      calldataPath,
+      JSON.stringify(jsonOutput, null, 2),
+      'utf-8'
+    );
+    console.log(
+      `Successfully created calldata.json with the function call information in ${calldataPath}!`
+    );
+  } catch (error) {
+    console.error('Error encoding function data:', error);
+    throw error;
+  }
+}
+
+async function main() {
+  generateProposalJson();
+
+  // get the actions to send it to the createHexCalldata function
+  const jsonFile = JSON.parse(
+    fs.readFileSync(mergedProposalActionsPath, 'utf-8')
+  );
+
+  let args = [];
+
+  if (!jsonFile.managementDAOActions) {
+    console.error('No actions found in merged-proposals.json');
+    return 1;
+  }
+  // remove the description from the actions
+  let proposalActions: ProposalAction[] = [];
+  let proposalMetadataFullDescription: string = '';
+  jsonFile.managementDAOActions.forEach((action: Action) => {
+    proposalActions.push({
+      to: action.to,
+      value: action.value,
+      data: action.data,
+    });
+    proposalMetadataFullDescription += action.description + ' ';
+  });
+
+  // this should be adjusted based on the actual proposal
+  if (!jsonFile.proposalInfo) {
+    console.error('No proposal info found in merged-proposals.json');
+    return 1;
+  }
+
+  const metadatata = {
+    title: jsonFile.proposalInfo.proposalTitle,
+    summary: jsonFile.proposalInfo.proposalSummary,
+    description: proposalMetadataFullDescription,
+    resources: jsonFile.proposalInfo.proposalResources,
+  };
+
+  const metadataCIDPath = await uploadToPinata(
+    JSON.stringify(metadatata, null, 2),
+    `management-dao-proposal-update-v1.4.0-metadata`
+  );
+
+  // push the metadata
+  args.push(ethers.utils.hexlify(ethers.utils.toUtf8Bytes(metadataCIDPath)));
+  // push the actions
+  args.push(proposalActions);
+
+  // push allow failure map => to zero
+  args.push(0);
+
+  // push approve proposal => to false
+  args.push(false);
+
+  // push try execution => to false
+  args.push(false);
+
+  // push the start and end dates
+  args.push(jsonFile.proposalInfo.proposalStartDate);
+  args.push(jsonFile.proposalInfo.proposalEndDate);
+
+  // generate the calldata in a json file
+  generateHexCalldataInJson(args);
+}
+
+main()
+  .then(() => {
+    console.log('done!');
+  })
+  .catch(error => {
+    console.error('Error in main:', error);
+    process.exit(1);
+  });

packages/contracts/src/test/Migration.sol

@@ -40,6 +40,9 @@ import {PluginRepoRegistry as PluginRepoRegistry_v1_3_0} from "@aragon/osx-v1.3.
 import {ENSSubdomainRegistrar as ENSSubdomainRegistrar_v1_0_0} from "@aragon/osx-v1.0.1/framework/utils/ens/ENSSubdomainRegistrar.sol";
 import {ENSSubdomainRegistrar as ENSSubdomainRegistrar_v1_3_0} from "@aragon/osx-v1.3.0/framework/utils/ens/ENSSubdomainRegistrar.sol";
 
+// needed in the script to generate the managing dao proposal when upgrading
+import {Multisig as Multisig_v1_3_0} from "@aragon/osx-v1.3.0/plugins/governance/multisig/Multisig.sol";
+
 // Integration Testing
 import {ProxyFactory} from "@aragon/osx-commons-contracts/src/utils/deployment/ProxyFactory.sol";
 

packages/contracts/types/hardhat.d.ts

@@ -27,6 +27,16 @@ declare module 'hardhat/types/runtime' {
     aragonToVerifyContracts: AragonVerifyEntry[];
     managementDAOMultisigPluginAddress: string;
     placeholderBuildCIDPath: string;
+    proposalInfo: {
+      proposalTitle: string;
+      proposalSummary: string;
+      proposalResources: {
+        name: string;
+        url: string;
+      }[];
+      proposalStartDate: number;
+      proposalEndDate: number;
+    };
     managementDAOActions: {
       to: string;
       value: BigNumberish;