diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml new file mode 100644 index 0000000..62ade45 --- /dev/null +++ b/.github/workflows/deploy-docs.yml @@ -0,0 +1,30 @@ +name: Deploy docs to GitHub Pages + +on: + push: + branches: + - main + +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - name: Setup Rust + uses: actions-rs/toolchain@v1 + with: + profile: minimal + toolchain: stable + override: true + - name: Install mdBook + run: cargo install mdbook + - name: Build mdBook + run: mdbook build docs + - name: Deploy to GitHub Pages + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./docs/book + publish_branch: gh-pages + keep_files: false + diff --git a/.github/workflows/go.yml b/.github/workflows/go.yml new file mode 100644 index 0000000..bff1271 --- /dev/null +++ b/.github/workflows/go.yml @@ -0,0 +1,42 @@ +name: Go + +on: + push: + branches: [ "main" ] + pull_request: + branches: [ "main" ] + +jobs: + + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + + - name: Set up Go + uses: actions/setup-go@v4 + with: + go-version: '1.21.x' + + - name: Build + working-directory: ./go + run: go build -v ./... + + - name: Test + working-directory: ./go + run: go test -v ./... + + golangci: + name: lint + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-go@v4 + with: + go-version: '1.21' + cache: false + - name: golangci-lint + uses: golangci/golangci-lint-action@v3 + with: + version: v1.54 + working-directory: ./go diff --git a/.github/workflows/python-tests.yml b/.github/workflows/python-tests.yml new file mode 100644 index 0000000..67e5403 --- /dev/null +++ b/.github/workflows/python-tests.yml @@ -0,0 +1,25 @@ +name: Python Tests + +on: [push, pull_request] + +jobs: + test: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + - name: Set up Python + uses: actions/setup-python@v2 + with: + python-version: '3.9' + + - name: Install dependencies + run: | + pip install -e ./python + pip install pytest pytest-xdist + + - name: Run Python tests + run: | + cd tests + pytest --adapters adapters/python + diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..26f1aa7 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,57 @@ + +name: Release + +on: + workflow_dispatch: + +jobs: + build: + name: Build on ${{ matrix.os }} for ${{ matrix.arch }} + runs-on: ${{ matrix.os }} + strategy: + matrix: + os: [ubuntu-latest, macos-latest, windows-latest] + arch: [amd64, arm64] + include: + - os: ubuntu-latest + arch: arm64 + target: aarch64-unknown-linux-gnu + - os: macos-latest + arch: arm64 + target: aarch64-apple-darwin + exclude: + - os: windows-latest + arch: arm64 + + steps: + - name: Checkout Repository + uses: actions/checkout@v2 + + - name: Install Dependencies (Ubuntu) + if: matrix.os == 'ubuntu-latest' + run: | + sudo apt-get update + sudo apt-get install pkg-config libssl-dev + + - name: Install Rust + uses: actions-rs/toolchain@v1 + with: + toolchain: stable + profile: minimal + override: true + target: ${{ matrix.target }} + + - name: Build Binary + run: | + cd rust + cargo build --release --target ${{ matrix.target }} --path crates/mesc_cli + + - name: Publish Release + if: startsWith(github.ref, 'refs/tags/') + uses: softprops/action-gh-release@v1 + with: + files: | + rust/target/${{ matrix.target }}/release/mesc_cli* + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + diff --git a/.github/workflows/rust-tests.yml b/.github/workflows/rust-tests.yml new file mode 100644 index 0000000..d058692 --- /dev/null +++ b/.github/workflows/rust-tests.yml @@ -0,0 +1,36 @@ +name: Rust Tests + +on: [push, pull_request] + +jobs: + test: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + + - name: Install Rust + uses: dtolnay/rust-toolchain@stable + + - name: Cache Rust artifacts + uses: Swatinem/rust-cache@v2 + with: + cache-on-failure: true + workspaces: rust + + - name: Build and Install Rust Project + run: cargo install --path rust/crates/mesc_cli --profile dev + + - name: Set up Python + uses: actions/setup-python@v2 + with: + python-version: '3.9' # Specify your required Python version + + - name: Install Python dependencies for testing + run: | + pip install pytest pytest-xdist + + - name: Run Rust tests + run: | + cd tests + pytest --adapters adapters/cli diff --git a/.github/workflows/typescript.yml b/.github/workflows/typescript.yml new file mode 100644 index 0000000..7630e50 --- /dev/null +++ b/.github/workflows/typescript.yml @@ -0,0 +1,46 @@ +name: TypeScript + +on: + push: + branches: [ "main" ] + pull_request: + branches: [ "main" ] + +defaults: + run: + working-directory: typescript + +env: + # enable debug logging + ACTIONS_RUNNER_DEBUG: true + +jobs: + build-lint-test: + runs-on: ubuntu-latest + defaults: + run: + working-directory: typescript + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Set up Bun + uses: oven-sh/setup-bun@v1 + with: + bun-version: latest + + - name: Install dependencies + run: bun install + + - name: Lint, Format, & Typecheck + working-directory: typescript + run: | + bun run lint + bun run format + bun run typecheck + + - name: Build + run: bun run build + + - name: Test + run: bun run test diff --git a/.gitignore b/.gitignore index 2447ba9..9b55d9e 100644 --- a/.gitignore +++ b/.gitignore @@ -4,6 +4,13 @@ TODO.md INTEGRATION.md PITCH.md *.json +!biome.json __pycache__ python/dist -book/book +docs/book +*.gif +node_modules +dist +.env +!.env.example +_ \ No newline at end of file diff --git a/README.md b/README.md index a0d1058..5e85ada 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,12 @@ # Multiple Endpoint Shared Configuration (MESC) Standard +[![Specification](https://img.shields.io/badge/Spec-blueviolet)](https://github.com/paradigmxyz/mesc/blob/main/SPECIFICATION.md) +[![issues - badge-generator](https://img.shields.io/badge/Docs-blueviolet)](https://paradigmxyz.github.io/mesc) +[![Rust Tests](https://github.com/paradigmxyz/mesc/workflows/Rust%20Tests/badge.svg)](https://github.com/paradigmxyz/mesc/tree/main/tests) +[![Python Tests](https://github.com/paradigmxyz/mesc/workflows/Python%20Tests/badge.svg)](https://github.com/paradigmxyz/mesc/tree/main/tests) + + MESC is a standard for how crypto tools configure their RPC endpoints. By following this specification, a user creates a single RPC configuration that can be shared by all crypto tools on their system. MESC has two main design goals: @@ -9,6 +15,9 @@ MESC has two main design goals: MESC is formally defined in [SPECIFICATION.md](./SPECIFICATION.md). +Additional information can be found in the [MESC Documentation](https://paradigmxyz.github.io/mesc/). + + ### Contents - [Reference Implementations](#reference-implementations) - [Quickstart](#quickstart) @@ -30,18 +39,21 @@ These implementations provide a consistent language-agnostic interface while sti ## Quickstart -The interactive [`mesc`](./cli) CLI tool makes it easy to create and manage a MESC configuration. -1. Install: `cargo install mesc_cli` -2. Create config interactively: `mesc setup` +The quickest way to use MESC is: +1. create a `mesc.json` config file +2. set the `MESC_PATH` environment variable to the path of this file -To create a MESC config manually: -1) Create a JSON file (can use [the example](./SPECIFICATION.md#example-rpcconfig) from the spec as a template). -2) Set `MESC_PATH` to the path of this JSON file. +These steps can be performed automatically using the interactive [`mesc`](./cli) CLI tool: +1. Install: `cargo install mesc_cli` +2. Perform interactive setup: `mesc setup` + +Installing the `mesc` cli on some linux distributions may require installing ssl libraries (e.g. `sudo apt-get install pkg-config libssl-dev` on ubunutu) ## Tutorial -Below is a brief tutorial on MESC. For more detail, see [SPECIFICATION.md](./SPECIFICATION.md). +Below is a brief tutorial on MESC. For more detail, see the MESC [Specification](./SPECIFICATION.md) and [Documentation](https://paradigmxyz.github.io/mesc). +Topics: - [Tracked Information](#tracked-information) - [Common Interface](#common-interface) - [Typical Usage](#typical-usage) @@ -93,33 +105,38 @@ endpoints: list[Endpoint] = mesc.find_endpoints(chain_id=5) ###### rust ```rust -use mesc; -use mesc::MescError; +use mesc::{MescError, Endpoint}; +use std::collections::HashMap; type OptionalResult = Result, MescError>; type MultiResult = Result, MescError>; +type MetadataResult = Result, MescError>; + +// check whether mesc is enabled +let enabled: bool = mesc::is_mesc_enabled(); // get the default endpoint let endpoint: OptionalResult = mesc::get_default_endpoint(None); // get the default endpoint of a network -let endpoint: OptionalResult = mesc::get_endpoint_by_network(5, None); +let endpoint: OptionalResult = mesc::get_endpoint_by_network("5", None); // get the default network for a particular tool -let chain_id: OptionalResult = mesc::get_default_endpoint("xyz_tool"); +let chain_id: OptionalResult = mesc::get_default_endpoint(Some("xyz_tool")); // get the default endpoint of a network for a particular tool -let endpoint: OptionalResult = mesc::get_endpoint_by_network(5, "xyz_tool"); +let endpoint: OptionalResult = mesc::get_endpoint_by_network("5", Some("xyz_tool")); // get an endpoint by name -let endpoint: OptionalResult = mesc::get_endpoint_by_name("local_query"); +let endpoint: OptionalResult = mesc::get_endpoint_by_name("local_goerli"); // parse a user-provided string into a matching endpoint // (first try 1. endpoint name, then 2. chain id, then 3. network name) -let endpoint: OptionalResult = mesc::get_endpoint_by_query(user_str, "xyz_tool"); +let user_str = "local_goerli"; +let endpoint: OptionalResult = mesc::get_endpoint_by_query(user_str, Some("xyz_tool")); // find all endpoints matching given criteria -let query = mesc::MultiEndpointQuery::new().chain_id(5); +let query = mesc::MultiEndpointQuery::new().chain_id("5").unwrap(); let endpoints: MultiResult = mesc::find_endpoints(query); ``` diff --git a/SPECIFICATION.md b/SPECIFICATION.md index 503395a..41a1336 100644 --- a/SPECIFICATION.md +++ b/SPECIFICATION.md @@ -112,10 +112,10 @@ MESC is built using three key-value data schemas: | `use_mesc` | `bool` | whether to disable MESC when this profile is selected Requirements: -- All keys of `RpcConfig` and `Endpoint` are required. No additional keys should be present, except within `global_metadata`, `profile_metadata`, and `endpoint_metadata`. +- All keys of `RpcConfig` and `Endpoint` are required. No additional keys must be present, except within `global_metadata`, `profile_metadata`, and `endpoint_metadata`. - Every endpoint name specified in `RpcConfig.default_endpoint` and in `RpcConfig.network_defaults` must exist in `RpcConfig.endpoints`. - These key-value structures can be easily represented in JSON and in most common programming languages. -- Each `chain_id` should be represented using either a decimal string or a hex string. Strings are used because chain id's can be 256 bits and most languages do not have native 256 bit integer types. For readability, decimal should be used for small chain id values and hex should be used for values that use the entire 256 bits. +- EVM `chain_id`'s must be represented using either a decimal string or a `0x`-prefixed hex string. Strings are used because chain id's can be 256 bits and most programming languages do not have native 256 bit integer types. For readability, decimal should be used for small chain id values and hex should be used for values that use the entire 256 bits. - Names of endpoints, networks, and profiles should be composed of characters that are either alphanumeric, dashes, underscores, or periods. Names should be at least 1 character long. ##### Metadata @@ -133,7 +133,7 @@ The `global_metadata`, `profile_metadata`, and `endpoint_metadata` fields allow | `host` | `str` | name of provider host | `"llamanodes"`, `"alchemy"`, `"quicknode"`, `"localhost"` | `ecosystem` | `str` | ecosystem of chain, (e.g. relates mainnets to testnets) | `"ethereum"`, `"polygon"` | | `node_client` | `str` | versioned node client | `erigon/2.48.1/linux-amd64/go1.20.5` `reth/v0.1.0-alpha.10-7b781eb60/x86_64-unknown-linux-gnu` | -| `namespaces` | `Sequence[str]` | RPC name spaces enabled for endpoint | `["eth", "trace, "debug"]` +| `namespaces` | `Sequence[str]` | RPC name spaces enabled for endpoint | `["eth", "trace", "debug"]` | `explorer` | `str` | block explorer url | `https://etherscan.io` | `location` | `str` | geographic region | `Paris, France` | | `cloud_region` | `str` | cloud provider region | `aws-us-east-1a` | @@ -207,7 +207,7 @@ These overrides use a simple syntax that is intended to be easily written by hum When a user specifies an endpoint, as in `-r `, a MESC library must resolve this input into an endpoint URL. It is generally preferable to allow this user query to be a URL, an endpoint name, a network name, or a chain_id. -MESC data should be searched in the following order: +MESC data must be searched in the following order: 1. endpoint names 2. chain_id 3. network name @@ -358,7 +358,10 @@ endpoint: Endpoint | None = mesc.get_endpoint_by_name('local_goerli') endpoint: Endpoint | None = mesc.get_endpoint_by_query(user_str, profile='xyz_tool') # find all endpoints matching given criteria -endpoints: list[Endpoint] = mesc.find_endpoints(chain_id=5) +endpoints: Sequence[Endpoint] = mesc.find_endpoints(chain_id=5) + +# get non-endpoint metadata +metadata: Mapping[str, Any] = mesc.get_global_metadata(profile='xyz_tool') ``` A reference implementation is provided in the supplemental files of this repository. diff --git a/book/book.toml b/book/book.toml deleted file mode 100644 index 12c383a..0000000 --- a/book/book.toml +++ /dev/null @@ -1,6 +0,0 @@ -[book] -authors = ["sslivkoff"] -language = "en" -multilingual = false -src = "src" -title = "MESC User Guide" diff --git a/book/src/cli.md b/book/src/cli.md deleted file mode 100644 index 3f213d4..0000000 --- a/book/src/cli.md +++ /dev/null @@ -1 +0,0 @@ -# CLI diff --git a/book/src/creating_a_config.md b/book/src/creating_a_config.md deleted file mode 100644 index bd0786f..0000000 --- a/book/src/creating_a_config.md +++ /dev/null @@ -1 +0,0 @@ -# Creating a config diff --git a/book/src/developer_resources.md b/book/src/developer_resources.md deleted file mode 100644 index a67a443..0000000 --- a/book/src/developer_resources.md +++ /dev/null @@ -1 +0,0 @@ -# Developer Resources diff --git a/book/src/environment_variables.md b/book/src/environment_variables.md deleted file mode 100644 index 6888411..0000000 --- a/book/src/environment_variables.md +++ /dev/null @@ -1 +0,0 @@ -# Setting up environment variables diff --git a/book/src/go.md b/book/src/go.md deleted file mode 100644 index 452b575..0000000 --- a/book/src/go.md +++ /dev/null @@ -1 +0,0 @@ -# Go diff --git a/book/src/integrating_mesc.md b/book/src/integrating_mesc.md deleted file mode 100644 index 0df363c..0000000 --- a/book/src/integrating_mesc.md +++ /dev/null @@ -1 +0,0 @@ -# Integrating MESC diff --git a/book/src/mesc_libraries.md b/book/src/mesc_libraries.md deleted file mode 100644 index 69293ba..0000000 --- a/book/src/mesc_libraries.md +++ /dev/null @@ -1 +0,0 @@ -# MESC Libraries diff --git a/book/src/mesc_overview.md b/book/src/mesc_overview.md deleted file mode 100644 index 53818cb..0000000 --- a/book/src/mesc_overview.md +++ /dev/null @@ -1,15 +0,0 @@ -# MESC Overview - -To get started as quickly as possible, see [Quickstart](./quickstart.md). - -To integrate MESC into an existing tool, see [Integrating MESC](./integrating_mesc.md). - -To create a MESC implementation in a new programming language, see [Implementing MESC](./implementing_mesc.md). - -To see information about each existing MESC implementation, see: -- [cli](./cli.md) -- [go](./go.md) -- [python](./python.md) -- [rust](./rust.md) -- [typescript](./typescript.md) - diff --git a/book/src/metadata.md b/book/src/metadata.md deleted file mode 100644 index 3366648..0000000 --- a/book/src/metadata.md +++ /dev/null @@ -1 +0,0 @@ -# Metadata diff --git a/book/src/overrides.md b/book/src/overrides.md deleted file mode 100644 index aea5e8c..0000000 --- a/book/src/overrides.md +++ /dev/null @@ -1 +0,0 @@ -# Overrides diff --git a/book/src/profiles.md b/book/src/profiles.md deleted file mode 100644 index 682bf7f..0000000 --- a/book/src/profiles.md +++ /dev/null @@ -1 +0,0 @@ -# Profiles diff --git a/book/src/python.md b/book/src/python.md deleted file mode 100644 index 4193ef4..0000000 --- a/book/src/python.md +++ /dev/null @@ -1 +0,0 @@ -# Python diff --git a/book/src/quickstart.md b/book/src/quickstart.md deleted file mode 100644 index 192f16c..0000000 --- a/book/src/quickstart.md +++ /dev/null @@ -1,40 +0,0 @@ -# Quickstart - -The quickest way to use MESC is -1) create a `mesc.json` config file -2) set the `MESC_PATH` environment variable to the path of this file - -You can create a `mesc.json` either 1) by using the interactive [MESC cli tool](https://github.com/paradigmxyz/mesc/tree/main/cli) (install using `cargo install mesc_cli`) or 2) by modifying the template below: - -```json -{ - "mesc_version": "MESC 1.0", - "default_endpoint": "local_ethereum", - "network_defaults": { - "1": "local_ethereum" - }, - "network_names": {}, - "endpoints": { - "local_ethereum": { - "name": "local_ethereum", - "url": "http://localhost:8545", - "chain_id": "1", - "endpoint_metadata": {} - } - }, - "profiles": { - "xyz": { - "name": "xyz", - "default_endpoint": "local_ethereum", - "network_defaults": { - "1": "local_ethereum" - }, - "profile_metadata": {}, - "use_mesc": true - } - }, - "global_metadata": {} -} -``` - -Configuration should follow the MESC [specification](https://github.com/paradigmxyz/mesc/blob/main/SPECIFICATION.md). diff --git a/book/src/rust.md b/book/src/rust.md deleted file mode 100644 index 2f1d5ef..0000000 --- a/book/src/rust.md +++ /dev/null @@ -1 +0,0 @@ -# Rust diff --git a/book/src/setting_up_mesc.md b/book/src/setting_up_mesc.md deleted file mode 100644 index a33fbf0..0000000 --- a/book/src/setting_up_mesc.md +++ /dev/null @@ -1 +0,0 @@ -# Basic MESC Usage diff --git a/book/src/typescript.md b/book/src/typescript.md deleted file mode 100644 index 42c9775..0000000 --- a/book/src/typescript.md +++ /dev/null @@ -1 +0,0 @@ -# Typescript diff --git a/cli/README.md b/cli/README.md index 4e5d422..0ce1e2a 100644 --- a/cli/README.md +++ b/cli/README.md @@ -13,6 +13,8 @@ The most important cli subcommands: View help for each subcommand by typing `mesc [SUBCOMMAND] --help` +![basics](https://github.com/paradigmxyz/mesc/assets/7907648/2f84d90b-9cfd-42fd-89f1-bd35949e1c14) + ## Contents - [Installation](#installation) - [Example Usage](#example-usage) @@ -71,25 +73,36 @@ mesc endpoint goerli --json ## Reference +Show in terminal by typing `mesc --help`: + ``` -Utility for creating and managing MESC RPC configurations +command line interface for creating, loading, and modifying MESC configuration data Usage: mesc Commands: - setup Create new configuration or modify existing configuration - status Print status of configuration - ls Print list of endpoints - defaults Print list of defaults + setup Create or modify config interactively + import Modify config by importing from file or other source + set Modify config by setting specific values ping Ping endpoints and fetch metadata + defaults Print list of defaults endpoint Print endpoint + help Print help + ls Print list of endpoints metadata Print metadata + status Print status of configuration url Print endpoint URL - help Print this message or the help of the given subcommand(s) Options: -h, --help Print help -V, --version Print version + +Help topics: (print these with mesc help ) + env Environmental variables + python Python interface + rust Rust interface + schema Schemas of configs, endpoints, and profiles + setup How to set up MESC ``` - If an endpoint is omitted, use the default endpoint diff --git a/book/README.md b/docs/README.md similarity index 92% rename from book/README.md rename to docs/README.md index afa68bc..d0ff07f 100644 --- a/book/README.md +++ b/docs/README.md @@ -1,7 +1,7 @@ # MESC User Guide -This is the user guide for MESC. See table of contents in [Summary](SUMMARY.md). +This is the user guide for MESC. See table of contents in [Summary](src/SUMMARY.md). ## Usage diff --git a/docs/book.toml b/docs/book.toml new file mode 100644 index 0000000..b2c8396 --- /dev/null +++ b/docs/book.toml @@ -0,0 +1,11 @@ +[book] +authors = ["sslivkoff"] +language = "en" +multilingual = false +src = "src" +title = "MESC User Guide" +description = "A specification for how crypto tools configure their RPC endpoints" + +[output.html] +git-repository-url = "https://github.com/paradigmxyz/mesc" +edit-url-template = "https://github.com/paradigmxyz/mesc/edit/main/docs/{path}" diff --git a/docs/demos/autocomplete.tape b/docs/demos/autocomplete.tape new file mode 100644 index 0000000..b5c808b --- /dev/null +++ b/docs/demos/autocomplete.tape @@ -0,0 +1,29 @@ +Output autocomplete.gif +Set FontSize 26 +Set Width 900 +Set Height 450 + +# setup +Hide +Type "mesc setup" +Enter +Sleep 500ms +Enter +Type "f" +Enter +Sleep 1 +Enter +Show + +Sleep 1.5s +Type@250ms "arbi" +Sleep 3s +Backspace 4 +Sleep 1s +Type@250ms "opti" +Sleep 3s +Backspace 4 +Sleep 1s +Type@250ms "zora" +Sleep 3s +Enter diff --git a/docs/demos/basics.tape b/docs/demos/basics.tape new file mode 100644 index 0000000..0c93223 --- /dev/null +++ b/docs/demos/basics.tape @@ -0,0 +1,50 @@ +Output basics.gif +Set FontSize 26 +Set Width 1200 +Set Height 800 + +# start mesc setup +Type "mesc setup" +Sleep 400ms +Enter +Sleep 2000ms + +# scroll through the options +Down +Sleep 250ms +Down +Sleep 250ms +Down +Sleep 1000ms +Up +Sleep 250ms +Up +Sleep 250ms +Up +Sleep 500ms + +# start the endpoint add process +Enter +Sleep 2000ms +Type "https://eth.llamarpc.com" +Enter +Sleep 3500ms + +# go through the add options +Enter +Sleep 2000ms + + +# save and exit +Up +Sleep 1500ms +Up +Sleep 1500ms +Enter +Sleep 2500ms + +# perform ping +Type "mesc ping" +Enter +Sleep 6000ms + diff --git a/docs/demos/tests.tape b/docs/demos/tests.tape new file mode 100644 index 0000000..6c4042e --- /dev/null +++ b/docs/demos/tests.tape @@ -0,0 +1,15 @@ +Output tests.gif +Set FontSize 19 +Set Width 1200 +Set Height 800 + + +Hide +Type "cd ~/repos/mesc/tests" +Enter +Type "clear" +Enter +Show +Type "pytest -n 8" +Enter +Sleep 25s diff --git a/book/src/SUMMARY.md b/docs/src/SUMMARY.md similarity index 51% rename from book/src/SUMMARY.md rename to docs/src/SUMMARY.md index 120569e..199505f 100644 --- a/book/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -1,29 +1,23 @@ # MESC User Guide - [MESC Overview](./mesc_overview.md) - - - -- [Basic MESC Usage]() - [Quickstart](./quickstart.md) - - [Creating a config](./creating_a_config.md) - - [Environment variables](./environment_variables.md) + - [What is MESC?](./what_is_mesc.md) + - [Why MESC?](./why_mesc.md) + - [Roadmap](./roadmap.md) +- [Using MESC](./using_mesc.md) + - [Setting up MESC](./setup.md) - [Profiles](./profiles.md) - [Metadata](./metadata.md) - [Overrides](./overrides.md) - - - -- [Developer Resources]() + - [Queries](./queries.md) +- [Developer Resources](./developer_resources.md) - [Integrating MESC](./integrating_mesc.md) - [Implementing MESC](./implementing_mesc.md) - - - -- [MESC Libraries]() + - [MESC Tests](./mesc_tests.md) +- [MESC Libraries](./libraries.md) - [CLI](./cli.md) - [Go](./go.md) - [Python](./python.md) - [Rust](./rust.md) - - [Typescript](./typescript.md) - + - [TypeScript](./typescript.md) diff --git a/docs/src/cli.md b/docs/src/cli.md new file mode 100644 index 0000000..f7a9c1c --- /dev/null +++ b/docs/src/cli.md @@ -0,0 +1 @@ +{{#include ../../cli/README.md}} diff --git a/docs/src/developer_resources.md b/docs/src/developer_resources.md new file mode 100644 index 0000000..a6ce921 --- /dev/null +++ b/docs/src/developer_resources.md @@ -0,0 +1,8 @@ +# Developer Resources + +The MESC specification and its reference implementations are developed in the [github repository](https://github.com/paradigmxyz/mesc). +- For information about integrating MESC into an existing tool, see [Integrating MESC](./integrating_mesc.md). +- For information about implementing a new MESC client, see [Implementing MESC](./implementing_mesc.md). +- For information about running MESC tests, see [MESC Test README](https://github.com/paradigmxyz/mesc/tree/main/tests). +- For information about building these docs, see [here](https://github.com/paradigmxyz/mesc/tree/main/book). + diff --git a/docs/src/go.md b/docs/src/go.md new file mode 100644 index 0000000..18dfaa7 --- /dev/null +++ b/docs/src/go.md @@ -0,0 +1 @@ +{{#include ../../go/README.md}} diff --git a/book/src/implementing_mesc.md b/docs/src/implementing_mesc.md similarity index 61% rename from book/src/implementing_mesc.md rename to docs/src/implementing_mesc.md index a8d6762..97bc6c7 100644 --- a/book/src/implementing_mesc.md +++ b/docs/src/implementing_mesc.md @@ -4,13 +4,20 @@ One of MESC's goals is to have an implementation for every programming language If you are creating a new MESC implementation, you may find the following useful: -1. The main functionality that a MESC implementation provides is the [Core MESC Interface](https://github.com/paradigmxyz/mesc/blob/main/SPECIFICATION.md#reference-implementation). This is a set of functions for reading whatever MESC data a user has configured on their system. +1. The main functionality that a MESC implementation provides is the [core MESC interface](https://github.com/paradigmxyz/mesc/blob/main/SPECIFICATION.md#reference-implementation). This is a set of functions for reading whatever MESC data a user has configured on their system. 2. The ability to **write** MESC configurations is useful, but should be considered a secondary goal. Users already have the ability to create MESC configurations either by 1) editing JSON by hand, 2) editing JSON programmatically, or 3) using the interactive [MESC cli tool](https://github.com/paradigmxyz/mesc/tree/main/cli). 3. A MESC implementation's compliance to the specification can be checked using the language-agnostic MESC test suite. Passing the test suite means that an implementation is complete. More details on the test suite can be found [here](https://github.com/paradigmxyz/mesc/tree/main/tests). -4. It is desirable to use the same names, types, and behaviors across each MESC implementation. This increases interoperability and makes MESC easier to learn and use. However it is also desirable to obey the common convetions of each programming language. Each MESC implementation must find a balance between language-agnostic conventions vs language-specific conventions. +4. It is desirable to use the same names, types, and behaviors across each MESC implementation. This increases interoperability and makes MESC easier to learn and use. However it is also desirable to obey the common conventions of each programming language. Each MESC implementation must find a balance between language-agnostic conventions vs language-specific conventions. 5. If parts of the MESC specification are confusing or difficult to implement, it may be helpful to look at existing implementations. These currently exist for [python](https://github.com/paradigmxyz/mesc/tree/main/python) and [rust](https://github.com/paradigmxyz/mesc/tree/main/rust). + +## Implementation Checklist + +1. Implement the [core MESC interface](https://paradigmxyz.github.io/mesc/queries.html) functions. These functions should have the same behavior in each implementation. +2. Create an adapter to run the [MESC test suite](https://github.com/paradigmxyz/mesc/tree/main/tests). Passing these tests means the implementation is fully compliant with the MESC specification. +3. Add an entry to the [generate_network_names.py](https://github.com/paradigmxyz/mesc/blob/main/python/generate_network_names.py) script. This script creates a native language code file for mapping between network names and chain id's using the standard [ethereum-lists/chains](https://github.com/ethereum-lists/chains) repository. + diff --git a/docs/src/integrating_mesc.md b/docs/src/integrating_mesc.md new file mode 100644 index 0000000..c448103 --- /dev/null +++ b/docs/src/integrating_mesc.md @@ -0,0 +1,60 @@ +# Integrating MESC + +MESC is designed to be easy to integrate into any existing tool in a backward-compatible manner. + +MESC integration patterns can be designed so that they only affect users that have opted-in to MESC, while leaving other users unaffected. + +Examples below are shown in python but work nearly identically for each language. + +## Workflow for getting the default RPC endpoint + +Let's say that an existing tool named `xyz` currently gets its default RPC endpoint from an environment variable `ETH_RPC_URL` like so: + +```python +def get_default_rpc_url() -> str | None: + return os.environ.get('ETH_RPC_URL') +``` + +MESC can be integrated using a few lines of code: + +```python +import mesc + +def get_default_rpc_url() -> str | None: + if mesc.is_mesc_enabled(): + endpoint = mesc.get_default_endpoint(profile='xyz') + if endpoint is not None: + return endpoint['url'] + return os.environ.get('ETH_RPC_URL') +``` + +This new function loads the MESC default endpoint for users that have opted-in to MESC. But it falls back to using `ETH_RPC_URL` if MESC is not enabled or MESC does not have a default endpoint set. + +Using `profile='xyz'` is optional, but it allows users to set custom settings for the `xyz` tool instead of using the global settings. + +## Workflow for letting users select an RPC endpoint + +Let's say that an existing tool named `xyz` currently lets users choose an RPC endpoint using an `-r` input argument. Users might use the tool in a similar manner to `xyz -r https://eth.llamarpc.com` or `xyz -r localhost:8545`. + +If we add an extra parsing step for the user input, we can allow the user to select from any endpoint inside the MESC configuration by name, by network name, or by chain id. Using a pattern like this: + +```python +def get_endpoint_url(user_input: str) -> str: + if mesc.is_mesc_enabled(): + endpoint = mesc.get_endpoint_by_query(user_input) + if endpoint is not None: + return endpoint['url'] + return user_input + +# ... + +url = get_endpoint_url(user_input) +``` + +Then users will be able to do any of the following + +- `xyz -r localhost:8545` (use a url) +- `xyz -r llamanodes_goerli` (use the endpoint named `llamanodes_goerli`) +- `xyz -r 5` (use the default endpoint for network with chain id `5`) +- `xyz -r goerli` (use the default endpoint for the network named `goerli`) + diff --git a/docs/src/libraries.md b/docs/src/libraries.md new file mode 100644 index 0000000..f40a501 --- /dev/null +++ b/docs/src/libraries.md @@ -0,0 +1,13 @@ +# MESC Libraries + +MESC aims to have an implementation for every common language in the cryptocurrency ecosystem. + +Implementations currently exist for: +- [CLI](./cli.md) +- [Go](./go.md) +- [Python](./python.md) +- [Rust](./rust.md) +- [TypeScript](./typescript.md) + + +If you want to create a MESC implementation for a new language, see [implementing MESC](./implementing_mesc.md). diff --git a/docs/src/mesc_overview.md b/docs/src/mesc_overview.md new file mode 100644 index 0000000..dfb3f51 --- /dev/null +++ b/docs/src/mesc_overview.md @@ -0,0 +1,18 @@ +# MESC Overview + +To **get started quickly**, see [Quickstart](./quickstart.md). + +To learn **what MESC is**, see [What is MESC?](./what_is_mesc.md). + +To learn the **motivation** behind MESC, see [Why MESC?](./why_mesc.md). + +To **integrate** MESC into an existing tool, see [Integrating MESC](./integrating_mesc.md). + +To **implement** MESC in a new programming language, see [Implementing MESC](./implementing_mesc.md). + +For information about existing MESC implementations, see: +- [CLI](./cli.md) +- [Go](./go.md) +- [Python](./python.md) +- [Rust](./rust.md) +- [TypeScript](./typescript.md) diff --git a/docs/src/mesc_tests.md b/docs/src/mesc_tests.md new file mode 100644 index 0000000..ed1ae05 --- /dev/null +++ b/docs/src/mesc_tests.md @@ -0,0 +1,2 @@ + +{{#include ../../tests/README.md}} diff --git a/docs/src/metadata.md b/docs/src/metadata.md new file mode 100644 index 0000000..095816f --- /dev/null +++ b/docs/src/metadata.md @@ -0,0 +1,43 @@ +# Metadata + +In a MESC configuration, the `global_metadata`, `profile_metadata`, and `endpoint_metadata` fields allow for optional or idiosyncratic metadata to be stored alongside the core RPC data. + +Tools using MESC can choose to ignore these fields. + + +## Metadata fields + +Contents of MESC metadata is only loosely specified. This is intentional to allow for some degree of future-proofing. It enables MESC to handle use-cases that are either unanticipated or highly-specific to a given tool. + + +## Examples + +**Endpoint metadata** + +| key | value type | description | examples | +| --- | --- | --- | --- | +| `rate_limit_rps` | `int` or `float` | ratelimit in requests per second | `250` | +| `rate_limit_cups` | `int` or `float` | ratelimit in CUPS | `1000` | +| `rate_limit_per_method` | `Mapping[str, int or float]` | ratelimit in RPS for each method | `{"trace_block": 200}` | +| `api_key` | `str` | api key | `a2798f237a2398rf7` | +| `jwt_secret` | `str` | jwt secret | | +| `host` | `str` | name of provider host | `"llamanodes"`, `"alchemy"`, `"quicknode"`, `"localhost"` +| `ecosystem` | `str` | ecosystem of chain, (e.g. relates mainnets to testnets) | `"ethereum"`, `"polygon"` | +| `node_client` | `str` | versioned node client | `erigon/2.48.1/linux-amd64/go1.20.5` `reth/v0.1.0-alpha.10-7b781eb60/x86_64-unknown-linux-gnu` | +| `namespaces` | `Sequence[str]` | RPC name spaces enabled for endpoint | `["eth", "trace, "debug"]` +| `explorer` | `str` | block explorer url | `https://etherscan.io` +| `location` | `str` | geographic region | `Paris, France` | +| `cloud_region` | `str` | cloud provider region | `aws-us-east-1a` | +| `labels` | `Sequence[str]` | tags | `private_mempool`, `cache`, `archive`, `consensus_layer`, `execution_layer`, `validator`, `ephemeral` | + +**Global Metadata** and **Profile Metadata** + +| key | value type | description | examples | +| --- | --- | --- | --- | +| `last_modified_by` | `str` | versioned tool used to create configuration | `mesc__1.0` | +| `last_modified_time` | `int` | timestamp of config modification | `1700200462` | +| `creation_time` | `int` | timestamp of config creation | `1700200462` | +| `api_keys` | `Mapping[str, str]` | API keys to RPC-related services | `{"etherscan": "abc123"}` | +| `groups` | `Mapping[str, Sequence[str]]` | groupings of endpoints, mapping of group name to list of endpoint names | `{"load_balancer": ["alchemy_optimism", "quicknode_optimism"]}` | +| `conceal` | `bool` | whether tool should avoid casually revealing private RPC url's unprompted | `true` | + diff --git a/docs/src/overrides.md b/docs/src/overrides.md new file mode 100644 index 0000000..3f33383 --- /dev/null +++ b/docs/src/overrides.md @@ -0,0 +1,58 @@ +# Overrides + +Overrides are a way to quickly modify a MESC configuration without needing to modify any files. + +Each override is an environment variable that overrides a specific MESC configuration key. + +Each override uses a syntax that is quick and easy to write by hand. + +## Example usage + +The `MESC_DEFAULT_ENDPOINT` override changes the default endpoint. + +#### Use in a script + +Sometimes it might be useful tweak a MESC config for a shell script. This can be achieved by inserting the MESC overrides into the script: + +```bash +#!/usr/bin/env bash + +export MESC_DEFAULT_ENDPOINT=local_goerli + +# ...rest of script that does RPC things +``` + +#### Prepending syntax + +Adding `VAR_NAME=VAR_VALUE` before a cli command will set an environment variable for just that command. + +So if before the default url is this: + +```bash +mesc url +> https://eth.llamarpc.com +``` + +Adding the override before the command will change the default url: + +```bash +MESC_DEFAULT_ENDPOINT=local_goerli mesc url +> localhost:8545 +``` + +This syntax works for any cli program, not just the `mesc` cli tool. + +## List of overrides + +Every type of information within a MESC configuration can be modified using overrides: + +| override variable | value syntax | example | +| --- | --- | --- | +| `MESC_DEFAULT_ENDPOINT` | url, endpoint name, or network name | `localhost:9999` | +| `MESC_NETWORK_DEFAULTS` | space-separated pairs of `=` | `5=alchemy_optimism 1=local_mainnet` | +| `MESC_NETWORK_NAMES` | space-separated pairs of `=` | `zora=7777777` | +| `MESC_ENDPOINTS` | space-separated items of `[[:]=]` | `alchemy_optimism=https://alchemy.com/fjsj local_goerli:5=localhost:8545` | +| `MESC_PROFILES` | space-separated pairs of `.[.` | `foundry.default_endpoint=local_goerli foundry.network_defaults.5=alchemy_optimism` | +| `MESC_GLOBAL_METADATA` | JSON formatted global metadata | `{}` | +| `MESC_ENDPOINT_METADATA` | JSON mapping of `{"endpoint_name": {}}` | `{}` | + diff --git a/docs/src/profiles.md b/docs/src/profiles.md new file mode 100644 index 0000000..d942943 --- /dev/null +++ b/docs/src/profiles.md @@ -0,0 +1,32 @@ +# Profiles + +Profiles are a way for each tool to customize its own MESC settings. + +Profiles allow each tool to: +- set its own default endpoint +- set its own default endpoints for each network +- override global metadata with its own metadata +- avoid using MESC for that tool without disabling MESC globally + +## Profiles are an optional feature + +If a MESC query does not specify a profile, the global configuration values are used. + +If a MESC query specifies a profile, but that profile does not exist or does not specify the relevant information, MESC will fallback to using global configuration values. + +## Setting up a profile + +The easiest way to create a profile is by using the interactive `mesc` cli tool, using the `mesc setup` subcommand. + +Alternatively, you can manually add a new `Profile` to the `profiles` key inside your `mesc.json`. The following is a template `Profile`: + +```json +{ + "name": "PROFILE_NAME", + "default_endpoint": null, + "network_defaults": {}, + "profile_metadata": {}, + "use_mesc": true +} +``` + diff --git a/docs/src/python.md b/docs/src/python.md new file mode 100644 index 0000000..6bb05a2 --- /dev/null +++ b/docs/src/python.md @@ -0,0 +1 @@ +{{#include ../../python/README.md}} diff --git a/docs/src/queries.md b/docs/src/queries.md new file mode 100644 index 0000000..e909e03 --- /dev/null +++ b/docs/src/queries.md @@ -0,0 +1,18 @@ +# Querying MESC data + +Each MESC implementation provides the same set of 7 functions for querying MESC data. + +The behavior of these functions is the same across languages. + +| function | output type | description | example call | +| --- | --- | --- | --- | +| `is_mesc_enabled()` | `bool` | return whether MESC is enabled | `is_mesc_enabled()` | +| `get_default_endpoint()` | `Endpoint` or `None` | get default MESC endpoint | `get_default_endpoint(profile='xyz')` | +| `get_endpoint_by_network()` | `Endpoint` or `None` | get default endpoint for network | `get_endpoint_by_network(5, profile='xyz')` | +| `get_endpoint_by_name()` | `Endpoint` or `None` | get endpoint by name | `get_endpoint_by_name('local_goerli')` | +| `get_endpoint_by_query()` | `Endpoint` or `None` | get endpoint for user input query | `get_endpoint_by_query(user_str, profile='xyz')` | +| `find_endpoints()` | `Sequence[Endpoint]` | find endpoint that match input criteria | `find_endpoints(chain_id=5)` | +| `get_global_metadata()` | `Mapping[str, Any]` | get non-endpoint metadata | `get_global_metadata(profile='xyz')` | + +The `profile` argument is optional for each function (it allows users to customize the settings for each tool, see [Profiles](./profiles.md) for details). + diff --git a/docs/src/quickstart.md b/docs/src/quickstart.md new file mode 100644 index 0000000..cbe0e65 --- /dev/null +++ b/docs/src/quickstart.md @@ -0,0 +1,57 @@ +# Quickstart + +The quickest way to use MESC is +1) create a `mesc.json` config file +2) set the `MESC_PATH` environment variable to the path of this file + +## Creating a config file + +You can create a `mesc.json` by one of two ways: +1) use the interactive [MESC cli tool](https://github.com/paradigmxyz/mesc/tree/main/cli) (install using `cargo install mesc_cli` and run `mesc setup`) +2) modify the template below: + +```json +{ + "mesc_version": "MESC 1.0", + "default_endpoint": "local_ethereum", + "network_defaults": { + "1": "local_ethereum" + }, + "network_names": {}, + "endpoints": { + "local_ethereum": { + "name": "local_ethereum", + "url": "http://localhost:8545", + "chain_id": "1", + "endpoint_metadata": {} + } + }, + "profiles": { + "xyz": { + "name": "xyz", + "default_endpoint": "local_ethereum", + "network_defaults": { + "1": "local_ethereum" + }, + "profile_metadata": {}, + "use_mesc": true + } + }, + "global_metadata": {} +} +``` + +The structure of the config must follow the MESC [specification](https://github.com/paradigmxyz/mesc/blob/main/SPECIFICATION.md). + +Installing the `mesc` cli on some linux distributions may require installing ssl libraries (e.g. `sudo apt-get install pkg-config libssl-dev` on ubunutu) + +## Setting environment variables + +The typical way to set environment variables is in your shell configuration files: `~/.bashrc`, `~.profile`, and/or `~/.bash_profile`. Including this line in those files will enable MESC: + +```bash +export MESC_PATH=/path/to/your/mesc.json +``` + +You can avoid editing these files yourself by running the MESC setup tool (`mesc setup`) as specified above. It will give you the option to automatically edit your shell files. + diff --git a/docs/src/roadmap.md b/docs/src/roadmap.md new file mode 100644 index 0000000..e2b7a37 --- /dev/null +++ b/docs/src/roadmap.md @@ -0,0 +1,6 @@ +# Roadmap + +Once the MESC specification reaches version 1.0, it will become ossified forever. This will maximize forward- and backward-compatibility between MESC integrations. Client libraries for reading or writing MESC configurations might continue development, but the underlying MESC specification will not change. + +MESC currently has implementations for CLI, python, and rust. Implementations for go and typescript are coming soon. If there is another language you have interest in bringing MESC to an additional programming language or environment, feel free to share on the [issue tracker](https://github.com/paradigmxyz/mesc). + diff --git a/docs/src/rust.md b/docs/src/rust.md new file mode 100644 index 0000000..f3b12a4 --- /dev/null +++ b/docs/src/rust.md @@ -0,0 +1 @@ +{{#include ../../rust/README.md}} diff --git a/docs/src/setup.md b/docs/src/setup.md new file mode 100644 index 0000000..eabb06b --- /dev/null +++ b/docs/src/setup.md @@ -0,0 +1,29 @@ + +# Setting up MESC + +## Basic setup + +MESC becomes enabled by setting one or more environment variables. + +In the simplest case, only one variable necessary: `MESC_PATH` is set to the path of a `mesc.json` config file. + +As described in the [quickstart](./quickstart.md), the `mesc.json` file is usually created using either 1) the interactive `mesc setup` command, or 2) copying from a starter template. The quickstart guide also describes how to set environment variables in your terminal shell. + +## Alternative setup without a `mesc.json` + +Sometimes it is convenient to configure a system without editing any files (e.g. inside a container, or when creating lots of unit tests, or in a low-privilege environment). + +This can be accomplished with MESC by setting the `MESC_ENV` variable instead of the `MESC_PATH` variable. `MESC_ENV` should simply contain the JSON content of a MESC configuration. + +If both `MESC_PATH` and `MESC_ENV` are set, you can select which one to use by setting `MESC_MODE` to either `PATH` or `ENV`. `MESC_PATH` takes precedence over `MESC_ENV` if `MESC_MODE` is not set. + +## Disabling MESC + +MESC can be disabled by either 1) unsetting all `MESC_*` variables, or 2) setting `MESC_MODE=DISABLED`. + +If MESC is disabled, the `is_mesc_disabled()` function will return `false` and all MESC querying functions will return an error (depending on language). + +## Overrides + +MESC also uses environment variables for overrides. See the [overrides](overrides.md) section for details. + diff --git a/docs/src/typescript.md b/docs/src/typescript.md new file mode 100644 index 0000000..3a765c6 --- /dev/null +++ b/docs/src/typescript.md @@ -0,0 +1 @@ +{{#include ../../typescript/README.md}} diff --git a/docs/src/using_mesc.md b/docs/src/using_mesc.md new file mode 100644 index 0000000..cd9223a --- /dev/null +++ b/docs/src/using_mesc.md @@ -0,0 +1,7 @@ +# Using MESC + +- To set MESC up, see [Setup up MESC](./setting_up_mesc.md) +- To use different MESC settings for different tools, see [Profiles](./profiles.md) +- To use MESC for tracking miscellaneous metadata, see [Metadata](./metadata.md) +- To quickly override MESC settings without editing files, see [Overrides](./overrides.md) + diff --git a/docs/src/what_is_mesc.md b/docs/src/what_is_mesc.md new file mode 100644 index 0000000..7859f80 --- /dev/null +++ b/docs/src/what_is_mesc.md @@ -0,0 +1,24 @@ +# What is MESC? + +MESC (Multiple Endpoint Shared Configuration) is a standardized approach for configuring RPC endpoints. Using MESC, a user creates a single RPC config that is shared by all RPC tools on their system. + +## Design Goals + +MESC has two main design goals: + +1. make it easy to share RPC configuration data across tools, languages, and environments +2. make it easy to manage the configuration of a large number of RPC endpoints + +MESC also has many secondary goals. It aims to be a solution that: +- allows specifying multiple providers for multiple chains +- allows selection of a default endpoint for each chain +- allows using either environment variables or config files +- is a single source of truth across multiple tools +- is OS-agnostic, using no OS-specific features +- is language-agnostic, using no language-specific features +- is backwards compatible with previous solutions + +## MESC is opt-in + +MESC is an **opt-in** standard: MESC is only enabled if a user has set a MESC-specific environment variable in their environment. This maximizes backward-compatiblity for existing tools that want to integrate MESC: If a user has not opted-in to MESC then simply fall back to the existing configuration method. + diff --git a/docs/src/why_mesc.md b/docs/src/why_mesc.md new file mode 100644 index 0000000..822a786 --- /dev/null +++ b/docs/src/why_mesc.md @@ -0,0 +1,26 @@ +# Why MESC? + +Between mainnet, testnets, chainforks, rollups, and alternative L1's, modern crypto tools must manage the configuration of multiple RPC endpoints. This configuration process is not standardized across tools. + +The most common approach for configuring RPC endpoint information is the `ETH_RPC_URL` environment variable (dapptools, forge, heimdall, checkthechain). However, this is not a formal standard and many tools use other approaches. Furthermore, using `ETH_RPC_URL` can only specify a single provider for a single chain, and it cannot specify any provider metadata beyond the url. + +Instead it would be desirable to have a solution that: +- allows specifying multiple providers for multiple chains +- allows selection of a default endpoint for each chain +- allows using either environment variables or config files +- is a single source of truth across multiple tools +- is OS-agnostic, using no OS-specific features +- is language-agnostic, using no language-specific features +- is backwards compatible with previous solutions + +MESC aims to satisfy all of these constraints. + + +## As a developer, why should I integrate MESC into my tools? + +- **Easier Onboarding**. As soon as a user installs your tool, they will be able to use your tool with all of their configured networks. This eliminates one of the major setup steps for most RPC consuming tools. +- **Interoperability**. If you maintain multiple tools, or your tool has components in multiple languages, MESC will create a single, shared source of truth across all of these tool components. +- **Safety and Robustness**. MESC is thoroughly tested against a large number of config-related edge cases. In many cases it will be safer to user MESC than to create a configuration system from scratch. +- **Minimize maintenance burden**. Leaning on MESC to handle configuration means there is one less thing you need to maintain. You can spend your time on other things. +- **Developer Features**. If you need to develop or test your tool with multiple endpoints, the `mesc` CLI tools contains many useful developer features for managing endpoints. +- **Go config-free**. In some cases, adopting MESC means that your tool no longer needs its own config. You can store your tool's config data in MESC's metadata and then just use MESC for all config IO. diff --git a/go/README.md b/go/README.md index bf54c21..1e8d807 100644 --- a/go/README.md +++ b/go/README.md @@ -1,3 +1,21 @@ # Go MESC Implementation -[WIP] +This is a reference implementation of the Go MESC standard. + +## Installation + +To use this project within your Golang project, execute the following within your project: + +``` +go get github.com/paradigmxyz/mesc/go +``` + +## Example Usage + +// TODO: pending doc + +## Reference + +Refer to the function signatures defined in [endpoints.go](pkg/mesc/endpoints.go) for the list of available functions. + +Models are available in the [model](pkg/mesc/model) package. \ No newline at end of file diff --git a/go/go.mod b/go/go.mod new file mode 100644 index 0000000..d3617f1 --- /dev/null +++ b/go/go.mod @@ -0,0 +1,17 @@ +module github.com/paradigmxyz/mesc/go + +go 1.20 + +require ( + github.com/go-logr/logr v1.3.0 // indirect + github.com/go-task/slim-sprig v0.0.0-20230315185526-52ccab3ef572 // indirect + github.com/google/go-cmp v0.6.0 // indirect + github.com/google/pprof v0.0.0-20210407192527-94a9f03dee38 // indirect + github.com/onsi/ginkgo/v2 v2.15.0 // indirect + github.com/onsi/gomega v1.31.0 // indirect + golang.org/x/net v0.19.0 // indirect + golang.org/x/sys v0.15.0 // indirect + golang.org/x/text v0.14.0 // indirect + golang.org/x/tools v0.16.1 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect +) diff --git a/go/go.sum b/go/go.sum new file mode 100644 index 0000000..71b2f92 --- /dev/null +++ b/go/go.sum @@ -0,0 +1,34 @@ +github.com/chzyer/logex v1.1.10/go.mod h1:+Ywpsq7O8HXn0nuIou7OrIPyXbp3wmkHB+jjWRnGsAI= +github.com/chzyer/readline v0.0.0-20180603132655-2972be24d48e/go.mod h1:nSuG5e5PlCu98SY8svDHJxuZscDgtXS6KTTbou5AhLI= +github.com/chzyer/test v0.0.0-20180213035817-a1ea475d72b1/go.mod h1:Q3SI9o4m/ZMnBNeIyt5eFwwo7qiLfzFZmjNmxjkiQlU= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/go-logr/logr v1.3.0 h1:2y3SDp0ZXuc6/cjLSZ+Q3ir+QB9T/iG5yYRXqsagWSY= +github.com/go-logr/logr v1.3.0/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY= +github.com/go-task/slim-sprig v0.0.0-20230315185526-52ccab3ef572 h1:tfuBGBXKqDEevZMzYi5KSi8KkcZtzBcTgAUUtapy0OI= +github.com/go-task/slim-sprig v0.0.0-20230315185526-52ccab3ef572/go.mod h1:9Pwr4B2jHnOSGXyyzV8ROjYa2ojvAY6HCGYYfMoC3Ls= +github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI= +github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY= +github.com/google/pprof v0.0.0-20210407192527-94a9f03dee38 h1:yAJXTCF9TqKcTiHJAE8dj7HMvPfh66eeA2JYW7eFpSE= +github.com/google/pprof v0.0.0-20210407192527-94a9f03dee38/go.mod h1:kpwsk12EmLew5upagYY7GY0pfYCcupk39gWOCRROcvE= +github.com/ianlancetaylor/demangle v0.0.0-20200824232613-28f6c0f3b639/go.mod h1:aSSvb/t6k1mPoxDqO4vJh6VOCGPwU4O0C2/Eqndh1Sc= +github.com/onsi/ginkgo/v2 v2.15.0 h1:79HwNRBAZHOEwrczrgSOPy+eFTTlIGELKy5as+ClttY= +github.com/onsi/ginkgo/v2 v2.15.0/go.mod h1:HlxMHtYF57y6Dpf+mc5529KKmSq9h2FpCF+/ZkwUxKM= +github.com/onsi/gomega v1.31.0 h1:54UJxxj6cPInHS3a35wm6BK/F9nHYueZ1NVujHDrnXE= +github.com/onsi/gomega v1.31.0/go.mod h1:DW9aCi7U6Yi40wNVAvT6kzFnEVEI5n3DloYBiKiT6zk= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= +golang.org/x/net v0.19.0 h1:zTwKpTd2XuCqf8huc7Fo2iSy+4RHPd10s4KzeTnVr1c= +golang.org/x/net v0.19.0/go.mod h1:CfAk/cbD4CthTvqiEl8NpboMuiuOYsAr/7NOjZJtv1U= +golang.org/x/sys v0.0.0-20191204072324-ce4227a45e2e/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.15.0 h1:h48lPFYpsTvQJZF4EKyI4aLHaev3CxivZmv7yZig9pc= +golang.org/x/sys v0.15.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= +golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ= +golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU= +golang.org/x/tools v0.16.1 h1:TLyB3WofjdOEepBHAU20JdNC1Zbg87elYofWYAY5oZA= +golang.org/x/tools v0.16.1/go.mod h1:kYVVN6I1mBNoB1OX+noeBjbRk4IUEPa7JJ+TJMEooJ0= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/go/pkg/mesc/endpoint/criteria/config.go b/go/pkg/mesc/endpoint/criteria/config.go new file mode 100644 index 0000000..cc72bac --- /dev/null +++ b/go/pkg/mesc/endpoint/criteria/config.go @@ -0,0 +1,34 @@ +package mesc + +import "github.com/paradigmxyz/mesc/go/pkg/mesc/model" + +// EndpointFindCriteriaConfig describes the criteria to be used with FindEndpoints +type EndpointFindCriteriaConfig struct { + chainID *model.ChainID + nameContains *string + urlContains *string +} + +// FindEndpointsCriteria provides a means of customizing the finding criteria for endpoints in FindEndpoints. +type FindEndpointsCriteria func(*EndpointFindCriteriaConfig) + +// HasChainID will find endpoints that contain endpoint metadata for the given chain ID. +func HasChainID(chainID model.ChainID) FindEndpointsCriteria { + return func(e *EndpointFindCriteriaConfig) { + e.chainID = &chainID + } +} + +// NameContains describes a criteria to find endpoints whose name contains the given substring. +func NameContains(name string) FindEndpointsCriteria { + return func(e *EndpointFindCriteriaConfig) { + e.nameContains = &name + } +} + +// URLContains describes a criteria to find endpoints whose URLs contain the given substring. +func URLContains(url string) FindEndpointsCriteria { + return func(e *EndpointFindCriteriaConfig) { + e.urlContains = &url + } +} diff --git a/go/pkg/mesc/endpoint/io/serialization/example.test_json b/go/pkg/mesc/endpoint/io/serialization/example.test_json new file mode 100644 index 0000000..80505ab --- /dev/null +++ b/go/pkg/mesc/endpoint/io/serialization/example.test_json @@ -0,0 +1,62 @@ +{ + "mesc_version": "MESC 1.0", + "default_endpoint": "local_ethereum", + "network_defaults": { + "1": "local_ethereum" + }, + "network_names": { + "local_ethereum": "1" + }, + "endpoints": { + "local_ethereum": { + "name": "local_ethereum", + "url": "http://localhost:8545", + "chain_id": "1", + "endpoint_metadata": { + "rate_limit_rps": 250, + "rate_limit_cups": 1000, + "rate_limit_per_method": { + "trace_block": 200 + }, + "api_key": "a2798f237a2398rf7", + "jwt_secret": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.dyt0CoTl4WoVjAHI9Q_CwSKhl6d_9rhM3NrXuJttkao", + "host": "local", + "ecosystem": "ethereum", + "node_client": "reth/v0.1.0-alpha.10-7b781eb60/x86_64-unknown-linux-gnu", + "namespaces": ["eth", "trace", "debug"], + "explorer": "https://etherscan.io", + "location": "Paris, France", + "cloud_region": "aws-us-east-1a", + "labels": ["private_mempool", "cache", "archive"] + } + } + }, + "profiles": { + "xyz": { + "name": "xyz", + "default_endpoint": "local_ethereum", + "network_defaults": { + "1": "local_ethereum" + }, + "profile_metadata": { + "last_modified_by": "mesc__1.0", + "last_modified_time": 1705870535, + "creation_time": 1700200462, + "api_keys": { + "etherscan": "abc123" + }, + "groups": { + "load_balancer": [ + "alchemy_optimism", + "quicknode_optimism" + ] + }, + "conceal": true + }, + "use_mesc": true + } + }, + "global_metadata": { + "example_global_metadatum": "example-global-value" + } +} \ No newline at end of file diff --git a/go/pkg/mesc/endpoint/io/serialization/json.go b/go/pkg/mesc/endpoint/io/serialization/json.go new file mode 100644 index 0000000..9e1f0fb --- /dev/null +++ b/go/pkg/mesc/endpoint/io/serialization/json.go @@ -0,0 +1,145 @@ +package serialization + +import ( + "encoding/json" + "fmt" + "io" + + "github.com/paradigmxyz/mesc/go/pkg/mesc/model" +) + +// DeserializeJSON deserializes the JSON contained within the given io.Reader into a model.RPCConfig object. +// This does not apply any validations prescribed by the MESC specification. +func DeserializeJSON(reader io.Reader) (*model.RPCConfig, error) { + var jsonConfig *jsonRPCConfig + if decodeErr := json.NewDecoder(reader).Decode(&jsonConfig); decodeErr != nil { + return nil, fmt.Errorf("failed to decode MESC JSON: %w", decodeErr) + } + + return jsonConfig.toModel(), nil +} + +// DeserializeEndpointMetadataJSON deserializes the given representation of endpoint metadata mapped by endpoint name. +func DeserializeEndpointMetadataJSON(reader io.Reader) (map[string]model.EndpointMetadata, error) { + var endpointJSONMetadata map[string]*jsonEndpoint + if decodeErr := json.NewDecoder(reader).Decode(&endpointJSONMetadata); decodeErr != nil { + return nil, fmt.Errorf("failed to decode endpoint metadata JSON: %w", decodeErr) + } + + endpoints := make(map[string]model.EndpointMetadata, len(endpointJSONMetadata)) + for endpointName, endpointJSON := range endpointJSONMetadata { + endpoints[endpointName] = endpointJSON.toModel() + } + + return endpoints, nil +} + +func toOptionalChainID(v *string) *model.ChainID { + if v == nil { + return nil + } + + asModel := model.ChainID(*v) + return &asModel +} + +func toChainIDMap[V any](source map[string]V) map[model.ChainID]V { + if source == nil { + return nil + } + + copy := make(map[model.ChainID]V, len(source)) + for chainID, value := range source { + copy[model.ChainID(chainID)] = value + } + + return copy +} + +func toMappedChainID[K comparable](source map[K]string) map[K]model.ChainID { + if source == nil { + return nil + } + + copy := make(map[K]model.ChainID, len(source)) + for key, chainID := range source { + copy[key] = model.ChainID(chainID) + } + + return copy +} + +type jsonRPCConfig struct { + MESCVersion string `json:"mesc_version"` + DefaultEndpoint *string `json:"default_endpoint"` + NetworkDefaults map[string]string `json:"network_defaults"` + NetworkNames map[string]string `json:"network_names"` + Endpoints map[string]*jsonEndpoint + Profiles map[string]*jsonProfile + GlobalMetadata map[string]any `json:"global_metadata"` +} + +func (j *jsonRPCConfig) toModel() *model.RPCConfig { + networkDefaults := toChainIDMap(j.NetworkDefaults) + networkNames := toMappedChainID(j.NetworkNames) + + rpcConfig := &model.RPCConfig{ + MESCVersion: j.MESCVersion, + DefaultEndpoint: j.DefaultEndpoint, + NetworkDefaults: networkDefaults, + NetworkNames: networkNames, + GlobalMetadata: j.GlobalMetadata, + } + + if jsonEndpoints := j.Endpoints; jsonEndpoints != nil { + modelEndpoints := make(map[string]model.EndpointMetadata, len(jsonEndpoints)) + for endpointName, jsonEndpoint := range jsonEndpoints { + modelEndpoints[endpointName] = jsonEndpoint.toModel() + } + rpcConfig.Endpoints = modelEndpoints + } + + if jsonProfiles := j.Profiles; jsonProfiles != nil { + modelProfiles := make(map[string]model.Profile, len(jsonProfiles)) + for profileName, jsonProfile := range jsonProfiles { + modelProfiles[profileName] = jsonProfile.toModel() + } + rpcConfig.Profiles = modelProfiles + } + + return rpcConfig +} + +type jsonEndpoint struct { + Name string + URL string + ChainID *string `json:"chain_id"` + EndpointMetadata map[string]any `json:"endpoint_metadata"` +} + +func (j *jsonEndpoint) toModel() model.EndpointMetadata { + return model.EndpointMetadata{ + Name: j.Name, + URL: j.URL, + ChainID: toOptionalChainID(j.ChainID), + EndpointMetadata: j.EndpointMetadata, + } +} + +type jsonProfile struct { + Name string + DefaultEndpoint *string `json:"default_endpoint"` + NetworkDefaults map[string]string `json:"network_defaults"` + ProfileMetadata map[string]any `json:"profile_metadata"` + UseMESC bool `json:"use_mesc"` +} + +func (j *jsonProfile) toModel() model.Profile { + return model.Profile{ + Name: j.Name, + DefaultEndpoint: j.DefaultEndpoint, + NetworkDefaults: toChainIDMap(j.NetworkDefaults), + ProfileMetadata: j.ProfileMetadata, + UseMESC: j.UseMESC, + } +} diff --git a/go/pkg/mesc/endpoint/io/serialization/json_test.go b/go/pkg/mesc/endpoint/io/serialization/json_test.go new file mode 100644 index 0000000..5ec32db --- /dev/null +++ b/go/pkg/mesc/endpoint/io/serialization/json_test.go @@ -0,0 +1,82 @@ +package serialization_test + +import ( + "bytes" + _ "embed" + "time" + + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" + "github.com/onsi/gomega/types" + + "github.com/paradigmxyz/mesc/go/pkg/mesc/endpoint/io/serialization" + "github.com/paradigmxyz/mesc/go/pkg/mesc/model" +) + +//go:embed example.test_json +var exampleJSON string + +var _ = Describe("JSON Deserialization", func() { + It("successfully deserializes the example JSON", func() { + jsonReader := bytes.NewBufferString(exampleJSON) + rpcConfig, err := serialization.DeserializeJSON(jsonReader) + Expect(err).ToNot(HaveOccurred(), "deserializing the JSON should not fail") + + Expect(rpcConfig.MESCVersion).To(Equal("MESC 1.0"), "the MESC version should be deserialized correctly") + Expect(rpcConfig.DefaultEndpoint).ToNot(BeNil(), "there should be a default endpoint") + Expect(*rpcConfig.DefaultEndpoint).To(Equal("local_ethereum"), "the default endpoint should be correct") + Expect(rpcConfig.NetworkDefaults).To(HaveKeyWithValue(model.ChainID("1"), "local_ethereum"), "the network defaults should be deserialized") + Expect(rpcConfig.NetworkNames).To(HaveKeyWithValue("local_ethereum", model.ChainID("1")), "the network names should be deserialized") + Expect(rpcConfig.GlobalMetadata).To(And(HaveLen(1), HaveKeyWithValue("example_global_metadatum", "example-global-value")), "the global metadata should have been read in") + + // verify endpoints + Expect(rpcConfig.Endpoints).To(And(HaveLen(1), HaveKey("local_ethereum")), "the local_ethereum endpoint should be deserialized") + ethereumEndpoint := rpcConfig.Endpoints["local_ethereum"] + Expect(ethereumEndpoint.Name).To(Equal("local_ethereum"), "the endpoint name should be deserialized") + Expect(ethereumEndpoint.URL).To(Equal("http://localhost:8545"), "the endpoint URL should be deserialized") + Expect(ethereumEndpoint.ChainID).ToNot(BeNil(), "the chain ID should be present on the endpoint metadata") + Expect(*ethereumEndpoint.ChainID).To(Equal(model.ChainID("1")), "the chain ID should be deserialized") + // The actual verification of the metadata contents follows this by exercising helper methods + Expect(ethereumEndpoint.EndpointMetadata).To(HaveLen(13), "there should be 13 endpoint metadata elements") + + expectMatches("rate limit RPS", ethereumEndpoint.GetRateLimitRPS, BeNumerically("==", 250)) + expectMatches("rate limit CUPS", ethereumEndpoint.GetRateLimitCUPS, BeNumerically("==", 1000)) + expectMatches("method rate limit", func() (float64, bool) { + return ethereumEndpoint.GetMethodRateLimit("trace_block") + }, BeNumerically("==", 200)) + expectMatches("API key", ethereumEndpoint.GetAPIKey, Equal("a2798f237a2398rf7")) + expectMatches("JWT secret", ethereumEndpoint.GetJWTSecret, ContainSubstring("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9")) + expectMatches("host", ethereumEndpoint.GetHost, Equal("local")) + expectMatches("ecosystem", ethereumEndpoint.GetEcosystem, Equal("ethereum")) + expectMatches("node client", ethereumEndpoint.GetNodeClient, Equal("reth/v0.1.0-alpha.10-7b781eb60/x86_64-unknown-linux-gnu")) + expectMatches("namespaces", ethereumEndpoint.GetNamespaces, ConsistOf([]string{"debug", "eth", "trace"})) + expectMatches("explorer", ethereumEndpoint.GetExplorer, Equal("https://etherscan.io")) + expectMatches("location", ethereumEndpoint.GetLocation, Equal("Paris, France")) + expectMatches("cloud region", ethereumEndpoint.GetCloudRegion, Equal("aws-us-east-1a")) + expectMatches("labels", ethereumEndpoint.GetLabels, ConsistOf([]string{"archive", "cache", "private_mempool"})) + + // verify profiles + Expect(rpcConfig.Profiles).To(And(HaveLen(1), HaveKey("xyz")), "the xyz profile should be read in") + xyzProfile := rpcConfig.Profiles["xyz"] + Expect(xyzProfile.Name).To(Equal("xyz"), "the profile name should be correct") + Expect(xyzProfile.DefaultEndpoint).ToNot(BeNil(), "the profile should have a default endpoint") + Expect(*xyzProfile.DefaultEndpoint).To(Equal("local_ethereum"), "the profile should have the correct default endpoint") + Expect(xyzProfile.NetworkDefaults).To(And(HaveLen(1), HaveKeyWithValue(model.ChainID("1"), "local_ethereum")), "the profile should have the correct network defaults") + Expect(xyzProfile.UseMESC).To(BeTrue(), "the profile should have MESC enabled") + expectMatches("last modified by", xyzProfile.GetLastModifiedBy, Equal("mesc__1.0")) + expectMatches("last modified time", xyzProfile.GetLastModifiedTime, BeTemporally("==", time.Unix(1705870535, 0))) + expectMatches("creation time", xyzProfile.GetCreationTime, BeTemporally("==", time.Unix(1700200462, 0))) + expectMatches("API keys", xyzProfile.GetAPIKeys, And(HaveLen(1), HaveKeyWithValue("etherscan", "abc123"))) + expectMatches("load balancer groups", func() ([]string, bool) { + loadBalancerGroups, hasGroup := xyzProfile.GetEndpointNamesForGrouping("load_balancer") + return loadBalancerGroups, hasGroup + }, ConsistOf([]string{"alchemy_optimism", "quicknode_optimism"})) + expectMatches("conceal", xyzProfile.Conceal, BeTrue()) + }) +}) + +func expectMatches[V any](valueDescriptor string, getter func() (V, bool), valueMatcher types.GomegaMatcher) { + actualValue, hasValue := getter() + Expect(hasValue).To(BeTrue(), "%s should be present", valueDescriptor) + Expect(actualValue).To(valueMatcher, "%s should match", valueDescriptor) +} diff --git a/go/pkg/mesc/endpoint/io/serialization/serialization_suite_test.go b/go/pkg/mesc/endpoint/io/serialization/serialization_suite_test.go new file mode 100644 index 0000000..b933e64 --- /dev/null +++ b/go/pkg/mesc/endpoint/io/serialization/serialization_suite_test.go @@ -0,0 +1,13 @@ +package serialization_test + +import ( + "testing" + + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +func TestSerialization(t *testing.T) { + RegisterFailHandler(Fail) + RunSpecs(t, "Serialization Suite") +} diff --git a/go/pkg/mesc/endpoint/resolution/config.go b/go/pkg/mesc/endpoint/resolution/config.go new file mode 100644 index 0000000..ccd1e60 --- /dev/null +++ b/go/pkg/mesc/endpoint/resolution/config.go @@ -0,0 +1,26 @@ +package mesc + +import "github.com/paradigmxyz/mesc/go/pkg/mesc/model" + +// EndpointResolutionConfig describes configuration and context to be applied during endpoint resolution. +type EndpointResolutionConfig struct { + profile *string + rpcConfig *model.RPCConfig +} + +// EndpointResolutionOption describes a way of configuring the resolution of an endpoint +type EndpointResolutionOption func(*EndpointResolutionConfig) + +// WithProfile will configure endpoint resolution to resolve with the given profile enabled. +func WithProfile(profile string) EndpointResolutionOption { + return func(cfg *EndpointResolutionConfig) { + cfg.profile = &profile + } +} + +// WithRPCConfig will configure endpoint resolution to resolve from the given RPCConfig. +func WithRPCConfig(rpcConfig model.RPCConfig) EndpointResolutionOption { + return func(cfg *EndpointResolutionConfig) { + cfg.rpcConfig = &rpcConfig + } +} diff --git a/go/pkg/mesc/endpoints.go b/go/pkg/mesc/endpoints.go new file mode 100644 index 0000000..2277a98 --- /dev/null +++ b/go/pkg/mesc/endpoints.go @@ -0,0 +1,54 @@ +package mesc + +import ( + "context" + "errors" + + criteria "github.com/paradigmxyz/mesc/go/pkg/mesc/endpoint/criteria" + resolution "github.com/paradigmxyz/mesc/go/pkg/mesc/endpoint/resolution" + model "github.com/paradigmxyz/mesc/go/pkg/mesc/model" +) + +// FindEndpoints will find all endpoint metadata matching the given criteria. +// If no criteria is provided, then all endpoints will be returned. +// If no endpoints are found, then an empty slice of EndpointMetadata will be returned. +func FindEndpoints(ctx context.Context, findCriteria []criteria.FindEndpointsCriteria, options ...resolution.EndpointResolutionOption) ([]*model.EndpointMetadata, error) { + // TODO: implement + return nil, errors.New("not implemented") +} + +// GetDefaultEndpoint resolves the endpoint metadata, if available, for the default endpoint. +// This will return nil if no endpoint metadata can be resolved. +func GetDefaultEndpoint(ctx context.Context, options ...resolution.EndpointResolutionOption) (*model.EndpointMetadata, error) { + // TODO: implement + return nil, errors.New("not yet implemented") +} + +// GetEndpointByNetwork resolves the endpoint metadata, if available, for the given chain ID. +// This will return nil if no endpoint metadata can be resolved. +func GetEndpointByNetwork(ctx context.Context, chainID model.ChainID, options ...resolution.EndpointResolutionOption) (*model.EndpointMetadata, error) { + // TODO: implement + return nil, errors.New("not yet implemented") +} + +// GetEndpointByName resolves the endpoint metadata, if available, for the network for the given name. +// This will return nil if no endpoint metadata can be resolved. +// If the given RPC config is non-nil, it will be used to determine the endpoint. +// If the given RPC config is nil, then the RPC config will be resolved according to the MESC specification. +func GetEndpointByName(ctx context.Context, name string, rpcConfig *model.RPCConfig) (*model.EndpointMetadata, error) { + // TODO: implement + return nil, errors.New("not yet implemented") +} + +// GetEndpointsByQuery resolves the endpoint metadata, if found, for the given query. +// This will return nil if no endpoint metadata can be resolved. +func GetEndpointsByQuery(ctx context.Context, query string, options ...resolution.EndpointResolutionOption) (*model.EndpointMetadata, error) { + // TODO: implement + return nil, errors.New("not yet implemented") +} + +// IsMESCEnabled determines if MESC is enabled. +func IsMESCEnabled(ctx context.Context) (bool, error) { + // TODO: implement + return false, errors.New("not yet implemented") +} diff --git a/go/pkg/mesc/env.go b/go/pkg/mesc/env.go new file mode 100644 index 0000000..07a8938 --- /dev/null +++ b/go/pkg/mesc/env.go @@ -0,0 +1,348 @@ +package mesc + +import ( + "bytes" + "context" + "encoding/json" + "fmt" + "net/url" + "os" + "strconv" + "strings" + + "github.com/paradigmxyz/mesc/go/pkg/mesc/endpoint/io/serialization" + model "github.com/paradigmxyz/mesc/go/pkg/mesc/model" +) + +// ResolveRPCConfig resolves an RPC configuration per the MESC specification rules. +func ResolveRPCConfig(ctx context.Context) (*model.RPCConfig, error) { + byMode, hasByMode, err := resolveFromMode() + if err != nil { + return nil, fmt.Errorf("failed to resolve RPC configuration by mode: %w", err) + } else if hasByMode { + return applyOverrides(byMode) + } + + byPath, hasByPath, err := readRPCConfigFile() + if err != nil { + return nil, fmt.Errorf("failed to read RPC configuration from file: %w", err) + } else if hasByPath { + return applyOverrides(byPath) + } + + byEnv, hasByEnv, err := readRPCConfigEnv() + if err != nil { + return nil, fmt.Errorf("failed to read RPC configuration from env: %w", err) + } else if hasByEnv { + return applyOverrides(byEnv) + } + + return nil, fmt.Errorf("unable to resolve MESC configuration") +} + +func applyEndpointMetadataOverrides(rpcConfig *model.RPCConfig) error { + endpointMetadataOverrideJSON := os.Getenv("MESC_ENDPOINT_METADATA") + if endpointMetadataOverrideJSON == "" { + return nil + } + + endpointMetadataOverrides, err := serialization.DeserializeEndpointMetadataJSON(bytes.NewBufferString(endpointMetadataOverrideJSON)) + if err != nil { + return fmt.Errorf("failed to deserialize endpoint metadata overrides: %w", err) + } + + if rpcConfig.Endpoints == nil { + rpcConfig.Endpoints = make(map[string]model.EndpointMetadata) + } + + for endpointName, endpointMetadata := range endpointMetadataOverrides { + rpcConfig.Endpoints[endpointName] = endpointMetadata + } + + return nil +} + +func applyEndpointOverrides(rpcConfig *model.RPCConfig) error { + endpointOverrides := os.Getenv("MESC_ENDPOINTS") + if endpointOverrides == "" { + return nil + } + + endpoints := make(map[string]model.EndpointMetadata) + for _, endpoint := range strings.Split(endpointOverrides, " ") { + splitEndpoint := strings.Split(endpoint, "=") + if len(splitEndpoint) != 2 { + return fmt.Errorf("invalid endpoint override: '%s'", endpoint) + } + + endpoint := model.EndpointMetadata{} + endpointKey := splitEndpoint[0] + if strings.Contains(endpointKey, ":") { + splitKey := strings.Split(endpointKey, ":") + endpoint.Name = splitKey[0] + endpointKey = splitKey[0] + chainID := model.ChainID(splitKey[1]) + endpoint.ChainID = &chainID + } else { + endpoint.Name = splitEndpoint[0] + } + + endpoint.URL = splitEndpoint[1] + + endpoints[endpointKey] = endpoint + } + rpcConfig.Endpoints = endpoints + + return nil +} + +func applyGlobalMetadataOverride(rpcConfig *model.RPCConfig) error { + globalMetadataOverride := os.Getenv("MESC_GLOBAL_METADATA") + if globalMetadataOverride == "" { + return nil + } + + var globalMetadataOverrides map[string]any + if unmarshalErr := json.Unmarshal([]byte(globalMetadataOverride), &globalMetadataOverrides); unmarshalErr != nil { + return fmt.Errorf("failed to unmarshal global metadata override: %w", unmarshalErr) + } + + if rpcConfig.GlobalMetadata == nil { + rpcConfig.GlobalMetadata = make(map[string]any) + } + + for overrideName, overrideValue := range globalMetadataOverrides { + rpcConfig.GlobalMetadata[overrideName] = overrideValue + } + + return nil +} + +func applyNetworkDefaultsOverride(rpcConfig *model.RPCConfig) error { + networkDefaultsOverride := os.Getenv("MESC_NETWORK_DEFAULTS") + if networkDefaultsOverride == "" { + return nil + } + + networkDefaults := make(map[model.ChainID]string) + for _, networkDefault := range strings.Split(networkDefaultsOverride, " ") { + splitNetworkDefault := strings.Split(networkDefault, "=") + if len(splitNetworkDefault) != 2 { + return fmt.Errorf("invalid network default override: '%s'", networkDefault) + } + + networkDefaults[model.ChainID(splitNetworkDefault[0])] = splitNetworkDefault[1] + } + rpcConfig.NetworkDefaults = networkDefaults + + return nil +} + +func applyNetworkNamesOverride(rpcConfig *model.RPCConfig) error { + networkNameOverride := os.Getenv("MESC_NETWORK_NAMES") + if networkNameOverride == "" { + return nil + } + + networkNames := make(map[string]model.ChainID) + for _, networkName := range strings.Split(networkNameOverride, " ") { + splitNetworkName := strings.Split(networkName, "=") + if len(splitNetworkName) != 2 { + return fmt.Errorf("invalid network name overide: '%s'", networkName) + } + + networkNames[splitNetworkName[0]] = model.ChainID(splitNetworkName[1]) + } + rpcConfig.NetworkNames = networkNames + + return nil +} + +func applyOverrides(rpcConfig *model.RPCConfig) (*model.RPCConfig, error) { + if err := applyNetworkDefaultsOverride(rpcConfig); err != nil { + return nil, fmt.Errorf("failed to apply network defaults overrides: %w", err) + } + + if err := applyNetworkNamesOverride(rpcConfig); err != nil { + return nil, fmt.Errorf("failed to apply network names overrides: %w", err) + } + + if err := applyEndpointOverrides(rpcConfig); err != nil { + return nil, fmt.Errorf("failed apply endpoint overrides: %w", err) + } + + if err := applyProfileOverrides(rpcConfig); err != nil { + return nil, fmt.Errorf("failed to apply profile overrides: %w", err) + } + + if err := applyGlobalMetadataOverride(rpcConfig); err != nil { + return nil, fmt.Errorf("failed to apply global metadata overrides: %w", err) + } + + if err := applyEndpointMetadataOverrides(rpcConfig); err != nil { + return nil, fmt.Errorf("failed to apply endpoint metadata overrides: %w", err) + } + + if defaultEndpointOverride := os.Getenv("MESC_DEFAULT_ENDPOINT"); defaultEndpointOverride != "" { + rpcConfig.DefaultEndpoint = &defaultEndpointOverride + synthesizeEndpoint(rpcConfig, defaultEndpointOverride) + } + + return rpcConfig, nil +} + +func applyProfileOverrides(rpcConfig *model.RPCConfig) error { + profileOverrides := os.Getenv("MESC_PROFILES") + if profileOverrides == "" { + return nil + } + + profiles := make(map[string]*model.Profile) + for _, profileOverride := range strings.Split(profileOverrides, " ") { + keyValue := strings.Split(profileOverride, "=") + if len(keyValue) != 2 { + return fmt.Errorf("invalid profile override: '%s'", profileOverride) + } + + keyParts := strings.Split(keyValue[0], ".") + if len(keyParts) < 2 { + return fmt.Errorf("invalid key in profile override key/value pair: '%s'", profileOverride) + } + + profile, hasProfile := profiles[keyParts[0]] + if !hasProfile { + profile = &model.Profile{ + Name: keyParts[0], + } + profiles[keyParts[0]] = profile + } + + switch keyParts[1] { + case "default_endpoint": + profile.DefaultEndpoint = &keyValue[1] + case "network_defaults": + if len(keyParts) < 3 { + return fmt.Errorf("invalid network default setting in profile override: '%s'", profileOverride) + } + + networkDefaults := profile.NetworkDefaults + if networkDefaults == nil { + networkDefaults = make(map[model.ChainID]string) + profile.NetworkDefaults = networkDefaults + } + networkDefaults[model.ChainID(keyParts[2])] = keyValue[1] + case "profile_metadata": + if len(keyParts) < 3 { + return fmt.Errorf("invalid profile metadata setting in profile override: '%s'", profileOverride) + } + + profileMetadata := profile.ProfileMetadata + if profileMetadata == nil { + profileMetadata = make(map[string]any) + profile.ProfileMetadata = profileMetadata + } + profileMetadata[keyParts[2]] = keyValue[1] + case "use_mesc": + parsedBool, parseErr := strconv.ParseBool(keyValue[1]) + if parseErr != nil { + return fmt.Errorf("invalid use_mesc setting in profile override: '%s'", profileOverride) + } + + profile.UseMESC = parsedBool + default: + return fmt.Errorf("unrecognized profile override setting: '%s'", profileOverride) + } + } + + dereffedProfiles := make(map[string]model.Profile, len(profiles)) + for profileName, profile := range profiles { + dereffedProfiles[profileName] = *profile + } + rpcConfig.Profiles = dereffedProfiles + + return nil +} + +func readRPCConfigBytes(jsonBytes []byte) (*model.RPCConfig, error) { + rpcConfig, serializationErr := serialization.DeserializeJSON(bytes.NewBuffer(jsonBytes)) + if serializationErr != nil { + return nil, fmt.Errorf("failed to deserialize JSON: %w", serializationErr) + } + + return rpcConfig, nil +} + +func readRPCConfigEnv() (*model.RPCConfig, bool, error) { + mescJSON := os.Getenv("MESC_ENV") + if mescJSON == "" { + return nil, false, nil + } + + rpcConfig, err := readRPCConfigBytes([]byte(mescJSON)) + if err != nil { + return nil, false, fmt.Errorf("failed to unmarshal RPC config JSON from env var: %w", err) + } + + return rpcConfig, true, nil +} + +func readRPCConfigFile() (*model.RPCConfig, bool, error) { + filePath := os.Getenv("MESC_PATH") + if filePath == "" { + return nil, false, nil + } + + jsonBytes, err := os.ReadFile(filePath) + if err != nil { + return nil, false, fmt.Errorf("failed to read RPC configuration from file '%s': %w", filePath, err) + } + + rpcConfig, err := readRPCConfigBytes(jsonBytes) + if err != nil { + return nil, false, fmt.Errorf("failed to unmarshal RPC config JSON from file '%s': %w", filePath, err) + } + + return rpcConfig, true, nil +} + +func resolveFromMode() (*model.RPCConfig, bool, error) { + mescMode := os.Getenv("MESC_MODE") + switch strings.TrimSpace(mescMode) { + case "PATH": + return readRPCConfigFile() + case "ENV": + return readRPCConfigEnv() + default: + if mescMode != "" { + return nil, false, fmt.Errorf("invalid MESC_MODE value: '%s'", mescMode) + } + } + + return nil, false, nil +} + +func synthesizeEndpoint(rpcConfig *model.RPCConfig, endpointName string) { + endpoints := rpcConfig.Endpoints + if endpoints == nil { + endpoints = make(map[string]model.EndpointMetadata) + rpcConfig.Endpoints = endpoints + } + + syntheticEndpointName := endpointName + if url, parseErr := url.Parse(endpointName); parseErr == nil { + if host := url.Host; host != "" { + syntheticEndpointName = host + } else if scheme := url.Scheme; scheme != "" { + syntheticEndpointName = scheme + } + } + + if _, hasEndpoint := endpoints[syntheticEndpointName]; hasEndpoint { + return + } + + endpoints[syntheticEndpointName] = model.EndpointMetadata{ + Name: syntheticEndpointName, + URL: endpointName, + } +} diff --git a/go/pkg/mesc/env_test.go b/go/pkg/mesc/env_test.go new file mode 100644 index 0000000..56a8a0f --- /dev/null +++ b/go/pkg/mesc/env_test.go @@ -0,0 +1,292 @@ +package mesc_test + +import ( + "context" + "os" + + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" + "github.com/paradigmxyz/mesc/go/pkg/mesc" + "github.com/paradigmxyz/mesc/go/pkg/mesc/model" +) + +var _ = Describe("Env", func() { + var ctx context.Context + + BeforeEach(func() { + ctx = context.Background() + }) + + Context("reading from environmental variables", func() { + When("the mode is set to ENV", func() { + BeforeEach(func() { + Expect(setAndResetEnv("MESC_MODE", "ENV")).To(Succeed(), "setting the mode should succeed") + }) + + It("reads the configuration from the environment", func() { + Expect(setAndResetEnv("MESC_ENV", `{ "mesc_version": "MESC 1.0", "default_endpoint": "ethereum_env" }`)) + + rpcConfig, err := mesc.ResolveRPCConfig(ctx) + Expect(err).ToNot(HaveOccurred(), "resolving the RPC configuration should not fail") + Expect(rpcConfig).ToNot(BeNil(), "the resolved RPC configuration should not be nil") + Expect(rpcConfig.DefaultEndpoint).ToNot(BeNil(), "the RPC configuration should have a default endpoint set") + Expect(*rpcConfig.DefaultEndpoint).To(Equal("ethereum_env"), "the RPC config should be read from the environmental variable") + }) + }) + + When("there is no mode set", func() { + When("there is JSON in MESC_ENV", func() { + BeforeEach(func() { + Expect(setAndResetEnv("MESC_ENV", `{ "mesc_version": "MESC 1.0", "default_endpoint": "ethereum_env_nomode" }`)) + }) + + It("resolves the JSON from the environmental variable", func() { + rpcConfig, err := mesc.ResolveRPCConfig(ctx) + Expect(err).ToNot(HaveOccurred(), "resolving the RPC configuration should not fail") + Expect(rpcConfig).ToNot(BeNil(), "the resolved RPC configuration should not be nil") + Expect(rpcConfig.DefaultEndpoint).ToNot(BeNil(), "the RPC configuration should have a default endpoint set") + Expect(*rpcConfig.DefaultEndpoint).To(Equal("ethereum_env_nomode"), "the RPC config should be read from the environmental variable") + }) + }) + }) + }) + + Context("applying overrides", func() { + BeforeEach(func() { + Expect(setAndResetEnv("MESC_MODE", "ENV")).To(Succeed(), "setting the mode should not fail") + Expect(setAndResetEnv("MESC_ENV", `{ "mesc_version": "MESC 1.0" }`)).To(Succeed(), "setting the JSON env should not fail") + }) + + When("there is a default endpoint override", func() { + BeforeEach(func() { + Expect(setAndResetEnv("MESC_DEFAULT_ENDPOINT", "localhost.default:9999")).To(Succeed(), "setting the default endpoint override should succeed") + }) + + It("overrides the default endpoint", func() { + rpcConfig, err := mesc.ResolveRPCConfig(ctx) + Expect(err).ToNot(HaveOccurred(), "resolving the RPC configuration should not fail") + Expect(rpcConfig.DefaultEndpoint).ToNot(BeNil(), "the default endpoint should be set") + Expect(*rpcConfig.DefaultEndpoint).To(Equal("localhost.default:9999"), "the default endpoint override should be applied") + + // A synthesized endpoint should also be created + Expect(rpcConfig.Endpoints).To(And( + HaveLen(1), + HaveKey("localhost.default"), + ), "a synthesized endpoint with the host name should be created") + + endpoint := rpcConfig.Endpoints["localhost.default"] + Expect(endpoint.Name).To(Equal("localhost.default"), "the endpoint name should match its key") + Expect(endpoint.URL).To(Equal("localhost.default:9999"), "the endpoint should inherit the specified URL") + Expect(endpoint.ChainID).To(BeNil(), "no chain ID should be inferred") + }) + + When("the override is a URL with a scheme", func() { + BeforeEach(func() { + Expect(setAndResetEnv("MESC_DEFAULT_ENDPOINT", "http://localhost.schemed:9999")).To(Succeed(), "setting the default endpoint override should succeed") + }) + + It("extracts the host out as the endpoint name", func() { + rpcConfig, err := mesc.ResolveRPCConfig(ctx) + Expect(err).ToNot(HaveOccurred(), "resolving the RPC configuration should not fail") + + Expect(rpcConfig.Endpoints).To(And( + HaveLen(1), + HaveKey("localhost.schemed:9999"), + ), "a synthesized endpoint with the host name should be created") + }) + }) + + When("there is another endpoint configured with the name of the override", func() { + BeforeEach(func() { + Expect(setAndResetEnv("MESC_DEFAULT_ENDPOINT", "localhost.default")).To(Succeed(), "setting the default endpoint override should succeed") + Expect(setAndResetEnv("MESC_ENDPOINTS", "localhost.default=https://alchemy.com/default")).To(Succeed(), "setting the endpoint overrides should succeed") + }) + + It("does not synthesize a new endpoint", func() { + rpcConfig, err := mesc.ResolveRPCConfig(ctx) + Expect(err).ToNot(HaveOccurred(), "resolving the RPC configuration should not fail") + + Expect(rpcConfig.DefaultEndpoint).ToNot(BeNil(), "the default endpoint should be present") + Expect(*rpcConfig.DefaultEndpoint).To(Equal("localhost.default"), "the default endpoint should be correct") + + Expect(rpcConfig.Endpoints).To(And( + HaveLen(1), + HaveKey("localhost.default"), + ), "the existing endpoint should be re-used") + + endpoint := rpcConfig.Endpoints["localhost.default"] + Expect(endpoint.URL).To(Equal("https://alchemy.com/default"), "the URL of the endpoint should be correct") + }) + }) + }) + + When("there are network defaults set", func() { + BeforeEach(func() { + Expect(setAndResetEnv("MESC_NETWORK_DEFAULTS", "5=alchemy_optimism 1=local_mainnet")).To(Succeed(), "setting the network defaults override should succeed") + }) + + It("applies the network default overrides", func() { + rpcConfig, err := mesc.ResolveRPCConfig(ctx) + Expect(err).ToNot(HaveOccurred(), "resolving the RPC configurations should not fail") + Expect(rpcConfig.NetworkDefaults).To(And( + HaveLen(2), + HaveKeyWithValue(model.ChainID("1"), "local_mainnet"), + HaveKeyWithValue(model.ChainID("5"), "alchemy_optimism"), + ), "the network default override should have been applied") + }) + }) + + When("there are network names set", func() { + BeforeEach(func() { + Expect(setAndResetEnv("MESC_NETWORK_NAMES", "zora=7777777 scroll=534352")).To(Succeed(), "setting the network names override should work") + }) + + It("applies the network names override", func() { + rpcConfig, err := mesc.ResolveRPCConfig(ctx) + Expect(err).ToNot(HaveOccurred(), "resolving the RPC configurations should not fail") + Expect(rpcConfig.NetworkNames).To(And( + HaveLen(2), + HaveKeyWithValue("zora", model.ChainID("7777777")), + HaveKeyWithValue("scroll", model.ChainID("534352")), + ), "the network names override should be applied") + }) + }) + + When("there are endpoint overrides set", func() { + BeforeEach(func() { + Expect(setAndResetEnv("MESC_ENDPOINTS", "alchemy_optimism=https://alchemy.com/fjsj local_goerli:5=localhost:8545")).To(Succeed(), "setting the endpoint overrides should succeed") + }) + + It("applies the endpoint overrides", func() { + rpcConfig, err := mesc.ResolveRPCConfig(ctx) + Expect(err).ToNot(HaveOccurred(), "resolving the RPC configurations should not fail") + Expect(rpcConfig.Endpoints).To(And( + HaveLen(2), + HaveKey("alchemy_optimism"), + HaveKey("local_goerli"), + ), "the endpoints should be loaded into the RPC configuration") + + optimismEndpoint := rpcConfig.Endpoints["alchemy_optimism"] + Expect(optimismEndpoint.Name).To(Equal("alchemy_optimism"), "the Optimism endpoint should inherit its key as its name") + Expect(optimismEndpoint.URL).To(Equal("https://alchemy.com/fjsj"), "the Optimism URL should be set") + Expect(optimismEndpoint.ChainID).To(BeNil(), "no chain ID should be set for the Optimism endpoint") + + goerliEndpoint := rpcConfig.Endpoints["local_goerli"] + Expect(goerliEndpoint.Name).To(Equal("local_goerli"), "the Goerli endpoint should inherit its key as its name") + Expect(goerliEndpoint.URL).To(Equal("localhost:8545"), "the Goerli endpoint should have the right URL") + Expect(goerliEndpoint.ChainID).ToNot(BeNil(), "the Goerli endpoint should have a chain ID set") + Expect(*goerliEndpoint.ChainID).To(Equal(model.ChainID("5")), "the Goerli endpoint should have the correct chain ID") + }) + }) + + When("there are profile overrides set", func() { + BeforeEach(func() { + Expect(setAndResetEnv("MESC_PROFILES", "foundry.default_endpoint=local_goerli foundry.network_defaults.5=alchemy_optimism foundry.profile_metadata.metadatum_key=metadatum_value foundry.use_mesc=true")).To(Succeed(), "setting the profiles override should not fail") + }) + + It("applies the profile overrides", func() { + rpcConfig, err := mesc.ResolveRPCConfig(ctx) + Expect(err).ToNot(HaveOccurred(), "resolving the RPC configurations should not fail") + Expect(rpcConfig.Profiles).To(And( + HaveLen(1), + HaveKey("foundry"), + ), "the profile should be loaded") + + profile := rpcConfig.Profiles["foundry"] + Expect(profile.Name).To(Equal("foundry"), "the profile should inherit the key as the name") + Expect(profile.DefaultEndpoint).ToNot(BeNil(), "the profile should have a default endpoint") + Expect(*profile.DefaultEndpoint).To(Equal("local_goerli"), "the profile should have the correct default endpoint") + Expect(profile.NetworkDefaults).To(And( + HaveLen(1), + HaveKeyWithValue(model.ChainID("5"), "alchemy_optimism"), + ), "the profile should have the correct network defaults loaded") + Expect(profile.ProfileMetadata).To(And( + HaveLen(1), + HaveKeyWithValue("metadatum_key", "metadatum_value"), + ), "the profile should have the correct metadata") + Expect(profile.UseMESC).To(BeTrue(), "the profile should have MESC enabled") + }) + }) + + When("there is a global metadata override", func() { + BeforeEach(func() { + Expect(setAndResetEnv("MESC_GLOBAL_METADATA", `{ "bool_field": true, "string_field": "str_value" }`)) + }) + + It("assigns the configured metadata as global metadata", func() { + rpcConfig, err := mesc.ResolveRPCConfig(ctx) + Expect(err).ToNot(HaveOccurred(), "resolving the RPC configurations should not fail") + Expect(rpcConfig.GlobalMetadata).To(And( + HaveLen(2), + HaveKeyWithValue("bool_field", true), + HaveKeyWithValue("string_field", "str_value"), + ), "the global metadata should be overridden") + }) + + When("the configuration already has global metadata set", func() { + BeforeEach(func() { + Expect(setAndResetEnv("MESC_ENV", `{ "mesc_version": "MESC 1.0", "global_metadata": { "keep_val": "do not lose" } }`)).To(Succeed(), "setting the JSON env should not fail") + }) + + It("overlays the override on top of the data", func() { + rpcConfig, err := mesc.ResolveRPCConfig(ctx) + Expect(err).ToNot(HaveOccurred(), "resolving the RPC configurations should not fail") + Expect(rpcConfig.GlobalMetadata).To(And( + HaveLen(3), + HaveKeyWithValue("bool_field", true), + HaveKeyWithValue("string_field", "str_value"), + HaveKeyWithValue("keep_val", "do not lose"), + ), "the global metadata should be overlayed by what's set as an override") + }) + }) + }) + + When("there is an endpoint metadata override", func() { + BeforeEach(func() { + Expect(setAndResetEnv("MESC_ENDPOINT_METADATA", `{ "local_ethereum": { "url": "http://localhost:8545" } }`)) + }) + + It("overrides it with the set JSON", func() { + rpcConfig, err := mesc.ResolveRPCConfig(ctx) + Expect(err).ToNot(HaveOccurred(), "resolving the RPC configurations should not fail") + Expect(rpcConfig.Endpoints).To(And( + HaveLen(1), + HaveKey("local_ethereum"), + ), "the RPC configuration should have the endpoint metadata loaded") + Expect(rpcConfig.Endpoints["local_ethereum"].URL).To(Equal("http://localhost:8545"), "the data for the endpoint should have been deserialized") + }) + + When("the RPC configuration already has endpoint metadata", func() { + BeforeEach(func() { + Expect(setAndResetEnv("MESC_ENV", `{ "mesc_version": "MESC 1.0", "endpoints": { "base_mainnet": { "url": "https://base.coinbase.com/rpc" }} }`)).To(Succeed(), "setting the JSON env should not fail") + }) + + It("overlays the existing configuration with the configured override", func() { + rpcConfig, err := mesc.ResolveRPCConfig(ctx) + Expect(err).ToNot(HaveOccurred(), "resolving the RPC configurations should not fail") + Expect(rpcConfig.Endpoints).To(And( + HaveLen(2), + HaveKey("base_mainnet"), + HaveKey("local_ethereum"), + ), "the RPC configuration should have the override endpoint metadata overlayed onto the pre-existing data") + }) + }) + }) + }) + + When("there is no resolvable RPC configuration", func() { + It("fails to resolve an RPC configuration", func() { + _, err := mesc.ResolveRPCConfig(ctx) + Expect(err).To(HaveOccurred(), "resolving the RPC configuration should fail") + Expect(err.Error()).To(Equal("unable to resolve MESC configuration"), "it should fail for the correct reason") + }) + }) +}) + +func setAndResetEnv(name string, value string) error { + originalValue := os.Getenv(name) + DeferCleanup(func() { + _ = os.Setenv(name, originalValue) + }) + return os.Setenv(name, value) +} diff --git a/go/pkg/mesc/mesc_suite_test.go b/go/pkg/mesc/mesc_suite_test.go new file mode 100644 index 0000000..5f0f30f --- /dev/null +++ b/go/pkg/mesc/mesc_suite_test.go @@ -0,0 +1,13 @@ +package mesc_test + +import ( + "testing" + + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +func TestMesc(t *testing.T) { + RegisterFailHandler(Fail) + RunSpecs(t, "Mesc Suite") +} diff --git a/go/pkg/mesc/model/chain_id.go b/go/pkg/mesc/model/chain_id.go new file mode 100644 index 0000000..ff7499a --- /dev/null +++ b/go/pkg/mesc/model/chain_id.go @@ -0,0 +1,32 @@ +package model + +import ( + "fmt" + "strconv" + "strings" +) + +// ChainID is the definition of a representation of a chain ID, +// conforming to the format as described in the MESC specification. +type ChainID string + +// ToInt will parse an integer representation of the chain ID. +func (c ChainID) ToInt() (int64, error) { + asString := string(c) + if strings.HasPrefix(asString, "0x") { + parsedInt, parseErr := strconv.ParseInt(asString[2:], 16, 64) + if parseErr != nil { + return 0, fmt.Errorf("failed to parse chain ID '%s' as a hex value: %w", asString, parseErr) + } + + return parsedInt, nil + } + + // Try to just parse it as a ten-base digit + parsedInt, parseErr := strconv.ParseInt(asString, 10, 64) + if parseErr != nil { + return 0, fmt.Errorf("failed to parse chain ID '%s' as a ten-base value: %w", asString, parseErr) + } + + return parsedInt, nil +} diff --git a/go/pkg/mesc/model/chain_id_test.go b/go/pkg/mesc/model/chain_id_test.go new file mode 100644 index 0000000..eab44fd --- /dev/null +++ b/go/pkg/mesc/model/chain_id_test.go @@ -0,0 +1,30 @@ +package model_test + +import ( + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" + + model "github.com/paradigmxyz/mesc/go/pkg/mesc/model" +) + +var _ = Describe("ChainID", func() { + Context("ToInt", func() { + When("the chain ID is expressed as a ten-base number", func() { + It("successfully parses the integer", func() { + chainID := model.ChainID("512") + asInt, err := chainID.ToInt() + Expect(err).ToNot(HaveOccurred(), "parsing the integer should not fail") + Expect(asInt).To(BeNumerically("==", 512), "the parsed integer should be correct") + }) + }) + + When("the chain ID is expressed as a hexadecimal number", func() { + It("successfully parses the integer", func() { + chainID := model.ChainID("0xddb99ac060e2") + asInt, err := chainID.ToInt() + Expect(err).ToNot(HaveOccurred(), "parsing the integer should not fail") + Expect(asInt).To(BeNumerically("==", 243789234987234), "the parsed integer should be correct") + }) + }) + }) +}) diff --git a/go/pkg/mesc/model/endpoint_metadata.go b/go/pkg/mesc/model/endpoint_metadata.go new file mode 100644 index 0000000..0428a9b --- /dev/null +++ b/go/pkg/mesc/model/endpoint_metadata.go @@ -0,0 +1,94 @@ +package model + +// EndpointMetadata describes metadata for an RPC endpoint. +type EndpointMetadata struct { + Name string // Name is the name of the endpoint + URL string // URL is the location of the endpoint + ChainID *ChainID // ChainID is the chain ID of the string + EndpointMetadata map[string]any // EndpointMetadata is a map of both well-defined endpoint metadata and custom metadata +} + +// GetAPIKey gets the API key in the endpoint metadata, if present. +func (e EndpointMetadata) GetAPIKey() (string, bool) { + return getMetadataString(apiKeyKey, e.EndpointMetadata) +} + +// GetCloudRegion gets the cloud region from the endpoint metadata, if present. +func (e EndpointMetadata) GetCloudRegion() (string, bool) { + return getMetadataString(cloudRegionKey, e.EndpointMetadata) +} + +// GetEcosystem gets the ecosystem in the endpoint metadata, if present. +func (e EndpointMetadata) GetEcosystem() (string, bool) { + return getMetadataString(ecosystemKey, e.EndpointMetadata) +} + +// GetExplorer gets the URL of the explorer from the endpoint metadata, if present. +func (e EndpointMetadata) GetExplorer() (string, bool) { + return getMetadataString(explorerKey, e.EndpointMetadata) +} + +// GetHost gets the host from the endpoint metadata, if present. +func (e EndpointMetadata) GetHost() (string, bool) { + return getMetadataString(hostKey, e.EndpointMetadata) +} + +// GetJWTSecret gets the JWT secret from the endpoint metadata, if present. +func (e EndpointMetadata) GetJWTSecret() (string, bool) { + return getMetadataString(jwtSecretkey, e.EndpointMetadata) +} + +// GetLabels gets the labels from the endpoint metadata, if present. +func (e EndpointMetadata) GetLabels() ([]string, bool) { + return getMetadataStringSlice(labelsKey, e.EndpointMetadata) +} + +// GetLocation gets the location from the endpoint metadata, if present. +func (e EndpointMetadata) GetLocation() (string, bool) { + return getMetadataString(locationKey, e.EndpointMetadata) +} + +// GetMethodRateLimit gets the rate limit, if present, of requests per second for the given RPC method name. +func (e EndpointMetadata) GetMethodRateLimit(methodName string) (float64, bool) { + rateLimitPerMethodAny, hasRateLimits := getMetadataAny(rateLimitPerMethodKey, e.EndpointMetadata) + if !hasRateLimits { + return 0.0, false + } + + rateLimitPerMethodMap, isMap := rateLimitPerMethodAny.(map[string]any) + if !isMap { + return 0.0, false + } + + rateLimitAny, hasRateLimit := rateLimitPerMethodMap[methodName] + if !hasRateLimit { + return 0.0, false + } + + rateLimitFloat, isFloat := rateLimitAny.(float64) + if !isFloat { + return 0.0, false + } + + return rateLimitFloat, true +} + +// GetNamespaces gets the method namespaces defined in the endpoint metadata, if present. +func (e EndpointMetadata) GetNamespaces() ([]string, bool) { + return getMetadataStringSlice(namespacesKey, e.EndpointMetadata) +} + +// GetNodeClient gets the node client information in the metadata, if present. +func (e EndpointMetadata) GetNodeClient() (string, bool) { + return getMetadataString(nodeClientKey, e.EndpointMetadata) +} + +// GetRateLimitCUPS gets the rate limit in compute units per second that the endpoint will allow. +func (e EndpointMetadata) GetRateLimitCUPS() (float64, bool) { + return getMetadataFloat64(rateLimitComputeUnitsPerSecondKey, e.EndpointMetadata) +} + +// GetRateLimitRPS gets the rate limit of requests per second that the endpoint will allow. +func (e EndpointMetadata) GetRateLimitRPS() (float64, bool) { + return getMetadataFloat64(rateLimitRequestsPerSecondKey, e.EndpointMetadata) +} diff --git a/go/pkg/mesc/model/metadata.go b/go/pkg/mesc/model/metadata.go new file mode 100644 index 0000000..63ff447 --- /dev/null +++ b/go/pkg/mesc/model/metadata.go @@ -0,0 +1,82 @@ +package model + +const ( + apiKeyKey = "api_key" + apiKeysKey = "api_keys" + cloudRegionKey = "cloud_region" + concealKey = "conceal" + creationTimeKey = "creation_time" + ecosystemKey = "ecosystem" + explorerKey = "explorer" + groupsKey = "groups" + hostKey = "host" + jwtSecretkey = "jwt_secret" + labelsKey = "labels" + lastModifiedByKey = "last_modified_by" + lastModifiedTimeKey = "last_modified_time" + locationKey = "location" + namespacesKey = "namespaces" + nodeClientKey = "node_client" + rateLimitComputeUnitsPerSecondKey = "rate_limit_cups" + rateLimitPerMethodKey = "rate_limit_per_method" + rateLimitRequestsPerSecondKey = "rate_limit_rps" +) + +func getMetadataAny(parameterName string, metadata map[string]any) (any, bool) { + if metadata == nil { + return nil, false + } + + metadatumAny, hasMetadatum := metadata[parameterName] + return metadatumAny, hasMetadatum +} + +func getMetadataFloat64(parameterName string, metadata map[string]any) (float64, bool) { + metadatumAny, hasMetadatum := getMetadataAny(parameterName, metadata) + if !hasMetadatum { + return 0.0, false + } + + metadatumFloat, isFloat := metadatumAny.(float64) + if !isFloat { + return 0.0, false + } + + return metadatumFloat, true +} + +func getMetadataString(parameterName string, metadata map[string]any) (string, bool) { + metadatumAny, hasMetadatum := getMetadataAny(parameterName, metadata) + if !hasMetadatum { + return "", false + } + + metadatumString, isString := metadatumAny.(string) + if !isString { + return "", false + } + + return metadatumString, true +} + +func getMetadataStringSlice(parameterName string, metadata map[string]any) ([]string, bool) { + metadatumAny, hasMetadatum := getMetadataAny(parameterName, metadata) + if !hasMetadatum { + return nil, false + } + + metadatumAnySlice, isAnySlice := metadatumAny.([]any) + if !isAnySlice { + return nil, false + } + + stringSlice := make([]string, len(metadatumAnySlice)) + for metadatumIndex, metadatumAny := range metadatumAnySlice { + metadatumString, isString := metadatumAny.(string) + if !isString { + return nil, false + } + stringSlice[metadatumIndex] = metadatumString + } + return stringSlice, true +} diff --git a/go/pkg/mesc/model/model_suite_test.go b/go/pkg/mesc/model/model_suite_test.go new file mode 100644 index 0000000..64ce08a --- /dev/null +++ b/go/pkg/mesc/model/model_suite_test.go @@ -0,0 +1,13 @@ +package model_test + +import ( + "testing" + + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +func TestModel(t *testing.T) { + RegisterFailHandler(Fail) + RunSpecs(t, "Model Suite") +} diff --git a/go/pkg/mesc/model/profile.go b/go/pkg/mesc/model/profile.go new file mode 100644 index 0000000..f5a38f1 --- /dev/null +++ b/go/pkg/mesc/model/profile.go @@ -0,0 +1,114 @@ +package model + +import ( + "fmt" + "time" +) + +// Profile describes a profile to contextualize resolved endpoint metadata +type Profile struct { + Name string // Name is the name of the profile + DefaultEndpoint *string // DefaultEndpoint contains the ChainID of the default network under this profile, if available + NetworkDefaults map[ChainID]string // NetworkDefaults maps ChainID values identifying networks to the name of the default endpoint of that network + ProfileMetadata map[string]any // ProfileMetadata is a combination of both well-defined and custom-defined metadata for this profile + UseMESC bool // UseMESC, if false, indicates that MESC resolution should not be used when this profile is enabled +} + +// Conceal gets, from the profile metadata, whether tools should avoid casually revealing the RPC URLs without prompting. +func (p Profile) Conceal() (bool, bool) { + concealAny, hasConceal := getMetadataAny(concealKey, p.ProfileMetadata) + if !hasConceal { + return false, false + } + + concealBool, isBool := concealAny.(bool) + if !isBool { + return false, false + } + + return concealBool, true +} + +// GetAPIKeys gets from the profile metadata the provided API keys, if present. +func (p Profile) GetAPIKeys() (map[string]string, bool) { + apiKeysAny, hasAPIKeys := getMetadataAny(apiKeysKey, p.ProfileMetadata) + if !hasAPIKeys { + return nil, false + } + + apiKeysMapToAny, isMap := apiKeysAny.(map[string]any) + if !isMap { + return nil, false + } + + apiKeys := make(map[string]string, len(apiKeysMapToAny)) + for serviceName, apiKeyAny := range apiKeysMapToAny { + apiKeyString, isString := apiKeyAny.(string) + if !isString { + return nil, false + } + apiKeys[serviceName] = apiKeyString + } + + return apiKeys, true +} + +// GetEndpointNamesForGrouping gets from the profile metadata the endpoint names that are found in the given grouping, if present. +func (p Profile) GetEndpointNamesForGrouping(grouping string) ([]string, bool) { + groupsAny, hasGroupsAny := getMetadataAny(groupsKey, p.ProfileMetadata) + if !hasGroupsAny { + return nil, false + } + + groupsMap, isMap := groupsAny.(map[string]any) + if !isMap { + return nil, false + } + + groupedEndpointsAny, hasGroup := groupsMap[grouping] + if !hasGroup { + fmt.Println("does not have grouping") + return nil, false + } + + groupedEndpointsAnySlice, isSlice := groupedEndpointsAny.([]any) + if !isSlice { + return nil, false + } + + stringSlice := make([]string, len(groupedEndpointsAnySlice)) + for anyIndex, anyEndpoint := range groupedEndpointsAnySlice { + endpointString, isString := anyEndpoint.(string) + if !isString { + return nil, false + } + stringSlice[anyIndex] = endpointString + } + + return stringSlice, true +} + +// GetCreationTime gets from the metadata the date and time at which the profile was created, present. +func (p Profile) GetCreationTime() (time.Time, bool) { + floatTime, hasFloat := getMetadataFloat64(creationTimeKey, p.ProfileMetadata) + if !hasFloat { + return time.Time{}, false + } + + return time.Unix(int64(floatTime), 0), true +} + +// GetLastModifiedBy gets from the metadata the versioned identifier of the tool used to create the configuration, if present. +func (p Profile) GetLastModifiedBy() (string, bool) { + return getMetadataString(lastModifiedByKey, p.ProfileMetadata) +} + +// GetLastModifiedTime gets from the metadata the date and time when this profile was last modified, if present. +func (p Profile) GetLastModifiedTime() (time.Time, bool) { + floatTime, hasFloat := getMetadataFloat64(lastModifiedTimeKey, p.ProfileMetadata) + if !hasFloat { + return time.Time{}, false + } + + return time.Unix(int64(floatTime), 0), true +} diff --git a/go/pkg/mesc/model/rpc_config.go b/go/pkg/mesc/model/rpc_config.go new file mode 100644 index 0000000..c773443 --- /dev/null +++ b/go/pkg/mesc/model/rpc_config.go @@ -0,0 +1,12 @@ +package model + +// RPCConfig describes a collection of RPC configurations +type RPCConfig struct { + MESCVersion string // MESCVersion describes the version of the MESC specification to which this adheres + DefaultEndpoint *string // DefaultEndpoint is the name of the default endpoint to be used; if nil, then there is no named default endpoint + NetworkDefaults map[ChainID]string // NetworkDefaults maps chain IDs to the names of the default network for each chain + NetworkNames map[string]ChainID // NetworkNames maps network names to chain ID values + Endpoints map[string]EndpointMetadata // Endpoints maps endpoint metadata by endpoint name + Profiles map[string]Profile // Profiles maps profiles by their profile names + GlobalMetadata map[string]any // GlobalMetadata contains metadata relevant across all profiles +} diff --git a/python/README.md b/python/README.md index d1d9f1a..a33b06e 100644 --- a/python/README.md +++ b/python/README.md @@ -16,7 +16,7 @@ It has no external dependencies. ### From Source ``` -git clone https://github/paradigmxyz/mesc +git clone https://github.com/paradigmxyz/mesc cd mesc pip install ./ ``` @@ -24,6 +24,7 @@ pip install ./ ## Example Usage ```python +from typing import Any, Mapping, Sequence import mesc # check whether mesc is enabled @@ -49,7 +50,10 @@ endpoint: Endpoint | None = mesc.get_endpoint_by_name('local_goerli') endpoint: Endpoint | None = mesc.get_endpoint_by_query(user_str, profile='xyz_tool') # find all endpoints matching given criteria -endpoints: list[Endpoint] = mesc.find_endpoints(chain_id=5) +endpoints: Sequence[Endpoint] = mesc.find_endpoints(chain_id=5) + +# get non-endpoint metadata +metadata: Mapping[str, Any] = mesc.get_global_metadata(profile='xyz_tool') ``` ## Reference diff --git a/python/generate_network_names.py b/python/generate_network_names.py index 7dc3419..75a824b 100755 --- a/python/generate_network_names.py +++ b/python/generate_network_names.py @@ -8,16 +8,20 @@ This script creates the following files in the MESC repository: - ./python/mesc/network_names.py - ./rust/crates/mesc/src/network_names.rs """ + from __future__ import annotations import os -import requests from typing import Mapping, MutableMapping +import requests # specialcase the standard name for certain chains special_cases: Mapping[str, str] = { 'OP Mainnet': 'optimism', + 'Avalanche C-Chain': 'avalanche', + 'Arbitrum One': 'arbitrum', + 'BNB Smart Chain Mainnet': 'bsc', 'Genesis Coin': 'genesis_coin', 'X1 Network': 'x1_network', 'ThaiChain 2.0 ThaiFi': 'thaifi', @@ -59,6 +63,8 @@ def standardize_name(name: str) -> str: name = name.lower() name = name.replace(' ', '_') name = name.replace('-', '_') + name = name.replace('___', '_') + name = name.replace('__', '_') name = name.replace('(', '') name = name.replace(')', '') @@ -119,13 +125,16 @@ def generate_python_content(network_names: Mapping[str, str]) -> str: rust_path = '../rust/crates/mesc/src/network_names.rs' rust_template = """{preamble} -use crate::{{ChainId, TryIntoChainId}}; -use std::collections::HashMap; +use crate::ChainId; +use std::{{collections::HashMap, sync::OnceLock}}; /// get default mapping between chain_id's and network names -pub fn get_network_names() -> HashMap {{ - {name_data} +pub fn get_network_names() -> &'static HashMap {{ + static CACHE: OnceLock> = OnceLock::new(); + CACHE.get_or_init(|| NETWORKS.iter().map(|&(chain_id, name)| (chain_id.into(), name)).collect()) }} + +pub(crate) const NETWORKS: &[(u64, &str)] = &{name_data}; """ @@ -133,14 +142,8 @@ def generate_rust_content(network_names: Mapping[str, str]) -> str: rust_preamble = '\n'.join(('//! ' + line).strip() for line in preamble.split('\n')) name_data = '[' for chain_id, network_name in network_names.items(): - name_data += '\n ("' + chain_id + '", "' + network_name + '"),' - name_data += """\n ] - .into_iter() - .filter_map(|(chain_id, name)| match chain_id.try_into_chain_id() { - Ok(chain_id) => Some((chain_id, name.to_string())), - Err(_) => None, - }) - .collect()""" + name_data += '\n (' + chain_id + ', "' + network_name + '"),' + name_data += '\n]' return rust_template.format(preamble=rust_preamble, name_data=name_data) diff --git a/python/mesc/__init__.py b/python/mesc/__init__.py index 9e34f3b..8b0e8f0 100644 --- a/python/mesc/__init__.py +++ b/python/mesc/__init__.py @@ -9,19 +9,34 @@ from .interface import ( find_endpoints, get_global_metadata, ) -from .types import Endpoint, Profile, RpcConfig -__version__ = '0.1.4' +import typing -__all__ = ( - 'Endpoint', - 'Profile', - 'RpcConfig', - 'is_mesc_enabled', - 'get_default_endpoint', - 'get_endpoint_by_name', - 'get_endpoint_by_network', - 'get_endpoint_by_query', - 'find_endpoints', - 'get_global_metadata', -) +if typing.TYPE_CHECKING: + from .types import Endpoint, Profile, RpcConfig + + __all__ = ( + 'Endpoint', + 'Profile', + 'RpcConfig', + 'is_mesc_enabled', + 'get_default_endpoint', + 'get_endpoint_by_name', + 'get_endpoint_by_network', + 'get_endpoint_by_query', + 'find_endpoints', + 'get_global_metadata', + ) + +else: + __all__ = ( + 'is_mesc_enabled', + 'get_default_endpoint', + 'get_endpoint_by_name', + 'get_endpoint_by_network', + 'get_endpoint_by_query', + 'find_endpoints', + 'get_global_metadata', + ) + +__version__ = '0.2.1' diff --git a/python/mesc/interface.py b/python/mesc/interface.py index 970e274..684c7c7 100644 --- a/python/mesc/interface.py +++ b/python/mesc/interface.py @@ -1,12 +1,16 @@ from __future__ import annotations import os -from typing_extensions import Any, Mapping, Sequence +import typing -from .types import mesc_env_vars, Endpoint, RpcConfig +from .types import mesc_env_vars from . import network_utils from . import load +if typing.TYPE_CHECKING: + from typing_extensions import Any, Mapping, Sequence + from .types import Endpoint, RpcConfig + def is_mesc_enabled() -> bool: """MESC is enabled if two criteria are met: @@ -51,6 +55,8 @@ def get_endpoint_by_name( """get MESC endpoint by name""" if config is None: config = load.read_config_data() + if not isinstance(name, str): + raise Exception('invalid type for name query, it must be a str') return config['endpoints'].get(name) @@ -66,18 +72,21 @@ def get_endpoint_by_network( # get global default for network if chain_id is None: - raise ValueError('chain_id must be a str') + raise ValueError('chain_id must be a str or int') chain_id = str(chain_id) network_defaults = config['network_defaults'] - default_name = network_defaults.get(chain_id) + default_name = network_utils.get_by_chain_id(network_defaults, chain_id) # get profile default for network - if profile and profile in config['profiles']: + if profile is not None and profile in config['profiles']: if not config['profiles'][profile]['use_mesc']: return None - name = config['profiles'][profile]['network_defaults'].get( - chain_id, default_name + name = network_utils.get_by_chain_id( + config['profiles'][profile]['network_defaults'], + chain_id, ) + if name is None: + name = default_name else: name = default_name @@ -141,8 +150,12 @@ def find_endpoints( if chain_id is not None: if isinstance(chain_id, int): chain_id = str(chain_id) + chain_id = network_utils.chain_id_to_standard_hex(chain_id) endpoints = [ - endpoint for endpoint in endpoints if endpoint['chain_id'] == chain_id + endpoint + for endpoint in endpoints + if endpoint['chain_id'] is not None + and network_utils.chain_id_to_standard_hex(endpoint['chain_id']) == chain_id ] # check name_contains @@ -160,6 +173,19 @@ def find_endpoints( return endpoints -def get_global_metadata() -> Mapping[str, Any]: +def get_global_metadata( + *, profile: str | None = None, config: RpcConfig | None = None +) -> Mapping[str, Any]: """return MESC global metadata""" - return load.read_config_data()['global_metadata'] + + if config is None: + config = load.read_config_data() + + if profile is not None: + profile_data = config['profiles'].get(profile) + if profile_data is not None: + if not profile_data['use_mesc']: + return {} + return dict(config['global_metadata'], **profile_data['profile_metadata']) + + return config['global_metadata'] diff --git a/python/mesc/load.py b/python/mesc/load.py index a08184c..ffdc67a 100644 --- a/python/mesc/load.py +++ b/python/mesc/load.py @@ -1,13 +1,17 @@ from __future__ import annotations + import json import os -from typing_extensions import cast, overload, Literal, Any +import typing -from .types import RpcConfig from . import exceptions from . import overrides from . import validation +if typing.TYPE_CHECKING: + from typing_extensions import Literal, Any + from .types import RpcConfig + def read_config_data() -> RpcConfig: """read MESC config according to MESC environment variables""" @@ -37,15 +41,15 @@ def read_config_data() -> RpcConfig: # validate validation.validate(config) - return cast(RpcConfig, config) + return config # type: ignore -@overload +@typing.overload def read_env_config(*, validate: Literal[False]) -> Any: ... -@overload +@typing.overload def read_env_config(*, validate: Literal[True]) -> RpcConfig: ... @@ -68,17 +72,15 @@ def read_env_config(*, validate: bool = True) -> RpcConfig | Any: # validate config if validate: validation.validate(config) - return cast(RpcConfig, config) - else: - return config + return config -@overload +@typing.overload def read_file_config(*, path: str | None = None, validate: Literal[False]) -> Any: ... -@overload +@typing.overload def read_file_config(*, path: str | None = None, validate: Literal[True]) -> RpcConfig: ... @@ -120,6 +122,4 @@ def read_file_config( # validate config if validate: validation.validate(config) - return cast(RpcConfig, config) - else: - return config + return config diff --git a/python/mesc/network_names.py b/python/mesc/network_names.py index 63e613c..433e0b1 100644 --- a/python/mesc/network_names.py +++ b/python/mesc/network_names.py @@ -22,7 +22,7 @@ network_names = { '13': 'diode_testnet_staging', '14': 'flare', '15': 'diode_prenet', - '16': 'flare_testnet_coston', + '16': 'songbird_testnet_coston', '17': 'thaifi', '18': 'thundercore_testnet', '19': 'songbird_canary', @@ -62,7 +62,7 @@ network_names = { '53': 'coinex_testnet', '54': 'openpiece', '55': 'zyx', - '56': 'bnb', + '56': 'bsc', '57': 'syscoin', '58': 'ontology', '59': 'eos_evm_legacy', @@ -94,8 +94,8 @@ network_names = { '85': 'gate_testnet', '86': 'gate', '87': 'nova', - '88': 'tomo', - '89': 'tomo_testnet', + '88': 'viction', + '89': 'viction_testnet', '90': 'garizon_stage0', '91': 'garizon_stage1', '92': 'garizon_stage2', @@ -134,16 +134,22 @@ network_names = { '126': 'oy', '127': 'factory_127', '128': 'huobi_eco', + '129': 'innovator', '131': 'engram_testnet', + '132': 'namefi', + '133': 'hashkey_testnet', '134': 'iexec', '135': 'alyx_testnet', '136': 'deam', '137': 'polygon', '138': 'defi_oracle_meta', '139': 'woop', + '140': 'eternal', '141': 'openpiece_testnet', '142': 'dax', '144': 'phi_v2', + '145': 'soraai_testnet', + '147': 'flag', '148': 'shimmerevm', '150': 'six_protocol_testnet', '151': 'redbelly', @@ -152,57 +158,89 @@ network_names = { '154': 'redbelly_tge', '155': 'tenet_testnet', '156': 'oeblock_testnet', + '157': 'puppynet_shibarium', + '158': 'roburna', + '159': 'roburna_testnet', '160': 'armonia_eva', '161': 'armonia_eva_testnet', '162': 'lightstreams_testnet', '163': 'lightstreams', - '165': 'omni_testnet', + '164': 'omni_omega_testnet', + '166': 'omni', '167': 'atoshi_testnet', '168': 'aioz', '169': 'manta_pacific', '170': 'hoo_testnet', + '171': 'co2e_ledger', '172': 'latam_block_resil_testnet', + '176': 'dc', + '178': 'abey_testnet', + '179': 'abey', '180': 'ame', + '181': 'waterfall', + '183': 'ethernity', + '184': 'dojima_testnet', + '185': 'mint', '186': 'seele', + '187': 'dojima', '188': 'bmc', '189': 'bmc_testnet', + '190': 'cmdao_bbq', + '191': 'filefilego', '193': 'crypto_emergency', - '195': 'x1_testnet', - '196': 'x1', + '195': 'x_layer_testnet', + '196': 'x_layer', '197': 'neutrinos_testnet', '198': 'bit', '199': 'bittorrent', '200': 'arbitrum_on_xdai', '201': 'moac_testnet', + '202': 'edgeless_testnet', '204': 'opbnb', + '205': 'ekaash', '206': 'vinu_testnet', '207': 'vinu', '208': 'structx', '210': 'bitnet', '211': 'freight_trust', - '212': 'map_makalu', + '212': 'mapo_makalu', + '213': 'b2_hub', '214': 'shinarium', '217': 'siriusnet_v2', '218': 'soterone_old', '220': 'scalind_testnet', + '221': 'blockex', '222': 'permission', + '223': 'b2', + '224': 'viridis_testnet', '225': 'la', '226': 'la_testnet', + '228': 'mind', '230': 'swapdex', + '233': 'ethernity_testnet', + '234': 'protojumbo_testnet', '236': 'deam_testnet', '238': 'blast', '242': 'plinga', '246': 'energy_web', '248': 'oasys', '250': 'fantom_opera', - '252': 'frax', + '252': 'fraxtal', + '254': 'swan', '255': 'kroma', '256': 'huobi_eco_testnet', '258': 'setheum', '259': 'neonlink', + '261': 'guru_testnet', '262': 'sur_block', + '266': 'neura', + '267': 'neura_testnet', + '268': 'neura_devnet', '269': 'high_performance_block', '271': 'egoncoin', + '278': 'xfair.ai', + '279': 'bpx_block', + '282': 'cronos_zkevm_testnet', '288': 'boba', '291': 'orderly', '295': 'hedera', @@ -211,43 +249,63 @@ network_names = { '298': 'hedera_localnet', '300': 'zksync_sepolia_testnet', '301': 'bobaopera', + '302': 'zkcandy_sepolia_testnet', '303': 'neuro_testnet', + '305': 'zksats', + '307': 'lovely_testnet', + '308': 'furtheon', '309': 'wyzth_testnet', '311': 'omax', '313': 'neuro', '314': 'filecoin', '321': 'kcc', '322': 'kcc_testnet', + '323': 'cosvm', '324': 'zksync', + '325': 'grvt', + '326': 'grvt_sepolia_testnet', '333': 'web3q', '335': 'dfk_test', '336': 'shiden', '338': 'cronos_testnet', + '345': 'tsc', + '360': 'shape', '361': 'theta', '363': 'theta_sapphire_testnet', '364': 'theta_amber_testnet', '365': 'theta_testnet', '369': 'pulse', '371': 'consta_testnet', + '380': 'zkamoeba_testnet', + '381': 'zkamoeba', '385': 'lisinski', + '388': 'cronos_zkevm', + '395': 'camdl_testnet', + '397': 'near', + '398': 'near_testnet', '399': 'nativ3', '400': 'hyperon_testnet', '401': 'ozone_testnet', + '404': 'syndr_l3', '411': 'pepe', '416': 'sx', '418': 'latestnet', '420': 'optimism_goerli_testnet', + '422': 'viridis', '424': 'pgn_public_goods', '427': 'zeeth', '428': 'geso_verse', + '434': 'boyaa', '443': 'ten_testnet', '444': 'synapse_testnet', '456': 'arzio', '462': 'areon_testnet', '463': 'areon', + '480': 'world', '499': 'rupaya', '500': 'camino_c', '501': 'columbus_test', + '510': 'syndicate', '512': 'double_a', '513': 'double_a_testnet', '516': 'gear_zero', @@ -255,11 +313,15 @@ network_names = { '529': 'fire', '530': 'fxcore', '534': 'candle', + '537': 'optrust', '542': 'paw_testnet', + '545': 'evm_on_flow_testnet', '555': 'vela1', '558': 'tao', '568': 'doge_testnet', '570': 'rollux', + '571': 'meta', + '579': 'filenova', '588': 'metis_stardust_testnet', '592': 'astar', '595': 'acala_mandala_testnet_tc9', @@ -268,26 +330,40 @@ network_names = { '599': 'metis_goerli_testnet', '600': 'meshnyan_testnet', '601': 'vine_testnet', + '610': 'darwin_devnet', + '612': 'eiob', '614': 'graphlinq_block', + '624': 'binary', + '625': 'binary_sepolia', '634': 'avocado', + '646': 'previewnet', '647': 'sx_testnet', '648': 'endurance', - '653': 'kali', + '653': 'kali_testnet', + '654': 'kali', + '662': 'ultronsmart', '666': 'pixie_testnet', '667': 'laos_arrakis', '668': 'junca', '669': 'junca_testnet', '686': 'karura', + '690': 'redstone', '700': 'star_social_testnet', + '701': 'darwinia_koi_testnet', '707': 'block_station', '708': 'block_station_testnet', '710': 'highbury', + '711': 'tucana', + '712': 'birdee_2', + '713': 'vrcscan', '719': 'shibarium_beta', '721': 'lycan', '727': 'blucrates', + '730': 'lovely', '740': 'canto_testnet', '741': 'vention_testnet', '742': 'script_testnet', + '747': 'evm_on_flow', '766': 'ql1', '776': 'open_testnet', '777': 'cheapeth', @@ -295,27 +371,35 @@ network_names = { '787': 'acala', '788': 'aero_testnet', '789': 'patex', + '799': 'rupaya_testnet', '800': 'lucid_block', '803': 'haic', '808': 'portal_fantasy_test', + '810': 'haven1_testnet', '813': 'qitmeer', '814': 'fire_zkevm', '818': 'beone', '820': 'callisto', + '822': 'runic_testnet', + '831': 'checkdot_block_devnet', '841': 'taraxa', '842': 'taraxa_testnet', + '852': 'hongkong', '859': 'zeeth_dev', '868': 'fantasia', '876': 'bandai_namco_research_verse', '877': 'dexit', '880': 'ambros', '888': 'wan', + '898': 'maxi_testnet', + '899': 'maxi', '900': 'garizon_testnet_stage0', '901': 'garizon_testnet_stage1', '902': 'garizon_testnet_stage2', '903': 'garizon_testnet_stage3', '909': 'portal_fantasy', '910': 'decentrabone_layer1_testnet', + '911': 'taproot', '917': 'rinia_testnet', '919': 'mode_testnet', '927': 'yidark', @@ -323,27 +407,37 @@ network_names = { '941': 'pulse_testnet_v2b', '942': 'pulse_testnet_v3', '943': 'pulse_testnet_v4', + '945': 'subtensor_evm_testnet', '956': 'munode_testnet', '957': 'lyra', '963': 'btc20', + '969': 'ethxy', '970': 'oort', '971': 'oort_huygens', '972': 'oort_ascraeus', + '973': 'palm', '977': 'nepal_block', + '979': 'ethxy_testnet', '980': 'top_evm', '985': 'memo', '989': 'top', '990': 'eliberty', - '997': '5ire_thunder', + '995': '5ire', + '996': 'bifrost_polkadot', + '997': '5ire_thunder_testnet', '998': 'lucky', '999': 'wan_testnet', '1000': 'gton', - '1001': 'klaytn_testnet_baobab', + '1001': 'kaia_testnet_kairos', '1003': 'tectum_emission_token', '1004': 't_ekta', + '1005': 'lemontestnet', + '1006': 'lemon', '1007': 'newton_testnet', '1008': 'eurus', + '1009': 'jumbo', '1010': 'evrice', + '1011': 'rebus', '1012': 'newton', '1022': 'sakura', '1023': 'clover_testnet', @@ -354,42 +448,59 @@ network_names = { '1038': 'bronos_testnet', '1039': 'bronos', '1073': 'shimmerevm_testnet', + '1075': 'iota_evm_testnet', '1079': 'mintara_testnet', '1080': 'mintara', '1088': 'metis_andromeda', '1089': 'humans.ai', '1099': 'moac', + '1100': 'dymension', '1101': 'polygon_zkevm', '1107': 'blxq_testnet', '1108': 'blxq', '1111': 'wemix', '1112': 'wemix_testnet', + '1113': 'b2_hub_testnet', '1115': 'core_block_testnet', '1116': 'core_block', '1117': 'dogcoin', + '1123': 'b2_testnet', '1130': 'defi_evm', '1131': 'defi_evm_testnet', '1133': 'defimeta_changi_testnet', + '1135': 'lisk', '1138': 'amstar_testnet', '1139': 'math', '1140': 'math_testnet', + '1147': 'flag_testnet', '1149': 'symplexia', '1170': 'origin_testnet', '1177': 'smart_host_teknoloji_testnet', + '1188': 'clubmos', '1197': 'iora', + '1200': 'cuckoo', '1201': 'evanesco_testnet', '1202': 'world_trade_technical', + '1209': 'saitablocksbc', + '1210': 'cuckoo_sepolia', '1213': 'popcateum', '1214': 'enter', + '1221': 'cycle_testnet', + '1223': 'cycle_testnet_jellyfish', + '1225': 'hybrid_testnet', + '1227': 'bitcoin_protocol_testnet', + '1228': 'cycle_testnet_cuttlefish', '1229': 'exzo', '1230': 'ultron_testnet', '1231': 'ultron', '1234': 'step', + '1235': 'itx', '1243': 'arc', '1244': 'arc_testnet', '1246': 'om_platform', '1248': 'dogether', '1252': 'cic_testnet', + '1260': 'metacces_testnet', '1280': 'halo', '1284': 'moonbeam', '1285': 'moonriver', @@ -400,15 +511,20 @@ network_names = { '1294': 'bobabeam', '1297': 'bobabase_testnet', '1311': 'dos_fuji_subnet', + '1313': 'jaiho', '1314': 'alyx', '1319': 'aia', '1320': 'aia_testnet', + '1328': 'sei_testnet', + '1329': 'sei', '1337': 'geth_testnet', '1338': 'elysium_testnet', '1339': 'elysium', '1343': 'blitz_subnet', '1353': 'cic', '1369': 'zafirium', + '1370': 'ramestta', + '1377': 'pingaksha_testnet', '1379': 'kalar', '1388': 'amstar', '1392': 'joseon', @@ -418,44 +534,69 @@ network_names = { '1440': 'living_assets', '1442': 'polygon_zkevm_testnet', '1452': 'gil_testnet', + '1453': 'meta_istanbul', '1455': 'ctex_scan_block', - '1501': 'bevm', + '1456': 'zkbase', + '1490': 'vitruveo', + '1499': 'idos_games_testnet', + '1501': 'bevm_canary', '1506': 'sherpax', '1507': 'sherpax_testnet', + '1513': 'story_testnet', '1515': 'beagle_messaging', '1559': 'tenet', + '1570': 'star_testnet', + '1578': 'star', + '1617': 'ethereum_inscription', '1618': 'catecoin', '1620': 'atheios', + '1625': 'gravity_alpha', + '1648': 'pivotal', '1657': 'bta', '1662': 'liqui', '1663': 'horizen_gobi_testnet', + '1686': 'mint_testnet', + '1687': 'mint_sepolia_testnet', '1688': 'ludan', '1701': 'anytype_evm', '1707': 'tbsi', '1708': 'tbsi_testnet', + '1717': 'doric', '1718': 'palette', + '1729': 'reya', + '1740': 'metal_l2_testnet', + '1750': 'metal_l2', '1773': 'party', '1777': 'gauss', + '1789': 'zkbase_sepolia_testnet', '1804': 'kerleano', '1807': 'rabbit_analog_testnet', + '1811': 'lif3_testnet', '1818': 'cube', '1819': 'cube_testnet', '1821': 'ruby', + '1853': 'highoctane_subnet', '1856': 'teslafunds', - '1875': 'whitebit', + '1875': 'white', '1881': 'gitshock_cartenz_testnet', '1890': 'lightlink_phoenix', '1891': 'lightlink_pegasus_testnet', '1898': 'bon', + '1899': 'redefi_layer_2', '1904': 'sports', '1907': 'bitci', '1908': 'bitci_testnet', '1909': 'merkle_scan', '1911': 'scalind', '1912': 'ruby_testnet', + '1918': 'upb_crescdi_testnet', '1945': 'onus_testnet', + '1946': 'minato', '1951': 'd', + '1953': 'selendra_testnet', '1954': 'dexilla_testnet', + '1956': 'aiw3_testnet', + '1961': 'selendra', '1967': 'eleanor', '1969': 'super_testnet', '1970': 'super', @@ -466,46 +607,67 @@ network_names = { '1985': 'satoshie', '1986': 'satoshie_testnet', '1987': 'ethergem', + '1992': 'hubble_exchange', + '1993': 'b3_sepolia_testnet', '1994': 'ekta', '1995': 'edexa_testnet', + '1996': 'sanko', + '1997': 'kyoto', '1998': 'kyoto_testnet', '2000': 'doge', '2001': 'milkomeda_c1', '2002': 'milkomeda_a1', + '2004': 'metalink', '2008': 'cloudwalk_testnet', '2009': 'cloudwalk', + '2013': 'panarchy', + '2014': 'now_testnet', '2016': 'mainnetz', + '2017': 'adiri', '2018': 'publicmint_devnet', '2019': 'publicmint_testnet', '2020': 'publicmint', '2021': 'edgeware_edgeevm', '2022': 'beresheet_bereevm_testnet', '2023': 'taycan_testnet', + '2024': 'swan_saturn_testnet', '2025': 'rangers_protocol', + '2026': 'edgeless', '2031': 'centrifuge', '2032': 'catalyst', '2035': 'phala', '2037': 'kiwi_subnet', '2038': 'shrapnel_testnet', - '2043': 'origintrail_para', + '2039': 'aleph_zero', + '2040': 'vanar', + '2043': 'neuroweb', '2044': 'shrapnel_subnet', + '2045': 'aiw3', '2047': 'stratos_testnet', '2048': 'stratos', '2049': 'movo', + '2071': 'metacces', '2077': 'quokkacoin', '2088': 'altair', '2089': 'algol', '2100': 'ecoball', '2101': 'ecoball_testnet_espuma', '2109': 'exosama', + '2112': 'u', + '2121': 'catena', '2122': 'metaplayerone', '2124': 'metaplayerone_dubai_testnet', + '2136': 'bigshortbets_testnet', '2137': 'bigshortbets', '2138': 'defi_oracle_meta_testnet', + '2140': 'oneness', + '2141': 'oneness_testnet', '2151': 'bosagora', '2152': 'findora', '2153': 'findora_testnet', '2154': 'findora_forge', + '2162': 'anime_testnet', + '2192': 'snax', '2199': 'moonsama', '2202': 'antofy', '2203': 'bitcoin_evm', @@ -517,52 +679,89 @@ network_names = { '2300': 'bomb', '2306': 'ebro', '2309': 'arevia', + '2311': 'chronicle_vesuvius_lit_protocol_testnet', '2323': 'soma_testnet', '2330': 'altcoin', + '2331': 'rss3_vsl_sepolia_testnet', '2332': 'soma', + '2340': 'atleta_olympia', + '2342': 'omnia', + '2355': 'silicon_zkevm', '2358': 'kroma_sepolia', + '2370': 'nexis_testnet', '2399': 'bomb_testnet', '2400': 'tcg_verse', + '2410': 'karak', '2415': 'xodex', - '2458': 'hybrid_testnet', + '2425': 'king_of_legends', + '2442': 'polygon_zkevm_cardona_testnet', '2468': 'hybrid', + '2477': '6degree_of_outreach', '2484': 'unicorn_ultra_nebulas_testnet', - '2522': 'frax_testnet', + '2511': 'karak_goerli', + '2522': 'fraxtal_testnet', + '2525': 'inevm', '2559': 'kortho', '2569': 'techpay', '2606': 'pocrnet', '2611': 'redlight', '2612': 'ez_c', '2613': 'ez_c_testnet', - '2625': 'whitebit_testnet', + '2625': 'white_testnet', + '2648': 'ailayer_testnet', + '2649': 'ailayer', + '2662': 'apex', '2710': 'morph_testnet', '2718': 'k_laos', + '2730': 'xr_sepolia', + '2731': 'elizabeth_testnet', + '2748': 'nanon', + '2777': 'gm', + '2810': 'morph_holesky', + '2868': 'hyperagi', + '2882': 'chips', '2888': 'boba_goerli_testnet', + '2889': 'aarma', + '2907': 'elux', + '2911': 'hy', + '2941': 'xenon_testnet', '2999': 'bityuan', '3000': 'cennznet_rata', '3001': 'cennznet_nikau', '3003': 'canxium', '3011': 'playa3ull_games', '3031': 'orlando', + '3033': 'rebus_testnet', '3068': 'bifrost', + '3073': 'movement_evm', + '3084': 'xl_testnet', '3100': 'immu3_evm', '3102': 'vulture_evm_beta', - '3141': 'filecoin___hyperspace_testnet', + '3109': 'satoshivm_alpha', + '3110': 'satoshivm_testnet', + '3141': 'filecoin_hyperspace_testnet', '3269': 'dubxcoin', '3270': 'dubxcoin_testnet', '3306': 'debounce_subnet_testnet', '3331': 'zcore_testnet', - '3333': 'web3q_testnet', + '3333': 'ethstorage_testnet', '3334': 'web3q_galileo', + '3335': 'ethstorage', + '3338': 'peaq', '3400': 'paribu_net', + '3424': 'evolve', '3434': 'secure_testnet', + '3456': 'layeredge_testnet', + '3490': 'gtcscan', '3500': 'paribu_net_testnet', '3501': 'jfin', '3601': 'pandoproject', '3602': 'pandoproject_testnet', + '3630': 'tycooncoin', '3636': 'botanix_testnet', '3637': 'botanix', '3639': 'i', + '3645': 'i_testnet', '3666': 'jouleverse', '3690': 'bittex', '3693': 'empire', @@ -570,7 +769,9 @@ network_names = { '3699': 'senjepowers', '3701': 'xpla_testnet', '3737': 'crossbell', + '3776': 'astar_zkevm', '3797': 'alvey', + '3799': 'tangle_testnet', '3885': 'fire_zkevm_ghostrider', '3888': 'kaly', '3889': 'kaly_testnet', @@ -578,33 +779,50 @@ network_names = { '3939': 'dos_tesnet', '3966': 'dyno', '3967': 'dyno_testnet', + '3993': 'apex_testnet', '3999': 'yuan', '4000': 'ozone', '4001': 'peperium_testnet', '4002': 'fantom_testnet', '4003': 'x1_fastnet', + '4040': 'carbonium_testnet', + '4048': 'gan_testnet', '4051': 'bobaopera_testnet', + '4058': 'bahamut_ocean', '4061': 'nahmii_3', '4062': 'nahmii_3_testnet', '4078': 'muster', + '4080': 'tobe_testnet', + '4088': 'zeroth', '4090': 'fastex_bahamut_oasis_testnet', '4096': 'bitindi_testnet', '4099': 'bitindi', '4102': 'aioz_testnet', '4139': 'humans.ai_testnet', '4141': 'tipboxcoin_testnet', + '4157': 'crossfi_testnet', + '4162': 'sx_rollup', '4181': 'phi_v1', + '4200': 'merlin', '4201': 'lukso_testnet', + '4202': 'lisk_sepolia_testnet', '4242': 'nexi', + '4243': 'nexi_v2', + '4269': 'laika_testnet', '4328': 'bobafuji_testnet', '4337': 'beam', '4400': 'credit', '4444': 'htmlcoin', '4460': 'orderly_sepolia_testnet', + '4488': 'hydra', + '4544': 'emoney_testnet', + '4613': 'very', + '4653': 'gold', '4689': 'iotex', '4690': 'iotex_testnet', '4759': 'meverse_testnet', '4777': 'blackfort_exchange_testnet', + '4801': 'world_sepolia_testnet', '4893': 'globel', '4918': 'venidium_testnet', '4919': 'venidium', @@ -614,6 +832,18 @@ network_names = { '5002': 'treasurenet_alpha', '5003': 'mantle_sepolia_testnet', '5005': 'treasurenet_testnet', + '5039': 'onigiri_test_subnet', + '5040': 'onigiri_subnet', + '5051': 'nollie_skate_testnet', + '5100': 'syndicate_testnet', + '5101': 'syndicate_frame', + '5102': 'sic_testnet', + '5103': 'coordinape_testnet', + '5104': 'charmverse_testnet', + '5105': 'superloyalty_testnet', + '5106': 'azra_testnet', + '5112': 'ham', + '5151': 'me_testnet', '5165': 'bahamut', '5169': 'smart_layer', '5177': 'tl', @@ -621,65 +851,113 @@ network_names = { '5234': 'humanode', '5290': 'fire_old', '5315': 'uzmi', + '5317': 'optrust_testnet', + '5321': 'itx_testnet', + '5333': 'netsbo', '5353': 'tritanium_testnet', + '5372': 'settlus_testnet', + '5424': 'edexa', + '5439': 'ego', '5522': 'vex_evm_testnet', - '5551': 'nahmii', - '5553': 'nahmii_testnet', + '5545': 'duck', + '5551': 'nahmii_2', + '5553': 'nahmii_2_testnet', '5555': 'verse', '5611': 'opbnb_testnet', + '5615': 'arcturus_testneet', '5616': 'arcturus_testnet', - '5678': 'tanssi_evm_container', + '5656': 'qie_block', + '5675': 'filenova_testnet', + '5678': 'tanssi_demo', '5700': 'syscoin_tanenbaum_testnet', '5729': 'hika_testnet', '5758': 'satoshi_testnet', '5777': 'ganache', + '5845': 'tangle', '5851': 'ontology_testnet', + '5858': 'chang_foundation', '5869': 'wego_rubidium', + '6000': 'bouncebit_testnet', + '6001': 'bouncebit', '6065': 'tres_testnet', '6066': 'tres', '6102': 'cascadia_testnet', '6118': 'uptn_testnet', '6119': 'uptn', + '6283': 'laos', + '6321': 'aura_euphoria_testnet', + '6322': 'aura', '6363': 'digit_soul', + '6398': 'connext_sepolia', '6502': 'peerpay', + '6550': 'flamma_testnet', '6552': 'scolcoin_wei_testnet', '6565': 'fox_testnet', '6626': 'pixie', '6660': 'latest_testnet', '6661': 'cybria', '6666': 'cybria_testnet', + '6667': 'stor', + '6678': 'edge_matrix', '6688': 'irishub', + '6699': 'ox', + '6701': 'paxb', '6779': 'compverse', - '6789': 'gold', + '6805': 'race', + '6806': 'race_testnet', + '6868': 'pools', + '6880': 'mtt', + '6942': 'laika', '6969': 'tomb', '6999': 'polysmart', '7000': 'zeta', - '7001': 'zeta_athens_3_testnet', + '7001': 'zeta_testnet', + '7007': 'bst', '7027': 'ella_the_heart', '7070': 'planq', + '7077': 'planq_atlas_testnet', '7100': 'nume', '7118': 'help_the_homeless', '7171': 'bitrock', + '7210': 'nibiru_testnet_1', + '7222': 'nibiru_devnet_3', + '7244': 'zeus_testnet', + '7300': 'xpla_verse', '7331': 'klyntar', '7332': 'horizen_eon', '7341': 'shyft', '7484': 'raba', '7518': 'meverse', + '7560': 'cyber', '7575': 'adil_testnet', '7576': 'adil_v2', '7668': 'the_root', - '7672': 'the_root___porcini_testnet', + '7672': 'the_root_porcini_testnet', '7700': 'canto', '7701': 'canto_tesnet', '7771': 'bitrock_testnet', + '7774': 'gdcc', + '7775': 'gdcc_testnet', + '7776': 'pandasea', '7777': 'rise_of_the_warbots_testnet', + '7778': 'orenium_protocol', + '7798': 'openex_long_testnet', '7860': 'maal_testnet', + '7862': 'maal_v2', + '7863': 'maal_testnet_v2', '7878': 'hazlor_testnet', + '7887': 'kinto', '7895': 'ardenium_athena', + '7923': 'dot_blox', + '7924': 'mo', '7979': 'dos', '8000': 'teleport', '8001': 'teleport_testnet', + '8008': 'polynomial', + '8017': 'isuncoin', '8029': 'mdgl_testnet', + '8047': 'boat', + '8054': 'karak_sepolia', '8080': 'shardeum_liberty_1.x', '8081': 'shardeum_liberty_2.x', '8082': 'shardeum_sphinx_1.x', @@ -695,11 +973,16 @@ network_names = { '8181': 'testnet_beone', '8192': 'torus', '8194': 'torus_testnet', - '8217': 'klaytn_cypress', + '8217': 'kaia', + '8227': 'space_subnet', '8272': 'blockton_block', '8285': 'korthotest', + '8329': 'lorenzo', + '8333': 'b3', '8387': 'dracones_financial_services', + '8428': 'that', '8453': 'base', + '8545': 'chakra_testnet', '8654': 'toki', '8655': 'toki_testnet', '8668': 'hela_official_runtime', @@ -707,26 +990,47 @@ network_names = { '8724': 'tool_global_testnet', '8726': 'storage', '8727': 'storage_testnet', + '8732': 'bullions', '8738': 'alph', '8768': 'tmy', + '8822': 'iota_evm', + '8844': 'hydra_testnet', '8848': 'maro_block', + '8866': 'superlumio', + '8869': 'lif3', '8880': 'unique', '8881': 'quartz_by_unique', '8882': 'opal_testnet_by_unique', '8883': 'sapphire_by_unique', + '8886': 'avenium_testnet', '8888': 'xana', '8889': 'vyvo', + '8890': 'orenium_testnet_protocol', '8898': 'mammoth', '8899': 'jib', + '8911': 'algen', + '8912': 'algen_testnet', + '8921': 'algen_layer2', + '8922': 'algen_layer2_testnet', '8989': 'giant_mammoth', '8995': 'bloxberg', '9000': 'evmos_testnet', '9001': 'evmos', + '9007': 'shido_testnet_block', + '9008': 'shido_block', '9012': 'berylbit', + '9024': 'nexa_testnet_block', + '9025': 'nexa_block', + '9069': 'apex_fusion_nexus', + '9070': 'apex_fusion_nexus_testnet', '9100': 'genesis_coin', '9170': 'rinia_testnet_old', '9223': 'codefin', '9339': 'dogcoin_testnet', + '9372': 'oasys_testnet', + '9393': 'dela_sepolia_testnet', + '9395': 'evoke', + '9496': 'weavevm_testnet', '9527': 'rangers_protocol_testnet_robin', '9528': 'qeasyweb3_testnet', '9559': 'neonlink_testnet', @@ -734,214 +1038,374 @@ network_names = { '9728': 'boba_bnb_testnet', '9768': 'mainnetz_testnet', '9779': 'pepenetwork', + '9789': 'tabi_testnet', '9790': 'carbon_evm', '9792': 'carbon_evm_testnet', + '9797': 'optimusz7', '9818': 'imperium_testnet', '9819': 'imperium', + '9876': 'binary_testnet', '9888': 'dogelayer', + '9897': 'arena_z_testnet', + '9898': 'larissa', + '9911': 'espento', + '9966': 'uxer_testnet', '9977': 'mind_testnet', '9980': 'combo', + '9981': 'volley', '9990': 'agung', - '9996': 'mind', '9997': 'altlayer_testnet', + '9998': 'ztc', '9999': 'myown_testnet', '10000': 'smart_bitcoin_cash', '10001': 'smart_bitcoin_cash_testnet', '10024': 'gon', '10081': 'japan_open_testnet', '10086': 'sjatsh', + '10096': 'metanova_verse', '10101': 'block_genesis', '10200': 'gnosis_chiado_testnet', '10201': 'maxx', + '10222': 'glscan', '10242': 'arthera', '10243': 'arthera_testnet', '10248': '0xtade', + '10321': 'tao_evm', + '10324': 'tao_evm_testnet', '10395': 'worldland_testnet', '10507': 'numbers', '10508': 'numbers_testnet', '10823': 'cryptocoinpay', + '10849': 'lamina1', + '10850': 'lamina1_identity', '10946': 'quadrans_block', '10947': 'quadrans_block_testnet', + '11000': 'kb', + '11011': 'shape_sepolia_testnet', '11110': 'astra', '11111': 'wagmi', '11115': 'astra_testnet', '11119': 'hashbit', + '11124': 'abstract_testnet', + '11221': 'shine', + '11227': 'jiritsu_testnet_subnet', '11235': 'haqq', '11437': 'shyft_testnet', + '11501': 'bevm', + '11503': 'bevm_testnet', + '11521': 'sats', '11612': 'sardis_testnet', - '11888': 'sanr', + '11822': 'artela_testnet', '11891': 'polygon_supernet_arianee', + '12001': 'fuse_testnet', '12009': 'satoshi', + '12020': 'aternos', '12051': 'singularity_zero_testnet', '12052': 'singularity_zero', '12123': 'brc', '12306': 'fibonacci', '12321': 'blg_testnet', + '12324': 'l3x_protocol', + '12325': 'l3x_protocol_testnet', '12345': 'step_testnet', - '12611': 'astar_zkevm', + '12553': 'rss3_vsl', '12715': 'rikeza_testnet', + '12781': 'playdapp_testnet', '12890': 'quantum_testnet', + '12898': 'playfair_testnet_subnet', '13000': 'sps', '13337': 'beam_testnet', + '13370': 'cannon_testnet', '13371': 'immutable_zkevm', '13381': 'phoenix', + '13396': 'masa', '13473': 'immutable_zkevm_testnet', + '13505': 'gravity_alpha_testnet_sepolia', + '13600': 'kronobit', '13812': 'susono', '14000': 'sps_testnet', + '14088': 'zeroth_testnet', + '14324': 'evolve_testnet', + '14333': 'vitruveo_testnet', + '14800': 'vana_moksha_testnet', + '14801': 'vana_satori_testnet', '14853': 'humanode_testnet_5_israfel', '15003': 'immutable_zkevm_devnet', + '15257': 'poodl_testnet', + '15259': 'poodl', + '15430': 'kymtc', '15551': 'loopnetwork', '15555': 'trust_evm_testnet', '15557': 'eos_evm_testnet', '16000': 'metadot', '16001': 'metadot_testnet', + '16116': 'defiverse', + '16166': 'cypherium', + '16180': 'plyr_phi', + '16350': 'incentiv_devnet', + '16481': 'pivotal_sepolia', '16507': 'genesys', + '16600': '0g_newton_testnet', '16688': 'irishub_testnet', '16718': 'airdao', '16888': 'ivar_testnet', '17000': 'holesky', '17001': 'redstone_holesky_testnet', + '17069': 'garnet_holesky', + '17071': 'on_points', + '17117': 'defiverse_testnet', '17171': 'g8', + '17172': 'eclipse_subnet', '17180': 'palette_testnet', + '17217': 'konet', '17777': 'eos_evm', '18000': 'frontier_of_dreams_testnet', '18122': 'smart_trades', '18159': 'proof_of_memes', '18181': 'g8_testnet', - '18686': 'mxc_zkevm', + '18231': 'unreal_old', + '18233': 'unreal', + '18686': 'mxc_zkevm_moon', + '18888': 'titan_tkx', + '18889': 'titan_tkx_testnet', '19011': 'home_verse', + '19077': 'blockx_atlantis_testnet', + '19191': 'blockx', + '19224': 'decentraconnect_social', + '19527': 'magnet', + '19600': 'lbry', '19845': 'btcix', '20001': 'camelark', + '20041': 'niza', + '20073': 'niza_testnet', '20729': 'callisto_testnet', '20736': 'p12', + '20765': 'jono11_subnet', + '21004': 'c4ei', + '21133': 'all_about_healthy', + '21223': 'dcpay', + '21224': 'dcpay_testnet', '21337': 'cennznet_azalea', + '21363': 'lestnet', '21816': 'om', '21912': 'bsl', '22023': 'taycan', '22040': 'airdao_testnet', '22222': 'nautilus', '22324': 'goldx_testnet', - '22776': 'map', + '22776': 'map_protocol', '23006': 'antofy_testnet', '23118': 'opside_testnet', '23294': 'oasis_sapphire', '23295': 'oasis_sapphire_testnet', + '23451': 'dreyerx', + '23452': 'dreyerx_testnet', '23888': 'blast_testnet', + '24076': 'kymtc_testnet', '24484': 'web', '24734': 'mintme.com', + '25186': 'liquidlayer', + '25327': 'everclear', + '25839': 'alvey_testnet', '25888': 'hammer', '25925': 'bitkub_testnet', '26026': 'ferrum_testnet', + '26482': 'ducatusx_testnet', + '26483': 'ducatusx', '26600': 'hertz', '26863': 'oasis', + '27181': 'klaos_nova', + '27483': 'nanon_sepolia', + '27827': 'zeroone_subnet', + '28516': 'vizing_testnet', + '28518': 'vizing', '28528': 'optimism_bedrock_goerli_alpha_testnet', + '28882': 'boba_sepolia', + '29112': 'hy_testnet', + '29223': 'nexa_metanet', + '29536': 'kai_testnet', '29548': 'mch_verse', + '30000': 'q', '30067': 'piece_testnet', + '30088': 'miyou', '30103': 'cerium_testnet', + '30730': 'movement_evm_legacy', + '30731': 'movement_evm_devnet', + '30732': 'movement_evm_testnet', '31102': 'ethersocial', '31223': 'cloudtx', '31224': 'cloudtx_testnet', '31337': 'go_testnet', - '31415': 'filecoin___wallaby_testnet', + '31414': 'evoke_testnet', + '31415': 'filecoin_wallaby_testnet', + '31753': 'x', + '31754': 'x_testnet', + '32001': 'w3gamez_holesky_testnet', + '32382': 'santiment_intelligence', '32520': 'bitgert', '32659': 'fusion', '32769': 'zilliqa_evm', '32990': 'zilliqa_evm_isolated_server', + '33033': 'entangle', '33101': 'zilliqa_evm_testnet', + '33103': 'zilliqa_2_evm_proto_testnet', + '33111': 'curtis', + '33133': 'entangle_testnet', '33210': 'cloudverse_subnet', '33333': 'aves', '33385': 'zilliqa_evm_devnet', + '33401': 'slingshot', '33469': 'zilliqa_2_evm_devnet', + '33979': 'funki', '34443': 'mode', + '34504': 'zeus', '35011': 'j2o_taro', - '35441': 'q', '35443': 'q_testnet', '38400': 'connectormanager', '38401': 'connectormanager_robin', + '39656': 'prm', '39797': 'energi', '39815': 'oho', + '40000': 'div', + '41455': 'aleph_zero_evm', '41500': 'opulent_x_beta', '42069': 'pegglecoin', - '42161': 'arbitrum_one', + '42072': 'agentlayer_testnet', + '42161': 'arbitrum', '42170': 'arbitrum_nova', '42220': 'celo', '42261': 'oasis_emerald_testnet', '42262': 'oasis_emerald', '42355': 'goldx', + '42421': 'asset_testnet', '42766': 'zkfair', + '42793': 'etherlink', '42801': 'gesoten_verse_testnet', '42888': 'kinto_testnet', '43110': 'athereum', + '43111': 'hemi', '43113': 'avalanche_fuji_testnet', - '43114': 'avalanche_c', + '43114': 'avalanche', '43288': 'boba_avax', '43851': 'zkfair_testnet', '44444': 'fren', + '44445': 'quantum', '44787': 'celo_alfajores_testnet', '45000': 'autobahn', + '45454': 'swamps_l2', + '45510': 'deelance', + '45513': 'blessnet', '46688': 'fusion_testnet', + '47763': 'neo_x', + '47803': 'redefi_layer_1', '47805': 'rei', + '48795': 'space_subnet_testnet', + '48899': 'zircuit_testnet', + '48900': 'zircuit', '49049': 'wireshape_floripa_testnet', '49088': 'bifrost_testnet', + '49321': 'gunz_testnet', '49797': 'energi_testnet', '50001': 'liveplex_oracleevm', '50005': 'yooldo_verse', '50006': 'yooldo_verse_testnet', '50021': 'gton_testnet', + '50888': 'erbie', '51178': 'lumoz_testnet_alpha', '51712': 'sardis', '52014': 'electroneum', + '53277': 'doid', + '53302': 'superseed_sepolia_testnet', + '53457': 'dodo_testnet', '53935': 'dfk', + '54176': 'overprotocol', '54211': 'haqq_testnet', '54321': 'toronet_testnet', '55004': 'titan', + '55551': 'photon_aurora_testnet', '55556': 'rei_testnet', + '55614': 'flamma', + '56026': 'lambda', '56288': 'boba_bnb', + '56400': 'testnet_zeroone_subnet', '56789': 'velo_labs', + '56797': 'doid_testnet', '57000': 'rollux_testnet', + '57451': 'coinsec', '58008': 'sepolia_pgn_public_goods', - '59140': 'linea_testnet', + '58680': 'lumoz_quidditch_testnet', + '59140': 'linea_goerli', + '59141': 'linea_sepolia', '59144': 'linea', + '59902': 'metis_sepolia_testnet', '59971': 'genesys_code', '60000': 'thinkium_testnet_0', '60001': 'thinkium_testnet_1', '60002': 'thinkium_testnet_2', '60103': 'thinkium_testnet_103', + '60808': 'bob', + '61022': 'orange', + '61406': 'kai', '61800': 'axel_dev_net', '61803': 'etica', '61916': 'doken_super', + '62049': 'optopia_testnet', + '62050': 'optopia', + '62298': 'citrea_devnet', '62320': 'celo_baklava_testnet', '62621': 'multivac', + '62831': 'plyr_tau_testnet', + '62850': 'laos_sigma_testnet', '63000': 'ecredits', '63001': 'ecredits_testnet', + '63002': 'esync_testnet', + '65349': 'cratd2c_testnet', + '65357': 'vecno', '65450': 'scolcoin', + '65536': 'automata', + '66665': 'creator_testnet', '66988': 'janus_testnet', '67390': 'siriusnet', '67588': 'cosmic', '68770': 'dm2_verse', + '68775': 'dm2_verse_testnet', '69420': 'condrieu', '70000': 'thinkium_0', '70001': 'thinkium_1', '70002': 'thinkium_2', '70103': 'thinkium_103', + '70700': 'proof_of_play_apex', '71111': 'guapcoinx', '71393': 'polyjuice_testnet', '71401': 'godwoken_testnet_v1', '71402': 'godwoken', + '72778': 'caga_crypto_ankara_testnet', '72992': 'grok', + '73114': 'icb_testnet', + '73115': 'icb', '73799': 'energy_web_volta_testnet', '73927': 'mixin_virtual_machine', '75000': 'resincoin', + '75512': 'geek_verse', + '75513': 'geek_verse_testnet', + '77001': 'bora', '77238': 'foundry_testnet', '77612': 'vention', + '77677': 'cycle_sailboat', '77777': 'toronet', '78110': 'firenze_test', '78281': 'dragonfly_hexapod', '78430': 'amplify_subnet', '78431': 'bulletin_subnet', '78432': 'conduit_subnet', + '78600': 'vanguard', '79879': 'gold_testnet', '80001': 'mumbai', + '80002': 'amoy', + '80008': 'polynomia_sepolia', + '80084': 'bera_bartio', + '80085': 'bera_artio', + '80096': 'hizoco', '81041': 'nordek', '81341': 'amana_testnet', '81342': 'amana_mixnet', @@ -952,22 +1416,41 @@ network_names = { '81361': 'mizana_testnet', '81362': 'mizana_mixnet', '81363': 'mizana_privnet', - '81720': 'quantum', '82459': 'smart_layer_testnet', + '83144': 'xprotocol_testnet', + '83278': 'esa', + '83872': 'zedxion', '84531': 'base_goerli_testnet', '84532': 'base_sepolia_testnet', '84886': 'aerie', '85449': 'cybertrust', '88002': 'nautilus_proteus_testnet', + '88559': 'inoai', + '88800': 'zkasino', + '88817': 'unit_zero_testnet', + '88819': 'unit_zero_stagenet', '88880': 'chiliz_scoville_testnet', - '88888': 'ivar', + '88882': 'chiliz_spicy_testnet', + '88888': 'chiliz', + '90001': 'fxcore_testnet', '90210': 'beverly_hills', + '90354': 'camp_testnet', '91002': 'nautilus_trition', + '91120': 'metadap_enterprise', '91715': 'combo_testnet', '92001': 'lambda_testnet', + '93572': 'liquidlayer_testnet', + '93747': 'stratovm_testnet', '96970': 'mantis_testnet_hexapod', + '97053': 'tetron_testnet', + '97055': 'tetron', '97288': 'boba_bnb_old', + '97435': 'slingshot_testnet', + '97531': 'green_testnet', + '97970': 'optimusz7_testnet', + '98881': 'ebi', '99099': 'eliberty_testnet', + '99876': 'edge_matrix_testnet', '99998': 'ubtestnet', '99999': 'ub', '100000': 'quark_root', @@ -981,8 +1464,15 @@ network_names = { '100008': 'quark_shard_7', '100009': 've', '100010': 've_testnet', - '101010': 'soverun_testnet', + '100011': 'quark_l2', + '101010': 'global_trust', + '102030': 'creditcoin', + '102031': 'creditcoin_testnet', + '102032': 'creditcoin_devnet', '103090': 'crystaleum', + '103454': 'masa_testnet', + '104566': 'kaspaclassic', + '105105': 'stratis', '108801': 'bro', '110000': 'quark_devnet_root', '110001': 'quark_devnet_shard_0', @@ -993,58 +1483,106 @@ network_names = { '110006': 'quark_devnet_shard_5', '110007': 'quark_devnet_shard_6', '110008': 'quark_devnet_shard_7', + '110011': 'quark_l2_testnet', + '110110': 'mars_credit', '111000': 'siberium_test', '111111': 'siberium', + '111188': 're.al', '112358': 'meta_one', + '119139': 'metadap_enterprise_testnet', + '123321': 'gem', '123456': 'adil_devnet', + '128123': 'etherlink_testnet', + '131313': 'odyssey_testnet', '131419': 'etnds', + '132902': 'form_testnet', + '141319': 'magape_testnet', '142857': 'icplaza', + '161212': 'playfi', + '165279': 'eclat', + '167000': 'taiko', '167004': 'taiko_alpha_2_testnet', '167005': 'taiko_grimsvotn_l2', '167006': 'taiko_eldfell_l3', '167007': 'taiko_jolnir_l2', + '167008': 'taiko_katla_l2', + '167009': 'taiko_hekla_l2', + '168168': 'zs', + '171000': 'fair_testnet', + '175177': 'chronicle_lit_protocol_testnet', + '175188': 'chronicle_yellowstone_lit_protocol_testnet', '188710': 'bitica', '188881': 'condor_test', + '199991': 'mazze_testnet', + '200000': 'xfair.ai_testnet', '200101': 'milkomeda_c1_testnet', '200202': 'milkomeda_a1_testnet', '200625': 'akroma', + '200810': 'bitlayer_testnet', + '200901': 'bitlayer', '201018': 'alaya', '201030': 'alaya_dev_testnet', '201804': 'mythical', '202020': 'decimal_testnet', + '202105': 'duck_testnet', + '202202': 'bethel_sydney', '202212': 'x1_devnet', + '202401': 'ymtech_besu_testnet', '202624': 'jellie', '204005': 'x1_network', + '205205': 'auroria_testnet', + '210049': 'gitagi_atlas_testnet', '210425': 'platon', + '212013': 'litentry', '220315': 'mas', '221230': 'reap', '221231': 'reap_testnet', + '222222': 'hydradx', + '222555': 'deepl', + '222666': 'deepl_testnet', '224168': 'taf_eco', '224422': 'conet_sebolia_testnet', '224433': 'conet_holesky', - '230315': 'hashkey_testnet', + '229772': 'abyss_protocol', + '230315': 'hashkey_testnetdiscard', '234666': 'haymo_testnet', + '240515': 'orange_testnet', '246529': 'artis_sigma1', '246785': 'artis_testnet_tau1', '247253': 'saakuru_testnet', '256256': 'cmp', + '262371': 'eclat_testnet', '266256': 'gear_zero_testnet', '271271': 'egoncoin_testnet', '281121': 'social', - '314159': 'filecoin___calibration_testnet', + '282828': 'zillion_sepolia_testnet', + '292003': 'cipherem_testnet', + '309075': 'one_world', + '313313': 'saharaai_testnet', + '314159': 'filecoin_calibration_testnet', + '322202': 'parex', + '323213': 'bloom_genesis_testnet', + '327126': 'waba_testnet', + '328527': 'nal', '330844': 'ttcoin', + '333313': 'bloom_genesis', '333331': 'aves_testnet', '333333': 'nativ3_testnet', '333666': 'oone_testnet', '333777': 'oone_devnet', '333888': 'polis_testnet', '333999': 'polis', + '336655': 'up_testnet', + '336666': 'up', + '355110': 'bitfinity', '355113': 'bitfinity_testnet', + '360890': 'lavita', '363636': 'digit_soul_2', '373737': 'hap_testnet', '381931': 'metal_c', '381932': 'metal_tahoe_c', '404040': 'tipboxcoin', + '413413': 'aie_testnet', '420420': 'kek', '420666': 'kek_kektest', '420692': 'alterium_l2_testnet', @@ -1055,30 +1593,64 @@ network_names = { '431140': 'markr_go', '432201': 'dexalot_subnet_testnet', '432204': 'dexalot_subnet', + '444444': 'syndr_l3_sepolia', '444900': 'weelink_testnet', '471100': 'patex_sepolia_testnet', '473861': 'ultra_pro', '474142': 'open', + '486487': 'gobbl_testnet', + '490000': 'autonomys_testnet_nova_domain', + '504441': 'playdapp', '512512': 'cmp_testnet', - '513100': 'ethereum_fair', + '513100': 'dis', + '526916': 'docoin_community', '534351': 'scroll_sepolia_testnet', '534352': 'scroll', '534353': 'scroll_alpha_testnet', '534354': 'scroll_pre_alpha_testnet', '534849': 'shinarium_beta', '535037': 'beaneco_smart', + '541764': 'overprotocol_testnet', + '552981': 'one_world_testnet', + '555555': 'pentagon_testnet', + '555666': 'eclipse_testnet', + '555888': 'dustboy_iot', '622277': 'hypra', + '622463': 'atlas', '641230': 'bear', '651940': 'all', - '666666': 'vision___vpioneer_test', + '656476': 'open_campus_codex', + '660279': 'xai', + '666666': 'vision_vpioneer_test', '666888': 'hela_official_runtime_testnet', + '686868': 'won', + '696969': 'galadriel_devnet', + '710420': 'tiltyard_subnet', + '713715': 'sei_devnet', + '721529': 'eram', + '723107': 'tix_testnet', + '743111': 'hemi_sepolia', '751230': 'bear_testnet', + '752024': 'ternoa_testnet', '761412': 'miexs_smart', + '764984': 'lamina1_testnet', + '767368': 'lamina1_identity_testnet', '776877': 'modularium', '800001': 'octaspace', + '808080': 'biz_testnet', + '808813': 'bob_sepolia', + '810180': 'zklink_nova', + '810181': 'zklink_nova_sepolia_testnet', + '810182': 'zklink_nova_goerli_testnet', + '812397': 'sg_verse', + '820522': 'tsc_testnet', '827431': 'curve', + '839320': 'prm_testnet', + '840000': 'runevm_testnet', '846000': '4goodnetwork', '855456': 'dodao', + '879151': 'blocx', + '888882': 'rexx', '888888': 'vision', '900000': 'posi_shard_0', '910000': 'posi_testnet_shard_0', @@ -1086,92 +1658,166 @@ network_names = { '920000': 'posi_devnet_shard_0', '920001': 'posi_devnet_shard_1', '923018': 'fncy_testnet', + '955081': 'jono12_subnet', '955305': 'eluvio_content_fabric', + '978657': 'treasure_ruby', + '984122': 'forma', + '984123': 'forma_sketchpad', '988207': 'ecrox', - '1127469': 'tiltyard_subnet', + '998899': 'supernet_testnet', + '999999': 'am', + '1100789': 'netmind_testnet', + '1234567': 'sharecle', '1261120': 'zkatana', '1313114': 'etho_protocol', '1313500': 'xerom', '1337702': 'kintsugi', '1337802': 'kiln', '1337803': 'zhejiang', + '1398243': 'automata_testnet', + '1398244': 'automata_orbit_testnet', + '1612127': 'playfi_albireo_testnet', + '1637450': 'xterio_testnet', + '1731313': 'turkey_demo_dev', '2021398': 'debank_testnet', '2099156': 'plian_main', '2206132': 'platon_dev_testnet2', '2611555': 'dpu', - '3141592': 'filecoin___butterfly_testnet', + '2702128': 'xterio', + '3132023': 'saharaai', + '3141592': 'filecoin_butterfly_testnet', + '3397901': 'funki_sepolia_sandbox', '3441005': 'manta_pacific_testnet', + '3441006': 'manta_pacific_sepolia_testnet', '4000003': 'altlayer_zero_gas', '4281033': 'worlds_caldera', + '4444444': 'altar_testnet', + '4457845': 'zero_testnet_sepolia', + '5112023': 'numblock', '5167003': 'mxc_wannsee_zkevm_testnet', + '5167004': 'moon_geneva_testnet', '5201420': 'electroneum_testnet', + '5318008': 'reactive_kopli', '5555555': 'imversed', '5555558': 'imversed_testnet', + '6038361': 'astar_zkyoto', + '6666665': 'safeanwang', + '6666666': 'safeanwang_testnet', + '7082400': 'coti_testnet', '7225878': 'saakuru', '7355310': 'openvessel', '7668378': 'ql1_testnet', '7762959': 'musicoin', '7777777': 'zora', '8007736': 'plian_sub_1', + '8008135': 'fhenix_helium', '8080808': 'hokum', + '8601152': 'waterfall_8_test', '8794598': 'hap', '8888881': 'quarix_testnet', '8888888': 'quarix', '9322252': 'xcap', '9322253': 'milvine', + '9999999': 'fluence', '10067275': 'plian_testnet_sub_1', '10101010': 'soverun', + '10241024': 'alienx', + '10241025': 'alienx_hal_testnet', + '11145513': 'blessnet_sepolia', '11155111': 'sepolia', '11155420': 'op_sepolia_testnet', + '12052024': 'memento_testnet', + '12227331': 'neox_testnet_t3', + '12227332': 'neo_x_testnet_t4', + '13068200': 'coti_devnet', '13371337': 'pep_churchill', '14288640': 'andus', '16658437': 'plian_testnet_main', + '18071918': 'mande', '18289463': 'iolite', + '19850818': 'deepbrain_testnet', + '19880818': 'deepbrain', + '20180427': 'stability_testnet', '20180430': 'smartmesh', '20181205': 'quarkblock', '20201022': 'pego', + '20230825': 'vcity_testnet', + '20240324': 'debank_sepolia_testnet', + '20240603': 'dbk', + '20241133': 'swan_proxima_testnet', '20482050': 'hokum_testnet', '22052002': 'excelon', + '24772477': '6degree_of_outreach_testnet', '27082017': 'excoincial_volta_testnet', '27082022': 'excoincial', + '28122024': 'ancient8_testnet', '28945486': 'auxilium', '29032022': 'fla', - '31415926': 'filecoin___local_testnet', + '31415926': 'filecoin_local_testnet', + '33626250': 'toliman_suave_testnet', '35855456': 'joys_digital', + '37084624': 'skale_nebula_hub_testnet', + '39916801': 'kingdom', '43214913': 'maistestsubnet', + '52164803': 'fluence_testnet', '61717561': 'aqua', '65010000': 'autonity_bakerloo_thames_testnet', '65010001': 'autonity_bakerloo_barada_testnet', + '65010002': 'autonity_bakerloo_sumida_testnet', + '65010003': 'autonity_bakerloo_yamuna_testnet', '65100000': 'autonity_piccadilly_thames_testnet', '65100001': 'autonity_piccadilly_barada_testnet', + '65100002': 'autonity_piccadilly_sumida_testnet', + '65100003': 'autonity_piccadilly_yamuna_testnet', '68840142': 'frame_testnet', + '77787778': '0xhash_testnet', + '79479957': 'sx_toronto_rollup', + '88558801': 'backstop_testnet', '88888888': 't.e.a.m_block', + '94204209': 'polygon_blackberry', '99415706': 'joys_digital_testnet', + '100000000': 'ethos', + '108160679': 'orai', + '111557560': 'cyber_testnet', + '123420111': 'op_celestia_raspberry', + '161221135': 'plume_testnet', + '168587773': 'blast_sepolia_testnet', '192837465': 'gather', '222000222': 'kanazawa', '245022926': 'neon_evm_devnet', + '245022929': 'neon_evm_devnet_rollup', '245022934': 'neon_evm', '245022940': 'neon_evm_testnet', '278611351': 'razor_skale', '311752642': 'oneledger', + '328527624': 'nal_sepolia_testnet', '333000333': 'meld', - '344106930': 'skale_calypso_hub_testnet', '356256156': 'gather_testnet', - '476158412': 'skale_europa_hub_testnet', + '476462898': 'skopje_testnet', '486217935': 'gather_devnet', - '503129905': 'skale_nebula_hub_testnet', + '531050104': 'sophon_testnet', + '666666666': 'degen', + '728126428': 'tron', + '888888888': 'ancient8', + '889910245': 'ptcescan_testnet', + '889910246': 'ptcescan', + '974399131': 'skale_calypso_hub_testnet', '999999999': 'zora_sepolia_testnet', + '1020352220': 'skale_titan_hub_testnet', '1122334455': 'ipos', '1146703430': 'cyberdecknet', '1273227453': 'human_protocol', '1313161554': 'aurora', '1313161555': 'aurora_testnet', '1313161556': 'aurora_betanet', + '1313161560': 'powergold', '1350216234': 'skale_titan_hub', '1351057110': 'chaos_skale_testnet', + '1380012617': 'rari', '1380996178': 'raptor', + '1444673419': 'skale_europa_hub_testnet', '1482601649': 'skale_nebula_hub', - '1517929550': 'skale_titan_hub_testnet', + '1511670449': 'gpt', '1564830818': 'skale_calypso_hub', '1666600000': 'harmony_shard_0', '1666600001': 'harmony_shard_1', @@ -1181,17 +1827,26 @@ network_names = { '1666700001': 'harmony_testnet_shard_1', '1666900000': 'harmony_devnet_shard_0', '1666900001': 'harmony_devnet_shard_1', + '1722641160': 'silicon_zkevm_sepolia_testnet', + '1802203764': 'kakarot_sepolia', + '1903648807': 'gemu_testnet', + '1918988905': 'rari_testnet', '2021121117': 'datahopper', '2046399126': 'skale_europa_hub', - '2863311531': 'ancient8_testnet', '3125659152': 'pirl', '4216137055': 'oneledger_testnet_frankenstein', '11297108099': 'palm_testnet', - '11297108109': 'palm', + '28872323069': 'gitswarm_test', + '37714555429': 'xai_testnet_v2', + '88153591557': 'arbitrum_blueberry', '111222333444': 'alphabet', + '111551119090': 'thanos_sepolia', + '123420000220': 'fluence_stage', '197710212030': 'ntity', '197710212031': 'haradev_testnet', + '202402181627': 'gm_testnet', '383414847825': 'zeniq', '666301171999': 'pdc', '6022140761023': 'molereum', + '2713017997578000': 'd_testnet', } diff --git a/python/mesc/network_utils.py b/python/mesc/network_utils.py index ed1adc7..cf7e13e 100644 --- a/python/mesc/network_utils.py +++ b/python/mesc/network_utils.py @@ -1,8 +1,11 @@ from __future__ import annotations -from .types import RpcConfig +import typing from . import network_names +if typing.TYPE_CHECKING: + from .types import RpcConfig + def is_chain_id(chain_id: str) -> bool: """return True if input is a valid chain_id""" @@ -31,3 +34,31 @@ def network_name_to_chain_id( return chain_id else: return None + + +def chain_id_to_standard_hex(chain_id: str) -> str | None: + if chain_id.startswith('0x'): + if len(chain_id) > 2: + as_hex = chain_id + else: + try: + as_hex = hex(int(chain_id)) + except ValueError: + return None + + return '0x' + as_hex[2:].lstrip('0') + + +T = typing.TypeVar('T') + + +def get_by_chain_id(mapping: typing.Mapping[str, T], chain_id: str) -> T | None: + if chain_id in mapping: + return mapping[chain_id] + + standard_mapping = {chain_id_to_standard_hex(k): v for k, v in mapping.items()} + return standard_mapping.get(chain_id_to_standard_hex(chain_id)) + + +def chain_ids_equal(lhs: str, rhs: str) -> bool: + return chain_id_to_standard_hex(lhs) == chain_id_to_standard_hex(rhs) diff --git a/python/mesc/overrides.py b/python/mesc/overrides.py index 5da1571..bb7a632 100644 --- a/python/mesc/overrides.py +++ b/python/mesc/overrides.py @@ -4,10 +4,13 @@ import copy import json import os import re -from typing_extensions import Any, Mapping, MutableMapping +import typing from . import interface, network_utils, exceptions -from .types import RpcConfig, Endpoint, Profile + +if typing.TYPE_CHECKING: + from typing_extensions import Any, Mapping, MutableMapping + from .types import RpcConfig, Endpoint, Profile def apply_env_overrides(config: RpcConfig | None) -> RpcConfig: diff --git a/python/mesc/types.py b/python/mesc/types.py index 380822b..58fa905 100644 --- a/python/mesc/types.py +++ b/python/mesc/types.py @@ -1,6 +1,9 @@ from __future__ import annotations -from typing_extensions import Any, MutableMapping, TypedDict, Literal, Sequence +import typing + +if typing.TYPE_CHECKING: + from typing_extensions import Any, MutableMapping, TypedDict, Literal mesc_env_vars = [ @@ -17,29 +20,29 @@ mesc_env_vars = [ ] -class Endpoint(TypedDict): - name: str - url: str - chain_id: str | None - endpoint_metadata: MutableMapping[str, Any] +if typing.TYPE_CHECKING: + class Endpoint(TypedDict): + name: str + url: str + chain_id: str | None + endpoint_metadata: MutableMapping[str, Any] -class Profile(TypedDict): - name: str - default_endpoint: str | None - network_defaults: MutableMapping[str, str] - profile_metadata: MutableMapping[str, Any] - use_mesc: bool + class Profile(TypedDict): + name: str + default_endpoint: str | None + network_defaults: MutableMapping[str, str] + profile_metadata: MutableMapping[str, Any] + use_mesc: bool - -class RpcConfig(TypedDict): - mesc_version: str - default_endpoint: str | None - endpoints: MutableMapping[str, Endpoint] - network_defaults: MutableMapping[str, str] - network_names: MutableMapping[str, str] - profiles: MutableMapping[str, Profile] - global_metadata: MutableMapping[str, Any] + class RpcConfig(TypedDict): + mesc_version: str + default_endpoint: str | None + endpoints: MutableMapping[str, Endpoint] + network_defaults: MutableMapping[str, str] + network_names: MutableMapping[str, str] + profiles: MutableMapping[str, Profile] + global_metadata: MutableMapping[str, Any] endpoint_types: dict[str, type | tuple[type, ...]] = { @@ -71,61 +74,58 @@ rpc_config_types: dict[str, type | tuple[type, ...]] = { # # query types # +if typing.TYPE_CHECKING: -class EndpointQuery(TypedDict): - query_type: Literal[ - 'default_endpoint', - 'endpoint_by_name', - 'endpoint_by_network', - 'user_input', - ] - fields: ( - DefaultEndpointQuery | EndpointNameQuery | EndpointNetworkQuery | UserInputQuery - ) + class EndpointQuery(TypedDict): + query_type: Literal[ + 'default_endpoint', + 'endpoint_by_name', + 'endpoint_by_network', + 'user_input', + ] + fields: ( + DefaultEndpointQuery + | EndpointNameQuery + | EndpointNetworkQuery + | UserInputQuery + ) + class DefaultEndpointQuery(TypedDict): + profile: str | None -class DefaultEndpointQuery(TypedDict): - profile: str | None + class EndpointNameQuery(TypedDict): + name: str + class EndpointNetworkQuery(TypedDict): + profile: str | None + chain_id: str | int -class EndpointNameQuery(TypedDict): - name: str + class UserInputQuery(TypedDict): + profile: str | None + user_input: str + class MultiEndpointQuery(TypedDict, total=False): + name_contains: str | None + url_contains: str | None + chain_id: str | int | None -class EndpointNetworkQuery(TypedDict): - profile: str | None - chain_id: str + class GlobalMetadataQuery(TypedDict, total=False): + profile: str | None - -class UserInputQuery(TypedDict): - profile: str | None - user_input: str - - -class MultiEndpointQuery(TypedDict, total=False): - name_contains: str | None - url_contains: str | None - chain_id: str | None - - -class GlobalMetadataQuery(TypedDict, total=False): - path: Sequence[str] | None - - -class MescQuery(TypedDict): - query_type: Literal[ - 'default_endpoint', - 'endpoint_by_name', - 'endpoint_by_network', - 'user_input', - 'multi_endpoint', - 'global_metadata', - ] - fields: ( - DefaultEndpointQuery - | EndpointNameQuery - | EndpointNetworkQuery - | UserInputQuery - | MultiEndpointQuery - | GlobalMetadataQuery - ) + class MescQuery(TypedDict): + query_type: Literal[ + 'default_endpoint', + 'endpoint_by_name', + 'endpoint_by_network', + 'user_input', + 'multi_endpoint', + 'global_metadata', + ] + fields: ( + DefaultEndpointQuery + | EndpointNameQuery + | EndpointNetworkQuery + | UserInputQuery + | MultiEndpointQuery + | GlobalMetadataQuery + ) diff --git a/python/mesc/validation.py b/python/mesc/validation.py index c79bbf9..f929db5 100644 --- a/python/mesc/validation.py +++ b/python/mesc/validation.py @@ -1,11 +1,15 @@ from __future__ import annotations -from typing_extensions import Any +import typing from .exceptions import InvalidConfig from .types import rpc_config_types, endpoint_types, profile_types from . import network_utils +if typing.TYPE_CHECKING: + from typing import Sequence + from typing_extensions import Any + def is_valid(config: Any) -> bool: try: @@ -100,7 +104,9 @@ def validate(config: Any) -> None: # default endpoints of each network actually use that specified network for chain_id, endpoint_name in config['network_defaults'].items(): - if chain_id != config['endpoints'][endpoint_name]['chain_id']: + if not network_utils.chain_ids_equal( + chain_id, config['endpoints'][endpoint_name]['chain_id'] + ): raise InvalidConfig( 'Endpoint is set as the default endpoint of network ' + chain_id @@ -109,7 +115,9 @@ def validate(config: Any) -> None: ) for profile_name, profile in config['profiles'].items(): for chain_id, endpoint_name in profile['network_defaults'].items(): - if chain_id != config['endpoints'][endpoint_name]['chain_id']: + if not network_utils.chain_ids_equal( + chain_id, config['endpoints'][endpoint_name]['chain_id'] + ): raise InvalidConfig( 'Endpoint is set as the default endpoint of network ' + chain_id @@ -165,7 +173,28 @@ def validate(config: Any) -> None: ) # no duplicate default network entries using decimal vs hex - pass + ensure_no_chain_id_collisions( + list(config['network_defaults'].keys()), 'network defaults' + ) + for profile_name, profile in config['profiles'].items(): + ensure_no_chain_id_collisions( + list(config['network_defaults'].keys()), 'profile ' + profile_name + ) + + +def ensure_no_chain_id_collisions(chain_ids: Sequence[str], name: str) -> None: + hex_numbers = set() + for chain_id in chain_ids: + as_hex = network_utils.chain_id_to_standard_hex(chain_id) + if as_hex in hex_numbers: + raise Exception( + 'chain_id collision, ' + + str(name) + + ' has multiple decimal/hex values for chain_id: ' + + str(chain_id) + ) + else: + hex_numbers.add(as_hex) def _check_type( diff --git a/python/pyproject.toml b/python/pyproject.toml index 872b7ea..94f0de8 100644 --- a/python/pyproject.toml +++ b/python/pyproject.toml @@ -28,14 +28,17 @@ classifiers = [ "Programming Language :: Python :: 3.12", "Typing :: Typed", ] -dependencies = [ - "typing-extensions >=4.9.0", -] +dependencies = [] [project.urls] Documentation = "https://github.com/paradigmxyz/mesc" Source = "https://github.com/paradigmxyz/mesc" +[project.optional-dependencies] +test = [ + "typing-extensions >=4.9.0", +] + [tool.mypy] python_version = "3.9" strict = true diff --git a/rust/Cargo.lock b/rust/Cargo.lock index 804b0b8..a428cd8 100644 --- a/rust/Cargo.lock +++ b/rust/Cargo.lock @@ -4,24 +4,24 @@ version = 3 [[package]] name = "addr2line" -version = "0.21.0" +version = "0.24.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8a30b2e23b9e17a9f90641c7ab1549cd9b44f296d3ccbf309d2863cfe398a0cb" +checksum = "f5fb1d8e4442bd405fdfd1dacb42792696b0cf9cb15882e5d097b742a676d375" dependencies = [ "gimli", ] [[package]] -name = "adler" -version = "1.0.2" +name = "adler2" +version = "2.0.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f26201604c87b1e01bd3d98f8d5d9a8fcbb815e8cedb41ffccbeb4bf593a35fe" +checksum = "512761e0bb2578dd7380c6baaa0f4ce03e84f95e960231d1dec8bf4d7d6e2627" [[package]] name = "ahash" -version = "0.8.6" +version = "0.8.11" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "91429305e9f0a25f6205c5b8e0d2db09e0708a7a6df0f42212bb56c32c8ac97a" +checksum = "e89da841a80418a9b391ebaea17f5c112ffaaa96f621d2c285b5174da76b9011" dependencies = [ "cfg-if", "getrandom", @@ -32,9 +32,9 @@ dependencies = [ [[package]] name = "aho-corasick" -version = "1.1.2" +version = "1.1.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b2969dcb958b36655471fc61f7e416fa76033bdd4bfed0678d8fee1e2d07a1f0" +checksum = "8e60d3430d3a69478ad0993f19238d2df97c507009a52b3c10addcd7f6bcb916" dependencies = [ "memchr", ] @@ -56,9 +56,9 @@ dependencies = [ [[package]] name = "allocator-api2" -version = "0.2.16" +version = "0.2.18" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0942ffc6dcaadf03badf6e6a2d0228460359d5e34b57ccdc720b7382dfbd5ec5" +checksum = "5c6cb57a04249c6480766f7f7cef5467412af1490f8d1e243141daddada3264f" [[package]] name = "android-tzdata" @@ -77,66 +77,67 @@ dependencies = [ [[package]] name = "ansi_colours" -version = "1.2.2" +version = "1.2.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "6a1558bd2075d341b9ca698ec8eb6fcc55a746b1fc4255585aad5b141d918a80" +checksum = "14eec43e0298190790f41679fe69ef7a829d2a2ddd78c8c00339e84710e435fe" dependencies = [ "rgb", ] [[package]] name = "anstream" -version = "0.6.4" +version = "0.6.15" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "2ab91ebe16eb252986481c5b62f6098f3b698a45e34b5b98200cf20dd2484a44" +checksum = "64e15c1ab1f89faffbf04a634d5e1962e9074f2741eef6d97f3c4e322426d526" dependencies = [ "anstyle", "anstyle-parse", "anstyle-query", "anstyle-wincon", "colorchoice", + "is_terminal_polyfill", "utf8parse", ] [[package]] name = "anstyle" -version = "1.0.4" +version = "1.0.8" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7079075b41f533b8c61d2a4d073c4676e1f8b249ff94a393b0595db304e0dd87" +checksum = "1bec1de6f59aedf83baf9ff929c98f2ad654b97c9510f4e70cf6f661d49fd5b1" [[package]] name = "anstyle-parse" -version = "0.2.2" +version = "0.2.5" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "317b9a89c1868f5ea6ff1d9539a69f45dffc21ce321ac1fd1160dfa48c8e2140" +checksum = "eb47de1e80c2b463c735db5b217a0ddc39d612e7ac9e2e96a5aed1f57616c1cb" dependencies = [ "utf8parse", ] [[package]] name = "anstyle-query" -version = "1.0.0" +version = "1.1.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5ca11d4be1bab0c8bc8734a9aa7bf4ee8316d462a08c6ac5052f888fef5b494b" +checksum = "6d36fc52c7f6c869915e99412912f22093507da8d9e942ceaf66fe4b7c14422a" dependencies = [ - "windows-sys 0.48.0", + "windows-sys 0.52.0", ] [[package]] name = "anstyle-wincon" -version = "3.0.1" +version = "3.0.4" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f0699d10d2f4d628a98ee7b57b289abbc98ff3bad977cb3152709d4bf2330628" +checksum = "5bf74e1b6e971609db8ca7a9ce79fd5768ab6ae46441c572e46cf596f59e57f8" dependencies = [ "anstyle", - "windows-sys 0.48.0", + "windows-sys 0.52.0", ] [[package]] name = "argminmax" -version = "0.6.1" +version = "0.6.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "202108b46429b765ef483f8a24d5c46f48c14acfdacc086dd4ab6dddf6bcdbd2" +checksum = "52424b59d69d69d5056d508b260553afd91c57e21849579cd1f50ee8b8b88eaa" dependencies = [ "num-traits", ] @@ -176,18 +177,18 @@ checksum = "16e62a023e7c117e27523144c5d2459f4397fcc3cab0085af8e2224f643a0193" dependencies = [ "proc-macro2", "quote", - "syn 2.0.39", + "syn 2.0.77", ] [[package]] name = "async-trait" -version = "0.1.74" +version = "0.1.82" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a66537f1bb974b254c98ed142ff995236e81b9d0fe4db0575f46612cb15eb0f9" +checksum = "a27b8a3a6e1a44fa4c8baf1f653e4172e81486d4941f2237e20dc2d0cf4ddff1" dependencies = [ "proc-macro2", "quote", - "syn 2.0.39", + "syn 2.0.77", ] [[package]] @@ -201,36 +202,42 @@ dependencies = [ [[package]] name = "atoi_simd" -version = "0.15.5" +version = "0.15.6" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ccfc14f5c3e34de57539a7ba9c18ecde3d9bbde48d232ea1da3e468adb307fd0" +checksum = "9ae037714f313c1353189ead58ef9eec30a8e8dc101b2622d461418fd59e28a9" [[package]] name = "autocfg" -version = "1.1.0" +version = "1.3.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d468802bab17cbc0cc575e9b053f41e72aa36bfa6b7f55e3529ffa43161b97fa" +checksum = "0c4b4d0bd25bd0b74681c0ad21497610ce1b7c91b1022cd21c80c6fbdd9476b0" [[package]] name = "backtrace" -version = "0.3.69" +version = "0.3.74" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "2089b7e3f35b9dd2d0ed921ead4f6d318c27680d4a5bd167b3ee120edb105837" +checksum = "8d82cb332cdfaed17ae235a638438ac4d4839913cc2af585c3c6746e8f8bee1a" dependencies = [ "addr2line", - "cc", "cfg-if", "libc", "miniz_oxide", "object", "rustc-demangle", + "windows-targets 0.52.6", ] [[package]] name = "base64" -version = "0.21.5" +version = "0.21.7" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "35636a1494ede3b646cc98f74f8e62c773a38a659ebc777a2cf26b9b74171df9" +checksum = "9d297deb1925b89f2ccc13d7635fa0714f12c87adce1c75356b39ca9b7178567" + +[[package]] +name = "base64" +version = "0.22.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "72b3254f16251a8381aa12e40e3c4d2f0199f8c6508fbecb9d91f575e0fbb8c6" [[package]] name = "bat" @@ -286,15 +293,15 @@ checksum = "bef38d45163c2f1dde094a7dfd33ccf595c92905c8f8f4fdc18d06fb1037718a" [[package]] name = "bitflags" -version = "2.4.1" +version = "2.6.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "327762f6e5a765692301e5bb513e0d9fef63be86bbc14528052b1cd3e6f03e07" +checksum = "b048fb63fd8b5923fc5aa7b340d8e156aec7ec02f0c78fa8a6ddc2613f6f71de" [[package]] name = "brotli" -version = "3.4.0" +version = "3.5.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "516074a47ef4bce09577a3b379392300159ce5b1ba2e501ff1c819950066100f" +checksum = "d640d25bc63c50fb1f0b545ffd80207d2e10a4c965530809b40ba3386825c391" dependencies = [ "alloc-no-stdlib", "alloc-stdlib", @@ -313,9 +320,9 @@ dependencies = [ [[package]] name = "bstr" -version = "1.9.0" +version = "1.10.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c48f0051a4b4c5e0b6d365cd04af53aeaa209e3cc15ec2cdb69e73cc87fbd0dc" +checksum = "40723b8fb387abc38f4f4a37c09073622e41dd12327033091ef8950659e6dc0c" dependencies = [ "memchr", "regex-automata", @@ -335,35 +342,41 @@ dependencies = [ [[package]] name = "bumpalo" -version = "3.14.0" +version = "3.16.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7f30e7476521f6f8af1a1c4c0b8cc94f0bee37d91763d0ca2665f299b6cd8aec" +checksum = "79296716171880943b8470b5f8d03aa55eb2e645a4874bdbb28adb49162e012c" [[package]] name = "bytemuck" -version = "1.14.0" +version = "1.18.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "374d28ec25809ee0e23827c2ab573d729e293f281dfe393500e7ad618baa61c6" +checksum = "94bbb0ad554ad961ddc5da507a12a29b14e4ae5bda06b19f575a3e6079d2e2ae" dependencies = [ "bytemuck_derive", ] [[package]] name = "bytemuck_derive" -version = "1.5.0" +version = "1.7.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "965ab7eb5f8f97d2a083c799f3a1b994fc397b2fe2da5d1da1626ce15a39f2b1" +checksum = "0cc8b54b395f2fcfbb3d90c47b01c7f444d94d05bdeb775811dec868ac3bbc26" dependencies = [ "proc-macro2", "quote", - "syn 2.0.39", + "syn 2.0.77", ] [[package]] -name = "bytes" +name = "byteorder" version = "1.5.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a2bd12c1caf447e69cd4528f47f94d203fd2582878ecb9e9465484c4148a8223" +checksum = "1fd0f2584146f6f2ef48085050886acf353beff7305ebd1ae69500e27c67f64b" + +[[package]] +name = "bytes" +version = "1.7.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8318a53db07bb3f8dca91a600466bdb3f2eaadeedfdbcf02e1accbad9271ba50" [[package]] name = "bytesize" @@ -373,12 +386,13 @@ checksum = "a3e368af43e418a04d52505cf3dbc23dda4e3407ae2fa99fd0e4f308ce546acc" [[package]] name = "cc" -version = "1.0.83" +version = "1.1.18" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f1174fb0b6ec23863f8b971027804a42614e347eafb0a95bf0b12cdae21fc4d0" +checksum = "b62ac837cdb5cb22e10a256099b4fc502b1dfe560cb282963a974d7abd80e476" dependencies = [ "jobserver", "libc", + "shlex", ] [[package]] @@ -389,23 +403,23 @@ checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd" [[package]] name = "chrono" -version = "0.4.31" +version = "0.4.38" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7f2c685bad3eb3d45a01354cedb7d5faa66194d1d58ba6e267a8de788f79db38" +checksum = "a21f936df1771bf62b77f047b726c4625ff2e8aa607c01ec06e5a05bd8463401" dependencies = [ "android-tzdata", "iana-time-zone", "js-sys", "num-traits", "wasm-bindgen", - "windows-targets 0.48.5", + "windows-targets 0.52.6", ] [[package]] name = "clap" -version = "4.4.8" +version = "4.5.17" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "2275f18819641850fa26c89acc84d465c1bf91ce57bc2748b28c420473352f64" +checksum = "3e5a21b8495e732f1b3c364c9949b201ca7bae518c502c80256c96ad79eaf6ac" dependencies = [ "clap_builder", "clap_derive", @@ -413,9 +427,9 @@ dependencies = [ [[package]] name = "clap_builder" -version = "4.4.8" +version = "4.5.17" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "07cdf1b148b25c1e1f7a42225e30a0d99a615cd4637eae7365548dd4529b95bc" +checksum = "8cf2dd12af7a047ad9d6da2b6b249759a22a7abc0f474c1dae1777afa4b21a73" dependencies = [ "anstream", "anstyle", @@ -426,21 +440,21 @@ dependencies = [ [[package]] name = "clap_derive" -version = "4.4.7" +version = "4.5.13" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "cf9804afaaf59a91e75b022a30fb7229a7901f60c755489cc61c9b423b836442" +checksum = "501d359d5f3dcaf6ecdeee48833ae73ec6e42723a1e52419c79abf9507eec0a0" dependencies = [ - "heck", + "heck 0.5.0", "proc-macro2", "quote", - "syn 2.0.39", + "syn 2.0.77", ] [[package]] name = "clap_lex" -version = "0.6.0" +version = "0.7.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "702fc72eb24e5a1e48ce58027a675bc24edd52096d5397d4aea7c6dd9eca0bd1" +checksum = "1462739cb27611015575c0c11df5df7601141071f07518d56fcc1be504cbec97" [[package]] name = "clircle" @@ -456,15 +470,15 @@ dependencies = [ [[package]] name = "colorchoice" -version = "1.0.0" +version = "1.0.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "acbf1af155f9b9ef647e42cdc158db4b64a1b61f743629225fde6f3e0be2a7c7" +checksum = "d3fd119d74b830634cea2a0f58bbd0d54540518a14397557951e79340abc28c0" [[package]] name = "colored_json" -version = "4.1.0" +version = "5.0.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "79cff32df5cfea75e6484eeff0b4e48ad3977fb6582676a7862b3590dddc7a87" +checksum = "e35980a1b846f8e3e359fd18099172a0857140ba9230affc4f71348081e039b6" dependencies = [ "serde", "serde_json", @@ -473,27 +487,27 @@ dependencies = [ [[package]] name = "comfy-table" -version = "7.1.0" +version = "7.1.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7c64043d6c7b7a4c58e39e7efccfdea7b93d885a795d0c054a69dbbf4dd52686" +checksum = "b34115915337defe99b2aff5c2ce6771e5fbc4079f4b506301f5cf394c8452f7" dependencies = [ "crossterm 0.27.0", "strum", - "strum_macros", + "strum_macros 0.26.4", "unicode-width", ] [[package]] name = "console" -version = "0.15.7" +version = "0.15.8" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c926e00cc70edefdc64d3a5ff31cc65bb97a3460097762bd23afb4d8145fccf8" +checksum = "0e1f83fc076bd6dd27517eacdf25fef6c4dfe5f1d7448bafaaf3a26f13b5e4eb" dependencies = [ "encode_unicode", "lazy_static", "libc", "unicode-width", - "windows-sys 0.45.0", + "windows-sys 0.52.0", ] [[package]] @@ -517,71 +531,61 @@ dependencies = [ [[package]] name = "core-foundation-sys" -version = "0.8.6" +version = "0.8.7" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "06ea2b9bc92be3c2baa9334a323ebca2d6f074ff852cd1d7b11064035cd3868f" +checksum = "773648b94d0e5d620f64f280777445740e61fe701025087ec8b57f45c791888b" [[package]] name = "crc32fast" -version = "1.3.2" +version = "1.4.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b540bd8bc810d3885c6ea91e2018302f68baba2129ab3e88f32389ee9370880d" +checksum = "a97769d94ddab943e4510d138150169a2758b5ef3eb191a9ee688de3e23ef7b3" dependencies = [ "cfg-if", ] [[package]] name = "crossbeam-channel" -version = "0.5.8" +version = "0.5.13" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a33c2bf77f2df06183c3aa30d1e96c0695a313d4f9c453cc3762a6db39f99200" +checksum = "33480d6946193aa8033910124896ca395333cae7e2d1113d1fef6c3272217df2" dependencies = [ - "cfg-if", "crossbeam-utils", ] [[package]] name = "crossbeam-deque" -version = "0.8.3" +version = "0.8.5" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ce6fd6f855243022dcecf8702fef0c297d4338e226845fe067f6341ad9fa0cef" +checksum = "613f8cc01fe9cf1a3eb3d7f488fd2fa8388403e97039e2f73692932e291a770d" dependencies = [ - "cfg-if", "crossbeam-epoch", "crossbeam-utils", ] [[package]] name = "crossbeam-epoch" -version = "0.9.15" +version = "0.9.18" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ae211234986c545741a7dc064309f67ee1e5ad243d0e48335adc0484d960bcc7" +checksum = "5b82ac4a3c2ca9c3460964f020e1402edd5753411d7737aa39c3714ad1b5420e" dependencies = [ - "autocfg", - "cfg-if", "crossbeam-utils", - "memoffset", - "scopeguard", ] [[package]] name = "crossbeam-queue" -version = "0.3.8" +version = "0.3.11" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d1cfb3ea8a53f37c40dea2c7bedcbd88bdfae54f5e2175d6ecaff1c988353add" +checksum = "df0346b5d5e76ac2fe4e327c5fd1118d6be7c51dfb18f9b7922923f287471e35" dependencies = [ - "cfg-if", "crossbeam-utils", ] [[package]] name = "crossbeam-utils" -version = "0.8.16" +version = "0.8.20" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5a22b2d63d4d1dc0b7f1b6b2747dd0088008a9be28b6ddf0b1e7d335e3037294" -dependencies = [ - "cfg-if", -] +checksum = "22ec99545bb0ed0ea7bb9b8e1e9122ea386ff8a48c0922e43f36d45ab09e0e80" [[package]] name = "crossterm" @@ -592,7 +596,7 @@ dependencies = [ "bitflags 1.3.2", "crossterm_winapi", "libc", - "mio", + "mio 0.8.11", "parking_lot", "signal-hook", "signal-hook-mio", @@ -605,7 +609,7 @@ version = "0.27.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "f476fe445d41c9e991fd07515a6f463074b782242ccf4a5b7b1d1012e70824df" dependencies = [ - "bitflags 2.4.1", + "bitflags 2.6.0", "crossterm_winapi", "libc", "parking_lot", @@ -632,15 +636,15 @@ dependencies = [ [[package]] name = "dyn-clone" -version = "1.0.16" +version = "1.0.17" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "545b22097d44f8a9581187cdf93de7a71e4722bf51200cfaba810865b49a495d" +checksum = "0d6ef0072f8a535281e4876be788938b528e9a1d43900b82c2569af7da799125" [[package]] name = "edit" -version = "0.1.4" +version = "0.1.5" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c562aa71f7bc691fde4c6bf5f93ae5a5298b617c2eb44c76c87832299a17fbb4" +checksum = "f364860e764787163c8c8f58231003839be31276e821e2ad2092ddf496b1aa09" dependencies = [ "tempfile", "which", @@ -648,9 +652,9 @@ dependencies = [ [[package]] name = "either" -version = "1.9.0" +version = "1.13.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a26ae43d7bcc3b814de94796a5e736d4029efb0ee900c12e2d54c993ad1a1e07" +checksum = "60b1af1c220855b6ceac025d3f6ecdd2b7c4894bfe9cd9bda4fbb4bc7c0d4cf0" [[package]] name = "encode_unicode" @@ -660,23 +664,23 @@ checksum = "a357d28ed41a50f9c765dbfe56cbc04a64e53e5fc58ba79fbc34c10ef3df831f" [[package]] name = "encoding_rs" -version = "0.8.33" +version = "0.8.34" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7268b386296a025e474d5140678f75d6de9493ae55a5d709eeb9dd08149945e1" +checksum = "b45de904aa0b010bce2ab45264d0631681847fa7b6f2eaa7dab7619943bc4f59" dependencies = [ "cfg-if", ] [[package]] name = "enum_dispatch" -version = "0.3.12" +version = "0.3.13" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8f33313078bb8d4d05a2733a94ac4c2d8a0df9a2b84424ebf4f33bfc224a890e" +checksum = "aa18ce2bc66555b3218614519ac839ddb759a7d6720732f979ef8d13be147ecd" dependencies = [ "once_cell", "proc-macro2", "quote", - "syn 2.0.39", + "syn 2.0.77", ] [[package]] @@ -687,9 +691,9 @@ checksum = "5443807d6dff69373d433ab9ef5378ad8df50ca6298caf15de6e52e24aaf54d5" [[package]] name = "errno" -version = "0.3.8" +version = "0.3.9" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a258e46cdc063eb8519c00b9fc845fc47bcfca4130e2f08e88665ceda8474245" +checksum = "534c5cf6194dfab3db3242765c03bbe257cf92f22b38f6bc0c58d59108a820ba" dependencies = [ "libc", "windows-sys 0.52.0", @@ -726,15 +730,15 @@ checksum = "95765f67b4b18863968b4a1bd5bb576f732b29a4a28c7cd84c09fa3e2875f33c" [[package]] name = "fastrand" -version = "2.0.1" +version = "2.1.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "25cbce373ec4653f1a01a31e8a5e5ec0c622dc27ff9c4e6606eefef5cbbed4a5" +checksum = "e8c02a5121d4ea3eb16a80748c74f5549a5665e4c21333c6098f283870fbdea6" [[package]] name = "flate2" -version = "1.0.28" +version = "1.0.33" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "46303f565772937ffe1d394a4fac6f411c6013172fadde9dcdb1e147a086940e" +checksum = "324a1be68054ef05ad64b861cc9eaf1d623d2d8cb25b4bf2cb9cdd902b4bf253" dependencies = [ "crc32fast", "miniz_oxide", @@ -787,9 +791,9 @@ dependencies = [ [[package]] name = "futures" -version = "0.3.29" +version = "0.3.30" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "da0290714b38af9b4a7b094b8a37086d1b4e61f2df9122c3cad2577669145335" +checksum = "645c6916888f6cb6350d2550b80fb63e734897a8498abe35cfb732b6487804b0" dependencies = [ "futures-channel", "futures-core", @@ -802,9 +806,9 @@ dependencies = [ [[package]] name = "futures-channel" -version = "0.3.29" +version = "0.3.30" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ff4dd66668b557604244583e3e1e1eada8c5c2e96a6d0d6653ede395b78bbacb" +checksum = "eac8f7d7865dcb88bd4373ab671c8cf4508703796caa2b1985a9ca867b3fcb78" dependencies = [ "futures-core", "futures-sink", @@ -812,15 +816,15 @@ dependencies = [ [[package]] name = "futures-core" -version = "0.3.29" +version = "0.3.30" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "eb1d22c66e66d9d72e1758f0bd7d4fd0bee04cad842ee34587d68c07e45d088c" +checksum = "dfc6580bb841c5a68e9ef15c77ccc837b40a7504914d52e47b8b0e9bbda25a1d" [[package]] name = "futures-executor" -version = "0.3.29" +version = "0.3.30" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0f4fb8693db0cf099eadcca0efe2a5a22e4550f98ed16aba6c48700da29597bc" +checksum = "a576fc72ae164fca6b9db127eaa9a9dda0d61316034f33a0a0d4eda41f02b01d" dependencies = [ "futures-core", "futures-task", @@ -829,38 +833,38 @@ dependencies = [ [[package]] name = "futures-io" -version = "0.3.29" +version = "0.3.30" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8bf34a163b5c4c52d0478a4d757da8fb65cabef42ba90515efee0f6f9fa45aaa" +checksum = "a44623e20b9681a318efdd71c299b6b222ed6f231972bfe2f224ebad6311f0c1" [[package]] name = "futures-macro" -version = "0.3.29" +version = "0.3.30" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "53b153fd91e4b0147f4aced87be237c98248656bb01050b96bf3ee89220a8ddb" +checksum = "87750cf4b7a4c0625b1529e4c543c2182106e4dedc60a2a6455e00d212c489ac" dependencies = [ "proc-macro2", "quote", - "syn 2.0.39", + "syn 2.0.77", ] [[package]] name = "futures-sink" -version = "0.3.29" +version = "0.3.30" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e36d3378ee38c2a36ad710c5d30c2911d752cb941c00c72dbabfb786a7970817" +checksum = "9fb8e00e87438d937621c1c6269e53f536c14d3fbd6a042bb24879e57d474fb5" [[package]] name = "futures-task" -version = "0.3.29" +version = "0.3.30" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "efd193069b0ddadc69c46389b740bbccdd97203899b48d09c5f7969591d6bae2" +checksum = "38d84fa142264698cdce1a9f9172cf383a0c82de1bddcf3092901442c4097004" [[package]] name = "futures-util" -version = "0.3.29" +version = "0.3.30" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a19526d624e703a3179b3d322efec918b6246ea0fa51d41124525f00f1cc8104" +checksum = "3d6401deb83407ab3da39eba7e33987a73c3df0c82b4bb5813ee871c19c41d48" dependencies = [ "futures-channel", "futures-core", @@ -875,10 +879,28 @@ dependencies = [ ] [[package]] -name = "getrandom" -version = "0.2.11" +name = "fuzzy-matcher" +version = "0.3.7" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "fe9006bed769170c11f845cf00c7c1e9092aeb3f268e007c3e760ac68008070f" +checksum = "54614a3312934d066701a80f20f15fa3b56d67ac7722b39eea5b4c9dd1d66c94" +dependencies = [ + "thread_local", +] + +[[package]] +name = "fxhash" +version = "0.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c31b6d751ae2c7f11320402d34e41349dd1016f8d5d45e48c4312bc8625af50c" +dependencies = [ + "byteorder", +] + +[[package]] +name = "getrandom" +version = "0.2.15" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c4567c8db10ae91089c99af84c68c38da3ec2f087c3f82960bcdbf3656b6f4d7" dependencies = [ "cfg-if", "js-sys", @@ -889,9 +911,9 @@ dependencies = [ [[package]] name = "gimli" -version = "0.28.1" +version = "0.31.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "4271d37baee1b8c7e4b708028c57d816cf9d2434acb33a549475f78c181f6253" +checksum = "32085ea23f3234fc7846555e85283ba4de91e21016dc0455a16286d87a292d64" [[package]] name = "git-version" @@ -910,16 +932,16 @@ checksum = "53010ccb100b96a67bc32c0175f0ed1426b31b655d562898e57325f81c023ac0" dependencies = [ "proc-macro2", "quote", - "syn 2.0.39", + "syn 2.0.77", ] [[package]] name = "git2" -version = "0.18.1" +version = "0.18.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "fbf97ba92db08df386e10c8ede66a2a0369bd277090afd8710e19e38de9ec0cd" +checksum = "232e6a7bfe35766bf715e55a88b39a700596c0ccfd88cd3680b4cdb40d66ef70" dependencies = [ - "bitflags 2.4.1", + "bitflags 2.6.0", "libc", "libgit2-sys", "log", @@ -934,22 +956,22 @@ checksum = "d2fabcfbdc87f4758337ca535fb41a6d701b65693ce38287d856d1674551ec9b" [[package]] name = "globset" -version = "0.4.14" +version = "0.4.15" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "57da3b9b5b85bd66f31093f8c408b90a74431672542466497dcbdfdc02034be1" +checksum = "15f1ce686646e7f1e19bf7d5533fe443a45dbfb990e00629110797578b42fb19" dependencies = [ "aho-corasick", "bstr", "log", "regex-automata", - "regex-syntax 0.8.2", + "regex-syntax", ] [[package]] name = "grep-cli" -version = "0.1.10" +version = "0.1.11" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ea40788c059ab8b622c4d074732750bfb3bd2912e2dd58eabc11798a4d5ad725" +checksum = "47f1288f0e06f279f84926fa4c17e3fcd2a22b357927a82f2777f7be26e4cec0" dependencies = [ "bstr", "globset", @@ -961,9 +983,9 @@ dependencies = [ [[package]] name = "h2" -version = "0.3.22" +version = "0.3.26" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "4d6250322ef6e60f93f9a2162799302cd6f68f79f6e5d85c8c16f14d1d958178" +checksum = "81fe527a889e1532da5c525686d96d4c2e74cdd345badf8dfef9f6b39dd5f5e8" dependencies = [ "bytes", "fnv", @@ -980,28 +1002,19 @@ dependencies = [ [[package]] name = "halfbrown" -version = "0.2.4" +version = "0.2.5" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5681137554ddff44396e5f149892c769d45301dd9aa19c51602a89ee214cb0ec" +checksum = "8588661a8607108a5ca69cab034063441a0413a0b041c13618a7dd348021ef6f" dependencies = [ - "hashbrown 0.13.2", + "hashbrown", "serde", ] [[package]] name = "hashbrown" -version = "0.13.2" +version = "0.14.5" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "43a3c133739dddd0d2990f9a4bdf8eb4b21ef50e4851ca85ab661199821d510e" -dependencies = [ - "ahash", -] - -[[package]] -name = "hashbrown" -version = "0.14.3" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "290f1a1d9242c78d09ce40a5e87e7554ee637af1351968159f4952f028f75604" +checksum = "e5274423e17b7c9fc20b6e7e208532f9b19825d82dfd615708b70edd83df41f1" dependencies = [ "ahash", "allocator-api2", @@ -1015,10 +1028,16 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "95505c38b4572b2d910cecb0281560f54b440a19336cbbcb27bf6ce6adc6f5a8" [[package]] -name = "hermit-abi" -version = "0.3.3" +name = "heck" +version = "0.5.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d77f7ec81a6d05a3abb01ab6eb7590f6083d08449fe5a1c8b1e620283546ccb7" +checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea" + +[[package]] +name = "hermit-abi" +version = "0.3.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d231dfb89cfffdbc30e7fc41579ed6066ad03abda9e567ccafae602b97ec5024" [[package]] name = "hex" @@ -1028,18 +1047,18 @@ checksum = "7f24254aa9a54b5c858eaee2f5bccdb46aaf0e486a595ed5fd8f86ba55232a70" [[package]] name = "home" -version = "0.5.5" +version = "0.5.9" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5444c27eef6923071f7ebcc33e3444508466a76f7a2b93da00ed6e19f30c1ddb" +checksum = "e3d1354bf6b7235cb4a0576c2619fd4ed18183f689b12b006a0ee7329eeff9a5" dependencies = [ - "windows-sys 0.48.0", + "windows-sys 0.52.0", ] [[package]] name = "http" -version = "0.2.11" +version = "0.2.12" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8947b1a6fad4393052c7ba1f4cd97bed3e953a95c79c92ad9b051a04611d9fbb" +checksum = "601cbb57e577e2f5ef5be8e7b83f0f63994f25aa94d673e54a92d5c516d101f1" dependencies = [ "bytes", "fnv", @@ -1048,9 +1067,9 @@ dependencies = [ [[package]] name = "http-body" -version = "0.4.5" +version = "0.4.6" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d5f38f16d184e36f2408a55281cd658ecbd3ca05cce6d6510a176eca393e26d1" +checksum = "7ceab25649e9960c0311ea418d17bee82c0dcec1bd053b5f9a66e265a693bed2" dependencies = [ "bytes", "http", @@ -1059,9 +1078,9 @@ dependencies = [ [[package]] name = "httparse" -version = "1.8.0" +version = "1.9.4" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d897f394bad6a705d5f4104762e116a75639e470d80901eed05a860a95cb1904" +checksum = "0fcc0b4a115bf80b728eb8ea024ad5bd707b615bfed49e0665b6e0f86fd082d9" [[package]] name = "httpdate" @@ -1071,9 +1090,9 @@ checksum = "df3b46402a9d5adb4c86a0cf463f42e19994e3ee891101b1841f30a545cb49a9" [[package]] name = "hyper" -version = "0.14.27" +version = "0.14.30" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ffb1cfd654a8219eaef89881fdb3bb3b1cdc5fa75ded05d6933b2b382e395468" +checksum = "a152ddd61dfaec7273fe8419ab357f33aee0d914c5f4efbf0d96fa749eea5ec9" dependencies = [ "bytes", "futures-channel", @@ -1086,7 +1105,7 @@ dependencies = [ "httpdate", "itoa", "pin-project-lite", - "socket2 0.4.10", + "socket2", "tokio", "tower-service", "tracing", @@ -1108,9 +1127,9 @@ dependencies = [ [[package]] name = "iana-time-zone" -version = "0.1.58" +version = "0.1.60" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8326b86b6cff230b97d0d312a6c40a60726df3332e721f72a1b035f451663b20" +checksum = "e7ffbb5a1b541ea2561f8c41c087286cc091e21e556a4f09a8f6cbf17b69b141" dependencies = [ "android_system_properties", "core-foundation-sys", @@ -1141,26 +1160,27 @@ dependencies = [ [[package]] name = "indexmap" -version = "2.1.0" +version = "2.5.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d530e1a18b1cb4c484e6e34556a0d948706958449fca0cab753d649f2bce3d1f" +checksum = "68b900aa2f7301e21c36462b170ee99994de34dff39a4a6a528e80e7376d07e5" dependencies = [ "equivalent", - "hashbrown 0.14.3", + "hashbrown", ] [[package]] name = "inquire" -version = "0.6.2" +version = "0.7.5" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c33e7c1ddeb15c9abcbfef6029d8e29f69b52b6d6c891031b88ed91b5065803b" +checksum = "0fddf93031af70e75410a2511ec04d49e758ed2f26dad3404a934e0fb45cc12a" dependencies = [ - "bitflags 1.3.2", + "bitflags 2.6.0", "crossterm 0.25.0", "dyn-clone", - "lazy_static", + "fuzzy-matcher", + "fxhash", "newline-converter", - "thiserror", + "once_cell", "unicode-segmentation", "unicode-width", ] @@ -1180,39 +1200,45 @@ dependencies = [ [[package]] name = "ipnet" -version = "2.9.0" +version = "2.10.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8f518f335dce6725a761382244631d86cf0ccb2863413590b31338feb467f9c3" +checksum = "187674a687eed5fe42285b40c6291f9a01517d415fad1c3cbc6a9f778af7fcd4" + +[[package]] +name = "is_terminal_polyfill" +version = "1.70.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7943c866cc5cd64cbc25b2e01621d07fa8eb2a1a23160ee81ce38704e97b8ecf" [[package]] name = "itoa" -version = "1.0.9" +version = "1.0.11" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "af150ab688ff2122fcef229be89cb50dd66af9e01a4ff320cc137eecc9bacc38" +checksum = "49f1f14873335454500d59611f1cf4a4b0f786f9ac11f4312a78e4cf2566695b" [[package]] name = "jobserver" -version = "0.1.27" +version = "0.1.32" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8c37f63953c4c63420ed5fd3d6d398c719489b9f872b9fa683262f8edd363c7d" +checksum = "48d1dbcbbeb6a7fec7e059840aa538bd62aaccf972c7346c4d9d2059312853d0" dependencies = [ "libc", ] [[package]] name = "js-sys" -version = "0.3.66" +version = "0.3.70" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "cee9c64da59eae3b50095c18d3e74f8b73c0b86d2792824ff01bbce68ba229ca" +checksum = "1868808506b929d7b0cfa8f75951347aa71bb21144b7791bae35d9bccfcfe37a" dependencies = [ "wasm-bindgen", ] [[package]] name = "lazy_static" -version = "1.4.0" +version = "1.5.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e2abad23fbc42b3700f2f279844dc832adb2b2eb069b2df918f455c4e18cc646" +checksum = "bbd2bcb4c963f2ddae06a2efc7e9f3591312473c50c6685e1f298068316e66fe" [[package]] name = "lexical-core" @@ -1280,15 +1306,15 @@ dependencies = [ [[package]] name = "libc" -version = "0.2.150" +version = "0.2.158" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "89d92a4743f9a61002fae18374ed11e7973f530cb3a3255fb354818118b2203c" +checksum = "d8adc4bb1803a324070e64a98ae98f38934d91957a99cfb3a43dcbc01bc56439" [[package]] name = "libgit2-sys" -version = "0.16.1+1.7.1" +version = "0.16.2+1.7.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f2a2bb3680b094add03bb3732ec520ece34da31a8cd2d633d1389d0f0fb60d0c" +checksum = "ee4126d8b4ee5c9d9ea891dd875cfdc1e9d0950437179104b183d7d8a74d24e8" dependencies = [ "cc", "libc", @@ -1304,9 +1330,9 @@ checksum = "4ec2a862134d2a7d32d7983ddcdd1c4923530833c9f2ea1a44fc5fa473989058" [[package]] name = "libz-sys" -version = "1.1.12" +version = "1.1.20" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d97137b25e321a73eef1418d1d5d2eda4d77e12813f8e6dead84bc52c5870a7b" +checksum = "d2d16453e800a8cf6dd2fc3eb4bc99b786a9b90c663b8559a5b1a041bf89e472" dependencies = [ "cc", "libc", @@ -1314,15 +1340,6 @@ dependencies = [ "vcpkg", ] -[[package]] -name = "line-wrap" -version = "0.1.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f30344350a2a51da54c1d53be93fade8a237e545dbcc4bdbe635413f2117cab9" -dependencies = [ - "safemem", -] - [[package]] name = "linked-hash-map" version = "0.5.6" @@ -1331,15 +1348,15 @@ checksum = "0717cef1bc8b636c6e1c1bbdefc09e6322da8a9321966e8928ef80d20f7f770f" [[package]] name = "linux-raw-sys" -version = "0.4.12" +version = "0.4.14" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c4cd1a83af159aa67994778be9070f0ae1bd732942279cabb14f86f986a21456" +checksum = "78b3ae25bc7c8c38cec158d1f2757ee79e9b3740fbc7ccf0e59e4b08d793fa89" [[package]] name = "lock_api" -version = "0.4.11" +version = "0.4.12" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "3c168f8615b12bc01f9c17e2eb0cc07dcae1940121185446edc3744920e8ef45" +checksum = "07af8b9cdd281b7915f413fa73f29ebd5d55d0d3f0155584dade1ff18cea1b17" dependencies = [ "autocfg", "scopeguard", @@ -1347,15 +1364,15 @@ dependencies = [ [[package]] name = "log" -version = "0.4.20" +version = "0.4.22" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b5e6163cb8c49088c2c36f57875e58ccd8c87c7427f7fbd50ea6710b2f3f2e8f" +checksum = "a7a70ba024b9dc04c27ea2f0c0548feb474ec5c54bba33a7f72f873a39d07b24" [[package]] name = "lz4" -version = "1.24.0" +version = "1.26.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7e9e2dd86df36ce760a60f6ff6ad526f7ba1f14ba0356f8254fb6905e6494df1" +checksum = "958b4caa893816eea05507c20cfe47574a43d9a697138a7872990bba8a0ece68" dependencies = [ "libc", "lz4-sys", @@ -1363,9 +1380,9 @@ dependencies = [ [[package]] name = "lz4-sys" -version = "1.9.4" +version = "1.10.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "57d27b317e207b10f69f5e75494119e391a96f48861ae870d1da6edac98ca900" +checksum = "109de74d5d2353660401699a4174a4ff23fcc649caf553df71933c7fb45ad868" dependencies = [ "cc", "libc", @@ -1373,9 +1390,9 @@ dependencies = [ [[package]] name = "memchr" -version = "2.7.1" +version = "2.7.4" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "523dc4f511e55ab87b694dc30d0f820d60906ef06413f93d4d7a1385599cc149" +checksum = "78ca9ab1a0babb1e7d5695e3530886289c18cf2f87ec19a575a0abdce112e3a3" [[package]] name = "memmap2" @@ -1386,18 +1403,9 @@ dependencies = [ "libc", ] -[[package]] -name = "memoffset" -version = "0.9.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5a634b1c61a95585bd15607c6ab0c4e5b226e695ff2800ba0cdccddf208c406c" -dependencies = [ - "autocfg", -] - [[package]] name = "mesc" -version = "0.1.4" +version = "0.3.0" dependencies = [ "serde", "serde_json", @@ -1406,7 +1414,7 @@ dependencies = [ [[package]] name = "mesc_cli" -version = "0.1.4" +version = "0.3.0" dependencies = [ "bat", "clap", @@ -1433,18 +1441,18 @@ checksum = "6877bb514081ee2a7ff5ef9de3281f14a4dd4bceac4c09388074a6b5df8a139a" [[package]] name = "miniz_oxide" -version = "0.7.1" +version = "0.8.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e7810e0be55b428ada41041c41f32c9f1a42817901b4ccf45fa3d4b6561e74c7" +checksum = "e2d80299ef12ff69b16a84bb182e3b9df68b5a91574d3d4fa6e41b65deec4df1" dependencies = [ - "adler", + "adler2", ] [[package]] name = "mio" -version = "0.8.9" +version = "0.8.11" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "3dce281c5e46beae905d4de1870d8b1509a9142b62eedf18b443b011ca8343d0" +checksum = "a4a650543ca06a924e8b371db273b2756685faae30f8487da1b56505a8f78b0c" dependencies = [ "libc", "log", @@ -1453,10 +1461,22 @@ dependencies = [ ] [[package]] -name = "multiversion" -version = "0.7.3" +name = "mio" +version = "1.0.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b2c7b9d7fe61760ce5ea19532ead98541f6b4c495d87247aff9826445cf6872a" +checksum = "80e04d1dcff3aae0704555fe5fee3bcfaf3d1fdf8a7e521d5b9d2b42acb52cec" +dependencies = [ + "hermit-abi", + "libc", + "wasi", + "windows-sys 0.52.0", +] + +[[package]] +name = "multiversion" +version = "0.7.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c4851161a11d3ad0bf9402d90ffc3967bf231768bfd7aeb61755ad06dbf1a142" dependencies = [ "multiversion-macros", "target-features", @@ -1464,9 +1484,9 @@ dependencies = [ [[package]] name = "multiversion-macros" -version = "0.7.3" +version = "0.7.4" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "26a83d8500ed06d68877e9de1dde76c1dbb83885dcdbda4ef44ccbc3fbda2ac8" +checksum = "79a74ddee9e0c27d2578323c13905793e91622148f138ba29738f9dddb835e90" dependencies = [ "proc-macro2", "quote", @@ -1476,11 +1496,10 @@ dependencies = [ [[package]] name = "native-tls" -version = "0.2.11" +version = "0.2.12" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "07226173c32f2926027b63cce4bcd8076c3552846cbe7925f3aaffeac0a3b92e" +checksum = "a8614eb2c83d59d1c8cc974dd3f920198647674a0a035e1af1fa58707e317466" dependencies = [ - "lazy_static", "libc", "log", "openssl", @@ -1494,9 +1513,9 @@ dependencies = [ [[package]] name = "newline-converter" -version = "0.2.2" +version = "0.3.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "1f71d09d5c87634207f894c6b31b6a2b2c64ea3bdcf71bd5599fdbbe1600c00f" +checksum = "47b6b097ecb1cbfed438542d16e84fd7ad9b0c76c8a65b7f9039212a3d14dc7f" dependencies = [ "unicode-segmentation", ] @@ -1539,39 +1558,35 @@ dependencies = [ ] [[package]] -name = "num-traits" -version = "0.2.17" +name = "num-conv" +version = "0.1.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "39e3200413f237f41ab11ad6d161bc7239c84dcb631773ccd7de3dfe4b5c267c" +checksum = "51d515d32fb182ee37cda2ccdcb92950d6a3c2893aa280e540671c2cd0f3b1d9" + +[[package]] +name = "num-traits" +version = "0.2.19" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "071dfc062690e90b734c0b2273ce72ad0ffa95f0c74596bc250dcfd960262841" dependencies = [ "autocfg", "libm", ] -[[package]] -name = "num_cpus" -version = "1.16.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "4161fcb6d602d4d2081af7c3a45852d875a03dd337a6bfdd6e06407b61342a43" -dependencies = [ - "hermit-abi", - "libc", -] - [[package]] name = "object" -version = "0.32.1" +version = "0.36.4" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "9cf5f9dd3933bd50a9e1f149ec995f39ae2c496d31fd772c1fd45ebc27e902b0" +checksum = "084f1a5821ac4c651660a94a7153d27ac9d8a53736203f58b31945ded098070a" dependencies = [ "memchr", ] [[package]] name = "once_cell" -version = "1.18.0" +version = "1.19.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "dd8b5dd2ae5ed71462c540258bedcb51965123ad7e7ccf4b9a8cafaa4a63576d" +checksum = "3fdb12b2476b595f9358c5161aa467c2438859caa136dec86c26fdd2efe17b92" [[package]] name = "onig" @@ -1597,11 +1612,11 @@ dependencies = [ [[package]] name = "openssl" -version = "0.10.61" +version = "0.10.66" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "6b8419dc8cc6d866deb801274bba2e6f8f6108c1bb7fcc10ee5ab864931dbb45" +checksum = "9529f4786b70a3e8c61e11179af17ab6188ad8d0ded78c5529441ed39d4bd9c1" dependencies = [ - "bitflags 2.4.1", + "bitflags 2.6.0", "cfg-if", "foreign-types", "libc", @@ -1618,7 +1633,7 @@ checksum = "a948666b637a0f465e8564c73e89d4dde00d72d4d473cc972f390fc3dcee7d9c" dependencies = [ "proc-macro2", "quote", - "syn 2.0.39", + "syn 2.0.77", ] [[package]] @@ -1629,9 +1644,9 @@ checksum = "ff011a302c396a5197692431fc1948019154afc178baf7d8e37367442a4601cf" [[package]] name = "openssl-sys" -version = "0.9.97" +version = "0.9.103" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c3eaad34cdd97d81de97964fc7f29e2d104f483840d906ef56daa1912338460b" +checksum = "7f9e8deee91df40a943c71b917e5874b951d32a802526c85721ce3b776c929d6" dependencies = [ "cc", "libc", @@ -1647,9 +1662,9 @@ checksum = "b15813163c1d831bf4a13c3610c05c0d03b39feb07f7e09fa234dac9b15aaf39" [[package]] name = "parking_lot" -version = "0.12.1" +version = "0.12.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "3742b2c103b9f06bc9fff0a37ff4912935851bee6d36f3c02bcc755bcfec228f" +checksum = "f1bf18183cf54e8d6059647fc3063646a1801cf30896933ec2311622cc4b9a27" dependencies = [ "lock_api", "parking_lot_core", @@ -1657,15 +1672,15 @@ dependencies = [ [[package]] name = "parking_lot_core" -version = "0.9.9" +version = "0.9.10" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "4c42a9226546d68acdd9c0a280d17ce19bfe27a46bf68784e4066115788d008e" +checksum = "1e401f977ab385c9e4e3ab30627d6f26d00e2c73eef317493c4ec6d468726cf8" dependencies = [ "cfg-if", "libc", "redox_syscall", "smallvec", - "windows-targets 0.48.5", + "windows-targets 0.52.6", ] [[package]] @@ -1695,9 +1710,9 @@ checksum = "e3148f5046208a5d56bcfc03053e3ca6334e51da8dfb19b6cdc8b306fae3283e" [[package]] name = "pin-project-lite" -version = "0.2.13" +version = "0.2.14" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8afb450f006bf6385ca15ef45d71d2288452bc3683ce2e2cacc0d18e4be60b58" +checksum = "bda66fc9667c18cb2758a2ac84d1167245054bcf85d5d1aaa6923f45801bdd02" [[package]] name = "pin-utils" @@ -1707,9 +1722,9 @@ checksum = "8b870d8c151b6f2fb93e84a13146138f05d02ed11c7e7c54f8826aaaf7c9f184" [[package]] name = "pkg-config" -version = "0.3.27" +version = "0.3.30" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "26072860ba924cbfa98ea39c8c19b4dd6a4a25423dbdf219c1eca91aa0cf6964" +checksum = "d231b230927b5e4ad203db57bbcbee2802f6bce620b1e4a9024a07d94e2907ec" [[package]] name = "planus" @@ -1722,13 +1737,12 @@ dependencies = [ [[package]] name = "plist" -version = "1.6.0" +version = "1.7.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e5699cc8a63d1aa2b1ee8e12b9ad70ac790d65788cd36101fa37f87ea46c4cef" +checksum = "42cf17e9a1800f5f396bc67d193dc9411b59012a5876445ef450d449881e1016" dependencies = [ - "base64", + "base64 0.22.1", "indexmap", - "line-wrap", "quick-xml", "serde", "time", @@ -1768,7 +1782,7 @@ dependencies = [ "foreign_vec", "futures", "getrandom", - "hashbrown 0.14.3", + "hashbrown", "itoa", "lz4", "multiversion", @@ -1790,12 +1804,12 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "ae73d5b8e55decde670caba1cc82b61f14bfb9a72503198f0997d657a98dcfd6" dependencies = [ "ahash", - "bitflags 2.4.1", + "bitflags 2.6.0", "bytemuck", "chrono", "comfy-table", "either", - "hashbrown 0.14.3", + "hashbrown", "indexmap", "num-traits", "once_cell", @@ -1872,7 +1886,7 @@ dependencies = [ "ahash", "chrono", "fallible-streaming-iterator", - "hashbrown 0.14.3", + "hashbrown", "indexmap", "itoa", "num-traits", @@ -1891,7 +1905,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "3555f759705be6dd0d3762d16a0b8787b2dc4da73b57465f3b2bf1a070ba8f20" dependencies = [ "ahash", - "bitflags 2.4.1", + "bitflags 2.6.0", "glob", "once_cell", "polars-arrow", @@ -1916,10 +1930,10 @@ checksum = "1a7eb218296aaa7f79945f08288ca32ca3cf25fa505649eeee689ec21eebf636" dependencies = [ "ahash", "argminmax", - "base64", + "base64 0.21.7", "bytemuck", "either", - "hashbrown 0.14.3", + "hashbrown", "hex", "indexmap", "memchr", @@ -1942,7 +1956,7 @@ checksum = "146010e4b7dd4d2d0e58ddc762f6361f77d7a0385c54471199370c17164f67dd" dependencies = [ "ahash", "async-stream", - "base64", + "base64 0.21.7", "brotli", "ethnum", "flate2", @@ -1969,7 +1983,7 @@ dependencies = [ "crossbeam-channel", "crossbeam-queue", "enum_dispatch", - "hashbrown 0.14.3", + "hashbrown", "num-traits", "polars-arrow", "polars-core", @@ -2003,7 +2017,7 @@ dependencies = [ "rayon", "regex", "smartstring", - "strum_macros", + "strum_macros 0.25.3", "version_check", ] @@ -2062,7 +2076,7 @@ checksum = "da6ce68169fe61d46958c8eab7447360f30f2f23f6e24a0ce703a14b0a3cfbfc" dependencies = [ "ahash", "bytemuck", - "hashbrown 0.14.3", + "hashbrown", "indexmap", "num-traits", "once_cell", @@ -2081,33 +2095,36 @@ checksum = "439ee305def115ba05938db6eb1644ff94165c5ab5e9420d1c1bcedbba909391" [[package]] name = "ppv-lite86" -version = "0.2.17" +version = "0.2.20" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5b40af805b3121feab8a3c29f04d8ad262fa8e0561883e7653e024ae4479e6de" +checksum = "77957b295656769bb8ad2b6a6b09d897d94f05c41b069aede1fcdaa675eaea04" +dependencies = [ + "zerocopy", +] [[package]] name = "proc-macro2" -version = "1.0.69" +version = "1.0.86" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "134c189feb4956b20f6f547d2cf727d4c0fe06722b20a0eec87ed445a97f92da" +checksum = "5e719e8df665df0d1c8fbfd238015744736151d4445ec0836b8e628aae103b77" dependencies = [ "unicode-ident", ] [[package]] name = "quick-xml" -version = "0.31.0" +version = "0.32.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "1004a344b30a54e2ee58d66a71b32d2db2feb0a31f9a2d302bf0536f15de2a33" +checksum = "1d3a6e5838b60e0e8fa7a43f22ade549a37d61f8bdbe636d0d7816191de969c2" dependencies = [ "memchr", ] [[package]] name = "quote" -version = "1.0.33" +version = "1.0.37" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5267fca4496028628a95160fc423a33e8b2e6af8a5302579e322e4b520293cae" +checksum = "b5b9d34b8991d19d98081b46eacdd8eb58c6f2b201139f7c5f643cc155a633af" dependencies = [ "proc-macro2", ] @@ -2154,9 +2171,9 @@ dependencies = [ [[package]] name = "rayon" -version = "1.8.0" +version = "1.10.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "9c27db03db7734835b3f53954b534c91069375ce6ccaa2e065441e07d9b6cdb1" +checksum = "b418a60154510ca1a002a752ca9714984e21e4241e804d32555251faf8b78ffa" dependencies = [ "either", "rayon-core", @@ -2164,9 +2181,9 @@ dependencies = [ [[package]] name = "rayon-core" -version = "1.12.0" +version = "1.12.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5ce3fb6ad83f861aac485e76e1985cd109d9a3713802152be56c3b1f0e0658ed" +checksum = "1465873a3dfdaa8ae7cb14b4383657caab0b3e8a0aa9ae8e04b044854c8dfce2" dependencies = [ "crossbeam-deque", "crossbeam-utils", @@ -2174,75 +2191,69 @@ dependencies = [ [[package]] name = "redox_syscall" -version = "0.4.1" +version = "0.5.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "4722d768eff46b75989dd134e5c353f0d6296e5aaa3132e776cbdb56be7731aa" +checksum = "2a908a6e00f1fdd0dfd9c0eb08ce85126f6d8bbda50017e74bc4a4b7d4a926a4" dependencies = [ - "bitflags 1.3.2", + "bitflags 2.6.0", ] [[package]] name = "ref-cast" -version = "1.0.20" +version = "1.0.23" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "acde58d073e9c79da00f2b5b84eed919c8326832648a5b109b3fce1bb1175280" +checksum = "ccf0a6f84d5f1d581da8b41b47ec8600871962f2a528115b542b362d4b744931" dependencies = [ "ref-cast-impl", ] [[package]] name = "ref-cast-impl" -version = "1.0.20" +version = "1.0.23" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7f7473c2cfcf90008193dd0e3e16599455cb601a9fce322b5bb55de799664925" +checksum = "bcc303e793d3734489387d205e9b186fac9c6cfacedd98cbb2e8a5943595f3e6" dependencies = [ "proc-macro2", "quote", - "syn 2.0.39", + "syn 2.0.77", ] [[package]] name = "regex" -version = "1.10.2" +version = "1.10.6" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "380b951a9c5e80ddfd6136919eef32310721aa4aacd4889a8d39124b026ab343" +checksum = "4219d74c6b67a3654a9fbebc4b419e22126d13d2f3c4a07ee0cb61ff79a79619" dependencies = [ "aho-corasick", "memchr", "regex-automata", - "regex-syntax 0.8.2", + "regex-syntax", ] [[package]] name = "regex-automata" -version = "0.4.3" +version = "0.4.7" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5f804c7828047e88b2d32e2d7fe5a105da8ee3264f01902f796c8e067dc2483f" +checksum = "38caf58cc5ef2fed281f89292ef23f6365465ed9a41b7a7754eb4e26496c92df" dependencies = [ "aho-corasick", "memchr", - "regex-syntax 0.8.2", + "regex-syntax", ] [[package]] name = "regex-syntax" -version = "0.7.5" +version = "0.8.4" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "dbb5fb1acd8a1a18b3dd5be62d25485eb770e05afb408a9627d14d451bae12da" - -[[package]] -name = "regex-syntax" -version = "0.8.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c08c74e62047bb2de4ff487b251e4a92e24f48745648451635cec7d591162d9f" +checksum = "7a66a03ae7c801facd77a29370b4faec201768915ac14a721ba36f20bc9c209b" [[package]] name = "reqwest" -version = "0.11.22" +version = "0.11.27" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "046cd98826c46c2ac8ddecae268eb5c2e58628688a5fc7a2643704a73faba95b" +checksum = "dd67538700a17451e7cba03ac727fb961abb7607553461627b97de0b89cf4a62" dependencies = [ - "base64", + "base64 0.21.7", "bytes", "encoding_rs", "futures-core", @@ -2260,9 +2271,11 @@ dependencies = [ "once_cell", "percent-encoding", "pin-project-lite", + "rustls-pemfile", "serde", "serde_json", "serde_urlencoded", + "sync_wrapper", "system-configuration", "tokio", "tokio-native-tls", @@ -2276,35 +2289,35 @@ dependencies = [ [[package]] name = "rgb" -version = "0.8.37" +version = "0.8.50" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "05aaa8004b64fd573fc9d002f4e632d51ad4f026c2b5ba95fcb6c2f32c2c47d8" +checksum = "57397d16646700483b67d2dd6511d79318f9d057fdbd21a4066aeac8b41d310a" dependencies = [ "bytemuck", ] [[package]] name = "rustc-demangle" -version = "0.1.23" +version = "0.1.24" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d626bb9dae77e28219937af045c257c28bfd3f69333c512553507f5f9798cb76" +checksum = "719b953e2095829ee67db738b3bfa9fa368c94900df327b3f07fe6e794d2fe1f" [[package]] name = "rustc_version" -version = "0.4.0" +version = "0.4.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "bfa0f585226d2e68097d4f95d113b15b83a82e819ab25717ec0590d9584ef366" +checksum = "cfcb3a22ef46e85b45de6ee7e79d063319ebb6594faafcf1c225ea92ab6e9b92" dependencies = [ "semver", ] [[package]] name = "rustix" -version = "0.38.26" +version = "0.38.37" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "9470c4bf8246c8daf25f9598dca807fb6510347b1e1cfa55749113850c79d88a" +checksum = "8acb788b847c24f28525660c4d7758620a7210875711f79e7f663cc152726811" dependencies = [ - "bitflags 2.4.1", + "bitflags 2.6.0", "errno", "libc", "linux-raw-sys", @@ -2312,22 +2325,25 @@ dependencies = [ ] [[package]] -name = "rustversion" -version = "1.0.14" +name = "rustls-pemfile" +version = "1.0.4" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7ffc183a10b4478d04cbbbfc96d0873219d962dd5accaff2ffbd4ceb7df837f4" +checksum = "1c74cae0a4cf6ccbbf5f359f08efdf8ee7e1dc532573bf0db71968cb56b1448c" +dependencies = [ + "base64 0.21.7", +] + +[[package]] +name = "rustversion" +version = "1.0.17" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "955d28af4278de8121b7ebeb796b6a45735dc01436d898801014aced2773a3d6" [[package]] name = "ryu" -version = "1.0.15" +version = "1.0.18" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "1ad4cc8da4ef723ed60bced201181d83791ad433213d8c24efffda1eec85d741" - -[[package]] -name = "safemem" -version = "0.3.3" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ef703b7cb59335eae2eb93ceb664c0eb7ea6bf567079d843e09420219668e072" +checksum = "f3cb5ba0dc43242ce17de99c180e96db90b235b8a9fdc9543c96d2209116bd9f" [[package]] name = "same-file" @@ -2340,11 +2356,11 @@ dependencies = [ [[package]] name = "schannel" -version = "0.1.22" +version = "0.1.24" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0c3733bf4cf7ea0880754e19cb5a462007c4a8c1914bff372ccc95b464f1df88" +checksum = "e9aaafd5a2b6e3d657ff009d82fbd630b6bd54dd4eb06f21693925cdf80f9b8b" dependencies = [ - "windows-sys 0.48.0", + "windows-sys 0.59.0", ] [[package]] @@ -2355,11 +2371,11 @@ checksum = "94143f37725109f92c262ed2cf5e59bce7498c01bcc1502d7b9afe439a4e9f49" [[package]] name = "security-framework" -version = "2.9.2" +version = "2.11.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "05b64fb303737d99b81884b2c63433e9ae28abebe5eb5045dcdd175dc2ecf4de" +checksum = "897b2245f0b511c87893af39b033e5ca9cce68824c4d7e7630b5a1d339658d02" dependencies = [ - "bitflags 1.3.2", + "bitflags 2.6.0", "core-foundation", "core-foundation-sys", "libc", @@ -2368,9 +2384,9 @@ dependencies = [ [[package]] name = "security-framework-sys" -version = "2.9.1" +version = "2.11.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e932934257d3b408ed8f30db49d85ea163bfe74961f017f405b025af298f0c7a" +checksum = "75da29fe9b9b08fe9d6b22b5b4bcbc75d8db3aa31e639aa56bb62e9d46bfceaf" dependencies = [ "core-foundation-sys", "libc", @@ -2378,9 +2394,9 @@ dependencies = [ [[package]] name = "semver" -version = "1.0.20" +version = "1.0.23" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "836fa6a3e1e547f9a2c4040802ec865b5d85f4014efe00555d7090a3dcaa1090" +checksum = "61697e0a1c7e512e84a621326239844a24d8207b4669b41bc18b32ea5cbf988b" [[package]] name = "seq-macro" @@ -2390,31 +2406,32 @@ checksum = "a3f0bf26fd526d2a95683cd0f87bf103b8539e2ca1ef48ce002d67aad59aa0b4" [[package]] name = "serde" -version = "1.0.192" +version = "1.0.210" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "bca2a08484b285dcb282d0f67b26cadc0df8b19f8c12502c13d966bf9482f001" +checksum = "c8e3592472072e6e22e0a54d5904d9febf8508f65fb8552499a1abc7d1078c3a" dependencies = [ "serde_derive", ] [[package]] name = "serde_derive" -version = "1.0.192" +version = "1.0.210" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d6c7207fbec9faa48073f3e3074cbe553af6ea512d7c21ba46e434e70ea9fbc1" +checksum = "243902eda00fad750862fc144cea25caca5e20d615af0a81bee94ca738f1df1f" dependencies = [ "proc-macro2", "quote", - "syn 2.0.39", + "syn 2.0.77", ] [[package]] name = "serde_json" -version = "1.0.108" +version = "1.0.128" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "3d1c7e3eac408d115102c4c24ad393e0821bb3a5df4d506a80f85f7a742a526b" +checksum = "6ff5456707a1de34e7e37f2a6fd3d3f808c318259cbd01ab6377795054b483d8" dependencies = [ "itoa", + "memchr", "ryu", "serde", ] @@ -2433,9 +2450,9 @@ dependencies = [ [[package]] name = "serde_yaml" -version = "0.9.29" +version = "0.9.34+deprecated" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a15e0ef66bf939a7c890a0bf6d5a733c70202225f9888a89ed5c62298b019129" +checksum = "6a8b1a1a2ebf674015cc02edccce75287f1a0130d394307b36743c2f5d504b47" dependencies = [ "indexmap", "itoa", @@ -2465,6 +2482,12 @@ version = "1.1.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "24188a676b6ae68c3b2cb3a01be17fbf7240ce009799bb56d5b1409051e78fde" +[[package]] +name = "shlex" +version = "1.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0fda2ff0d084019ba4d7c6f371c95d8fd75ce3524c3cb8fb653a3023f6323e64" + [[package]] name = "signal-hook" version = "0.3.17" @@ -2477,29 +2500,29 @@ dependencies = [ [[package]] name = "signal-hook-mio" -version = "0.2.3" +version = "0.2.4" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "29ad2e15f37ec9a6cc544097b78a1ec90001e9f71b81338ca39f430adaca99af" +checksum = "34db1a06d485c9142248b7a054f034b349b212551f3dfd19c94d45a754a217cd" dependencies = [ "libc", - "mio", + "mio 0.8.11", "signal-hook", ] [[package]] name = "signal-hook-registry" -version = "1.4.1" +version = "1.4.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d8229b473baa5980ac72ef434c4415e70c4b5e71b423043adb4ba059f89c99a1" +checksum = "a9e9e0b4211b72e7b8b6e85c807d36c212bdb33ea8587f7569562a84df5465b1" dependencies = [ "libc", ] [[package]] name = "simd-json" -version = "0.13.4" +version = "0.13.10" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e5a3720326b20bf5b95b72dbbd133caae7e0dcf71eae8f6e6656e71a7e5c9aaa" +checksum = "570c430b3d902ea083097e853263ae782dfe40857d93db019a12356c8e8143fa" dependencies = [ "ahash", "getrandom", @@ -2530,9 +2553,9 @@ dependencies = [ [[package]] name = "smallvec" -version = "1.11.2" +version = "1.13.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "4dccd0940a2dcdf68d092b8cbab7dc0ad8fa938bf95787e1b916b0e3d0e8e970" +checksum = "3c5e1a9a646d36c3599cd173a41282daf47c44583ad367b8e6837255952e5c67" [[package]] name = "smartstring" @@ -2553,22 +2576,12 @@ checksum = "1b6b67fb9a61334225b5b790716f609cd58395f895b3fe8b328786812a40bc3b" [[package]] name = "socket2" -version = "0.4.10" +version = "0.5.7" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "9f7916fc008ca5542385b89a3d3ce689953c143e9304a9bf8beec1de48994c0d" +checksum = "ce305eb0b4296696835b71df73eb912e0f1ffd2556a501fcede6e0c50349191c" dependencies = [ "libc", - "winapi", -] - -[[package]] -name = "socket2" -version = "0.5.5" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7b5fac59a5cb5dd637972e5fca70daf0523c9067fcdc4842f053dae04a18f8e9" -dependencies = [ - "libc", - "windows-sys 0.48.0", + "windows-sys 0.52.0", ] [[package]] @@ -2615,15 +2628,15 @@ checksum = "fe895eb47f22e2ddd4dabc02bce419d2e643c8e3b585c78158b349195bc24d82" [[package]] name = "strsim" -version = "0.10.0" +version = "0.11.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "73473c0e59e6d5812c5dfe2a064a6444949f089e20eec9a2e5506596494e4623" +checksum = "7da8b5736845d9f2fcb837ea5d9e2628564b3b043a70948a3f0b778838c5fb4f" [[package]] name = "strum" -version = "0.25.0" +version = "0.26.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "290d54ea6f91c969195bdbcd7442c8c2a2ba87da8bf60a7ee86a235d4bc1e125" +checksum = "8fec0f0aef304996cf250b31b5a10dee7980c85da9d759361292b8bca5a18f06" [[package]] name = "strum_macros" @@ -2631,11 +2644,24 @@ version = "0.25.3" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "23dc1fa9ac9c169a78ba62f0b841814b7abae11bdd047b9c58f893439e309ea0" dependencies = [ - "heck", + "heck 0.4.1", "proc-macro2", "quote", "rustversion", - "syn 2.0.39", + "syn 2.0.77", +] + +[[package]] +name = "strum_macros" +version = "0.26.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4c6bee85a5a24955dc440386795aa378cd9cf82acd5f764469152d2270e581be" +dependencies = [ + "heck 0.5.0", + "proc-macro2", + "quote", + "rustversion", + "syn 2.0.77", ] [[package]] @@ -2651,9 +2677,9 @@ dependencies = [ [[package]] name = "syn" -version = "2.0.39" +version = "2.0.77" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "23e78b90f2fcf45d3e842032ce32e3f2d1545ba6636271dcbf24fa306d87be7a" +checksum = "9f35bcdf61fd8e7be6caf75f429fdca8beb3ed76584befb503b1569faee373ed" dependencies = [ "proc-macro2", "quote", @@ -2661,10 +2687,16 @@ dependencies = [ ] [[package]] -name = "syntect" -version = "5.1.0" +name = "sync_wrapper" +version = "0.1.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e02b4b303bf8d08bfeb0445cba5068a3d306b6baece1d5582171a9bf49188f91" +checksum = "2047c6ded9c721764247e62cd3b03c09ffc529b2ba5b10ec482ae507a4a70160" + +[[package]] +name = "syntect" +version = "5.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "874dcfa363995604333cf947ae9f751ca3af4522c60886774c4963943b4746b1" dependencies = [ "bincode", "bitflags 1.3.2", @@ -2673,8 +2705,9 @@ dependencies = [ "once_cell", "onig", "plist", - "regex-syntax 0.7.5", + "regex-syntax", "serde", + "serde_derive", "serde_json", "thiserror", "walkdir", @@ -2728,28 +2761,28 @@ dependencies = [ [[package]] name = "target-features" -version = "0.1.5" +version = "0.1.6" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "cfb5fa503293557c5158bd215fdc225695e567a77e453f5d4452a50a193969bd" +checksum = "c1bbb9f3c5c463a01705937a24fdabc5047929ac764b2d5b9cf681c1f5041ed5" [[package]] name = "tempfile" -version = "3.8.1" +version = "3.12.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7ef1adac450ad7f4b3c28589471ade84f25f731a7a0fe30d71dfa9f60fd808e5" +checksum = "04cbcdd0c794ebb0d4cf35e88edd2f7d2c4c3e9a5a6dab322839b321c6a87a64" dependencies = [ "cfg-if", "fastrand", - "redox_syscall", + "once_cell", "rustix", - "windows-sys 0.48.0", + "windows-sys 0.59.0", ] [[package]] name = "termcolor" -version = "1.4.0" +version = "1.4.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ff1bc3d3f05aff0403e8ac0d92ced918ec05b666a43f83297ccef5bea8a3d449" +checksum = "06794f8f6c5c898b3275aebefa6b8a1cb24cd2c6c79397ab15774837a0bc5755" dependencies = [ "winapi-util", ] @@ -2766,29 +2799,29 @@ dependencies = [ [[package]] name = "thiserror" -version = "1.0.50" +version = "1.0.63" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f9a7210f5c9a7156bb50aa36aed4c95afb51df0df00713949448cf9e97d382d2" +checksum = "c0342370b38b6a11b6cc11d6a805569958d54cfa061a29969c3b5ce2ea405724" dependencies = [ "thiserror-impl", ] [[package]] name = "thiserror-impl" -version = "1.0.50" +version = "1.0.63" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "266b2e40bc00e5a6c09c3584011e08b06f123c00362c92b975ba9843aaaa14b8" +checksum = "a4558b58466b9ad7ca0f102865eccc95938dca1a74a856f2b57b6629050da261" dependencies = [ "proc-macro2", "quote", - "syn 2.0.39", + "syn 2.0.77", ] [[package]] name = "thread_local" -version = "1.1.7" +version = "1.1.8" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "3fdd6f064ccff2d6567adcb3873ca630700f00b5ad3f060c25b5dcfd9a4ce152" +checksum = "8b9ef9bad013ada3808854ceac7b46812a6465ba368859a37e2100283d2d719c" dependencies = [ "cfg-if", "once_cell", @@ -2796,12 +2829,13 @@ dependencies = [ [[package]] name = "time" -version = "0.3.31" +version = "0.3.36" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f657ba42c3f86e7680e53c8cd3af8abbe56b5491790b46e22e19c0d57463583e" +checksum = "5dfd88e563464686c916c7e46e623e520ddc6d79fa6641390f2e3fa86e83e885" dependencies = [ "deranged", "itoa", + "num-conv", "powerfmt", "serde", "time-core", @@ -2816,18 +2850,19 @@ checksum = "ef927ca75afb808a4d64dd374f00a2adf8d0fcff8e7b184af886c3c87ec4a3f3" [[package]] name = "time-macros" -version = "0.2.16" +version = "0.2.18" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "26197e33420244aeb70c3e8c78376ca46571bc4e701e4791c2cd9f57dcb3a43f" +checksum = "3f252a68540fde3a3877aeea552b832b40ab9a69e318efd078774a01ddee1ccf" dependencies = [ + "num-conv", "time-core", ] [[package]] name = "tinyvec" -version = "1.6.0" +version = "1.8.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "87cc5ceb3875bb20c2890005a4e226a4651264a5c75edb2421b52861a0a0cb50" +checksum = "445e881f4f6d382d5f27c034e25eb92edd7c784ceab92a0937db7f2e9471b938" dependencies = [ "tinyvec_macros", ] @@ -2840,32 +2875,31 @@ checksum = "1f3ccbac311fea05f86f61904b462b55fb3df8837a366dfc601a0161d0532f20" [[package]] name = "tokio" -version = "1.34.0" +version = "1.40.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d0c014766411e834f7af5b8f4cf46257aab4036ca95e9d2c144a10f59ad6f5b9" +checksum = "e2b070231665d27ad9ec9b8df639893f46727666c6767db40317fbe920a5d998" dependencies = [ "backtrace", "bytes", "libc", - "mio", - "num_cpus", + "mio 1.0.2", "parking_lot", "pin-project-lite", "signal-hook-registry", - "socket2 0.5.5", + "socket2", "tokio-macros", - "windows-sys 0.48.0", + "windows-sys 0.52.0", ] [[package]] name = "tokio-macros" -version = "2.2.0" +version = "2.4.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5b8a1e28f2deaa14e508979454cb3a223b10b938b45af148bc0986de36f1923b" +checksum = "693d596312e88961bc67d7f1f97af8a70227d9f90c31bba5806eec004978d752" dependencies = [ "proc-macro2", "quote", - "syn 2.0.39", + "syn 2.0.77", ] [[package]] @@ -2880,21 +2914,22 @@ dependencies = [ [[package]] name = "tokio-util" -version = "0.7.10" +version = "0.7.12" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5419f34732d9eb6ee4c3578b7989078579b7f039cbbb9ca2c4da015749371e15" +checksum = "61e7c3654c13bcd040d4a03abee2c75b1d14a37b423cf5a813ceae1cc903ec6a" dependencies = [ "bytes", "futures-core", "futures-sink", "pin-project-lite", "tokio", - "tracing", ] [[package]] name = "toolstr" -version = "0.1.3" +version = "0.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "eea5389dd1f24e3b2b025cd6f4efe63729a57b1c930e7208daec0905b8318388" dependencies = [ "chrono", "polars", @@ -2907,6 +2942,8 @@ dependencies = [ [[package]] name = "toolstr_colored" version = "2.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8d335176ed9b133b9d9e226656f2f486f84ebac50250c598246ac6d6d512ac05" dependencies = [ "lazy_static", "windows-sys 0.48.0", @@ -2914,9 +2951,9 @@ dependencies = [ [[package]] name = "tower-service" -version = "0.3.2" +version = "0.3.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b6bc1c9ce2b5135ac7f93c72918fc37feb872bdc6a5533a8b85eb4b86bfdae52" +checksum = "8df9b6e13f2d32c91b9bd719c00d1958837bc7dec474d94952798cc8e69eeec3" [[package]] name = "tracing" @@ -2937,7 +2974,7 @@ checksum = "34704c8d6ebcbc939824180af020566b01a7c01f80641264eba0999f6c2b6be7" dependencies = [ "proc-macro2", "quote", - "syn 2.0.39", + "syn 2.0.77", ] [[package]] @@ -2977,36 +3014,36 @@ dependencies = [ [[package]] name = "try-lock" -version = "0.2.4" +version = "0.2.5" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "3528ecfd12c466c6f163363caf2d02a71161dd5e1cc6ae7b34207ea2d42d81ed" +checksum = "e421abadd41a4225275504ea4d6566923418b7f05506fbc9c0fe86ba7396114b" [[package]] name = "unicode-bidi" -version = "0.3.13" +version = "0.3.15" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "92888ba5573ff080736b3648696b70cafad7d250551175acbaa4e0385b3e1460" +checksum = "08f95100a766bf4f8f28f90d77e0a5461bbdb219042e7679bebe79004fed8d75" [[package]] name = "unicode-ident" -version = "1.0.12" +version = "1.0.13" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "3354b9ac3fae1ff6755cb6db53683adb661634f67557942dea4facebec0fee4b" +checksum = "e91b56cd4cadaeb79bbf1a5645f6b4f8dc5bde8834ad5894a8db35fda9efa1fe" [[package]] name = "unicode-normalization" -version = "0.1.22" +version = "0.1.23" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5c5713f0fc4b5db668a2ac63cdb7bb4469d8c9fed047b1d0292cc7b0ce2ba921" +checksum = "a56d1686db2308d901306f92a263857ef59ea39678a5458e7cb17f01415101f5" dependencies = [ "tinyvec", ] [[package]] name = "unicode-segmentation" -version = "1.10.1" +version = "1.11.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "1dd624098567895118886609431a7c3b8f516e41d30e0643f03d94592a147e36" +checksum = "d4c87d22b6e3f4a18d4d40ef354e97c90fcb14dd91d7dc0aa9d8a1172ebf7202" [[package]] name = "unicode-truncate" @@ -3019,21 +3056,21 @@ dependencies = [ [[package]] name = "unicode-width" -version = "0.1.11" +version = "0.1.13" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e51733f11c9c4f72aa0c160008246859e340b00807569a0da0e7a1079b27ba85" +checksum = "0336d538f7abc86d282a4189614dfaa90810dfc2c6f6427eaf88e16311dd225d" [[package]] name = "unsafe-libyaml" -version = "0.2.10" +version = "0.2.11" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ab4c90930b95a82d00dc9e9ac071b4991924390d46cbd0dfe566148667605e4b" +checksum = "673aac59facbab8a9007c7f6108d11f63b603f7cabff99fabf650fea5c32b861" [[package]] name = "url" -version = "2.5.0" +version = "2.5.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "31e6302e3bb753d46e83516cae55ae196fc0c309407cf11ab35cc51a4c2a4633" +checksum = "22784dbdf76fdde8af1aeda5622b546b422b6fc585325248a2bf9f5e41e94d6c" dependencies = [ "form_urlencoded", "idna", @@ -3042,9 +3079,9 @@ dependencies = [ [[package]] name = "utf8parse" -version = "0.2.1" +version = "0.2.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "711b9620af191e0cdc7468a8d14e709c3dcdb115b36f838e601583af800a370a" +checksum = "06abde3611657adf66d383f00b093d7faecc7fa57071cce2578660c9f1010821" [[package]] name = "valuable" @@ -3054,9 +3091,9 @@ checksum = "830b7e5d4d90034032940e4ace0d9a9a057e7a45cd94e6c007832e39edb82f6d" [[package]] name = "value-trait" -version = "0.8.0" +version = "0.8.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ea87257cfcbedcb9444eda79c59fdfea71217e6305afee8ee33f500375c2ac97" +checksum = "dad8db98c1e677797df21ba03fca7d3bf9bec3ca38db930954e4fe6e1ea27eb4" dependencies = [ "float-cmp", "halfbrown", @@ -3072,15 +3109,15 @@ checksum = "accd4ea62f7bb7a82fe23066fb0957d48ef677f6eeb8215f372f52e48bb32426" [[package]] name = "version_check" -version = "0.9.4" +version = "0.9.5" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "49874b5167b65d7193b8aba1567f5c7d93d001cafc34600cee003eda787e483f" +checksum = "0b928f33d975fc6ad9f86c8f283853ad26bdd5b10b7f1542aa2fa15e2289105a" [[package]] name = "walkdir" -version = "2.4.0" +version = "2.5.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d71d857dc86794ca4c280d616f7da00d2dbfd8cd788846559a6813e6aa4b54ee" +checksum = "29790946404f91d9c5d06f9874efddea1dc06c5efe94541a7d6863108e3a5e4b" dependencies = [ "same-file", "winapi-util", @@ -3103,34 +3140,35 @@ checksum = "9c8d87e72b64a3b4db28d11ce29237c246188f4f51057d65a7eab63b7987e423" [[package]] name = "wasm-bindgen" -version = "0.2.89" +version = "0.2.93" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0ed0d4f68a3015cc185aff4db9506a015f4b96f95303897bfa23f846db54064e" +checksum = "a82edfc16a6c469f5f44dc7b571814045d60404b55a0ee849f9bcfa2e63dd9b5" dependencies = [ "cfg-if", + "once_cell", "wasm-bindgen-macro", ] [[package]] name = "wasm-bindgen-backend" -version = "0.2.89" +version = "0.2.93" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "1b56f625e64f3a1084ded111c4d5f477df9f8c92df113852fa5a374dbda78826" +checksum = "9de396da306523044d3302746f1208fa71d7532227f15e347e2d93e4145dd77b" dependencies = [ "bumpalo", "log", "once_cell", "proc-macro2", "quote", - "syn 2.0.39", + "syn 2.0.77", "wasm-bindgen-shared", ] [[package]] name = "wasm-bindgen-futures" -version = "0.4.39" +version = "0.4.43" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ac36a15a220124ac510204aec1c3e5db8a22ab06fd6706d881dc6149f8ed9a12" +checksum = "61e9300f63a621e96ed275155c108eb6f843b6a26d053f122ab69724559dc8ed" dependencies = [ "cfg-if", "js-sys", @@ -3140,9 +3178,9 @@ dependencies = [ [[package]] name = "wasm-bindgen-macro" -version = "0.2.89" +version = "0.2.93" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0162dbf37223cd2afce98f3d0785506dcb8d266223983e4b5b525859e6e182b2" +checksum = "585c4c91a46b072c92e908d99cb1dcdf95c5218eeb6f3bf1efa991ee7a68cccf" dependencies = [ "quote", "wasm-bindgen-macro-support", @@ -3150,28 +3188,28 @@ dependencies = [ [[package]] name = "wasm-bindgen-macro-support" -version = "0.2.89" +version = "0.2.93" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f0eb82fcb7930ae6219a7ecfd55b217f5f0893484b7a13022ebb2b2bf20b5283" +checksum = "afc340c74d9005395cf9dd098506f7f44e38f2b4a21c6aaacf9a105ea5e1e836" dependencies = [ "proc-macro2", "quote", - "syn 2.0.39", + "syn 2.0.77", "wasm-bindgen-backend", "wasm-bindgen-shared", ] [[package]] name = "wasm-bindgen-shared" -version = "0.2.89" +version = "0.2.93" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7ab9b36309365056cd639da3134bf87fa8f3d86008abf99e612384a6eecd459f" +checksum = "c62a0a307cb4a311d3a07867860911ca130c3494e8c2719593806c08bc5d0484" [[package]] name = "web-sys" -version = "0.3.66" +version = "0.3.70" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "50c24a44ec86bb68fbecd1b3efed7e85ea5621b39b35ef2766b66cd984f8010f" +checksum = "26fdeaafd9bd129f65e7c031593c24d62186301e0c72c8978fa1678be7d532c0" dependencies = [ "js-sys", "wasm-bindgen", @@ -3191,9 +3229,9 @@ dependencies = [ [[package]] name = "wild" -version = "2.2.0" +version = "2.2.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "10d01931a94d5a115a53f95292f51d316856b68a035618eb831bbba593a30b67" +checksum = "a3131afc8c575281e1e80f36ed6a092aa502c08b18ed7524e86fbbb12bb410e1" dependencies = [ "glob", ] @@ -3216,11 +3254,11 @@ checksum = "ac3b87c63620426dd9b991e5ce0329eff545bccbbb34f3be09ff6fb6ab51b7b6" [[package]] name = "winapi-util" -version = "0.1.6" +version = "0.1.9" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f29e6f9198ba0d26b4c9f07dbe6f9ed633e1f3d5b8b414090084349e46a52596" +checksum = "cf221c93e13a30d793f7645a0e7762c55d169dbb0a49671918a2319d289b10bb" dependencies = [ - "winapi", + "windows-sys 0.59.0", ] [[package]] @@ -3231,20 +3269,11 @@ checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f" [[package]] name = "windows-core" -version = "0.51.1" +version = "0.52.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f1f8cf84f35d2db49a46868f947758c7a1138116f7fac3bc844f43ade1292e64" +checksum = "33ab640c8d7e35bf8ba19b884ba838ceb4fba93a4e8c65a9059d08afcfc683d9" dependencies = [ - "windows-targets 0.48.5", -] - -[[package]] -name = "windows-sys" -version = "0.45.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "75283be5efb2831d37ea142365f009c02ec203cd29a3ebecbc093d52315b66d0" -dependencies = [ - "windows-targets 0.42.2", + "windows-targets 0.52.6", ] [[package]] @@ -3262,22 +3291,16 @@ version = "0.52.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "282be5f36a8ce781fad8c8ae18fa3f9beff57ec1b52cb3de0789201425d9a33d" dependencies = [ - "windows-targets 0.52.0", + "windows-targets 0.52.6", ] [[package]] -name = "windows-targets" -version = "0.42.2" +name = "windows-sys" +version = "0.59.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8e5180c00cd44c9b1c88adb3693291f1cd93605ded80c250a75d472756b4d071" +checksum = "1e38bc4d79ed67fd075bcc251a1c39b32a1776bbe92e5bef1f0bf1f8c531853b" dependencies = [ - "windows_aarch64_gnullvm 0.42.2", - "windows_aarch64_msvc 0.42.2", - "windows_i686_gnu 0.42.2", - "windows_i686_msvc 0.42.2", - "windows_x86_64_gnu 0.42.2", - "windows_x86_64_gnullvm 0.42.2", - "windows_x86_64_msvc 0.42.2", + "windows-targets 0.52.6", ] [[package]] @@ -3297,25 +3320,20 @@ dependencies = [ [[package]] name = "windows-targets" -version = "0.52.0" +version = "0.52.6" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8a18201040b24831fbb9e4eb208f8892e1f50a37feb53cc7ff887feb8f50e7cd" +checksum = "9b724f72796e036ab90c1021d4780d4d3d648aca59e491e6b98e725b84e99973" dependencies = [ - "windows_aarch64_gnullvm 0.52.0", - "windows_aarch64_msvc 0.52.0", - "windows_i686_gnu 0.52.0", - "windows_i686_msvc 0.52.0", - "windows_x86_64_gnu 0.52.0", - "windows_x86_64_gnullvm 0.52.0", - "windows_x86_64_msvc 0.52.0", + "windows_aarch64_gnullvm 0.52.6", + "windows_aarch64_msvc 0.52.6", + "windows_i686_gnu 0.52.6", + "windows_i686_gnullvm", + "windows_i686_msvc 0.52.6", + "windows_x86_64_gnu 0.52.6", + "windows_x86_64_gnullvm 0.52.6", + "windows_x86_64_msvc 0.52.6", ] -[[package]] -name = "windows_aarch64_gnullvm" -version = "0.42.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "597a5118570b68bc08d8d59125332c54f1ba9d9adeedeef5b99b02ba2b0698f8" - [[package]] name = "windows_aarch64_gnullvm" version = "0.48.5" @@ -3324,15 +3342,9 @@ checksum = "2b38e32f0abccf9987a4e3079dfb67dcd799fb61361e53e2882c3cbaf0d905d8" [[package]] name = "windows_aarch64_gnullvm" -version = "0.52.0" +version = "0.52.6" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "cb7764e35d4db8a7921e09562a0304bf2f93e0a51bfccee0bd0bb0b666b015ea" - -[[package]] -name = "windows_aarch64_msvc" -version = "0.42.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e08e8864a60f06ef0d0ff4ba04124db8b0fb3be5776a5cd47641e942e58c4d43" +checksum = "32a4622180e7a0ec044bb555404c800bc9fd9ec262ec147edd5989ccd0c02cd3" [[package]] name = "windows_aarch64_msvc" @@ -3342,15 +3354,9 @@ checksum = "dc35310971f3b2dbbf3f0690a219f40e2d9afcf64f9ab7cc1be722937c26b4bc" [[package]] name = "windows_aarch64_msvc" -version = "0.52.0" +version = "0.52.6" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "bbaa0368d4f1d2aaefc55b6fcfee13f41544ddf36801e793edbbfd7d7df075ef" - -[[package]] -name = "windows_i686_gnu" -version = "0.42.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c61d927d8da41da96a81f029489353e68739737d3beca43145c8afec9a31a84f" +checksum = "09ec2a7bb152e2252b53fa7803150007879548bc709c039df7627cabbd05d469" [[package]] name = "windows_i686_gnu" @@ -3360,15 +3366,15 @@ checksum = "a75915e7def60c94dcef72200b9a8e58e5091744960da64ec734a6c6e9b3743e" [[package]] name = "windows_i686_gnu" -version = "0.52.0" +version = "0.52.6" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a28637cb1fa3560a16915793afb20081aba2c92ee8af57b4d5f28e4b3e7df313" +checksum = "8e9b5ad5ab802e97eb8e295ac6720e509ee4c243f69d781394014ebfe8bbfa0b" [[package]] -name = "windows_i686_msvc" -version = "0.42.2" +name = "windows_i686_gnullvm" +version = "0.52.6" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "44d840b6ec649f480a41c8d80f9c65108b92d89345dd94027bfe06ac444d1060" +checksum = "0eee52d38c090b3caa76c563b86c3a4bd71ef1a819287c19d586d7334ae8ed66" [[package]] name = "windows_i686_msvc" @@ -3378,15 +3384,9 @@ checksum = "8f55c233f70c4b27f66c523580f78f1004e8b5a8b659e05a4eb49d4166cca406" [[package]] name = "windows_i686_msvc" -version = "0.52.0" +version = "0.52.6" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ffe5e8e31046ce6230cc7215707b816e339ff4d4d67c65dffa206fd0f7aa7b9a" - -[[package]] -name = "windows_x86_64_gnu" -version = "0.42.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8de912b8b8feb55c064867cf047dda097f92d51efad5b491dfb98f6bbb70cb36" +checksum = "240948bc05c5e7c6dabba28bf89d89ffce3e303022809e73deaefe4f6ec56c66" [[package]] name = "windows_x86_64_gnu" @@ -3396,15 +3396,9 @@ checksum = "53d40abd2583d23e4718fddf1ebec84dbff8381c07cae67ff7768bbf19c6718e" [[package]] name = "windows_x86_64_gnu" -version = "0.52.0" +version = "0.52.6" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "3d6fa32db2bc4a2f5abeacf2b69f7992cd09dca97498da74a151a3132c26befd" - -[[package]] -name = "windows_x86_64_gnullvm" -version = "0.42.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "26d41b46a36d453748aedef1486d5c7a85db22e56aff34643984ea85514e94a3" +checksum = "147a5c80aabfbf0c7d901cb5895d1de30ef2907eb21fbbab29ca94c5b08b1a78" [[package]] name = "windows_x86_64_gnullvm" @@ -3414,15 +3408,9 @@ checksum = "0b7b52767868a23d5bab768e390dc5f5c55825b6d30b86c844ff2dc7414044cc" [[package]] name = "windows_x86_64_gnullvm" -version = "0.52.0" +version = "0.52.6" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "1a657e1e9d3f514745a572a6846d3c7aa7dbe1658c056ed9c3344c4109a6949e" - -[[package]] -name = "windows_x86_64_msvc" -version = "0.42.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "9aec5da331524158c6d1a4ac0ab1541149c0b9505fde06423b02f5ef0106b9f0" +checksum = "24d5b23dc417412679681396f2b49f3de8c1473deb516bd34410872eff51ed0d" [[package]] name = "windows_x86_64_msvc" @@ -3432,9 +3420,9 @@ checksum = "ed94fce61571a4006852b7389a063ab983c02eb1bb37b47f8272ce92d06d9538" [[package]] name = "windows_x86_64_msvc" -version = "0.52.0" +version = "0.52.6" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "dff9641d1cd4be8d1a070daf9e3773c5f67e78b4d9d42263020c057706765c04" +checksum = "589f6da84c646204747d1270a2a5661ea66ed1cced2631d546fdfb155959f9ec" [[package]] name = "winreg" @@ -3448,9 +3436,9 @@ dependencies = [ [[package]] name = "xxhash-rust" -version = "0.8.7" +version = "0.8.12" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "9828b178da53440fa9c766a3d2f73f7cf5d0ac1fe3980c1e5018d899fd19e07b" +checksum = "6a5cbf750400958819fb6178eaa83bee5cd9c29a26a40cc241df8c70fdd46984" [[package]] name = "yaml-rust" @@ -3463,53 +3451,54 @@ dependencies = [ [[package]] name = "yansi" -version = "0.5.1" +version = "1.0.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "09041cd90cf85f7f8b2df60c646f853b7f535ce68f85244eb6731cf89fa498ec" +checksum = "cfe53a6657fd280eaa890a3bc59152892ffa3e30101319d168b781ed6529b049" [[package]] name = "zerocopy" -version = "0.7.30" +version = "0.7.35" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "306dca4455518f1f31635ec308b6b3e4eb1b11758cefafc782827d0aa7acb5c7" +checksum = "1b9b4fd18abc82b8136838da5d50bae7bdea537c574d8dc1a34ed098d6c166f0" dependencies = [ + "byteorder", "zerocopy-derive", ] [[package]] name = "zerocopy-derive" -version = "0.7.30" +version = "0.7.35" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "be912bf68235a88fbefd1b73415cb218405958d1655b2ece9035a19920bdf6ba" +checksum = "fa4f8080344d4671fb4e831a13ad1e68092748387dfc4f55e356242fae12ce3e" dependencies = [ "proc-macro2", "quote", - "syn 2.0.39", + "syn 2.0.77", ] [[package]] name = "zstd" -version = "0.13.0" +version = "0.13.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "bffb3309596d527cfcba7dfc6ed6052f1d39dfbd7c867aa2e865e4a449c10110" +checksum = "fcf2b778a664581e31e389454a7072dab1647606d44f7feea22cd5abb9c9f3f9" dependencies = [ "zstd-safe", ] [[package]] name = "zstd-safe" -version = "7.0.0" +version = "7.2.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "43747c7422e2924c11144d5229878b98180ef8b06cca4ab5af37afc8a8d8ea3e" +checksum = "54a3ab4db68cea366acc5c897c7b4d4d1b8994a9cd6e6f841f8964566a419059" dependencies = [ "zstd-sys", ] [[package]] name = "zstd-sys" -version = "2.0.9+zstd.1.5.5" +version = "2.0.13+zstd.1.5.6" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "9e16efa8a874a0481a574084d34cc26fdb3b99627480f785888deb6386506656" +checksum = "38ff0f21cfee8f97d94cef41359e0c89aa6113028ab0291aa8ca0038995a95aa" dependencies = [ "cc", "pkg-config", diff --git a/rust/Cargo.toml b/rust/Cargo.toml index 1505d0d..ce713ff 100644 --- a/rust/Cargo.toml +++ b/rust/Cargo.toml @@ -7,10 +7,9 @@ members = ["crates/mesc", "crates/mesc_cli"] resolver = "2" [workspace.package] -version = "0.1.4" +version = "0.3.0" edition = "2021" license = "MIT OR Apache-2.0" -homepage = "https://github.com/paradigmxyz/mesc" repository = "https://github.com/paradigmxyz/mesc" exclude = [".github/"] diff --git a/rust/README.md b/rust/README.md index d039942..75bb36d 100644 --- a/rust/README.md +++ b/rust/README.md @@ -16,7 +16,7 @@ The `crates/mesc_cli` crate is a tool for reading, writing, and validating MESC Inside a cargo project: `cargo add mesc` -Inside a `Cargo.toml`: `mesc = "1.0"` +Inside a `Cargo.toml`: `mesc = "0.2.1"` ## Example Usage @@ -46,6 +46,8 @@ pub struct Profile { pub name: String, pub default_endpoint: Option, pub network_defaults: HashMap, + pub profile_metadata: HashMap, + pub use_mesc: bool, } #[derive(Serialize, Deserialize, Debug, Clone, Eq, PartialEq, Hash)] @@ -54,11 +56,12 @@ pub struct ChainId(String); Basic read functions ```rust -use mesc; -use mesc::MescError; +use mesc::{MescError, Endpoint}; +use std::collections::HashMap; type OptionalResult = Result, MescError>; type MultiResult = Result, MescError>; +type MetadataResult = Result, MescError>; // check whether mesc is enabled let enabled: bool = mesc::is_mesc_enabled(); @@ -67,22 +70,26 @@ let enabled: bool = mesc::is_mesc_enabled(); let endpoint: OptionalResult = mesc::get_default_endpoint(None); // get the default endpoint of a network -let endpoint: OptionalResult = mesc::get_endpoint_by_network(5, None); +let endpoint: OptionalResult = mesc::get_endpoint_by_network("5", None); // get the default network for a particular tool -let chain_id: OptionalResult = mesc::get_default_endpoint("xyz_tool"); +let chain_id: OptionalResult = mesc::get_default_endpoint(Some("xyz_tool")); // get the default endpoint of a network for a particular tool -let endpoint: OptionalResult = mesc::get_endpoint_by_network(5, "xyz_tool"); +let endpoint: OptionalResult = mesc::get_endpoint_by_network("5", Some("xyz_tool")); // get an endpoint by name -let endpoint: OptionalResult = mesc::get_endpoint_by_name("local_query"); +let endpoint: OptionalResult = mesc::get_endpoint_by_name("local_goerli"); // parse a user-provided string into a matching endpoint // (first try 1. endpoint name, then 2. chain id, then 3. network name) -let endpoint: OptionalResult = mesc::get_endpoint_by_query(user_str, "xyz_tool"); +let user_str = "local_goerli"; +let endpoint: OptionalResult = mesc::get_endpoint_by_query(user_str, Some("xyz_tool")); // find all endpoints matching given criteria -let query = mesc::MultiEndpointQuery::new().chain_id(5); +let query = mesc::MultiEndpointQuery::new().chain_id("5").unwrap(); let endpoints: MultiResult = mesc::find_endpoints(query); + +// get non-endpoint metadata +let metadata: MetadataResult = mesc::get_global_metadata(Some("xyz_tool")); ``` diff --git a/rust/crates/mesc/Cargo.toml b/rust/crates/mesc/Cargo.toml index 2bd9d68..113aefd 100644 --- a/rust/crates/mesc/Cargo.toml +++ b/rust/crates/mesc/Cargo.toml @@ -4,7 +4,6 @@ description = "libraries for creating, loading, and modifying MESC configuation version.workspace = true edition.workspace = true license.workspace = true -homepage.workspace = true repository.workspace = true [dependencies] diff --git a/rust/crates/mesc/src/directory.rs b/rust/crates/mesc/src/directory.rs index 383e055..25069a5 100644 --- a/rust/crates/mesc/src/directory.rs +++ b/rust/crates/mesc/src/directory.rs @@ -1,30 +1,14 @@ use crate::ChainId; -use std::collections::HashMap; - -fn known_networks() -> HashMap<&'static str, ChainId> { - [ - ("ethereum", 1u32.into()), - ("goerli", 5u32.into()), - ("optimism", 10u32.into()), - ("polygon", 137u32.into()), - ("arbitrum", 42161u32.into()), - ] - .iter() - .cloned() - .collect() -} /// get chain id of given network name -pub(crate) fn get_network_chain_id(network: &str) -> Option { - known_networks().remove(network) +pub(crate) fn get_network_chain_id(network_name: &str) -> Option { + crate::network_names::NETWORKS + .iter() + .find(|(_, name)| *name == network_name) + .map(|(chain_id, _)| (*chain_id).into()) } /// get network name of given chain id -pub fn get_network_name(chain_id: &ChainId) -> Option { - for (name, other_chain_id) in known_networks().iter() { - if chain_id == other_chain_id { - return Some(name.to_string()) - } - } - None +pub fn get_network_name(chain_id: &ChainId) -> Option<&'static str> { + crate::network_names::get_network_names().get(chain_id).copied() } diff --git a/rust/crates/mesc/src/interface.rs b/rust/crates/mesc/src/interface.rs index ae76f0f..21e20c1 100644 --- a/rust/crates/mesc/src/interface.rs +++ b/rust/crates/mesc/src/interface.rs @@ -18,7 +18,7 @@ pub fn get_default_endpoint(profile: Option<&str>) -> Result, M } /// get endpoint by network -pub fn get_endpoint_by_network( +pub fn get_endpoint_by_network( chain_id: T, profile: Option<&str>, ) -> Result, MescError> { @@ -44,6 +44,8 @@ pub fn find_endpoints(query: MultiEndpointQuery) -> Result, MescEr } /// get global metadata -pub fn get_global_metadata() -> Result, MescError> { - query::get_global_metadata(&load_config_data()?) +pub fn get_global_metadata( + profile: Option<&str>, +) -> Result, MescError> { + query::get_global_metadata(&load_config_data()?, profile) } diff --git a/rust/crates/mesc/src/load.rs b/rust/crates/mesc/src/load.rs index c8e0d91..fa4f0f4 100644 --- a/rust/crates/mesc/src/load.rs +++ b/rust/crates/mesc/src/load.rs @@ -4,7 +4,7 @@ use std::{env, fs}; /// check whether mesc is enabled pub fn is_mesc_enabled() -> bool { if let Ok("DISABLED") = std::env::var("MESC_MODE").as_deref() { - return false + return false; }; let env_vars = [ "MESC_MODE", @@ -79,6 +79,9 @@ pub fn load_file_config(path: Option) -> Result { Some(path) => path, None => get_config_path()?, }; + if !std::path::Path::new(path.as_str()).exists() { + return Err(MescError::MissingConfigFile(path)); + }; let config_str = fs::read_to_string(path).map_err(MescError::IOError)?; serde_json::from_str(&config_str).map_err(|_| MescError::InvalidJson) } @@ -91,10 +94,13 @@ pub fn get_config_path() -> Result { } /// expand tilde's in path -pub fn expand_path(path: String) -> Result { - if let Some(subpath) = path.strip_prefix("~/") { +pub fn expand_path>(path: P) -> Result { + let path_str = + path.as_ref().to_str().ok_or(MescError::InvalidPath("Invalid path".to_string()))?; + + if let Some(subpath) = path_str.strip_prefix("~/") { Ok(format!("{}/{}", env::var("HOME")?, subpath)) } else { - Ok(path) + Ok(path_str.to_string()) } } diff --git a/rust/crates/mesc/src/metadata.rs b/rust/crates/mesc/src/metadata.rs index f58c86c..e4edbca 100644 --- a/rust/crates/mesc/src/metadata.rs +++ b/rust/crates/mesc/src/metadata.rs @@ -15,7 +15,7 @@ pub fn get_api_key>( if let Some(api_keys) = profile.profile_metadata.get("api_keys") { let api_keys: HashMap = get_value_at(api_keys, &[])?; if let Some(key) = api_keys.get(key_name) { - return Ok(Some(key.clone())) + return Ok(Some(key.clone())); } } } @@ -24,7 +24,7 @@ pub fn get_api_key>( if let Some(api_keys) = config.global_metadata.get("api_keys") { let api_keys: HashMap = get_value_at(api_keys, &[])?; if let Some(key) = api_keys.get(key_name) { - return Ok(Some(key.clone())) + return Ok(Some(key.clone())); } } diff --git a/rust/crates/mesc/src/network_names.rs b/rust/crates/mesc/src/network_names.rs index 288aa72..5c3442a 100644 --- a/rust/crates/mesc/src/network_names.rs +++ b/rust/crates/mesc/src/network_names.rs @@ -6,1204 +6,1856 @@ //! //! Do not edit this file manually. -use crate::{ChainId, TryIntoChainId}; -use std::collections::HashMap; +use crate::ChainId; +use std::{collections::HashMap, sync::OnceLock}; /// get default mapping between chain_id's and network names -pub fn get_network_names() -> HashMap { - [ - ("1", "ethereum"), - ("2", "expanse"), - ("3", "ropsten"), - ("4", "rinkeby"), - ("5", "goerli"), - ("6", "kotti_testnet"), - ("7", "thai"), - ("8", "ubiq"), - ("9", "ubiq_testnet"), - ("10", "optimism"), - ("11", "metadium"), - ("12", "metadium_testnet"), - ("13", "diode_testnet_staging"), - ("14", "flare"), - ("15", "diode_prenet"), - ("16", "flare_testnet_coston"), - ("17", "thaifi"), - ("18", "thundercore_testnet"), - ("19", "songbird_canary"), - ("20", "elastos"), - ("21", "elastos_testnet"), - ("22", "ela_did"), - ("23", "ela_did_testnet"), - ("24", "kardia"), - ("25", "cronos"), - ("26", "genesis_testnet"), - ("27", "shiba"), - ("28", "boba_rinkeby_testnet"), - ("29", "genesis"), - ("30", "rootstock"), - ("31", "rootstock_testnet"), - ("32", "gooddata_testnet"), - ("33", "gooddata"), - ("34", "secure"), - ("35", "tbwg"), - ("36", "dx"), - ("37", "xpla"), - ("38", "valorbit"), - ("39", "u2u_solaris"), - ("40", "telos_evm"), - ("41", "telos_evm_testnet"), - ("42", "lukso"), - ("43", "darwinia_pangolin_testnet"), - ("44", "crab"), - ("45", "darwinia_pangoro_testnet"), - ("46", "darwinia"), - ("47", "acria_intelli"), - ("48", "ennothem_proterozoic"), - ("49", "ennothem_testnet_pioneer"), - ("50", "xdc"), - ("51", "xdc_apothem"), - ("52", "coinex"), - ("53", "coinex_testnet"), - ("54", "openpiece"), - ("55", "zyx"), - ("56", "bnb"), - ("57", "syscoin"), - ("58", "ontology"), - ("59", "eos_evm_legacy"), - ("60", "go"), - ("61", "ethereum_classic"), - ("62", "morden_testnet"), - ("63", "mordor_testnet"), - ("64", "ellaism"), - ("65", "okex_testnet"), - ("66", "okx"), - ("67", "db_testnet"), - ("68", "soterone"), - ("69", "optimism_kovan"), - ("70", "hoo"), - ("71", "conflux_espace_testnet"), - ("72", "dx_testnet"), - ("73", "fncy"), - ("74", "id"), - ("75", "decimal"), - ("76", "mix"), - ("77", "poa_sokol"), - ("78", "primus"), - ("79", "zenith"), - ("80", "gene"), - ("81", "japan_open"), - ("82", "meter"), - ("83", "meter_testnet"), - ("84", "linqto_devnet"), - ("85", "gate_testnet"), - ("86", "gate"), - ("87", "nova"), - ("88", "tomo"), - ("89", "tomo_testnet"), - ("90", "garizon_stage0"), - ("91", "garizon_stage1"), - ("92", "garizon_stage2"), - ("93", "garizon_stage3"), - ("94", "swissdlt"), - ("95", "camdl"), - ("96", "bitkub"), - ("97", "bnb_testnet"), - ("98", "six_protocol"), - ("99", "poa_core"), - ("100", "gnosis"), - ("101", "etherinc"), - ("102", "web3games_testnet"), - ("103", "worldland"), - ("104", "kaiba_lightning_testnet"), - ("105", "web3games_devnet"), - ("106", "velas_evm"), - ("107", "nebula_testnet"), - ("108", "thundercore"), - ("109", "shibarium"), - ("110", "proton_testnet"), - ("111", "etherlite"), - ("112", "coinbit"), - ("113", "dehvo"), - ("114", "flare_testnet_coston2"), - ("116", "debank"), - ("117", "uptick"), - ("118", "arcology_testnet"), - ("119", "enuls"), - ("120", "enuls_testnet"), - ("121", "real"), - ("122", "fuse"), - ("123", "fuse_sparknet"), - ("124", "decentralized_web"), - ("125", "oy_testnet"), - ("126", "oy"), - ("127", "factory_127"), - ("128", "huobi_eco"), - ("131", "engram_testnet"), - ("134", "iexec"), - ("135", "alyx_testnet"), - ("136", "deam"), - ("137", "polygon"), - ("138", "defi_oracle_meta"), - ("139", "woop"), - ("141", "openpiece_testnet"), - ("142", "dax"), - ("144", "phi_v2"), - ("148", "shimmerevm"), - ("150", "six_protocol_testnet"), - ("151", "redbelly"), - ("152", "redbelly_devnet"), - ("153", "redbelly_testnet"), - ("154", "redbelly_tge"), - ("155", "tenet_testnet"), - ("156", "oeblock_testnet"), - ("160", "armonia_eva"), - ("161", "armonia_eva_testnet"), - ("162", "lightstreams_testnet"), - ("163", "lightstreams"), - ("165", "omni_testnet"), - ("167", "atoshi_testnet"), - ("168", "aioz"), - ("169", "manta_pacific"), - ("170", "hoo_testnet"), - ("172", "latam_block_resil_testnet"), - ("180", "ame"), - ("186", "seele"), - ("188", "bmc"), - ("189", "bmc_testnet"), - ("193", "crypto_emergency"), - ("195", "x1_testnet"), - ("196", "x1"), - ("197", "neutrinos_testnet"), - ("198", "bit"), - ("199", "bittorrent"), - ("200", "arbitrum_on_xdai"), - ("201", "moac_testnet"), - ("204", "opbnb"), - ("206", "vinu_testnet"), - ("207", "vinu"), - ("208", "structx"), - ("210", "bitnet"), - ("211", "freight_trust"), - ("212", "map_makalu"), - ("214", "shinarium"), - ("217", "siriusnet_v2"), - ("218", "soterone_old"), - ("220", "scalind_testnet"), - ("222", "permission"), - ("225", "la"), - ("226", "la_testnet"), - ("230", "swapdex"), - ("236", "deam_testnet"), - ("238", "blast"), - ("242", "plinga"), - ("246", "energy_web"), - ("248", "oasys"), - ("250", "fantom_opera"), - ("252", "frax"), - ("255", "kroma"), - ("256", "huobi_eco_testnet"), - ("258", "setheum"), - ("259", "neonlink"), - ("262", "sur_block"), - ("269", "high_performance_block"), - ("271", "egoncoin"), - ("288", "boba"), - ("291", "orderly"), - ("295", "hedera"), - ("296", "hedera_testnet"), - ("297", "hedera_previewnet"), - ("298", "hedera_localnet"), - ("300", "zksync_sepolia_testnet"), - ("301", "bobaopera"), - ("303", "neuro_testnet"), - ("309", "wyzth_testnet"), - ("311", "omax"), - ("313", "neuro"), - ("314", "filecoin"), - ("321", "kcc"), - ("322", "kcc_testnet"), - ("324", "zksync"), - ("333", "web3q"), - ("335", "dfk_test"), - ("336", "shiden"), - ("338", "cronos_testnet"), - ("361", "theta"), - ("363", "theta_sapphire_testnet"), - ("364", "theta_amber_testnet"), - ("365", "theta_testnet"), - ("369", "pulse"), - ("371", "consta_testnet"), - ("385", "lisinski"), - ("399", "nativ3"), - ("400", "hyperon_testnet"), - ("401", "ozone_testnet"), - ("411", "pepe"), - ("416", "sx"), - ("418", "latestnet"), - ("420", "optimism_goerli_testnet"), - ("424", "pgn_public_goods"), - ("427", "zeeth"), - ("428", "geso_verse"), - ("443", "ten_testnet"), - ("444", "synapse_testnet"), - ("456", "arzio"), - ("462", "areon_testnet"), - ("463", "areon"), - ("499", "rupaya"), - ("500", "camino_c"), - ("501", "columbus_test"), - ("512", "double_a"), - ("513", "double_a_testnet"), - ("516", "gear_zero"), - ("520", "xt"), - ("529", "fire"), - ("530", "fxcore"), - ("534", "candle"), - ("542", "paw_testnet"), - ("555", "vela1"), - ("558", "tao"), - ("568", "doge_testnet"), - ("570", "rollux"), - ("588", "metis_stardust_testnet"), - ("592", "astar"), - ("595", "acala_mandala_testnet_tc9"), - ("596", "karura_testnet"), - ("597", "acala_testnet"), - ("599", "metis_goerli_testnet"), - ("600", "meshnyan_testnet"), - ("601", "vine_testnet"), - ("614", "graphlinq_block"), - ("634", "avocado"), - ("647", "sx_testnet"), - ("648", "endurance"), - ("653", "kali"), - ("666", "pixie_testnet"), - ("667", "laos_arrakis"), - ("668", "junca"), - ("669", "junca_testnet"), - ("686", "karura"), - ("700", "star_social_testnet"), - ("707", "block_station"), - ("708", "block_station_testnet"), - ("710", "highbury"), - ("719", "shibarium_beta"), - ("721", "lycan"), - ("727", "blucrates"), - ("740", "canto_testnet"), - ("741", "vention_testnet"), - ("742", "script_testnet"), - ("766", "ql1"), - ("776", "open_testnet"), - ("777", "cheapeth"), - ("786", "maal"), - ("787", "acala"), - ("788", "aero_testnet"), - ("789", "patex"), - ("800", "lucid_block"), - ("803", "haic"), - ("808", "portal_fantasy_test"), - ("813", "qitmeer"), - ("814", "fire_zkevm"), - ("818", "beone"), - ("820", "callisto"), - ("841", "taraxa"), - ("842", "taraxa_testnet"), - ("859", "zeeth_dev"), - ("868", "fantasia"), - ("876", "bandai_namco_research_verse"), - ("877", "dexit"), - ("880", "ambros"), - ("888", "wan"), - ("900", "garizon_testnet_stage0"), - ("901", "garizon_testnet_stage1"), - ("902", "garizon_testnet_stage2"), - ("903", "garizon_testnet_stage3"), - ("909", "portal_fantasy"), - ("910", "decentrabone_layer1_testnet"), - ("917", "rinia_testnet"), - ("919", "mode_testnet"), - ("927", "yidark"), - ("940", "pulse_testnet"), - ("941", "pulse_testnet_v2b"), - ("942", "pulse_testnet_v3"), - ("943", "pulse_testnet_v4"), - ("956", "munode_testnet"), - ("957", "lyra"), - ("963", "btc20"), - ("970", "oort"), - ("971", "oort_huygens"), - ("972", "oort_ascraeus"), - ("977", "nepal_block"), - ("980", "top_evm"), - ("985", "memo"), - ("989", "top"), - ("990", "eliberty"), - ("997", "5ire_thunder"), - ("998", "lucky"), - ("999", "wan_testnet"), - ("1000", "gton"), - ("1001", "klaytn_testnet_baobab"), - ("1003", "tectum_emission_token"), - ("1004", "t_ekta"), - ("1007", "newton_testnet"), - ("1008", "eurus"), - ("1010", "evrice"), - ("1012", "newton"), - ("1022", "sakura"), - ("1023", "clover_testnet"), - ("1024", "clv_para"), - ("1028", "bittorrent_testnet"), - ("1030", "conflux_espace"), - ("1031", "proxy_testnet"), - ("1038", "bronos_testnet"), - ("1039", "bronos"), - ("1073", "shimmerevm_testnet"), - ("1079", "mintara_testnet"), - ("1080", "mintara"), - ("1088", "metis_andromeda"), - ("1089", "humans.ai"), - ("1099", "moac"), - ("1101", "polygon_zkevm"), - ("1107", "blxq_testnet"), - ("1108", "blxq"), - ("1111", "wemix"), - ("1112", "wemix_testnet"), - ("1115", "core_block_testnet"), - ("1116", "core_block"), - ("1117", "dogcoin"), - ("1130", "defi_evm"), - ("1131", "defi_evm_testnet"), - ("1133", "defimeta_changi_testnet"), - ("1138", "amstar_testnet"), - ("1139", "math"), - ("1140", "math_testnet"), - ("1149", "symplexia"), - ("1170", "origin_testnet"), - ("1177", "smart_host_teknoloji_testnet"), - ("1197", "iora"), - ("1201", "evanesco_testnet"), - ("1202", "world_trade_technical"), - ("1213", "popcateum"), - ("1214", "enter"), - ("1229", "exzo"), - ("1230", "ultron_testnet"), - ("1231", "ultron"), - ("1234", "step"), - ("1243", "arc"), - ("1244", "arc_testnet"), - ("1246", "om_platform"), - ("1248", "dogether"), - ("1252", "cic_testnet"), - ("1280", "halo"), - ("1284", "moonbeam"), - ("1285", "moonriver"), - ("1286", "moonrock_old"), - ("1287", "moonbase_alpha"), - ("1288", "moonrock"), - ("1291", "swisstronik_testnet"), - ("1294", "bobabeam"), - ("1297", "bobabase_testnet"), - ("1311", "dos_fuji_subnet"), - ("1314", "alyx"), - ("1319", "aia"), - ("1320", "aia_testnet"), - ("1337", "geth_testnet"), - ("1338", "elysium_testnet"), - ("1339", "elysium"), - ("1343", "blitz_subnet"), - ("1353", "cic"), - ("1369", "zafirium"), - ("1379", "kalar"), - ("1388", "amstar"), - ("1392", "joseon"), - ("1402", "polygon_zkevm_testnet_old"), - ("1422", "polygon_zkevm_testnet_pre_audit_upgraded"), - ("1433", "rikeza"), - ("1440", "living_assets"), - ("1442", "polygon_zkevm_testnet"), - ("1452", "gil_testnet"), - ("1455", "ctex_scan_block"), - ("1501", "bevm"), - ("1506", "sherpax"), - ("1507", "sherpax_testnet"), - ("1515", "beagle_messaging"), - ("1559", "tenet"), - ("1618", "catecoin"), - ("1620", "atheios"), - ("1657", "bta"), - ("1662", "liqui"), - ("1663", "horizen_gobi_testnet"), - ("1688", "ludan"), - ("1701", "anytype_evm"), - ("1707", "tbsi"), - ("1708", "tbsi_testnet"), - ("1718", "palette"), - ("1773", "party"), - ("1777", "gauss"), - ("1804", "kerleano"), - ("1807", "rabbit_analog_testnet"), - ("1818", "cube"), - ("1819", "cube_testnet"), - ("1821", "ruby"), - ("1856", "teslafunds"), - ("1875", "whitebit"), - ("1881", "gitshock_cartenz_testnet"), - ("1890", "lightlink_phoenix"), - ("1891", "lightlink_pegasus_testnet"), - ("1898", "bon"), - ("1904", "sports"), - ("1907", "bitci"), - ("1908", "bitci_testnet"), - ("1909", "merkle_scan"), - ("1911", "scalind"), - ("1912", "ruby_testnet"), - ("1945", "onus_testnet"), - ("1951", "d"), - ("1954", "dexilla_testnet"), - ("1967", "eleanor"), - ("1969", "super_testnet"), - ("1970", "super"), - ("1971", "atelier"), - ("1972", "redecoin"), - ("1975", "onus"), - ("1984", "eurus_testnet"), - ("1985", "satoshie"), - ("1986", "satoshie_testnet"), - ("1987", "ethergem"), - ("1994", "ekta"), - ("1995", "edexa_testnet"), - ("1998", "kyoto_testnet"), - ("2000", "doge"), - ("2001", "milkomeda_c1"), - ("2002", "milkomeda_a1"), - ("2008", "cloudwalk_testnet"), - ("2009", "cloudwalk"), - ("2016", "mainnetz"), - ("2018", "publicmint_devnet"), - ("2019", "publicmint_testnet"), - ("2020", "publicmint"), - ("2021", "edgeware_edgeevm"), - ("2022", "beresheet_bereevm_testnet"), - ("2023", "taycan_testnet"), - ("2025", "rangers_protocol"), - ("2031", "centrifuge"), - ("2032", "catalyst"), - ("2035", "phala"), - ("2037", "kiwi_subnet"), - ("2038", "shrapnel_testnet"), - ("2043", "origintrail_para"), - ("2044", "shrapnel_subnet"), - ("2047", "stratos_testnet"), - ("2048", "stratos"), - ("2049", "movo"), - ("2077", "quokkacoin"), - ("2088", "altair"), - ("2089", "algol"), - ("2100", "ecoball"), - ("2101", "ecoball_testnet_espuma"), - ("2109", "exosama"), - ("2122", "metaplayerone"), - ("2124", "metaplayerone_dubai_testnet"), - ("2137", "bigshortbets"), - ("2138", "defi_oracle_meta_testnet"), - ("2151", "bosagora"), - ("2152", "findora"), - ("2153", "findora_testnet"), - ("2154", "findora_forge"), - ("2199", "moonsama"), - ("2202", "antofy"), - ("2203", "bitcoin_evm"), - ("2213", "evanesco"), - ("2221", "kava_testnet"), - ("2222", "kava"), - ("2223", "v"), - ("2241", "krest"), - ("2300", "bomb"), - ("2306", "ebro"), - ("2309", "arevia"), - ("2323", "soma_testnet"), - ("2330", "altcoin"), - ("2332", "soma"), - ("2358", "kroma_sepolia"), - ("2399", "bomb_testnet"), - ("2400", "tcg_verse"), - ("2415", "xodex"), - ("2458", "hybrid_testnet"), - ("2468", "hybrid"), - ("2484", "unicorn_ultra_nebulas_testnet"), - ("2522", "frax_testnet"), - ("2559", "kortho"), - ("2569", "techpay"), - ("2606", "pocrnet"), - ("2611", "redlight"), - ("2612", "ez_c"), - ("2613", "ez_c_testnet"), - ("2625", "whitebit_testnet"), - ("2710", "morph_testnet"), - ("2718", "k_laos"), - ("2888", "boba_goerli_testnet"), - ("2999", "bityuan"), - ("3000", "cennznet_rata"), - ("3001", "cennznet_nikau"), - ("3003", "canxium"), - ("3011", "playa3ull_games"), - ("3031", "orlando"), - ("3068", "bifrost"), - ("3100", "immu3_evm"), - ("3102", "vulture_evm_beta"), - ("3141", "filecoin___hyperspace_testnet"), - ("3269", "dubxcoin"), - ("3270", "dubxcoin_testnet"), - ("3306", "debounce_subnet_testnet"), - ("3331", "zcore_testnet"), - ("3333", "web3q_testnet"), - ("3334", "web3q_galileo"), - ("3400", "paribu_net"), - ("3434", "secure_testnet"), - ("3500", "paribu_net_testnet"), - ("3501", "jfin"), - ("3601", "pandoproject"), - ("3602", "pandoproject_testnet"), - ("3636", "botanix_testnet"), - ("3637", "botanix"), - ("3639", "i"), - ("3666", "jouleverse"), - ("3690", "bittex"), - ("3693", "empire"), - ("3698", "senjepowers_testnet"), - ("3699", "senjepowers"), - ("3701", "xpla_testnet"), - ("3737", "crossbell"), - ("3797", "alvey"), - ("3885", "fire_zkevm_ghostrider"), - ("3888", "kaly"), - ("3889", "kaly_testnet"), - ("3912", "drac"), - ("3939", "dos_tesnet"), - ("3966", "dyno"), - ("3967", "dyno_testnet"), - ("3999", "yuan"), - ("4000", "ozone"), - ("4001", "peperium_testnet"), - ("4002", "fantom_testnet"), - ("4003", "x1_fastnet"), - ("4051", "bobaopera_testnet"), - ("4061", "nahmii_3"), - ("4062", "nahmii_3_testnet"), - ("4078", "muster"), - ("4090", "fastex_bahamut_oasis_testnet"), - ("4096", "bitindi_testnet"), - ("4099", "bitindi"), - ("4102", "aioz_testnet"), - ("4139", "humans.ai_testnet"), - ("4141", "tipboxcoin_testnet"), - ("4181", "phi_v1"), - ("4201", "lukso_testnet"), - ("4242", "nexi"), - ("4328", "bobafuji_testnet"), - ("4337", "beam"), - ("4400", "credit"), - ("4444", "htmlcoin"), - ("4460", "orderly_sepolia_testnet"), - ("4689", "iotex"), - ("4690", "iotex_testnet"), - ("4759", "meverse_testnet"), - ("4777", "blackfort_exchange_testnet"), - ("4893", "globel"), - ("4918", "venidium_testnet"), - ("4919", "venidium"), - ("4999", "blackfort_exchange"), - ("5000", "mantle"), - ("5001", "mantle_testnet"), - ("5002", "treasurenet_alpha"), - ("5003", "mantle_sepolia_testnet"), - ("5005", "treasurenet_testnet"), - ("5165", "bahamut"), - ("5169", "smart_layer"), - ("5177", "tl"), - ("5197", "eraswap"), - ("5234", "humanode"), - ("5290", "fire_old"), - ("5315", "uzmi"), - ("5353", "tritanium_testnet"), - ("5522", "vex_evm_testnet"), - ("5551", "nahmii"), - ("5553", "nahmii_testnet"), - ("5555", "verse"), - ("5611", "opbnb_testnet"), - ("5616", "arcturus_testnet"), - ("5678", "tanssi_evm_container"), - ("5700", "syscoin_tanenbaum_testnet"), - ("5729", "hika_testnet"), - ("5758", "satoshi_testnet"), - ("5777", "ganache"), - ("5851", "ontology_testnet"), - ("5869", "wego_rubidium"), - ("6065", "tres_testnet"), - ("6066", "tres"), - ("6102", "cascadia_testnet"), - ("6118", "uptn_testnet"), - ("6119", "uptn"), - ("6363", "digit_soul"), - ("6502", "peerpay"), - ("6552", "scolcoin_wei_testnet"), - ("6565", "fox_testnet"), - ("6626", "pixie"), - ("6660", "latest_testnet"), - ("6661", "cybria"), - ("6666", "cybria_testnet"), - ("6688", "irishub"), - ("6779", "compverse"), - ("6789", "gold"), - ("6969", "tomb"), - ("6999", "polysmart"), - ("7000", "zeta"), - ("7001", "zeta_athens_3_testnet"), - ("7027", "ella_the_heart"), - ("7070", "planq"), - ("7100", "nume"), - ("7118", "help_the_homeless"), - ("7171", "bitrock"), - ("7331", "klyntar"), - ("7332", "horizen_eon"), - ("7341", "shyft"), - ("7484", "raba"), - ("7518", "meverse"), - ("7575", "adil_testnet"), - ("7576", "adil_v2"), - ("7668", "the_root"), - ("7672", "the_root___porcini_testnet"), - ("7700", "canto"), - ("7701", "canto_tesnet"), - ("7771", "bitrock_testnet"), - ("7777", "rise_of_the_warbots_testnet"), - ("7860", "maal_testnet"), - ("7878", "hazlor_testnet"), - ("7895", "ardenium_athena"), - ("7979", "dos"), - ("8000", "teleport"), - ("8001", "teleport_testnet"), - ("8029", "mdgl_testnet"), - ("8080", "shardeum_liberty_1.x"), - ("8081", "shardeum_liberty_2.x"), - ("8082", "shardeum_sphinx_1.x"), - ("8086", "bitcoin"), - ("8087", "e_dollar"), - ("8098", "streamux_block"), - ("8131", "qitmeer_testnet"), - ("8132", "qitmeer_mixnet"), - ("8133", "qitmeer_privnet"), - ("8134", "amana"), - ("8135", "flana"), - ("8136", "mizana"), - ("8181", "testnet_beone"), - ("8192", "torus"), - ("8194", "torus_testnet"), - ("8217", "klaytn_cypress"), - ("8272", "blockton_block"), - ("8285", "korthotest"), - ("8387", "dracones_financial_services"), - ("8453", "base"), - ("8654", "toki"), - ("8655", "toki_testnet"), - ("8668", "hela_official_runtime"), - ("8723", "tool_global"), - ("8724", "tool_global_testnet"), - ("8726", "storage"), - ("8727", "storage_testnet"), - ("8738", "alph"), - ("8768", "tmy"), - ("8848", "maro_block"), - ("8880", "unique"), - ("8881", "quartz_by_unique"), - ("8882", "opal_testnet_by_unique"), - ("8883", "sapphire_by_unique"), - ("8888", "xana"), - ("8889", "vyvo"), - ("8898", "mammoth"), - ("8899", "jib"), - ("8989", "giant_mammoth"), - ("8995", "bloxberg"), - ("9000", "evmos_testnet"), - ("9001", "evmos"), - ("9012", "berylbit"), - ("9100", "genesis_coin"), - ("9170", "rinia_testnet_old"), - ("9223", "codefin"), - ("9339", "dogcoin_testnet"), - ("9527", "rangers_protocol_testnet_robin"), - ("9528", "qeasyweb3_testnet"), - ("9559", "neonlink_testnet"), - ("9700", "oortdev"), - ("9728", "boba_bnb_testnet"), - ("9768", "mainnetz_testnet"), - ("9779", "pepenetwork"), - ("9790", "carbon_evm"), - ("9792", "carbon_evm_testnet"), - ("9818", "imperium_testnet"), - ("9819", "imperium"), - ("9888", "dogelayer"), - ("9977", "mind_testnet"), - ("9980", "combo"), - ("9990", "agung"), - ("9996", "mind"), - ("9997", "altlayer_testnet"), - ("9999", "myown_testnet"), - ("10000", "smart_bitcoin_cash"), - ("10001", "smart_bitcoin_cash_testnet"), - ("10024", "gon"), - ("10081", "japan_open_testnet"), - ("10086", "sjatsh"), - ("10101", "block_genesis"), - ("10200", "gnosis_chiado_testnet"), - ("10201", "maxx"), - ("10242", "arthera"), - ("10243", "arthera_testnet"), - ("10248", "0xtade"), - ("10395", "worldland_testnet"), - ("10507", "numbers"), - ("10508", "numbers_testnet"), - ("10823", "cryptocoinpay"), - ("10946", "quadrans_block"), - ("10947", "quadrans_block_testnet"), - ("11110", "astra"), - ("11111", "wagmi"), - ("11115", "astra_testnet"), - ("11119", "hashbit"), - ("11235", "haqq"), - ("11437", "shyft_testnet"), - ("11612", "sardis_testnet"), - ("11888", "sanr"), - ("11891", "polygon_supernet_arianee"), - ("12009", "satoshi"), - ("12051", "singularity_zero_testnet"), - ("12052", "singularity_zero"), - ("12123", "brc"), - ("12306", "fibonacci"), - ("12321", "blg_testnet"), - ("12345", "step_testnet"), - ("12611", "astar_zkevm"), - ("12715", "rikeza_testnet"), - ("12890", "quantum_testnet"), - ("13000", "sps"), - ("13337", "beam_testnet"), - ("13371", "immutable_zkevm"), - ("13381", "phoenix"), - ("13473", "immutable_zkevm_testnet"), - ("13812", "susono"), - ("14000", "sps_testnet"), - ("14853", "humanode_testnet_5_israfel"), - ("15003", "immutable_zkevm_devnet"), - ("15551", "loopnetwork"), - ("15555", "trust_evm_testnet"), - ("15557", "eos_evm_testnet"), - ("16000", "metadot"), - ("16001", "metadot_testnet"), - ("16507", "genesys"), - ("16688", "irishub_testnet"), - ("16718", "airdao"), - ("16888", "ivar_testnet"), - ("17000", "holesky"), - ("17001", "redstone_holesky_testnet"), - ("17171", "g8"), - ("17180", "palette_testnet"), - ("17777", "eos_evm"), - ("18000", "frontier_of_dreams_testnet"), - ("18122", "smart_trades"), - ("18159", "proof_of_memes"), - ("18181", "g8_testnet"), - ("18686", "mxc_zkevm"), - ("19011", "home_verse"), - ("19845", "btcix"), - ("20001", "camelark"), - ("20729", "callisto_testnet"), - ("20736", "p12"), - ("21337", "cennznet_azalea"), - ("21816", "om"), - ("21912", "bsl"), - ("22023", "taycan"), - ("22040", "airdao_testnet"), - ("22222", "nautilus"), - ("22324", "goldx_testnet"), - ("22776", "map"), - ("23006", "antofy_testnet"), - ("23118", "opside_testnet"), - ("23294", "oasis_sapphire"), - ("23295", "oasis_sapphire_testnet"), - ("23888", "blast_testnet"), - ("24484", "web"), - ("24734", "mintme.com"), - ("25888", "hammer"), - ("25925", "bitkub_testnet"), - ("26026", "ferrum_testnet"), - ("26600", "hertz"), - ("26863", "oasis"), - ("28528", "optimism_bedrock_goerli_alpha_testnet"), - ("29548", "mch_verse"), - ("30067", "piece_testnet"), - ("30103", "cerium_testnet"), - ("31102", "ethersocial"), - ("31223", "cloudtx"), - ("31224", "cloudtx_testnet"), - ("31337", "go_testnet"), - ("31415", "filecoin___wallaby_testnet"), - ("32520", "bitgert"), - ("32659", "fusion"), - ("32769", "zilliqa_evm"), - ("32990", "zilliqa_evm_isolated_server"), - ("33101", "zilliqa_evm_testnet"), - ("33210", "cloudverse_subnet"), - ("33333", "aves"), - ("33385", "zilliqa_evm_devnet"), - ("33469", "zilliqa_2_evm_devnet"), - ("34443", "mode"), - ("35011", "j2o_taro"), - ("35441", "q"), - ("35443", "q_testnet"), - ("38400", "connectormanager"), - ("38401", "connectormanager_robin"), - ("39797", "energi"), - ("39815", "oho"), - ("41500", "opulent_x_beta"), - ("42069", "pegglecoin"), - ("42161", "arbitrum_one"), - ("42170", "arbitrum_nova"), - ("42220", "celo"), - ("42261", "oasis_emerald_testnet"), - ("42262", "oasis_emerald"), - ("42355", "goldx"), - ("42766", "zkfair"), - ("42801", "gesoten_verse_testnet"), - ("42888", "kinto_testnet"), - ("43110", "athereum"), - ("43113", "avalanche_fuji_testnet"), - ("43114", "avalanche_c"), - ("43288", "boba_avax"), - ("43851", "zkfair_testnet"), - ("44444", "fren"), - ("44787", "celo_alfajores_testnet"), - ("45000", "autobahn"), - ("46688", "fusion_testnet"), - ("47805", "rei"), - ("49049", "wireshape_floripa_testnet"), - ("49088", "bifrost_testnet"), - ("49797", "energi_testnet"), - ("50001", "liveplex_oracleevm"), - ("50005", "yooldo_verse"), - ("50006", "yooldo_verse_testnet"), - ("50021", "gton_testnet"), - ("51178", "lumoz_testnet_alpha"), - ("51712", "sardis"), - ("52014", "electroneum"), - ("53935", "dfk"), - ("54211", "haqq_testnet"), - ("54321", "toronet_testnet"), - ("55004", "titan"), - ("55556", "rei_testnet"), - ("56288", "boba_bnb"), - ("56789", "velo_labs"), - ("57000", "rollux_testnet"), - ("58008", "sepolia_pgn_public_goods"), - ("59140", "linea_testnet"), - ("59144", "linea"), - ("59971", "genesys_code"), - ("60000", "thinkium_testnet_0"), - ("60001", "thinkium_testnet_1"), - ("60002", "thinkium_testnet_2"), - ("60103", "thinkium_testnet_103"), - ("61800", "axel_dev_net"), - ("61803", "etica"), - ("61916", "doken_super"), - ("62320", "celo_baklava_testnet"), - ("62621", "multivac"), - ("63000", "ecredits"), - ("63001", "ecredits_testnet"), - ("65450", "scolcoin"), - ("66988", "janus_testnet"), - ("67390", "siriusnet"), - ("67588", "cosmic"), - ("68770", "dm2_verse"), - ("69420", "condrieu"), - ("70000", "thinkium_0"), - ("70001", "thinkium_1"), - ("70002", "thinkium_2"), - ("70103", "thinkium_103"), - ("71111", "guapcoinx"), - ("71393", "polyjuice_testnet"), - ("71401", "godwoken_testnet_v1"), - ("71402", "godwoken"), - ("72992", "grok"), - ("73799", "energy_web_volta_testnet"), - ("73927", "mixin_virtual_machine"), - ("75000", "resincoin"), - ("77238", "foundry_testnet"), - ("77612", "vention"), - ("77777", "toronet"), - ("78110", "firenze_test"), - ("78281", "dragonfly_hexapod"), - ("78430", "amplify_subnet"), - ("78431", "bulletin_subnet"), - ("78432", "conduit_subnet"), - ("79879", "gold_testnet"), - ("80001", "mumbai"), - ("81041", "nordek"), - ("81341", "amana_testnet"), - ("81342", "amana_mixnet"), - ("81343", "amana_privnet"), - ("81351", "flana_testnet"), - ("81352", "flana_mixnet"), - ("81353", "flana_privnet"), - ("81361", "mizana_testnet"), - ("81362", "mizana_mixnet"), - ("81363", "mizana_privnet"), - ("81720", "quantum"), - ("82459", "smart_layer_testnet"), - ("84531", "base_goerli_testnet"), - ("84532", "base_sepolia_testnet"), - ("84886", "aerie"), - ("85449", "cybertrust"), - ("88002", "nautilus_proteus_testnet"), - ("88880", "chiliz_scoville_testnet"), - ("88888", "ivar"), - ("90210", "beverly_hills"), - ("91002", "nautilus_trition"), - ("91715", "combo_testnet"), - ("92001", "lambda_testnet"), - ("96970", "mantis_testnet_hexapod"), - ("97288", "boba_bnb_old"), - ("99099", "eliberty_testnet"), - ("99998", "ubtestnet"), - ("99999", "ub"), - ("100000", "quark_root"), - ("100001", "quark_shard_0"), - ("100002", "quark_shard_1"), - ("100003", "quark_shard_2"), - ("100004", "quark_shard_3"), - ("100005", "quark_shard_4"), - ("100006", "quark_shard_5"), - ("100007", "quark_shard_6"), - ("100008", "quark_shard_7"), - ("100009", "ve"), - ("100010", "ve_testnet"), - ("101010", "soverun_testnet"), - ("103090", "crystaleum"), - ("108801", "bro"), - ("110000", "quark_devnet_root"), - ("110001", "quark_devnet_shard_0"), - ("110002", "quark_devnet_shard_1"), - ("110003", "quark_devnet_shard_2"), - ("110004", "quark_devnet_shard_3"), - ("110005", "quark_devnet_shard_4"), - ("110006", "quark_devnet_shard_5"), - ("110007", "quark_devnet_shard_6"), - ("110008", "quark_devnet_shard_7"), - ("111000", "siberium_test"), - ("111111", "siberium"), - ("112358", "meta_one"), - ("123456", "adil_devnet"), - ("131419", "etnds"), - ("142857", "icplaza"), - ("167004", "taiko_alpha_2_testnet"), - ("167005", "taiko_grimsvotn_l2"), - ("167006", "taiko_eldfell_l3"), - ("167007", "taiko_jolnir_l2"), - ("188710", "bitica"), - ("188881", "condor_test"), - ("200101", "milkomeda_c1_testnet"), - ("200202", "milkomeda_a1_testnet"), - ("200625", "akroma"), - ("201018", "alaya"), - ("201030", "alaya_dev_testnet"), - ("201804", "mythical"), - ("202020", "decimal_testnet"), - ("202212", "x1_devnet"), - ("202624", "jellie"), - ("204005", "x1_network"), - ("210425", "platon"), - ("220315", "mas"), - ("221230", "reap"), - ("221231", "reap_testnet"), - ("224168", "taf_eco"), - ("224422", "conet_sebolia_testnet"), - ("224433", "conet_holesky"), - ("230315", "hashkey_testnet"), - ("234666", "haymo_testnet"), - ("246529", "artis_sigma1"), - ("246785", "artis_testnet_tau1"), - ("247253", "saakuru_testnet"), - ("256256", "cmp"), - ("266256", "gear_zero_testnet"), - ("271271", "egoncoin_testnet"), - ("281121", "social"), - ("314159", "filecoin___calibration_testnet"), - ("330844", "ttcoin"), - ("333331", "aves_testnet"), - ("333333", "nativ3_testnet"), - ("333666", "oone_testnet"), - ("333777", "oone_devnet"), - ("333888", "polis_testnet"), - ("333999", "polis"), - ("355113", "bitfinity_testnet"), - ("363636", "digit_soul_2"), - ("373737", "hap_testnet"), - ("381931", "metal_c"), - ("381932", "metal_tahoe_c"), - ("404040", "tipboxcoin"), - ("420420", "kek"), - ("420666", "kek_kektest"), - ("420692", "alterium_l2_testnet"), - ("421611", "arbitrum_rinkeby"), - ("421613", "arbitrum_goerli"), - ("421614", "arbitrum_sepolia"), - ("424242", "fastex_testnet"), - ("431140", "markr_go"), - ("432201", "dexalot_subnet_testnet"), - ("432204", "dexalot_subnet"), - ("444900", "weelink_testnet"), - ("471100", "patex_sepolia_testnet"), - ("473861", "ultra_pro"), - ("474142", "open"), - ("512512", "cmp_testnet"), - ("513100", "ethereum_fair"), - ("534351", "scroll_sepolia_testnet"), - ("534352", "scroll"), - ("534353", "scroll_alpha_testnet"), - ("534354", "scroll_pre_alpha_testnet"), - ("534849", "shinarium_beta"), - ("535037", "beaneco_smart"), - ("622277", "hypra"), - ("641230", "bear"), - ("651940", "all"), - ("666666", "vision___vpioneer_test"), - ("666888", "hela_official_runtime_testnet"), - ("751230", "bear_testnet"), - ("761412", "miexs_smart"), - ("776877", "modularium"), - ("800001", "octaspace"), - ("827431", "curve"), - ("846000", "4goodnetwork"), - ("855456", "dodao"), - ("888888", "vision"), - ("900000", "posi_shard_0"), - ("910000", "posi_testnet_shard_0"), - ("912559", "astria_evm_dusknet"), - ("920000", "posi_devnet_shard_0"), - ("920001", "posi_devnet_shard_1"), - ("923018", "fncy_testnet"), - ("955305", "eluvio_content_fabric"), - ("988207", "ecrox"), - ("1127469", "tiltyard_subnet"), - ("1261120", "zkatana"), - ("1313114", "etho_protocol"), - ("1313500", "xerom"), - ("1337702", "kintsugi"), - ("1337802", "kiln"), - ("1337803", "zhejiang"), - ("2021398", "debank_testnet"), - ("2099156", "plian_main"), - ("2206132", "platon_dev_testnet2"), - ("2611555", "dpu"), - ("3141592", "filecoin___butterfly_testnet"), - ("3441005", "manta_pacific_testnet"), - ("4000003", "altlayer_zero_gas"), - ("4281033", "worlds_caldera"), - ("5167003", "mxc_wannsee_zkevm_testnet"), - ("5201420", "electroneum_testnet"), - ("5555555", "imversed"), - ("5555558", "imversed_testnet"), - ("7225878", "saakuru"), - ("7355310", "openvessel"), - ("7668378", "ql1_testnet"), - ("7762959", "musicoin"), - ("7777777", "zora"), - ("8007736", "plian_sub_1"), - ("8080808", "hokum"), - ("8794598", "hap"), - ("8888881", "quarix_testnet"), - ("8888888", "quarix"), - ("9322252", "xcap"), - ("9322253", "milvine"), - ("10067275", "plian_testnet_sub_1"), - ("10101010", "soverun"), - ("11155111", "sepolia"), - ("11155420", "op_sepolia_testnet"), - ("13371337", "pep_churchill"), - ("14288640", "andus"), - ("16658437", "plian_testnet_main"), - ("18289463", "iolite"), - ("20180430", "smartmesh"), - ("20181205", "quarkblock"), - ("20201022", "pego"), - ("20482050", "hokum_testnet"), - ("22052002", "excelon"), - ("27082017", "excoincial_volta_testnet"), - ("27082022", "excoincial"), - ("28945486", "auxilium"), - ("29032022", "fla"), - ("31415926", "filecoin___local_testnet"), - ("35855456", "joys_digital"), - ("43214913", "maistestsubnet"), - ("61717561", "aqua"), - ("65010000", "autonity_bakerloo_thames_testnet"), - ("65010001", "autonity_bakerloo_barada_testnet"), - ("65100000", "autonity_piccadilly_thames_testnet"), - ("65100001", "autonity_piccadilly_barada_testnet"), - ("68840142", "frame_testnet"), - ("88888888", "t.e.a.m_block"), - ("99415706", "joys_digital_testnet"), - ("192837465", "gather"), - ("222000222", "kanazawa"), - ("245022926", "neon_evm_devnet"), - ("245022934", "neon_evm"), - ("245022940", "neon_evm_testnet"), - ("278611351", "razor_skale"), - ("311752642", "oneledger"), - ("333000333", "meld"), - ("344106930", "skale_calypso_hub_testnet"), - ("356256156", "gather_testnet"), - ("476158412", "skale_europa_hub_testnet"), - ("486217935", "gather_devnet"), - ("503129905", "skale_nebula_hub_testnet"), - ("999999999", "zora_sepolia_testnet"), - ("1122334455", "ipos"), - ("1146703430", "cyberdecknet"), - ("1273227453", "human_protocol"), - ("1313161554", "aurora"), - ("1313161555", "aurora_testnet"), - ("1313161556", "aurora_betanet"), - ("1350216234", "skale_titan_hub"), - ("1351057110", "chaos_skale_testnet"), - ("1380996178", "raptor"), - ("1482601649", "skale_nebula_hub"), - ("1517929550", "skale_titan_hub_testnet"), - ("1564830818", "skale_calypso_hub"), - ("1666600000", "harmony_shard_0"), - ("1666600001", "harmony_shard_1"), - ("1666600002", "harmony_shard_2"), - ("1666600003", "harmony_shard_3"), - ("1666700000", "harmony_testnet_shard_0"), - ("1666700001", "harmony_testnet_shard_1"), - ("1666900000", "harmony_devnet_shard_0"), - ("1666900001", "harmony_devnet_shard_1"), - ("2021121117", "datahopper"), - ("2046399126", "skale_europa_hub"), - ("2863311531", "ancient8_testnet"), - ("3125659152", "pirl"), - ("4216137055", "oneledger_testnet_frankenstein"), - ("11297108099", "palm_testnet"), - ("11297108109", "palm"), - ("111222333444", "alphabet"), - ("197710212030", "ntity"), - ("197710212031", "haradev_testnet"), - ("383414847825", "zeniq"), - ("666301171999", "pdc"), - ("6022140761023", "molereum"), - ] - .into_iter() - .filter_map(|(chain_id, name)| match chain_id.try_into_chain_id() { - Ok(chain_id) => Some((chain_id, name.to_string())), - Err(_) => None, - }) - .collect() +pub fn get_network_names() -> &'static HashMap { + static CACHE: OnceLock> = OnceLock::new(); + CACHE.get_or_init(|| NETWORKS.iter().map(|&(chain_id, name)| (chain_id.into(), name)).collect()) } + +pub(crate) const NETWORKS: &[(u64, &str)] = &[ + (1, "ethereum"), + (2, "expanse"), + (3, "ropsten"), + (4, "rinkeby"), + (5, "goerli"), + (6, "kotti_testnet"), + (7, "thai"), + (8, "ubiq"), + (9, "ubiq_testnet"), + (10, "optimism"), + (11, "metadium"), + (12, "metadium_testnet"), + (13, "diode_testnet_staging"), + (14, "flare"), + (15, "diode_prenet"), + (16, "songbird_testnet_coston"), + (17, "thaifi"), + (18, "thundercore_testnet"), + (19, "songbird_canary"), + (20, "elastos"), + (21, "elastos_testnet"), + (22, "ela_did"), + (23, "ela_did_testnet"), + (24, "kardia"), + (25, "cronos"), + (26, "genesis_testnet"), + (27, "shiba"), + (28, "boba_rinkeby_testnet"), + (29, "genesis"), + (30, "rootstock"), + (31, "rootstock_testnet"), + (32, "gooddata_testnet"), + (33, "gooddata"), + (34, "secure"), + (35, "tbwg"), + (36, "dx"), + (37, "xpla"), + (38, "valorbit"), + (39, "u2u_solaris"), + (40, "telos_evm"), + (41, "telos_evm_testnet"), + (42, "lukso"), + (43, "darwinia_pangolin_testnet"), + (44, "crab"), + (45, "darwinia_pangoro_testnet"), + (46, "darwinia"), + (47, "acria_intelli"), + (48, "ennothem_proterozoic"), + (49, "ennothem_testnet_pioneer"), + (50, "xdc"), + (51, "xdc_apothem"), + (52, "coinex"), + (53, "coinex_testnet"), + (54, "openpiece"), + (55, "zyx"), + (56, "bsc"), + (57, "syscoin"), + (58, "ontology"), + (59, "eos_evm_legacy"), + (60, "go"), + (61, "ethereum_classic"), + (62, "morden_testnet"), + (63, "mordor_testnet"), + (64, "ellaism"), + (65, "okex_testnet"), + (66, "okx"), + (67, "db_testnet"), + (68, "soterone"), + (69, "optimism_kovan"), + (70, "hoo"), + (71, "conflux_espace_testnet"), + (72, "dx_testnet"), + (73, "fncy"), + (74, "id"), + (75, "decimal"), + (76, "mix"), + (77, "poa_sokol"), + (78, "primus"), + (79, "zenith"), + (80, "gene"), + (81, "japan_open"), + (82, "meter"), + (83, "meter_testnet"), + (84, "linqto_devnet"), + (85, "gate_testnet"), + (86, "gate"), + (87, "nova"), + (88, "viction"), + (89, "viction_testnet"), + (90, "garizon_stage0"), + (91, "garizon_stage1"), + (92, "garizon_stage2"), + (93, "garizon_stage3"), + (94, "swissdlt"), + (95, "camdl"), + (96, "bitkub"), + (97, "bnb_testnet"), + (98, "six_protocol"), + (99, "poa_core"), + (100, "gnosis"), + (101, "etherinc"), + (102, "web3games_testnet"), + (103, "worldland"), + (104, "kaiba_lightning_testnet"), + (105, "web3games_devnet"), + (106, "velas_evm"), + (107, "nebula_testnet"), + (108, "thundercore"), + (109, "shibarium"), + (110, "proton_testnet"), + (111, "etherlite"), + (112, "coinbit"), + (113, "dehvo"), + (114, "flare_testnet_coston2"), + (116, "debank"), + (117, "uptick"), + (118, "arcology_testnet"), + (119, "enuls"), + (120, "enuls_testnet"), + (121, "real"), + (122, "fuse"), + (123, "fuse_sparknet"), + (124, "decentralized_web"), + (125, "oy_testnet"), + (126, "oy"), + (127, "factory_127"), + (128, "huobi_eco"), + (129, "innovator"), + (131, "engram_testnet"), + (132, "namefi"), + (133, "hashkey_testnet"), + (134, "iexec"), + (135, "alyx_testnet"), + (136, "deam"), + (137, "polygon"), + (138, "defi_oracle_meta"), + (139, "woop"), + (140, "eternal"), + (141, "openpiece_testnet"), + (142, "dax"), + (144, "phi_v2"), + (145, "soraai_testnet"), + (147, "flag"), + (148, "shimmerevm"), + (150, "six_protocol_testnet"), + (151, "redbelly"), + (152, "redbelly_devnet"), + (153, "redbelly_testnet"), + (154, "redbelly_tge"), + (155, "tenet_testnet"), + (156, "oeblock_testnet"), + (157, "puppynet_shibarium"), + (158, "roburna"), + (159, "roburna_testnet"), + (160, "armonia_eva"), + (161, "armonia_eva_testnet"), + (162, "lightstreams_testnet"), + (163, "lightstreams"), + (164, "omni_omega_testnet"), + (166, "omni"), + (167, "atoshi_testnet"), + (168, "aioz"), + (169, "manta_pacific"), + (170, "hoo_testnet"), + (171, "co2e_ledger"), + (172, "latam_block_resil_testnet"), + (176, "dc"), + (178, "abey_testnet"), + (179, "abey"), + (180, "ame"), + (181, "waterfall"), + (183, "ethernity"), + (184, "dojima_testnet"), + (185, "mint"), + (186, "seele"), + (187, "dojima"), + (188, "bmc"), + (189, "bmc_testnet"), + (190, "cmdao_bbq"), + (191, "filefilego"), + (193, "crypto_emergency"), + (195, "x_layer_testnet"), + (196, "x_layer"), + (197, "neutrinos_testnet"), + (198, "bit"), + (199, "bittorrent"), + (200, "arbitrum_on_xdai"), + (201, "moac_testnet"), + (202, "edgeless_testnet"), + (204, "opbnb"), + (205, "ekaash"), + (206, "vinu_testnet"), + (207, "vinu"), + (208, "structx"), + (210, "bitnet"), + (211, "freight_trust"), + (212, "mapo_makalu"), + (213, "b2_hub"), + (214, "shinarium"), + (217, "siriusnet_v2"), + (218, "soterone_old"), + (220, "scalind_testnet"), + (221, "blockex"), + (222, "permission"), + (223, "b2"), + (224, "viridis_testnet"), + (225, "la"), + (226, "la_testnet"), + (228, "mind"), + (230, "swapdex"), + (233, "ethernity_testnet"), + (234, "protojumbo_testnet"), + (236, "deam_testnet"), + (238, "blast"), + (242, "plinga"), + (246, "energy_web"), + (248, "oasys"), + (250, "fantom_opera"), + (252, "fraxtal"), + (254, "swan"), + (255, "kroma"), + (256, "huobi_eco_testnet"), + (258, "setheum"), + (259, "neonlink"), + (261, "guru_testnet"), + (262, "sur_block"), + (266, "neura"), + (267, "neura_testnet"), + (268, "neura_devnet"), + (269, "high_performance_block"), + (271, "egoncoin"), + (278, "xfair.ai"), + (279, "bpx_block"), + (282, "cronos_zkevm_testnet"), + (288, "boba"), + (291, "orderly"), + (295, "hedera"), + (296, "hedera_testnet"), + (297, "hedera_previewnet"), + (298, "hedera_localnet"), + (300, "zksync_sepolia_testnet"), + (301, "bobaopera"), + (302, "zkcandy_sepolia_testnet"), + (303, "neuro_testnet"), + (305, "zksats"), + (307, "lovely_testnet"), + (308, "furtheon"), + (309, "wyzth_testnet"), + (311, "omax"), + (313, "neuro"), + (314, "filecoin"), + (321, "kcc"), + (322, "kcc_testnet"), + (323, "cosvm"), + (324, "zksync"), + (325, "grvt"), + (326, "grvt_sepolia_testnet"), + (333, "web3q"), + (335, "dfk_test"), + (336, "shiden"), + (338, "cronos_testnet"), + (345, "tsc"), + (360, "shape"), + (361, "theta"), + (363, "theta_sapphire_testnet"), + (364, "theta_amber_testnet"), + (365, "theta_testnet"), + (369, "pulse"), + (371, "consta_testnet"), + (380, "zkamoeba_testnet"), + (381, "zkamoeba"), + (385, "lisinski"), + (388, "cronos_zkevm"), + (395, "camdl_testnet"), + (397, "near"), + (398, "near_testnet"), + (399, "nativ3"), + (400, "hyperon_testnet"), + (401, "ozone_testnet"), + (404, "syndr_l3"), + (411, "pepe"), + (416, "sx"), + (418, "latestnet"), + (420, "optimism_goerli_testnet"), + (422, "viridis"), + (424, "pgn_public_goods"), + (427, "zeeth"), + (428, "geso_verse"), + (434, "boyaa"), + (443, "ten_testnet"), + (444, "synapse_testnet"), + (456, "arzio"), + (462, "areon_testnet"), + (463, "areon"), + (480, "world"), + (499, "rupaya"), + (500, "camino_c"), + (501, "columbus_test"), + (510, "syndicate"), + (512, "double_a"), + (513, "double_a_testnet"), + (516, "gear_zero"), + (520, "xt"), + (529, "fire"), + (530, "fxcore"), + (534, "candle"), + (537, "optrust"), + (542, "paw_testnet"), + (545, "evm_on_flow_testnet"), + (555, "vela1"), + (558, "tao"), + (568, "doge_testnet"), + (570, "rollux"), + (571, "meta"), + (579, "filenova"), + (588, "metis_stardust_testnet"), + (592, "astar"), + (595, "acala_mandala_testnet_tc9"), + (596, "karura_testnet"), + (597, "acala_testnet"), + (599, "metis_goerli_testnet"), + (600, "meshnyan_testnet"), + (601, "vine_testnet"), + (610, "darwin_devnet"), + (612, "eiob"), + (614, "graphlinq_block"), + (624, "binary"), + (625, "binary_sepolia"), + (634, "avocado"), + (646, "previewnet"), + (647, "sx_testnet"), + (648, "endurance"), + (653, "kali_testnet"), + (654, "kali"), + (662, "ultronsmart"), + (666, "pixie_testnet"), + (667, "laos_arrakis"), + (668, "junca"), + (669, "junca_testnet"), + (686, "karura"), + (690, "redstone"), + (700, "star_social_testnet"), + (701, "darwinia_koi_testnet"), + (707, "block_station"), + (708, "block_station_testnet"), + (710, "highbury"), + (711, "tucana"), + (712, "birdee_2"), + (713, "vrcscan"), + (719, "shibarium_beta"), + (721, "lycan"), + (727, "blucrates"), + (730, "lovely"), + (740, "canto_testnet"), + (741, "vention_testnet"), + (742, "script_testnet"), + (747, "evm_on_flow"), + (766, "ql1"), + (776, "open_testnet"), + (777, "cheapeth"), + (786, "maal"), + (787, "acala"), + (788, "aero_testnet"), + (789, "patex"), + (799, "rupaya_testnet"), + (800, "lucid_block"), + (803, "haic"), + (808, "portal_fantasy_test"), + (810, "haven1_testnet"), + (813, "qitmeer"), + (814, "fire_zkevm"), + (818, "beone"), + (820, "callisto"), + (822, "runic_testnet"), + (831, "checkdot_block_devnet"), + (841, "taraxa"), + (842, "taraxa_testnet"), + (852, "hongkong"), + (859, "zeeth_dev"), + (868, "fantasia"), + (876, "bandai_namco_research_verse"), + (877, "dexit"), + (880, "ambros"), + (888, "wan"), + (898, "maxi_testnet"), + (899, "maxi"), + (900, "garizon_testnet_stage0"), + (901, "garizon_testnet_stage1"), + (902, "garizon_testnet_stage2"), + (903, "garizon_testnet_stage3"), + (909, "portal_fantasy"), + (910, "decentrabone_layer1_testnet"), + (911, "taproot"), + (917, "rinia_testnet"), + (919, "mode_testnet"), + (927, "yidark"), + (940, "pulse_testnet"), + (941, "pulse_testnet_v2b"), + (942, "pulse_testnet_v3"), + (943, "pulse_testnet_v4"), + (945, "subtensor_evm_testnet"), + (956, "munode_testnet"), + (957, "lyra"), + (963, "btc20"), + (969, "ethxy"), + (970, "oort"), + (971, "oort_huygens"), + (972, "oort_ascraeus"), + (973, "palm"), + (977, "nepal_block"), + (979, "ethxy_testnet"), + (980, "top_evm"), + (985, "memo"), + (989, "top"), + (990, "eliberty"), + (995, "5ire"), + (996, "bifrost_polkadot"), + (997, "5ire_thunder_testnet"), + (998, "lucky"), + (999, "wan_testnet"), + (1000, "gton"), + (1001, "kaia_testnet_kairos"), + (1003, "tectum_emission_token"), + (1004, "t_ekta"), + (1005, "lemontestnet"), + (1006, "lemon"), + (1007, "newton_testnet"), + (1008, "eurus"), + (1009, "jumbo"), + (1010, "evrice"), + (1011, "rebus"), + (1012, "newton"), + (1022, "sakura"), + (1023, "clover_testnet"), + (1024, "clv_para"), + (1028, "bittorrent_testnet"), + (1030, "conflux_espace"), + (1031, "proxy_testnet"), + (1038, "bronos_testnet"), + (1039, "bronos"), + (1073, "shimmerevm_testnet"), + (1075, "iota_evm_testnet"), + (1079, "mintara_testnet"), + (1080, "mintara"), + (1088, "metis_andromeda"), + (1089, "humans.ai"), + (1099, "moac"), + (1100, "dymension"), + (1101, "polygon_zkevm"), + (1107, "blxq_testnet"), + (1108, "blxq"), + (1111, "wemix"), + (1112, "wemix_testnet"), + (1113, "b2_hub_testnet"), + (1115, "core_block_testnet"), + (1116, "core_block"), + (1117, "dogcoin"), + (1123, "b2_testnet"), + (1130, "defi_evm"), + (1131, "defi_evm_testnet"), + (1133, "defimeta_changi_testnet"), + (1135, "lisk"), + (1138, "amstar_testnet"), + (1139, "math"), + (1140, "math_testnet"), + (1147, "flag_testnet"), + (1149, "symplexia"), + (1170, "origin_testnet"), + (1177, "smart_host_teknoloji_testnet"), + (1188, "clubmos"), + (1197, "iora"), + (1200, "cuckoo"), + (1201, "evanesco_testnet"), + (1202, "world_trade_technical"), + (1209, "saitablocksbc"), + (1210, "cuckoo_sepolia"), + (1213, "popcateum"), + (1214, "enter"), + (1221, "cycle_testnet"), + (1223, "cycle_testnet_jellyfish"), + (1225, "hybrid_testnet"), + (1227, "bitcoin_protocol_testnet"), + (1228, "cycle_testnet_cuttlefish"), + (1229, "exzo"), + (1230, "ultron_testnet"), + (1231, "ultron"), + (1234, "step"), + (1235, "itx"), + (1243, "arc"), + (1244, "arc_testnet"), + (1246, "om_platform"), + (1248, "dogether"), + (1252, "cic_testnet"), + (1260, "metacces_testnet"), + (1280, "halo"), + (1284, "moonbeam"), + (1285, "moonriver"), + (1286, "moonrock_old"), + (1287, "moonbase_alpha"), + (1288, "moonrock"), + (1291, "swisstronik_testnet"), + (1294, "bobabeam"), + (1297, "bobabase_testnet"), + (1311, "dos_fuji_subnet"), + (1313, "jaiho"), + (1314, "alyx"), + (1319, "aia"), + (1320, "aia_testnet"), + (1328, "sei_testnet"), + (1329, "sei"), + (1337, "geth_testnet"), + (1338, "elysium_testnet"), + (1339, "elysium"), + (1343, "blitz_subnet"), + (1353, "cic"), + (1369, "zafirium"), + (1370, "ramestta"), + (1377, "pingaksha_testnet"), + (1379, "kalar"), + (1388, "amstar"), + (1392, "joseon"), + (1402, "polygon_zkevm_testnet_old"), + (1422, "polygon_zkevm_testnet_pre_audit_upgraded"), + (1433, "rikeza"), + (1440, "living_assets"), + (1442, "polygon_zkevm_testnet"), + (1452, "gil_testnet"), + (1453, "meta_istanbul"), + (1455, "ctex_scan_block"), + (1456, "zkbase"), + (1490, "vitruveo"), + (1499, "idos_games_testnet"), + (1501, "bevm_canary"), + (1506, "sherpax"), + (1507, "sherpax_testnet"), + (1513, "story_testnet"), + (1515, "beagle_messaging"), + (1559, "tenet"), + (1570, "star_testnet"), + (1578, "star"), + (1617, "ethereum_inscription"), + (1618, "catecoin"), + (1620, "atheios"), + (1625, "gravity_alpha"), + (1648, "pivotal"), + (1657, "bta"), + (1662, "liqui"), + (1663, "horizen_gobi_testnet"), + (1686, "mint_testnet"), + (1687, "mint_sepolia_testnet"), + (1688, "ludan"), + (1701, "anytype_evm"), + (1707, "tbsi"), + (1708, "tbsi_testnet"), + (1717, "doric"), + (1718, "palette"), + (1729, "reya"), + (1740, "metal_l2_testnet"), + (1750, "metal_l2"), + (1773, "party"), + (1777, "gauss"), + (1789, "zkbase_sepolia_testnet"), + (1804, "kerleano"), + (1807, "rabbit_analog_testnet"), + (1811, "lif3_testnet"), + (1818, "cube"), + (1819, "cube_testnet"), + (1821, "ruby"), + (1853, "highoctane_subnet"), + (1856, "teslafunds"), + (1875, "white"), + (1881, "gitshock_cartenz_testnet"), + (1890, "lightlink_phoenix"), + (1891, "lightlink_pegasus_testnet"), + (1898, "bon"), + (1899, "redefi_layer_2"), + (1904, "sports"), + (1907, "bitci"), + (1908, "bitci_testnet"), + (1909, "merkle_scan"), + (1911, "scalind"), + (1912, "ruby_testnet"), + (1918, "upb_crescdi_testnet"), + (1945, "onus_testnet"), + (1946, "minato"), + (1951, "d"), + (1953, "selendra_testnet"), + (1954, "dexilla_testnet"), + (1956, "aiw3_testnet"), + (1961, "selendra"), + (1967, "eleanor"), + (1969, "super_testnet"), + (1970, "super"), + (1971, "atelier"), + (1972, "redecoin"), + (1975, "onus"), + (1984, "eurus_testnet"), + (1985, "satoshie"), + (1986, "satoshie_testnet"), + (1987, "ethergem"), + (1992, "hubble_exchange"), + (1993, "b3_sepolia_testnet"), + (1994, "ekta"), + (1995, "edexa_testnet"), + (1996, "sanko"), + (1997, "kyoto"), + (1998, "kyoto_testnet"), + (2000, "doge"), + (2001, "milkomeda_c1"), + (2002, "milkomeda_a1"), + (2004, "metalink"), + (2008, "cloudwalk_testnet"), + (2009, "cloudwalk"), + (2013, "panarchy"), + (2014, "now_testnet"), + (2016, "mainnetz"), + (2017, "adiri"), + (2018, "publicmint_devnet"), + (2019, "publicmint_testnet"), + (2020, "publicmint"), + (2021, "edgeware_edgeevm"), + (2022, "beresheet_bereevm_testnet"), + (2023, "taycan_testnet"), + (2024, "swan_saturn_testnet"), + (2025, "rangers_protocol"), + (2026, "edgeless"), + (2031, "centrifuge"), + (2032, "catalyst"), + (2035, "phala"), + (2037, "kiwi_subnet"), + (2038, "shrapnel_testnet"), + (2039, "aleph_zero"), + (2040, "vanar"), + (2043, "neuroweb"), + (2044, "shrapnel_subnet"), + (2045, "aiw3"), + (2047, "stratos_testnet"), + (2048, "stratos"), + (2049, "movo"), + (2071, "metacces"), + (2077, "quokkacoin"), + (2088, "altair"), + (2089, "algol"), + (2100, "ecoball"), + (2101, "ecoball_testnet_espuma"), + (2109, "exosama"), + (2112, "u"), + (2121, "catena"), + (2122, "metaplayerone"), + (2124, "metaplayerone_dubai_testnet"), + (2136, "bigshortbets_testnet"), + (2137, "bigshortbets"), + (2138, "defi_oracle_meta_testnet"), + (2140, "oneness"), + (2141, "oneness_testnet"), + (2151, "bosagora"), + (2152, "findora"), + (2153, "findora_testnet"), + (2154, "findora_forge"), + (2162, "anime_testnet"), + (2192, "snax"), + (2199, "moonsama"), + (2202, "antofy"), + (2203, "bitcoin_evm"), + (2213, "evanesco"), + (2221, "kava_testnet"), + (2222, "kava"), + (2223, "v"), + (2241, "krest"), + (2300, "bomb"), + (2306, "ebro"), + (2309, "arevia"), + (2311, "chronicle_vesuvius_lit_protocol_testnet"), + (2323, "soma_testnet"), + (2330, "altcoin"), + (2331, "rss3_vsl_sepolia_testnet"), + (2332, "soma"), + (2340, "atleta_olympia"), + (2342, "omnia"), + (2355, "silicon_zkevm"), + (2358, "kroma_sepolia"), + (2370, "nexis_testnet"), + (2399, "bomb_testnet"), + (2400, "tcg_verse"), + (2410, "karak"), + (2415, "xodex"), + (2425, "king_of_legends"), + (2442, "polygon_zkevm_cardona_testnet"), + (2468, "hybrid"), + (2477, "6degree_of_outreach"), + (2484, "unicorn_ultra_nebulas_testnet"), + (2511, "karak_goerli"), + (2522, "fraxtal_testnet"), + (2525, "inevm"), + (2559, "kortho"), + (2569, "techpay"), + (2606, "pocrnet"), + (2611, "redlight"), + (2612, "ez_c"), + (2613, "ez_c_testnet"), + (2625, "white_testnet"), + (2648, "ailayer_testnet"), + (2649, "ailayer"), + (2662, "apex"), + (2710, "morph_testnet"), + (2718, "k_laos"), + (2730, "xr_sepolia"), + (2731, "elizabeth_testnet"), + (2748, "nanon"), + (2777, "gm"), + (2810, "morph_holesky"), + (2868, "hyperagi"), + (2882, "chips"), + (2888, "boba_goerli_testnet"), + (2889, "aarma"), + (2907, "elux"), + (2911, "hy"), + (2941, "xenon_testnet"), + (2999, "bityuan"), + (3000, "cennznet_rata"), + (3001, "cennznet_nikau"), + (3003, "canxium"), + (3011, "playa3ull_games"), + (3031, "orlando"), + (3033, "rebus_testnet"), + (3068, "bifrost"), + (3073, "movement_evm"), + (3084, "xl_testnet"), + (3100, "immu3_evm"), + (3102, "vulture_evm_beta"), + (3109, "satoshivm_alpha"), + (3110, "satoshivm_testnet"), + (3141, "filecoin_hyperspace_testnet"), + (3269, "dubxcoin"), + (3270, "dubxcoin_testnet"), + (3306, "debounce_subnet_testnet"), + (3331, "zcore_testnet"), + (3333, "ethstorage_testnet"), + (3334, "web3q_galileo"), + (3335, "ethstorage"), + (3338, "peaq"), + (3400, "paribu_net"), + (3424, "evolve"), + (3434, "secure_testnet"), + (3456, "layeredge_testnet"), + (3490, "gtcscan"), + (3500, "paribu_net_testnet"), + (3501, "jfin"), + (3601, "pandoproject"), + (3602, "pandoproject_testnet"), + (3630, "tycooncoin"), + (3636, "botanix_testnet"), + (3637, "botanix"), + (3639, "i"), + (3645, "i_testnet"), + (3666, "jouleverse"), + (3690, "bittex"), + (3693, "empire"), + (3698, "senjepowers_testnet"), + (3699, "senjepowers"), + (3701, "xpla_testnet"), + (3737, "crossbell"), + (3776, "astar_zkevm"), + (3797, "alvey"), + (3799, "tangle_testnet"), + (3885, "fire_zkevm_ghostrider"), + (3888, "kaly"), + (3889, "kaly_testnet"), + (3912, "drac"), + (3939, "dos_tesnet"), + (3966, "dyno"), + (3967, "dyno_testnet"), + (3993, "apex_testnet"), + (3999, "yuan"), + (4000, "ozone"), + (4001, "peperium_testnet"), + (4002, "fantom_testnet"), + (4003, "x1_fastnet"), + (4040, "carbonium_testnet"), + (4048, "gan_testnet"), + (4051, "bobaopera_testnet"), + (4058, "bahamut_ocean"), + (4061, "nahmii_3"), + (4062, "nahmii_3_testnet"), + (4078, "muster"), + (4080, "tobe_testnet"), + (4088, "zeroth"), + (4090, "fastex_bahamut_oasis_testnet"), + (4096, "bitindi_testnet"), + (4099, "bitindi"), + (4102, "aioz_testnet"), + (4139, "humans.ai_testnet"), + (4141, "tipboxcoin_testnet"), + (4157, "crossfi_testnet"), + (4162, "sx_rollup"), + (4181, "phi_v1"), + (4200, "merlin"), + (4201, "lukso_testnet"), + (4202, "lisk_sepolia_testnet"), + (4242, "nexi"), + (4243, "nexi_v2"), + (4269, "laika_testnet"), + (4328, "bobafuji_testnet"), + (4337, "beam"), + (4400, "credit"), + (4444, "htmlcoin"), + (4460, "orderly_sepolia_testnet"), + (4488, "hydra"), + (4544, "emoney_testnet"), + (4613, "very"), + (4653, "gold"), + (4689, "iotex"), + (4690, "iotex_testnet"), + (4759, "meverse_testnet"), + (4777, "blackfort_exchange_testnet"), + (4801, "world_sepolia_testnet"), + (4893, "globel"), + (4918, "venidium_testnet"), + (4919, "venidium"), + (4999, "blackfort_exchange"), + (5000, "mantle"), + (5001, "mantle_testnet"), + (5002, "treasurenet_alpha"), + (5003, "mantle_sepolia_testnet"), + (5005, "treasurenet_testnet"), + (5039, "onigiri_test_subnet"), + (5040, "onigiri_subnet"), + (5051, "nollie_skate_testnet"), + (5100, "syndicate_testnet"), + (5101, "syndicate_frame"), + (5102, "sic_testnet"), + (5103, "coordinape_testnet"), + (5104, "charmverse_testnet"), + (5105, "superloyalty_testnet"), + (5106, "azra_testnet"), + (5112, "ham"), + (5151, "me_testnet"), + (5165, "bahamut"), + (5169, "smart_layer"), + (5177, "tl"), + (5197, "eraswap"), + (5234, "humanode"), + (5290, "fire_old"), + (5315, "uzmi"), + (5317, "optrust_testnet"), + (5321, "itx_testnet"), + (5333, "netsbo"), + (5353, "tritanium_testnet"), + (5372, "settlus_testnet"), + (5424, "edexa"), + (5439, "ego"), + (5522, "vex_evm_testnet"), + (5545, "duck"), + (5551, "nahmii_2"), + (5553, "nahmii_2_testnet"), + (5555, "verse"), + (5611, "opbnb_testnet"), + (5615, "arcturus_testneet"), + (5616, "arcturus_testnet"), + (5656, "qie_block"), + (5675, "filenova_testnet"), + (5678, "tanssi_demo"), + (5700, "syscoin_tanenbaum_testnet"), + (5729, "hika_testnet"), + (5758, "satoshi_testnet"), + (5777, "ganache"), + (5845, "tangle"), + (5851, "ontology_testnet"), + (5858, "chang_foundation"), + (5869, "wego_rubidium"), + (6000, "bouncebit_testnet"), + (6001, "bouncebit"), + (6065, "tres_testnet"), + (6066, "tres"), + (6102, "cascadia_testnet"), + (6118, "uptn_testnet"), + (6119, "uptn"), + (6283, "laos"), + (6321, "aura_euphoria_testnet"), + (6322, "aura"), + (6363, "digit_soul"), + (6398, "connext_sepolia"), + (6502, "peerpay"), + (6550, "flamma_testnet"), + (6552, "scolcoin_wei_testnet"), + (6565, "fox_testnet"), + (6626, "pixie"), + (6660, "latest_testnet"), + (6661, "cybria"), + (6666, "cybria_testnet"), + (6667, "stor"), + (6678, "edge_matrix"), + (6688, "irishub"), + (6699, "ox"), + (6701, "paxb"), + (6779, "compverse"), + (6805, "race"), + (6806, "race_testnet"), + (6868, "pools"), + (6880, "mtt"), + (6942, "laika"), + (6969, "tomb"), + (6999, "polysmart"), + (7000, "zeta"), + (7001, "zeta_testnet"), + (7007, "bst"), + (7027, "ella_the_heart"), + (7070, "planq"), + (7077, "planq_atlas_testnet"), + (7100, "nume"), + (7118, "help_the_homeless"), + (7171, "bitrock"), + (7210, "nibiru_testnet_1"), + (7222, "nibiru_devnet_3"), + (7244, "zeus_testnet"), + (7300, "xpla_verse"), + (7331, "klyntar"), + (7332, "horizen_eon"), + (7341, "shyft"), + (7484, "raba"), + (7518, "meverse"), + (7560, "cyber"), + (7575, "adil_testnet"), + (7576, "adil_v2"), + (7668, "the_root"), + (7672, "the_root_porcini_testnet"), + (7700, "canto"), + (7701, "canto_tesnet"), + (7771, "bitrock_testnet"), + (7774, "gdcc"), + (7775, "gdcc_testnet"), + (7776, "pandasea"), + (7777, "rise_of_the_warbots_testnet"), + (7778, "orenium_protocol"), + (7798, "openex_long_testnet"), + (7860, "maal_testnet"), + (7862, "maal_v2"), + (7863, "maal_testnet_v2"), + (7878, "hazlor_testnet"), + (7887, "kinto"), + (7895, "ardenium_athena"), + (7923, "dot_blox"), + (7924, "mo"), + (7979, "dos"), + (8000, "teleport"), + (8001, "teleport_testnet"), + (8008, "polynomial"), + (8017, "isuncoin"), + (8029, "mdgl_testnet"), + (8047, "boat"), + (8054, "karak_sepolia"), + (8080, "shardeum_liberty_1.x"), + (8081, "shardeum_liberty_2.x"), + (8082, "shardeum_sphinx_1.x"), + (8086, "bitcoin"), + (8087, "e_dollar"), + (8098, "streamux_block"), + (8131, "qitmeer_testnet"), + (8132, "qitmeer_mixnet"), + (8133, "qitmeer_privnet"), + (8134, "amana"), + (8135, "flana"), + (8136, "mizana"), + (8181, "testnet_beone"), + (8192, "torus"), + (8194, "torus_testnet"), + (8217, "kaia"), + (8227, "space_subnet"), + (8272, "blockton_block"), + (8285, "korthotest"), + (8329, "lorenzo"), + (8333, "b3"), + (8387, "dracones_financial_services"), + (8428, "that"), + (8453, "base"), + (8545, "chakra_testnet"), + (8654, "toki"), + (8655, "toki_testnet"), + (8668, "hela_official_runtime"), + (8723, "tool_global"), + (8724, "tool_global_testnet"), + (8726, "storage"), + (8727, "storage_testnet"), + (8732, "bullions"), + (8738, "alph"), + (8768, "tmy"), + (8822, "iota_evm"), + (8844, "hydra_testnet"), + (8848, "maro_block"), + (8866, "superlumio"), + (8869, "lif3"), + (8880, "unique"), + (8881, "quartz_by_unique"), + (8882, "opal_testnet_by_unique"), + (8883, "sapphire_by_unique"), + (8886, "avenium_testnet"), + (8888, "xana"), + (8889, "vyvo"), + (8890, "orenium_testnet_protocol"), + (8898, "mammoth"), + (8899, "jib"), + (8911, "algen"), + (8912, "algen_testnet"), + (8921, "algen_layer2"), + (8922, "algen_layer2_testnet"), + (8989, "giant_mammoth"), + (8995, "bloxberg"), + (9000, "evmos_testnet"), + (9001, "evmos"), + (9007, "shido_testnet_block"), + (9008, "shido_block"), + (9012, "berylbit"), + (9024, "nexa_testnet_block"), + (9025, "nexa_block"), + (9069, "apex_fusion_nexus"), + (9070, "apex_fusion_nexus_testnet"), + (9100, "genesis_coin"), + (9170, "rinia_testnet_old"), + (9223, "codefin"), + (9339, "dogcoin_testnet"), + (9372, "oasys_testnet"), + (9393, "dela_sepolia_testnet"), + (9395, "evoke"), + (9496, "weavevm_testnet"), + (9527, "rangers_protocol_testnet_robin"), + (9528, "qeasyweb3_testnet"), + (9559, "neonlink_testnet"), + (9700, "oortdev"), + (9728, "boba_bnb_testnet"), + (9768, "mainnetz_testnet"), + (9779, "pepenetwork"), + (9789, "tabi_testnet"), + (9790, "carbon_evm"), + (9792, "carbon_evm_testnet"), + (9797, "optimusz7"), + (9818, "imperium_testnet"), + (9819, "imperium"), + (9876, "binary_testnet"), + (9888, "dogelayer"), + (9897, "arena_z_testnet"), + (9898, "larissa"), + (9911, "espento"), + (9966, "uxer_testnet"), + (9977, "mind_testnet"), + (9980, "combo"), + (9981, "volley"), + (9990, "agung"), + (9997, "altlayer_testnet"), + (9998, "ztc"), + (9999, "myown_testnet"), + (10000, "smart_bitcoin_cash"), + (10001, "smart_bitcoin_cash_testnet"), + (10024, "gon"), + (10081, "japan_open_testnet"), + (10086, "sjatsh"), + (10096, "metanova_verse"), + (10101, "block_genesis"), + (10200, "gnosis_chiado_testnet"), + (10201, "maxx"), + (10222, "glscan"), + (10242, "arthera"), + (10243, "arthera_testnet"), + (10248, "0xtade"), + (10321, "tao_evm"), + (10324, "tao_evm_testnet"), + (10395, "worldland_testnet"), + (10507, "numbers"), + (10508, "numbers_testnet"), + (10823, "cryptocoinpay"), + (10849, "lamina1"), + (10850, "lamina1_identity"), + (10946, "quadrans_block"), + (10947, "quadrans_block_testnet"), + (11000, "kb"), + (11011, "shape_sepolia_testnet"), + (11110, "astra"), + (11111, "wagmi"), + (11115, "astra_testnet"), + (11119, "hashbit"), + (11124, "abstract_testnet"), + (11221, "shine"), + (11227, "jiritsu_testnet_subnet"), + (11235, "haqq"), + (11437, "shyft_testnet"), + (11501, "bevm"), + (11503, "bevm_testnet"), + (11521, "sats"), + (11612, "sardis_testnet"), + (11822, "artela_testnet"), + (11891, "polygon_supernet_arianee"), + (12001, "fuse_testnet"), + (12009, "satoshi"), + (12020, "aternos"), + (12051, "singularity_zero_testnet"), + (12052, "singularity_zero"), + (12123, "brc"), + (12306, "fibonacci"), + (12321, "blg_testnet"), + (12324, "l3x_protocol"), + (12325, "l3x_protocol_testnet"), + (12345, "step_testnet"), + (12553, "rss3_vsl"), + (12715, "rikeza_testnet"), + (12781, "playdapp_testnet"), + (12890, "quantum_testnet"), + (12898, "playfair_testnet_subnet"), + (13000, "sps"), + (13337, "beam_testnet"), + (13370, "cannon_testnet"), + (13371, "immutable_zkevm"), + (13381, "phoenix"), + (13396, "masa"), + (13473, "immutable_zkevm_testnet"), + (13505, "gravity_alpha_testnet_sepolia"), + (13600, "kronobit"), + (13812, "susono"), + (14000, "sps_testnet"), + (14088, "zeroth_testnet"), + (14324, "evolve_testnet"), + (14333, "vitruveo_testnet"), + (14800, "vana_moksha_testnet"), + (14801, "vana_satori_testnet"), + (14853, "humanode_testnet_5_israfel"), + (15003, "immutable_zkevm_devnet"), + (15257, "poodl_testnet"), + (15259, "poodl"), + (15430, "kymtc"), + (15551, "loopnetwork"), + (15555, "trust_evm_testnet"), + (15557, "eos_evm_testnet"), + (16000, "metadot"), + (16001, "metadot_testnet"), + (16116, "defiverse"), + (16166, "cypherium"), + (16180, "plyr_phi"), + (16350, "incentiv_devnet"), + (16481, "pivotal_sepolia"), + (16507, "genesys"), + (16600, "0g_newton_testnet"), + (16688, "irishub_testnet"), + (16718, "airdao"), + (16888, "ivar_testnet"), + (17000, "holesky"), + (17001, "redstone_holesky_testnet"), + (17069, "garnet_holesky"), + (17071, "on_points"), + (17117, "defiverse_testnet"), + (17171, "g8"), + (17172, "eclipse_subnet"), + (17180, "palette_testnet"), + (17217, "konet"), + (17777, "eos_evm"), + (18000, "frontier_of_dreams_testnet"), + (18122, "smart_trades"), + (18159, "proof_of_memes"), + (18181, "g8_testnet"), + (18231, "unreal_old"), + (18233, "unreal"), + (18686, "mxc_zkevm_moon"), + (18888, "titan_tkx"), + (18889, "titan_tkx_testnet"), + (19011, "home_verse"), + (19077, "blockx_atlantis_testnet"), + (19191, "blockx"), + (19224, "decentraconnect_social"), + (19527, "magnet"), + (19600, "lbry"), + (19845, "btcix"), + (20001, "camelark"), + (20041, "niza"), + (20073, "niza_testnet"), + (20729, "callisto_testnet"), + (20736, "p12"), + (20765, "jono11_subnet"), + (21004, "c4ei"), + (21133, "all_about_healthy"), + (21223, "dcpay"), + (21224, "dcpay_testnet"), + (21337, "cennznet_azalea"), + (21363, "lestnet"), + (21816, "om"), + (21912, "bsl"), + (22023, "taycan"), + (22040, "airdao_testnet"), + (22222, "nautilus"), + (22324, "goldx_testnet"), + (22776, "map_protocol"), + (23006, "antofy_testnet"), + (23118, "opside_testnet"), + (23294, "oasis_sapphire"), + (23295, "oasis_sapphire_testnet"), + (23451, "dreyerx"), + (23452, "dreyerx_testnet"), + (23888, "blast_testnet"), + (24076, "kymtc_testnet"), + (24484, "web"), + (24734, "mintme.com"), + (25186, "liquidlayer"), + (25327, "everclear"), + (25839, "alvey_testnet"), + (25888, "hammer"), + (25925, "bitkub_testnet"), + (26026, "ferrum_testnet"), + (26482, "ducatusx_testnet"), + (26483, "ducatusx"), + (26600, "hertz"), + (26863, "oasis"), + (27181, "klaos_nova"), + (27483, "nanon_sepolia"), + (27827, "zeroone_subnet"), + (28516, "vizing_testnet"), + (28518, "vizing"), + (28528, "optimism_bedrock_goerli_alpha_testnet"), + (28882, "boba_sepolia"), + (29112, "hy_testnet"), + (29223, "nexa_metanet"), + (29536, "kai_testnet"), + (29548, "mch_verse"), + (30000, "q"), + (30067, "piece_testnet"), + (30088, "miyou"), + (30103, "cerium_testnet"), + (30730, "movement_evm_legacy"), + (30731, "movement_evm_devnet"), + (30732, "movement_evm_testnet"), + (31102, "ethersocial"), + (31223, "cloudtx"), + (31224, "cloudtx_testnet"), + (31337, "go_testnet"), + (31414, "evoke_testnet"), + (31415, "filecoin_wallaby_testnet"), + (31753, "x"), + (31754, "x_testnet"), + (32001, "w3gamez_holesky_testnet"), + (32382, "santiment_intelligence"), + (32520, "bitgert"), + (32659, "fusion"), + (32769, "zilliqa_evm"), + (32990, "zilliqa_evm_isolated_server"), + (33033, "entangle"), + (33101, "zilliqa_evm_testnet"), + (33103, "zilliqa_2_evm_proto_testnet"), + (33111, "curtis"), + (33133, "entangle_testnet"), + (33210, "cloudverse_subnet"), + (33333, "aves"), + (33385, "zilliqa_evm_devnet"), + (33401, "slingshot"), + (33469, "zilliqa_2_evm_devnet"), + (33979, "funki"), + (34443, "mode"), + (34504, "zeus"), + (35011, "j2o_taro"), + (35443, "q_testnet"), + (38400, "connectormanager"), + (38401, "connectormanager_robin"), + (39656, "prm"), + (39797, "energi"), + (39815, "oho"), + (40000, "div"), + (41455, "aleph_zero_evm"), + (41500, "opulent_x_beta"), + (42069, "pegglecoin"), + (42072, "agentlayer_testnet"), + (42161, "arbitrum"), + (42170, "arbitrum_nova"), + (42220, "celo"), + (42261, "oasis_emerald_testnet"), + (42262, "oasis_emerald"), + (42355, "goldx"), + (42421, "asset_testnet"), + (42766, "zkfair"), + (42793, "etherlink"), + (42801, "gesoten_verse_testnet"), + (42888, "kinto_testnet"), + (43110, "athereum"), + (43111, "hemi"), + (43113, "avalanche_fuji_testnet"), + (43114, "avalanche"), + (43288, "boba_avax"), + (43851, "zkfair_testnet"), + (44444, "fren"), + (44445, "quantum"), + (44787, "celo_alfajores_testnet"), + (45000, "autobahn"), + (45454, "swamps_l2"), + (45510, "deelance"), + (45513, "blessnet"), + (46688, "fusion_testnet"), + (47763, "neo_x"), + (47803, "redefi_layer_1"), + (47805, "rei"), + (48795, "space_subnet_testnet"), + (48899, "zircuit_testnet"), + (48900, "zircuit"), + (49049, "wireshape_floripa_testnet"), + (49088, "bifrost_testnet"), + (49321, "gunz_testnet"), + (49797, "energi_testnet"), + (50001, "liveplex_oracleevm"), + (50005, "yooldo_verse"), + (50006, "yooldo_verse_testnet"), + (50021, "gton_testnet"), + (50888, "erbie"), + (51178, "lumoz_testnet_alpha"), + (51712, "sardis"), + (52014, "electroneum"), + (53277, "doid"), + (53302, "superseed_sepolia_testnet"), + (53457, "dodo_testnet"), + (53935, "dfk"), + (54176, "overprotocol"), + (54211, "haqq_testnet"), + (54321, "toronet_testnet"), + (55004, "titan"), + (55551, "photon_aurora_testnet"), + (55556, "rei_testnet"), + (55614, "flamma"), + (56026, "lambda"), + (56288, "boba_bnb"), + (56400, "testnet_zeroone_subnet"), + (56789, "velo_labs"), + (56797, "doid_testnet"), + (57000, "rollux_testnet"), + (57451, "coinsec"), + (58008, "sepolia_pgn_public_goods"), + (58680, "lumoz_quidditch_testnet"), + (59140, "linea_goerli"), + (59141, "linea_sepolia"), + (59144, "linea"), + (59902, "metis_sepolia_testnet"), + (59971, "genesys_code"), + (60000, "thinkium_testnet_0"), + (60001, "thinkium_testnet_1"), + (60002, "thinkium_testnet_2"), + (60103, "thinkium_testnet_103"), + (60808, "bob"), + (61022, "orange"), + (61406, "kai"), + (61800, "axel_dev_net"), + (61803, "etica"), + (61916, "doken_super"), + (62049, "optopia_testnet"), + (62050, "optopia"), + (62298, "citrea_devnet"), + (62320, "celo_baklava_testnet"), + (62621, "multivac"), + (62831, "plyr_tau_testnet"), + (62850, "laos_sigma_testnet"), + (63000, "ecredits"), + (63001, "ecredits_testnet"), + (63002, "esync_testnet"), + (65349, "cratd2c_testnet"), + (65357, "vecno"), + (65450, "scolcoin"), + (65536, "automata"), + (66665, "creator_testnet"), + (66988, "janus_testnet"), + (67390, "siriusnet"), + (67588, "cosmic"), + (68770, "dm2_verse"), + (68775, "dm2_verse_testnet"), + (69420, "condrieu"), + (70000, "thinkium_0"), + (70001, "thinkium_1"), + (70002, "thinkium_2"), + (70103, "thinkium_103"), + (70700, "proof_of_play_apex"), + (71111, "guapcoinx"), + (71393, "polyjuice_testnet"), + (71401, "godwoken_testnet_v1"), + (71402, "godwoken"), + (72778, "caga_crypto_ankara_testnet"), + (72992, "grok"), + (73114, "icb_testnet"), + (73115, "icb"), + (73799, "energy_web_volta_testnet"), + (73927, "mixin_virtual_machine"), + (75000, "resincoin"), + (75512, "geek_verse"), + (75513, "geek_verse_testnet"), + (77001, "bora"), + (77238, "foundry_testnet"), + (77612, "vention"), + (77677, "cycle_sailboat"), + (77777, "toronet"), + (78110, "firenze_test"), + (78281, "dragonfly_hexapod"), + (78430, "amplify_subnet"), + (78431, "bulletin_subnet"), + (78432, "conduit_subnet"), + (78600, "vanguard"), + (79879, "gold_testnet"), + (80001, "mumbai"), + (80002, "amoy"), + (80008, "polynomia_sepolia"), + (80084, "bera_bartio"), + (80085, "bera_artio"), + (80096, "hizoco"), + (81041, "nordek"), + (81341, "amana_testnet"), + (81342, "amana_mixnet"), + (81343, "amana_privnet"), + (81351, "flana_testnet"), + (81352, "flana_mixnet"), + (81353, "flana_privnet"), + (81361, "mizana_testnet"), + (81362, "mizana_mixnet"), + (81363, "mizana_privnet"), + (82459, "smart_layer_testnet"), + (83144, "xprotocol_testnet"), + (83278, "esa"), + (83872, "zedxion"), + (84531, "base_goerli_testnet"), + (84532, "base_sepolia_testnet"), + (84886, "aerie"), + (85449, "cybertrust"), + (88002, "nautilus_proteus_testnet"), + (88559, "inoai"), + (88800, "zkasino"), + (88817, "unit_zero_testnet"), + (88819, "unit_zero_stagenet"), + (88880, "chiliz_scoville_testnet"), + (88882, "chiliz_spicy_testnet"), + (88888, "chiliz"), + (90001, "fxcore_testnet"), + (90210, "beverly_hills"), + (90354, "camp_testnet"), + (91002, "nautilus_trition"), + (91120, "metadap_enterprise"), + (91715, "combo_testnet"), + (92001, "lambda_testnet"), + (93572, "liquidlayer_testnet"), + (93747, "stratovm_testnet"), + (96970, "mantis_testnet_hexapod"), + (97053, "tetron_testnet"), + (97055, "tetron"), + (97288, "boba_bnb_old"), + (97435, "slingshot_testnet"), + (97531, "green_testnet"), + (97970, "optimusz7_testnet"), + (98881, "ebi"), + (99099, "eliberty_testnet"), + (99876, "edge_matrix_testnet"), + (99998, "ubtestnet"), + (99999, "ub"), + (100000, "quark_root"), + (100001, "quark_shard_0"), + (100002, "quark_shard_1"), + (100003, "quark_shard_2"), + (100004, "quark_shard_3"), + (100005, "quark_shard_4"), + (100006, "quark_shard_5"), + (100007, "quark_shard_6"), + (100008, "quark_shard_7"), + (100009, "ve"), + (100010, "ve_testnet"), + (100011, "quark_l2"), + (101010, "global_trust"), + (102030, "creditcoin"), + (102031, "creditcoin_testnet"), + (102032, "creditcoin_devnet"), + (103090, "crystaleum"), + (103454, "masa_testnet"), + (104566, "kaspaclassic"), + (105105, "stratis"), + (108801, "bro"), + (110000, "quark_devnet_root"), + (110001, "quark_devnet_shard_0"), + (110002, "quark_devnet_shard_1"), + (110003, "quark_devnet_shard_2"), + (110004, "quark_devnet_shard_3"), + (110005, "quark_devnet_shard_4"), + (110006, "quark_devnet_shard_5"), + (110007, "quark_devnet_shard_6"), + (110008, "quark_devnet_shard_7"), + (110011, "quark_l2_testnet"), + (110110, "mars_credit"), + (111000, "siberium_test"), + (111111, "siberium"), + (111188, "re.al"), + (112358, "meta_one"), + (119139, "metadap_enterprise_testnet"), + (123321, "gem"), + (123456, "adil_devnet"), + (128123, "etherlink_testnet"), + (131313, "odyssey_testnet"), + (131419, "etnds"), + (132902, "form_testnet"), + (141319, "magape_testnet"), + (142857, "icplaza"), + (161212, "playfi"), + (165279, "eclat"), + (167000, "taiko"), + (167004, "taiko_alpha_2_testnet"), + (167005, "taiko_grimsvotn_l2"), + (167006, "taiko_eldfell_l3"), + (167007, "taiko_jolnir_l2"), + (167008, "taiko_katla_l2"), + (167009, "taiko_hekla_l2"), + (168168, "zs"), + (171000, "fair_testnet"), + (175177, "chronicle_lit_protocol_testnet"), + (175188, "chronicle_yellowstone_lit_protocol_testnet"), + (188710, "bitica"), + (188881, "condor_test"), + (199991, "mazze_testnet"), + (200000, "xfair.ai_testnet"), + (200101, "milkomeda_c1_testnet"), + (200202, "milkomeda_a1_testnet"), + (200625, "akroma"), + (200810, "bitlayer_testnet"), + (200901, "bitlayer"), + (201018, "alaya"), + (201030, "alaya_dev_testnet"), + (201804, "mythical"), + (202020, "decimal_testnet"), + (202105, "duck_testnet"), + (202202, "bethel_sydney"), + (202212, "x1_devnet"), + (202401, "ymtech_besu_testnet"), + (202624, "jellie"), + (204005, "x1_network"), + (205205, "auroria_testnet"), + (210049, "gitagi_atlas_testnet"), + (210425, "platon"), + (212013, "litentry"), + (220315, "mas"), + (221230, "reap"), + (221231, "reap_testnet"), + (222222, "hydradx"), + (222555, "deepl"), + (222666, "deepl_testnet"), + (224168, "taf_eco"), + (224422, "conet_sebolia_testnet"), + (224433, "conet_holesky"), + (229772, "abyss_protocol"), + (230315, "hashkey_testnetdiscard"), + (234666, "haymo_testnet"), + (240515, "orange_testnet"), + (246529, "artis_sigma1"), + (246785, "artis_testnet_tau1"), + (247253, "saakuru_testnet"), + (256256, "cmp"), + (262371, "eclat_testnet"), + (266256, "gear_zero_testnet"), + (271271, "egoncoin_testnet"), + (281121, "social"), + (282828, "zillion_sepolia_testnet"), + (292003, "cipherem_testnet"), + (309075, "one_world"), + (313313, "saharaai_testnet"), + (314159, "filecoin_calibration_testnet"), + (322202, "parex"), + (323213, "bloom_genesis_testnet"), + (327126, "waba_testnet"), + (328527, "nal"), + (330844, "ttcoin"), + (333313, "bloom_genesis"), + (333331, "aves_testnet"), + (333333, "nativ3_testnet"), + (333666, "oone_testnet"), + (333777, "oone_devnet"), + (333888, "polis_testnet"), + (333999, "polis"), + (336655, "up_testnet"), + (336666, "up"), + (355110, "bitfinity"), + (355113, "bitfinity_testnet"), + (360890, "lavita"), + (363636, "digit_soul_2"), + (373737, "hap_testnet"), + (381931, "metal_c"), + (381932, "metal_tahoe_c"), + (404040, "tipboxcoin"), + (413413, "aie_testnet"), + (420420, "kek"), + (420666, "kek_kektest"), + (420692, "alterium_l2_testnet"), + (421611, "arbitrum_rinkeby"), + (421613, "arbitrum_goerli"), + (421614, "arbitrum_sepolia"), + (424242, "fastex_testnet"), + (431140, "markr_go"), + (432201, "dexalot_subnet_testnet"), + (432204, "dexalot_subnet"), + (444444, "syndr_l3_sepolia"), + (444900, "weelink_testnet"), + (471100, "patex_sepolia_testnet"), + (473861, "ultra_pro"), + (474142, "open"), + (486487, "gobbl_testnet"), + (490000, "autonomys_testnet_nova_domain"), + (504441, "playdapp"), + (512512, "cmp_testnet"), + (513100, "dis"), + (526916, "docoin_community"), + (534351, "scroll_sepolia_testnet"), + (534352, "scroll"), + (534353, "scroll_alpha_testnet"), + (534354, "scroll_pre_alpha_testnet"), + (534849, "shinarium_beta"), + (535037, "beaneco_smart"), + (541764, "overprotocol_testnet"), + (552981, "one_world_testnet"), + (555555, "pentagon_testnet"), + (555666, "eclipse_testnet"), + (555888, "dustboy_iot"), + (622277, "hypra"), + (622463, "atlas"), + (641230, "bear"), + (651940, "all"), + (656476, "open_campus_codex"), + (660279, "xai"), + (666666, "vision_vpioneer_test"), + (666888, "hela_official_runtime_testnet"), + (686868, "won"), + (696969, "galadriel_devnet"), + (710420, "tiltyard_subnet"), + (713715, "sei_devnet"), + (721529, "eram"), + (723107, "tix_testnet"), + (743111, "hemi_sepolia"), + (751230, "bear_testnet"), + (752024, "ternoa_testnet"), + (761412, "miexs_smart"), + (764984, "lamina1_testnet"), + (767368, "lamina1_identity_testnet"), + (776877, "modularium"), + (800001, "octaspace"), + (808080, "biz_testnet"), + (808813, "bob_sepolia"), + (810180, "zklink_nova"), + (810181, "zklink_nova_sepolia_testnet"), + (810182, "zklink_nova_goerli_testnet"), + (812397, "sg_verse"), + (820522, "tsc_testnet"), + (827431, "curve"), + (839320, "prm_testnet"), + (840000, "runevm_testnet"), + (846000, "4goodnetwork"), + (855456, "dodao"), + (879151, "blocx"), + (888882, "rexx"), + (888888, "vision"), + (900000, "posi_shard_0"), + (910000, "posi_testnet_shard_0"), + (912559, "astria_evm_dusknet"), + (920000, "posi_devnet_shard_0"), + (920001, "posi_devnet_shard_1"), + (923018, "fncy_testnet"), + (955081, "jono12_subnet"), + (955305, "eluvio_content_fabric"), + (978657, "treasure_ruby"), + (984122, "forma"), + (984123, "forma_sketchpad"), + (988207, "ecrox"), + (998899, "supernet_testnet"), + (999999, "am"), + (1100789, "netmind_testnet"), + (1234567, "sharecle"), + (1261120, "zkatana"), + (1313114, "etho_protocol"), + (1313500, "xerom"), + (1337702, "kintsugi"), + (1337802, "kiln"), + (1337803, "zhejiang"), + (1398243, "automata_testnet"), + (1398244, "automata_orbit_testnet"), + (1612127, "playfi_albireo_testnet"), + (1637450, "xterio_testnet"), + (1731313, "turkey_demo_dev"), + (2021398, "debank_testnet"), + (2099156, "plian_main"), + (2206132, "platon_dev_testnet2"), + (2611555, "dpu"), + (2702128, "xterio"), + (3132023, "saharaai"), + (3141592, "filecoin_butterfly_testnet"), + (3397901, "funki_sepolia_sandbox"), + (3441005, "manta_pacific_testnet"), + (3441006, "manta_pacific_sepolia_testnet"), + (4000003, "altlayer_zero_gas"), + (4281033, "worlds_caldera"), + (4444444, "altar_testnet"), + (4457845, "zero_testnet_sepolia"), + (5112023, "numblock"), + (5167003, "mxc_wannsee_zkevm_testnet"), + (5167004, "moon_geneva_testnet"), + (5201420, "electroneum_testnet"), + (5318008, "reactive_kopli"), + (5555555, "imversed"), + (5555558, "imversed_testnet"), + (6038361, "astar_zkyoto"), + (6666665, "safeanwang"), + (6666666, "safeanwang_testnet"), + (7082400, "coti_testnet"), + (7225878, "saakuru"), + (7355310, "openvessel"), + (7668378, "ql1_testnet"), + (7762959, "musicoin"), + (7777777, "zora"), + (8007736, "plian_sub_1"), + (8008135, "fhenix_helium"), + (8080808, "hokum"), + (8601152, "waterfall_8_test"), + (8794598, "hap"), + (8888881, "quarix_testnet"), + (8888888, "quarix"), + (9322252, "xcap"), + (9322253, "milvine"), + (9999999, "fluence"), + (10067275, "plian_testnet_sub_1"), + (10101010, "soverun"), + (10241024, "alienx"), + (10241025, "alienx_hal_testnet"), + (11145513, "blessnet_sepolia"), + (11155111, "sepolia"), + (11155420, "op_sepolia_testnet"), + (12052024, "memento_testnet"), + (12227331, "neox_testnet_t3"), + (12227332, "neo_x_testnet_t4"), + (13068200, "coti_devnet"), + (13371337, "pep_churchill"), + (14288640, "andus"), + (16658437, "plian_testnet_main"), + (18071918, "mande"), + (18289463, "iolite"), + (19850818, "deepbrain_testnet"), + (19880818, "deepbrain"), + (20180427, "stability_testnet"), + (20180430, "smartmesh"), + (20181205, "quarkblock"), + (20201022, "pego"), + (20230825, "vcity_testnet"), + (20240324, "debank_sepolia_testnet"), + (20240603, "dbk"), + (20241133, "swan_proxima_testnet"), + (20482050, "hokum_testnet"), + (22052002, "excelon"), + (24772477, "6degree_of_outreach_testnet"), + (27082017, "excoincial_volta_testnet"), + (27082022, "excoincial"), + (28122024, "ancient8_testnet"), + (28945486, "auxilium"), + (29032022, "fla"), + (31415926, "filecoin_local_testnet"), + (33626250, "toliman_suave_testnet"), + (35855456, "joys_digital"), + (37084624, "skale_nebula_hub_testnet"), + (39916801, "kingdom"), + (43214913, "maistestsubnet"), + (52164803, "fluence_testnet"), + (61717561, "aqua"), + (65010000, "autonity_bakerloo_thames_testnet"), + (65010001, "autonity_bakerloo_barada_testnet"), + (65010002, "autonity_bakerloo_sumida_testnet"), + (65010003, "autonity_bakerloo_yamuna_testnet"), + (65100000, "autonity_piccadilly_thames_testnet"), + (65100001, "autonity_piccadilly_barada_testnet"), + (65100002, "autonity_piccadilly_sumida_testnet"), + (65100003, "autonity_piccadilly_yamuna_testnet"), + (68840142, "frame_testnet"), + (77787778, "0xhash_testnet"), + (79479957, "sx_toronto_rollup"), + (88558801, "backstop_testnet"), + (88888888, "t.e.a.m_block"), + (94204209, "polygon_blackberry"), + (99415706, "joys_digital_testnet"), + (100000000, "ethos"), + (108160679, "orai"), + (111557560, "cyber_testnet"), + (123420111, "op_celestia_raspberry"), + (161221135, "plume_testnet"), + (168587773, "blast_sepolia_testnet"), + (192837465, "gather"), + (222000222, "kanazawa"), + (245022926, "neon_evm_devnet"), + (245022929, "neon_evm_devnet_rollup"), + (245022934, "neon_evm"), + (245022940, "neon_evm_testnet"), + (278611351, "razor_skale"), + (311752642, "oneledger"), + (328527624, "nal_sepolia_testnet"), + (333000333, "meld"), + (356256156, "gather_testnet"), + (476462898, "skopje_testnet"), + (486217935, "gather_devnet"), + (531050104, "sophon_testnet"), + (666666666, "degen"), + (728126428, "tron"), + (888888888, "ancient8"), + (889910245, "ptcescan_testnet"), + (889910246, "ptcescan"), + (974399131, "skale_calypso_hub_testnet"), + (999999999, "zora_sepolia_testnet"), + (1020352220, "skale_titan_hub_testnet"), + (1122334455, "ipos"), + (1146703430, "cyberdecknet"), + (1273227453, "human_protocol"), + (1313161554, "aurora"), + (1313161555, "aurora_testnet"), + (1313161556, "aurora_betanet"), + (1313161560, "powergold"), + (1350216234, "skale_titan_hub"), + (1351057110, "chaos_skale_testnet"), + (1380012617, "rari"), + (1380996178, "raptor"), + (1444673419, "skale_europa_hub_testnet"), + (1482601649, "skale_nebula_hub"), + (1511670449, "gpt"), + (1564830818, "skale_calypso_hub"), + (1666600000, "harmony_shard_0"), + (1666600001, "harmony_shard_1"), + (1666600002, "harmony_shard_2"), + (1666600003, "harmony_shard_3"), + (1666700000, "harmony_testnet_shard_0"), + (1666700001, "harmony_testnet_shard_1"), + (1666900000, "harmony_devnet_shard_0"), + (1666900001, "harmony_devnet_shard_1"), + (1722641160, "silicon_zkevm_sepolia_testnet"), + (1802203764, "kakarot_sepolia"), + (1903648807, "gemu_testnet"), + (1918988905, "rari_testnet"), + (2021121117, "datahopper"), + (2046399126, "skale_europa_hub"), + (3125659152, "pirl"), + (4216137055, "oneledger_testnet_frankenstein"), + (11297108099, "palm_testnet"), + (28872323069, "gitswarm_test"), + (37714555429, "xai_testnet_v2"), + (88153591557, "arbitrum_blueberry"), + (111222333444, "alphabet"), + (111551119090, "thanos_sepolia"), + (123420000220, "fluence_stage"), + (197710212030, "ntity"), + (197710212031, "haradev_testnet"), + (202402181627, "gm_testnet"), + (383414847825, "zeniq"), + (666301171999, "pdc"), + (6022140761023, "molereum"), + (2713017997578000, "d_testnet"), +]; diff --git a/rust/crates/mesc/src/overrides.rs b/rust/crates/mesc/src/overrides.rs index a79b740..9f0997b 100644 --- a/rust/crates/mesc/src/overrides.rs +++ b/rust/crates/mesc/src/overrides.rs @@ -1,6 +1,20 @@ use crate::{ChainId, Endpoint, MescError, Profile, RpcConfig, TryIntoChainId}; use std::collections::HashMap; +/// get active overrides +pub fn get_active_overrides() -> Vec { + let overrides = [ + "MESC_NETWORK_NAMES", + "MESC_NETWORK_DEFAULTS", + "MESC_ENDPOINTS", + "MESC_DEFAULT_ENDPOINT", + "MESC_GLOBAL_METADATA", + "MESC_ENDPOINT_METADATA", + "MESC_PROFILES", + ]; + overrides.iter().filter_map(|v| std::env::var(v).ok()).collect() +} + /// apply overrides to config pub fn apply_overrides(config: &mut RpcConfig) -> Result<(), MescError> { if let Some(default_endpoint) = get_default_endpoint_override() { @@ -58,8 +72,7 @@ fn get_network_defaults_override() -> Result>, M for piece in raw.split(' ') { match piece.split('=').collect::>().as_slice() { [chain_id, endpoint] => { - network_defaults - .insert((chain_id.to_string()).try_into_chain_id()?, endpoint.to_string()); + network_defaults.insert(chain_id.try_into_chain_id()?, endpoint.to_string()); } _ => { return Err(MescError::OverrideError( @@ -83,8 +96,7 @@ fn get_network_names_override() -> Result>, Mesc for piece in raw.split(' ') { match piece.split('=').collect::>().as_slice() { [name, chain_id] => { - network_names - .insert(name.to_string(), (chain_id.to_string()).try_into_chain_id()?); + network_names.insert(name.to_string(), chain_id.try_into_chain_id()?); } _ => { return Err(MescError::OverrideError( @@ -176,7 +188,7 @@ pub fn get_default_endpoint_name(url: &str, chain_id: Option) -> Option if let Some(split) = hostname.split('.').last() { split.to_string() } else { hostname }; match chain_id { - Some(chain_id) => Some(format!("{}_{}", hostname, chain_id.as_str())), + Some(chain_id) => Some(format!("{hostname}_{chain_id}")), None => Some(hostname), } } diff --git a/rust/crates/mesc/src/query.rs b/rust/crates/mesc/src/query.rs index f6b8af9..8dd61f5 100644 --- a/rust/crates/mesc/src/query.rs +++ b/rust/crates/mesc/src/query.rs @@ -10,11 +10,15 @@ pub fn get_default_endpoint( config: &RpcConfig, profile: Option<&str>, ) -> Result, MescError> { - // if using a profile, check if that profile has a default endpoint for chain_id + // if using a profile, check if that profile has a default endpoint if let Some(profile) = profile { - let name = config.profiles.get(profile).and_then(|p| p.default_endpoint.clone()); - if let Some(name) = name { - return get_endpoint_by_name(config, name.as_str()) + if let Some(profile_data) = config.profiles.get(profile) { + if !profile_data.use_mesc { + return Ok(None); + } + if let Some(endpoint_name) = profile_data.default_endpoint.as_deref() { + return get_endpoint_by_name(config, endpoint_name); + } } }; @@ -25,7 +29,7 @@ pub fn get_default_endpoint( } /// get endpoint by network -pub fn get_endpoint_by_network( +pub fn get_endpoint_by_network( config: &RpcConfig, chain_id: T, profile: Option<&str>, @@ -34,15 +38,19 @@ pub fn get_endpoint_by_network( // if using a profile, check if that profile has a default endpoint for chain_id if let Some(profile) = profile { - let name = config.profiles.get(profile).and_then(|p| p.network_defaults.get(&chain_id)); - if let Some(name) = name { - return get_endpoint_by_name(config, name) + if let Some(profile_data) = config.profiles.get(profile) { + if !profile_data.use_mesc { + return Ok(None); + } + if let Some(endpoint_name) = profile_data.network_defaults.get(&chain_id) { + return get_endpoint_by_name(config, endpoint_name); + } } }; // check if base configuration has a default endpoint for that chain_id match config.network_defaults.get(&chain_id) { - Some(name) => get_endpoint_by_name(config, name), + Some(name) => get_endpoint_by_name(config, name.as_str()), None => Ok(None), } } @@ -62,6 +70,14 @@ pub fn get_endpoint_by_query( query: &str, profile: Option<&str>, ) -> Result, MescError> { + if let Some(profile) = profile { + if let Some(profile_data) = config.profiles.get(profile) { + if !profile_data.use_mesc { + return Ok(None); + } + } + } + // by endpoint name if let Some(endpoint) = config.endpoints.get(query) { return Ok(Some(endpoint.clone())); @@ -92,7 +108,7 @@ pub fn find_endpoints( let mut candidates: Vec = config.endpoints.clone().into_values().collect(); if let Some(chain_id) = query.chain_id { - candidates.retain(|endpoint| endpoint.chain_id.as_ref() == Some(&chain_id)) + candidates.retain(|endpoint| endpoint.chain_id.as_ref() == Some(&chain_id)); } if let Some(name) = query.name_contains { @@ -109,6 +125,19 @@ pub fn find_endpoints( /// get global metadata pub fn get_global_metadata( config: &RpcConfig, + profile: Option<&str>, ) -> Result, MescError> { - Ok(config.global_metadata.clone()) + let mut metadata = config.global_metadata.clone(); + + // load profile metadata + if let Some(profile) = profile { + if let Some(profile_data) = config.profiles.get(profile) { + if !profile_data.use_mesc { + return Ok(HashMap::new()); + } + metadata.extend(profile_data.profile_metadata.clone()) + } + } + + Ok(metadata) } diff --git a/rust/crates/mesc/src/types/chain_ids.rs b/rust/crates/mesc/src/types/chain_ids.rs index 6b0c4be..3123068 100644 --- a/rust/crates/mesc/src/types/chain_ids.rs +++ b/rust/crates/mesc/src/types/chain_ids.rs @@ -3,68 +3,42 @@ use serde::{Deserialize, Serialize}; /// ChainId is a string representation of an integer chain id /// - TryFrom conversions allow specifying as String, &str, uint, or binary data -#[derive(Serialize, Deserialize, Debug, Clone, Eq, PartialEq, Hash)] -pub struct ChainId(String); +#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize)] +#[serde(into = "ChainIdSerde", try_from = "ChainIdSerde")] +pub struct ChainId(u64); impl ChainId { + /// create new chain id + pub fn new(chain_id: u64) -> ChainId { + ChainId(chain_id) + } + + /// parse chain id from string + pub fn parse(chain_id: &str) -> Result { + chain_id.try_into_chain_id() + } + + /// get chain id value + pub fn get(&self) -> u64 { + self.0 + } + /// convert to hex representation - pub fn to_hex(&self) -> Result { + pub fn to_hex(&self) -> String { let ChainId(chain_id) = self; - if chain_id.starts_with("0x") { - Ok(chain_id.clone()) - } else { - match chain_id.parse::() { - Ok(number) => Ok(format!("0x{:x}", number)), - Err(_) => Err(MescError::IntegrityError("bad chain_id".to_string())), - } - } + format!("{chain_id:#x}") } /// convert to hex representation, zero-padded to 256 bits - pub fn to_hex_256(&self) -> Result { + pub fn to_hex_256(&self) -> String { let ChainId(chain_id) = self; - if chain_id.starts_with("0x") { - Ok(chain_id.clone()) - } else { - match chain_id.parse::() { - Ok(number) => Ok(format!("0x{:016x}", number)), - Err(_) => Err(MescError::IntegrityError("bad chain_id".to_string())), - } - } - } - - /// return chain_id as &str - pub fn as_str(&self) -> &str { - let ChainId(chain_id) = self; - chain_id.as_str() - } -} - -impl PartialOrd for ChainId { - fn partial_cmp(&self, other: &Self) -> Option { - Some(self.cmp(other)) - } -} - -impl Ord for ChainId { - fn cmp(&self, other: &Self) -> std::cmp::Ordering { - let self_string: String = match self.to_hex() { - Ok(s) => s[2..].to_string(), - Err(_) => return std::cmp::Ordering::Greater, - }; - let other_string = match other.to_hex() { - Ok(s) => s[2..].to_string(), - Err(_) => return std::cmp::Ordering::Greater, - }; - let self_str = format!("{:>079}", self_string); - let other_str = format!("{:>079}", other_string); - self_str.cmp(&other_str) + format!("0x{chain_id:064x}") } } impl std::fmt::Display for ChainId { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { - write!(f, "{}", self.0) + self.0.fmt(f) } } @@ -73,14 +47,14 @@ macro_rules! impl_from_uint_for_chainid { $( impl From<$t> for ChainId { fn from(value: $t) -> ChainId { - ChainId(value.to_string()) + ChainId(value as _) } } )* }; } -impl_from_uint_for_chainid!(u8, u16, u32, u64, u128, usize); +impl_from_uint_for_chainid!(u8, u16, u32, u64, usize); /// use custom trait instead of TryInto so that Error type is always the same pub trait TryIntoChainId { @@ -96,21 +70,22 @@ impl TryIntoChainId for ChainId { impl TryIntoChainId for String { fn try_into_chain_id(self) -> Result { - if !self.is_empty() && self.chars().all(|c| c.is_ascii_digit()) { - Ok(ChainId(self)) - } else { - Err(MescError::InvalidChainId(self)) - } + self.as_str().try_into_chain_id() } } impl TryIntoChainId for &str { fn try_into_chain_id(self) -> Result { - if self.chars().all(|c| c.is_ascii_digit()) { - Ok(ChainId(self.to_string())) - } else { - Err(MescError::InvalidChainId(self.to_string())) + if !self.is_empty() { + let (radix, s) = match self.get(0..2) { + Some("0x") => (16, &self[2..]), + _ => (10, self), + }; + if let Ok(chain_id) = u64::from_str_radix(s, radix) { + return Ok(ChainId(chain_id)); + } } + Err(MescError::InvalidChainId(self.to_string())) } } @@ -119,17 +94,34 @@ macro_rules! impl_try_into_chain_id_for_integer { $( impl TryIntoChainId for $t { fn try_into_chain_id(self) -> Result { - Ok(ChainId(self.to_string())) + Ok(ChainId::from(self)) } } )* }; } -impl_try_into_chain_id_for_integer!(u8, u16, u32, u64, u128, usize); +impl_try_into_chain_id_for_integer!(u8, u16, u32, u64, usize); impl TryIntoChainId for &[u8] { fn try_into_chain_id(self) -> Result { Err(MescError::NotImplemented("binary chain_id".to_string())) } } + +#[derive(Serialize, Deserialize)] +struct ChainIdSerde(String); + +impl From for ChainIdSerde { + fn from(chain_id: ChainId) -> ChainIdSerde { + ChainIdSerde(chain_id.to_string()) + } +} + +impl TryFrom for ChainId { + type Error = MescError; + + fn try_from(value: ChainIdSerde) -> Result { + value.0.try_into_chain_id() + } +} diff --git a/rust/crates/mesc/src/types/errors.rs b/rust/crates/mesc/src/types/errors.rs index 4ed9312..a5f2f3c 100644 --- a/rust/crates/mesc/src/types/errors.rs +++ b/rust/crates/mesc/src/types/errors.rs @@ -23,6 +23,14 @@ pub enum MescError { #[error("Missing endpoint: {0}")] MissingEndpoint(String), + /// Error for missing invalid path + #[error("Invalid path: {0}")] + InvalidPath(String), + + /// Error for missing config file + #[error("Missing config file: {0}")] + MissingConfigFile(String), + /// Error wrapper for standard IO errors. #[error(transparent)] IOError(#[from] std::io::Error), diff --git a/rust/crates/mesc/src/types/queries.rs b/rust/crates/mesc/src/types/queries.rs index e5dddeb..866bbda 100644 --- a/rust/crates/mesc/src/types/queries.rs +++ b/rust/crates/mesc/src/types/queries.rs @@ -115,6 +115,8 @@ pub struct UserInputQuery { /// GlobalMetadataQuery #[derive(Debug, Clone)] pub struct GlobalMetadataQuery { + /// profile + pub profile: Option, /// path pub path: Option>, } diff --git a/rust/crates/mesc/src/validate.rs b/rust/crates/mesc/src/validate.rs index 52b4d19..c5dc9ec 100644 --- a/rust/crates/mesc/src/validate.rs +++ b/rust/crates/mesc/src/validate.rs @@ -1,5 +1,4 @@ use crate::{MescError, RpcConfig}; -use std::collections::HashSet; pub(crate) fn validate_config(config: &RpcConfig) -> Result<(), MescError> { // referenced endpoints exist @@ -70,29 +69,5 @@ pub(crate) fn validate_config(config: &RpcConfig) -> Result<(), MescError> { } } - // chain_id's are valid - for network in config.network_defaults.keys() { - network.to_hex()?; - } - for profile in config.profiles.values() { - for network in profile.network_defaults.keys() { - network.to_hex()?; - } - } - for endpoint in config.endpoints.values() { - if let Some(chain_id) = endpoint.chain_id.as_ref() { - chain_id.to_hex()?; - } - } - - // no duplicate default network entries using decimal vs hex - let hex_networks: Result, MescError> = - config.network_defaults.keys().map(|c| c.to_hex()).collect(); - if hex_networks?.len() != config.network_defaults.len() { - return Err(MescError::IntegrityError( - "colliding network defaults using decimal vs hex".to_string(), - )); - } - Ok(()) } diff --git a/rust/crates/mesc/src/write.rs b/rust/crates/mesc/src/write.rs index 867c875..8ecc328 100644 --- a/rust/crates/mesc/src/write.rs +++ b/rust/crates/mesc/src/write.rs @@ -1,15 +1,17 @@ use crate::{MescError, RpcConfig, TryIntoChainId}; -use std::fs::File; +use std::{fs::File, path::Path}; /// write config to file -pub fn write_config(config: RpcConfig, path: String) -> Result<(), MescError> { - if let Some(parent) = std::path::Path::new(&path).parent() { +pub fn write_config>(config: RpcConfig, path: P) -> Result<(), MescError> { + let path_ref = path.as_ref(); + + if let Some(parent) = path_ref.parent() { if !parent.exists() { - std::fs::create_dir_all(&path)? + std::fs::create_dir_all(parent)? }; } - let file = File::create(path)?; + let file = File::create(path_ref)?; Ok(serde_json::to_writer_pretty(file, &config)?) } diff --git a/rust/crates/mesc_cli/Cargo.toml b/rust/crates/mesc_cli/Cargo.toml index 4245bfc..ef419b7 100644 --- a/rust/crates/mesc_cli/Cargo.toml +++ b/rust/crates/mesc_cli/Cargo.toml @@ -4,7 +4,6 @@ description = "command line interface for creating, loading, and modifying MESC version.workspace = true edition.workspace = true license.workspace = true -homepage.workspace = true repository.workspace = true [[bin]] @@ -14,16 +13,16 @@ path = "src/main.rs" [dependencies] bat = "0.24.0" clap = { version = "4.4.8", features = ["derive"] } -colored_json = "4.1.0" +colored_json = "5" edit = "0.1.4" futures = "0.3.29" -inquire = "0.6.2" +inquire = "0.7" ipgeolocate = "0.3.6" -mesc = { version = "0.1.4", path = "../mesc" } -reqwest = { version = "0.11.22", features = ["json"] } +mesc = { version = "0.3.0", path = "../mesc" } +reqwest = { version = "0.11", features = ["json"] } serde = { workspace = true } serde_json = { workspace = true } thiserror = { workspace = true } tokio = { version = "1.32.0", features = ["full"] } -toolstr = { version = "0.1.3", path = "../../../../toolstr/toolstr-rust/crates/toolstr" } +toolstr = { version = "0.1.3" } url = "2.2.2" diff --git a/rust/crates/mesc_cli/src/cli/args.rs b/rust/crates/mesc_cli/src/cli/args.rs index e1d3c1b..7cbcee8 100644 --- a/rust/crates/mesc_cli/src/cli/args.rs +++ b/rust/crates/mesc_cli/src/cli/args.rs @@ -7,6 +7,7 @@ pub(crate) async fn run_cli() -> Result<(), MescCliError> { match Cli::parse().command { Commands::Setup(args) => setup_command(args).await, Commands::Import(args) => import_command(args).await, + Commands::Set(args) => set_command(args).await, Commands::Status(args) => status_command(args), Commands::Ls(args) => ls_command(args), Commands::Defaults(args) => defaults_command(args), @@ -43,26 +44,30 @@ pub(crate) struct Cli { /// Define your subcommands as an enum #[derive(Subcommand)] pub(crate) enum Commands { - /// Create new config or modify existing config + /// Create or modify config interactively Setup(SetupArgs), - /// Import a config from file or external source + /// Modify config by importing from file or other source Import(ImportArgs), - /// Print status of configuration - Status(StatusArgs), - /// Print list of endpoints - Ls(LsArgs), - /// Print list of defaults - Defaults(DefaultsArgs), + /// Modify config by setting specific values + /// + /// This command is idempotent + Set(SetArgs), /// Ping endpoints and fetch metadata Ping(PingArgs), + /// Print list of defaults + Defaults(DefaultsArgs), /// Print endpoint Endpoint(EndpointArgs), - /// Print metadata - Metadata(MetadataArgs), - /// Print endpoint URL - Url(UrlArgs), /// Print help Help(HelpArgs), + /// Print list of endpoints + Ls(LsArgs), + /// Print metadata + Metadata(MetadataArgs), + /// Print status of configuration + Status(StatusArgs), + /// Print endpoint URL + Url(UrlArgs), } /// Arguments for the `setup` subcommand @@ -105,6 +110,34 @@ pub(crate) struct ImportArgs { pub(crate) output_path: Option, } +/// Arguments for the `set` subcommand +#[derive(Parser)] +pub(crate) struct SetArgs { + /// key to set + #[clap()] + pub(crate) key: Option, + + /// value to set + #[clap()] + pub(crate) value: Option, + + /// space-separated list of keys + #[clap(long)] + pub(crate) keys: Option>, + + /// space-separated list of values (must match --keys) + #[clap(long)] + pub(crate) values: Option>, + + /// delete specified key(s) instead of setting them + #[clap(long)] + pub(crate) delete: bool, + + /// config path to use [default: MESC_PATH] + #[clap(long)] + pub(crate) path: Option, +} + /// Arguments for the `status` subcommand #[derive(Parser)] pub(crate) struct StatusArgs { @@ -212,7 +245,19 @@ pub(crate) struct EndpointArgs { /// Arguments for the `metadata` subcommand #[derive(Parser)] -pub(crate) struct MetadataArgs {} +pub(crate) struct MetadataArgs { + /// print metadata of endpoint + #[clap(long)] + pub(crate) endpoint: Option, + + /// print metadata of profile merged with global metadata + #[clap(long)] + pub(crate) profile: Option, + + /// print metadata of profile not merged with global metadata + #[clap(long)] + pub(crate) profile_only: Option, +} /// Arguments for the `url` subcommand #[derive(Parser)] diff --git a/rust/crates/mesc_cli/src/cli/subcommands/help.rs b/rust/crates/mesc_cli/src/cli/subcommands/help.rs index 0cfac39..37f1a92 100644 --- a/rust/crates/mesc_cli/src/cli/subcommands/help.rs +++ b/rust/crates/mesc_cli/src/cli/subcommands/help.rs @@ -9,6 +9,7 @@ pub(crate) fn help_command(args: HelpArgs) -> Result<(), MescCliError> { "python" => print_python_interface(), "rust" => print_rust_interface(), "schema" => print_schema()?, + "setup" => print_setup_help(), _ => println!("Unknown help topic: {}", topic), }, None => Cli::command().print_help().map_err(|e| { @@ -19,15 +20,50 @@ pub(crate) fn help_command(args: HelpArgs) -> Result<(), MescCliError> { Ok(()) } +fn print_help_topic(topic: &str) -> Result<(), MescCliError> { + match topic { + "env" => print_env_help(), + "python" => print_python_interface(), + "rust" => print_rust_interface(), + "schema" => print_schema()?, + "setup" => print_setup_help(), + _ => println!("Unknown help topic: {}", topic), + } + Ok(()) +} + pub(crate) fn get_help_topics() -> Vec<(String, String)> { vec![ - ("env".to_string(), "Description of environmental variables".to_string()), - ("python".to_string(), "Print python interface".to_string()), - ("rust".to_string(), "Print rust interface".to_string()), + ("env".to_string(), "Environmental variables".to_string()), + ("python".to_string(), "Python interface".to_string()), + ("rust".to_string(), "Rust interface".to_string()), ("schema".to_string(), "Schemas of configs, endpoints, and profiles".to_string()), + ("setup".to_string(), "How to set up MESC".to_string()), ] } +pub(crate) fn print_interactive_help() -> Result<(), MescCliError> { + println!(); + print_setup_help(); + println!(); + let topics = get_help_topics(); + let mut options: Vec<_> = topics.iter().map(|(t, _)| t.as_str()).collect(); + options.push("Return to main menu"); + loop { + let prompt = "Print help about other MESC topics?"; + match inquire::Select::new(prompt, options.clone()).prompt() { + Ok("Return to main menu") => return Ok(()), + Ok(topic) => { + println!(); + print_help_topic(topic)?; + println!() + } + Err(inquire::InquireError::OperationCanceled) => return Ok(()), + Err(e) => return Err(e.into()), + } + } +} + fn print_env_help() { let messages = vec![ ( @@ -105,7 +141,8 @@ fn print_code(content: String, filetype: &str) { } fn print_python_interface() { - let interface = r#"import mesc + let interface = r#"from typing import Any, Mapping, Sequence +import mesc # check whether mesc is enabled enabled: bool = mesc.is_mesc_enabled() @@ -130,40 +167,51 @@ endpoint: Endpoint | None = mesc.get_endpoint_by_name('local_goerli') endpoint: Endpoint | None = mesc.get_endpoint_by_query(user_str, profile='xyz_tool') # find all endpoints matching given criteria -endpoints: list[Endpoint] = mesc.find_endpoints(chain_id=5)"#; +endpoints: Sequence[Endpoint] = mesc.find_endpoints(chain_id=5) + +# get non-endpoint metadata +metadata: Mapping[str, Any] = mesc.get_global_metadata(profile='xyz_tool')"#; print_code(interface.to_string(), "py") } fn print_rust_interface() { - let interface = r#"use mesc; -use mesc::MescError; + let interface = r#"use mesc::{MescError, Endpoint}; +use std::collections::HashMap; type OptionalResult = Result, MescError>; type MultiResult = Result, MescError>; +type MetadataResult = Result, MescError>; + +// check whether mesc is enabled +let enabled: bool = mesc::is_mesc_enabled(); // get the default endpoint let endpoint: OptionalResult = mesc::get_default_endpoint(None); // get the default endpoint of a network -let endpoint: OptionalResult = mesc::get_endpoint_by_network(5, None); +let endpoint: OptionalResult = mesc::get_endpoint_by_network("5", None); // get the default network for a particular tool -let chain_id: OptionalResult = mesc::get_default_endpoint("xyz_tool"); +let chain_id: OptionalResult = mesc::get_default_endpoint(Some("xyz_tool")); // get the default endpoint of a network for a particular tool -let endpoint: OptionalResult = mesc::get_endpoint_by_network(5, "xyz_tool"); +let endpoint: OptionalResult = mesc::get_endpoint_by_network("5", Some("xyz_tool")); // get an endpoint by name -let endpoint: OptionalResult = mesc::get_endpoint_by_name("local_query"); +let endpoint: OptionalResult = mesc::get_endpoint_by_name("local_goerli"); // parse a user-provided string into a matching endpoint // (first try 1. endpoint name, then 2. chain id, then 3. network name) -let endpoint: OptionalResult = mesc::get_endpoint_by_query(user_str, "xyz_tool"); +let user_str = "local_goerli"; +let endpoint: OptionalResult = mesc::get_endpoint_by_query(user_str, Some("xyz_tool")); // find all endpoints matching given criteria -let query = mesc::MultiEndpointQuery::new().chain_id(5); -let endpoints: MultiResult = mesc::find_endpoints(query);"#; +let query = mesc::MultiEndpointQuery::new().chain_id("5").unwrap(); +let endpoints: MultiResult = mesc::find_endpoints(query); + +// get non-endpoint metadata +let metadata: MetadataResult = mesc::get_global_metadata(Some("xyz_tool"));"#; print_code(interface.to_string(), "rs") } @@ -298,3 +346,19 @@ fn print_schema() -> Result<(), MescCliError> { Ok(()) } + +fn print_setup_help() { + println!( + r#"A basic MESC setup requires two steps: +1. create a {} configuration file +2. set the {} environment variable to the path of this file + +The {} command can interactively perform both steps + +{} can also be used to create and modify configuration data"#, + "mesc.json".white().bold(), + "MESC_PATH".white().bold(), + "mesc setup".white().bold(), + "mesc setup".white().bold() + ) +} diff --git a/rust/crates/mesc_cli/src/cli/subcommands/import.rs b/rust/crates/mesc_cli/src/cli/subcommands/import.rs index 4c6a3c0..b56c530 100644 --- a/rust/crates/mesc_cli/src/cli/subcommands/import.rs +++ b/rust/crates/mesc_cli/src/cli/subcommands/import.rs @@ -1,7 +1,12 @@ use crate::{ImportArgs, MescCliError}; use mesc::RpcConfig; +#[allow(unreachable_code)] +#[allow(unused_variables)] pub(crate) async fn import_command(args: ImportArgs) -> Result<(), MescCliError> { + println!("import command under construction, try again later"); + return Ok(()); + // get output path let output_path = match (args.output_path, std::env::var("MESC_PATH")) { (Some(path), _) => path, diff --git a/rust/crates/mesc_cli/src/cli/subcommands/metadata.rs b/rust/crates/mesc_cli/src/cli/subcommands/metadata.rs index c14bd41..fda0f5b 100644 --- a/rust/crates/mesc_cli/src/cli/subcommands/metadata.rs +++ b/rust/crates/mesc_cli/src/cli/subcommands/metadata.rs @@ -1,7 +1,33 @@ use crate::{MescCliError, MetadataArgs}; -pub(crate) fn metadata_command(_args: MetadataArgs) -> Result<(), MescCliError> { +pub(crate) fn metadata_command(args: MetadataArgs) -> Result<(), MescCliError> { let config = mesc::load::load_config_data()?; - println!("{}", serde_json::to_string_pretty(&config.global_metadata)?); - Ok(()) + match (args.endpoint, args.profile, args.profile_only) { + (None, None, None) => { + println!("{}", serde_json::to_string_pretty(&config.global_metadata)?); + Ok(()) + } + (Some(endpoint), None, None) => { + if let Some(endpoint) = config.endpoints.get(endpoint.as_str()) { + println!("{}", serde_json::to_string_pretty(&endpoint.endpoint_metadata)?); + Ok(()) + } else { + Err(MescCliError::Error("endpoint not found".to_string())) + } + } + (None, Some(profile), None) => { + let metadata = mesc::get_global_metadata(Some(profile.as_str()))?; + println!("{}", serde_json::to_string_pretty(&metadata)?); + Ok(()) + } + (None, None, Some(profile)) => { + if let Some(profile) = config.profiles.get(profile.as_str()) { + println!("{}", serde_json::to_string_pretty(&profile.profile_metadata)?); + Ok(()) + } else { + Err(MescCliError::Error("profile not found".to_string())) + } + } + _ => Err(MescCliError::Error("cannot specify more than one metadata type".to_string())), + } } diff --git a/rust/crates/mesc_cli/src/cli/subcommands/mod.rs b/rust/crates/mesc_cli/src/cli/subcommands/mod.rs index 0f642fc..dcbe01e 100644 --- a/rust/crates/mesc_cli/src/cli/subcommands/mod.rs +++ b/rust/crates/mesc_cli/src/cli/subcommands/mod.rs @@ -5,6 +5,7 @@ mod import; mod ls; mod metadata; mod ping; +mod set; mod setup; mod status; mod url; @@ -16,6 +17,7 @@ pub(crate) use import::*; pub(crate) use ls::*; pub(crate) use metadata::*; pub(crate) use ping::*; +pub(crate) use set::*; pub(crate) use setup::*; pub(crate) use status::*; pub(crate) use url::*; diff --git a/rust/crates/mesc_cli/src/cli/subcommands/set.rs b/rust/crates/mesc_cli/src/cli/subcommands/set.rs new file mode 100644 index 0000000..b7b73ec --- /dev/null +++ b/rust/crates/mesc_cli/src/cli/subcommands/set.rs @@ -0,0 +1,341 @@ +use crate::{MescCliError, SetArgs}; +use mesc::{RpcConfig, TryIntoChainId}; +use serde_json::{Map, Value}; +use std::collections::HashMap; +use toolstr::Colorize; + +pub(crate) async fn set_command(args: SetArgs) -> Result<(), MescCliError> { + // load old config data + let path = match (args.path.clone(), mesc::load::get_config_mode()) { + (Some(path), _) => path, + (_, Ok(mesc::ConfigMode::Path)) => mesc::load::get_config_path()?, + _ => { + eprintln!("to use set, must be in MESC_MODE=PATH or use the --path argument"); + std::process::exit(1); + } + }; + let mut config = match mesc::load::load_file_config(Some(path.clone())) { + Ok(data) => data, + Err(e) => { + eprintln!("could not load MESC config: {}", e); + std::process::exit(1); + } + }; + let old_config = config.clone(); + + // decide what to edit + let kv_pairs = determine_kv_pairs(&args)?; + let n_kv_pairs = kv_pairs.len(); + + // edit + for (key, value) in kv_pairs.into_iter() { + if let Some(value) = value { + set_config_value(&mut config, key, value)? + } else { + delete_config_value(&mut config, key)? + } + } + + // check that new config is valid + if let Err(e) = config.validate() { + eprintln!("Aborting because these updated resulted in an invalid config: {}", e); + std::process::exit(1); + } + + // write new file + if config != old_config { + mesc::write::write_config(config, path)?; + if n_kv_pairs == 1 { + println!("Applied {} update to config", n_kv_pairs.to_string().green().bold()); + } else { + println!("Applied {} updates to config", n_kv_pairs.to_string().green().bold()); + } + } else { + println!("Updates did not change the content of the config"); + } + + Ok(()) +} + +fn determine_kv_pairs(args: &SetArgs) -> Result)>, MescCliError> { + let kv_pairs = match ( + args.key.clone(), + args.value.clone(), + args.keys.clone(), + args.values.clone(), + args.delete, + ) { + (None, _, None, _, _) => { + return Err(MescCliError::InvalidInput("specify one of key or --keys".to_string())) + } + (Some(_), _, Some(_), _, _) => { + return Err(MescCliError::InvalidInput("cannot specify both key and --keys".to_string())) + } + (_, None, _, None, false) => { + return Err(MescCliError::InvalidInput("specify value or --values".to_string())) + } + (_, Some(_), _, Some(_), _) => { + return Err(MescCliError::InvalidInput( + "cannot specify both value and --values".to_string(), + )) + } + (_, Some(_), _, _, true) | (_, _, _, Some(_), true) => { + return Err(MescCliError::InvalidInput( + "cannot specify value or --values when using --delete".to_string(), + )) + } + (_, _, None, Some(_), false) => { + return Err(MescCliError::InvalidInput( + "must specify --keys when using --values".to_string(), + )) + } + (Some(key), Some(value), None, None, false) => vec![(key, Some(value))], + (Some(key), None, None, None, true) => vec![(key, None)], + (None, None, Some(keys), Some(values), false) => { + keys.into_iter().zip(values.into_iter().map(Some)).collect() + } + (None, None, Some(keys), None, true) => keys.into_iter().map(|k| (k, None)).collect(), + (None, Some(value), Some(keys), None, false) => { + keys.into_iter().map(|k| (k, Some(value.clone()))).collect() + } + }; + Ok(kv_pairs) +} + +fn set_config_value( + config: &mut RpcConfig, + key: String, + value: String, +) -> Result<(), MescCliError> { + let parts = key.split("\\.").flat_map(|part| part.split('.')).collect::>(); + match parts.as_slice() { + ["mesc_version"] => config.mesc_version = value, + ["default_endpoint"] => config.default_endpoint = Some(value), + ["endpoints", endpoint_name] => { + config + .endpoints + .insert(endpoint_name.to_string(), serde_json::from_str(value.as_str())?); + } + ["endpoints", endpoint_name, rest @ ..] => { + let rest = rest.to_vec(); + if (rest.len() == 1) & (rest[0] == "name") { + mesc::write::update_endpoint_name(config, endpoint_name, value.as_str())?; + return Ok(()); + } + if let Some(endpoint) = config.endpoints.get_mut(*endpoint_name) { + match rest.as_slice() { + ["url"] => endpoint.url = value, + ["chain_id"] => endpoint.chain_id = Some(value.try_into_chain_id()?), + ["endpoint_metadata", location @ ..] => { + set_metadata_entry(&mut endpoint.endpoint_metadata, location, value)?; + } + _ => return Err(MescCliError::InvalidInput(format!("cannot set key: {}", key))), + } + }; + } + ["network_defaults", chain_id] => { + config.network_defaults.insert(chain_id.try_into_chain_id()?, value); + } + ["network_names", network_name] => { + config.network_names.insert(network_name.to_string(), value.try_into_chain_id()?); + } + ["profiles", profile_name] => { + config.profiles.insert(profile_name.to_string(), serde_json::from_str(value.as_str())?); + } + ["profiles", profile_name, rest @ ..] => { + let rest = rest.to_vec(); + if let Some(profile) = config.profiles.get_mut(*profile_name) { + match rest.as_slice() { + ["name"] => profile.name = value, + ["default_endpoint"] => profile.default_endpoint = Some(value), + ["network_defaults", chain_id] => { + profile.network_defaults.insert(chain_id.try_into_chain_id()?, value); + } + ["profile_metadata", location @ ..] => { + set_metadata_entry(&mut profile.profile_metadata, location, value)?; + } + ["use_mesc"] => match value.parse::() { + Ok(as_bool) => profile.use_mesc = as_bool, + Err(_) => { + return Err(MescCliError::InvalidInput( + "use_mesc must be a bool value".to_string(), + )) + } + }, + _ => return Err(MescCliError::InvalidInput(format!("cannot set key: {}", key))), + } + } + } + ["global_metadata", location @ ..] => { + set_metadata_entry(&mut config.global_metadata, location, value)?; + } + _ => return Err(MescCliError::InvalidInput(format!("cannot delete key: {}", key))), + }; + Ok(()) +} + +fn delete_config_value(config: &mut RpcConfig, key: String) -> Result<(), MescCliError> { + let parts = key.split("\\.").flat_map(|part| part.split('.')).collect::>(); + match parts.as_slice() { + ["mesc_version"] => { + return Err(MescCliError::InvalidInput("cannot delete mesc_version".to_string())) + } + ["default_endpoint"] => config.default_endpoint = None, + ["endpoints", endpoint_name] => { + config.endpoints.remove(endpoint_name.to_string().as_str()); + } + ["endpoints", endpoint_name, rest @ ..] => { + let rest = rest.to_vec(); + if let Some(endpoint) = config.endpoints.get_mut(*endpoint_name) { + match rest.as_slice() { + ["name"] => { + return Err(MescCliError::InvalidInput( + "cannot delete endpoint name".to_string(), + )) + } + ["url"] => { + return Err(MescCliError::InvalidInput( + "cannot delete endpoint url".to_string(), + )) + } + ["chain_id"] => { + endpoint.chain_id = None; + } + ["endpoint_metadata", location @ ..] => { + delete_metadata_entry(&mut endpoint.endpoint_metadata, location)?; + } + _ => { + return Err(MescCliError::InvalidInput(format!( + "cannot delete key: {}", + key + ))) + } + } + } + } + ["network_defaults", chain_id] => { + config.network_defaults.remove(&chain_id.try_into_chain_id()?); + } + ["network_names", network_name] => { + config.network_names.remove(*network_name); + } + ["profiles", profile_name] => { + config.profiles.remove(*profile_name); + } + ["profiles", profile_name, rest @ ..] => { + let rest = rest.to_vec(); + if let Some(profile) = config.profiles.get_mut(*profile_name) { + match rest.as_slice() { + ["name"] => { + return Err(MescCliError::InvalidInput( + "cannot delete profile name".to_string(), + )) + } + ["default_endpoint"] => profile.default_endpoint = None, + ["network_defaults", chain_id] => { + profile.network_defaults.remove(&chain_id.try_into_chain_id()?); + } + ["profile_metadata", location @ ..] => { + delete_metadata_entry(&mut profile.profile_metadata, location)?; + } + ["use_mesc"] => { + return Err(MescCliError::InvalidInput( + "cannot delete profile use_mesc".to_string(), + )) + } + _ => { + return Err(MescCliError::InvalidInput(format!( + "cannot delete key: {}", + key + ))) + } + } + } + } + ["global_metadata", location @ ..] => { + delete_metadata_entry(&mut config.global_metadata, location)?; + } + _ => return Err(MescCliError::InvalidInput(format!("cannot delete key: {}", key))), + }; + Ok(()) +} + +fn set_metadata_entry( + metadata: &mut HashMap, + location: &[&str], + json_content: String, +) -> Result<(), MescCliError> { + if location.is_empty() { + return Err(MescCliError::InvalidInput("must specify metadata path to set".to_string())); + } + + let parsed_value = serde_json::from_str(&json_content) + .map_err(|e| MescCliError::InvalidInput(format!("Failed to parse JSON content: {}", e)))?; + + if location.len() == 1 { + metadata.insert(location[0].to_string(), parsed_value); + return Ok(()); + } + + let mut current_value = + metadata.entry(location[0].to_string()).or_insert_with(|| Value::Object(Map::new())); + + for &key in &location[1..location.len() - 1] { + current_value = match current_value { + Value::Object(map) => { + map.entry(key.to_string()).or_insert_with(|| Value::Object(Map::new())) + } + _ => return Err(MescCliError::InvalidInput(format!("Invalid path: {}", key))), + }; + } + + if let Some(last_key) = location.last() { + if let Value::Object(map) = current_value { + map.insert(last_key.to_string(), parsed_value); + } else { + return Err(MescCliError::InvalidInput("Target is not an object".to_string())); + } + } + + Ok(()) +} + +fn delete_metadata_entry( + metadata: &mut HashMap, + location: &[&str], +) -> Result<(), MescCliError> { + if location.is_empty() { + return Err(MescCliError::InvalidInput("must specify metadata path to delete".to_string())); + } + + if location.len() == 1 { + metadata.remove(location[0]); + return Ok(()); + } + + let mut current_value = match metadata.get_mut(location[0]) { + Some(value) => value, + None => return Ok(()), + }; + + for &key in &location[1..location.len() - 1] { + current_value = match current_value { + Value::Null => return Ok(()), + Value::Object(map) => match map.get_mut(key) { + Some(value) => value, + None => return Ok(()), + }, + _ => return Err(MescCliError::InvalidInput(format!("Invalid path: {}", key))), + }; + } + + if let Some(last_key) = location.last() { + if let Value::Object(map) = current_value { + map.remove(*last_key); + } else { + return Err(MescCliError::InvalidInput("Target is not an object".to_string())); + } + } + + Ok(()) +} diff --git a/rust/crates/mesc_cli/src/cli/subcommands/setup.rs b/rust/crates/mesc_cli/src/cli/subcommands/setup.rs deleted file mode 100644 index 60bcba0..0000000 --- a/rust/crates/mesc_cli/src/cli/subcommands/setup.rs +++ /dev/null @@ -1,1088 +0,0 @@ -use crate::{print_defaults, MescCliError, SetupArgs}; -use inquire::{ - ui::{Attributes, Color, IndexPrefix, RenderConfig, StyleSheet, Styled}, - InquireError, -}; -use mesc::{ChainId, Endpoint, RpcConfig, TryIntoChainId}; -use std::collections::{HashMap, HashSet}; -use toolstr::Colorize; - -pub(crate) async fn setup_command(args: SetupArgs) -> Result<(), MescCliError> { - inquire::set_global_render_config(get_render_config()); - - if args.editor { - return edit_config_in_editor(args); - } - - let config_mode = mesc::load::get_config_mode()?; - match config_mode { - mesc::ConfigMode::Path => { - println!("MESC is enabled"); - println!(); - println!("config stored at: {}", mesc::load::get_config_path()?.bold()); - } - mesc::ConfigMode::Env => { - println!("MESC is enabled"); - println!(); - println!("config stored in MESC_ENV environment variable"); - } - mesc::ConfigMode::Disabled => { - println!("MESC is not enabled"); - } - }; - println!(); - - loop { - if mesc::is_mesc_enabled() { - match mesc::load::load_config_data() { - Ok(config) => return modify_existing_config(config, None).await, - Err(_) => { - println!("The current MESC config contains improper data"); - println!(); - let options = vec!["Fix the data manually", "Create a new config from scratch"]; - match inquire::Select::new("How to proceed?", options).prompt() { - Ok("Fix the data manually") => match config_mode { - mesc::ConfigMode::Path => { - let path = mesc::load::get_config_path()?; - edit::edit_file(path)? - } - _ => { - println!("Config data stored in MESC_ENV environment variable"); - println!(); - println!("Edit MESC_ENV in your terminal config files and then restart your terminal"); - } - }, - Ok("Create a new config from scratch") => return setup_new_config().await, - Err(InquireError::OperationCanceled) => { - println!("exiting"); - std::process::exit(1); - } - _ => println!("Improper selection"), - }; - return Ok(()); - } - } - } else if let Ok(path) = mesc::load::get_config_path() { - println!("a MESC config path has still been specified: {}", path.bold()); - - if std::path::Path::new(&path).exists() { - println!(); - match mesc::load::load_file_config(None) { - Ok(config) => { - println!("To enable MESC, select \"Setup environment\" below"); - println!(); - return modify_existing_config(config, None).await; - } - Err(_) => { - println!("This MESC config file contains improper data"); - let options = - vec!["Fix the data manually", "Create a new config from scratch"]; - match inquire::Select::new("How to proceed?", options).prompt() { - Ok("Fix the data manually") => edit::edit_file(path)?, - Ok("Create a new config from scratch") => { - return setup_new_config().await - } - Err(InquireError::OperationCanceled) => { - println!("exiting"); - std::process::exit(1); - } - _ => {} - }; - } - } - } else { - println!(); - return setup_new_config().await; - } - } else { - return setup_new_config().await; - } - } -} - -fn edit_config_in_editor(args: SetupArgs) -> Result<(), MescCliError> { - if let Some(path) = args.path { - edit::edit_file(path)? - } else if let Ok(mesc::ConfigMode::Path) = mesc::load::get_config_mode() { - let path = mesc::load::get_config_path()?; - edit::edit_file(path)? - } else { - return Err(MescCliError::Error("no file to edit".to_string())); - }; - Ok(()) -} - -async fn setup_new_config() -> Result<(), MescCliError> { - println!(" {}", "Creating new config...".bold()); - let mut write_mode = None; - let mut config = RpcConfig::default(); - setup_environment(&mut config, &mut write_mode)?; - if let Some(ConfigWriteMode::Path(path)) = write_mode.clone() { - if std::path::Path::new(&path).exists() { - println!(" Config file already exists, loading"); - config = mesc::load::load_file_config(Some(path))?; - } else { - mesc::write::write_config(config.clone(), path)?; - println!(" {}", "Empty configuration created".bold()); - } - } - - modify_existing_config(config, write_mode).await?; - - Ok(()) -} - -async fn modify_existing_config( - config: RpcConfig, - mut config_write_mode: Option, -) -> Result<(), MescCliError> { - let options = [ - "Setup environment", - "Add new endpoint", - "Modify endpoint", - "Modify defaults", - "Modify global metadata", - "Print config as JSON", - "Exit and save changes", - "Exit without saving", - ] - .to_vec(); - let original_config = config.clone(); - let mut valid_config = config.clone(); - let mut config = config.clone(); - // let mut config_write_mode: Option = None; - loop { - // modify config - let input = match inquire::Select::new("What do you want to do?", options.clone()) - .with_page_size(10) - .prompt() - { - Ok(input) => input, - Err(InquireError::OperationCanceled) => { - println!(" Exiting without saving"); - std::process::exit(0) - } - Err(e) => return Err(e.into()), - }; - match input { - "Setup environment" => setup_environment(&mut config, &mut config_write_mode)?, - "Add new endpoint" => add_endpoint(&mut config).await?, - "Modify endpoint" => modify_endpoint(&mut config).await?, - "Modify defaults" => modify_defaults(&mut config)?, - "Modify global metadata" => modify_global_metadata(&mut config).await?, - "Print config as JSON" => { - println!(); - println!("{}", colored_json::to_colored_json_auto(&config)?); - println!(); - } - "Exit and save changes" => break, - "Exit without saving" => return Ok(()), - _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), - }; - - // validation - match config.validate() { - Ok(()) => {} - Err(e) => { - println!("Invalid data: {:?}", e); - println!("Reverting to previous config state"); - config = valid_config.clone(); - continue; - } - }; - - valid_config = config.clone(); - } - - // write file - if config != original_config { - if config_write_mode.is_none() { - config_write_mode = get_config_write_mode()?; - }; - if config_write_mode.is_none() { - println!(" No write mode selected"); - println!(" Not writing changes to disk"); - } else { - match &config_write_mode { - Some(write_mode) => match write_mode { - ConfigWriteMode::Path(path) => { - mesc::write::write_config(config, path.clone())?; - println!(" {} {}", "config written to".bold(), path.green()); - } - ConfigWriteMode::Env(_) => { - todo!("writing environment variables not supported yet") - } - }, - None => return Err(MescCliError::Error("could not obtain write mode".to_string())), - }; - } - } else { - println!(" {}", "No updates to save".bold()) - } - Ok(()) -} - -fn setup_environment( - _config: &mut RpcConfig, - config_write_mode: &mut Option, -) -> Result<(), MescCliError> { - if mesc::is_mesc_enabled() { - println!(); - println!(" MESC is already enabled"); - println!(" Using path {}", mesc::load::get_config_path()?.green().bold()); - println!(); - } else if let Some(config_write_mode) = config_write_mode { - match config_write_mode { - ConfigWriteMode::Path(path) => { - println!(" MESC not yet enabled, but will write config to {}", path.green().bold()) - } - ConfigWriteMode::Env(_) => { - println!(" ENV mode not yet available in the interactive cli") - } - }; - } else { - let options = - vec!["Store MESC config in a file", "Store MESC config in an environment variable"]; - let prompt = "How do you want to store your MESC config?"; - match inquire::Select::new(prompt, options).prompt() { - Ok("Store MESC config in a file") => { - let prompt = "Where should mesc.json file be saved? (enter a directory path)"; - let parent = match inquire::Text::new(prompt).prompt() { - Ok(parent) => { - let parent = if parent.trim().is_empty() { - ".".to_string() - } else { - mesc::load::expand_path(parent)? - }; - std::path::PathBuf::from(parent) - } - Err(InquireError::OperationCanceled) => return Ok(()), - Err(_) => return Err(MescCliError::InvalidInput("invalid input".to_string())), - }; - let path: String = parent.join("mesc.json").to_string_lossy().to_string(); - *config_write_mode = Some(ConfigWriteMode::Path(path.to_string())); - println!( - " Insert this line into your {} and {} files:", - "~/.bashrc".green().bold(), - "~/.profile".green().bold() - ); - println!(" {}{}", "MESC_PATH=".green().bold(), path.green().bold()); - println!(" Then restart your terminal shell"); - } - Ok("Store MESC config in an environment variable") => { - println!(" This is not available in the interactive MESC cli yet"); - } - Err(InquireError::OperationCanceled) => {} - _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), - } - } - - Ok(()) -} - -#[derive(Clone)] -enum ConfigWriteMode { - /// file path of JSON config file - Path(String), - /// list of config files to write to - Env(Vec), -} - -fn get_config_write_mode() -> Result, MescCliError> { - if let Ok(path) = mesc::load::get_config_path() { - return Ok(Some(ConfigWriteMode::Path(path))); - }; - - let prompt = "How do you want to save the config?"; - let options = ["Save as path file", "Save as an environment variable"].to_vec(); - loop { - let write_mode = match inquire::Select::new(prompt, options.clone()).prompt() { - Ok("Save as path file") => { - let prompt = "Where should mesc.json file be saved? (enter a directory path)"; - let parent = match inquire::Text::new(prompt).prompt() { - Ok(parent) => { - let parent = if parent.trim().is_empty() { - ".".to_string() - } else { - mesc::load::expand_path(parent)? - }; - std::path::PathBuf::from(parent) - } - Err(InquireError::OperationCanceled) => return Ok(None), - Err(_) => return Err(MescCliError::InvalidInput("invalid input".to_string())), - }; - let path: String = parent.join("mesc.json").to_string_lossy().to_string(); - Some(ConfigWriteMode::Path(path.to_string())) - } - Ok("Save an environment variable") => { - println!("not supported yet"); - continue; - } - Err(InquireError::OperationCanceled) => return Ok(None), - _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), - }; - return Ok(write_mode); - } -} - -fn is_ip(url: &str) -> bool { - use std::net::{Ipv4Addr, Ipv6Addr}; - if url.is_empty() { - return false; - } - let domain = match url.split_once('/') { - Some((domain, _)) => domain, - None => url, - }; - let domain = domain.split(':').next().unwrap_or(""); - domain.parse::().is_ok() || domain.parse::().is_ok() -} - -async fn add_endpoint(config: &mut RpcConfig) -> Result<(), MescCliError> { - let url = match inquire::Text::new("New endpoint URL?").prompt() { - Ok(input) => input, - Err(InquireError::OperationCanceled) => return Ok(()), - Err(_) => return Err(MescCliError::InvalidInput("invalid input".to_string())), - }; - - // add transport protocol - let url = if !url.starts_with("http") & !url.starts_with("ws") & !url.ends_with(".ipc") { - if url.starts_with("localhost") | is_ip(&url) { - let url = format!("http://{}", url); - println!( - " Transport protocol not included. Defaulting to http: {}", - url.green().bold() - ); - url - } else { - let url = format!("https://{}", url); - println!( - " Transport protocol not included. Defaulting to https: {}", - url.green().bold() - ); - url - } - } else { - url - }; - - // get chain_id - println!(" Querying chain id..."); - let client = reqwest::Client::builder().timeout(std::time::Duration::from_secs(4)).build()?; - let chain_id = crate::rpc::request_chain_id(client, url.clone()).await; - let chain_id = match chain_id { - Ok(chain_id) => { - println!(" {} {}", "Using chain_id".bold(), chain_id.as_str().green()); - Some(chain_id) - } - _ => { - println!(" {}", "Could not detect chain id".red()); - select_chain_id("How to proceed?".to_string()).await? - } - }; - - // get name - let default_name = mesc::overrides::get_default_endpoint_name(&url, chain_id.clone()); - let mut input = inquire::Text::new("New endpoint name?"); - if let Some(default_name) = default_name.as_ref() { - input = input.with_default(default_name); - } - let name = match input.prompt() { - Ok(choice) => choice, - Err(InquireError::OperationCanceled) => return Ok(()), - Err(_) => return Err(MescCliError::InvalidInput("invalid input".to_string())), - }; - - // create endpoint - let endpoint = - Endpoint { url, name, chain_id, endpoint_metadata: std::collections::HashMap::new() }; - config.endpoints.insert(endpoint.name.clone(), endpoint); - println!(" {}", "New endpoint added".bold()); - Ok(()) -} - -async fn select_chain_id(prompt: String) -> Result, MescCliError> { - let options = vec![ - "Search known network names", - "Enter endpoint chain id manually", - "Do not use a chain id for this endpoint", - ]; - loop { - match inquire::Select::new(prompt.as_str(), options.clone()).prompt() { - Ok("Do not use a chain id for this endpoint") => return Ok(None), - Ok("Enter endpoint chain id manually") => { - match inquire::Text::new("Chain id?").prompt() { - Ok(text) => { - match text.try_into_chain_id() { - Ok(chain_id) => return Ok(Some(chain_id)), - _ => continue, - }; - } - Err(InquireError::OperationCanceled) => return Ok(None), - _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), - } - } - Ok("Search known network names") => { - println!( - " Fetching network names from {}...", - "https://chainid.network".green().bold() - ); - match select_chain_id_by_name().await { - Ok(Some(chain_id)) => return Ok(Some(chain_id)), - Ok(None) => return Ok(None), - _ => { - println!(" Exiting without saving"); - std::process::exit(0); - } - } - } - Err(InquireError::OperationCanceled) => return Ok(None), - _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), - } - } -} - -async fn modify_endpoint(config: &mut RpcConfig) -> Result<(), MescCliError> { - // select endpoint - let mut options: Vec = config.endpoints.clone().into_keys().collect(); - options.sort(); - let endpoint_name = match inquire::Select::new("Which endpoint to modify?", options).prompt() { - Ok(name) => name, - Err(InquireError::OperationCanceled) => return Ok(()), - _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), - }; - let endpoint = match config.endpoints.get(&endpoint_name) { - Some(endpoint) => endpoint.clone(), - None => return Err(MescCliError::InvalidInput("endpoint does not exist".to_string())), - }; - println!(" {}", "Current endpoint data:".bold(),); - println!(); - let colored = colored_json::to_colored_json_auto(&serde_json::to_value(&endpoint)?)?; - for line in colored.split('\n') { - println!(" {}", line); - } - println!(); - - // gather modifications - let halt_options: HashSet<&str> = vec!["Delete endpoint", "Done"].into_iter().collect(); - let mut option = query_modify_endpoint(endpoint_name.clone(), config, true).await?; - loop { - if halt_options.contains(option.as_str()) { - break; - } - option = query_modify_endpoint(endpoint_name.clone(), config, false).await?; - } - - // commit modifications - if option != "Delete endpoint" { - let new_endpoint = match config.endpoints.get(&endpoint_name) { - Some(endpoint) => endpoint.clone(), - None => return Err(MescCliError::InvalidInput("endpoint does not exist".to_string())), - }; - if new_endpoint == endpoint { - println!(" Endpoint unmodified"); - } else { - println!(" {}", "New endpoint data:".bold(),); - println!(); - let colored = colored_json::to_colored_json_auto(&serde_json::to_value(endpoint)?)?; - for line in colored.split('\n') { - println!(" {}", line); - } - println!(); - } - } - - Ok(()) -} - -async fn query_modify_endpoint( - endpoint_name: String, - config: &mut RpcConfig, - first_change: bool, -) -> Result { - let options = [ - "Modify endpoint name", - "Modify endpoint url", - "Modify endpoint chain_id", - "Modify endpoint metadata", - "Delete endpoint", - "Print endpoint as JSON", - "Done", - ] - .to_vec(); - - let message = if first_change { "How to modify endpoint?" } else { "Any other modifications?" }; - - let option = match inquire::Select::new(message, options.clone()).prompt() { - Ok(answer) => answer, - Err(InquireError::OperationCanceled) => return Ok("Done".to_string()), - _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), - }; - - match option { - "Modify endpoint name" => { - let new_name = match inquire::Text::new("New name?").prompt() { - Ok(answer) => answer, - Err(InquireError::OperationCanceled) => return Ok("Done".to_string()), - _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), - }; - mesc::write::update_endpoint_name(config, endpoint_name.as_str(), new_name.as_str())?; - } - "Modify endpoint url" => { - let new_url = match inquire::Text::new("New url?").prompt() { - Ok(answer) => answer, - Err(InquireError::OperationCanceled) => return Ok("Done".to_string()), - _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), - }; - if let Some(endpoint) = config.endpoints.get_mut(&endpoint_name) { - endpoint.url = new_url; - } - } - "Modify endpoint chain_id" => { - match select_chain_id("New chain_id?".to_string()).await { - Ok(Some(chain_id)) => mesc::write::update_endpoint_chain_id( - config, - endpoint_name.as_str(), - chain_id.clone(), - )?, - Ok(None) => return Ok("Done".to_string()), - _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), - }; - } - "Modify endpoint metadata" => modify_endpoint_metadata(endpoint_name.as_str(), config)?, - "Delete endpoint" => { - mesc::write::delete_endpoint(config, endpoint_name.as_str())?; - println!("{} {}", "Deleted endpoint:".red(), endpoint_name.green()); - } - "Print endpoint as JSON" => { - let endpoint = match config.endpoints.get(&endpoint_name) { - Some(endpoint) => endpoint.clone(), - None => { - return Err(MescCliError::InvalidInput("endpoint does not exist".to_string())) - } - }; - println!(" {}", "Current endpoint data:".bold(),); - println!(); - let colored = colored_json::to_colored_json_auto(&serde_json::to_value(endpoint)?)?; - for line in colored.split('\n') { - println!(" {}", line); - } - println!(); - } - "Done" => {} - _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), - }; - - Ok(option.to_string()) -} - -fn modify_endpoint_metadata( - endpoint_name: &str, - config: &mut RpcConfig, -) -> Result<(), MescCliError> { - let endpoint = match config.endpoints.get_mut(endpoint_name) { - Some(endpoint) => endpoint, - None => { - return Err(MescCliError::InvalidInput(format!("missing endpoint: {}", endpoint_name))) - } - }; - let options = vec![ - "Add label", - "Remove label", - "Set ratelimit", - "Set api key", - "Edit raw JSON", - "Done editing metadata", - ]; - match inquire::Select::new("How to modify metadata?", options).prompt() { - Ok("Add label") => { - let new_label = match inquire::Text::new("What is the new label?").prompt() { - Ok(new_label) => new_label, - Err(InquireError::OperationCanceled) => return Ok(()), - _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), - }; - if endpoint.endpoint_metadata.get_mut("labels").is_none() { - endpoint - .endpoint_metadata - .insert("labels".to_string(), serde_json::json!(Vec::::new())); - }; - let labels = endpoint.endpoint_metadata.get_mut("labels").unwrap(); - if let Some(array) = labels.as_array_mut() { - array.push(serde_json::Value::String(new_label)); - println!(" Added label") - } else { - println!("Incorrectly formatted data, labels is not a list"); - }; - } - Ok("Remove label") => { - match endpoint.endpoint_metadata.get_mut("labels") { - Some(serde_json::Value::Array(labels)) => { - let label_strings: Vec<&str> = - labels.iter().filter_map(|val| val.as_str()).collect(); - if label_strings.is_empty() { - println!("No labels for endpoint"); - return Ok(()); - }; - match inquire::Select::new("Which label to remove?", label_strings.clone()) - .prompt() - { - Ok(label) => { - if let Some(index) = - label_strings.iter().position(|test_label| test_label == &label) - { - labels.remove(index); - } else { - println!("Label not found."); - } - } - Err(InquireError::OperationCanceled) => return Ok(()), - _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), - } - } - Some(_) => { - println!("Incorrectly formatted data, labels is not a list"); - } - None => { - println!(" Endpoint does not have any labels") - } - }; - } - Ok("Set ratelimit") => { - let message = "What is the rate limit, in requests per second?"; - let value = match inquire::CustomType::::new(message) - .with_formatter(&|i| format!("{:.2}", i)) - .with_error_message("Please type a valid number") - .with_help_message(" Enter the number of requests per seconds") - .prompt() - { - Ok(value) => value, - Err(InquireError::OperationCanceled) => return Ok(()), - _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), - }; - endpoint - .endpoint_metadata - .insert("rate_limit_rps".to_string(), serde_json::json!(value)); - } - Ok("Set api key") => { - let api_key = match inquire::Text::new("What is the api key?").prompt() { - Ok(api_key) => api_key, - Err(InquireError::OperationCanceled) => return Ok(()), - _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), - }; - endpoint.endpoint_metadata.insert("api_key".to_string(), serde_json::json!(api_key)); - } - Ok("Edit raw JSON") => { - let edited = edit::edit(serde_json::to_string(&endpoint.endpoint_metadata)?)?; - let value: Result, serde_json::Error> = - serde_json::from_str(&edited); - endpoint.endpoint_metadata = value?; - } - Ok("Done editing metadata") => return Ok(()), - Err(InquireError::OperationCanceled) => return Ok(()), - _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), - } - Ok(()) -} - -async fn modify_global_metadata(config: &mut RpcConfig) -> Result<(), MescCliError> { - let options = - vec!["Modify raw global metadata JSON", "Edit custom network names", "Back to main menu"]; - match inquire::Select::new("What do you want to do?", options).prompt() { - Ok("Modify raw global metadata JSON") => { - let old_metadata = serde_json::to_string(&config.global_metadata)?; - let new_metadata = edit::edit(&old_metadata)?; - if old_metadata == new_metadata { - println!(" {}", "Global metadata unchanged".bold()); - } else { - let value: Result, serde_json::Error> = - serde_json::from_str(&new_metadata); - config.global_metadata = value?; - println!(" {}", "Global metadata updated".bold()); - } - Ok(()) - } - Ok("Edit custom network names") => modify_custom_network_names(config).await, - Ok("Back to main menu") => Ok(()), - Err(InquireError::OperationCanceled) => Ok(()), - _ => Err(MescCliError::InvalidInput("invalid input".to_string())), - } -} - -async fn modify_custom_network_names(config: &mut RpcConfig) -> Result<(), MescCliError> { - print_custom_network_names(config); - - loop { - let options = if config.network_names.is_empty() { - vec![ - "Add custom network name", - "Print custom network names", - "Done editing custom names", - ] - } else { - vec![ - "Add custom network name", - "Edit custom network name", - "Remove custom network name", - "Print custom network names", - "Done editing custom names", - ] - }; - match inquire::Select::new("What do you want to do?", options).prompt() { - Ok("Add custom network name") => { - let name = match inquire::Text::new("Custom network name?").prompt() { - Ok(name) => name, - Err(InquireError::OperationCanceled) => continue, - _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), - }; - loop { - match inquire::Text::new("What is the chain id?").prompt() { - Ok(chain_id) => match chain_id.try_into_chain_id() { - Ok(chain_id) => { - config.network_names.insert(name.clone(), chain_id); - println!(" Custom network name added"); - break; - } - _ => { - println!(" not a valid chain id"); - continue; - } - }, - Err(InquireError::OperationCanceled) => break, - _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), - } - } - } - Ok("Edit custom network name") => match select_custom_network_name(config) { - Ok(Some(old_name)) => match inquire::Text::new("New name?").prompt() { - Ok(new_name) => match config.network_names.remove(&old_name) { - Some(chain_id) => { - config.network_names.insert(new_name, chain_id); - } - None => continue, - }, - Err(InquireError::OperationCanceled) => return Ok(()), - _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), - }, - Ok(None) => return Ok(()), - _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), - }, - Ok("Remove custom network name") => match select_custom_network_name(config) { - Ok(Some(name)) => { - config.network_names.remove(&name); - println!(" Name removed"); - } - Ok(None) => return Ok(()), - _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), - }, - Ok("Print custom network names") => print_custom_network_names(config), - Ok("Done editing custom names") => return Ok(()), - Err(InquireError::OperationCanceled) => return Ok(()), - _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), - } - } -} - -fn print_custom_network_names(config: &RpcConfig) { - if config.network_names.is_empty() { - println!(" No custom network names currently being used"); - } else { - println!( - " {} custom network names currently being used:", - config.network_names.len().to_string().green().bold() - ); - for (network_name, chain_id) in config.network_names.iter() { - println!(" - {} = {}", network_name.bold(), chain_id.as_str().green().bold()); - } - }; -} - -fn select_custom_network_name(config: &RpcConfig) -> Result, MescCliError> { - let names: Vec<_> = config.network_names.keys().collect(); - if names.is_empty() { - return Ok(None); - } - match inquire::Select::new("Which custom name?", names).prompt() { - Ok(name) => Ok(Some(name.clone())), - Err(InquireError::OperationCanceled) => Ok(None), - _ => Err(MescCliError::InvalidInput("invalid input".to_string())), - } -} - -fn modify_defaults(config: &mut RpcConfig) -> Result<(), MescCliError> { - println!(" Current defaults:"); - println!(); - print_defaults(config)?; - println!(); - - let options = [ - "Set the default endpoint", - "Set the default endpoint for network", - "Add new profile", - "Modify existing profile", - "Print current defaults", - "Done modifying defaults", - ] - .to_vec(); - - loop { - match inquire::Select::new("Which defaults do you want to modify?", options.clone()) - .prompt() - { - Ok("Set the default endpoint") => { - let prompt = "Which endpoint should be the default?"; - let endpoint_name = match select_endpoint(config, prompt)? { - Some(value) => value, - _ => return Ok(()), - }; - config.default_endpoint = Some(endpoint_name.clone()); - if let Some(endpoint) = - mesc::query::get_endpoint_by_name(config, endpoint_name.as_str())? - { - if let Some(chain_id) = endpoint.chain_id { - config.network_defaults.insert(chain_id, endpoint_name); - }; - } - } - Ok("Set the default endpoint for network") => { - let prompt = "Set the default endpoint for which network?"; - let chain_id = match select_config_chain_id(config, prompt)? { - Some(value) => value, - _ => return Ok(()), - }; - let prompt = "What should be the default endpoint for this network?"; - let endpoint_name = match select_endpoint_of_network(config, &chain_id, prompt)? { - Some(value) => value, - _ => return Ok(()), - }; - config.network_defaults.insert(chain_id, endpoint_name); - } - Ok("Add new profile") => { - let name = match inquire::Text::new("Name?").prompt() { - Ok(answer) => answer, - Err(InquireError::OperationCanceled) => return Ok(()), - _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), - }; - if config.profiles.contains_key(&name) { - println!(); - } else { - config.profiles.insert(name.clone(), mesc::Profile::new(name)); - println!(" profile added"); - } - } - Ok("Modify existing profile") => { - if config.profiles.is_empty() { - println!(" no profiles are currently configured"); - continue; - } - - let profile_name = match select_profile(config, "Which profile to modify?")? { - Some(value) => value, - _ => return Ok(()), - }; - let options = vec![ - "Set the profile's name", - "Set the profile's default endpoint", - "Set the profile's default endpoint for a network", - ]; - match inquire::Select::new("What to modify?", options).prompt() { - Ok("Set the profile's name") => { - let new_name = match inquire::Text::new("New name?").prompt() { - Ok(answer) => answer, - Err(InquireError::OperationCanceled) => return Ok(()), - _ => { - return Err(MescCliError::InvalidInput("invalid input".to_string())) - } - }; - if config.profiles.contains_key(&new_name) { - println!("profile with this name already exists"); - continue; - }; - if let Some(mut profile) = config.profiles.remove(&profile_name) { - profile.name = new_name.clone(); - config.profiles.insert(new_name, profile); - } else { - println!("profile not present"); - } - } - Ok("Set the profile's default endpoint") => { - let prompt = "Which endpoint to use as profile default?"; - let default_endpoint = match select_endpoint(config, prompt)? { - Some(value) => value, - _ => return Ok(()), - }; - if let Some(endpoint) = - mesc::query::get_endpoint_by_name(config, &default_endpoint)? - { - if let Some(profile) = config.profiles.get_mut(&profile_name) { - profile.default_endpoint = Some(default_endpoint.clone()); - if let Some(chain_id) = endpoint.chain_id.clone() { - profile.network_defaults.insert(chain_id, default_endpoint); - } - } else { - println!("profile not present"); - } - } - } - Ok("Set the profile's default endpoint for a network") => { - let prompt = "Set the profile's default endpoint for which network?"; - let chain_id = match select_config_chain_id(config, prompt)? { - Some(value) => value, - _ => return Ok(()), - }; - let prompt = "What should be the default endpoint for this network?"; - let endpoint_name = - match select_endpoint_of_network(config, &chain_id, prompt)? { - Some(value) => value, - _ => return Ok(()), - }; - if let Some(profile) = config.profiles.get_mut(&profile_name) { - profile.network_defaults.insert(chain_id, endpoint_name); - } else { - println!("profile not present"); - } - } - Err(InquireError::OperationCanceled) => return Ok(()), - _ => { - println!("invalid input"); - } - } - } - Ok("Print current defaults") => { - println!("Current defaults:"); - println!(); - print_defaults(config)?; - println!(); - } - Ok("Done modifying defaults") => return Ok(()), - Err(InquireError::OperationCanceled) => return Ok(()), - _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), - } - } -} - -fn select_endpoint(config: &RpcConfig, prompt: &str) -> Result, MescCliError> { - let mut options: Vec = config.endpoints.clone().into_keys().collect(); - options.sort(); - match inquire::Select::new(prompt, options).prompt() { - Ok(answer) => Ok(Some(answer)), - Err(InquireError::OperationCanceled) => Ok(None), - _ => Err(MescCliError::InvalidInput("invalid input".to_string())), - } -} - -fn select_endpoint_of_network( - config: &RpcConfig, - chain_id: &ChainId, - prompt: &str, -) -> Result, MescCliError> { - let mut options: Vec = config - .endpoints - .clone() - .values() - .filter(|endpoint| endpoint.chain_id.as_ref() == Some(chain_id)) - .map(|endpoint| endpoint.name.clone()) - .collect(); - options.sort(); - match inquire::Select::new(prompt, options).prompt() { - Ok(answer) => Ok(Some(answer)), - Err(InquireError::OperationCanceled) => Ok(None), - _ => Err(MescCliError::InvalidInput("invalid input".to_string())), - } -} - -fn select_profile(config: &RpcConfig, prompt: &str) -> Result, MescCliError> { - let mut options: Vec<_> = config.profiles.keys().collect(); - options.sort(); - match inquire::Select::new(prompt, options).prompt() { - Ok(answer) => Ok(Some(answer.to_string())), - Err(InquireError::OperationCanceled) => Ok(None), - _ => Err(MescCliError::InvalidInput("invalid input".to_string())), - } -} - -fn select_config_chain_id( - config: &RpcConfig, - prompt: &str, -) -> Result, MescCliError> { - let mut chain_ids: HashSet = HashSet::new(); - for endpoint in config.endpoints.values() { - if let Some(chain_id) = endpoint.chain_id.as_ref() { - chain_ids.insert(chain_id.clone()); - } - } - let mut sorted_chain_ids: Vec = chain_ids.into_iter().collect(); - sorted_chain_ids.sort_by_key(|chain_id| chain_id.to_hex_256().unwrap_or("".to_string())); - let options: Vec = sorted_chain_ids - .iter() - .map(|chain_id| match mesc::directory::get_network_name(chain_id) { - Some(name) => format!("{}) {}", chain_id.as_str(), name), - None => chain_id.to_string(), - }) - .collect(); - let input = match inquire::Select::new(prompt, options.clone()).prompt() { - Ok(answer) => answer, - Err(InquireError::OperationCanceled) => return Ok(None), - _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), - }; - match options.iter().position(|x| x == &input) { - Some(index) => Ok(Some(sorted_chain_ids.remove(index))), - None => Err(MescCliError::Error("invalid input".to_string())), - } -} - -async fn select_chain_id_by_name() -> Result, MescCliError> { - let network_list = match crate::network::fetch_network_list().await { - Ok(mapping) => mapping, - Err(_) => { - println!(" could not retrieve network list"); - return Ok(None); - } - }; - let mut pairs: Vec<(ChainId, String)> = network_list.into_iter().collect(); - pairs.sort_by_key(|(chain_id, _)| { - chain_id.to_hex_256().unwrap_or(chain_id.as_str().to_string()) - }); - - let options: Vec<_> = - pairs.iter().map(|(chain_id, name)| format!("{}) {}", chain_id, name)).collect(); - let mut render_config = get_render_config(); - render_config.option_index_prefix = IndexPrefix::None; - match inquire::Select::new("Which network?", options.clone()) - .with_render_config(render_config) - .prompt() - { - Ok(answer) => match options.iter().position(|option| option == &answer) { - Some(index) => match pairs.get(index) { - Some((chain_id, _)) => Ok(Some(chain_id.clone())), - None => Ok(None), - }, - None => Err(MescCliError::InvalidInput("bad input".to_string())), - }, - Err(InquireError::OperationCanceled) => Ok(None), - _ => Err(MescCliError::Error("invalid input".to_string())), - } -} - -fn get_render_config() -> RenderConfig { - let highlight_color = Color::DarkGreen; - - let mut render_config = RenderConfig::default(); - render_config.prompt = StyleSheet::new().with_attr(Attributes::BOLD); - render_config.prompt_prefix = Styled::new("").with_fg(Color::LightRed); - render_config.answered_prompt_prefix = Styled::new("").with_fg(Color::LightRed); - render_config.placeholder = StyleSheet::new().with_fg(Color::LightRed); - render_config.selected_option = Some(StyleSheet::new().with_fg(highlight_color)); - render_config.highlighted_option_prefix = Styled::new("→").with_fg(highlight_color); - render_config.selected_checkbox = Styled::new("☑").with_fg(highlight_color); - render_config.scroll_up_prefix = Styled::new("⇞"); - render_config.scroll_down_prefix = Styled::new("⇟"); - render_config.unselected_checkbox = Styled::new("☐"); - render_config.option_index_prefix = IndexPrefix::Simple; - render_config.error_message = - render_config.error_message.with_prefix(Styled::new("❌").with_fg(Color::LightRed)); - render_config.answer = StyleSheet::new().with_attr(Attributes::BOLD).with_fg(highlight_color); - let grey = Color::Rgb { r: 100, g: 100, b: 100 }; - render_config.help_message = StyleSheet::new().with_fg(grey).with_attr(Attributes::ITALIC); - - render_config -} diff --git a/rust/crates/mesc_cli/src/cli/subcommands/setup/command.rs b/rust/crates/mesc_cli/src/cli/subcommands/setup/command.rs new file mode 100644 index 0000000..20352c8 --- /dev/null +++ b/rust/crates/mesc_cli/src/cli/subcommands/setup/command.rs @@ -0,0 +1,239 @@ +use crate::{MescCliError, SetupArgs}; +use mesc::{MescError, RpcConfig}; +use std::path::PathBuf; +use toolstr::Colorize; + +use super::{config_modification::*, inquire_utils::*, selectors::*, shell_config::*, writing::*}; + +pub(crate) async fn setup_command(args: SetupArgs) -> Result<(), MescCliError> { + inquire::set_global_render_config(get_render_config()); + if args.editor { + edit_config_in_editor(args) + } else { + let (mode, shell_config_modified) = get_write_mode()?; + let config = load_config_data(&mode)?; + let endpoint_word = if config.endpoints.len() == 1 { "endpoint" } else { "endpoints" }; + let profile_word = if config.profiles.len() == 1 { "profile" } else { "profiles" }; + println!( + " Current config has {} {} and {} {}", + config.endpoints.len().to_string().green(), + endpoint_word, + config.profiles.len().to_string().green(), + profile_word, + ); + println!(); + let result = modify_existing_config(config, Some(mode)).await; + if shell_config_modified { + println!(); + println!( + "{}", + "Shell config files were modified. Restart shell to load these files.".magenta() + ) + } + result + } +} + +/// edit MESC config in editor instead of interactive menus +fn edit_config_in_editor(args: SetupArgs) -> Result<(), MescCliError> { + if let Some(path) = args.path { + edit::edit_file(path)? + } else if let Ok(mesc::ConfigMode::Path) = mesc::load::get_config_mode() { + let path = mesc::load::get_config_path()?; + edit::edit_file(path)? + } else { + return Err(MescCliError::Error("no file to edit".to_string())); + }; + Ok(()) +} + +/// get write mode for config +fn get_write_mode() -> Result<(ConfigWriteMode, bool), MescCliError> { + match ( + std::env::var("MESC_MODE").as_deref(), + std::env::var("MESC_PATH").as_deref(), + std::env::var("MESC_ENV").as_deref(), + !mesc::overrides::get_active_overrides().is_empty(), + ) { + (Ok("DISABLED"), _, _, _) => { + println!(" MESC is disabled because {}", "MESC_MODE=DISABLED".green().bold()); + println!( + " To enable MESC, set {} to {} or {} or unset it", + "MESC_MODE".green().bold(), + "PATH".green().bold(), + "ENV".green().bold() + ); + let config_mode = select_config_mode()?; + let modified_first = setup_mesc_mode_env_var(&config_mode)?; + let modified_second = setup_mesc_env_vars(&config_mode)?; + Ok((config_mode, !modified_first.is_empty() || !modified_second.is_empty())) + } + (Ok("PATH"), Ok(path), _, _) | (Err(_), Ok(path), _, _) => { + let path = mesc::load::expand_path(path)?; + println!(" MESC is {}", "enabled".green().bold()); + let print_path = + if let Ok(raw_path) = std::env::var("MESC_PATH") { raw_path } else { path.clone() }; + println!(" Using {}{}", "MESC_PATH=".green().bold(), print_path.green().bold()); + Ok((ConfigWriteMode::Path(path.into()), false)) + } + (Ok("PATH"), Err(_), _, _) => { + println!(" MESC is enabled"); + println!( + " Using {}, but {} is not set", + "MESC_MODE=PATH".green().bold(), + "MESC_PATH".green().bold() + ); + let path = select_config_path()?; + println!(" Using config path: {}", path.to_string_lossy().green().bold()); + let modified_files = setup_mesc_path_env_var(&path)?; + Ok((ConfigWriteMode::Path(path), !modified_files.is_empty())) + } + (Ok("ENV"), _, Ok(_env), _) | (Err(_), Err(_), Ok(_env), _) => { + println!(" MESC is enabled"); + println!(" Using {}", "MESC_MODE=ENV".green().bold()); + Ok((ConfigWriteMode::Env(vec![]), false)) + } + (Ok("ENV"), _, Err(_), _) => { + println!(" MESC is enabled"); + println!( + " Using {}, but {} is not set", + "MESC_MODE=ENV".green().bold(), + "MESC_ENV".green().bold() + ); + Ok((ConfigWriteMode::Env(vec![]), false)) + } + (Ok(other), _, _, _) => { + eprintln!("Invaild value for {}: {}", "MESC_MODE".green().bold(), other.green().bold()); + eprintln!( + "Either 1) unset this variable, or 2) set it to one of {{PATH, ENV, DISABLED}}" + ); + Err(MescCliError::Error("invalid MESC_MODE".to_string())) + } + (Err(_), Err(_), Err(_), true) => { + println!(" MESC is only enabled because overrides are set:"); + for var_name in mesc::overrides::get_active_overrides().iter() { + println!("- {}", var_name.bold().green()) + } + println!( + " To enable MESC more permanently, set either {} or {}", + "MESC_PATH".green().bold(), + "MESC_ENV".green().bold() + ); + let mode = select_config_mode()?; + let modified_files = setup_mesc_env_vars(&mode)?; + Ok((mode, !modified_files.is_empty())) + } + (Err(_), Err(_), Err(_), false) => { + println!(" MESC is disabled because no MESC env vars are set"); + println!(" To enable MESC, set one of the MESC env vars"); + let mode = select_config_mode()?; + let modified_files = setup_mesc_env_vars(&mode)?; + Ok((mode, !modified_files.is_empty())) + } + } +} + +/// load config data based on write mode +fn load_config_data(mode: &ConfigWriteMode) -> Result { + // attempt to load config data + let config = match mode { + ConfigWriteMode::Path(path) => { + // if path DNE that is ok, just start from scratch + // if invalid json, or other io error, ask to start from scratch break + let option_path = Some(path.to_string_lossy().into()); + match mesc::load::load_file_config(option_path) { + Ok(config) => Ok(config), + Err(MescError::MissingConfigFile(_)) => { + let config = RpcConfig::default(); + let prompt = "Config file does not exist, do you want to create one?"; + match inquire::Confirm::new(prompt).with_default(true).prompt() { + Ok(true) => { + mesc::write::write_config(config.clone(), path)?; + println!( + " Created blank config at {}", + path.to_string_lossy().bold().green() + ); + } + Ok(false) => { + println!(" Starting from blank config. Use \"Exit and save changes\" below to save"); + } + Err(_) => std::process::exit(1), + } + Ok(config) + } + Err(e) => Err(e), + } + } + ConfigWriteMode::Env(_) => { + // if env unset that is ok, just start from scratch + // if invalid json, ask to start from scratch, or break + match std::env::var("MESC_ENV") { + Ok(val) if !val.is_empty() => mesc::load::load_env_config(), + _ => { + println!(" {} var is empty, using blank config", "MESC_ENV".green().bold()); + Ok(RpcConfig::default()) + } + } + } + }; + + // create new config upon loading error + let config = match config { + Ok(config) => config, + Err(e) => { + eprintln!("Could not load config data: {}", format!("{}", e).red()); + let prompt = "How do you want to procede?"; + let options = vec!["Start a new config from scratch", "Exit setup"]; + match inquire::Select::new(prompt, options).prompt() { + Ok("Start a new config from scratch") => RpcConfig::default(), + _ => std::process::exit(1), + } + } + }; + + // ensure that config data is valid + let mut config = config.clone(); + loop { + match config.validate() { + Ok(()) => break, + Err(e) => { + eprintln!("Config data is not valid: {}", format!("{}", e).red()); + let prompt = "What do you want to do?"; + let options = + vec!["Create new config from scratch", "Edit the data manually", "Exit setup"]; + match inquire::Select::new(prompt, options).prompt() { + Ok("Create new config from scratch") => config = RpcConfig::default(), + Ok("Edit the data manually") => { + let new_config = edit::edit(serde_json::to_string(&config)?)?; + if let Ok(new_config) = serde_json::from_str(new_config.as_str()) { + config = new_config + } + } + Ok("Exit setup") | Ok(_) | Err(_) => std::process::exit(1), + } + } + }; + } + + Ok(config) +} + +fn setup_mesc_mode_env_var(mode: &ConfigWriteMode) -> Result, MescCliError> { + let value = match mode { + ConfigWriteMode::Path(_) => "PATH", + ConfigWriteMode::Env(_) => "ENV", + }; + modify_shell_config_var("MESC_MODE", value.to_string(), None) +} + +fn setup_mesc_env_vars(mode: &ConfigWriteMode) -> Result, MescCliError> { + match mode { + ConfigWriteMode::Path(path) => setup_mesc_path_env_var(path), + ConfigWriteMode::Env(_) => Ok(vec![]), + } +} + +fn setup_mesc_path_env_var(path: &std::path::Path) -> Result, MescCliError> { + let value = path.to_string_lossy().to_string(); + modify_shell_config_var("MESC_PATH", value, None) +} diff --git a/rust/crates/mesc_cli/src/cli/subcommands/setup/config_modification.rs b/rust/crates/mesc_cli/src/cli/subcommands/setup/config_modification.rs new file mode 100644 index 0000000..a2e468e --- /dev/null +++ b/rust/crates/mesc_cli/src/cli/subcommands/setup/config_modification.rs @@ -0,0 +1,79 @@ +use crate::MescCliError; +use inquire::InquireError; +use mesc::RpcConfig; + +use super::{defaults::*, endpoints::*, metadata::*, network_names::*, writing::*}; +use crate::cli::subcommands::help::print_interactive_help; +use toolstr::Colorize; + +pub(crate) async fn modify_existing_config( + config: RpcConfig, + config_write_mode: Option, +) -> Result<(), MescCliError> { + let options = [ + "Add new endpoint", + "Modify endpoint", + "Modify defaults", + "Modify metadata", + "Modify network names", + "Print config as JSON", + "Print help information", + "Exit and save changes", + "Exit without saving", + ] + .to_vec(); + let original_config = config.clone(); + let mut valid_config = config.clone(); + let mut config = config.clone(); + loop { + // modify config + match inquire::Select::new("What do you want to do?", options.clone()) + .with_page_size(10) + .prompt() + { + Ok("Add new endpoint") => add_endpoint(&mut config).await?, + Ok("Modify endpoint") => modify_endpoint(&mut config).await?, + Ok("Modify defaults") => modify_defaults(&mut config)?, + Ok("Modify metadata") => modify_global_metadata(&mut config).await?, + Ok("Modify network names") => modify_custom_network_names(&mut config).await?, + Ok("Print config as JSON") => { + println!(); + println!("{}", colored_json::to_colored_json_auto(&config)?); + println!(); + } + Ok("Print help information") => print_interactive_help()?, + Ok("Exit and save changes") => break, + Ok("Exit without saving") => return Ok(()), + Err(InquireError::OperationCanceled) => { + if config != original_config { + println!(" Exiting without saving"); + } else { + println!(" Exiting"); + } + std::process::exit(0) + } + Ok(_) | Err(_) => return Err(MescCliError::InvalidInput("invalid input".to_string())), + }; + + // validation + match config.validate() { + Ok(()) => {} + Err(e) => { + println!("Invalid data: {:?}", e); + println!("Reverting to previous config state"); + config = valid_config.clone(); + continue; + } + }; + + valid_config = config.clone(); + } + + // write file + if config != original_config { + write_config(config, config_write_mode)?; + } else { + println!(" {}", "No updates to save".bold()) + } + Ok(()) +} diff --git a/rust/crates/mesc_cli/src/cli/subcommands/setup/defaults.rs b/rust/crates/mesc_cli/src/cli/subcommands/setup/defaults.rs new file mode 100644 index 0000000..dfd2420 --- /dev/null +++ b/rust/crates/mesc_cli/src/cli/subcommands/setup/defaults.rs @@ -0,0 +1,156 @@ +use super::selectors::*; +use crate::{print_defaults, MescCliError}; +use inquire::InquireError; +use mesc::RpcConfig; + +pub(crate) fn modify_defaults(config: &mut RpcConfig) -> Result<(), MescCliError> { + println!(" Current defaults:"); + println!(); + print_defaults(config)?; + println!(); + + let options = [ + "Set the default endpoint", + "Set the default endpoint for network", + "Add new profile", + "Modify existing profile", + "Print current defaults", + "Done modifying defaults", + ] + .to_vec(); + + loop { + match inquire::Select::new("Which defaults do you want to modify?", options.clone()) + .prompt() + { + Ok("Set the default endpoint") => { + let prompt = "Which endpoint should be the default?"; + let endpoint_name = match select_endpoint(config, prompt)? { + Some(value) => value, + _ => return Ok(()), + }; + config.default_endpoint = Some(endpoint_name.clone()); + if let Some(endpoint) = + mesc::query::get_endpoint_by_name(config, endpoint_name.as_str())? + { + if let Some(chain_id) = endpoint.chain_id { + config.network_defaults.insert(chain_id, endpoint_name); + }; + } + } + Ok("Set the default endpoint for network") => { + let prompt = "Set the default endpoint for which network?"; + let chain_id = match select_config_chain_id(config, prompt)? { + Some(value) => value, + _ => return Ok(()), + }; + let prompt = "What should be the default endpoint for this network?"; + let endpoint_name = match select_endpoint_of_network(config, &chain_id, prompt)? { + Some(value) => value, + _ => return Ok(()), + }; + config.network_defaults.insert(chain_id, endpoint_name); + } + Ok("Add new profile") => { + let name = match inquire::Text::new("Name?").prompt() { + Ok(answer) => answer, + Err(InquireError::OperationCanceled) => return Ok(()), + _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), + }; + if config.profiles.contains_key(&name) { + println!(); + } else { + config.profiles.insert(name.clone(), mesc::Profile::new(name)); + println!(" profile added"); + } + } + Ok("Modify existing profile") => { + if config.profiles.is_empty() { + println!(" no profiles are currently configured"); + continue; + } + + let profile_name = match select_profile(config, "Which profile to modify?")? { + Some(value) => value, + _ => return Ok(()), + }; + let options = vec![ + "Set the profile's name", + "Set the profile's default endpoint", + "Set the profile's default endpoint for a network", + ]; + match inquire::Select::new("What to modify?", options).prompt() { + Ok("Set the profile's name") => { + let new_name = match inquire::Text::new("New name?").prompt() { + Ok(answer) => answer, + Err(InquireError::OperationCanceled) => return Ok(()), + _ => { + return Err(MescCliError::InvalidInput("invalid input".to_string())) + } + }; + if config.profiles.contains_key(&new_name) { + println!("profile with this name already exists"); + continue; + }; + if let Some(mut profile) = config.profiles.remove(&profile_name) { + profile.name = new_name.clone(); + config.profiles.insert(new_name, profile); + } else { + println!("profile not present"); + } + } + Ok("Set the profile's default endpoint") => { + let prompt = "Which endpoint to use as profile default?"; + let default_endpoint = match select_endpoint(config, prompt)? { + Some(value) => value, + _ => return Ok(()), + }; + if let Some(endpoint) = + mesc::query::get_endpoint_by_name(config, &default_endpoint)? + { + if let Some(profile) = config.profiles.get_mut(&profile_name) { + profile.default_endpoint = Some(default_endpoint.clone()); + if let Some(chain_id) = endpoint.chain_id.clone() { + profile.network_defaults.insert(chain_id, default_endpoint); + } + } else { + println!("profile not present"); + } + } + } + Ok("Set the profile's default endpoint for a network") => { + let prompt = "Set the profile's default endpoint for which network?"; + let chain_id = match select_config_chain_id(config, prompt)? { + Some(value) => value, + _ => return Ok(()), + }; + let prompt = "What should be the default endpoint for this network?"; + let endpoint_name = + match select_endpoint_of_network(config, &chain_id, prompt)? { + Some(value) => value, + _ => return Ok(()), + }; + if let Some(profile) = config.profiles.get_mut(&profile_name) { + profile.network_defaults.insert(chain_id, endpoint_name); + } else { + println!("profile not present"); + } + } + Err(InquireError::OperationCanceled) => return Ok(()), + _ => { + println!("invalid input"); + } + } + } + Ok("Print current defaults") => { + println!("Current defaults:"); + println!(); + print_defaults(config)?; + println!(); + } + Ok("Done modifying defaults") => return Ok(()), + Err(InquireError::OperationCanceled) => return Ok(()), + _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), + } + } +} diff --git a/rust/crates/mesc_cli/src/cli/subcommands/setup/endpoints.rs b/rust/crates/mesc_cli/src/cli/subcommands/setup/endpoints.rs new file mode 100644 index 0000000..166906a --- /dev/null +++ b/rust/crates/mesc_cli/src/cli/subcommands/setup/endpoints.rs @@ -0,0 +1,207 @@ +use crate::{network::is_ip, MescCliError}; +use inquire::InquireError; +use mesc::{Endpoint, RpcConfig}; +use std::collections::{HashMap, HashSet}; +use toolstr::Colorize; + +use super::{metadata::*, selectors::*}; + +pub(crate) async fn add_endpoint(config: &mut RpcConfig) -> Result<(), MescCliError> { + let url = match inquire::Text::new("New endpoint URL?").prompt() { + Ok(input) => input, + Err(InquireError::OperationCanceled) => return Ok(()), + Err(_) => return Err(MescCliError::InvalidInput("invalid input".to_string())), + }; + + // add transport protocol + let url = if !url.starts_with("http") & !url.starts_with("ws") & !url.ends_with(".ipc") { + if url.starts_with("localhost") | is_ip(&url) { + let url = format!("http://{}", url); + println!( + " Transport protocol not included. Defaulting to http: {}", + url.green().bold() + ); + url + } else { + let url = format!("https://{}", url); + println!( + " Transport protocol not included. Defaulting to https: {}", + url.green().bold() + ); + url + } + } else { + url + }; + + // get chain_id + println!(" Querying chain id..."); + let client = reqwest::Client::builder().timeout(std::time::Duration::from_secs(4)).build()?; + let chain_id = crate::rpc::request_chain_id(client, url.clone()).await; + let chain_id = match chain_id { + Ok(chain_id) => { + println!(" {} {}", "Using chain_id".bold(), chain_id.to_string().green()); + Some(chain_id) + } + _ => { + println!(" {}", "Could not detect chain id".red()); + select_chain_id("How to proceed?".to_string()).await? + } + }; + + // get name + let default_name = mesc::overrides::get_default_endpoint_name(&url, chain_id.clone()); + let mut input = inquire::Text::new("New endpoint name?"); + if let Some(default_name) = default_name.as_ref() { + input = input.with_default(default_name); + } + let name = match input.prompt() { + Ok(choice) => choice, + Err(InquireError::OperationCanceled) => return Ok(()), + Err(_) => return Err(MescCliError::InvalidInput("invalid input".to_string())), + }; + + // create endpoint + let endpoint = Endpoint { url, name, chain_id, endpoint_metadata: HashMap::new() }; + config.endpoints.insert(endpoint.name.clone(), endpoint); + println!(" {}", "New endpoint added".bold()); + Ok(()) +} + +pub(crate) async fn modify_endpoint(config: &mut RpcConfig) -> Result<(), MescCliError> { + // select endpoint + let mut options: Vec = config.endpoints.clone().into_keys().collect(); + if options.is_empty() { + println!(" No endpoints to modify"); + return Ok(()); + } + options.sort(); + let endpoint_name = match inquire::Select::new("Which endpoint to modify?", options).prompt() { + Ok(name) => name, + Err(InquireError::OperationCanceled) => return Ok(()), + _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), + }; + let endpoint = match config.endpoints.get(&endpoint_name) { + Some(endpoint) => endpoint.clone(), + None => return Err(MescCliError::InvalidInput("endpoint does not exist".to_string())), + }; + println!(" {}", "Current endpoint data:".bold(),); + println!(); + let colored = colored_json::to_colored_json_auto(&serde_json::to_value(&endpoint)?)?; + for line in colored.split('\n') { + println!(" {}", line); + } + println!(); + + // gather modifications + let halt_options: HashSet<&str> = vec!["Delete endpoint", "Done"].into_iter().collect(); + let mut option = query_modify_endpoint(endpoint_name.clone(), config, true).await?; + loop { + if halt_options.contains(option.as_str()) { + break; + } + option = query_modify_endpoint(endpoint_name.clone(), config, false).await?; + } + + // commit modifications + if option != "Delete endpoint" { + let new_endpoint = match config.endpoints.get(&endpoint_name) { + Some(endpoint) => endpoint.clone(), + None => return Err(MescCliError::InvalidInput("endpoint does not exist".to_string())), + }; + if new_endpoint == endpoint { + println!(" Endpoint unmodified"); + } else { + println!(" {}", "New endpoint data:".bold(),); + println!(); + let colored = colored_json::to_colored_json_auto(&serde_json::to_value(endpoint)?)?; + for line in colored.split('\n') { + println!(" {}", line); + } + println!(); + } + } + + Ok(()) +} + +pub(crate) async fn query_modify_endpoint( + endpoint_name: String, + config: &mut RpcConfig, + first_change: bool, +) -> Result { + let options = [ + "Modify endpoint name", + "Modify endpoint url", + "Modify endpoint chain_id", + "Modify endpoint metadata", + "Delete endpoint", + "Print endpoint as JSON", + "Done", + ] + .to_vec(); + + let message = if first_change { "How to modify endpoint?" } else { "Any other modifications?" }; + + let option = match inquire::Select::new(message, options.clone()).prompt() { + Ok(answer) => answer, + Err(InquireError::OperationCanceled) => return Ok("Done".to_string()), + _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), + }; + + match option { + "Modify endpoint name" => { + let new_name = match inquire::Text::new("New name?").prompt() { + Ok(answer) => answer, + Err(InquireError::OperationCanceled) => return Ok("Done".to_string()), + _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), + }; + mesc::write::update_endpoint_name(config, endpoint_name.as_str(), new_name.as_str())?; + } + "Modify endpoint url" => { + let new_url = match inquire::Text::new("New url?").prompt() { + Ok(answer) => answer, + Err(InquireError::OperationCanceled) => return Ok("Done".to_string()), + _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), + }; + if let Some(endpoint) = config.endpoints.get_mut(&endpoint_name) { + endpoint.url = new_url; + } + } + "Modify endpoint chain_id" => { + match select_chain_id("New chain_id?".to_string()).await { + Ok(Some(chain_id)) => mesc::write::update_endpoint_chain_id( + config, + endpoint_name.as_str(), + chain_id.clone(), + )?, + Ok(None) => return Ok("Done".to_string()), + _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), + }; + } + "Modify endpoint metadata" => modify_endpoint_metadata(endpoint_name.as_str(), config)?, + "Delete endpoint" => { + mesc::write::delete_endpoint(config, endpoint_name.as_str())?; + println!("{} {}", "Deleted endpoint:".red(), endpoint_name.green()); + } + "Print endpoint as JSON" => { + let endpoint = match config.endpoints.get(&endpoint_name) { + Some(endpoint) => endpoint.clone(), + None => { + return Err(MescCliError::InvalidInput("endpoint does not exist".to_string())) + } + }; + println!(" {}", "Current endpoint data:".bold(),); + println!(); + let colored = colored_json::to_colored_json_auto(&serde_json::to_value(endpoint)?)?; + for line in colored.split('\n') { + println!(" {}", line); + } + println!(); + } + "Done" => {} + _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), + }; + + Ok(option.to_string()) +} diff --git a/rust/crates/mesc_cli/src/cli/subcommands/setup/inquire_utils.rs b/rust/crates/mesc_cli/src/cli/subcommands/setup/inquire_utils.rs new file mode 100644 index 0000000..9064f12 --- /dev/null +++ b/rust/crates/mesc_cli/src/cli/subcommands/setup/inquire_utils.rs @@ -0,0 +1,25 @@ +use inquire::ui::{Attributes, Color, IndexPrefix, RenderConfig, StyleSheet, Styled}; + +pub(crate) fn get_render_config() -> RenderConfig<'static> { + let highlight_color = Color::DarkGreen; + + let mut render_config = RenderConfig::default(); + render_config.prompt = StyleSheet::new().with_attr(Attributes::BOLD); + render_config.prompt_prefix = Styled::new("").with_fg(Color::LightRed); + render_config.answered_prompt_prefix = Styled::new("").with_fg(Color::LightRed); + render_config.placeholder = StyleSheet::new().with_fg(Color::LightRed); + render_config.selected_option = Some(StyleSheet::new().with_fg(highlight_color)); + render_config.highlighted_option_prefix = Styled::new("→").with_fg(highlight_color); + render_config.selected_checkbox = Styled::new("☑").with_fg(highlight_color); + render_config.scroll_up_prefix = Styled::new("⇞"); + render_config.scroll_down_prefix = Styled::new("⇟"); + render_config.unselected_checkbox = Styled::new("☐"); + render_config.option_index_prefix = IndexPrefix::Simple; + render_config.error_message = + render_config.error_message.with_prefix(Styled::new("❌").with_fg(Color::LightRed)); + render_config.answer = StyleSheet::new().with_attr(Attributes::BOLD).with_fg(highlight_color); + let grey = Color::Rgb { r: 100, g: 100, b: 100 }; + render_config.help_message = StyleSheet::new().with_fg(grey).with_attr(Attributes::ITALIC); + + render_config +} diff --git a/rust/crates/mesc_cli/src/cli/subcommands/setup/metadata.rs b/rust/crates/mesc_cli/src/cli/subcommands/setup/metadata.rs new file mode 100644 index 0000000..1c4988b --- /dev/null +++ b/rust/crates/mesc_cli/src/cli/subcommands/setup/metadata.rs @@ -0,0 +1,210 @@ +use crate::MescCliError; +use inquire::InquireError; +use mesc::RpcConfig; +use std::collections::HashMap; +use toolstr::Colorize; + +use super::selectors::*; + +pub(crate) fn modify_endpoint_metadata( + endpoint_name: &str, + config: &mut RpcConfig, +) -> Result<(), MescCliError> { + let endpoint = match config.endpoints.get_mut(endpoint_name) { + Some(endpoint) => endpoint, + None => { + return Err(MescCliError::InvalidInput(format!("missing endpoint: {}", endpoint_name))) + } + }; + let options = vec![ + "Add label", + "Remove label", + "Set ratelimit", + "Set API key", + "Edit raw JSON", + "Done editing metadata", + ]; + match inquire::Select::new("How to modify metadata?", options).prompt() { + Ok("Add label") => { + let new_label = match inquire::Text::new("What is the new label?").prompt() { + Ok(new_label) => new_label, + Err(InquireError::OperationCanceled) => return Ok(()), + _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), + }; + if endpoint.endpoint_metadata.get_mut("labels").is_none() { + endpoint + .endpoint_metadata + .insert("labels".to_string(), serde_json::json!(Vec::::new())); + }; + let labels = endpoint.endpoint_metadata.get_mut("labels").unwrap(); + if let Some(array) = labels.as_array_mut() { + array.push(serde_json::Value::String(new_label)); + println!(" Added label") + } else { + println!("Incorrectly formatted data, labels is not a list"); + }; + } + Ok("Remove label") => { + match endpoint.endpoint_metadata.get_mut("labels") { + Some(serde_json::Value::Array(labels)) => { + let label_strings: Vec<&str> = + labels.iter().filter_map(|val| val.as_str()).collect(); + if label_strings.is_empty() { + println!("No labels for endpoint"); + return Ok(()); + }; + match inquire::Select::new("Which label to remove?", label_strings.clone()) + .prompt() + { + Ok(label) => { + if let Some(index) = + label_strings.iter().position(|test_label| test_label == &label) + { + labels.remove(index); + } else { + println!("Label not found."); + } + } + Err(InquireError::OperationCanceled) => return Ok(()), + _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), + } + } + Some(_) => { + println!("Incorrectly formatted data, labels is not a list"); + } + None => { + println!(" Endpoint does not have any labels") + } + }; + } + Ok("Set ratelimit") => { + let message = "What is the rate limit, in requests per second?"; + let value = match inquire::CustomType::::new(message) + .with_formatter(&|i| format!("{:.2}", i)) + .with_error_message("Please type a valid number") + .with_help_message(" Enter the number of requests per seconds") + .prompt() + { + Ok(value) => value, + Err(InquireError::OperationCanceled) => return Ok(()), + _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), + }; + endpoint + .endpoint_metadata + .insert("rate_limit_rps".to_string(), serde_json::json!(value)); + } + Ok("Set API key") => { + let api_key = match inquire::Text::new("What is the API key?").prompt() { + Ok(api_key) => api_key, + Err(InquireError::OperationCanceled) => return Ok(()), + _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), + }; + endpoint.endpoint_metadata.insert("api_key".to_string(), serde_json::json!(api_key)); + } + Ok("Edit raw JSON") => { + let edited = edit::edit(serde_json::to_string(&endpoint.endpoint_metadata)?)?; + let value: Result, serde_json::Error> = + serde_json::from_str(&edited); + endpoint.endpoint_metadata = value?; + } + Ok("Done editing metadata") => return Ok(()), + Err(InquireError::OperationCanceled) => return Ok(()), + _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), + } + Ok(()) +} + +pub(crate) async fn modify_global_metadata(config: &mut RpcConfig) -> Result<(), MescCliError> { + loop { + let options = vec![ + "Modify global metadata as JSON", + "Modify profile metadata as JSON", + "Modify endpoint metadata", + "Print global metadata", + "Print profiles metadata", + "Back to main menu", + ]; + match inquire::Select::new("What do you want to do?", options).prompt() { + Ok("Modify global metadata as JSON") => { + let old_metadata = serde_json::to_string(&config.global_metadata)?; + let new_metadata = edit::edit(&old_metadata)?; + if old_metadata == new_metadata { + println!(" {}", "Global metadata unchanged".bold()); + } else { + let value: Result, serde_json::Error> = + serde_json::from_str(&new_metadata); + match value { + Ok(value) => { + config.global_metadata = value; + println!(" {}", "Global metadata updated".bold()); + } + Err(_) => { + println!(" {}", "Invalid JSON, ignoring".red().bold()) + } + } + } + } + Ok("Modify profile metadata as JSON") => { + if config.profiles.is_empty() { + println!(" No profiles in config"); + } else if let Some(profile_name) = select_profile(config, "Which profile?")? { + if let Some(profile) = config.profiles.get(&profile_name) { + let old_metadata = serde_json::to_string(&profile.profile_metadata)?; + let new_metadata = edit::edit(&old_metadata)?; + if old_metadata == new_metadata { + println!(" {}", "Profile metadata unchanged".bold()); + } else { + let value: Result< + HashMap, + serde_json::Error, + > = serde_json::from_str(&new_metadata); + match value { + Ok(value) => { + config.global_metadata = value; + println!(" {}", "Profile metadata updated".bold()); + } + Err(_) => { + println!(" {}", "Invalid JSON, ignoring".red().bold()) + } + } + } + } + } else { + return Ok(()); + } + } + Ok("Modify endpoint metadata") => { + if config.endpoints.is_empty() { + println!(" No endpoints in config"); + } else if let Some(endpoint) = select_endpoint(config, "Which endpoint?")? { + modify_endpoint_metadata(endpoint.as_str(), config)?; + } else { + return Ok(()); + } + } + Ok("Print global metadata") => { + println!(); + println!("{}", colored_json::to_colored_json_auto(&config.global_metadata)?); + println!(); + } + Ok("Print profiles metadata") => { + if config.profiles.is_empty() { + println!(" No profiles in config"); + } else { + println!(); + for (profile_name, profile) in config.profiles.iter() { + println!("profile: {}:", profile_name.bold().white()); + println!( + "{}", + colored_json::to_colored_json_auto(&profile.profile_metadata)? + ); + println!(); + } + } + } + Ok("Back to main menu") => return Ok(()), + Err(InquireError::OperationCanceled) => return Ok(()), + _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), + } + } +} diff --git a/rust/crates/mesc_cli/src/cli/subcommands/setup/mod.rs b/rust/crates/mesc_cli/src/cli/subcommands/setup/mod.rs new file mode 100644 index 0000000..80b49f4 --- /dev/null +++ b/rust/crates/mesc_cli/src/cli/subcommands/setup/mod.rs @@ -0,0 +1,12 @@ +mod command; +mod config_modification; +mod defaults; +mod endpoints; +mod inquire_utils; +mod metadata; +mod network_names; +mod selectors; +mod shell_config; +mod writing; + +pub(crate) use command::setup_command; diff --git a/rust/crates/mesc_cli/src/cli/subcommands/setup/network_names.rs b/rust/crates/mesc_cli/src/cli/subcommands/setup/network_names.rs new file mode 100644 index 0000000..e7a7dab --- /dev/null +++ b/rust/crates/mesc_cli/src/cli/subcommands/setup/network_names.rs @@ -0,0 +1,96 @@ +use crate::MescCliError; +use inquire::InquireError; +use mesc::{RpcConfig, TryIntoChainId}; +use toolstr::Colorize; + +use super::selectors::*; + +pub(crate) async fn modify_custom_network_names( + config: &mut RpcConfig, +) -> Result<(), MescCliError> { + print_custom_network_names(config); + + loop { + let options = if config.network_names.is_empty() { + vec![ + "Add custom network name", + "Print custom network names", + "Done editing custom names", + ] + } else { + vec![ + "Add custom network name", + "Edit custom network name", + "Remove custom network name", + "Print custom network names", + "Done editing custom names", + ] + }; + match inquire::Select::new("What do you want to do?", options).prompt() { + Ok("Add custom network name") => { + let name = match inquire::Text::new("Custom network name?").prompt() { + Ok(name) => name, + Err(InquireError::OperationCanceled) => continue, + _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), + }; + loop { + match inquire::Text::new("What is the chain id?").prompt() { + Ok(chain_id) => match chain_id.try_into_chain_id() { + Ok(chain_id) => { + config.network_names.insert(name.clone(), chain_id); + println!(" Custom network name added"); + break; + } + _ => { + println!(" not a valid chain id"); + continue; + } + }, + Err(InquireError::OperationCanceled) => break, + _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), + } + } + } + Ok("Edit custom network name") => match select_custom_network_name(config) { + Ok(Some(old_name)) => match inquire::Text::new("New name?").prompt() { + Ok(new_name) => match config.network_names.remove(&old_name) { + Some(chain_id) => { + config.network_names.insert(new_name, chain_id); + } + None => continue, + }, + Err(InquireError::OperationCanceled) => return Ok(()), + _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), + }, + Ok(None) => return Ok(()), + _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), + }, + Ok("Remove custom network name") => match select_custom_network_name(config) { + Ok(Some(name)) => { + config.network_names.remove(&name); + println!(" Name removed"); + } + Ok(None) => return Ok(()), + _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), + }, + Ok("Print custom network names") => print_custom_network_names(config), + Ok("Done editing custom names") => return Ok(()), + Err(InquireError::OperationCanceled) => return Ok(()), + _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), + } + } +} + +fn print_custom_network_names(config: &RpcConfig) { + if config.network_names.is_empty() { + println!(" No custom network names currently being used"); + } else { + println!( + " {} custom network names currently being used:", + config.network_names.len().to_string().green().bold() + ); + for (network_name, chain_id) in config.network_names.iter() { + println!(" - {} = {}", network_name.bold(), chain_id.to_string().green().bold()); + } + }; +} diff --git a/rust/crates/mesc_cli/src/cli/subcommands/setup/selectors.rs b/rust/crates/mesc_cli/src/cli/subcommands/setup/selectors.rs new file mode 100644 index 0000000..614be51 --- /dev/null +++ b/rust/crates/mesc_cli/src/cli/subcommands/setup/selectors.rs @@ -0,0 +1,245 @@ +use crate::MescCliError; +use inquire::{ui::IndexPrefix, InquireError}; +use mesc::{ChainId, RpcConfig, TryIntoChainId}; +use std::collections::HashSet; +use toolstr::Colorize; + +use super::{inquire_utils::*, writing::*}; + +pub(crate) async fn select_chain_id(prompt: String) -> Result, MescCliError> { + let options = vec![ + "Search known network names", + "Enter endpoint chain id manually", + "Do not use a chain id for this endpoint", + ]; + loop { + match inquire::Select::new(prompt.as_str(), options.clone()).prompt() { + Ok("Do not use a chain id for this endpoint") => return Ok(None), + Ok("Enter endpoint chain id manually") => { + match inquire::Text::new("Chain id?").prompt() { + Ok(text) => { + match text.try_into_chain_id() { + Ok(chain_id) => return Ok(Some(chain_id)), + _ => continue, + }; + } + Err(InquireError::OperationCanceled) => return Ok(None), + _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), + } + } + Ok("Search known network names") => { + println!( + " Fetching network names from {}...", + "https://chainid.network".green().bold() + ); + match select_chain_id_by_name().await { + Ok(Some(chain_id)) => return Ok(Some(chain_id)), + Ok(None) => return Ok(None), + _ => { + println!(" Exiting without saving"); + std::process::exit(0); + } + } + } + Err(InquireError::OperationCanceled) => return Ok(None), + _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), + } + } +} + +pub(crate) async fn select_chain_id_by_name() -> Result, MescCliError> { + let network_list = match crate::network::fetch_network_list().await { + Ok(mapping) => mapping, + Err(_) => { + println!(" could not retrieve network list"); + return Ok(None); + } + }; + let mut pairs: Vec<(ChainId, String)> = network_list.into_iter().collect(); + pairs.sort_by(|(a, _), (b, _)| a.cmp(b)); + + let options: Vec<_> = + pairs.iter().map(|(chain_id, name)| format!("{}) {}", chain_id, name)).collect(); + let mut render_config = get_render_config(); + render_config.option_index_prefix = IndexPrefix::None; + match inquire::Select::new("Which network?", options.clone()) + .with_render_config(render_config) + .prompt() + { + Ok(answer) => match options.iter().position(|option| option == &answer) { + Some(index) => match pairs.get(index) { + Some((chain_id, _)) => Ok(Some(chain_id.clone())), + None => Ok(None), + }, + None => Err(MescCliError::InvalidInput("bad input".to_string())), + }, + Err(InquireError::OperationCanceled) => Ok(None), + _ => Err(MescCliError::Error("invalid input".to_string())), + } +} + +pub(crate) fn select_custom_network_name( + config: &RpcConfig, +) -> Result, MescCliError> { + let names: Vec<_> = config.network_names.keys().collect(); + if names.is_empty() { + return Ok(None); + } + match inquire::Select::new("Which custom name?", names).prompt() { + Ok(name) => Ok(Some(name.clone())), + Err(InquireError::OperationCanceled) => Ok(None), + _ => Err(MescCliError::InvalidInput("invalid input".to_string())), + } +} + +pub(crate) fn select_endpoint( + config: &RpcConfig, + prompt: &str, +) -> Result, MescCliError> { + let mut options: Vec = config.endpoints.clone().into_keys().collect(); + if options.is_empty() { + return Ok(None); + } + options.sort(); + match inquire::Select::new(prompt, options).prompt() { + Ok(answer) => Ok(Some(answer)), + Err(InquireError::OperationCanceled) => Ok(None), + _ => Err(MescCliError::InvalidInput("invalid input".to_string())), + } +} + +pub(crate) fn select_endpoint_of_network( + config: &RpcConfig, + chain_id: &ChainId, + prompt: &str, +) -> Result, MescCliError> { + let mut options: Vec = config + .endpoints + .clone() + .values() + .filter(|endpoint| endpoint.chain_id.as_ref() == Some(chain_id)) + .map(|endpoint| endpoint.name.clone()) + .collect(); + if options.is_empty() { + return Ok(None); + } + options.sort(); + match inquire::Select::new(prompt, options).prompt() { + Ok(answer) => Ok(Some(answer)), + Err(InquireError::OperationCanceled) => Ok(None), + _ => Err(MescCliError::InvalidInput("invalid input".to_string())), + } +} + +pub(crate) fn select_profile( + config: &RpcConfig, + prompt: &str, +) -> Result, MescCliError> { + let mut options: Vec<_> = config.profiles.keys().collect(); + if options.is_empty() { + return Ok(None); + } + options.sort(); + match inquire::Select::new(prompt, options).prompt() { + Ok(answer) => Ok(Some(answer.to_string())), + Err(InquireError::OperationCanceled) => Ok(None), + _ => Err(MescCliError::InvalidInput("invalid input".to_string())), + } +} + +pub(crate) fn select_config_chain_id( + config: &RpcConfig, + prompt: &str, +) -> Result, MescCliError> { + let mut chain_ids = config + .endpoints + .values() + .filter_map(|endpoint| endpoint.chain_id.clone()) + .collect::>() + .into_iter() + .collect::>(); + chain_ids.sort(); + let options: Vec = chain_ids + .iter() + .map(|chain_id| match mesc::directory::get_network_name(chain_id) { + Some(name) => format!("{chain_id}) {name}"), + None => chain_id.to_string(), + }) + .collect(); + let input = match inquire::Select::new(prompt, options.clone()).prompt() { + Ok(answer) => answer, + Err(InquireError::OperationCanceled) => return Ok(None), + _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), + }; + match options.iter().position(|x| x == &input) { + Some(index) => Ok(Some(chain_ids[index].clone())), + None => Err(MescCliError::Error("invalid input".to_string())), + } +} + +pub(crate) fn select_config_mode() -> Result { + let prompt = "Do you want to store your MESC config in a file or in an env var?"; + let options = vec!["File (recommended)", "Environment Variable"]; + match inquire::Select::new(prompt, options).prompt() { + Ok("File (recommended)") => Ok(ConfigWriteMode::Path(select_config_path()?)), + Ok("Environment Variable") => Ok(ConfigWriteMode::Env(vec![])), + Ok(_) | Err(_) => { + eprintln!("Aborting setup"); + std::process::exit(1); + } + } +} + +pub(crate) fn select_config_path() -> Result { + loop { + let prompt = "Where to save MESC config file?"; + match inquire::Text::new(prompt).with_default("~/mesc.json").prompt() { + Ok(path) => { + let path = mesc::load::expand_path(path)?; + let path = std::path::Path::new(path.as_str()); + if path.exists() { + if path.is_file() { + match path.extension().map(|ext| ext.to_string_lossy()) { + Some(ext) if ext == "json" => return Ok(path.to_path_buf()), + _ => { + let prompt = "Use file even without a .json file extension?"; + if let Ok(true) = + inquire::Confirm::new(prompt).with_default(false).prompt() + { + return Ok(path.to_path_buf()); + } + } + } + } else if path.is_dir() { + let path = path.join("mesc.json"); + println!("Treating as a directory, will save to {}", path.display()); + return Ok(path); + } else { + println!("Not a valid file path"); + } + } else { + match path.extension() { + Some(ext) if ext == "json" => return Ok(path.to_path_buf()), + Some(_) => { + let prompt = "Use file even without a .json file extension?"; + if let Ok(true) = + inquire::Confirm::new(prompt).with_default(false).prompt() + { + return Ok(path.to_path_buf()); + } + } + None => { + let path = path.join("mesc.json"); + println!("Treating as a directory, will save to {}", path.display()); + return Ok(path); + } + } + } + } + Err(_) => { + eprintln!("Aborting setup"); + std::process::exit(1); + } + } + } +} diff --git a/rust/crates/mesc_cli/src/cli/subcommands/setup/shell_config.rs b/rust/crates/mesc_cli/src/cli/subcommands/setup/shell_config.rs new file mode 100644 index 0000000..c3de2f5 --- /dev/null +++ b/rust/crates/mesc_cli/src/cli/subcommands/setup/shell_config.rs @@ -0,0 +1,261 @@ +use crate::MescCliError; + +use std::{ + fs::{File, OpenOptions}, + io::{BufRead, BufReader, Write}, + path::{Path, PathBuf}, +}; +use toolstr::Colorize; + +#[derive(Hash, PartialEq, Eq)] +pub(crate) struct Mention { + pub(crate) path: PathBuf, + pub(crate) env_var: String, + pub(crate) simple_value: Option, + pub(crate) line: String, +} + +pub(crate) fn get_shell_config_paths() -> Result, MescCliError> { + let home_dir = + std::env::var("HOME").map_err(|_| MescCliError::Error("home dir not found".to_string()))?; + let home_path = PathBuf::from(home_dir); + let mut candidates = vec![home_path.join(".bashrc"), home_path.join(".profile")]; + + // paths added only if they exist + for path in [home_path.join(".zshrc")] { + if path.exists() { + candidates.push(path) + } + } + + Ok(candidates) +} + +/// return list of modified files +pub(crate) fn modify_shell_config_var( + var_name: &str, + value: String, + paths: Option>, +) -> Result, MescCliError> { + // decide where to look + let shell_configs = match paths { + Some(paths) => paths, + None => get_shell_config_paths()?, + }; + + // detect where env var is currently defined + let mut not_set: Vec = Vec::new(); + let mut complex_mentions: Vec = Vec::new(); + let mut set_already: Vec = Vec::new(); + let mut set_wrong: Vec = Vec::new(); + for path in shell_configs.into_iter() { + let mentions = find_env_var_mentions(var_name, &path)?; + if mentions.is_empty() { + not_set.push(path) + } else if mentions.iter().all(|m| m.simple_value.is_none()) { + complex_mentions.push(path) + } else if mentions.iter().all(|m| m.simple_value == Some(value.clone())) { + set_already.push(path) + } else { + set_wrong.push(path) + } + } + + // modify shell configs accordingly + match (not_set.len(), complex_mentions.len(), set_wrong.len(), set_already.len()) { + (0, 0, 0, 0) => { + println!(" No shell config files specified"); + Ok(vec![]) + } + (n_not_set, n_set_complex, n_set_wrong, n_set_already) => { + println!(" Need to set {} in order to use this file", "MESC_PATH".green().bold()); + if n_set_already > 0 { + println!( + " {} is already set to the desired value in {} shell config files", + var_name.bold().green(), + n_set_already.to_string().green().bold() + ); + for (i, path) in set_already.iter().enumerate() { + println!(" {}. {}", i + 1, path.to_string_lossy().green().bold()); + } + } + if n_set_complex > 0 { + println!(" {} is already set in a complex, non-standard way for {} shell config files. You must edit these files manually: {:?}", var_name.green().bold(), n_set_complex.to_string().green().bold(), get_file_names(&complex_mentions)); + for (i, path) in complex_mentions.iter().enumerate() { + println!(" {}. {}", i + 1, path.to_string_lossy().green().bold()); + } + } + if n_not_set + n_set_wrong > 0 { + let to_change: Vec<_> = not_set.into_iter().chain(set_wrong).collect(); + edit_shell_config_files_to_value(var_name, value, to_change) + } else { + Ok(vec![]) + } + } + } +} + +fn edit_shell_config_files_to_value( + var_name: &str, + value: String, + to_edit: Vec, +) -> Result, MescCliError> { + println!( + " {} can be automatically updated for {} shell config files:", + var_name.bold().green(), + format!("{}", to_edit.len()).green().bold(), + ); + for (i, path) in to_edit.iter().enumerate() { + println!(" {}. {}", i + 1, path.to_string_lossy().green().bold()); + } + let mut to_edit: std::collections::HashSet = to_edit.into_iter().collect(); + + let prompt = "What do you want to do?"; + let options = vec![ + "Edit these files automatically (recommended)", + "Edit these files manually in editor", + "Choose a subset of these files", + "Ignore this for now", + "Exit setup", + ]; + let original_to_edit = to_edit.clone(); + let edited = loop { + match inquire::Select::new(prompt, options.clone()).prompt() { + Ok("Edit these files automatically (recommended)") => { + for path in to_edit.iter() { + replace_mentions(path, var_name, &value)? + } + break to_edit.into_iter().collect(); + } + Ok("Edit these files manually in editor") => { + for path in to_edit.iter() { + edit::edit_file(path)?; + } + break to_edit.into_iter().collect(); + } + Ok("Choose a subset of these files") => { + to_edit = match inquire::MultiSelect::new( + "Select which files to edit", + original_to_edit + .clone() + .into_iter() + .map(|x| x.to_string_lossy().to_string()) + .collect(), + ) + .prompt() + { + Ok(paths) => { + println!(" Selected {} files", paths.len().to_string().bold().green()); + paths.iter().map(|p| PathBuf::from(p.to_string())).collect() + } + Err(_) => continue, + } + } + Ok("Ignore this for now") => break vec![], + Ok("Exit setup") | Ok(_) | Err(_) => std::process::exit(0), + }; + }; + + match edited.len() { + 0 => println!(" {} not updated in any shell config files", var_name.green().bold()), + 1 => println!(" {} updated in 1 config file", var_name.green().bold()), + n => println!(" Edited {} config files", n.to_string().green().bold()), + }; + + Ok(edited) +} + +/// Find mentions of environment variable in path +pub(crate) fn find_env_var_mentions( + env_var: &str, + path: &PathBuf, +) -> Result, MescCliError> { + let mut mentions: Vec = Vec::new(); + if path.exists() { + let file = File::open(path)?; + let reader = BufReader::new(file); + for line in reader.lines() { + let line = line?; + if line.trim_start().starts_with('#') { + continue; + } + if let Some(value) = extract_simple_value(&line, env_var) { + mentions.push(Mention { + path: path.clone(), + env_var: env_var.to_string(), + simple_value: Some(value), + line: line.clone(), + }); + } else if line.contains(env_var) { + mentions.push(Mention { + path: path.clone(), + env_var: env_var.to_string(), + simple_value: None, + line, + }); + } + } + } + Ok(mentions) +} + +/// Helper function to extract the simple value from a line, if present +fn extract_simple_value(line: &str, env_var: &str) -> Option { + if line.starts_with(&format!("export {}=", env_var)) { + line.split_once('=').map(|(_, value)| value.to_string()) + } else { + None + } +} + +/// Helper function to get a list of file names from a list of paths +fn get_file_names(paths: &[PathBuf]) -> Vec { + paths + .iter() + .filter_map(|path| path.file_name()) + .filter_map(|os_str| os_str.to_str()) + .map(|str_slice| str_slice.to_owned()) + .collect() +} + +/// Replace mentions of an environment variable in a file with a new value +pub(crate) fn replace_mentions>( + path: P, + env_var: &str, + new_value: &str, +) -> Result<(), MescCliError> { + let path = path.as_ref(); + + if !path.exists() { + let _file = File::create(path)?; + } + let file = File::open(path)?; + let reader = BufReader::new(file); + + let mut lines: Vec = Vec::new(); + let mut modified = false; + + for line in reader.lines() { + let line = line?; + if line.starts_with(&format!("export {}=", env_var)) { + lines.push(format!("export {}={}", env_var, new_value)); + modified = true; + } else { + lines.push(line); + } + } + if !modified { + lines.push("".to_string()); + lines.push(format!("export {}={}", env_var, new_value)); + modified = true; + } + + if modified { + let mut file = OpenOptions::new().write(true).truncate(true).open(path)?; + for line in lines { + writeln!(file, "{}", line)?; + } + } + + Ok(()) +} diff --git a/rust/crates/mesc_cli/src/cli/subcommands/setup/writing.rs b/rust/crates/mesc_cli/src/cli/subcommands/setup/writing.rs new file mode 100644 index 0000000..e85cfd0 --- /dev/null +++ b/rust/crates/mesc_cli/src/cli/subcommands/setup/writing.rs @@ -0,0 +1,77 @@ +use crate::MescCliError; +use inquire::InquireError; +use mesc::RpcConfig; +use toolstr::Colorize; + +#[derive(Clone)] +pub(crate) enum ConfigWriteMode { + /// file path of JSON config file + Path(std::path::PathBuf), + /// list of config files to write to + Env(Vec), +} + +pub(crate) fn write_config( + config: RpcConfig, + config_write_mode: Option, +) -> Result<(), MescCliError> { + let config_write_mode = match config_write_mode { + Some(config_write_mode) => Some(config_write_mode), + None => get_config_write_mode()?, + }; + if config_write_mode.is_none() { + println!(" No write mode selected"); + println!(" Not writing changes to disk"); + } else { + match &config_write_mode { + Some(write_mode) => match write_mode { + ConfigWriteMode::Path(path) => { + mesc::write::write_config(config, path.clone())?; + println!(" {} {}", "config written to".bold(), path.to_string_lossy().green()); + } + ConfigWriteMode::Env(_) => { + todo!("writing environment variables not supported yet") + } + }, + None => return Err(MescCliError::Error("could not obtain write mode".to_string())), + }; + }; + Ok(()) +} + +pub(crate) fn get_config_write_mode() -> Result, MescCliError> { + if let Ok(path) = mesc::load::get_config_path() { + return Ok(Some(ConfigWriteMode::Path(path.into()))); + }; + + let prompt = "How do you want to save the config?"; + let options = ["Save as path file", "Save as an environment variable"].to_vec(); + loop { + let write_mode = match inquire::Select::new(prompt, options.clone()).prompt() { + Ok("Save as path file") => { + let prompt = "Where should mesc.json file be saved? (enter a directory path)"; + let parent = match inquire::Text::new(prompt).prompt() { + Ok(parent) => { + let parent = if parent.trim().is_empty() { + ".".to_string() + } else { + mesc::load::expand_path(parent)? + }; + std::path::PathBuf::from(parent) + } + Err(InquireError::OperationCanceled) => return Ok(None), + Err(_) => return Err(MescCliError::InvalidInput("invalid input".to_string())), + }; + let path: String = parent.join("mesc.json").to_string_lossy().to_string(); + Some(ConfigWriteMode::Path(path.into())) + } + Ok("Save an environment variable") => { + println!("not supported yet"); + continue; + } + Err(InquireError::OperationCanceled) => return Ok(None), + _ => return Err(MescCliError::InvalidInput("invalid input".to_string())), + }; + return Ok(write_mode); + } +} diff --git a/rust/crates/mesc_cli/src/cli/subcommands/status.rs b/rust/crates/mesc_cli/src/cli/subcommands/status.rs index 3dfae8c..35f47f4 100644 --- a/rust/crates/mesc_cli/src/cli/subcommands/status.rs +++ b/rust/crates/mesc_cli/src/cli/subcommands/status.rs @@ -46,33 +46,42 @@ pub(crate) fn status_command(args: StatusArgs) -> Result<(), MescCliError> { values.push("false".to_string()); if let MescError::IOError(ref e) = e { if let std::io::ErrorKind::NotFound = e.kind() { - println!("config file not found"); + println!("{}", "config file not found".red()); + println!(); } else { - println!("could not load config: {:?}", e); + println!("{}", format!("could not load config: {:?}", e).red()); + println!(); + keys.push("config found"); + values.push(format!("{}", "false".to_string().red())); } } else { - println!("could not load config: {:?}", e); + println!("{}", format!("could not load config: {:?}", e).red()); + println!(); }; - return Err(e.into()); + None } Ok(config) => { keys.push("config found"); - values.push("true".to_string()); - config + values.push(format!("{}", "true".to_string().green())); + Some(config) } }; // validate config keys.push("config valid"); - match config.validate() { - Ok(()) => { - values.push("true".to_string()); - } - Err(e) => { - values.push("false".to_string()); - println!("{:?}", e); - } - }; + if let Some(config) = config.clone() { + match config.validate() { + Ok(()) => { + values.push(format!("{}", "true".to_string().green())); + } + Err(e) => { + values.push(format!("{}", "false".to_string().red())); + println!("{:?}", e); + } + }; + } else { + values.push("[no config]".to_string()); + } let format = toolstr::TableFormat::default(); let column_formats = vec![ @@ -80,13 +89,13 @@ pub(crate) fn status_command(args: StatusArgs) -> Result<(), MescCliError> { toolstr::ColumnFormatShorthand::new() .name("v") .left_justify() - .font_style("".green().bold()), + .font_style("".bold().green()), ]; let format = toolstr::TableFormat { include_header_row: false, indent: 4, column_formats: Some(column_formats), - column_delimiter: " ".to_string(), + column_delimiter: " ".to_string(), ..format }; let mut table = toolstr::Table::default(); @@ -103,8 +112,12 @@ pub(crate) fn status_command(args: StatusArgs) -> Result<(), MescCliError> { println!(); toolstr::print_header("Configured Endpoints", &theme); println!(); - let endpoints: Vec<_> = config.endpoints.clone().into_values().collect(); - print_endpoints(&endpoints, args.reveal)?; + if let Some(ref config) = config.clone() { + let endpoints: Vec<_> = config.endpoints.clone().into_values().collect(); + print_endpoints(&endpoints, args.reveal)?; + } else { + println!("[no config]"); + } }; // print defaults @@ -113,8 +126,21 @@ pub(crate) fn status_command(args: StatusArgs) -> Result<(), MescCliError> { println!(); toolstr::print_header("Default Endpoints", &theme); println!(); - print_defaults(&config)?; + if let Some(config) = config.clone() { + print_defaults(&config)?; + } else { + println!("[no config]"); + } }; + if !args.verbose { + println!(); + println!( + "use {} or {} to print additional information", + "-v".bold().white(), + "--verbose".bold().white() + ) + } + Ok(()) } diff --git a/rust/crates/mesc_cli/src/metadata.rs b/rust/crates/mesc_cli/src/metadata.rs index ba2a500..8533746 100644 --- a/rust/crates/mesc_cli/src/metadata.rs +++ b/rust/crates/mesc_cli/src/metadata.rs @@ -30,7 +30,7 @@ pub(crate) fn get_theme_font_style(id: &str) -> Result } fn get_cli_theme() -> Result, MescCliError> { - let global_metadata = mesc::get_global_metadata()?; + let global_metadata = mesc::get_global_metadata(Some("mesc_cli"))?; let path: Vec<&str> = vec![]; let cli_theme: HashMap = match global_metadata.get("cli_theme") { Some(value) => get_value_at(value, &path)?, diff --git a/rust/crates/mesc_cli/src/network.rs b/rust/crates/mesc_cli/src/network.rs index a61eef3..9c7edc0 100644 --- a/rust/crates/mesc_cli/src/network.rs +++ b/rust/crates/mesc_cli/src/network.rs @@ -43,7 +43,7 @@ pub(crate) async fn get_node_network_info( // ip address and location let (ip_address, location) = - if fields.contains(&"ip".to_string()) | fields.contains(&"location".to_string()) { + if fields.contains(&"ip".to_string()) || fields.contains(&"location".to_string()) { match get_ip_address(url.as_str()) { Ok(ip) => { let service = ipgeolocate::Service::IpApi; @@ -73,6 +73,19 @@ pub(crate) async fn get_node_network_info( }) } +pub(crate) fn is_ip(url: &str) -> bool { + use std::net::{Ipv4Addr, Ipv6Addr}; + if url.is_empty() { + return false; + } + let domain = match url.split_once('/') { + Some((domain, _)) => domain, + None => url, + }; + let domain = domain.split(':').next().unwrap_or(""); + domain.parse::().is_ok() || domain.parse::().is_ok() +} + fn get_ip_address(url: &str) -> Result { let parsed_url = url::Url::parse(url) .map_err(|_| MescCliError::UrlError("could not parse url".to_string()))?; diff --git a/rust/crates/mesc_cli/src/printing.rs b/rust/crates/mesc_cli/src/printing.rs index de35c33..459a763 100644 --- a/rust/crates/mesc_cli/src/printing.rs +++ b/rust/crates/mesc_cli/src/printing.rs @@ -14,7 +14,7 @@ pub(crate) fn print_endpoint_pretty(endpoint: Endpoint) { println!("- url: {}", endpoint.url); println!( "- chain_id: {}", - endpoint.chain_id.map_or("-".to_string(), |chain_id| chain_id.to_string()) + endpoint.chain_id.map_or_else(|| "-".to_string(), |chain_id| chain_id.to_string()) ); println!("- metadata: {:?}", endpoint.endpoint_metadata); } @@ -49,10 +49,20 @@ pub(crate) fn print_endpoints( let mut names = Vec::new(); let mut networks = Vec::new(); let mut urls = Vec::new(); + let mut network_names = Vec::new(); let sorted_endpoints = sort_endpoints(endpoints); + + let all_network_names = mesc::network_names::get_network_names(); for endpoint in sorted_endpoints.into_iter() { names.push(endpoint.name.clone()); networks.push(endpoint.chain_id_string()); + + let network_name = endpoint + .chain_id + .as_ref() + .and_then(|chain_id| all_network_names.get(&chain_id).map(ToString::to_string)) + .unwrap_or_else(|| endpoint.chain_id_string()); + network_names.push(network_name); if reveal { urls.push(endpoint.url.clone()); } else { @@ -71,9 +81,14 @@ pub(crate) fn print_endpoints( let mut table = toolstr::Table::default(); table.add_column("endpoint", names)?; format.add_column(ColumnFormatShorthand::new().name("endpoint").font_style(metavar_style)); - table.add_column("network", networks)?; - format - .add_column(ColumnFormatShorthand::new().name("network").font_style(description_style)); + table.add_column("network", network_names)?; + format.add_column( + ColumnFormatShorthand::new().name("network").font_style(description_style.clone()), + ); + // table.add_column("chain id", networks)?; + // format.add_column( + // ColumnFormatShorthand::new().name("chain id").font_style(description_style), + // ); table.add_column("url", urls)?; format.add_column(ColumnFormatShorthand::new().name("url").font_style(option_style)); format.print(table)?; diff --git a/tests/README.md b/tests/README.md index 28c6a34..82841a9 100644 --- a/tests/README.md +++ b/tests/README.md @@ -1,22 +1,42 @@ # MESC Tests -These tests measure the degree to which a MESC implementation is compliant with the MESC specification. - -These tests are language-agnostic, allowing the same tests to be run against each MESC implementation. +A language-agnostic set of tests is used to check whether each MESC implementation is compliant with the MESC specification. ## Usage -1. `generate.py` generates tests in the `generated/` directory -2. `run.py adapters/` runs the tests for the given adapter + +1. Install `pytest` with `pytest-xdist`: `pip install pytest pytest-xdist` + +2. Go to the tests directory: `cd $MESC_REPO/mesc/tests` + +3. Run one of these commands: + +|description | command | +| --- | --- | +| run tests | `pytest` | +| run test in parallel mode (much faster) | `pytest -n auto` | +| run tests in debug mode (helpful for debugging) | `pytest --pdb` | +| run tests only tests that previously failed | `pytest --lf` | +| run tests for specific adapters only | `pytest --adapters adapters/python adapters/cli` | + +By default, tests will run for all MESC implementations. If you do not have all of these implementations installed, you will need to use `--adapters` to select only the subset that that you have installed. + ## Adapters -Each MESC implementation has an adapter that allows running the tests using the test runner. +Each MESC implementation has an adapter that receives a test as input and prints the result as output. Adapters are located in the [adapters](https://github.com/paradigmxyz/mesc/tree/main/tests/adapters) directory. To make a custom adapter: -1. adapter should be a script that takes a JSON `Query` as its single argument -2. the adapter should run the query and output the result as JSON -3. if the config loading or the query fails, simply output the word `FAIL` +1. adapter should be a script that takes a JSON [`MescQuery`](https://github.com/paradigmxyz/mesc/blob/5cb1086c237f2b38c3a3095466823f3d64a62052/python/mesc/types.py#L115) as its single argument +2. the adapter should run the query, and then print the result as JSON +3. if the config loading or the query fails, simply print the word `FAIL` The adapter should never crash upon failure, just print the word `FAIL` + +## Files +- `adapters/` contains a test adapter for each MESC implementation +- `conftest.py` configuration file for pytest +- `generate.py` generates all of the MESC test cases +- `test_mesc.py` packages MESC tests into form usable by pypi + diff --git a/tests/adapters/cli b/tests/adapters/cli index d648eff..5875665 100755 --- a/tests/adapters/cli +++ b/tests/adapters/cli @@ -1,11 +1,16 @@ #!/usr/bin/env python3 +from __future__ import annotations + import argparse import json import os import subprocess +import typing from typing import cast -from mesc.types import MescQuery + +if typing.TYPE_CHECKING: + from mesc.types import MescQuery def run_query(query: MescQuery) -> str: @@ -15,7 +20,9 @@ def run_query(query: MescQuery) -> str: name = cast(str, query["fields"]["name"]) # type: ignore cmd = ["mesc", "endpoint", "--json", "--name", name] elif query["query_type"] == "endpoint_by_network": - chain_id = cast(str, query["fields"]["chain_id"]) # type: ignore + chain_id = query["fields"]["chain_id"] + if isinstance(chain_id, int): + chain_id = str(chain_id) cmd = ["mesc", "endpoint", "--json", "--network", chain_id] elif query["query_type"] == "user_input": user_input = query["fields"]["user_input"] # type: ignore @@ -30,7 +37,10 @@ def run_query(query: MescQuery) -> str: cmd.append(query['fields']['url_contains']) if query["fields"].get('chain_id') is not None: cmd.append('--network') - cmd.append(query['fields']['chain_id']) + chain_id = query["fields"]["chain_id"] + if isinstance(chain_id, int): + chain_id = str(chain_id) + cmd.append(chain_id) elif query['query_type'] == 'global_metadata': cmd = ["mesc", "metadata"] else: diff --git a/tests/adapters/python b/tests/adapters/python index 85bbd25..61c82ed 100755 --- a/tests/adapters/python +++ b/tests/adapters/python @@ -1,31 +1,36 @@ #!/usr/bin/env python3 +from __future__ import annotations + import argparse import json -from typing import Sequence, cast +import typing -from mesc.types import Endpoint, EndpointQuery import mesc +if typing.TYPE_CHECKING: + from typing import Sequence, Union + from mesc.types import Endpoint, EndpointQuery -def run_query(query: EndpointQuery) -> Endpoint | Sequence[Endpoint] | None: + +def run_query(query: EndpointQuery) -> Union[Endpoint, Sequence[Endpoint], None]: if query["query_type"] == "default_endpoint": - default_fields = cast(mesc.types.DefaultEndpointQuery, query["fields"]) + default_fields: mesc.types.DefaultEndpointQuery = query["fields"] return mesc.get_default_endpoint(**default_fields) elif query["query_type"] == "endpoint_by_name": - name_fields = cast(mesc.types.EndpointNameQuery, query["fields"]) + name_fields: mesc.types.EndpointNameQuery = query["fields"] return mesc.get_endpoint_by_name(**name_fields) elif query["query_type"] == "endpoint_by_network": - network_fields = cast(mesc.types.EndpointNetworkQuery, query["fields"]) + network_fields: mesc.types.EndpointNetworkQuery = query["fields"] return mesc.get_endpoint_by_network(**network_fields) elif query["query_type"] == "user_input": - user_input_fields = cast(mesc.types.UserInputQuery, query["fields"]) + user_input_fields: mesc.types.UserInputQuery = query["fields"] return mesc.get_endpoint_by_query(**user_input_fields) elif query["query_type"] == "multi_endpoint": - multi_endpoint_fields = cast(mesc.types.MultiEndpointQuery, query['fields']) + multi_endpoint_fields: mesc.types.MultiEndpointQuery = query["fields"] return mesc.find_endpoints(**multi_endpoint_fields) elif query["query_type"] == "global_metadata": - return mesc.get_global_metadata() + return mesc.get_global_metadata(**query["fields"]) else: raise Exception("invalid query type: " + str(query["query_type"])) diff --git a/tests/conftest.py b/tests/conftest.py new file mode 100644 index 0000000..a6d3f97 --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,15 @@ +from __future__ import annotations +from _pytest.config.argparsing import Parser +from _pytest.python import Metafunc + +default_adapters = ["adapters/python", "adapters/cli"] + + +def pytest_addoption(parser: Parser) -> None: + parser.addoption("--adapters", action="store", nargs="+", default=default_adapters) + + +def pytest_generate_tests(metafunc: Metafunc) -> None: + if "adapter" in metafunc.fixturenames: + adapters = metafunc.config.getoption("adapters") + metafunc.parametrize("adapter", adapters, scope="function") diff --git a/tests/generate.py b/tests/generate.py index ba57530..e1f07c6 100755 --- a/tests/generate.py +++ b/tests/generate.py @@ -3,13 +3,12 @@ from __future__ import annotations import copy -import json -import os -import time -from typing import Any, TypeVar, Sequence +import typing +from typing import Any, Sequence, TypeVar, Union -from mesc import RpcConfig, Profile, Endpoint -from mesc.types import EndpointQuery, MultiEndpointQuery, GlobalMetadataQuery, MescQuery +if typing.TYPE_CHECKING: + from mesc import Endpoint, Profile, RpcConfig + from mesc.types import MescQuery blank_config: RpcConfig = { "mesc_version": "MESC 1.0", @@ -78,6 +77,12 @@ full_config: RpcConfig = { "chain_id": "10", "endpoint_metadata": {}, }, + "llamanodes_base": { + "name": "llamanodes_base", + "url": "https://base.llamarpc.com", + "chain_id": "8453", + "endpoint_metadata": {}, + }, }, "profiles": { "abc": { @@ -91,17 +96,28 @@ full_config: RpcConfig = { "name": "xyz", "default_endpoint": "llamanodes_ethereum", "network_defaults": { - "1": "llamanodes_ethereum", + "0x00001": "llamanodes_ethereum", "10": "llamanodes_optimism", + "8453": "llamanodes_base", + }, + "profile_metadata": { + "sample_key": "profile_value", }, - "profile_metadata": {}, "use_mesc": True, }, + "not_using_mesc": { + "name": "not_using_mesc", + "default_endpoint": None, + "network_defaults": {}, + "profile_metadata": {}, + "use_mesc": False, + }, }, "global_metadata": { "api_keys": { "etherscan": "abc123", }, + "sample_key": "global_value", }, } @@ -113,14 +129,15 @@ known_networks = { } # tests are in form [test_name, env, config, query, result, should_succeed] -Test = tuple[ - str, - dict[str, str], - RpcConfig, - None | MescQuery, - Any, - bool, -] +if typing.TYPE_CHECKING: + Test = tuple[ + str, + dict[str, str], + RpcConfig, + Union[None, MescQuery], + Any, + bool, + ] def generate_tests() -> list[Test]: @@ -128,9 +145,104 @@ def generate_tests() -> list[Test]: generators = [ create_basic_query_tests, create_override_tests, - create_invalid_tests, + create_invalid_query_tests, + create_invalid_config_tests, ] - return [test for generator in generators for test in generator()] + + tests = [test for generator in generators for test in generator()] + + # for queries that specify chain_id, also specify hexadecimal chain_id + for test in list(tests): + query = test[3] + if query is not None and "profile" in query.get("fields", {}): + if query["fields"].get("chain_id") is not None: + # version without leading zeros + chain_id = query["fields"]["chain_id"] # type: ignore + as_hex = hex(int(chain_id)) # type: ignore + new_test = copy.deepcopy(test) + new_test[3]["fields"]["chain_id"] = as_hex # type: ignore + new_test = (new_test[0] + ", hex chain_id",) + new_test[1:] + tests.append(new_test) + + # version with 1 extra leading zero + chain_id = query["fields"]["chain_id"] # type: ignore + as_hex = "0x" + "0" + hex(int(chain_id))[2:] # type: ignore + new_test = copy.deepcopy(test) + new_test[3]["fields"]["chain_id"] = as_hex # type: ignore + new_test = (new_test[0] + ", hex chain_id",) + new_test[1:] + tests.append(new_test) + + # version with 4 extra leading zeros + chain_id = query["fields"]["chain_id"] # type: ignore + as_hex = "0x" + "0000" + hex(int(chain_id))[2:] # type: ignore + new_test = copy.deepcopy(test) + new_test[3]["fields"]["chain_id"] = as_hex # type: ignore + new_test = (new_test[0] + ", hex chain_id",) + new_test[1:] + tests.append(new_test) + + if ( + query["fields"].get("user_input") is not None + and isinstance(query["fields"]["user_input"], str) # type: ignore + and query["fields"]["user_input"].isdecimal() # type: ignore + ): + # version without leading zeros + chain_id = query["fields"]["user_input"] # type: ignore + as_hex = hex(int(chain_id)) + new_test = copy.deepcopy(test) + new_test[3]["fields"]["user_input"] = as_hex # type: ignore + new_test = (new_test[0] + ", hex chain_id",) + new_test[1:] + tests.append(new_test) + + # version with 1 extra leading zero + chain_id = query["fields"]["user_input"] # type: ignore + as_hex = "0x" + "0" + hex(int(chain_id))[2:] + new_test = copy.deepcopy(test) + new_test[3]["fields"]["user_input"] = as_hex # type: ignore + new_test = (new_test[0] + ", hex chain_id",) + new_test[1:] + tests.append(new_test) + + # version with 4 extra leading zeros + chain_id = query["fields"]["user_input"] # type: ignore + as_hex = "0x" + "0000" + hex(int(chain_id))[2:] + new_test = copy.deepcopy(test) + new_test[3]["fields"]["user_input"] = as_hex # type: ignore + new_test = (new_test[0] + ", hex chain_id",) + new_test[1:] + tests.append(new_test) + + # for tests that query with null profile, also query with non-existent profile + for test in list(tests): + query = test[3] + if ( + query is not None + and "profile" in query.get("fields", {}) + and query["fields"].get("profile") is None + ): + new_test = copy.deepcopy(test) + new_test[3]["fields"]["profile"] = "unknown_profile" # type: ignore + new_test = (new_test[0] + ", unknown_profile",) + new_test[1:] + tests.append(new_test) + + # every query should return None or empty when a profile has use_mesc=True + for test in list(tests): + query = test[3] + target_output = test[4] + if ( + query is not None + and "profile" in query.get("fields", {}) + and query["fields"].get("profile") is None + and target_output is not None + ): + new_test = copy.deepcopy(test) + new_test[3]["fields"]["profile"] = "not_using_mesc" # type: ignore + if query["query_type"] == "global_metadata": + expected: dict[str, Any] | None = {} + else: + expected = None + new_test = new_test[0:4] + (expected,) + new_test[5:] + new_test = (new_test[0] + ", profile not_using_mesc",) + new_test[1:] + tests.append(new_test) + + return tests T = TypeVar("T") @@ -239,6 +351,17 @@ def create_basic_query_tests() -> list[Test]: full_config["endpoints"]["local_goerli"], True, ), + ( + "query endpoint chain_id by int", + {}, + full_config, + { + "query_type": "endpoint_by_network", + "fields": {"chain_id": 1, "profile": None}, + }, + full_config["endpoints"]["local_ethereum"], + True, + ), ( "get endpoint by network", {}, @@ -250,6 +373,28 @@ def create_basic_query_tests() -> list[Test]: None, True, ), + ( + "get endpoint by network, base", + {}, + full_config, + { + "query_type": "endpoint_by_network", + "fields": {"chain_id": "8453", "profile": None}, + }, + None, + True, + ), + ( + "get endpoint by network, base, profile", + {}, + full_config, + { + "query_type": "endpoint_by_network", + "fields": {"chain_id": "8453", "profile": "xyz"}, + }, + full_config["endpoints"]["llamanodes_base"], + True, + ), ( "get endpoint by network profile fallback", {}, @@ -353,9 +498,20 @@ def create_basic_query_tests() -> list[Test]: full_config["endpoints"]["local_goerli"], True, ), + ( + "get endpoint by user query, dne", + {}, + full_config, + { + "query_type": "user_input", + "fields": {"user_input": "this_query_has_no_results", "profile": None}, + }, + None, + True, + ), ] - # get endpoint by user query, profile blank + # get endpoint by user query, with default profile tests += [ ( "get endpoint by user query, endpoint name", @@ -423,6 +579,17 @@ def create_basic_query_tests() -> list[Test]: full_config["endpoints"]["local_goerli"], True, ), + ( + "get endpoint by user query, dne", + {}, + full_config, + { + "query_type": "user_input", + "fields": {"user_input": "this_query_has_no_results", "profile": "abc"}, + }, + None, + True, + ), ] # get endpoint by user query, profile full @@ -482,16 +649,33 @@ def create_basic_query_tests() -> list[Test]: full_config["endpoints"]["llamanodes_ethereum"], True, ), - # ( - # "get endpoint by user query, custom network name", - # full_config, - # {"query_type": "user_input", "fields": {"user_input": "testnet", "profile": "xyz"}}, - # full_config['endpoints']['llamanodes_goerli'], - # ), + ( + "get endpoint by user query, custom network name", + {}, + full_config, + { + "query_type": "user_input", + "fields": {"user_input": "testnet", "profile": "xyz"}, + }, + full_config["endpoints"]["local_goerli"], + True, + ), + ( + "get endpoint by user query, dne", + {}, + full_config, + { + "query_type": "user_input", + "fields": {"user_input": "this_query_has_no_results", "profile": "xyz"}, + }, + None, + True, + ), ] # test querying by known network names for chain_id, network_name in known_networks.items(): + # with a default endpoint network_endpoint = copy.deepcopy(blank_endpoint) network_endpoint["chain_id"] = chain_id network_config = copy.deepcopy(full_config) @@ -510,6 +694,23 @@ def create_basic_query_tests() -> list[Test]: ) tests.append(test) + # without a default endpoint + network_config = copy.deepcopy(full_config) + if chain_id in network_config["network_defaults"]: + del network_config["network_defaults"][chain_id] + test_without: Test = ( + "test querying " + network_name + " by name", + {}, + network_config, + { + "query_type": "user_input", + "fields": {"user_input": network_name, "profile": None}, + }, + None, + True, + ) + tests.append(test_without) + # test multi-endpoint queries tests += [ ( @@ -524,6 +725,14 @@ def create_basic_query_tests() -> list[Test]: ], True, ), + ( + "empty fuzzy name query", + {}, + full_config, + {"query_type": "multi_endpoint", "fields": {"name_contains": "yyyyyy"}}, + [], + True, + ), ( "fuzzy url query", {}, @@ -532,9 +741,18 @@ def create_basic_query_tests() -> list[Test]: [ full_config["endpoints"]["llamanodes_ethereum"], full_config["endpoints"]["llamanodes_optimism"], + full_config["endpoints"]["llamanodes_base"], ], True, ), + ( + "fuzzy url query", + {}, + full_config, + {"query_type": "multi_endpoint", "fields": {"url_contains": "yyyyyy"}}, + [], + True, + ), ( "chain_id query", {}, @@ -546,61 +764,67 @@ def create_basic_query_tests() -> list[Test]: ], True, ), + ( + "chain_id int query", + {}, + full_config, + {"query_type": "multi_endpoint", "fields": {"chain_id": 1}}, + [ + full_config["endpoints"]["local_ethereum"], + full_config["endpoints"]["llamanodes_ethereum"], + ], + True, + ), + ( + "empty chain_id query", + {}, + full_config, + {"query_type": "multi_endpoint", "fields": {"chain_id": "1111"}}, + [], + True, + ), ] - # for tests that query with null profile, also query with non-existent profile - for test in list(tests): - query = test[3] - if "profile" in query.get("fields", {}) and query["fields"]["profile"] is None: # type: ignore - new_test = copy.deepcopy(test) - new_test[3]["fields"]["profile"] = "unknown_profile" # type: ignore - tests.append(new_test) + # test fetching metadata + tests += [ + ( + "get full global metadata, no profile", + {}, + full_config, + {"query_type": "global_metadata", "fields": {"profile": None}}, + full_config["global_metadata"], + True, + ), + ( + "get full global metadata, irrelevant profile", + {}, + full_config, + {"query_type": "global_metadata", "fields": {"profile": "abc"}}, + full_config["global_metadata"], + True, + ), + ( + "get full global metadata, merged with profile", + {}, + full_config, + {"query_type": "global_metadata", "fields": {"profile": "xyz"}}, + dict( + full_config["global_metadata"], + **full_config["profiles"]["xyz"]["profile_metadata"], + ), + True, + ), + ] return tests -# [name, env, config] -def create_invalid_tests() -> list[Test]: - tests: list[Test] = [] - - # unknown default endpoint - config = copy.deepcopy(blank_config) - config["default_endpoint"] = "random_unknown" - tests.append( - ( - "unknown default endpoint", - {}, - config, - None, - None, - False, - ) - ) - - # unknown network defaults - config = copy.deepcopy(full_config) - config["network_defaults"]["10"] = "random_unknown" - tests.append( - ( - "unknown network defaults", - {}, - config, - None, - None, - False, - ), - ) - - # invalid queries +def create_invalid_query_tests() -> list[Test]: invalid_queries: Sequence[tuple[str, Any]] = [ ( "query default endpoint with int profile", {"query_type": "default_endpoint", "fields": {"profile": 1}}, ), - ( - "query endpoint name by non-existent name", - {"query_type": "default_endpoint", "fields": {"profile": 1}}, - ), ( "query endpoint name by null", {"query_type": "endpoint_by_name", "fields": {"name": None}}, @@ -616,13 +840,6 @@ def create_invalid_tests() -> list[Test]: "fields": {"chain_id": None, "profile": None}, }, ), - ( - "query endpoint chain_id by int", - { - "query_type": "endpoint_by_network", - "fields": {"chain_id": 1, "profile": None}, - }, - ), ( "query endpoint chain_id by int profile", { @@ -649,6 +866,8 @@ def create_invalid_tests() -> list[Test]: {"query_type": "user_input", "fields": {"user_input": True, "profile": 1}}, ), ] + + tests = [] for test_name, query in invalid_queries: test: Test = ( test_name, @@ -660,6 +879,156 @@ def create_invalid_tests() -> list[Test]: ) tests.append(test) + return tests + + +def create_invalid_config_tests() -> list[Test]: + tests: list[Test] = [] + + # unknown default endpoint + config = copy.deepcopy(blank_config) + config["default_endpoint"] = "random_unknown" + tests.append( + ( + "unknown default endpoint", + {}, + config, + None, + None, + False, + ) + ) + config = copy.deepcopy(full_config) + config["profiles"]["abc"]["default_endpoint"] = "random_unknown" + tests.append( + ( + "unknown default endpoint", + {}, + config, + None, + None, + False, + ) + ) + + # unknown network defaults + config = copy.deepcopy(full_config) + config["network_defaults"]["10"] = "random_unknown" + tests.append( + ( + "unknown network defaults", + {}, + config, + None, + None, + False, + ), + ) + config = copy.deepcopy(full_config) + config["profiles"]["abc"]["network_defaults"]["10"] = "random_unknown" + tests.append( + ( + "unknown network defaults", + {}, + config, + None, + None, + False, + ), + ) + + # endpoint name doesn't match + config = copy.deepcopy(blank_config) + config["endpoints"] = {"other_name": blank_endpoint} + tests.append( + ( + "unknown network defaults", + {}, + # dict(blank_config, endpoints={'other_name': blank_endpoint}), + config, + None, + None, + False, + ), + ) + + # profile name doesn't match + config = copy.deepcopy(blank_config) + config["profiles"] = {"other_name": blank_profile} + tests.append( + ( + "unknown network defaults", + {}, + config, + None, + None, + False, + ), + ) + + # global default endpoint of network doesn't actually use that network + config = copy.deepcopy(full_config) + config["endpoints"]["local_ethereum"]["chain_id"] = "4" + tests.append( + ( + "global default endpoint of network doesn't actually use that network", + {}, + config, + None, + None, + False, + ), + ) + + # profile default endpoint of network doesn't actually use that network + config = copy.deepcopy(full_config) + config["endpoints"]["llamanodes_ethereum"]["chain_id"] = "4" + tests.append( + ( + "global default endpoint of network doesn't actually use that network", + {}, + config, + None, + None, + False, + ), + ) + + # conflicting chain_ids in global network defaults + config = copy.deepcopy(full_config) + config["network_defaults"]["8453"] = "llamanodes_base" + config["network_defaults"]["0x2105"] = "llamanodes_base" + tests.append( + ( + "conflicting chain_ids in global network defaults", + {}, + config, + None, + None, + False, + ), + ) + + # conflicting chain_ids in profile network defaults + for profile_name, profile_data in full_config["profiles"].items(): + config = copy.deepcopy(full_config) + config["profiles"][profile_name]["network_defaults"]["8453"] = "llamanodes_base" + config["profiles"][profile_name]["network_defaults"]["0x2105"] = ( + "llamanodes_base" + ) + tests.append( + ( + "conflicting chain_ids in profile " + + profile_name + + " network defaults", + {}, + config, + None, + None, + False, + ), + ) + # incorrect types tests invalid_type_tests = [ ( @@ -826,6 +1195,38 @@ def create_invalid_tests() -> list[Test]: None, ), ), + ( + "profile profile_metadata is null", + set_path_value( + copy.deepcopy(full_config), + ["profiles", "xyz", "profile_metadata"], + None, + ), + ), + ( + "profile profile_metadata is int", + set_path_value( + copy.deepcopy(full_config), + ["profiles", "xyz", "profile_metadata"], + 1, + ), + ), + ( + "profile use_mesc is null", + set_path_value( + copy.deepcopy(full_config), + ["profiles", "xyz", "use_mesc"], + None, + ), + ), + ( + "profile use_mesc is int", + set_path_value( + copy.deepcopy(full_config), + ["profiles", "xyz", "use_mesc"], + 1, + ), + ), ( "global metadata is int", set_path_value(copy.deepcopy(full_config), ["global_metadata"], 1), @@ -836,7 +1237,7 @@ def create_invalid_tests() -> list[Test]: ), ] for test_name, config in invalid_type_tests: - test = ( + test: Test = ( test_name, {}, config, @@ -929,7 +1330,6 @@ def create_invalid_tests() -> list[Test]: return tests -# [name, env, config, query, result] def create_override_tests() -> list[Test]: tests: list[Test] = [] @@ -1200,15 +1600,15 @@ def create_override_tests() -> list[Test]: "override global metadata, change existing key", {"MESC_GLOBAL_METADATA": '{"api_keys": {"etherscan": "new_key"}}'}, full_config, - {"query_type": "global_metadata", "fields": {"path": None}}, - {"api_keys": {"etherscan": "new_key"}}, + {"query_type": "global_metadata", "fields": {}}, + dict(full_config["global_metadata"], api_keys={"etherscan": "new_key"}), True, ), ( "override global metadata, add new key", {"MESC_GLOBAL_METADATA": '{"some_new_key": "value"}'}, full_config, - {"query_type": "global_metadata", "fields": {"path": None}}, + {"query_type": "global_metadata", "fields": {}}, dict(full_config["global_metadata"], some_new_key="value"), True, ), @@ -1216,7 +1616,7 @@ def create_override_tests() -> list[Test]: "override global metadata blank", {"MESC_GLOBAL_METADATA": ""}, full_config, - {"query_type": "global_metadata", "fields": {"path": None}}, + {"query_type": "global_metadata", "fields": {}}, full_config["global_metadata"], True, ), @@ -1282,17 +1682,3 @@ def create_override_tests() -> list[Test]: pass return tests - - -if __name__ == "__main__": - start_time = time.time() - tests = generate_tests() - duration = time.time() - start_time - print("generated", len(tests), "tests in", "%.3f" % duration, "seconds") - - path = "generated/tests.json" - os.makedirs(os.path.dirname(path), exist_ok=True) - with open(path, "w") as f: - json.dump(tests, f) - print() - print("saved to", path) diff --git a/tests/run.py b/tests/run.py deleted file mode 100755 index 7fa5d0b..0000000 --- a/tests/run.py +++ /dev/null @@ -1,302 +0,0 @@ -#!/usr/bin/env python3 - -import argparse -import contextlib -import os -import json -import shutil -import subprocess -import sys -import tempfile -from typing import Any, Callable, ContextManager, Generator, Mapping, MutableSequence - -from mesc.types import EndpointQuery, MultiEndpointQuery, RpcConfig - - -# tests are in form [test_name, env, config, query, result, should_succeed] -Test = tuple[ - str, - dict[str, str], - RpcConfig, - None | EndpointQuery | MultiEndpointQuery, - Any, - bool, -] - - -class OutputDoesNotMatch(Exception): - pass - - -class FailedQuery(Exception): - pass - - -def get_setups() -> ( - Mapping[str, Callable[[RpcConfig], ContextManager[Mapping[str, str]]]] -): - return { - "path": setup_config_path, - "env": setup_config_env_var, - } - - -@contextlib.contextmanager -def setup_config_path(config: RpcConfig) -> Generator[Mapping[str, str], None, None]: - temp_dir = tempfile.mkdtemp() - temp_path = os.path.join(temp_dir, "config.json") - with open(temp_path, "w") as f: - json.dump(config, f) - try: - yield {"MESC_MODE": "PATH", "MESC_PATH": temp_path} - finally: - shutil.rmtree(temp_dir) - - -@contextlib.contextmanager -def setup_config_env_var(config: RpcConfig) -> Generator[Mapping[str, str], None, None]: - config_data = json.dumps(config) - try: - yield {"MESC_MODE": "ENV", "MESC_ENV": config_data} - finally: - pass - - -def parse_args() -> Mapping[str, Any]: - parser = argparse.ArgumentParser() - parser.add_argument("adapters", help="path to adapter", nargs="+") - parser.add_argument( - "--verbose", help="print extra error output", action="store_true" - ) - parser.add_argument("--halt", help="halt on first error", action="store_true") - parser.add_argument( - "--generated-path", - help="path to generated tests", - default="./generated/tests.json", - ) - parser.add_argument('--index', help='test indices to run', nargs='+') - args = parser.parse_args() - - return { - "adapters": args.adapters, - "generated_path": args.generated_path, - "verbose": args.verbose, - "halt": args.halt, - 'index': args.index, - } - - -def run_test( - test: Test, - adapter: str, - setup_name: str, - setup_env: Mapping[str, str], - halt: bool, - verbose: bool, - successes: MutableSequence[tuple[str, str, str]], - failures: MutableSequence[tuple[str, str, str, str]], - index: int, -) -> None: - test_name, test_env, config, query, target_result, should_succeed = test - - # run command - try: - # create env - env = {} - env["PATH"] = os.environ["PATH"] - env.update(setup_env) - env.update(test_env) - - cmd = [adapter, json.dumps(query)] - output = subprocess.check_output([sys.executable] + cmd, env=env) - except Exception: - if halt: - sys.exit() - message = "adapter broken, test failed to complete" - failures.append((adapter, setup_name, test_name, message)) - return - - # parse output - try: - actual_result = json.loads(output.decode("utf-8").strip()) - if not json_equal(actual_result, target_result): - raise OutputDoesNotMatch("") - if should_succeed: - successes.append((adapter, setup_name, test_name)) - else: - message = "success when expecting failure" - failures.append((adapter, setup_name, test_name, message)) - if verbose: - print(message) - print_summary( - config=config, - env=env, - test_name=test_name, - query=query, - output=output, - target_result=target_result, - exception=None, - successes=successes, - failures=failures, - index=index, - ) - if halt: - sys.exit() - else: - return - except Exception as exception: - if should_succeed: - if verbose: - print_summary( - config=config, - env=env, - test_name=test_name, - query=query, - output=output, - target_result=target_result, - exception=exception, - successes=successes, - failures=failures, - index=index, - ) - if halt: - sys.exit() - if len(output) == 0: - message = "no output" - elif output.decode("utf-8").startswith("FAIL"): - message = "QueryFailed:" - else: - message = str(type(exception).__name__) + ": " + str(exception.args[0]) - failures.append((adapter, setup_name, test_name, message)) - else: - successes.append((adapter, setup_name, test_name)) - - -def print_summary( - config: Any, - env: Mapping[str, str], - test_name: str, - query: Any, - output: Any, - target_result: Any, - exception: Exception | None, - successes: MutableSequence[tuple[str, str, str]], - failures: MutableSequence[tuple[str, str, str, str]], - index: int, -) -> None: - print("CONFIG", json.dumps(config, sort_keys=True, indent=4)) - print( - "ENV:", - json.dumps( - {k: v for k, v in env.items() if k != "PATH"}, - sort_keys=True, - indent=4, - ), - ) - print("QUERY:", query) - try: - print( - "OUTPUT:", - json.dumps(json.loads(output.decode("utf-8")), indent=4, sort_keys=True), - ) - except Exception: - print("OUTPUT:", output.decode("utf-8").strip()) - print("EXPECTED:", json.dumps(target_result, indent=4, sort_keys=True)) - print("EXCEPTION:", type(exception), exception) - print("TEST_NAME:", test_name) - print("INDEX:", index) - - -def json_equal(lhs: Any, rhs: Any) -> bool: - return cannonical_json(lhs) == cannonical_json(rhs) - - -def cannonical_json(data: Any): - if isinstance(data, list): - data = sorted(cannonical_json(item) for item in data) - return json.dumps(data, sort_keys=True) - - -if __name__ == "__main__": - # load data - args = parse_args() - adapters = args["adapters"] - setups = get_setups() - with open(args["generated_path"], "r") as f: - tests = json.load(f) - - # store successes as (adapter, test_name, setup_name) - successes: MutableSequence[tuple[str, str, str]] = [] - - # store failures as (adapter, test_name, setup_name, error) - failures: MutableSequence[tuple[str, str, str, str]] = [] - - # run tests - if len(adapters) == 1: - word = 'adapter' - else: - word = 'adapters' - print( - "testing", - len(tests), - "queries in", - len(setups), - "modes for", - len(adapters), - word - ) - index = -1 - for adapter in adapters: - for test in tests: - for setup_name, setup in setups.items(): - with setup(test[2]) as setup_env: - index += 1 - if args['index'] is not None and str(index) not in args['index']: - continue - run_test( - adapter=adapter, - test=test, - setup_name=setup_name, - setup_env=setup_env, - halt=args["halt"], - verbose=args["verbose"], - successes=successes, - failures=failures, - index=index, - ) - - # summary - print() - print(len(successes), "/", len(adapters) * len(setups) * len(tests), "tests successful") - n_failures = len(failures) - if n_failures == 0: - print() - print("SUCCESS") - else: - print() - print(n_failures, "total failures:") - - try: - import toolstr - - labels = ["adapter", "mode", "test", "error"] - rows = [list(row) for row in failures] - for row in rows: - row[0] = row[0].split("/")[-1] - row[2] = row[2].replace(", ", "\n") - row[3] = row[3] - column_justify = {"error": "left"} - toolstr.print_multiline_table( - rows, - separate_all_rows=False, - compact=3, - labels=labels, - add_row_index=True, - max_table_width=shutil.get_terminal_size().columns, - column_justify=column_justify, - ) - except ImportError: - for failure in failures: - print("-", failure) - print() - print("FAILURE") diff --git a/tests/test_mesc.py b/tests/test_mesc.py new file mode 100755 index 0000000..e1d3f02 --- /dev/null +++ b/tests/test_mesc.py @@ -0,0 +1,208 @@ +from __future__ import annotations + +import contextlib +import os +import json +import shutil +import subprocess +import sys +import tempfile +from typing import ( + Any, + Callable, + ContextManager, + Generator, + Mapping, + cast, + Union, +) +import pytest + +import generate + +import typing + +if typing.TYPE_CHECKING: + from mesc.types import RpcConfig, MescQuery + + # tests are in form [test_name, env, config, query, result, should_succeed] + Test = tuple[ + str, + dict[str, str], + RpcConfig, + Union[None, MescQuery], + Any, + bool, + ] + + +class AdapterFailure(Exception): + pass + + +class OutputDoesNotMatch(Exception): + pass + + +class QueryFailed(Exception): + pass + + +class QueryShouldHaveFailed(Exception): + pass + + +def get_setups() -> ( + list[tuple[str, Callable[[RpcConfig], ContextManager[Mapping[str, str]]]]] +): + return [ + ("path", setup_config_path), + ("env", setup_config_env_var), + ] + + +@contextlib.contextmanager +def setup_config_path(config: RpcConfig) -> Generator[Mapping[str, str], None, None]: + temp_dir = tempfile.mkdtemp() + temp_path = os.path.join(temp_dir, "config.json") + with open(temp_path, "w") as f: + json.dump(config, f) + try: + yield {"MESC_MODE": "PATH", "MESC_PATH": temp_path} + finally: + shutil.rmtree(temp_dir) + + +@contextlib.contextmanager +def setup_config_env_var(config: RpcConfig) -> Generator[Mapping[str, str], None, None]: + config_data = json.dumps(config) + try: + yield {"MESC_MODE": "ENV", "MESC_ENV": config_data} + finally: + pass + + +tests = generate.generate_tests() + + +@pytest.mark.parametrize("setup", get_setups()) +@pytest.mark.parametrize("test", tests, ids=[test[0] for test in tests]) +def test_mesc_output( + setup: tuple[str, Callable[[RpcConfig], ContextManager[Mapping[str, str]]]], + test: Test, + adapter: str, +) -> None: + # load inputs + if adapter in ["", None]: + raise AdapterFailure("must specify adapter") + test_name, test_env, config, query, target_result, should_succeed = test + setup_name, f_setup = setup + + # run query + env = {} + with f_setup(test[2]) as setup_env: + try: + env["PATH"] = os.environ["PATH"] + env.update(setup_env) + env.update(test_env) + cmd = [adapter, json.dumps(query)] + output = subprocess.check_output([sys.executable] + cmd, env=env) + except Exception: + raise AdapterFailure("adapter broken, test failed to complete") + + # package error data for printing + error_data = dict( + config=config, + env=env, + test_name=test_name, + query=query, + output=output, + target_result=target_result, + ) + + # decode output as json + decode_exception: Exception | None = None + try: + actual_result = json.loads(output.decode("utf-8").strip()) + output_decodable = True + except Exception as e: + actual_result = None + output_decodable = False + decode_exception = e + + # assert whether output is correct + if not output_decodable: + if should_succeed: + # failure case: output could not be decoded + print_error_summary(**error_data) + if len(output) == 0: + message = "no output" + elif output.decode("utf-8").startswith("FAIL"): + message = "QueryFailed:" + else: + exception = cast(Exception, decode_exception) + message = str(type(exception).__name__) + ": " + str(exception.args) + raise QueryFailed(message, adapter, setup_name, test_name) + else: + # working properly + pass + else: + if json_equal(actual_result, target_result): + if should_succeed: + # working properly + pass + else: + # failure case: incorrect query output + print_error_summary(**error_data) + raise QueryShouldHaveFailed( + "success when expecting failure", adapter, setup_name, test_name + ) + else: + if should_succeed: + # failure case: query should have failed + print_error_summary(**error_data) + raise OutputDoesNotMatch( + "output does not match", adapter, setup_name, test_name + ) + else: + # working properly + pass + + +def json_equal(lhs: Any, rhs: Any) -> bool: + return cannonical_json(lhs) == cannonical_json(rhs) + + +def cannonical_json(data: Any) -> str: + if isinstance(data, list): + data = sorted(cannonical_json(item) for item in data) + return json.dumps(data, sort_keys=True) + + +def print_error_summary( + config: Any, + env: Mapping[str, str], + test_name: str, + query: Any, + output: Any, + target_result: Any, +) -> None: + print("CONFIG", json.dumps(config, sort_keys=True, indent=4)) + print( + "ENV:", + json.dumps( + {k: v for k, v in env.items() if k != "PATH"}, + sort_keys=True, + indent=4, + ), + ) + print("QUERY:", query) + try: + print( + "OUTPUT:", + json.dumps(json.loads(output.decode("utf-8")), indent=4, sort_keys=True), + ) + except Exception: + print("OUTPUT:", output.decode("utf-8").strip()) + print("EXPECTED:", json.dumps(target_result, indent=4, sort_keys=True)) + print("TEST_NAME:", test_name) diff --git a/typescript/.env.example b/typescript/.env.example new file mode 100644 index 0000000..e9350b1 --- /dev/null +++ b/typescript/.env.example @@ -0,0 +1,11 @@ +NODE_ENV="development" +MESC_MODE="" +MESC_PATH="" +MESC_ENV="" +MESC_NETWORK_DEFAULTS="" +MESC_NETWORK_NAMES="" +MESC_ENDPOINTS="" +MESC_PROFILES="" +MESC_GLOBAL_METADATA="" +MESC_ENDPOINT_METADATA="" +MESC_DEFAULT_ENDPOINT="" diff --git a/typescript/.gitignore b/typescript/.gitignore new file mode 100644 index 0000000..468f82a --- /dev/null +++ b/typescript/.gitignore @@ -0,0 +1,175 @@ +# Based on https://raw.githubusercontent.com/github/gitignore/main/Node.gitignore + +# Logs + +logs +_.log +npm-debug.log_ +yarn-debug.log* +yarn-error.log* +lerna-debug.log* +.pnpm-debug.log* + +# Caches + +.cache + +# Diagnostic reports (https://nodejs.org/api/report.html) + +report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json + +# Runtime data + +pids +_.pid +_.seed +*.pid.lock + +# Directory for instrumented libs generated by jscoverage/JSCover + +lib-cov + +# Coverage directory used by tools like istanbul + +coverage +*.lcov + +# nyc test coverage + +.nyc_output + +# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) + +.grunt + +# Bower dependency directory (https://bower.io/) + +bower_components + +# node-waf configuration + +.lock-wscript + +# Compiled binary addons (https://nodejs.org/api/addons.html) + +build/Release + +# Dependency directories + +node_modules/ +jspm_packages/ + +# Snowpack dependency directory (https://snowpack.dev/) + +web_modules/ + +# TypeScript cache + +*.tsbuildinfo + +# Optional npm cache directory + +.npm + +# Optional eslint cache + +.eslintcache + +# Optional stylelint cache + +.stylelintcache + +# Microbundle cache + +.rpt2_cache/ +.rts2_cache_cjs/ +.rts2_cache_es/ +.rts2_cache_umd/ + +# Optional REPL history + +.node_repl_history + +# Output of 'npm pack' + +*.tgz + +# Yarn Integrity file + +.yarn-integrity + +# dotenv environment variable files + +.env +.env.development.local +.env.test.local +.env.production.local +.env.local + +# parcel-bundler cache (https://parceljs.org/) + +.parcel-cache + +# Next.js build output + +.next +out + +# Nuxt.js build / generate output + +.nuxt +dist + +# Gatsby files + +# Comment in the public line in if your project uses Gatsby and not Next.js + +# https://nextjs.org/blog/next-9-1#public-directory-support + +# public + +# vuepress build output + +.vuepress/dist + +# vuepress v2.x temp and cache directory + +.temp + +# Docusaurus cache and generated files + +.docusaurus + +# Serverless directories + +.serverless/ + +# FuseBox cache + +.fusebox/ + +# DynamoDB Local files + +.dynamodb/ + +# TernJS port file + +.tern-port + +# Stores VSCode versions used for testing VSCode extensions + +.vscode-test + +# yarn v2 + +.yarn/cache +.yarn/unplugged +.yarn/build-state.yml +.yarn/install-state.gz +.pnp.* + +# IntelliJ based IDEs +.idea + +# Finder (MacOS) folder config +.DS_Store diff --git a/typescript/.npmrc b/typescript/.npmrc new file mode 100644 index 0000000..62ddad7 --- /dev/null +++ b/typescript/.npmrc @@ -0,0 +1,4 @@ +engine-strict=true +auto-install-peers=true +enable-pre-post-scripts=true +strict-peer-dependencies=false diff --git a/typescript/biome.json b/typescript/biome.json new file mode 100644 index 0000000..904ac51 --- /dev/null +++ b/typescript/biome.json @@ -0,0 +1,64 @@ +{ + "$schema": "./node_modules/@biomejs/biome/configuration_schema.json", + "organizeImports": { + "enabled": true + }, + "files": { + "ignore": ["dist", "_"] + }, + "linter": { + "enabled": true, + "rules": { + "all": true, + "style": { + "noNamespace": "off" + }, + "complexity": { + "useLiteralKeys": "off" + }, + "correctness": { + "noUnusedVariables": "off" + }, + "nursery": { + "noNodejsModules": "off" + }, + "performance": { + "noAccumulatingSpread": "off" + } + } + }, + "formatter": { + "enabled": true, + "lineWidth": 100, + "indentWidth": 2, + "indentStyle": "space", + "formatWithErrors": true + }, + "javascript": { + "globals": [ + "NodeJS", + "MESC_MODE", + "MESC_PATH", + "MESC_ENV", + "MESC_ENDPOINTS", + "MESC_DEFAULT_ENDPOINT", + "MESC_PROFILES", + "MESC_NETWORK_NAMES", + "MESC_NETWORK_DEFAULTS", + "MESC_GLOBAL_METADATA", + "MESC_ENDPOINT_METADATA" + ], + "formatter": { + "enabled": true, + "lineWidth": 100, + "indentWidth": 2, + "indentStyle": "space", + "quoteStyle": "single", + "trailingComma": "none", + "semicolons": "asNeeded", + "jsxQuoteStyle": "single", + "quoteProperties": "asNeeded", + "arrowParentheses": "asNeeded" + } + } +} diff --git a/typescript/bun.lockb b/typescript/bun.lockb new file mode 100755 index 0000000..658729a Binary files /dev/null and b/typescript/bun.lockb differ diff --git a/typescript/environment.d.ts b/typescript/environment.d.ts new file mode 100644 index 0000000..b34b4ae --- /dev/null +++ b/typescript/environment.d.ts @@ -0,0 +1,17 @@ +interface EnvironmentVariables { + readonly NODE_ENV: 'development' | 'production' | 'test' + readonly MESC_MODE: string + readonly MESC_PATH: string + readonly MESC_ENV: string + readonly MESC_ENDPOINT_METADATA: string + readonly MESC_GLOBAL_METADATA: string + readonly MESC_ENDPOINTS: string + readonly MESC_NETWORK_NAMES: string + readonly MESC_DEFAULT_ENDPOINT: string + readonly MESC_NETWORK_DEFAULTS: string + readonly MESC_PROFILES: string +} + +declare namespace NodeJS { + interface ProcessEnv extends EnvironmentVariables {} +} diff --git a/typescript/package.json b/typescript/package.json new file mode 100644 index 0000000..8607825 --- /dev/null +++ b/typescript/package.json @@ -0,0 +1,48 @@ +{ + "name": "@mesc/core", + "version": "0.0.0", + "description": "MESC is a specification for how crypto tools configure their RPC endpoints.", + "readme": "github:paradigmxyz/mesc#readme", + "type": "module", + "main": "./dist/index.js", + "module": "./dist/index.js", + "types": "./dist/index.d.ts", + "exports": { + ".": { + "types": "./dist/index.d.ts", + "import": "./dist/index.js" + }, + "./package.json": "./package.json" + }, + "files": [ + "dist", + "package.json" + ], + "scripts": { + "build": "tsup --config=tsup.config.ts", + "lint": "bunx @biomejs/biome lint . --apply", + "format": "bunx @biomejs/biome format . --write", + "typecheck": "tsc --project tsconfig.json --noEmit", + "test": "vitest --run" + }, + "dependencies": { + "valibot": "^0.28.1" + }, + "devDependencies": { + "@biomejs/biome": "1.5.3", + "@total-typescript/ts-reset": "^0.5.1", + "@types/bun": "^1.0.5", + "@types/node": "^20.11.17", + "bun": "^1.0.26", + "tsup": "^8.0.2", + "typescript": "^5.3.3", + "vitest": "^1.2.2" + }, + "repository": { + "type": "git", + "url": "https://github.com/paradigmxyz/mesc", + "directory": "typescript" + }, + "license": "MIT", + "sideEffects": false +} diff --git a/typescript/reset.d.ts b/typescript/reset.d.ts new file mode 100644 index 0000000..cede83f --- /dev/null +++ b/typescript/reset.d.ts @@ -0,0 +1,2 @@ +/* https://github.com/total-typescript/ts-reset */ +import '@total-typescript/ts-reset' diff --git a/tests/generated/.gitkeep b/typescript/scripts/.gitkeep similarity index 100% rename from tests/generated/.gitkeep rename to typescript/scripts/.gitkeep diff --git a/typescript/src/errors.ts b/typescript/src/errors.ts new file mode 100644 index 0000000..a0cfa62 --- /dev/null +++ b/typescript/src/errors.ts @@ -0,0 +1,17 @@ +export class MescDisabledError extends Error { + constructor(public message = 'MESCs are disabled') { + super(message) + } +} + +export class MissingEndpointError extends Error { + constructor(public message = 'Missing endpoint') { + super(message) + } +} + +export class InvalidOverrideError extends Error { + constructor(public message = 'Invalid override') { + super(message) + } +} diff --git a/typescript/src/index.ts b/typescript/src/index.ts new file mode 100644 index 0000000..c59eeae --- /dev/null +++ b/typescript/src/index.ts @@ -0,0 +1,42 @@ +export * from '#/types.ts' +import { getRpcConfig } from '#/transform.ts' +import type { Endpoint, Maybe } from '#/types.ts' +import type { ChainId } from '#/schemas/rpc-config.ts' + +/** + * @see https://github.com/paradigmxyz/mesc/blob/main/SPECIFICATION.md#reference-implementation + */ + +interface MESC { + getDefaultEndpoint(args?: { profile: string }): Maybe + getEndpointByName({ name }: { name: string }): Endpoint + getEndpointByQuery({ query, profile }: { query: string; profile?: string }): Maybe + getEndpointByNetwork({ + chainId, + profile + }: { chainId: ChainId; profile?: string }): Maybe + findEndpoins(): Endpoint[] +} + +export const mescConfiguration = getRpcConfig(process.env) + +export const mesc = { + getDefaultEndpoint: args => { + throw new Error('Method not implemented.') + }, + + getEndpointByName: args => { + throw new Error('Method not implemented.') + }, + + getEndpointByQuery: args => { + throw new Error('Method not implemented.') + }, + + getEndpointByNetwork: args => { + throw new Error('Method not implemented.') + }, + findEndpoins: () => { + throw new Error('Method not implemented.') + } +} satisfies MESC diff --git a/typescript/src/networks.ts b/typescript/src/networks.ts new file mode 100644 index 0000000..6d4f164 --- /dev/null +++ b/typescript/src/networks.ts @@ -0,0 +1,30 @@ +import type { ChainId } from '#/schemas/rpc-config.ts' +import type { NetworkName, RpcConfig } from '#/types.ts' + +export const knownNetworks = { + ethereum: '1', + goerli: '5', + optimism: '10', + polygon: '137', + holesky: '17000', + arbitrum: '42161' +} satisfies Record + +export function networkNameToChainId({ + networkName, + config +}: { + networkName: string + config?: RpcConfig +}) { + networkName = networkName.toLowerCase() + if (!stringIsNetworkName(networkName)) { + throw new Error(`Unknown network name: ${networkName}`) + } + if (!config) return knownNetworks[networkName] + return config['network_names'][networkName] +} + +function stringIsNetworkName(input: string): input is NetworkName { + return input in knownNetworks +} diff --git a/typescript/src/parsers.ts b/typescript/src/parsers.ts new file mode 100644 index 0000000..2190b3c --- /dev/null +++ b/typescript/src/parsers.ts @@ -0,0 +1,110 @@ +import fs from 'node:fs' +import * as v from 'valibot' +import { raise, removeUndefined } from '#/utilities.ts' +import { rpcConfigSchema } from '#/schemas/rpc-config.ts' +import type { RawMESCConfig } from '#/schemas/mesc-config' + +/** @see https://github.com/paradigmxyz/mesc/blob/main/SPECIFICATION.md#environment-setup */ +export function parseMescVariables({ + MESC_MODE, + MESC_PATH, + MESC_ENV +}: Pick) { + if (MESC_MODE.length > 0 && !['PATH', 'ENV'].includes(MESC_MODE)) { + raise('MESC_MODE must be set to PATH or ENV') + } + + if (MESC_MODE === 'PATH') { + const mescFileExists = fs.existsSync(MESC_PATH) + if (!mescFileExists) raise('MESC_MODE is set to PATH but file set in MESC_PATH does not exist') + const rawRpcConfig = fs.readFileSync(MESC_PATH, { encoding: 'utf-8' }) + return v.safeParse(rpcConfigSchema, JSON.parse(rawRpcConfig), { + abortEarly: false, + abortPipeEarly: false + }) + } + if (MESC_MODE === 'ENV') { + const rawRpcConfig = MESC_ENV?.length + ? MESC_ENV + : raise('MESC_MODE is set to ENV but MESC_ENV is not set or empty') + return v.safeParse(rpcConfigSchema, JSON.parse(rawRpcConfig), { + abortEarly: false, + abortPipeEarly: false + }) + } + raise('MESC_MODE is not enabled') +} + +/** + * parse space-separated items of .[.into a mapping + * Example: "foundry.default_endpoint=local_goerli foundry.network_defaults.5=alchemy_optimism" + * returns { + * foundry: { + * default_endpoint: "local_goerli", + * network_defaults: { + * 5: "alchemy_optimism" + * } + * } + * } + */ +export function parseSpaceSeparatedProfiles(input?: string) { + if (!input) return false + const parts = input.split(' ') + const groups = {} as { + [profile: string]: { + default_endpoint?: string + network_defaults?: Record + } + } + for (const part of parts) { + if (part.includes('default_endpoint')) { + const [profile, key] = part.split('.') + if (!profile || !key) raise(`Failed to parse MESC_PROFILES profile: ${part}`) + const [key_, value] = key.split('=') + if (!key_ || !value) raise(`Failed to parse MESC_PROFILES: ${part}`) + groups[profile] = { default_endpoint: value, ...groups[profile] } + } + if (part.includes('network_defaults')) { + const [profile, key, chainIdNetworkName] = part.split('.') + if (!profile || !key || !chainIdNetworkName) raise(`Failed to parse MESC_PROFILES: ${part}`) + const [chainId, networkName] = chainIdNetworkName.split('=') + if (!chainId || !networkName) raise(`Failed to parse MESC_PROFILES: ${part}`) + groups[profile] = { ...groups[profile], network_defaults: { [chainId]: networkName } } + } + } + return groups +} + +/** + * parse space-separated items of [[:]=] into a mapping + * returns {Record} + */ +export function parseSpaceSeparatedEndpoints(input?: string) { + if (!input) return false + return removeUndefined( + input.split(' ').reduce((accumulator, item) => { + const [name, url] = item.split('=') as [string, string] + const [name_, chain_id] = name.split(':') as [string, string | undefined] + return { ...accumulator, [name_]: { url, chain_id } } + }, {}) + ) as Record +} + +/** + * parse space-separated pairs of = into a mapping + */ +export function parseSpaceSeparatedPairs(input?: string) { + if (!input) return false + return input.split(' ').reduce((accumulator, pair) => { + const [key, value] = pair.split('=') as [string, string] + return { ...accumulator, [key]: value } + }, {}) +} + +/** + * parse JSON string into a JSON object + */ +export function parseStringJSON(input?: string) { + if (!input) return false + return JSON.parse(input) as Record +} diff --git a/typescript/src/schemas/mesc-config.ts b/typescript/src/schemas/mesc-config.ts new file mode 100644 index 0000000..13f5d9f --- /dev/null +++ b/typescript/src/schemas/mesc-config.ts @@ -0,0 +1,23 @@ +import * as v from 'valibot' + +export const mescConfigSchema = v.object({ + MESC_MODE: v.union([v.literal('PATH'), v.literal('ENV'), v.literal('DISABLED')]), + MESC_PATH: v.string(), + MESC_ENV: v.optional(v.string()), + /** JSON mapping of {"endpoint_name": {}} */ + MESC_ENDPOINT_METADATA: v.optional(v.string()), + /** JSON formatted global metadata */ + MESC_GLOBAL_METADATA: v.optional(v.string()), + /** space-separated items of [[:]=] */ + MESC_ENDPOINTS: v.optional(v.string([v.regex(/(\w+(\.\w+)?(:\d+)?=[\w\d]+)+/)])), + /** space-separated pairs of = */ + MESC_NETWORK_NAMES: v.optional(v.string([v.regex(/(\w+=[\w\d]+)+/)])), + /** url, endpoint name, or network name */ + MESC_DEFAULT_ENDPOINT: v.optional(v.string()), + /** space-separated pairs of .[. */ + MESC_PROFILES: v.optional(v.string([v.regex(/(\w+\.\w+(\.\d+)?)=[\w\d]+/)])), + /** space-separated pairs of = */ + MESC_NETWORK_DEFAULTS: v.optional(v.string([v.regex(/(\d+=[\w\d]+)+/)])) +}) + +export type RawMESCConfig = v.Input diff --git a/typescript/src/schemas/rpc-config.ts b/typescript/src/schemas/rpc-config.ts new file mode 100644 index 0000000..41a5288 --- /dev/null +++ b/typescript/src/schemas/rpc-config.ts @@ -0,0 +1,34 @@ +import * as v from 'valibot' + +/** + * chain_id should be represented using either a decimal string or a hex string. + * Strings are used because chain id's can be 256 bits and most languages do not have native 256 bit integer types. + * For readability, decimal should be used for small chain id values and hex should be used for values that use the entire 256 bits. + */ +export const chainIdSchema = v.union([v.string(), v.number()]) + +export type ChainId = v.Output + +export const rpcConfigSchema = v.object({ + mesc_version: v.literal('MESC 1.0'), + default_endpoint: v.optional(v.string()), + network_defaults: v.record(v.string()), + network_names: v.record(v.string()), + endpoints: v.record( + v.object({ + name: v.string(), + url: v.string(), + chain_id: v.optional(v.string()), + endpoint_metadata: v.any() + }) + ), + profiles: v.record( + v.object({ + default_endpoint: v.optional(v.nullable(v.string())), + network_defaults: v.record(v.string()) + }) + ), + global_metadata: v.any() +}) + +export type RpcConfig = v.Output diff --git a/typescript/src/transform.ts b/typescript/src/transform.ts new file mode 100644 index 0000000..6abd062 --- /dev/null +++ b/typescript/src/transform.ts @@ -0,0 +1,97 @@ +import * as v from 'valibot' +import { + parseStringJSON, + parseMescVariables, + parseSpaceSeparatedPairs, + parseSpaceSeparatedProfiles, + parseSpaceSeparatedEndpoints +} from '#/parsers.ts' +import { raise } from '#/utilities.ts' +import { mescConfigSchema } from '#/schemas/mesc-config.ts' + +/** + * TODO: check if MESC_NETWORK_DEFAULTS is supposed to be merged with existing network_defaults or override it + * if the latter, then: + * 'Object.assign(rpcConfig.network_defaults, rpcConfig.network_defaults, mescNetworkDefaults)' + */ + +/** @see https://github.com/paradigmxyz/mesc/blob/main/SPECIFICATION.md */ +export const mescConfigurationTransform = v.transform( + mescConfigSchema, + ({ + MESC_MODE, + MESC_PATH, + MESC_ENV, + MESC_ENDPOINTS, + MESC_DEFAULT_ENDPOINT, + MESC_PROFILES, + MESC_NETWORK_NAMES, + MESC_NETWORK_DEFAULTS, + MESC_GLOBAL_METADATA, + MESC_ENDPOINT_METADATA + }) => { + // MESC is not enabled + if (MESC_MODE === 'DISABLED' || [MESC_MODE, MESC_ENV, MESC_PATH].filter(Boolean).length === 0) + return null + const { + success, + output: rpcConfig, + issues + } = parseMescVariables({ MESC_MODE, MESC_PATH, MESC_ENV }) + if (!success) + raise(`Failed to parse MESC variables: ${JSON.stringify(v.flatten(issues), undefined, 2)}`) + + if (MESC_DEFAULT_ENDPOINT?.length) { + Object.assign(rpcConfig, { default_endpoint: MESC_DEFAULT_ENDPOINT }) + } + + const mescNetworkDefaults = parseSpaceSeparatedPairs(MESC_NETWORK_DEFAULTS) + if (mescNetworkDefaults) { + Object.assign(rpcConfig, { network_defaults: mescNetworkDefaults }) + } + + const mescNetworkNames = parseSpaceSeparatedPairs(MESC_NETWORK_NAMES) + if (mescNetworkNames) { + Object.assign(rpcConfig, { network_names: mescNetworkNames }) + } + + const mescEndpoints = parseSpaceSeparatedEndpoints(MESC_ENDPOINTS) + if (mescEndpoints) { + Object.assign(rpcConfig, { endpoints: mescEndpoints }) + } + + const mescProfiles = parseSpaceSeparatedProfiles(MESC_PROFILES) + if (mescProfiles) { + Object.assign(rpcConfig, { profiles: mescProfiles }) + } + + const mescGlobalMetadata = parseStringJSON(MESC_GLOBAL_METADATA) + if (mescGlobalMetadata) { + Object.assign(rpcConfig.global_metadata, rpcConfig.global_metadata, mescGlobalMetadata) + } + + const mescEndpointMetadata = parseStringJSON(MESC_ENDPOINT_METADATA) + if (mescEndpointMetadata) { + for (const endpoint in mescEndpointMetadata) { + const metadata = mescEndpointMetadata[endpoint] + if (!rpcConfig.endpoints[endpoint]) continue + Object.assign(rpcConfig.endpoints[endpoint]?.endpoint_metadata, metadata) + } + } + + return rpcConfig + } +) + +export type MESCConfiguration = v.Output + +export function getRpcConfig(env: Record = process.env): MESCConfiguration { + const { output, success, issues } = v.safeParse(mescConfigurationTransform, env, { + abortEarly: false, + abortPipeEarly: false + }) + + if (!success) raise(`Failed to parse MESC configuration: ${JSON.stringify(issues, undefined, 2)}`) + + return output +} diff --git a/typescript/src/types.ts b/typescript/src/types.ts new file mode 100644 index 0000000..edbcb69 --- /dev/null +++ b/typescript/src/types.ts @@ -0,0 +1,46 @@ +import type { ChainId } from '#/schemas/rpc-config.ts' + +export type NetworkName = 'ethereum' | 'goerli' | 'optimism' | 'polygon' | 'holesky' | 'arbitrum' + +export interface RpcConfig { + mesc_version: string + default_endpoint?: string + endpoints: Record + network_defaults: Record + network_names: Record + profiles: Record + global_metadata: Record +} + +export interface Endpoint { + name: string + url: string + chain_id?: ChainId + endpoint_metadata: Record +} + +export interface Profile { + name: string + default_endpoint?: string + network_defaults: Record +} + +export interface Query { + default_endpoint?: string + endpoint_by_name?: string + endpoint_by_network?: string + user_input?: string + multi_endpoint?: string + global_metadata?: string +} + +export type Maybe = T | undefined + +type Json = string | number | boolean | null | Json[] | { [key: string]: Json } + +/** + * This type utility is used to unwrap complex types so you can hover over them in your editor + */ +export type Pretty = { + [K in keyof T]: T[K] +} & {} diff --git a/typescript/src/utilities.ts b/typescript/src/utilities.ts new file mode 100644 index 0000000..53e3b5c --- /dev/null +++ b/typescript/src/utilities.ts @@ -0,0 +1,11 @@ +export function raise(error: unknown): never { + throw typeof error === 'string' ? new Error(error) : error +} + +export const unixTimestamp = () => `${Math.floor(Date.now() / 1_000)}` + +// removed properties with undefined values from object +export function removeUndefined(object?: T): T { + if (!object) return {} as T + return (typeof object === 'string' ? JSON.parse(object) : JSON.parse(JSON.stringify(object))) as T +} diff --git a/typescript/test/index.test.ts b/typescript/test/index.test.ts new file mode 100644 index 0000000..afc291f --- /dev/null +++ b/typescript/test/index.test.ts @@ -0,0 +1,6 @@ +import { expect, test } from 'vitest' + +// placeholder test +test(() => { + expect(1).toBe(1) +}) diff --git a/typescript/tsconfig.json b/typescript/tsconfig.json new file mode 100644 index 0000000..0d876f2 --- /dev/null +++ b/typescript/tsconfig.json @@ -0,0 +1,37 @@ +{ + "compilerOptions": { + "baseUrl": ".", + "noEmit": true, + "paths": { + "#/*": ["./src/*"], + "~test-json": ["../tests/generated/tests.json"] + }, + "types": ["node", "bun"], + "lib": ["ESNext"], + "module": "ESNext", + "target": "ESNext", + "moduleResolution": "Bundler", + "useDefineForClassFields": true, + "resolveJsonModule": true, + "resolvePackageJsonExports": true, + "resolvePackageJsonImports": true, + "allowImportingTsExtensions": true, + "noUncheckedIndexedAccess": true, + "noFallthroughCasesInSwitch": true, + "sourceMap": false, + "declarationMap": false, + "noPropertyAccessFromIndexSignature": true, + "alwaysStrict": true, + "strictNullChecks": true, + "verbatimModuleSyntax": true, + "strict": true, + "skipLibCheck": true, + "allowSyntheticDefaultImports": true, + "forceConsistentCasingInFileNames": true, + "allowJs": true, + "checkJs": true + }, + "include": ["src", "test", "scripts"], + "files": ["environment.d.ts", "reset.d.ts"], + "exclude": ["_"] +} diff --git a/typescript/tsup.config.ts b/typescript/tsup.config.ts new file mode 100644 index 0000000..73bd18e --- /dev/null +++ b/typescript/tsup.config.ts @@ -0,0 +1,13 @@ +import { defineConfig } from 'tsup' + +export default defineConfig({ + dts: true, + shims: true, + clean: true, + bundle: true, + outDir: 'dist', + format: ['esm'], + target: ['node20'], + treeshake: 'recommended', + entry: ['./src/index.ts'] +}) diff --git a/typescript/vitest.config.ts b/typescript/vitest.config.ts new file mode 100644 index 0000000..29aebba --- /dev/null +++ b/typescript/vitest.config.ts @@ -0,0 +1,5 @@ +import { defineConfig } from 'vitest/config' + +export default defineConfig({ + test: {} +})