evm-contracts-tools 0.0.62 → 0.0.64

package/evm-contract-call

@@ -2,27 +2,30 @@
 
 // SPDX-License-Identifier: AGPL-3.0-or-later
 
-/**    ----------------------------------------------------------------
- *     evm-contract-call.js
- *     ----------------------------------------------------------------
+/**    ----------------------------------------------------------
+ *     evm-contract-call
+ *     ----------------------------------------------------------
  *     Copyright ©
  *       Pellegrino Prevete
  *         2024, 2025, 2026
  * 
  *     All rights reserved
- *     ----------------------------------------------------------------
+ *     ----------------------------------------------------------
  * 
- *     This program is free software: you can redistribute it and/or
- *     modify it under the terms of the GNU General Public License as
- *     published by the Free Software Foundation, either version 3 of
- *     the License, or (at your option) any later version.
+ *     This program is free software: you can redistribute it
+ *     and/or modify it under the terms of the GNU General
+ *     Public License as published by the Free Software
+ *     Foundation, either version 3 of the License, or
+ *     (at your option) any later version.
  * 
- *     This program is distributed in the hope that it will be useful,
- *     but WITHOUT ANY WARRANTY; without even the implied warranty of
- *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- *     GNU General Public License for more details.
+ *     This program is distributed in the hope that it will
+ *     be useful, but WITHOUT ANY WARRANTY; without even the
+ *     implied warranty of MERCHANTABILITY or FITNESS FOR A
+ *     PARTICULAR PURPOSE.
+ *     See the GNU General Public License for more details.
  * 
- *     You should have received a copy of the GNU General Public License
+ *     You should have received a copy of the
+ *     GNU General Public License
  *     along with this program.
  *     If not, see <https://www.gnu.org/licenses/>.
  */
@@ -191,6 +194,31 @@ const
 const
   _cache_dir_auto_detect =
     _libevm_contract_call_module._cache_dir_auto_detect;
+/* global
+     _call_auth_auto_detect */
+const
+  _call_auth_auto_detect =
+    _libevm_contract_call_module._call_auth_auto_detect;
+/* global
+     _contract_abi_auto_detect */
+const
+  _contract_abi_auto_detect =
+    _libevm_contract_call_module._contract_abi_auto_detect;
+/* global
+     _contract_address_auto_detect */
+const
+  _contract_address_auto_detect =
+    _libevm_contract_call_module._contract_address_auto_detect;
+/* global
+     _contract_bytecode_auto_detect */
+const
+  _contract_bytecode_auto_detect =
+    _libevm_contract_call_module._contract_bytecode_auto_detect;
+/* global
+     _contract_compiler_output_auto_detect */
+const
+  _contract_compiler_output_auto_detect =
+    _libevm_contract_call_module._contract_compiler_output_auto_detect;
 /* global
      _data_dir_auto_detect */
 const
@@ -202,30 +230,25 @@ const
   _default_artifact_path_get =
     _libevm_contract_call_module._default_artifact_path_get;
 /* global
-     _contract_abi_auto_detect */
+     _deployments_dir_auto_detect */
 const
-  _contract_abi_auto_detect =
-    _libevm_contract_call_module._contract_abi_auto_detect;
+  _deployments_dir_auto_detect =
+    _libevm_contract_call_module._deployments_dir_auto_detect;
 /* global
      _evm_contract_call */
 const
   _evm_contract_call =
     _libevm_contract_call_module._evm_contract_call;
 /* global
-     _call_auth_auto_detect */
+     _help_display_check */
 const
-  _call_auth_auto_detect =
-    _libevm_contract_call_module._call_auth_auto_detect;
+  _help_display_check =
+    _libevm_contract_call_module._help_display_check;
 /* global
      _target_app_auto_detect */
 const
   _target_app_auto_detect =
     _libevm_contract_call_module._target_app_auto_detect;
-/* global
-     _contract_address_auto_detect */
-const
-  _contract_address_auto_detect =
-    _libevm_contract_call_module._contract_address_auto_detect;
 /* global
      _target_contract_auto_detect */
 const
@@ -304,6 +327,13 @@ function
     "call",
     "type",
     "");
+  /* global
+       output_file:
+         writable */
+  _set(
+    "output",
+    "file",
+    "");
   /* global
        index_retrieve:
          writable */
