Documentation

Documentation »API »Providers »Community Providers

Community Providers

There are many awesome community services that provide Ethereum nodes both for developers just starting out and for large-scale communities.

Functions
Alchemy
AlchemyProvider
Ankr
Cloudflare
CommunityResourcable
Etherscan
INFURA
Pocket
QuickNode

<src>showThrottleMessage(service: string)⇒ void

Displays a warning in tht console when the community resource is being used too heavily by the app, recommending the developer acquire their own credentials instead of using the community credentials.

The notification will only occur once per service.

Alchemy

About Alchemy

<src>class AlchemyProvider

inherits fromJsonRpcProvider, JsonRpcApiPollingProvider, JsonRpcApiProvider, AbstractProvider, Provider, ContractRunner, EventEmitterable, NameResolver, CommunityResourcable

The AlchemyProvider connects to the Alchemy JSON-RPC end-points.

By default, a highly-throttled API key is used, which is appropriate for quick prototypes and simple scripts. To gain access to an increased rate-limit, it is highly recommended to sign up here.

<src>alchemyProvider.apiKey⇒ stringread-only

<src>new AlchemyProvider(network?: Networkish, apiKey?: null | string)

<src>AlchemyProvider.getRequest(network: Network, apiKey?: string)⇒ FetchRequest

Ankr

Ankr provides a third-party service for connecting to various blockchains over JSON-RPC.

Supported Networks

Ethereum Mainnet (mainnet)
Goerli Testnet (goerli)
Polygon (matic)
Arbitrum (arbitrum)

<src>class AnkrProvider

inherits fromJsonRpcProvider, JsonRpcApiPollingProvider, JsonRpcApiProvider, AbstractProvider, Provider, ContractRunner, EventEmitterable, NameResolver, CommunityResourcable

The AnkrProvider connects to the Ankr JSON-RPC end-points.

By default, a highly-throttled API key is used, which is appropriate for quick prototypes and simple scripts. To gain access to an increased rate-limit, it is highly recommended to sign up here.

<src>ankrProvider.apiKey⇒ stringread-only

The API key for the Ankr connection.

<src>new AnkrProvider(network?: Networkish, apiKey?: null | string)

Create a new AnkrProvider.

By default connecting to mainnet with a highly throttled API key.

<src>AnkrProvider.getRequest(network: Network, apiKey?: null | string)⇒ FetchRequest

Returns a prepared request for connecting to network with apiKey.

Cloudflare

About Cloudflare

<src>class CloudflareProvider

inherits fromJsonRpcProvider, JsonRpcApiPollingProvider, JsonRpcApiProvider, AbstractProvider, Provider, ContractRunner, EventEmitterable, NameResolver

About Cloudflare...

<src>new CloudflareProvider(network?: Networkish)

<src>interface CommunityResourcable

There are many awesome community services that provide Ethereum nodes both for developers just starting out and for large-scale communities.

<src>communityResourcable.isCommunityResource()⇒ boolean

Returns true of the instance is connected using the community credentials.

Etherscan

Etherscan provides a third-party service for connecting to various blockchains over a combination of JSON-RPC and custom API endpoints.

Supported Networks

Ethereum Mainnet (mainnet)
Goerli Testnet (goerli)
Sepolia Testnet (sepolia)
Arbitrum (arbitrum)
Arbitrum Goerli Testnet (arbitrum-goerli)
Optimism (optimism)
Optimism Goerli Testnet (optimism-goerli)
Polygon (matic)
Polygon Mumbai Testnet (maticmum)

<src>DebugEventEtherscanProvider⇒ { action: "sendRequest" , id: number , payload: Record< string, any > , url: string } | { action: "receiveRequest" , id: number , result: any } | { action: "receiveError" , error: any , id: number }

When subscribing to the "debug" event on an Etherscan-based provider, the events receive a DebugEventEtherscanProvider payload.

<src>class EtherscanPlugin

inherits fromNetworkPlugin

A Network can include an EtherscanPlugin to provide a custom base URL.

<src>etherscanPlugin.baseUrl⇒ stringread-only

The Etherscan API base URL.

<src>new EtherscanPlugin(baseUrl: string)

Creates a new EtherscanProvider which will use baseUrl.

<src>class EtherscanProvider

inherits fromAbstractProvider, Provider, ContractRunner, EventEmitterable, NameResolver

The EtherscanBaseProvider is the super-class of EtherscanProvider, which should generally be used instead.

Since the EtherscanProvider includes additional code for Contract access, in rare cases that contracts are not used, this class can reduce code size.

<src>etherscanProvider.apiKey⇒ null | stringread-only

The API key or null if using the community provided bandwidth.

<src>etherscanProvider.network⇒ Networkread-only

The connected network.

<src>new EtherscanProvider(network?: Networkish, apiKey?: string)

Creates a new EtherscanBaseProvider.

<src>etherscanProvider._checkError(req: PerformActionRequest, error: Error, transaction: any)⇒ never

Throws the normalized Etherscan error.

<src>etherscanProvider._getTransactionPostData(transaction: TransactionRequest)⇒ Record< string, string >

Returns transaction normalized for the Etherscan API.

<src>etherscanProvider.detectNetwork()⇒ Promise< Network >

<src>etherscanProvider.fetch(module: string, params: Record< string, any >, post?: boolean)⇒ Promise< any >

Resolves to the result of calling module with params.

If post, the request is made as a POST request.

<src>etherscanProvider.getBaseUrl()⇒ string

Returns the base URL.

If an EtherscanPlugin is configured on the EtherscanBaseProvider_network, returns the plugin's baseUrl.

<src>etherscanProvider.getContract(address: string)⇒ Promise< null | Contract >

Resolves to a [Contract]] for address, using the Etherscan API to retreive the Contract ABI.

