improvement to jsdoc types

Author: Zhan Milenkov

src/commands/account.mjs

@@ -129,8 +129,8 @@ export class AccountCommand extends BaseCommand {
   }
 
   /**
-   * @param toAccountId
-   * @param amount
+   * @param {AccountId} toAccountId
+   * @param {number} amount
    * @returns {Promise<boolean>}
    */
   async transferAmountFromOperator (toAccountId, amount) {

src/commands/cluster.mjs

@@ -222,7 +222,7 @@ export class ClusterCommand extends BaseCommand {
 
   /**
    * Return Yargs command definition for 'cluster' command
-   * @param {ClusterCommand} clusterCmd an instance of ClusterCommand
+   * @param {ClusterCommand} clusterCmd - an instance of ClusterCommand
    * @returns {{command: string, desc: string, builder: Function}}
    */
   static getCommandDefinition (clusterCmd) {

src/commands/flags.mjs

@@ -14,7 +14,7 @@
  * limitations under the License.
  *
  */
-'use strict';
+'use strict'
 import { constants } from '../core/index.mjs'
 import * as core from '../core/index.mjs'
 import * as version from '../../version.mjs'

src/commands/index.mjs

@@ -27,7 +27,7 @@ import * as flags from './flags.mjs'
 /**
  * Return a list of Yargs command builder to be exposed through CLI
  * @param {Object} opts it is an Options object containing logger
- * @returns {Array<>} TODO
+ * @returns {Array<{command: string, desc: string, builder: Function, handler?: Function}[]>}
  */
 function Initialize (opts) {
   const initCmd = new InitCommand(opts)

src/commands/mirror_node.mjs

@@ -46,7 +46,7 @@ export class MirrorNodeCommand extends BaseCommand {
   }
 
   /**
-   * @returns {*[]}
+   * @returns {CommandFlag[]}
    */
   static get DEPLOY_FLAGS_LIST () {
     return [

src/commands/network.mjs

@@ -47,7 +47,7 @@ export class NetworkCommand extends BaseCommand {
   }
 
   /**
-   * @returns {*[]}
+   * @returns {CommandFlag[]}
    */
   static get DEPLOY_FLAGS_LIST () {
     return [
@@ -157,7 +157,7 @@ export class NetworkCommand extends BaseCommand {
 
   /**
    * @param task
-   * @param argv
+   * @param {Object} argv
    * @returns {Promise<NetworkDeployConfigClass>}
    */
   async prepareConfig (task, argv) {

src/commands/node.mjs

@@ -190,7 +190,6 @@ export class NodeCommand extends BaseCommand {
    * @returns {Promise<void>}
    */
   async close () {
-    // TODO VALIDATE AWAIT IS NEEDED
     await this.accountManager.close()
     if (this._portForwards) {
       for (const srv of this._portForwards) {
@@ -569,7 +568,7 @@ export class NodeCommand extends BaseCommand {
    * @param {Object} podNames
    * @param {*} task
    * @param {string} localBuildPath
-   * @returns {Listr<any, any, any>}
+   * @returns {Listr<*, *, *>}
    */
   uploadPlatformSoftware (nodeIds, podNames, task, localBuildPath) {
     const self = this
@@ -627,9 +626,9 @@ export class NodeCommand extends BaseCommand {
    * @param {string[]} nodeIds
    * @param {Object} podNames
    * @param {string} releaseTag
-   * @param task
+   * @param {*} task
    * @param {string} localBuildPath
-   * @returns {Listr<*, *, *>|*}
+   * @returns {Listr<*, *, *>}
    */
   fetchLocalOrReleasedPlatformSoftware (nodeIds, podNames, releaseTag, task, localBuildPath) {
     const self = this
@@ -644,8 +643,8 @@ export class NodeCommand extends BaseCommand {
    * @param {string[]} nodeIds
    * @param {Object} podNames
    * @param {string} releaseTag
-   * @param task
-   * @param platformInstaller
+   * @param {*} task
+   * @param {PlatformInstaller} platformInstaller
    * @returns {Listr<any, any, any>}
    */
   fetchPlatformSoftware (nodeIds, podNames, releaseTag, task, platformInstaller) {

src/commands/prompts.mjs

@@ -14,7 +14,7 @@
  * limitations under the License.
  *
  */
-'use strict';
+'use strict'
 import { ListrEnquirerPromptAdapter } from '@listr2/prompt-adapter-enquirer'
 import fs from 'fs'
 import { FullstackTestingError, IllegalArgumentError } from '../core/errors.mjs'

src/commands/relay.mjs

@@ -47,7 +47,7 @@ export class RelayCommand extends BaseCommand {
   }
 
   /**
-   * @returns {*[]}
+   * @returns {CommandFlag[]}
    */
   static get DEPLOY_FLAGS_LIST () {
     return [

src/core/account_manager.mjs

@@ -14,7 +14,7 @@
  * limitations under the License.
  *
  */
-'use strict';
+'use strict'
 import * as HashgraphProto from '@hashgraph/proto'
 import * as Base64 from 'js-base64'
 import os from 'os'
@@ -42,6 +42,13 @@ import ip from 'ip'
 import { NetworkNodeServicesBuilder } from './network_node_services.mjs'
 import path from 'path'
 
+/**
+ * @typedef {Object} AccountIdWithKeyPairObject
+ * @property {string} accountId
+ * @property {string} privateKey
+ * @property {string} publicKey
+ */
+
 const REASON_FAILED_TO_GET_KEYS = 'failed to get keys for accountId'
 const REASON_SKIPPED = 'skipped since it does not have a genesis key'
 const REASON_FAILED_TO_UPDATE_ACCOUNT = 'failed to update account keys'
@@ -72,11 +79,9 @@ export class AccountManager {
 
   /**
    * Gets the account keys from the Kubernetes secret from which it is stored
-   * TODO SEEMS NOT TO BE STRING accountId
    * @param {string} accountId - the account ID for which we want its keys
    * @param {string} namespace - the namespace that is storing the secret
-   * @returns {Promise<{accountId: string, privateKey: string, publicKey: string}|null>} a custom object
-   * with the account id, private key, and public key
+   * @returns {Promise<AccountIdWithKeyPairObject>}
    */
   async getAccountKeysFromSecret (accountId, namespace) {
     const secret = await this.k8.getSecret(namespace, Templates.renderAccountKeySecretLabelSelector(accountId))
@@ -101,7 +106,7 @@ export class AccountManager {
    * returns the Genesis private key, then will return an AccountInfo object with the
    * accountId, privateKey, publicKey
    * @param {string} namespace - the namespace that the secret is in
-   * @returns {Promise<{accountId: string, privateKey: string, publicKey: string}>}
+   * @returns {Promise<AccountIdWithKeyPairObject>}
    */
   async getTreasuryAccountKeys (namespace) {
     // check to see if the treasure account is in the secrets
@@ -111,7 +116,7 @@ export class AccountManager {
   /**
    * batch up the accounts into sets to be processed
    * @param {number[][]} [accountRange]
-   * @returns an array of arrays of numbers representing the accounts to update
+   * @returns {number[][]} an array of arrays of numbers representing the accounts to update
    */
   batchAccounts (accountRange = constants.SYSTEM_ACCOUNTS) {
     const batchSize = constants.ACCOUNT_UPDATE_BATCH_SIZE
@@ -210,10 +215,10 @@ export class AccountManager {
 
   /**
    * Returns a node client that can be used to make calls against
-   * @param namespace the namespace for which the node client resides
-   * @param {Map<string, NetworkNodeServices>}networkNodeServicesMap a map of the service objects that proxy the nodes
-   * @param operatorId the account id of the operator of the transactions
-   * @param operatorKey the private key of the operator of the transactions
+   * @param {string} namespace - the namespace for which the node client resides
+   * @param {Map<string, NetworkNodeServices>} networkNodeServicesMap - a map of the service objects that proxy the nodes
+   * @param {string} operatorId - the account id of the operator of the transactions
+   * @param {string} operatorKey - the private key of the operator of the transactions
    * @returns {Promise<import('@hashgraph/sdk').Client>} a node client that can be used to call transactions
    */
   async _getNodeClient (namespace, networkNodeServicesMap, operatorId, operatorKey) {
@@ -253,8 +258,8 @@ export class AccountManager {
 
   /**
    * Gets a Map of the Hedera node services and the attributes needed
-   * @param namespace the namespace of the fullstack network deployment
-   * @returns {Promise<Map<String,NetworkNodeServices>>} a map of the network node services
+   * @param {string} namespace - the namespace of the fullstack network deployment
+   * @returns {Promise<Map<string, NetworkNodeServices>>} a map of the network node services
    */
   async getNodeServiceMap (namespace) {
     const labelSelector = 'fullstack.hedera.com/node-name'
@@ -330,12 +335,11 @@ export class AccountManager {
   }
 
   /**
-   * updates a set of special accounts keys with a newly generated key and stores them in a
-   * Kubernetes secret
-   * @param namespace the namespace of the nodes network
-   * @param currentSet the accounts to update
-   * @param updateSecrets whether to delete the secret prior to creating a new secret
-   * @param resultTracker an object to keep track of the results from the accounts that are being updated
+   * updates a set of special accounts keys with a newly generated key and stores them in a Kubernetes secret
+   * @param {string} namespace the namespace of the nodes network
+   * @param {string[]} currentSet - the accounts to update
+   * @param {boolean} updateSecrets - whether to delete the secret prior to creating a new secret
+   * @param {Object} resultTracker - an object to keep track of the results from the accounts that are being updated
    * @returns {Promise<*>} the updated resultTracker object
    */
   async updateSpecialAccountsKeys (namespace, currentSet, updateSecrets, resultTracker) {
@@ -374,12 +378,11 @@ export class AccountManager {
   }
 
   /**
-   * update the account keys for a given account and store its new key in a Kubernetes
-   * secret
-   * @param namespace the namespace of the nodes network
-   * @param accountId the account that will get its keys updated
-   * @param genesisKey the genesis key to compare against
-   * @param updateSecrets whether to delete the secret prior to creating a new secret
+   * update the account keys for a given account and store its new key in a Kubernetes secret
+   * @param {string} namespace - the namespace of the nodes network
+   * @param {AccountId} accountId - the account that will get its keys updated
+   * @param {PrivateKey} genesisKey - the genesis key to compare against
+   * @param {boolean} updateSecrets - whether to delete the secret prior to creating a new secret
    * @returns {Promise<{value: string, status: string}|{reason: string, value: string, status: string}>} the result of the call
    */
   async updateAccountKeys (namespace, accountId, genesisKey, updateSecrets) {
@@ -468,7 +471,7 @@ export class AccountManager {
 
   /**
    * gets the account info from Hedera network
-   * @param accountId the account
+   * @param {AccountId|string} accountId - the account
    * @returns {AccountInfo} the private key of the account
    */
   async accountInfoQuery (accountId) {
@@ -485,7 +488,7 @@ export class AccountManager {
 
   /**
    * gets the account private and public key from the Kubernetes secret from which it is stored
-   * @param accountId the account
+   * @param {AccountId|string} accountId - the account
    * @returns {Promise<Key[]>} the private key of the account
    */
   async getAccountKeys (accountId) {
@@ -503,9 +506,9 @@ export class AccountManager {
 
   /**
    * send an account key update transaction to the network of nodes
-   * @param accountId the account that will get it's keys updated
-   * @param newPrivateKey the new private key
-   * @param oldPrivateKey the genesis key that is the current key
+   * @param {AccountId|string} accountId - the account that will get its keys updated
+   * @param {PrivateKey|string} newPrivateKey - the new private key
+   * @param {PrivateKey|string} oldPrivateKey - the genesis key that is the current key
    * @returns {Promise<boolean>} whether the update was successful
    */
   async sendAccountKeyUpdate (accountId, newPrivateKey, oldPrivateKey) {
@@ -538,13 +541,13 @@ export class AccountManager {
 
   /**
    * creates a new Hedera account
-   * @param namespace the namespace to store the Kubernetes key secret into
-   * @param privateKey the private key of type PrivateKey
-   * @param amount the amount of HBAR to add to the account
-   * @param setAlias whether to set the alias of the account to the public key,
-   * requires the privateKey supplied to be ECDSA
-   * @returns {{accountId: AccountId, privateKey: string, publicKey: string, balance: number}} a
-   * custom object with the account information in it
+   * @param {string} namespace - the namespace to store the Kubernetes key secret into
+   * @param {Key} privateKey - the private key of type PrivateKey
+   * @param {number} amount - the amount of HBAR to add to the account
+   * @param {boolean} [setAlias] - whether to set the alias of the account to the public key, requires
+   * the privateKey supplied to be ECDSA
+   * @returns {{accountId: AccountId, privateKey: string, publicKey: string, balance: number}} a custom object with
+   * the account information in it
    */
   async createNewAccount (namespace, privateKey, amount, setAlias = false) {
     const newAccountTransaction = new AccountCreateTransaction()
@@ -601,9 +604,9 @@ export class AccountManager {
 
   /**
    * transfer the specified amount of HBAR from one account to another
-   * @param fromAccountId the account to pull the HBAR from
-   * @param toAccountId the account to put the HBAR
-   * @param hbarAmount the amount of HBAR
+   * @param {AccountId|string} fromAccountId - the account to pull the HBAR from
+   * @param {AccountId|string} toAccountId - the account to put the HBAR
+   * @param {number} hbarAmount - the amount of HBAR
    * @returns {Promise<boolean>} if the transaction was successfully posted
    */
   async transferAmount (fromAccountId, toAccountId, hbarAmount) {

src/core/chart_manager.mjs

@@ -14,11 +14,16 @@
  * limitations under the License.
  *
  */
+'use strict'
 import { constants } from './index.mjs'
 import chalk from 'chalk'
 import { FullstackTestingError } from './errors.mjs'
 
 export class ChartManager {
+  /**
+   * @param {Helm} helm
+   * @param {Logger} logger
+   */
   constructor (helm, logger) {
     if (!logger) throw new Error('An instance of core/Logger is required')
     if (!helm) throw new Error('An instance of core/Helm is required')
@@ -32,7 +37,7 @@ export class ChartManager {
    *
    * This must be invoked before calling other methods
    *
-   * @param repoURLs - a map of name and chart repository URLs
+   * @param {Map<string, string>} repoURLs - a map of name and chart repository URLs
    * @param {boolean} force - whether or not to update the repo
    * @returns {Promise<string[]>}
    */

src/core/config_manager.mjs

@@ -14,7 +14,7 @@
  * limitations under the License.
  *
  */
-'use strict';
+'use strict'
 import fs from 'fs'
 import { FullstackTestingError, MissingArgumentError } from './errors.mjs'
 import { constants } from './index.mjs'

src/core/constants.mjs

@@ -14,6 +14,7 @@
  * limitations under the License.
  *
  */
+'use strict'
 import { AccountId, FileId } from '@hashgraph/sdk'
 import { color, PRESET_TIMER } from 'listr2'
 import path, { dirname, normalize } from 'path'
@@ -77,11 +78,9 @@ export const GENESIS_KEY = process.env.GENESIS_KEY || '302e020100300506032b65700
 export const SYSTEM_ACCOUNTS = [[3, 100], [200, 349], [400, 750], [900, 1000]] // do account 0.0.2 last and outside the loop
 export const SHORTER_SYSTEM_ACCOUNTS = [[3, 60]]
 export const TREASURY_ACCOUNT = 2
-
-// TODO Verify that parsing to integer is required
-export const LOCAL_NODE_START_PORT = parseInt(process.env.LOCAL_NODE_START_PORT) || 30212
-export const LOCAL_NODE_PROXY_START_PORT = parseInt(process.env.LOCAL_NODE_PROXY_START_PORT) || 30313
-export const ACCOUNT_UPDATE_BATCH_SIZE = parseInt(process.env.ACCOUNT_UPDATE_BATCH_SIZE) || 10
+export const LOCAL_NODE_START_PORT = process.env.LOCAL_NODE_START_PORT || 30212
+export const LOCAL_NODE_PROXY_START_PORT = process.env.LOCAL_NODE_PROXY_START_PORT || 30313
+export const ACCOUNT_UPDATE_BATCH_SIZE = process.env.ACCOUNT_UPDATE_BATCH_SIZE || 10
 
 export const NODE_PROXY_USER_ID = process.env.NODE_PROXY_USER_ID || 'admin'
 export const NODE_PROXY_PASSWORD = process.env.NODE_PROXY_PASSWORD || 'adminpwd'
@@ -142,12 +141,11 @@ export const PROFILE_LOCAL = 'local'
 export const ALL_PROFILES = [PROFILE_LOCAL, PROFILE_TINY, PROFILE_SMALL, PROFILE_MEDIUM, PROFILE_LARGE]
 export const DEFAULT_PROFILE_FILE = path.join(SOLO_CACHE_DIR, 'profiles', 'custom-spec.yaml')
 
-// TODO Verify that parsing to integer is required
 // ------ Hedera SDK Related ------
-export const NODE_CLIENT_MAX_ATTEMPTS = parseInt(process.env.NODE_CLIENT_MAX_ATTEMPTS) || 60
-export const NODE_CLIENT_MIN_BACKOFF = parseInt(process.env.NODE_CLIENT_MIN_BACKOFF) || 1000
-export const NODE_CLIENT_MAX_BACKOFF = parseInt(process.env.NODE_CLIENT_MAX_BACKOFF) || 1000
-export const NODE_CLIENT_REQUEST_TIMEOUT = parseInt(process.env.NODE_CLIENT_REQUEST_TIMEOUT) || 120000
+export const NODE_CLIENT_MAX_ATTEMPTS = process.env.NODE_CLIENT_MAX_ATTEMPTS || 60
+export const NODE_CLIENT_MIN_BACKOFF = process.env.NODE_CLIENT_MIN_BACKOFF || 1000
+export const NODE_CLIENT_MAX_BACKOFF = process.env.NODE_CLIENT_MAX_BACKOFF || 1000
+export const NODE_CLIENT_REQUEST_TIMEOUT = process.env.NODE_CLIENT_REQUEST_TIMEOUT || 120000
 
 // ---- New Node Related ----
 export const ENDPOINT_TYPE_IP = 'IP'

src/core/helpers.mjs

@@ -146,7 +146,7 @@ export function createBackupDir (destDir, prefix = 'backup', curDate = new Date(
 }
 
 /**
- * @param {Map} [fileMap]
+ * @param {Map<string, string>} [fileMap]
  * @param {boolean} removeOld
  */
 export function makeBackup (fileMap = new Map(), removeOld = true) {
@@ -287,7 +287,7 @@ export async function getNodeLogs (k8, namespace) {
 
 /**
  * Create a map of node IDs to account IDs
- * @param {string[]} nodeIDs - an array of the node IDs
+ * @param {string[]} nodeIDs
  * @returns {Map<string, string>} the map of node IDs to account IDs
  */
 export function getNodeAccountMap (nodeIDs) {