@@ -395,14 +425,282 @@ function
     "";
 }
 
+async function
+  _artifacts_auto_detect() {
+  let
+    _contract_abi,
+    _contract_bytecode,
+    _msg;
+  const
+    _global =
+      _global_get();
+  const
+    _quiet =
+      _global[
+        "quiet"];
+  _contract_abi =
+    _get(
+      "contract",
+      "abi");
+  _contract_bytecode =
+    _get(
+      "contract",
+      "bytecode");
+  const
+    _contract_compiler_output =
+      _get(
+        "contract",
+        "compiler_output");
+  const
+    _contract_address =
+      _get(
+        "contract",
+        "address");
+  const
+    _target_contract =
+      _get(
+        "target",
+        "contract");
+  const
+    _contract_address_type =
+      typeof(
+        _contract_address);
+  const
+    _contract_abi_type =
+      typeof(
+        _contract_abi);
+  const
+    _contract_bytecode_type =
+      typeof(
+        _contract_bytecode);
+  const
+    _contract_compiler_output_type =
+      typeof(
+        _contract_compiler_output);
+  if ( _contract_address_type !== "undefined" &&
+       _contract_address_type === "string" ) {
+    if ( 0 < _contract_address.length ) {
+      if ( _contract_abi_type === "array" ) {
+        _msg =
+          "Contract ABI with type " +
+          "array not implemented.";
+        _msg_error(
+          _msg,
+          0);
+        throw _msg;
+      }
+      else if ( _contract_abi_type === "string" ) {
+        if ( 0 < _contract_abi.length ) {
+          _msg =
+            "Selecting contract ABI:";
+          _msg_info(
+            _msg);
+          if ( _quiet == "n" ) {
+            _echo(
+              _contract_abi);
+          }
+        }
+        else {
+          _msg =
+            "Specified no contract ABI " +
+            `for contract '${_target_contract}' ` +
+            `and address '${_contract_address}', ` +
+            "auto-detecting.";
+          _msg_info(
+            _msg);
+          try {
+            await _contract_abi_auto_detect();
+          }
+          catch(
+            _error) {
+            _msg =
+              "Error auto-detecting contract ABI.";
+            _msg_error(
+              _msg,
+              0);
+            throw _error;
+          }
+        }
+      }
+      else {
+        _msg =
+          `Unknown type '${_contract_abi_type}' ` +
+          `for contract ABI (must be string).`;
+        _msg_error(
+          _msg,
+          0);
+        throw _msg;
+      }
+      _contract_abi =
+        _get(
+          "contract",
+          "abi");
+      if ( _contract_bytecode_type === "array" ) {
+        _msg =
+          "Contract bytecode with type " +
+          "array not implemented.";
+        _msg_error(
+          _msg,
+          0);
+        throw _msg;
+      }
+      else if ( _contract_bytecode_type === "string" ) {
+        if ( 0 < _contract_bytecode.length ) {
+          _msg =
+            "Selecting contract Bytecode:";
+          _msg_info(
+            _msg);
+          if ( _quiet == "n" ) {
+            _echo(
+              _contract_bytecode);
+          }
+        }
+        else {
+          _msg =
+            "Specified no contract bytecode " +
+            `for contract '${_target_contract}' ` +
+            `and address '${_contract_address}', ` +
+            "auto-detecting.";
+          _msg_info(
+            _msg);
+          try {
+            await _contract_bytecode_auto_detect();
+          }
+          catch(
+            _error) {
+            _msg =
+              "Error running " +
+              "'_contract_bytecode_auto_detect'.";
+            _msg_error(
+              _msg,
+              0);
+            throw _error;
+          }
+        }
+      }
+      else {
+        _msg =
+          `Unknown type '${_contract_bytecode_type}' ` +
+          `for contract bytecode (must be string).`;
+        _msg_error(
+          _msg,
+          0);
+        throw _msg;
+      }
+      _contract_bytecode =
+        _get(
+          "contract",
+          "bytecode");
+      if ( _contract_compiler_output_type === "array" ) {
+        _msg =
+          "Contract compiler output with type " +
+          "array not implemented.";
+        _msg_error(
+          _msg,
+          0);
+        throw _msg;
+      }
+      else if ( _contract_compiler_output_type === "string" ) {
+        if ( 0 < _contract_compiler_output.length ) {
+          _msg =
+            "Selecting contract compiler output:";
+          _msg_info(
+            _msg);
+          if ( _quiet == "n" ) {
+            _echo(
+              _contract_compiler_output);
+          }
+        }
+        else {
+          _msg =
+            "Specified no contract compiler output " +
+            `for contract '${_target_contract}' ` +
+            `and address '${_contract_address}', ` +
+            "auto-detecting.";
+          _msg_info(
+            _msg);
+          try {
+            await _contract_compiler_output_auto_detect();
+          }
+          catch(
+            _error) {
+            let
+              _error_info;
+            _error_info =
+              false;
+            _msg =
+              "Error auto-detecting contract compiler output.";
+            if ( _contract_abi !== "" &&
+                 _contract_bytecode !== "" ) {
+              _error_info =
+                true;
+	    }
+            if ( _error_info ) {
+              _msg_info(
+                _msg);
+              _msg =
+                "Performing call using ABI and " +
+                "and bytecode.";
+              _msg_info(
+                _msg);
+            }
+            else {
+              _msg_error(
+                _msg,
+                0);
+              _msg =
+                "Either one between the contract abi " +
+                "plus the bytecode or the contract " +
+                "compiler output must be available " +
+                "to perform a call.";
+              _msg_error(
+                _msg,
+                0);
+              throw _error;
+            }
+          }
+        }
+      }
+      else {
+        _msg =
+          `Unknown type '${_contract_compiler_output_type}' ` +
+          `for contract compiler output (must be string).`;
+        _msg_error(
+          _msg,
+          0);
+        throw _msg;
+      }
+    }
+    else {
+      _msg =
+        "No address in input, artifacts detection " +
+        "skipped.";
+      _msg_info(
+        _msg);
+    }
+  }
+  else {
+    _msg =
+      `Uknown type for contract address (type ` +
+      `'${_contract_address_type}'):`;
+    _msg_error(
+      _msg,
+      0);
+    _echo2(
+      _contract_address);
+  }
+}
+
 async function 
   _overrides_set(
     _help_display) {
   let
     _address_valid,
-    _contract_abi,
     _contract_address,
     _msg;
+  _help_display =
+    _help_display_check(
+      _help_display);
   const
     _global =
       _global_get();
@@ -431,6 +729,10 @@ async function
     "call",
     "date",
     _get_date_human());
