Add watchGas CLI command

packages/near-sdk-js/package.json

@@ -76,6 +76,7 @@
     "eslint": "8.54.0",
     "eslint-config-prettier": "8.10.0",
     "json5": "2.2.3",
+    "near-workspaces": "4.0.0",
     "npm-run-all": "4.1.5",
     "prettier": "2.8.8",
     "typescript": "4.7.4"

packages/near-sdk-js/src/cli/cli.ts

@@ -10,8 +10,9 @@ import { rollup } from "rollup";
 import { Command } from "commander";
 import signal from "signale";
 
-import { executeCommand, validateContract } from "./utils.js";
+import { executeCommand, formatGas, parseNamedArgs, validateContract } from "./utils.js";
 import { runAbiCompilerPlugin } from "./abi.js";
+import { Worker } from "near-workspaces";
 
 const { Signale } = signal;
 const PROJECT_DIR = process.cwd();
@@ -85,6 +86,21 @@ program
       .option("--verbose", "Whether to print more verbose output.", false)
       .action(transpileJsAndBuildWasmCom)
   )
+  .addCommand(
+    new Command("watchGas")
+      .usage("[target] [methodName params...] [methodName params...]")
+      .description(
+        "Measure gas used for a contract method. Run this command after deploying the contract."
+      )
+      .argument(
+        "[target]",
+        "Target file path and name. (e.g., ./build/counter.wasm)"
+      )
+      .argument(
+        "[...methodCalls]", "Method calls with their parameters (e.g., increase n=5 decrease n=2)"
+      )
+      .action(measureGas)
+  )
   .parse();
 
 function getTargetDir(target: string): string {
@@ -389,3 +405,70 @@ async function wasiStubContract(contractTarget: string, verbose = false) {
   const WASI_STUB = `${NEAR_SDK_JS}/lib/cli/deps/binaryen/wasi-stub/run.sh`;
   await executeCommand(`${WASI_STUB} ${contractTarget}`, verbose);
 }
+
+async function measureGas(target: string, ...methodCalls) {
+  let worker;
+  try {
+    worker = await Worker.init();
+    const root = worker.rootAccount;
+    const contract = await root.devDeploy(target);
+    const account = await root.createSubAccount("ali");
+
+    let currentMethod = null;
+    let methodParams = [];
+    const methodCallsArr = methodCalls.pop().args.slice(1);
+
+    const output = [];
+
+    for (let i = 0; i < methodCallsArr.length; i++) {
+      if (methodCallsArr[i].includes("=")) {
+        methodParams.push(methodCallsArr[i]);
+        continue;
+      }
+
+      if (currentMethod) {
+        const res = await processMethod(account, contract, currentMethod, methodParams);
+        output.push(res);
+      }
+
+      currentMethod = methodCallsArr[i];
+      methodParams = [];
+    }
+
+    if (currentMethod) {
+      const res = await processMethod(account, contract, currentMethod, methodParams);
+      output.push(res);
+    }
+
+    console.table(output.map(({Method, Params, TotalGas}) => ({       
+      Method,
+      Params: JSON.stringify(Params), 
+      TotalGas 
+    })));
+  } catch (error) {
+    console.error(error);
+  } finally {
+    await worker?.tearDown();
+  }
+}
+
+async function processMethod(account, contract, method, params) {
+  const parsedParams = parseNamedArgs(params);
+  const tx = await account.callRaw(contract, method, parsedParams);
+
+  if (!tx.result.status.SuccessValue && tx.result.status.Failure) {
+    console.error(JSON.stringify(tx.result.status));
+    return {};
+  }
+
+  return {
+    Method: method,
+    Params: parsedParams,
+    TotalGas: formatGas(
+      tx.result.transaction_outcome.outcome.gas_burnt +
+      tx.result.receipts_outcome[0].outcome.gas_burnt +
+      // TODO: remove after near-workspaces is updated
+      (tx.result.receipts_outcome[1].outcome.gas_burnt || 0)
+    )
+  }
+}

packages/near-sdk-js/src/cli/utils.ts

@@ -137,3 +137,35 @@ export async function validateContract(
 
   return true;
 }
+
+export function parseNamedArgs(args) {
+  return args.reduce((acc, arg) => {
+    const [key, value] = arg.split('=');
+    acc[key] = value;
+    return acc;
+  }, {});
+}
+
+export function logTotalGas(r) {
+  console.log(
+    'Total gas used: ',
+    formatGas(
+      r.result.transaction_outcome.outcome.gas_burnt +
+      r.result.receipts_outcome[0].outcome.gas_burnt +
+      // TODO: remove after near-workspaces is updated
+      (r.result.receipts_outcome[1].outcome.gas_burnt || 0)
+    ),
+    '\n'
+  );
+}
+
+export function formatGas(gas) {
+  if (gas < 10 ** 12) {
+    const tGas = gas / 10 ** 12;
+    const roundTGas = Math.round(tGas * 100000) / 100000;
+    return roundTGas + "T";
+  }
+  const tGas = gas / 10 ** 12;
+  const roundTGas = Math.round(tGas * 100) / 100;
+  return roundTGas + "T";
+}