rotating-provider
v2.0.11
Published
A quickstart-friendly TypeScript template with comprehensive formatting, linting, releases, testing, and other great tooling built-in. ✨
Downloads
13
Readme
Table of Contents
Introduction
Rotating Provider is a utility library that helps manage and switch between multiple providers in a decentralized application (dApp) that interacts with multiple blockchain networks. It facilitates the rotation of providers to ensure continuous service availability while handling issues with individual providers.
Features
- Efficiently switch between multiple blockchain providers.
- Automatic validation and rotation of providers to avoid downtime.
- Simple and flexible integration with existing dApp projects.
- Customizable interval and provider lists to suit different use cases.
Installation
Install the package using npm:
npm install rotating-provider
or pnpm:
pnpm add rotating-provider
Usage
To use the Rotating Provider library, follow these steps:
- Import the library in your JavaScript/TypeScript file:
const { RotatingProvider } = require("rotating-provider"); // For JavaScript
// or
import { RotatingProvider } from "rotating-provider"; // For TypeScript
- Create a new instance of RotatingProvider by providing chain id and interval between rotation:
const providerInterval = 5000; // Set the interval (in milliseconds) for provider rotation.
const chainId = 1; // Chain id of blockchain
const rotatingProvider = new RotatingProvider(chainId, providerInterval);
- Access the provider functions
const blocknumber = await rotatingProvider.provider.getBlockNumber();
Author
- Aceson Sunny (0xask3)
Contributing
Contributions to the Rotating Provider library are welcome! If you find a bug, have an idea for an improvement, or want to contribute new features, please follow these steps:
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Make your changes and commit them with descriptive commit messages.
- Push your branch to your forked repository.
- Submit a pull request to the main repository, explaining your changes.
License
The Rotating Provider library is licensed under the MIT License.