+  _override_set(
+    "output",
+    "file",
+    "");
   _override_set(
     "wallet",
     "name",
@@ -460,37 +762,81 @@ async function
     "msg",
     "value",
     "0");
-  await _wallet_overrides_set(
-    "evm-wallet",
-    wallet_name,
-    call_auth,
-    "n",                // qr support
-    _target_networks);
-  await _target_app_auto_detect();
-  await _target_contract_auto_detect();
-  // await _target_networks_auto_detect();
+  const
+    _wallet_overrides_set_args = [
+      "evm-wallet",
+      wallet_name,
+      call_auth,
+      "n",                // qr support
+      _target_networks
+    ];
   try {
-    await _contract_address_auto_detect();
+    await _wallet_overrides_set.apply(
+      null,
+      _wallet_overrides_set_args);
   }
   catch(
     _error) {
     _msg =
-      "Error auto-detecting address.";
+      "Error running '_wallet_overrides_set' " +
+      "with arguments:";
     _msg_error(
       _msg,
       0);
     _echo2(
-      _msg);
-    throw _error; 
+      _error);
+    throw _error;
   }
-  const
-    _help_display_type =
-      typeof(
-        _help_display);
-  if ( ( _help_display_type !== "undefined" &&
-         _help_display !== "" ) &&
-       ( _help_display_type !== "boolean" &&
-         _help_display !== true ) ) {
+  if ( ! _help_display ) {
+    try {
+      await _target_app_auto_detect();
+    }
+    catch(
+      _error) {
+      _msg =
+        "Error auto-detecting target application.";
+      _msg_error(
+        _msg,
+        0);
+      throw _error;
+    }
+    try {
+      await _deployments_dir_auto_detect();
+    }
+    catch(
+      _error) {
+      _msg =
+        "Error auto-detecting deployments directory.";
+      _msg_error(
+        _msg,
+        0);
+      throw _error;
+    }
+    try {
+      await _target_contract_auto_detect();
+    }
+    catch(
+      _error) {
+      _msg =
+        "Error auto-detecting target contract.";
+      _msg_error(
+        _msg,
+        0);
+      throw _error;
+    }
+    try {
+      await _contract_address_auto_detect();
+    }
+    catch(
+      _error) {
+      _msg =
+        "Error auto-detecting contract address.";
+      _msg_error(
+        _msg,
+        0);
+      throw _error;
+    }
+    // await _target_networks_auto_detect();
     try {
       _contract_address =
         _get(
@@ -522,96 +868,26 @@ async function
         0);
       throw _msg;
     }
-  }
-  _override_set(
-    "index",
-    "retrieve",
-    "n");
-  // _api_key_auto_detect();
-  _contract_abi =
-    _get(
-      "contract",
-      "abi");
-  _contract_address =
-    _get(
-      "contract",
-      "address");
-  const
-    _target_contract =
-      _get(
-        "target",
-        "contract");
-  const
-    _contract_address_type =
-      typeof(
-        _contract_address);
-  const
-    _contract_abi_type =
-      typeof(
-        _contract_abi);
-  if ( _contract_address_type !== "undefined" &&
-       _contract_address != "" ) {
-    if ( _contract_abi_type === "array" ) {
+    _override_set(
+      "index",
+      "retrieve",
+      "n");
+    // _api_key_auto_detect();
+    try {
+      await _artifacts_auto_detect();
+    }
+    catch(
+      _error) {
       _msg =
-        "Not implemented.";
+        "Error running '_artifacts_auto_detect'.";
       _msg_error(
         _msg,
-        1);
-    }
-    else if ( _contract_abi_type === "string" ) {
-      if ( 0 < _contract_abi.length ) {
-        _msg =
-          "Contract ABI:";
-        _msg_error(
-          _msg,
-          0);
-        _echo2(
-          _contract_abi);
-      }
-      else {
-        _msg =
-          "Specified no contract ABI " +
-          `for contract '${_target_contract}' ` +
-          `and address'${_contract_address}',` +
-          "auto-detecting.";
-        _msg_info(
-          _msg);
-        try {
-          _contract_abi =
-            await _default_artifact_path_get(
-              "abi");
-          await _artifact_local_auto_detect(
-            "bytecode");
-          await _artifact_local_auto_detect(
-            "compiler_output");
-          if ( _contract_abi == "" ||
-               _default_artifact_path_get(
-                 "abi") == _contract_abi ) {
-            await _contract_abi_auto_detect();
-          }
-        }
-        catch(
-          _error) {
-          _msg =
-            "Sigh.";
-          _msg_error(
-            _msg,
-            0);
-          throw _error;
-        }
-      }
+        0);
+      _echo2(
+        _error);
+      throw _error;
     }
   }
-  else {
-    _msg =
-      `Contract address (type ` +
-      `'${_contract_address_type}'):`;
-    _msg_error(
-      _msg,
-      0);
-    _echo2(
-      _contract_address);
-  }
 }
 
 function
