README.md

 

Web3 RPC Provider

     

🎯 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 for optimal, stable, and latest block height access to blockchains.

🚀 Deployment

# Run the image
$ docker run -p 3000:3000 -d dodozoo/we3-rpc-provider:latest

💡 Usage

The usage is straightforward, just make a request to the following apis.

Get the endpoint of multiple chains

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

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 folder.

🧑‍💻 Development

Starting Project

# 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

👥 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.

📝 License

This project is under license from MIT. For more details, see the LICENSE file.

 

Back to top