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/management-dao-proposal/files-to-merge/
 
 # generated
 generated

packages/contracts/deploy/new/40_finalize-management-dao/20_register-management-dao-on-dao-registry.ts

@@ -81,11 +81,16 @@ const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
 
   let metadataCIDPath = '0x';
 
+  if (!process.env.PUB_PINATA_JWT) {
+    throw new Error('PUB_PINATA_JWT is not set');
+  }
+
   if (!isLocal(hre.network)) {
     // Upload the metadata to IPFS
     metadataCIDPath = await uploadToPinata(
-      JSON.stringify(MANAGEMENT_DAO_METADATA, null, 2),
-      `management-dao-metadata`
+      MANAGEMENT_DAO_METADATA,
+      `management-dao-metadata`,
+      process.env.PUB_PINATA_JWT
     );
   }
 

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: 1739802134,
+  };
+};
+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/management-dao-proposal/generate-managing-dao-proposal-info.ts"
   },
   "repository": {
     "type": "git",
@@ -52,7 +53,7 @@
   },
   "devDependencies": {
     "@aragon/osx-commons-configs": "^0.8.0",
-    "@aragon/osx-commons-sdk": "^0.1.0",
+    "@aragon/osx-commons-sdk": "^0.2.0",
     "@aragon/osx-ethers-v1.2.0": "npm:@aragon/[email protected]",
     "@aragon/osx-v1.0.1": "npm:@aragon/[email protected]",
     "@aragon/osx-v1.3.0": "npm:@aragon/[email protected]",

packages/contracts/scripts/management-dao-proposal/README.md

@@ -0,0 +1,58 @@
+## Description
+
+This script merges the plugin proposal actions defined in the files inside the `files-to-merge` folder and the `deployed_contracts.json` file into the `merged-proposals.json` file.
+
+## How it works
+
+Before running this script, you need to deploy the plugins and the framework.
+
+To deploy the framework, run the deploy script in the `packages/contracts` folder:
+
+```
+yarn deploy --network <network> --tags <the tags>
+```
+
+For deploying version `1.4.0` on Sepolia, you can run:
+
+```
+yarn deploy --network sepolia --tags v1.4.0,VerifyEnd,ConcludeEnd
+```
+
+This will generate a `deployed_contracts.json` file in the `packages/contracts` folder that will be used by this script to merge proposal actions. The proposal information will be included (for more details, check the first deployment step in the `01_Info.ts` file). You can modify this information as needed (elements like the proposal end date might need modification).
+
+After deploying the framework, go to each plugin repository and run the deploy script:
+
+```
+yarn deploy --network <network> --tags <the tags>
+```
+
+For deploying and publishing a new version on Sepolia, you can run:
+
+```
+yarn deploy --network sepolia --tags NewVersion,Verification
+```
+
+This deployment will generate a `createVersionProposalData-network.json` file that you need to copy to the `./files-to-merge` folder.
+
+Once you have both the `deployed_contracts.json` file and the plugin deployment json files, you can run this script to merge the proposal actions:
+
+```
+yarn generate-proposal-json
+```
+
+This will generate two files in the `./generated` folder:
+
+- A `merged-proposals.json` file with all the proposal and deployment details
+- A `calldata.json` file with the proposal information and the raw calldata
+
+## Steps
+
+1. Deploy the framework
+2. Deploy the plugins
+3. Copy the deployment json files to the `./files-to-merge` folder
+4. Run the script to merge the proposal actions
+5. The `./generated` folder will be created with the `merged-proposals.json` file and the `calldata.json` file
+
+## Note
+
+To test the deployment and the generated calldata, you can check the tests in the `test/deploy/deployment-1.4.0.ts` file. It will attempt to create, approve, and execute the proposal with the calldata generated by this script. This file is specific for checking the deployment of version `1.4.0`; you might need to modify it for other versions. Also, note that the test is forking the network, so you might need to adjust the network name and the fork block number.

packages/contracts/scripts/management-dao-proposal/generate-managing-dao-proposal-info.ts

@@ -0,0 +1,214 @@
+// 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 dotenv from 'dotenv';
+import {ethers} from 'ethers';
+import * as fs from 'fs';
+import * as path from 'path';
+
+dotenv.config({path: path.resolve(__dirname, '../../.env')});
+
+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, './files-to-merge');
+
+const mergedProposalActionsPath = path.join(
+  __dirname,
+  './generated/merged-proposals.json'
+);
+
+const calldataPath = path.join(__dirname, './generated/calldata.json');
+
+function generateProposalJson() {
+  // check if the file exists
+  if (!fs.existsSync(deployedContractsPath)) {
+    throw new Error('deployed_contracts.json file not found');
+  }
+
+  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});
+
+    throw new Error('No plugin proposals found in files-to-merge');
+  }
+
+  // read the plugin proposals data
+  const proposalFiles = fs
+    .readdirSync(proposalActionsPath)
+    .filter(file => file.endsWith('.json'));
+
+  if (proposalFiles.length === 0) {
+    throw new Error('No plugin proposals found in files-to-merge');
+  }
+
+  // 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);
+
+    // Validate that the JSON has both 'actions' and 'proposalDescription'
+    if (
+      !data.actions ||
+      !Array.isArray(data.actions) ||
+      data.actions.length === 0 ||
+      !data.proposalDescription ||
+      !data.actions[0].to ||
+      data.actions[0].value === undefined ||
+      !data.actions[0].data
+    ) {
+      console.error(
+        `File ${file} is missing required fields ('actions' and/or 'proposalDescription'). Skipping.`
+      );
+      continue;
+    }
+
+    tmpAction = {
+      to: data.actions[0]?.to,
+      value: data.actions[0]?.value,
+      data: data.actions[0]?.data,
+      description: data.proposalDescription,
+    };
+
+    deployedContracts.managementDAOActions.push(tmpAction);
+  }
+
+  // Create directory if it doesn't exist
+  const mergedProposalDir = path.dirname(mergedProposalActionsPath);
+  if (!fs.existsSync(mergedProposalDir)) {
+    fs.mkdirSync(mergedProposalDir, {recursive: true});
+  }
+
+  // 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}!`
+  );
+}
+
+function generateHexCalldataInJson(functionArgs: any[]) {
+  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}!`
+  );
+}
+
+async function main() {
+  generateProposalJson();
+
+  // Check if merged proposals file exists
+  if (!fs.existsSync(mergedProposalActionsPath)) {
+    throw new Error(`File not found: ${mergedProposalActionsPath}`);
+  }
+
+  // get the actions to send it to the createHexCalldata function
+  const jsonFile = JSON.parse(
+    fs.readFileSync(mergedProposalActionsPath, 'utf-8')
+  );
+
+  let args = [];
+
+  if (!jsonFile.managementDAOActions) {
+    throw new Error('No actions found in merged-proposals.json');
+  }
+  // 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) {
+    throw new Error('No proposal info found in merged-proposals.json');
+  }
+
+  const metadata = {
+    title: jsonFile.proposalInfo.proposalTitle,
+    summary: jsonFile.proposalInfo.proposalSummary,
+    description: proposalMetadataFullDescription,
+    resources: jsonFile.proposalInfo.proposalResources,
+  };
+
+  if (!process.env.PUB_PINATA_JWT) {
+    throw new Error('PUB_PINATA_JWT is not set');
+  }
+
+  const metadataCIDPath = await uploadToPinata(
+    metadata,
+    `management-dao-proposal-update-v1.4.0-metadata`,
+    process.env.PUB_PINATA_JWT
+  );
+
+  // 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";