167 lines
5.7 KiB
Plaintext
167 lines
5.7 KiB
Plaintext
_section: Provider API Keys @<api-keys>
|
|
|
|
//( **TL; DR** – sign up for your own API keys with the links below to improve your application performance )//
|
|
|
|
When using a [[Provider]] backed by an API service (such as [[link-alchemy]],
|
|
[[link-etherscan]] or [[link-infura]]), the service requires an API key,
|
|
which allows each service to track individual projects and their usage and
|
|
permissions.
|
|
|
|
The ethers library offers default API keys for each service, so that each
|
|
[[Provider]] works out-of-the-box.
|
|
|
|
These API keys are provided as a community resource by the backend services
|
|
for low-traffic projects and for early prototyping.
|
|
|
|
Since these API keys are shared by all users (that have not acquired their
|
|
own API key), they are aggressively throttled which means retries occur more
|
|
frequently and the responses are slower.
|
|
|
|
It is **highly recommended** that you sign up for a free API key from each service for their
|
|
free tier, which (depending on the service) includes many advantages:
|
|
|
|
- a much **higher request rate** and concurrent request limit
|
|
- **faster** responses with fewer retries and timeouts
|
|
- useful **metric tracking** for performance tuning and to analyze your customer behaviour
|
|
- more **advanced APIs**, such as archive data or advanced log queries
|
|
|
|
_subsection: Etherscan @NOTE<(see the [[EtherscanProvider]])> @<api-keys--etherscan>
|
|
|
|
Etherscan is an Ethereum block explorer, which is possibly the most useful
|
|
developer tool for building and debugging Ethereum applications.
|
|
|
|
They offer an extensive collection of API endpoints which provide all the
|
|
operations required to interact with the Ethereum Blockchain.
|
|
|
|
[Sign up for a free API key on Etherscan](link-etherscan-signup)
|
|
|
|
**Benefits:**
|
|
|
|
- higher rate limit (since you are not using the [shared rate limit](link-etherscan-ratelimit))
|
|
- customer usage metrics
|
|
|
|
_definition: **Networks:**
|
|
``homestead``, ``goerli``, ``sepolia``, ``matic``. ``maticmum``, ``arbitrum``,
|
|
``arbitrum-goerli``, ``optimism`` and ``optimism-goerli``.
|
|
|
|
|
|
_subsection: INFURA @NOTE<(see the [[InfuraProvider]])> @<api-keys--infura>
|
|
|
|
The INFURA service has been around for quite some time and is very robust
|
|
and reliable and highly recommended.
|
|
|
|
They offer a standard JSON-RPC interface and a WebSocket interface, which makes
|
|
interaction with standard tools versatile, simple and straightforward.
|
|
|
|
[Sign up for a free Project ID on INFURA](link-infura-signup)
|
|
|
|
**Benefits:**
|
|
|
|
- higher rate limit
|
|
- customer usage metrics
|
|
- access to archive data (requires paid upgrade)
|
|
|
|
_definition: **Networks:**
|
|
``homestead``, ``goerli``, ``sepolia``, ``matic``. ``maticmum``, ``arbitrum``,
|
|
``arbitrum-goerli``, ``optimism`` and ``optimism-goerli``.
|
|
|
|
|
|
_subsection: Alchemy @NOTE<(see the [[AlchemyProvider]])> @<api-keys--alchemy>
|
|
|
|
The Alchemy service has been around a few years and is also very robust
|
|
and reliable.
|
|
|
|
They offer a standard JSON-RPC interface and a WebSocket interface, as well
|
|
as a collection of advanced APIs for interacting with tokens and to assist
|
|
with debugging.
|
|
|
|
[Sign up for a free API key on Alchemy](link-alchemy-signup)
|
|
|
|
**Benefits:**
|
|
|
|
- higher rate limit
|
|
- customer usage metrics
|
|
- access to advanced token balance and metadata APIs
|
|
- access to advanced debugging trace and revert reason APIs
|
|
|
|
_definition: **Networks:**
|
|
``homestead``, ``goerli``, ``matic``. ``maticmum``, ``arbitrum``,
|
|
``arbitrum-goerli``, ``optimism`` and ``optimism-goerli``.
|
|
|
|
|
|
_subsection: Pocket Gateway @NOTE<(see the [[PocketProvider]])> @<api-keys--pocket-gateway>
|
|
|
|
They offer a standard JSON-RPC interface using either a load-balanced
|
|
network or non-load-balanced fleet.
|
|
|
|
[Sign up for a free API key on Pocket](link-pocket-signup)
|
|
|
|
**Benefits:**
|
|
|
|
- customer usage metrics
|
|
- decentralized Access to Blockchain Infrastructure
|
|
- Stake as opposed to paying a monthly fee
|
|
- Highly redundant global set of nodes incentivized by cryptoeconomic incentives
|
|
|
|
_definition: **Networks:**
|
|
``homestead``
|
|
|
|
|
|
_subsection: Ankr @NOTE<(see the [[AnkrProvider]])> @<api-keys--ankr>
|
|
|
|
They offer a standard JSON-RPC interface and have fairly high capacity without
|
|
the need for an API key early on in the development cycle.
|
|
|
|
[See their free tier features on Ankr](link-ankr-public)
|
|
|
|
**Benefits:**
|
|
|
|
- higher rate limit
|
|
- customer usage metrics
|
|
- access to archive data (requires paid upgrade)
|
|
|
|
_definition: **Networks:**
|
|
``homestead``, ``matic`` and ``arbitrum``
|
|
|
|
|
|
_subsection: Creating a Default Provider @<api-keys--getDefaultProvider>
|
|
|
|
The [default provider](providers-getDefaultProvider) connects to multiple
|
|
backends and verifies their results internally, making it simple to have
|
|
a high level of trust in third-party services.
|
|
|
|
A second optional parameter allows API keys to be specified to each
|
|
Provider created internally and any API key omitted will fallback onto
|
|
using the default API key for that service.
|
|
|
|
It is **highly recommended** that you provide an API for each service, to
|
|
maximize your applications performance.
|
|
|
|
If the API key ``"-"`` is used, the corresponding Provider will be omitted.
|
|
|
|
_code: Passing API Keys into getDefaultProvider @lang<script>
|
|
|
|
// Use the mainnet
|
|
const network = "homestead";
|
|
|
|
// Specify your own API keys
|
|
// Each is optional, and if you omit it the default
|
|
// API key for that service will be used.
|
|
const provider = ethers.getDefaultProvider(network, {
|
|
etherscan: YOUR_ETHERSCAN_API_KEY,
|
|
infura: YOUR_INFURA_PROJECT_ID,
|
|
// Or if using a project secret:
|
|
// infura: {
|
|
// projectId: YOUR_INFURA_PROJECT_ID,
|
|
// projectSecret: YOUR_INFURA_PROJECT_SECRET,
|
|
// },
|
|
alchemy: YOUR_ALCHEMY_API_KEY,
|
|
pocket: YOUR_POCKET_APPLICATION_KEY
|
|
// Or if using an application secret key:
|
|
// pocket: {
|
|
// applicationId: ,
|
|
// applicationSecretKey:
|
|
// },
|
|
ankr: YOUR_ANKR_API_KEY
|
|
});
|