@@ -699,6 +975,12 @@ function
       "     -t --call-type                  It can be 'static' or 'dynamic'.",
       `       <call-type>                   Default: '${call_type}`,
       "",
+      "     -o --output-file                If specified saves the call output",
+      "       <file-path>                   at the specified location, otherwise it",
+      "                                     will print it on stdout.",
+      `                                     Default: '${output_file}`,
+      "",
+      "     -t --call-type                  It can be 'static' or 'dynamic'.",
       "  call options:",
       `     -V --msg-value                  How much '${measure_unit} to attach to the`,
       `       <msg-value>                   transaction.`,
@@ -794,6 +1076,7 @@ async function
   _cmdline_parse() {
   let
     _help_display,
+    _method_args,
     _msg,
     _network,
     _target_networks_set;
@@ -889,15 +1172,31 @@ async function
     "method",
     _argv[
       "_"][
-        0]);
+        1]);
+  try {
+    const
+      _args_length =
+        _argv[
+          "_"].length;
+    _method_args =
+      await _argv[
+        "_"].slice(
+        2,
+        _args_length);
+  }
+  catch(
+    _error) {
+    _msg =
+      "Error slicing '_argv'.";
+    _msg_error(
+      _msg,
+      0);
+    throw _error;
+  }
   _set(
     "method",
     "args",
-    _argv[
-      "_"].slice(
-      2,
-      _argv[
-        "_"].length - 2));
+    _method_args);
   if ( "t" in _argv ) {
     _set(
       "call",
@@ -912,6 +1211,20 @@ async function
       _argv[
         "call-type"]);
   }
