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

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

class AlchemyProvider

inherits from JsonRpcProvider, JsonRpcApiPollingProvider, 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.

PROPERTIES

<src>alchemyProvider.apiKey⇒ stringread-only

CREATING INSTANCES

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

METHODS

<src>alchemyProvider._getProvider(chainId: number)⇒ AbstractProvider

<src>alchemyProvider._perform(req: PerformActionRequest)⇒ Promise< any >

<src>alchemyProvider.isCommunityResource()⇒ boolean

STATIC METHODS

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

interface CommunityResourcable

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

METHODS

<src>communityResourcable.isCommunityResource()⇒ boolean

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

Alchemy

About Alchemy

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)

class AnkrProvider

inherits from JsonRpcProvider, JsonRpcApiPollingProvider, 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.

PROPERTIES

<src>ankrProvider.apiKey⇒ stringread-only

The API key for the Ankr connection.

CREATING INSTANCES

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

Create a new AnkrProvider.

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

METHODS

<src>ankrProvider._getProvider(chainId: number)⇒ AbstractProvider

<src>ankrProvider.getRpcError(payload: JsonRpcPayload, error: JsonRpcError)⇒ Error

<src>ankrProvider.isCommunityResource()⇒ boolean

STATIC METHODS

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

Returns a prepared request for connecting to network with apiKey.

Cloudflare

About Cloudflare

class CloudflareProvider

inherits from JsonRpcProvider, JsonRpcApiPollingProvider

About Cloudflare...

CREATING INSTANCES

<src>new CloudflareProvider(network?: Networkish)

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 (matic-mumbai)

TYPES

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

class EtherscanPlugin

inherits from NetworkPlugin

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

PROPERTIES

<src>etherscanPlugin.baseUrl⇒ stringread-only

The Etherscan API base URL.

CREATING INSTANCES

<src>new EtherscanPlugin(baseUrl: string)

Creates a new EtherscanProvider which will use baseUrl.

METHODS

<src>etherscanPlugin.clone()⇒ EtherscanPlugin

class EtherscanProvider

inherits from AbstractProvider, Provider

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.

PROPERTIES

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

CREATING INSTANCES

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

Creates a new EtherscanBaseProvider.

METHODS

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

Throws the normalized Etherscan error.

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

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

Returns transaction normalized for the Etherscan API.

<src>etherscanProvider._perform(req: PerformActionRequest)⇒ Promise< any >

<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.getNetwork()⇒ Promise< Network >

<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 (matic-mumbai)

class InfuraProvider

inherits from JsonRpcProvider, JsonRpcApiPollingProvider, 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.

PROPERTIES

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

CREATING INSTANCES

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

Creates a new InfuraProvider.

METHODS

<src>infuraProvider._getProvider(chainId: number)⇒ AbstractProvider

<src>infuraProvider.isCommunityResource()⇒ boolean

STATIC METHODS

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

class InfuraWebSocketProvider

inherits from WebSocketProvider, SocketProvider, 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.

PROPERTIES

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

CREATING INSTANCES

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

Creates a new InfuraWebSocketProvider.

METHODS

<src>infuraWebSocketProvider.isCommunityResource()⇒ boolean

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)

class PocketProvider

inherits from JsonRpcProvider, JsonRpcApiPollingProvider, 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.

PROPERTIES

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

CREATING INSTANCES

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

METHODS

<src>pocketProvider._getProvider(chainId: number)⇒ AbstractProvider

<src>pocketProvider.isCommunityResource()⇒ boolean

STATIC METHODS

<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 (matic-mumbai)

class QuickNodeProvider

inherits from JsonRpcProvider, JsonRpcApiPollingProvider, 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.

PROPERTIES

<src>quickNodeProvider.token⇒ stringread-only

The API token.

CREATING INSTANCES

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

Creates a new QuickNodeProvider.

METHODS

<src>quickNodeProvider._getProvider(chainId: number)⇒ AbstractProvider

<src>quickNodeProvider.isCommunityResource()⇒ boolean

STATIC METHODS

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

Returns a new request prepared for network and the token.