Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/c29r3/solana-rpc-finder
Solana RPC Finder is a tool that helps discover available RPC nodes in the Solana network
https://github.com/c29r3/solana-rpc-finder
api crypto cryptocurrency rpc sol solana web3
Last synced: 27 days ago
JSON representation
Solana RPC Finder is a tool that helps discover available RPC nodes in the Solana network
- Host: GitHub
- URL: https://github.com/c29r3/solana-rpc-finder
- Owner: c29r3
- License: gpl-3.0
- Created: 2024-09-12T17:46:48.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-09-13T11:39:05.000Z (about 2 months ago)
- Last Synced: 2024-09-30T07:05:44.186Z (about 1 month ago)
- Topics: api, crypto, cryptocurrency, rpc, sol, solana, web3
- Language: Python
- Homepage:
- Size: 39.1 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Solana RPC Finder
**Solana RPC Finder** is a tool that helps discover available RPC nodes in the Solana network.
https://solana.rpc-finder.com/
## Table of Contents
- [Description](#description)
- [Installation](#installation)
- [Configuration](#configuration)
- [Usage](#usage)
- [Running with Docker](#running-with-docker)
- [Updating the Docker Image](#updating-the-docker-image)
- [Output Format](#output-format)
- [Requirements](#requirements)
- [License](#license)
## Description
The script performs the following tasks:
- Retrieves the list of all cluster nodes from one or more initial RPCs.
- Checks the availability of each node based on its IP and port.
- Filters nodes with active RPC servers.
- Supports multithreading to speed up node discovery and verification.
- Saves the list of active nodes to the `active_nodes.json` file for later use.
## Installation
1. Clone the repository:
```bash
git clone https://github.com/c29r3/solana-rpc-finder.git
```
2. Navigate to the project directory:
```bash
cd solana-rpc-finder
```
3. Install the required dependencies:
```bash
pip install -r requirements.txt
```
## Configuration
You can configure the following parameters inside the script:
- `INITIAL_RPC_NODES`: A list of initial RPC nodes to scan (by default, the official Solana node).
- `DEFAULT_PORT`: The default port for checking RPC nodes (8899).
- `RETRY_COUNT`: The number of retry attempts to fetch cluster nodes.
- `SCAN_NULL_RPC_NODES`: Specifies whether to scan nodes with a missing `rpc` field.
- Multithreading parameters:
- `MAX_RPC_FETCH_WORKERS`: Number of threads for fetching nodes from initial RPCs.
- `MAX_NODE_CHECK_WORKERS`: Number of threads for checking node availability.
## Usage
1. Run the script:
```bash
python main.py
```
2. The script will perform the following steps:
- Load nodes from the `active_nodes.json` file (if it exists).
- Fetch nodes from the initial RPCs.
- Check node availability and save active nodes to the `active_nodes.json` file.
3. After completion, all active nodes will be saved to the `active_nodes.json` file.
## Running with Docker
To run the project inside a Docker container:
1. Run the following command to start the Docker container and mount the necessary files:
```bash
touch active_nodes.json full_cluster.json; \
docker run -it --rm \
-v $(pwd)/active_nodes.json:/app/active_nodes.json \
-v $(pwd)/full_cluster.json:/app/full_cluster.json \
--user $(id -u):$(id -g) \
c29r3/solana-rpc-finder:latest
```
This command will:
- Mount `active_nodes.json` and `full_cluster.json` from your current working directory into the container.
- Ensure the container is run with the same user permissions as your host system.
## Updating the Docker Image
To pull the latest version of the Docker image and update it, run:
```bash
docker pull c29r3/solana-rpc-finder:latest
```
This will fetch the latest version of the image from the Docker Hub.
## Output Format
The `active_nodes.json` file contains a list of active nodes in JSON format. Example:
```json
[
{
"featureSet": 4215500110,
"gossip": "192.168.0.2:8000",
"pubkey": "7mF8NZ...",
"pubsub": "192.168.0.2:8900",
"rpc": "192.168.0.2:8899",
"shredVersion": 50093,
"tpu": "192.168.0.2:8012",
"tpuQuic": "192.168.0.2:8018",
"version": "1.18.23",
"latency": 218.30987930297852
},
{
"featureSet": 4215500110,
"gossip": "192.168.0.3:8000",
"pubkey": "9ubTvP...",
"pubsub": "192.168.0.3:8900",
"rpc": "192.168.0.3:8899",
"shredVersion": 50093,
"tpu": "192.168.0.3:8003",
"tpuQuic": "192.168.0.3:8009",
"version": "1.18.22",
"latency": 210.6649875640869
}
]
```
## Requirements
- Python 3.7+
- Modules: `requests`, `tqdm`, `concurrent.futures`
## License
This project is licensed under the GNU General Public License v3.0. See the [LICENSE](LICENSE) file for details.