docs: update function annotations

Author: rackstar

scripts/governance/execute-createProposalWithSolution-txdata.js

@@ -8,7 +8,6 @@ const { sendTransaction, prepareProposalTransaction } = require('./helpers');
  * @param categoryId category id for the proposal
  * @param actionParamsRaw action params for the proposal as stringified JSON
  * @param solutionHash hash of the solution for the proposal
- * @returns {Promise<{createProposalWithSolution: *}>}
  */
 const main = async (proposalFilePath, categoryId, actionParamsRaw, solutionHash = '') => {
   if (network.name === 'tenderly') {

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

@@ -79,6 +79,11 @@ async function main() {
   decodeParamData(opts);
 }
 
+/**
+ * Function to decode action parameters from a governance proposal
+ * @param {Object} options - options object containing categoryId and data
+ * @returns an array of processed values, converting bytes to UTF8 where applicable
+ */
 function decodeParamData(options) {
   const actionParamTypes = PROPOSAL_CATEGORY[options.categoryId].actionParamTypes;
 

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

@@ -138,6 +138,13 @@ function processArg(arg, type, argsIndex) {
   return arg;
 }
 
+/**
+ * Encodes the action parameters for a given governance proposal category.
+ *
+ * @param {string} categoryId - The ID of the governance proposal category.
+ * @param {Array} actionParams - The parameters to be encoded, in the order specified by the category.
+ * @returns {string} The encoded action data in a hex string format.
+ */
 function getEncodedAction(categoryId, actionParams) {
   const { actionParamTypes, description } = PROPOSAL_CATEGORY[categoryId];
 

scripts/governance/simulate-createProposalWithSolution-txdata.js

@@ -9,7 +9,6 @@ const { simulateTransaction, prepareProposalTransaction, verifyDecodedCreateProp
  * @param categoryId category id for the proposal
  * @param actionParamsRaw action params for the proposal as stringified JSON
  * @param solutionHash hash of the solution for the proposal
- * @returns {Promise<{createProposalWithSolution: *}>}
  */
 const main = async (proposalFilePath, categoryId, actionParamsRaw, solutionHash = '') => {
   if (network.name === 'tenderly') {