evm-chains-info 0.0.1

package/README.md

@@ -0,0 +1,100 @@
+
+[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 A)
+[comment]: <> (PARTICULAR PURPOSE.)
+
+[comment]: <> (See the GNU Affero General Public License for more)
+[comment]: <> (details. You should have received a copy of the GNU)
+[comment]: <> (Affero License along with this program.)
+[comment]: <> (If not, see <https://www.gnu.org/licenses/>.)
+[comment]: <> (SPDX-License-Identifier: AGPL-3.0)
+
+# EVM Chains Info (`evm-chains-info.js`)
+
+[![NPM version](
+  https://img.shields.io/npm/e/evmfs/evmfs.svg)](
+    https://npmjs.org/package/evmfs)
+
+Returns information about EVM chains.
+
+```bash
+  evm-chains-info.js \
+    [options] \
+    <target-chain>
+```
+
+This program is a dependency for the
+[EVM Contracts Tools](
+  https://github.com/themartiancompany/evm-contracts-tools)
+and the [libEVM](
+  https://github.com/themartiancompany/libevm)
+library.
+
+It is written and depends on the
+[Crash Javascript](
+  https://github.com/themartiancompany/crash-js)
+library.
+
+## Installation
+
+The program in this source repo
+can be installed from source using GNU Make.
+
+```bash
+make \
+  install
+```
+
+It has officially published on the
+the uncensorable
+[Ur](
+  https://github.com/themartiancompany/ur)
+user repository and application store as
+`evm-chains-info`.
+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-chains-info
+```
+
+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-chains-info-ur](
+  https://github.com/themartiancompany/encoding-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.
+
+The package has also been published
+on the NPM Registry as `evm-chains-info`
+and so it can be installed from there by typing
+
+```bash
+npm \
+  install \
+    "evm-chains-info"
+```
+
+## License
+
+This program is released by Pellegrino Prevete under the terms
+of the GNU Affero General Public License version 3.

package/evm-chains-info

@@ -0,0 +1,345 @@
+#!/usr/bin/env node
+
+// SPDX-License-Identifier: AGPL-3.0-or-later
+
+/**    ----------------------------------------------------------------
+ *     evm-chains-info.js
+ *     ----------------------------------------------------------------
+ *     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(
+    'crash-js');
+/* global
+     _cmdline_check */
+const
+  _cmdline_check =
+    _libcrash._cmdline_check;
+/* global
+     _msg_info */
+const
+  _msg_info =
+    _libcrash._msg_info;
+/* global
+     _msg_error */
+const
+  _msg_error =
+    _libcrash._msg_error;
+/* global
+     _argv_get */
+const
+_argv_get =
+  _libcrash._argv_get;
+
+const
+  _libevm_chains_info =
+    require(
+      "./libevm-chains-info");
+/* global
+     _rpc_backends_get */
+const
+  _evm_chains_db_path_get =
+    _libevm_chains_info._evm_chains_db_path_get;
+/* global
+     _rpc_backends_get */
+const
+  _evm_chain_info_get =
+    _libevm_chains_info._evm_chain_info_get;
+/* global
+     _rpc_backends_get */
+const
+  _rpc_backend_get =
+    _libevm_chains_info._rpc_backend_get;
+/* global
+     _rpc_backends_get */
+const
+  _rpc_backends_get =
+    _rpc_backends_get;
+
+function
+  _global_variables() {
+  /* global
+       app_name:
+         writable */
+  app_name =
+    "evm-chains-info.js";
+  /* global
+       app_opts:
+         writable */
+  app_opts =
+    [];
+  /* global
+       encoding_format:
+         writable */
+  encoding_format =
+    "";
+  /* global
+       buffer_size:
+         writable */
+  buffer_size =
+    "";
+  /* global
+       string_length:
+         writable */
+  string_length =
+    "";
+  /* global
+       in_file:
+         writable */
+  in_file =
+    "";
+  /* global
+       out_txt_prefix:
+         writable */
+  out_txt_prefix =
+    "";
+  /* global
+       amount_only:
+         writable */
+  amount_only =
+    "";
+  /* global
+       quiet:
+         writable */
+  quiet =
+    "";
+}
+
+function 
+  _overrides_set() {
+  if ( encoding_format == "" ) {
+    encoding_format =
+      "base64";
+  }
+  if ( string_length == "" ) {
+    string_length =
+      "10000";
+  }
+  if ( buffer_size == "" ) {
+    buffer_size =
+      "2000000"; // 2MB
+  }
+  if ( amount_only == "" ) {
+    amount_only =
+      "false";
+  }
+}
+
+function
+  _config_show() {
+  let
+    _line,
+    _text;
+  _text = [
+    `${app_name} configuration:`,
+    `      Runtime environment:   ${runtime_environment}`,
+    `          Encoding format:   ${encoding_format}`,
+    `              Buffer size:   ${buffer_size}`,
+    `      Chunk string length:   ${string_length}`,
+    `       Chunks amount only:   ${amount_only}`,
+    `                  In file:   ${in_file}`,
+    `          Out text prefix:   ${out_txt_prefix}`,
+  ];
+  for ( _line of _text ) {
+    _msg_info(
+      _line);
+  }
+}
+
+function
+  _usage(
+    _exit_code) {
+  let
+    _line,
+    _text;
+  _text = [
+    "Converts binary to ascii text.",
+    "",
+    "Usage:",
+    "",
+    "  bin2txt",
+    "    <in-file>",
+    "    <out-txt-prefix>",
+    "",
+    "  arguments:",
+    "    <in-file>                        An input file.",
+    "    <out-file-prefix>                Prefix for the output file(s).",
+    "",
+    "  options:",
+    "",
+    "     -f --encoding-format            Encoding format ('base64').",
+    `       <encoding-format>             Default: '${encoding_format}`,
+    "",
+    "     -B --buffer-size                Size in bytes the input file will",
+    "       <buffer-size>                 be split before being read",
+    "                                     in memory and passed to",
+    "                                     the encoder.",
+    `                                     Default: '${buffer_size}'`,
+    "",
+    "     -L --string-length              String chunk length.",
+    `       <string-length>               Default: '${string_length}'`,
+    "",
+    "     -s --amount-only                Only print chunks amount.",
+    `                                     Default: '${amount_only}'`,
+    "",
+    "     -h --help                       This message.",
+    "     -v --verbose                    Enable verbose output."
+  ];
+  for ( _line of _text ) {
+    console.log(
+      _line);
+  }
+  process.exit(
+    _exit_code);
+}
+
+function 
+  _cmdline_parse() {
+  let
+    _argv,
+    _help_display,
+    _msg;
+  _argv =
+    _argv_get();
+  _options =
+    _argv[
+      "_"];
+  quiet = 
+    "y";
+  runtime_environment =
+    "node";
+  if ( _options.indexOf(
+         "--help") > -1 ||
+       _options.indexOf(
+         "-h") > -1) {
+    _help_display =
+      true;
+  }
+  if ( _help_display ) {
+    quiet =
+      "n";
+    _usage(
+      0);
+  }
+  if ( typeof(
+         _argv) == "undefined" ||
+       _argv[
+         "_"].length < 1 ) {
+    _msg =
+      "Input file argument required.";
+    _msg_error(
+      _msg,
+      0);
+    _usage(
+      1);
+  }
+  in_file =
+    _argv[
+      "_"][
+        0];
+  if ( _argv[
+         "_"].length < 2 ) {
+    out_txt_prefix =
+      in_file +
+      ".base64";
+  }
+  if ( "L" in _argv ) {
+    string_length =
+      _argv[
+        "L"];
+  }
+  if ( "string-length" in _argv ) {
+    string_length =
+      _argv[
+        "string-length"];
+  }
+  if ( "s" in _argv ) {
+    amount_only =
+      _argv[
+        "s"];
+  }
+  if ( "amount-only" in _argv ) {
+    amount_only =
+      _argv[
+        "amount-only"];
+  }
+  if ( "v" in _argv ) {
+    verbose =
+      _argv[
+        "v"];
+  }
+  if ( "verbose" in _argv ) {
+    verbose =
+      _argv[
+        "verbose"];
+  }
+  if ( verbose ) {
+    quiet =
+      "n";
+  }
+}
+
+function
+  _url_parse() {
+  let
+    _argv;
+  runtime_environment =
+    "browser";
+  _argv =
+    _argv_url_get();
+  in_file =
+    _argv_url_get(
+      "in_file")[
+        0];
+  target_planet =
+    _argv_url_get(
+      "out_txt_prefix")[
+        0];
+  quiet =
+    _argv_url_get(
+      "quiet");
+  if ( quiet.length === 0 ) {
+    quiet =
+      "n";
+  }
+}
+
+_global_variables();
+if ( _cmdline_check(
+       "bin2txt.js") == true ) {
+  _cmdline_parse();
+}
+_overrides_set();
+_config_show();
+app_opts = [
+  in_file,
+  out_txt_prefix,
+  encoding_format,  
+  string_length,
+  buffer_size,
+  amount_only 
+];
+_bin2txt.apply(
+  null,
+  app_opts);

package/libevm-chains-info

@@ -0,0 +1,206 @@
+#!/usr/bin/env node
+
+
+// SPDX-License-Identifier: AGPL-3.0-or-later
+
+/**    ----------------------------------------------------------------
+ *     libevm-chains-info
+ *     ----------------------------------------------------------------
+ *     Copyright ©
+ *       Pellegrino Prevete
+ *         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');
+const
+  _libcrash_module =
+    require(
+      "crash-js");
+_file_exists =
+  _libcrash_module._file_exists;
+_json_read =
+  _libcrash_module._json_read;
+_path_join =
+  _libcrash_module._path_join;
+
+function
+  _evm_chains_db_path_get(
+    _user) {
+  let
+    _db_exists,
+    _path;
+  if ( _user == undefined ) {
+    _user =
+      false;
+  }
+  if ( _user == true ) {
+    _path =
+      _path_join(
+        [process.env.HOME,
+         ".local",
+         "share",
+         "evm-chains",
+         "chains.json"])
+    _db_exists =
+      _file_exists(
+        _db_path);
+    if ( _db_exists == false ) {
+      _user =
+        false;
+    }
+  }
+  if ( _user == false ) {
+    _path =
+      _path_join(
+        [process.env.NODE_PATH,
+         "..",
+         "evm-chains",
+         "chains.json"])
+  }
+  else {
+    _msg_error(
+      "Input variable '_user' must be a boolean",
+      0);
+  }
+  return _path;
+}
+
+function
+  _evm_chain_info_get(
+    _chain_id,
+    _chain_info,
+    _db_path) {
+  let
+    _db,
+    _db_exists;
+  if ( _db_path == undefined ) {
+    _db_path =
+      _evm_chains_db_path_get(
+        false);
+  }
+  _db_exists =
+    _file_exists(
+      _db_path);
+  if ( _db_exists == false ) {
+    _msg_error(
+      "Database file does not exists.",
+      1);
+  }
+  _db =
+    _json_read(
+      _db_path);
+  for ( _chain_info of _db) {
+    if ( _chain_info["chainId"] == _chain_id ) {
+      return _chain_info;
+    }
+  }
+  _msg_error(
+    `Network '${_chain_id}' not found.`,
+    1);
+}
+
+function
+  _rpc_backend_get(
+    _network_chain_id,
+    _selection_method,
+    _db_path) {
+  let
+    _chain_id,
+    _chain_info;
+  if ( _network_chain_id == undefined ) {
+    _msg_error(
+      "Network's ChainID not specified.",
+      1);
+  }
+  if ( _selection_method == undefined ) {
+    _selection_method =
+      "kirsh";
+  }
+  if ( _db_path == undefined ) {
+    _db_path =
+      _evm_chains_db_path_get(
+        false);
+  }
+  _chain_id =
+    Number(
+      _network_chain_id);
+  _chain_info =
+    _evm_chain_info_get(
+      _chain_id,
+      _db_path);
+  if ( _selection_method == "kirsh" ) {
+    return _chain_info["rpc"][0];
+  }
+  else {
+    _msg_error(
+      "Unknown selection method.",
+      1);
+  }
+}
+
+function _rpc_backends_get(
+    _networks_chain_ids,
+    _selection_method,
+    _db_path) {
+    let
+      _chain_id,
+      _rpc_backend_get_opts,
+      _rpcs;
+  if ( _selection_method == undefined ) {
+    _selection_method =
+      "kirsh";
+  }
+  if ( _db_path == undefined ) {
+    _db_path =
+      _evm_chains_db_path_get(
+        false);
+  }
+  _rpcs =
+    [];
+  for ( _chain_id of _networks_chain_ids ) {
+    _rpc_backend_get_opts = [
+      _chain_id,
+      _selection_method,
+      _db_path
+    ];
+    _rpc_backend =
+      _rpc_backend_get.apply(
+        null,
+        _rpc_backend_get_opts);
+    _rpcs.append(
+      _rpc_backend);
+  }
+  return _rpcs;
+}
+
+module.exports = {
+  _evm_chains_db_path_get:
+    _evm_chains_db_path_get,
+  _evm_chain_info_get:
+    _evm_chain_info_get,
+  _rpc_backend_get:
+    _rpc_backend_get,
+  _rpc_backends_get:
+    _rpc_backends_get
+};