evm-contracts-tools 0.0.11 → 0.0.14

package/evm-contract-call

@@ -3,7 +3,7 @@
 // SPDX-License-Identifier: AGPL-3.0-or-later
 
 /**    ----------------------------------------------------------------
- *     evm-chains-info.js
+ *     evm-contract-call.js
  *     ----------------------------------------------------------------
  *     Copyright ©
  *       Pellegrino Prevete
@@ -30,6 +30,34 @@
 /* eslint-disable
      no-unused-vars */
 
+/* global
+     call_auth:
+       writable */
+/* global
+     call_timeout:
+       writable */
+/* global
+     msg_value:
+       writable */
+/* global
+     target_network:
+       writable */
+/* global
+     target_networks:
+       writable */
+/* global
+     api_key:
+       writable */
+/* global
+     wallet_path:
+       writable */
+/* global
+     wallet_password:
+       writable */
+/* global
+     wallet_seed:
+       writable */
+
 const
   _libcrash =
   require(
@@ -69,56 +97,59 @@ const
 const
 _process_exit =
   _libcrash._process_exit;
-
-
 const
   _libevm_module =
     require(
       "libevm");
+/* global
+     _libevm_cmdline_parse */
+const
+  _libevm_cmdline_parse =
+    _libevm_module._libevm_cmdline_parse;
 /* global
      _libevm_global_variables */
 const
   _libevm_global_variables =
     _libevm_module._libevm_global_variables;
+/* global
+     _libevm_url_parse */
+const
+  _libevm_url_parse =
+    _libevm_module._libevm_url_parse;
 /* global
      _wallet_overrides_set */
 const
   _wallet_overrides_set =
     _libevm_module._wallet_overrides_set;
 const
-  _libevm_chains_info_module =
+  _libevm_contract_call_module =
     require(
-      "libevm-chains-info");
-/* global
-     _evm_chains_db_path_get */
-const
-  _evm_chains_db_path_get =
-    _libevm_chains_info_module._evm_chains_db_path_get;
+      "./libevm-contract-call");
 /* global
-     _evm_chains_info_get */
+     _artifact_local_auto_detect */
 const
-  _evm_chain_info_get =
-    _libevm_chains_info_module._evm_chain_info_get;
+  _artifact_local_auto_detect =
+    _libevm_contract_call_module._artifact_local_auto_detect;
 /* global
-     _rpc_backends_get */
+     _default_artifact_path_get */
 const
-  _rpc_backend_get =
-    _libevm_chains_info_module._rpc_backend_get;
+  _default_artifact_path_get =
+    _libevm_contract_call_module._default_artifact_path_get;
 /* global
-     _evm_chains_info */
+     _contract_abi_auto_detect */
 const
-  _evm_chains_info =
-    _libevm_chains_info_module._evm_chains_info;
+  _contract_abi_auto_detect =
+    _libevm_contract_call_module._contract_abi_auto_detect;
 /* global
-     _db_paths_auto_detect */
+     _evm_contract_call */
 const
-  _db_paths_auto_detect =
-    _libevm_chains_info_module._db_paths_auto_detect;
+  _evm_contract_call =
+    _libevm_contract_call_module._evm_contract_call;
 /* global
-     _input_type_auto_detect */
+     _call_auth_auto_detect */
 const
-  _input_type_auto_detect =
-    _libevm_chains_info_module._input_type_auto_detect;
+  _call_auth_auto_detect =
+    _libevm_contract_call_module._db_paths_auto_detect;
 
 function
   _global_variables() {
@@ -142,6 +173,21 @@ function
          writable */
   call_date =
     "";
+  /* global
+       wallet_name:
+         writable */
+  wallet_name =
+    "";
+  /* global
+       retries_max:
+         writable */
+  retries_max =
+    "";
+  /* global
+       rpc_selection:
+         writable */
+  rpc_selection =
+    "";
   /* global
        call_type:
          writable */
@@ -210,41 +256,59 @@ function
     call_date =
       _get_date_human();
   }
