bsc-provider-helper
v1.0.0
Published
BSC (BNB Smart Chain) provider and wallet helpers for trading bots
Maintainers
Readme
bsc-provider-helper
BSC (BNB Smart Chain) provider and wallet helpers for trading bots. Create ethers v6 JsonRpcProvider and Wallet for BSC mainnet (56) and testnet (97).
Install
npm install bsc-provider-helperUsage
const {
getProvider,
getWallet,
getWalletWithProvider,
getDefaultRpcUrl,
BSC_MAINNET_CHAIN_ID,
BSC_TESTNET_CHAIN_ID,
} = require('bsc-provider-helper');
// Default BSC mainnet provider
const provider = getProvider();
const block = await provider.getBlockNumber();
// Custom RPC or testnet
const testnet = getProvider('https://data-seed-prebsc-1-s1.binance.org:8545', 97);
// Wallet (for signing txs in trading bot)
const wallet = getWalletWithProvider(process.env.PRIVATE_KEY);
const balance = await wallet.provider.getBalance(wallet.address);Subpath imports
const { getDefaultRpcUrl, BSC_MAINNET_CHAIN_ID } = require('bsc-provider-helper/chains');
const { getProvider, getMainnetProvider } = require('bsc-provider-helper/provider');
const { getWallet, getWalletWithProvider } = require('bsc-provider-helper/wallet');API
| Method | Description |
|--------|-------------|
| getDefaultRpcUrl(chainId?) | Default RPC URL for BSC mainnet (56) or testnet (97) |
| getProvider(rpcUrl?, chainId?) | ethers.JsonRpcProvider for BSC |
| getMainnetProvider() | Provider for BSC mainnet |
| getTestnetProvider() | Provider for BSC testnet |
| getWallet(privateKey, provider?) | ethers.Wallet; connect to provider if given |
| getWalletWithProvider(privateKey, rpcUrl?) | Wallet with default mainnet provider |
Dependencies
ethers^6.x
License
MIT
