docs: add/extend function annotation for create2 and governance scripts

Author: rackstar

scripts/create2/deploy.js

@@ -8,6 +8,9 @@ const { parseEther } = require('ethers/lib/utils');
 
 const ADDRESS_REGEX = /^0x[a-f0-9]{40}$/i;
 
+/**
+ * Supports both mainnet and tenderly networks
+ */
 const usage = () => {
   console.log(`
     Usage:

scripts/create2/get-signer.js

@@ -12,7 +12,7 @@ const getSigner = async (kind = SIGNER_TYPE.LOCAL) => {
   const provider = ethers.provider;
   const { AWS_KMS_KEY_ID, AWS_REGION } = process.env;
 
-  // Use contract deployer address to closely imitate main-net deployment
+  // Use contract deployer address to closely mimic main-net deployment
   if (kind === SIGNER_TYPE.LOCAL) {
     await provider.send('hardhat_impersonateAccount', [CONTRACT_DEPLOYER]);
     const signer = await provider.getSigner(CONTRACT_DEPLOYER);

scripts/governance/execute-createProposalWithSolution-txdata.js

@@ -3,7 +3,10 @@ const { ethers, network } = require('hardhat');
 const { sendTransaction, prepareProposalTransaction } = require('./helpers');
 
 /**
- * Generate and execute the tx data for the Governance.createProposalWithSolution transaction
+ * Generates and executes the tx data for the Governance.createProposalWithSolution transaction
+ *
+ * node execute-createProposalWithSolution-txdata.js <PATH_PROPOSAL_JSON> <CATEGORY_ID> <ENCODED_ACTION_DATA>
+ *
  * @param proposalFilePath path for file of proposal data containing title, shortDescription, and description
  * @param categoryId category id for the proposal
  * @param actionParamsRaw action params for the proposal as stringified JSON

scripts/governance/get-decoded-action-data.js

@@ -7,6 +7,12 @@ const { defaultAbiCoder, toUtf8String } = ethers.utils;
 // Prefixed and non-prefixed hex are both valid
 const HEX_REGEX = /^(?:0x)?[a-f0-9]+$/i;
 
+/**
+ * Decodes the given encoded hex action data according to the categoryId
+ *
+ * Execute command:
+ * node scripts/governance/get-decoded-action-data -i <CATEGORY_ID> -d '<HEX_ENCODED_ACTION_DATA>'
+ */
 const usage = () => {
   console.log(`
     Usage:

scripts/governance/get-encoded-action-data.js

@@ -4,6 +4,11 @@ const { PROPOSAL_CATEGORY } = require('./constants');
 const { defaultAbiCoder, toUtf8Bytes } = ethers.utils;
 const ADDRESS_REGEX = /^0x[a-f0-9]{40}$/i;
 
+/**
+ * Encodes the given actions params according to the categoryId
+ *
+ * node scripts/governance/get-encoded-action-data -i <CATEGORY_ID> -a '<ACTION_PARAMS_JSON_ARRAY>'
+ */
 const usage = () => {
   console.log(`
     Usage:

scripts/governance/simulate-createProposalWithSolution-txdata.js

@@ -4,7 +4,10 @@ const { ethers, network } = require('hardhat');
 const { simulateTransaction, prepareProposalTransaction, verifyDecodedCreateProposalTxInputs } = require('./helpers');
 
 /**
- * Generate and simulate the tx data for the Governance.createProposalWithSolution transaction
+ * Generates and simulates the tx data for the Governance.createProposalWithSolution transaction
+ *
+ * node simulate-createProposalWithSolution-txdata.js <PATH_PROPOSAL_JSON> <CATEGORY_ID> <ENCODED_ACTION_DATA>
+ *
  * @param proposalFilePath path for file of proposal data containing title, shortDescription, and description
  * @param categoryId category id for the proposal
  * @param actionParamsRaw action params for the proposal as stringified JSON