https://github.com/dodoex/web3-rpc-provider
This repo offers the apis of get the free endpoint, enabling clients to quickly access blockchain networks.
https://github.com/dodoex/web3-rpc-provider
ethereum-dapp web3
Last synced: 2 months ago
JSON representation
This repo offers the apis of get the free endpoint, enabling clients to quickly access blockchain networks.
- Host: GitHub
- URL: https://github.com/dodoex/web3-rpc-provider
- Owner: DODOEX
- License: mit
- Created: 2024-09-06T01:51:23.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-09-13T17:15:48.000Z (8 months ago)
- Last Synced: 2024-09-14T15:12:10.634Z (8 months ago)
- Topics: ethereum-dapp, web3
- Language: TypeScript
- Homepage:
- Size: 68.4 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Web3 RPC Provider
## :dart: Introduction
Web3 RPC Provider offers the apis of get the free endpoint, enabling clients to quickly access blockchain networks.
> [!NOTE]
> Works with [Web3 RPC Proxy](https://github.com/DODOEX/web3-rpc-proxy) for optimal, stable, and latest block height access to blockchains.
## :rocket: Deployment
```bash
# Run the image
$ docker run -p 3000:3000 -d dodozoo/we3-rpc-provider:latest
```
## :bulb: Usage
The usage is straightforward, just make a request to the following apis.
Get the endpoint of multiple chains
```bash
curl --location --request GET 'http://localhost:3000/endpoints'
```
Query Parameters:
- `chains`: Required
The chains parameter allows specifying multiple chain ID values.
Get the endpoint of a single chain
```bash
curl --location --request GET 'http://localhost:3000/{{chain}}/endpoints'
```
- `chain`: Required
Represents the chain ID. fill it in to get the endpoint of the specified chain.
### Common Query Parameters:
- `sources`: Required
The sources parameter represents the source of the free endpoint. it can be filled in the class name of Picker in the [pickers](src/pickers) folder.
## :technologist: Development
### Starting Project
```bash
# Clone the project
$ git clone https://github.com/DODOEX/web3-rpc-provider
# Navigate to the project directory
$ cd web3-rpc-provider
# Install project dependencies
$ pnpm install
# Start the project
$ npm run start
```
## :busts_in_silhouette: Contribute
If you want to contribute to the Web3 RPC Provider project:
Fix issues: Find and fix issues in the project.
Write documentation: Improve and write relevant documentation for the project.
Write tests: Write and optimize test cases for the project.
If you want to show appreciation or support the continued development of the Web3 RPC Provider project, you can do so by:
Giving the project a GitHub Star. Supporting the project by donating a cup of tea.
## :memo: License
This project is under license from MIT. For more details, see [the LICENSE file](LICENSE).