chore: move print* functions into common

axelarnetwork · Jul 26, 2024 · feef9c3 · feef9c3
1 parent a79088e
commit feef9c3
Show file tree

Hide file tree

Showing 32 changed files with 97 additions and 120 deletions.
diff --git a/common/index.js b/common/index.js
@@ -1,4 +1,4 @@
 module.exports = {
-  ...require('./cli-utils'),
-  ...require('./utils'),
-}
+    ...require('./cli-utils'),
+    ...require('./utils'),
+};
diff --git a/common/utils.js b/common/utils.js
@@ -1,24 +1,57 @@
-'use strict'
+'use strict';
 
 const { outputJsonSync } = require('fs-extra');
+const chalk = require('chalk');
 
 function loadConfig(env) {
-  return require(`${__dirname}/../axelar-chains-config/info/${env}.json`);
+    return require(`${__dirname}/../axelar-chains-config/info/${env}.json`);
 }
 
 function saveConfig(config, env) {
-  writeJSON(config, `${__dirname}/../axelar-chains-config/info/${env}.json`);
+    writeJSON(config, `${__dirname}/../axelar-chains-config/info/${env}.json`);
 }
 
 const writeJSON = (data, name) => {
-  outputJsonSync(name, data, {
-      spaces: 2,
-      EOL: '\n',
-  });
+    outputJsonSync(name, data, {
+        spaces: 2,
+        EOL: '\n',
+    });
 };
 