-  _wallet_overrides_set();
-  if ( target_command == "" ) {
-    target_command =
-      "get";
-  }
-  _input_type_auto_detect();
-  if ( output_type == "" ) {
-    output_type =
-      "name";
-  }
-  if ( retrieval_mode == "" ) {
-    retrieval_mode =
-      "offline";
-  }
-  if ( selection_method == "" ) {
-    // TODO:
-    //   remove all references
-    //   to that monster
-    selection_method =
-      "kirsh";
+  if ( wallet_name == "" ) {
+    wallet_name =
+      "default";
   }
-  if ( api_key == "" ) {
-    api_key =
+  if ( index_retrieve == "" ) {
+    index_retrieve =
       "n";
   }
-  if ( user_level == "" ) {
-    user_level =
-      "y";
+  if ( retries_max == "" ) {
+    retries_max =
+      "300";
   }
-  if ( networks_all == "" ) {
-    networks_all =
-      "n";
+  if ( rpc_selection == "" ) {
+    rpc_selection =
+      "kirsh";
+  }
+  if ( call_type == "" ) {
+    call_type =
+      "static";
+  }
+  _call_auth_auto_detect();
+  if ( call_timeout == "" ) {
+    call_timeout =
+      "300000";
+  }
+  if ( measure_unit == "" ) {
+    measure_unit =
+      "ether";
   }
-  _db_paths_auto_detect(
-    target_chain);
+  if ( msg_value == "" ) {
+    msg_value =
+      "0";
+  }
+  // _api_key_auto_detect();
+  if ( contract_address != "" ) {
+    if ( contract_abi == "" ) {
+      contract_abi =
+        _default_artifact_path_get();
+      _artifact_local_auto_detect(
+        "bytecode");
+      _artifact_local_auto_detect(
+        "compiler_output");
+      if ( contract_abi == "" ||
+           _default_artifact_path_get(
+	     "abi") == contract_abi ) {
+        _contract_abi_auto_detect();
+      }
+    }
+  }
+  _wallet_overrides_set(
+    "evm-wallet",
+    wallet_name,
+    call_auth);
 }
 
 function
@@ -256,16 +320,31 @@ function
       `${app_name} configuration:`,
       `                Call date:   ${call_date}`,
       `      Runtime environment:   ${runtime_environment}`,
-      `           Target command:   ${target_command}`,
-      `               Input type:   ${input_type}`,
-      `              Output type:   ${output_type}`,
-      `           Retrieval mode:   ${retrieval_mode}`,
-      `      User-level database:   ${user_level}`,
+      `                Call type:   ${call_type}`,
+      `      Call authentication:   ${call_auth}`,
+      `    Credentials options:`,
+      `              Wallet name:   ${wallet_name}`,
+      `           Wallet address:   ${api_key}`,
+      `              Wallet path:   ${wallet_path}`,
+      `          Wallet password:   ${wallet_password}`,
+      `              Wallet seed:   ${wallet_seed}`,
+      `        Network options:`,
+      `           Target network:   ${target_network}`,
+      `              Max retries:   ${retries_max}`,
+      `             Call timeout:   ${call_timeout}`,
       `                  API key:   ${api_key}`,
-      `     RPC selection method:   ${selection_method}`,
-      `             All networks:   ${networks_all}`,
-      `             Target chain:   ${target_chain}`,
-      `           Database paths:   ${db_paths}`,
+      `     RPC selection method:   ${rpc_selection}`,
+      `                Gas price:   ${price_gas}`,
+      `       Contract options:`,
+      `         Contract address:   ${contract_address}`,
+      `             Contract ABI:   ${contract_abi}`,
+      `        Contract bytecode:   ${contract_bytecode}`,
+      ` Contract compiler output:   ${contract_compiler_output}`,
+      `           Call options:`,
+      `            Message value:   ${msg_value}`,
+      `             Measure unit:   ${measure_unit}`,
+      `          Contract method:   ${contract_method}`,
+      `         Method arguments:   ${method_args}`,
     ];
   for ( _line of _text ) {
     _msg_info(
@@ -280,47 +359,93 @@ function
     _line;
   const
     _text = [
-      "Returns info about EVM blockchains.",
+      "Runs a smart contract function.",
       "",
       "Usage:",
       "",
-      "  evm-chains-info.js",
+      "  evm-contract-call.js",
       "    [options]",
-      "    <target-chain>",
+      "    <contract-address>",
+      "    <contract-method>",
+      "    ([method-args])",
+      "",
+      "  networks:",
+      "    all those supported by",
+      "    'evm-chains-info' as well",
+      "    as directly RPC addresses",
       "",
       "  options:",
       "",
-      "     -C --command                    Target command. Can be 'get' or 'set'.",
-      `       <target-command>              Default: '${target_command}`,
+      "     -t --call-type                  It can be 'static' or 'dynamic'.",
+      `       <call-type>                   Default: '${call_type}`,
+      "",
+      "  call options:",
+      `     -V --msg-value                  How much '${measure_unit} to attach to the`,
+      `       <msg-value>                   transaction.`,
+      `                                     Default: '${msg_value}'`,
+      "",
+      "     -u --measure-unit               Measure unit for the transacion.",
+      `       <measure-unit>                It can be 'ether' or 'wei'.`,
+      `                                     Default: '${measure_unit}'`,
+      "",
+      "     -P --price-gas                  I dont remember. It can be 'idontknow'.",
+      "       <price-gas>",
+      `                                     Default: '${price_gas}'`,
+      "",
+      "     -r --retries-max                Maximum number of retries before",
+      `       <retries-max>                 Declaring the call failed.`,
+      `                                     Default: '${retries_max}'`,
+      "",
+      "     -T --call-timeout               Maximum number of milliseconds before",
+      "       <call-timeout>                declaring the call failed.",
+      `                                     Default: '${call_timeout}'`,
       "",
-      "     -i --input-type                 Input type. It can be 'id' or 'name'.",
-      `       <input-type>                  Default: '${input_type}'`,
+      "  contract options:",
       "",
-      "     -o --output-type                Output type. It can be 'id', 'name',",
-      "       <output-type>                 'rpc', 'explorers'.",
-      `                                     Default: '${output_type}'`,
+      "     -A --abi                        Contract ABI path.",
+      `       <contract-abi>                Default: '${contract_abi}'.`,
       "",
-      "     -m --retrieval-mode             It can be 'offline'.",
-      `       <retrieval-mode>              Default: '${retrieval_mode}'`,
+      "     -B --bytecode                   Contract bytecode path.",
+      `       <contract-bytecode>           Default: '${contract_bytecode}'.`,
       "",
-      "     -u --user-level                 It can be 'y' or 'n'.",
-      `       <user-level>                  Default: '${user_level}'`,
+      "     -C --compiler-output            Contract compiler output path",
+      `       <contract-bytecode>           (the hardhat artifact.`,
+      `                                     Default: '${contract_compiler_output}'.`,
       "",
-      "     -d --db-path                    Path of the chains' info json file",
-      "       <db-path>                     to be used for 'offline' retrieval.",
-      `                                     Default: '${db_paths}'`,
+      "     -I --index-retrieve             Enables retrieving contract's artifacts",
+      `                                     from the EVM Contracts Source Index.`,
+      `                                     Default: '${contract_compiler_output}'.`,
       "",
-      "     -s --selection-method           When output type is 'rpc',",
-      "       <selection-method>            selection criterion to use when",
-      "                                     more than one is available.",
-      "                                     It can be 'kirsh', 'random' or 'all'.",
-      `                                     Default: '${selection_method}'`,
+      "  credentials options:",
       "",
-      "     -k                              If selected, when output type is 'rpc',",
-      "                                     includes the ones requiring an API key.",
-      `                                     Default: '${api_key}'`,
-      "     -a --all                        Whether to show results for all networks.",
-      `                                     Default: '${networks_all}'`,
+      "     -N --wallet-name                EVM Wallet name.",
+      `       <wallet-name>                 Default: '${wallet_name}'.`,
+      "",
+      "     -w --wallet-path                EVM Wallet path.",
+      `       <wallet-path>                 Default: '${wallet_path}'.`,
+      "",
+      "     -p --wallet-password            EVM Wallet password file.",
+      `       <wallet-password>             Default: '${wallet_password}'.`,
+      "",
+      "     -s --wallet-seed                EVM Wallet seed file.",
+      `       <wallet-seed>                 Default: '${wallet_seed}'.`,
+      "",
+      "     -k --api-key                    Etherscan-like service key file.",
+      `       <api-key>                     Default: '${api_key}'.`,
+      "",
+      "  libEVM options:",
+      "",
+      "     -a --auth                       Call authentication.",
+      `                                     Default: '${call_auth}'`,
+      "",
+      "     -n --network                    EVM network name. Accepted",
+      "       <network>                     values are all those supported by",
+      `                                     'evm-chains-info' and RPC addresses.`,
+      `                                     Default: '${target_network}'.`,
+      "",
+      "     -S --rpc-selection              RPC selection method. It can be",
+      "       <rpc-selection>               'kirsh', 'random' or 'all'.",
+      `                                     Default: '${rpc_selection}'.`,
       "",
       "     -h --help                       This message.",
       "     -v --verbose                    Enable verbose output."
@@ -341,8 +466,12 @@ function
   const
     _argv_args = {
       "booleans": [
+        "a",
+        "auth",
         "h",
         "help",
+        "I",
+        "index-retrieve",
         "v",
         "verbose"
       ]
@@ -415,7 +544,8 @@ function
         0];
   const
     method_args =
-      _out.slice(
+      _argv[
+        "_"].slice(
         2,
         _argv[
           "_"].length - 2);
@@ -504,26 +634,36 @@ function
       _argv[
         "A"];
   }
-  if ( "contract-abi" in _argv ) {
+  if ( "abi" in _argv ) {
     contract_abi =
       _argv[
-        "contract-abi"];
+        "abi"];
+  }
+  if ( "B" in _argv ) {
+    contract_bytecode =
+      _argv[
+        "B"];
+  }
+  if ( "bytecode" in _argv ) {
+    contract_bytecode =
+      _argv[
+        "bytecode"];
   }
   if ( "C" in _argv ) {
     contract_compiler_output =
       _argv[
         "C"];
   }
-  if ( "contract-compiler-output" in _argv ) {
+  if ( "compiler-output" in _argv ) {
     contract_compiler_output =
       _argv[
-        "contract-compiler-output"];
+        "compiler-output"];
   }
   if ( "a" in _argv ) {
     call_auth =
       "y";
   }
-  if ( "call-auth" in _argv ) {
+  if ( "auth" in _argv ) {
     call_auth =
       "y";
   }
@@ -553,52 +693,69 @@ function
 
 function
   _url_parse() {
+  let
+    _method,
+    _network;
   runtime_environment =
     "browser";
-  target_chain =
+  call_type =
+    _argv_url_get(
+      "call_type")[
+        0];
+  call_timeout =
     _argv_url_get(
-      "chain")[
+      "call_timeout")[
         0];
-  target_command =
+  index_retrieve =
     _argv_url_get(
-      "command")[
+      "index_retrieve")[
         0];
-  input_type =
+  price_gas =
     _argv_url_get(
-      "input_type")[
+      "price_gas")[
         0];
-  output_type =
+  measure_unit =
     _argv_url_get(
-      "output_type")[
+      "measure_unit")[
         0];
-  input_type =
+  msg_value =
     _argv_url_get(
-      "input_type")[
+      "msg_value")[
         0];
-  retrieval_mode =
+  retries_max =
     _argv_url_get(
-      "retrieval_mode")[
+      "retries_max")[
         0];
-  user_level =
+  rpc_selection =
     _argv_url_get(
-      "user_level")[
+      "rpc_selection")[
         0];
-  db_paths.push(
+  contract_abi =
     _argv_url_get(
-      "db_path")[
-        0]);
-  selection_method =
+      "abi")[
+        0];
+  contract_bytecode =
     _argv_url_get(
-      "selection_method")[
+      "bytecode")[
         0];
-  api_key =
+  contract_compiler_output =
     _argv_url_get(
-      "api_key")[
+      "compiler_output")[
         0];
-  networks_all =
+  rpc_selection =
     _argv_url_get(
-      "networks_all")[
+      "rpc_selection")[
         0];
+  for ( _network of _argv_url_get(
+                     "network") ) {
+    target_networks.push(
+      _network);
+  }
+  for ( _method of _argv_url_get(
+                     "method_args") ) {
+    method_args.push(
+      _method);
+  }
   quiet =
     _argv_url_get(
       "quiet");
@@ -631,22 +788,34 @@ if ( _cmdline_check(
      _cmdline_check(
             "evm-contract-call") == true ) {
   _cmdline_parse();
+  _libevm_cmdline_parse();
 }
 else{
   _url_parse();
+  _libevm_url_parse();
 }
 _overrides_set();
 _config_show();
 app_opts = [
-  target_command,
-  input_type,
-  output_type,
-  retrieval_mode,
-  selection_method,
+  call_type,
+  call_timeout,
+  wallet_name,
+  wallet_path,
+  wallet_password,
+  wallet_seed,
   api_key,
-  networks_all,
-  target_chain,
-  db_paths
+  msg_value,
+  price_gas,
+  measure_unit,
+  retries_max,
+  target_network,
+  rpc_selection,
+  contract_address,
+  contract_abi,
+  contract_bytecode,
+  contract_compiler_output,
+  contract_method,
+  method_args
 ];
 _evm_contract_call_cmdline(
   app_opts);