ethers.js/packages/providers/README.md

79 lines
1.3 KiB
Markdown
Raw Permalink Normal View History

2019-05-14 18:25:46 -04:00
Ethereum Providers
==================
This sub-module is part of the [ethers project](https://github.com/ethers-io/ethers.js).
2019-05-14 18:25:46 -04:00
It contains common Provider classes, utility functions for dealing with providers
and re-exports many of the classes and types needed to implement a custom Provider.
2019-05-14 18:25:46 -04:00
For more information, see the [documentation](https://docs.ethers.io/v5/api/providers/).
Importing
---------
Most users will prefer to use the [umbrella package](https://www.npmjs.com/package/ethers),
but for those with more specific needs, individual components can be imported.
```javascript
const {
Provider,
BaseProvider,
JsonRpcProvider,
StaticJsonRpcProvider,
UrlJsonRpcProvider,
FallbackProvider,
AlchemyProvider,
CloudflareProvider,
EtherscanProvider,
InfuraProvider,
NodesmithProvider,
IpcProvider,
Web3Provider,
WebSocketProvider,
JsonRpcSigner,
getDefaultProvider,
getNetwork,
Formatter,
// Types
TransactionReceipt,
TransactionRequest,
TransactionResponse,
Listener,
ExternalProvider,
Block,
BlockTag,
EventType,
Filter,
Log,
JsonRpcFetchFunc,
Network,
Networkish
} = require("@ethersproject/providers");
```
2019-05-14 18:25:46 -04:00
License
-------
MIT License