evm-contracts-tools 0.0.1

package/README.md

@@ -0,0 +1,101 @@
+[comment]: <> (SPDX-License-Identifier: AGPL-3.0)
+
+[comment]: <> (------------------------------------------------------)
+[comment]: <> (Copyright © 2024, 2025, 2026  Pellegrino Prevete)
+[comment]: <> (All rights reserved)
+[comment]: <> (------------------------------------------------------)
+
+[comment]: <> (This program is free software: you can redistribute)
+[comment]: <> (it and/or modify it under the terms of the GNU Affero)
+[comment]: <> (General Public License as published by the Free)
+[comment]: <> (Software Foundation, either version 3 of the License.)
+
+[comment]: <> (This program is distributed in the hope that it will be)
+[comment]: <> (useful, but WITHOUT ANY WARRANTY; without even the)
+[comment]: <> (implied warranty of MERCHANTABILITY or FITNESS FOR)
+[comment]: <> (A PARTICULAR PURPOSE. See the)
+[comment]: <> (See the GNU Affero General Public License for)
+[comment]: <> (more details.)
+
+[comment]: <> (You should have received a copy of the GNU Affero)
+[comment]: <> (General Public License along with this program.)
+[comment]: <> (If not, see <https://www.gnu.org/licenses/>.)
+
+# EVM Smart Contracts Tools
+
+A full-suite collection of useful JavaScript
+programs and libraries to enable seamless development
+of native computer applications designed to interact
+with Ethereum Virtual Machine-compatible networks. 
+
+Particular focus has been put onto giving users the ability
+to seamlessly call publicly verified smart contracts functions
+same as they would do to retrieve information from any other standard
+local program.
+
+In order to do so, the `evm-contract-call` program obtains networks'
+informations from the
+[EVM Chains Info](
+  https://github.com/themartiancompany/evm-chains-info)
+and automatically retrieves eventually missing smart
+contracts artifacts from online sources using the
+[EVM Contracts ABI Get](
+  https://github.com/themartiancompany/evm-contracts-abi-get)
+utility.
+
+The `evm-contract-call` program uses the 
+[Ethers](
+  https://github.com/ethers-io/ethers.js)
+JavaScript library to
+communicate with Ethereum Virtual Machine-compatible
+blockchain networks and integrates natively with
+and depends on the
+[EVM Wallet](
+  https://github.com/themartiancompany/evm-wallet),
+but it's also possible to directly provide seeds files.
+
+The tools are a required software dependency for
+[libEVM](
+  https://github.com/themartiancompany/libevm).
+
+## Installation
+
+The tools in this source repo
+can be installed from source using GNU Make.
+
+```bash
+make \
+  install
+```
+
+The collection has been officially published
+on the the uncensorable
+[Ur](
+  https://github.com/themartiancompany/ur)
+user repository and application store as
+`evm-contracts-tools`.
+The source code is published on the
+[Ethereum Virtual Machine File System](
+  https://github.com/themartiancompany/evmfs)
+so it can't possibly be taken down.
+
+To install it from there just type
+
+```bash
+ur \
+  evm-contracts-tools
+```
+
+A censorable HTTP Github mirror of the recipe published there,
+containing a full list of the software dependencies needed to run the
+tools is hosted on
+[evm-contracts-tools-ur](
+  https://github.com/themartiancompany/evm-contracts-tools-ur).
+
+Be aware the mirror could go offline any time as Github and more
+in general all HTTP resources are inherently unstable and censorable.
+
+## License
+
+This program is released by Pellegrino Prevete under the terms
+of the GNU Affero General Public License version 3.

package/fs-worker.js

@@ -0,0 +1 @@
+(()=>{var e={816(e,o,n){function t(){let e;return"undefined"==typeof window&&void 0!==n.g&&n.g.global===n.g&&"function"!=typeof n||(e=function(){let e;try{e=n(816)}catch(e){console.log(e);const o="Error importing the '@themartiancompany/opfs' module as 'opfs'. If you got this error while bundling a webpack for a project depending on this module double check its 'webpack.config.js' file or whether the 'opfs' module is listed in developer dependencies and install them.I'm sorry for this inconvenience but Node packagement system does not currently distinguish 'development' from 'build' dependencies.";throw console.error(o),e}return e}()),e}const r=t();e.exports=r,e.exports.getModule=function(e){let o;if(""==_module_name||"undefined"==typeof _module_name)o=t();else if("opfs"==_module_name)o=n(816);else{if("fs"!=_module_name){const e="Unknown file system module "+`'${_module_name}'.`.const;throw _error={msg:e},console.error(e),_error}o=n(816)}return o}},314(e,o,n){const t=n(816);_sync_agent=t.startSyncAgent,e.exports={_sync_agent},_sync_agent()}},o={};function n(t){var r=o[t];if(void 0!==r)return r.exports;var s=o[t]={exports:{}};return e[t](s,s.exports,n),s.exports}n.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),n(314)})();

package/lib/bytecode-creation-get

@@ -0,0 +1,438 @@
+#!/usr/bin/env node
+
+// SPDX-License-Identifier: AGPL-3.0-or-later
+
+/**    ----------------------------------------------------------------------
+ *     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 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
+ *     along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+const
+  _libcrash =
+    require(
+      '../libcrash-js/crash-js');
+_cmdline_check =
+  _libcrash._cmdline_check;
+_error_display =
+  _libcrash._error_display;
+_msg_info =
+  _libcrash._msg_info;
+_msg_error =
+  _libcrash._msg_error;
+_printf =
+  _libcrash._printf;
+const
+  { ethers } =
+    require(
+      "ethers");
+_ethers =
+  ethers;
+_wei_to_ether =
+  _ethers.formatEther;
+const
+  _transaction_get_module =
+    require(
+      '../evm-transactions-tools/transaction-get');
+_transaction_get =
+  _transaction_get_module._transaction_get;
+const
+  _transaction_receipt_get_module =
+    require(
+      '../evm-transactions-tools/transaction-receipt-get');
+_transaction_receipt_get =
+  _transaction_receipt_get_module._transaction_receipt_get;
+const
+  _deployer_get_module =
+    require(
+      './deployer-get');
+_deployer_get =
+  _deployer_get_module._deployer_get;
+
+function
+  _global_variables() {
+  app_name =
+    "bytecode-creation-get";
+  wallet_seed =
+    "";
+  retries_max =
+    "";
+  api_key_path =
+    "";
+  chain_id =
+    "";
+  chain_name =
+    "";
+  target_network =
+    "";
+  contract_address =
+    "";
+  transaction_deployment =
+    "";
+  contract_bytecode_path =
+    "";
+  quiet =
+    "";
+}
+
+function
+  _delay(
+    _time) {
+  return new Promise(resolve => setTimeout(resolve, _time));
+}
+
+async function
+  _bytecode_creation_get(
+    _wallet_seed,
+    _retries_max,
+    _api_key_path,
+    _chain_id,
+    _chain_name,
+    _target_network,
+    _contract_address,
+    _transaction_deployment,
+    _bytecode_path) {
+  let
+    _attempt,
+    _bytecode,
+    _deployer,
+    _deployer_get_opts,
+    _transaction_get_opts,
+    _tx,
+    _wallet_password; //,
+    // _receipt,
+    // _transaction_receipt_get_opts,
+  if ( _bytecode_path == undefined ) {
+    _bytecode_path =
+      "";
+  }
+  if ( _contract_address == undefined ) {
+    _contract_address =
+      "";
+  }
+  _contract_address =
+    _contract_address.toLowerCase();
+  _attempt =
+    1;
+  _wallet_password =
+    "";
+  _output_path =
+    "";
+  _transaction_get_opts = [
+    _retries_max,
+    _wallet_seed,
+    _wallet_password,
+    _chain_id,
+    _chain_name,
+    _target_network,
+    _api_key_path,
+    _output_path,
+    _transaction_deployment
+  ];
+  _transaction_receipt_get_opts = [
+    _retries_max,
+    _wallet_seed,
+    _wallet_password,
+    _chain_id,
+    _chain_name,
+    _target_network,
+    _api_key_path,
+    _output_path,
+    _transaction_deployment
+  ];
+  while ( _attempt <= _retries_max ) {
+    try {
+      _tx =
+        await _transaction_get.apply(
+          null,
+          _transaction_get_opts);
+      if ( _tx == undefined ) {
+        throw { "error": {
+                  "message":
+                    "Undefined transaction." } };
+      }
+      else if ( _tx != undefined ) {
+        _bytecode =
+          _tx.data;
+	_file_write(
+          _bytecode_path,
+          _bytecode);
+      }
+      break
+    } catch (
+        _error) {
+      _error_display(
+        _error);
+      // TODO: Do not break the loop
+      //       only on network errors.
+      _attempt =
+        _attempt + 1;
+      _msg_error(
+        "Increasing retry and waiting 3 seconds.",
+        0);
+      await _delay(
+        3000);
+    }
+  }
+  if ( _attempt > _retries_max ) {
+    throw "Maximum number of retries reached.";
+  }
+  return _bytecode;
+}
+
+function
+  _config_show() {
+  let
+    _line,
+    _method_args,
+    _text;
+  _text =
+    [];
+  _text.push(
+    "bytecode-creation-get configuration:");
+  _text.push(
+    "             Wallet seed: {wallet_seed}".replace(
+      "{wallet_seed}",
+      wallet_seed));
+  _text.push(
+    "             Max retries: {retries_max}".replace(
+      "{retries_max}",
+      retries_max));
+  _text.push(
+    "            API Key path: {api_key_path}".replace(
+      "{api_key_path}",
+      api_key_path));
+  _text.push(
+    "                Chain ID: {chain_id}".replace(
+      "{chain_id}",
+      chain_id));
+  _text.push(
+    "              Chain Name: {chain_name}".replace(
+      "{chain_name}",
+      chain_name));
+  _text.push(
+    "          Target network: {target_network}".replace(
+      "{target_network}",
+      target_network));
+  _text.push(
+    "        Contract address: {contract_address}".replace(
+      "{contract_address}",
+      contract_address));
+  _text.push(
+    "  Deployment transaction: {transaction_deployment}".replace(
+      "{transaction_deployment}",
+      transaction_deployment));
+  for (_line of _text)  { 
+    _msg_info(
+      _line);
+  }
+}
+
+function
+  _usage(
+    _exit) {
+  let
+    _display_fun,
+    _line,
+    _text;
+  _text = [
+    "Returns the creation bytecode for a contract given its deployment transaction hash.",
+    "",
+    "Usage:",
+    "  bytecode-creation-get",
+    "    <quiet>",
+    "    <wallet_seed>",
+    "    <retries_max>",
+    "    <api_key_path>",
+    "    <chain_id>",
+    "    <chain_name>",
+    "    <target_network>",
+    "    <contract_address>",
+    "    <transaction_deployment>",
+    "    <contract_bytecode_path>",
+    "",
+    "Args:",
+    "  <quiet>                          Can be 'y' or 'n'",
+    "                                   Default: y",
+    "  <wallet_seed>                    Path of the file containing",
+    "                                   the seed phrase.",
+    "  <retries_max>                    Maximum number of retries before",
+    "                                   failing.",
+    "  <api_key_path>                   Path of the API key for the",
+    "                                   contract ABI provider service",
+    "  <chain_id>                       Chain ID for the network.",
+    "  <chain_name>                     Name for the network.",
+    "  <target_network>                 Network on which the contract",
+    "                                   resides.",
+    "  <contract_address>               Address of the contract",
+    "  <transaction_deployment>         Contract deployment transaction.",
+    "  <contract_bytecode_path>         Where to save contract bytecode.",
+    "",
+    "  Options:",
+    "    -h                             This help."
+  ];
+  for (_line of _text) {
+    _msg_info(
+      _line);
+  }
+  process.exit(
+    _exit);
+}
+
+function
+  _overrides_set() {
+  if ( retries_max == "" ) {
+    retries_max =
+      10;
+  }
+}
+
+function
+  _cmdline_parse() {
+  quiet =
+    "y";
+  process.argv.forEach(
+    function (
+      _value,
+      _index,
+      _array) {
+      if ( _index == 2 ) {
+        quiet =
+          _value;
+      }
+      if ( _index == 3 ) {
+        wallet_seed =
+          _value;
+      }
+      if ( _index == 4 ) {
+        retries_max =
+          _value;
+      }
+      if ( _index == 5 ) {
+        api_key_path =
+          _value;
+      }
+      if ( _index == 6 ) {
+        chain_id =
+          _value;
+      }
+      if ( _index == 7 ) {
+        chain_name =
+          _value;
+      }
+      if ( _index == 8 ) {
+        target_network =
+          _value;
+      }
+      if ( _index == 9 ) {
+        contract_address =
+          _value;
+      }
+      if ( _index == 10 ) {
+        transaction_deployment =
+          _value;
+      }
+      if ( _index == 11 ) {
+        contract_bytecode_path =
+          _value;
+      }
+      if ( _value == "-h" ||
+           _value == "--help" ) {
+        quiet =
+          "n";
+        _usage(
+          0);
+      }
+    }
+  );
+  if ( transaction_deployment == "" ) {
+    _msg_error(
+      "No deployment transaction specified.",
+      0);
+    quiet =
+      "n";
+    _usage(
+      1);
+  }
+  if ( contract_bytecode_path == "" ) {
+    _msg_error(
+      "No contract bytecode path specified.",
+      0);
+    quiet =
+      "n";
+    _usage(
+      1);
+  }
+}
+async function
+  _bytecode_creation_get_cmdline(
+    _app_opts) {
+  let
+    _bytecode,
+    _msg;
+  try {
+    _bytecode = 
+      await _bytecode_creation_get.apply(
+        null,
+        _app_opts);
+    if ( _bytecode != undefined ) {
+      _msg_info(
+        `Bytecode has length '${_bytecode.length}'`);
+      // _printf(
+      //   _bytecode.toString());
+    }
+    else {
+      _msg =
+        "It has not been possible to retrieve " +
+	"the bytecode from the transaction.";
+      throw _msg;
+    }
+  } catch (
+      _error) {
+    _msg_error(
+      _error,
+      1);
+  }
+}
+
+if ( _cmdline_check(
+       "bytecode-creation-get") ) {
+  _global_variables();
+  _cmdline_parse();
+  _overrides_set();
+  _config_show();
+  app_opts = [
+    wallet_seed,
+    retries_max,
+    api_key_path,
+    chain_id,
+    chain_name,
+    target_network,
+    contract_address,
+    transaction_deployment,
+    contract_bytecode_path
+  ];
+  _bytecode_creation_get_cmdline(
+    app_opts);
+}
+
+module.exports = {
+  _bytecode_creation_get:
+    _bytecode_creation_get
+};