<src>etherscanProvider.getEtherPrice()⇒ Promise< number >

Resolves to the current price of ether.

This returns 0 on any network other than mainnet.

<src>etherscanProvider.getPostData(module: string, params: Record< string, any >)⇒ Record< string, any >

Returns the parameters for using POST requests.

<src>etherscanProvider.getPostUrl()⇒ string

Returns the URL for using POST requests.

<src>etherscanProvider.getUrl(module: string, params: Record< string, string >)⇒ string

Returns the URL for the module and params.

<src>etherscanProvider.isCommunityResource()⇒ boolean

INFURA

INFURA provides a third-party service for connecting to various blockchains over JSON-RPC.

Supported Networks

Ethereum Mainnet (mainnet)
Goerli Testnet (goerli)
Sepolia Testnet (sepolia)
Arbitrum (arbitrum)
Arbitrum Goerli Testnet (arbitrum-goerli)
Optimism (optimism)
Optimism Goerli Testnet (optimism-goerli)
Polygon (matic)
Polygon Mumbai Testnet (maticmum)

<src>class InfuraProvider

inherits fromJsonRpcProvider, JsonRpcApiPollingProvider, JsonRpcApiProvider, AbstractProvider, Provider, ContractRunner, EventEmitterable, NameResolver, CommunityResourcable

The InfuraProvider connects to the INFURA JSON-RPC end-points.

By default, a highly-throttled API key is used, which is appropriate for quick prototypes and simple scripts. To gain access to an increased rate-limit, it is highly recommended to sign up here.

<src>infuraProvider.projectId⇒ stringread-only

The Project ID for the INFURA connection.

<src>infuraProvider.projectSecret⇒ null | stringread-only

The Project Secret.

If null, no authenticated requests are made. This should not be used outside of private contexts.

<src>new InfuraProvider(network?: Networkish, projectId?: null | string, projectSecret?: null | string)

Creates a new InfuraProvider.

<src>InfuraProvider.getRequest(network: Network, projectId?: null | string, projectSecret?: null | string)⇒ FetchRequest

Returns a prepared request for connecting to network with projectId and projectSecret.

<src>InfuraProvider.getWebSocketProvider(network?: Networkish, projectId?: string)⇒ InfuraWebSocketProvider

Creates a new InfuraWebSocketProvider.

<src>class InfuraWebSocketProvider

inherits fromWebSocketProvider, SocketProvider, JsonRpcApiProvider, AbstractProvider, Provider, ContractRunner, EventEmitterable, NameResolver, CommunityResourcable

The InfuraWebSocketProvider connects to the INFURA WebSocket end-points.

By default, a highly-throttled API key is used, which is appropriate for quick prototypes and simple scripts. To gain access to an increased rate-limit, it is highly recommended to sign up here.

<src>infuraWebSocketProvider.projectId⇒ stringread-only

The Project ID for the INFURA connection.

<src>infuraWebSocketProvider.projectSecret⇒ null | stringread-only

The Project Secret.

If null, no authenticated requests are made. This should not be used outside of private contexts.

<src>new InfuraWebSocketProvider(network?: Networkish, projectId?: string)

Creates a new InfuraWebSocketProvider.

Pocket

Pocket Network provides a third-party service for connecting to various blockchains over JSON-RPC.

Supported Networks

Ethereum Mainnet (mainnet)
Goerli Testnet (goerli)
Polygon (matic)
Arbitrum (arbitrum)

<src>class PocketProvider

inherits fromJsonRpcProvider, JsonRpcApiPollingProvider, JsonRpcApiProvider, AbstractProvider, Provider, ContractRunner, EventEmitterable, NameResolver, CommunityResourcable

The PocketProvider connects to the Pocket Network JSON-RPC end-points.

By default, a highly-throttled API key is used, which is appropriate for quick prototypes and simple scripts. To gain access to an increased rate-limit, it is highly recommended to sign up here.

<src>pocketProvider.applicationId⇒ stringread-only

The Application ID for the Pocket connection.

<src>pocketProvider.applicationSecret⇒ null | stringread-only

The Application Secret for making authenticated requests to the Pocket connection.

<src>new PocketProvider(network?: Networkish, applicationId?: null | string, applicationSecret?: null | string)

Create a new PocketProvider.

By default connecting to mainnet with a highly throttled API key.

<src>PocketProvider.getRequest(network: Network, applicationId?: null | string, applicationSecret?: null | string)⇒ FetchRequest

Returns a prepared request for connecting to network with applicationId.

QuickNode

QuickNode provides a third-party service for connecting to various blockchains over JSON-RPC.

Supported Networks

Ethereum Mainnet (mainnet)
Goerli Testnet (goerli)
Arbitrum (arbitrum)
Arbitrum Goerli Testnet (arbitrum-goerli)
Optimism (optimism)
Optimism Goerli Testnet (optimism-goerli)
Polygon (matic)
Polygon Mumbai Testnet (maticmum)

<src>class QuickNodeProvider

inherits fromJsonRpcProvider, JsonRpcApiPollingProvider, JsonRpcApiProvider, AbstractProvider, Provider, ContractRunner, EventEmitterable, NameResolver, CommunityResourcable

The QuickNodeProvider connects to the QuickNode JSON-RPC end-points.

By default, a highly-throttled API token is used, which is appropriate for quick prototypes and simple scripts. To gain access to an increased rate-limit, it is highly recommended to sign up here.

<src>quickNodeProvider.token⇒ stringread-only

The API token.

<src>new QuickNodeProvider(network?: Networkish, token?: null | string)

Creates a new QuickNodeProvider.

<src>QuickNodeProvider.getRequest(network: Network, token?: null | string)⇒ FetchRequest

Returns a new request prepared for network and the token.