+  if ( "o" in _argv ) {
+    _set(
+      "output",
+      "file",
+      _argv[
+        "o"]);
+  }
+  if ( "output-file" in _argv ) {
+    _set(
+      "output",
+      "file",
+      _argv[
+        "output-file"]);
+  }
   if ( "T" in _argv ) {
     _set(
       "call",
@@ -1265,12 +1578,23 @@ async function
     _app_opts) {
   let
     _msg,
-    _results;
+    _result,
+    _results,
+    _results_list,
+    _results_type;
   try {
     _results =
       await _evm_contract_call.apply(
         null,
         _app_opts);
+    _results_type =
+      typeof(
+        _results);
+    _msg =
+      `Got results '${_results}' ` +
+      `(type '${_results_type}').`;
+    _msg_info(
+      _msg);
   }
   catch(
     _error) {
@@ -1280,41 +1604,47 @@ async function
     _msg_error(
       _msg,
       0);
-    _echo(
-      _msg);
     _echo2(
       _error);
     throw _error;
   }
-  // const
-  //   _results_type =
-  //     typeof(
-  //       _results);
-  // if ( _results_type == "array" ) {
-  //   for ( _result of _results ) {
-  //     _echo(
-  //       _result);
-  //   }
-  // }
-  // else if ( _results_type == "object" ) {
-  //   for ( _result in _results ) {
-  //     _echo(
-  //       _results[
-  //         _result]);
-  //   }
-  // }
-  // else if ( _results_type == "string" ) {
-  //   _printf(
-  //     _results);
-  // }
-  // else if ( _results_type == "undefined" ) {
-  //   _msg =
-  //     "No results";
-  //   _msg_error(
-  //     _msg,
-  //     0);
-  //   throw _msg;
-  // }
+  if ( _results_type == "array" ) {
+    for ( _result of _results ) {
+      await _printf(
+        _result);
+    }
+  }
+  else if ( _results_type == "object" ) {
+    for ( _result in _results ) {
+      _msg =
+        `Got result '${_result}':`;
+      _msg_info(
+        _msg);
+      await _printf(
+        _results[
+          _result]);
+    }
+  }
+  else if ( _results_type == "string" ) {
+    _printf(
+      _results);
+  }
+  else if ( _results_type == "undefined" ) {
+    _msg =
+      "No results";
+    _msg_error(
+      _msg,
+      0);
+    throw _msg;
+  }
+  else {
+    _msg =
+      `Result type '${_results_type}'.`;
+    _msg_error(
+      _msg,
+      0);
+    throw _msg;
+  }
   return _results;
 }
 
@@ -1388,6 +1718,15 @@ async function
     _cmdline_out =
       await _evm_contract_call_cmdline(
         _app_opts);
+    _msg =
+      "Done running '_evm_contract_call_cmdline' " +
+      `with parameters:`;
+    _msg_info(
+      _msg);
+    if ( _quiet == "n" ) {
+      _echo(
+        _app_opts);
+    }
   }
   catch(
     _error) {
@@ -1401,23 +1740,26 @@ async function
       _error);
     throw _error;
   }
+  _exit(
+    0);
   return _cmdline_out;
 }
 
-_global_variables();
-_libevm_global_variables();
 if ( await _cmdline_check(
        "evm-contract-call.js") ||
      await _cmdline_check(
        "evm-contract-call") ||
      await _cmdline_check(
        "./evm-contract-call") ) {
+  _global_variables();
+  _libevm_global_variables();
   await _cmdline_parse();
 }
-else{
+else {
   _url_parse();
   _libevm_url_parse();
 }
+
 try {
   await _main();
 }