-module.exports = {
-  loadConfig,
-  saveConfig,
-  writeJSON,
+const printInfo = (msg, info = '', colour = chalk.green) => {
+    if (info) {
+        console.log(`${msg}: ${colour(info)}\n`);
+    } else {
+        console.log(`${msg}\n`);
+    }
+};
+
+const printWarn = (msg, info = '') => {
+    if (info) {
+        msg = `${msg}: ${info}`;
+    }
+
+    console.log(`${chalk.italic.yellow(msg)}\n`);
+};
+
+const printError = (msg, info = '') => {
+    if (info) {
+        msg = `${msg}: ${info}`;
+    }
+
+    console.log(`${chalk.bold.red(msg)}\n`);
+};
+
+function printLog(log) {
+    console.log(JSON.stringify({ log }, null, 2));
 }
+
+module.exports = {
+    loadConfig,
+    saveConfig,
+    writeJSON,
+    printInfo,
+    printWarn,
+    printError,
+    printLog,
+};
diff --git a/evm/broadcast-transactions.js b/evm/broadcast-transactions.js
@@ -7,9 +7,8 @@ const {
     providers: { getDefaultProvider },
 } = ethers;
 
-const { printError, printInfo, printWarn, getConfigByChainId, prompt } = require('./utils');
-const { loadConfig } = require('../common');
-const { addBaseOptions } = require('../common');
+const { getConfigByChainId, prompt } = require('./utils');
+const { printError, printInfo, printWarn, addBaseOptions, loadConfig } = require('../common');
 const { sendTransaction, getSignedTx, storeSignedTx } = require('./sign-utils');
 
 async function processCommand(config, _, options, file) {

diff --git a/evm/check-finality.js b/evm/check-finality.js
@@ -5,8 +5,8 @@ const {
     providers: { JsonRpcProvider },
 } = ethers;
 const { Command, Option } = require('commander');
-const { printInfo, mainProcessor, isKeccak256Hash, sleep } = require('./utils');
-const { addBaseOptions } = require('../common');
+const { mainProcessor, isKeccak256Hash, sleep } = require('./utils');
+const { printInfo, addBaseOptions } = require('../common');
 
 async function processCommand(_config, chain, options) {
     const txHash = options.txHash;

diff --git a/evm/check-ownership-request.js b/evm/check-ownership-request.js
@@ -5,18 +5,9 @@ require('dotenv').config();
 const axios = require('axios');
 const { Command, Option } = require('commander');
 const { ethers } = require('hardhat');
-const {loadConfig} = require('../common');
+const { loadConfig, printError, printInfo, printWarn } = require('../common');
 const { Contract, getDefaultProvider } = ethers;
-const {
-    validateParameters,
-    printError,
-    getContractJSON,
-    printInfo,
-    printWarn,
-    printObj,
-    isValidAddress,
-    isStringArray,
-} = require('./utils');
+const { validateParameters, getContractJSON, printObj, isValidAddress, isStringArray } = require('./utils');
 
 const interchainTokenFactoryABI = getContractJSON('InterchainTokenFactory').abi;
 const interchainTokenABI = getContractJSON('InterchainToken').abi;

diff --git a/evm/check-wallet-balance.js b/evm/check-wallet-balance.js
@@ -4,8 +4,8 @@ const { Command, Option } = require('commander');
 const { ethers } = require('hardhat');
 const { getDefaultProvider, BigNumber } = ethers;
 
-const { printError, mainProcessor } = require('./utils');
-const { addBaseOptions } = require('../common');
+const { mainProcessor } = require('./utils');
+const { printError, addBaseOptions } = require('../common');
 const { getNonceFileData } = require('./sign-utils');
 
 async function processCommand(_, chain, options) {

diff --git a/evm/decode.js b/evm/decode.js
@@ -6,7 +6,8 @@ const {
     utils: { Interface },
 } = ethers;
 const { Command, Option } = require('commander');
-const { printInfo, printError, validateParameters, getContractJSON } = require('./utils');
+const { validateParameters, getContractJSON } = require('./utils');
+const { printInfo, printError } = require('../common');
 
 const decode = (calldata, iface) => {
     try {

diff --git a/evm/deploy-amplifier-gateway.js b/evm/deploy-amplifier-gateway.js
@@ -14,10 +14,7 @@ const {
 const {
     saveConfig,
     getBytecodeHash,
-    printInfo,
-    printError,
     printWalletInfo,
-    printWarn,
     prompt,
     mainProcessor,
     deployContract,
@@ -31,7 +28,7 @@ const {
     getDeployOptions,
 } = require('./utils');
 const { calculateDomainSeparator, isValidCosmosAddress } = require('../cosmwasm/utils');
-const { addExtendedOptions } = require('../common');
+const { addExtendedOptions, printInfo, printError, printWarn } = require('../common');
 const { storeSignedTx, signTransaction, getWallet } = require('./sign-utils.js');
 
 const { WEIGHTED_SIGNERS_TYPE, encodeWeightedSigners } = require('@axelar-network/axelar-gmp-sdk-solidity/scripts/utils');

diff --git a/evm/deploy-contract.js b/evm/deploy-contract.js
@@ -9,9 +9,6 @@ const {
 } = ethers;
 const { Command, Option } = require('commander');
 const {
-    printInfo,
-    printWarn,
-    printError,
     getGasOptions,
     isNonEmptyString,
     isNumber,
@@ -27,7 +24,7 @@ const {
     getContractJSON,
     getDeployOptions,
 } = require('./utils');
-const { addExtendedOptions } = require('../common');
+const { addExtendedOptions, printInfo, printWarn, printError } = require('../common');
 
 async function getConstructorArgs(contractName, config, wallet, options) {
     const args = options.args ? JSON.parse(options.args) : {};

diff --git a/evm/deploy-gateway-v6.2.x.js b/evm/deploy-gateway-v6.2.x.js
@@ -15,21 +15,18 @@ const {
     saveConfig,
     getBytecodeHash,
     verifyContract,
-    printInfo,
     getProxy,
     getEVMAddresses,
     httpGet,
-    printError,
     printWalletInfo,
-    printWarn,
     prompt,
     mainProcessor,
     isContract,
     deployContract,
     getGasOptions,
     getDeployOptions,
 } = require('./utils');
-const { addExtendedOptions } = require('../common');
+const { printInfo, printError, printWarn, addExtendedOptions } = require('../common');
 const { storeSignedTx, signTransaction, getWallet } = require('./sign-utils.js');
 
 const AxelarGatewayProxy = require('@axelar-network/axelar-cgp-solidity/artifacts/contracts/AxelarGatewayProxy.sol/AxelarGatewayProxy.json');

diff --git a/evm/deploy-its.js b/evm/deploy-its.js
@@ -10,9 +10,6 @@ const {
     deployContract,
     printWalletInfo,
     saveConfig,
-    printInfo,
-    printWarn,
-    printError,
     getContractJSON,
     mainProcessor,
     prompt,
@@ -25,7 +22,7 @@ const {
     getDeployedAddress,
     wasEventEmitted,
 } = require('./utils');
-const { addExtendedOptions } = require('../common');
+const { addExtendedOptions, printInfo, printWarn, printError } = require('../common');
 const { Command, Option } = require('commander');
 
 /**

diff --git a/evm/deploy-upgradable.js b/evm/deploy-upgradable.js
@@ -12,17 +12,8 @@ const IUpgradable = require('@axelar-network/axelar-gmp-sdk-solidity/interfaces/
 const { Command, Option } = require('commander');
 
 const { deployUpgradable, deployCreate2Upgradable, deployCreate3Upgradable, upgradeUpgradable } = require('./upgradable');
-const {
-    printInfo,
-    printError,
-    printWalletInfo,
-    getDeployedAddress,
-    prompt,
-    getGasOptions,
-    getDeployOptions,
-    mainProcessor,
-} = require('./utils');
-const { addExtendedOptions } = require('../common');
+const { printWalletInfo, getDeployedAddress, prompt, getGasOptions, getDeployOptions, mainProcessor } = require('./utils');
+const { addExtendedOptions, printInfo, printError } = require('../common');
 
 function getProxy(wallet, proxyAddress) {
     return new Contract(proxyAddress, IUpgradable.abi, wallet);

diff --git a/evm/determine-finality-latency.js b/evm/determine-finality-latency.js
@@ -5,8 +5,8 @@ const {
     providers: { JsonRpcProvider },
 } = ethers;
 const { Command, Option } = require('commander');
-const { printInfo, mainProcessor, sleep } = require('./utils');
-const { addBaseOptions } = require('../common');
+const { mainProcessor, sleep } = require('./utils');
+const { printInfo, addBaseOptions } = require('../common');
 
 function updateFinality(finality, chain, update) {
     if (update) {

diff --git a/evm/execute-contract.js b/evm/execute-contract.js
@@ -10,8 +10,8 @@ const {
 
 const readlineSync = require('readline-sync');
 const { Command, Option } = require('commander');
-const { isNumber, isNonEmptyString, printObj, printLog, printError, getContractJSON } = require('./utils');
-const { loadConfig, saveConfig } = require('../common');
+const { isNumber, isNonEmptyString, printObj, getContractJSON } = require('./utils');
+const { printLog, printError, loadConfig, saveConfig } = require('../common');
 const { addBaseOptions } = require('../common');
 
 async function getCallData(action, targetContract, inputRecipient, inputAmount) {

diff --git a/evm/gas-service.js b/evm/gas-service.js
@@ -8,10 +8,7 @@ const {
 } = ethers;
 const { Command, Option } = require('commander');
 const {
-    printInfo,
     printWalletInfo,
-    printWarn,
-    printError,
     mainProcessor,
     prompt,
     getContractJSON,
@@ -23,7 +20,7 @@ const {
     timeout,
     relayTransaction,
 } = require('./utils');
-const { addBaseOptions } = require('../common');
+const { addBaseOptions, printInfo, printWarn, printError } = require('../common');
 const { getWallet } = require('./sign-utils');
 
 let failedChainUpdates = [];

diff --git a/evm/gateway.js b/evm/gateway.js
@@ -10,21 +10,18 @@ const {
 } = ethers;
 const { Command, Option } = require('commander');
 const {
-    printInfo,
     prompt,
-    printWarn,
     printWalletInfo,
     getEVMBatch,
     getEVMAddresses,
     isValidAddress,
     wasEventEmitted,
     mainProcessor,
-    printError,
     getGasOptions,
     httpGet,
     getContractJSON,
 } = require('./utils');
-const { addBaseOptions } = require('../common');
+const { printInfo, printWarn, printError, addBaseOptions } = require('../common');
 const { getWallet } = require('./sign-utils');
 
 const IGateway = require('@axelar-network/axelar-gmp-sdk-solidity/interfaces/IAxelarGateway.json');

diff --git a/evm/governance.js b/evm/governance.js
@@ -10,15 +10,13 @@ const {
 } = ethers;
 const { Command, Option } = require('commander');
 const {
-    printInfo,
     getGasOptions,
     printWalletInfo,
     isValidTimeFormat,
     dateToEta,
     etaToDate,
     getCurrentTimeInSeconds,
     wasEventEmitted,
-    printWarn,
     getBytecodeHash,
     isValidAddress,
     mainProcessor,
@@ -28,6 +26,7 @@ const {
     writeJSON,
     isKeccak256Hash,
 } = require('./utils.js');
+const { printInfo, printWarn } = require('../common.js');
 const { addBaseOptions } = require('./cli-utils.js');
 const { getWallet } = require('./sign-utils.js');
 const IAxelarServiceGovernance = require('@axelar-network/axelar-gmp-sdk-solidity/interfaces/IAxelarServiceGovernance.json');

diff --git a/evm/interchainTokenFactory.js b/evm/interchainTokenFactory.js
@@ -7,8 +7,8 @@ const {
     constants: { AddressZero },
 } = ethers;
 const { Command, Option } = require('commander');
-const { printInfo, prompt, mainProcessor, validateParameters, getContractJSON, getGasOptions, printWalletInfo } = require('./utils');
-const { addExtendedOptions } = require('../common');
+const { prompt, mainProcessor, validateParameters, getContractJSON, getGasOptions, printWalletInfo } = require('./utils');
+const { addExtendedOptions, printInfo } = require('../common');
 const { getDeploymentSalt, handleTx, isValidDestinationChain } = require('./its');
 const { getWallet } = require('./sign-utils');
 const IInterchainTokenFactory = getContractJSON('IInterchainTokenFactory');

diff --git a/evm/its.js b/evm/its.js
@@ -9,11 +9,9 @@ const {
     Contract,
 } = ethers;
 const { Command, Option } = require('commander');
+const { printInfo, printWarn, printError } = require('../common');
 const {
-    printInfo,
     prompt,
-    printWarn,
-    printError,
     printWalletInfo,
     wasEventEmitted,
     mainProcessor,

diff --git a/evm/min-deposit-proposal.js b/evm/min-deposit-proposal.js
@@ -1,8 +1,8 @@
 'use strict';
 
 const { Command, Option } = require('commander');
-const { addBaseOptions } = require('../');
-const { mainProcessor, printInfo, isValidNumber, isValidAddress } = require('./utils');
+const { addBaseOptions, printInfo } = require('../common');
+const { mainProcessor, isValidNumber, isValidAddress } = require('./utils');
 
 const values = [];
 

diff --git a/evm/multisig.js b/evm/multisig.js
@@ -9,11 +9,9 @@ const {
 } = ethers;
 const { Command, Option } = require('commander');
 const {
-    printInfo,
     printWalletInfo,
     isNumber,
     isValidCalldata,
-    printWarn,
     isNonEmptyStringArray,
     isNumberArray,
     isValidAddress,
@@ -23,7 +21,7 @@ const {
     isBytes32Array,
     getGasOptions,
 } = require('./utils');
-const { addBaseOptions } = require('../common');
+const { addBaseOptions, printInfo, printWarn } = require('../common');
 const IMultisig = require('@axelar-network/axelar-gmp-sdk-solidity/interfaces/IMultisig.json');
 const IGateway = require('@axelar-network/axelar-gmp-sdk-solidity/interfaces/IAxelarGateway.json');
 const IGovernance = require('@axelar-network/axelar-gmp-sdk-solidity/interfaces/IAxelarServiceGovernance.json');