Skip to content

Commit

Permalink
update for failover protection
Browse files Browse the repository at this point in the history
  • Loading branch information
joaniefromtheblock committed Jun 27, 2024
1 parent 2162dca commit b76a655
Show file tree
Hide file tree
Showing 12 changed files with 118 additions and 84 deletions.
2 changes: 1 addition & 1 deletion services-sidebar.js
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ const sidebar = {
type: "category",
label: "Reference",
link: { type: "generated-index", slug: "/reference" },
collapsed: true,
collapsed: false,
items: [{ type: "autogenerated", dirName: "reference" }],
},
],
Expand Down
37 changes: 7 additions & 30 deletions services/concepts/failover-protection.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,39 +5,16 @@ sidebar_position: 1

# Failover protection

:::info
Failover protection is available on the following networks for customers on the Growth or Custom plans:

Failover support is available on Mainnet only.
- [Arbitrum](../reference/arbitrum/index.md)
- [Avalanche (C-Chain)](../reference/avalanche-c-chain/index.md)
- [Optimism](../reference/optimism/index.md)
- [Polygon](../reference/polygon-pos/index.md)

:::

Failover protection is available on the Mainnet network for customers on the Growth or Custom plans.
This feature ensures API requests are fulfilled even if Infura experiences a service issue or
The failover protection feature ensures API requests are fulfilled even if Infura experiences a service issue or
outage. This is achieved by routing requests to a select partner.

Failover protection is enabled on a per-request basis by adding the failover header to your API
request (see [Enable API request forwarding](../how-to/enable-api-forwarding.md)). This gives
you control over which requests you'd like fulfilled by Infura's partner if failover protection should be needed.

## Partners and privacy policies

No personal information is sent as part of partner requests, only information necessary to fulfill
your API request. This means that Infura's partner service provider can service your request, but not
store the content of your request.

For any parameters required in an RPC request, these could be the type that describe the method,
addresses, gas, and session.

Bware Labs ([Terms of Service](https://bwarelabs.com/terms), [Privacy Policy](https://bwarelabs.com/privacy)) is
Infura's failover-protection partner. While Bware Labs supports most Infura methods, it does not yet support
the following methods:

- `eth_accounts`
- `eth_coinbase`
- `eth_protocolVersion`
- `eth_feeHistory`
- `eth_maxPriorityFeePerGas`
- `eth_sendTransaction`
- `eth_sign`
- `eth_syncing`
- `eth_submitWork`
you control over which requests you'd like fulfilled by Infura's partner if failover protection should be needed.
3 changes: 1 addition & 2 deletions services/concepts/gas.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,7 @@ The Ethereum London hard fork update changed the blockchain’s transaction fee
[EIP-1559](https://eips.ethereum.org/EIPS/eip-1559). This update changed the way users pay gas fees on the Ethereum
network and other EVM chains.

Before EIP-1559, users specified a gas price, which was the amount they were willing to pay for a transaction to be mined. The
auction-style system meant gas prices often fluctuated wildly. After EIP-1559, this has been replaced by two new values:
Before EIP-1559, users specified a gas price, which was the amount they were willing to pay for a transaction to be mined. The auction-style system meant gas prices often fluctuated wildly. After EIP-1559, this has been replaced by two new values:

- Base fee: The minimum transaction fee for every transaction to be included in a block. This is calculated by the network
and is affected by the number of transactions included in the previous block. The base fee gets burned, meaning
Expand Down
2 changes: 1 addition & 1 deletion services/how-to/enable-api-forwarding.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ For JSON-RPC methods, you can request failover protection by adding the failover
your API request using `cURL`, `Web3.js`, `Ethers.js`, or any other language of your choice.

For more information about this feature, including our partner and their privacy information,
see [Failover protection](../../../concepts/failover-protection.md).
see [Failover protection](../concepts/failover-protection.md).

:::info

Expand Down
2 changes: 1 addition & 1 deletion services/how-to/use-ipfs/_category_.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@
"link": {
"type": "generated-index",
"slug": "services/how-to/",
"description": "This section has information on using IPFS."
"description": "This section has information on using the Interplanetary File System (IPFS)."
}
}
44 changes: 0 additions & 44 deletions services/how-to/use-ipfs/index.md

This file was deleted.

17 changes: 16 additions & 1 deletion services/reference/arbitrum/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,13 @@ import CardList from '@site/src/components/CardList'

# Arbitrum

:::note Failover protection

Arbitrum [failover support](../../concepts/failover-protection.md) is available on Mainnet only.
Calls to the network are routed to [partner infrastructure providers](#partners-and-privacy-policies).

:::

Arbitrum is an Ethereum scaling solution that provides high throughput and low-cost smart contract execution. Arbitrum's design
allows it to be fully compatible with Ethereum. Developers will find that building with Arbitrum is nearly identical to
building on Ethereum.
Expand Down Expand Up @@ -40,4 +47,12 @@ Select one of the following options to get started with the Arbitrum network:
description: "Learn how to create an API key and secure and share it with your team."
}
]}
/>
/>

## Partners and privacy policies

No personal information is sent as part of partner requests, only information necessary to fulfill your API request. This means that Infura's partner service provider can service your request, but not store the content of your request.

For any parameters required in an RPC request, these could be the type that describe the method, addresses, gas, and session.

Liquify (Privacy Policy) is Infura's failover-protection partner and currently offer failover support for all Infura's Arbitrum methods.
17 changes: 16 additions & 1 deletion services/reference/avalanche-c-chain/index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,16 @@
---
description: Avalanche C-Chain
---
import CardList from '@site/src/components/CardList'

# Avalanche (C-Chain)

import CardList from '@site/src/components/CardList'
:::note Failover protection

Avalanche (C-Chain) [failover support](../../concepts/failover-protection.md) is available on Mainnet only.
Calls to the network are routed to [partner infrastructure providers](#partners-and-privacy-policies).

:::

Avalanche is a Proof of Stake (PoS), layer 1 platform that features 3 built-in blockchains: [Exchange Chain (X-Chain)](https://docs.avax.network/overview/getting-started/avalanche-platform-overview#exchange-chain-x-chain), [Platform Chain (P-Chain)](https://docs.avax.network/overview/getting-started/avalanche-platform-overview#platform-chain-p-chain), and [Contract Chain (C-Chain)](https://docs.avax.network/overview/getting-started/avalanche-platform-overview#contract-chain-c-chain). Infura provides access to the C-Chain only.

Expand Down Expand Up @@ -40,3 +47,11 @@ Select one of the following options to get started with the Avalanche C-Chain ne
}
]}
/>

## Partners and privacy policies

No personal information is sent as part of partner requests, only information necessary to fulfill your API request. This means that Infura's partner service provider can service your request, but not store the content of your request.

For any parameters required in an RPC request, these could be the type that describe the method, addresses, gas, and session.

Liquify (Privacy Policy) is Infura's failover-protection partner and currently offer failover support for all Infura's Avalanche (C-Chain) methods.
3 changes: 3 additions & 0 deletions services/reference/gas-api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ description: Gas API documentation
import CardList from '@site/src/components/CardList'

# Gas API

The Gas API is a tool that delivers real-time [gas prices](../../concepts/gas.md) for supported networks, enabling users to identify the best times to execute transactions based on current rates and intricacies introduced by [EIP-1559](https://eips.ethereum.org/EIPS/eip-1559).

<CardList
items={[
{
Expand Down
21 changes: 20 additions & 1 deletion services/reference/ipfs/index.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,30 @@
---
description: Gas network documentation
description: IPFS documentation
---

import CardList from '@site/src/components/CardList'

# IPFS

The [Interplanetary File System (IPFS)](../../how-to/use-ipfs/migrate-to-infuras-ipfs-service.md) is a distributed, [peer-to-peer (p2p)](https://en.wikipedia.org/wiki/Peer-to-peer) storage network used for storing and accessing files, websites, applications, and data.

:::caution Limited access

Infura is currently limiting IPFS services to customers that already have an active IPFS key.
New IPFS key creation is disabled for new and existing customers.

:::

Content is accessible from peer nodes located anywhere in the world. These nodes relay information, store it, or both.

To integrate your IPFS project with Infura, create an [Infura API key](../../get-started/infura.md#2-create-an-api-key).

:::info See also

See the [official IPFS documentation](https://docs.ipfs.io) for more information. Check out the [IPFS Quick Start docs](https://docs.ipfs.io/how-to/command-line-quick-start/#prerequisites) to get up and running with IPFS.

:::

<CardList
items={[
{
Expand Down
27 changes: 26 additions & 1 deletion services/reference/optimism/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,13 @@ import CardList from '@site/src/components/CardList'

# Optimism

:::note Failover protection

Optimism [failover support](../../concepts/failover-protection.md) is available on Mainnet only.
Calls to the network are routed to [partner infrastructure providers](#partners-and-privacy-policies).

:::

Optimism is an EVM-compatible, layer 2, rollup scaling solution that operates on top of Ethereum. All transactions that
occur on Optimism are posted and validated on Ethereum mainnet using Optimistic Rollups.

Expand Down Expand Up @@ -36,4 +43,22 @@ occur on Optimism are posted and validated on Ethereum mainnet using Optimistic
description: "Learn how to create an API key and secure and share it with your team."
}
]}
/>
/>

## Partners and privacy policies

No personal information is sent as part of partner requests, only information necessary to fulfill your API request. This means that Infura's partner service provider can service your request, but not store the content of your request.

For any parameters required in an RPC request, these could be the type that describe the method, addresses, gas, and session.

Bware Labs (Terms of Service, Privacy Policy) is Infura's failover-protection partner. While Bware Labs supports most Infura methods, it does not yet support the following methods:

- `eth_accounts`
- `eth_coinbase`
- `eth_protocolVersion`
- `eth_feeHistory`
- `eth_maxPriorityFeePerGas`
- `eth_sendTransaction`
- `eth_sign`
- `eth_syncing`
- `eth_submitWork`
27 changes: 26 additions & 1 deletion services/reference/polygon-pos/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,13 @@ import CardList from '@site/src/components/CardList'

# Polygon PoS

:::note Failover protection

[Failover protection](../../concepts/failover-protection.md) is available on the Polygon network for customers on the Growth or Custom plans.
Calls to the network are routed to [partner infrastructure providers](#partners-and-privacy-policies).

:::

The Polygon PoS network is a hybrid Plasma Proof of Stake side-chain to Ethereum. It's fully compatible with the Ethereum
virtual machine (EVM) which allows developers to leverage Infura, MetaMask, and other tools they use for Ethereum when
developing and deploying smart contracts to the Polygon network.
Expand Down Expand Up @@ -37,4 +44,22 @@ The [official Polygon documentation](https://docs.polygon.technology) for more i
description: "Learn how to create an API key and secure and share it with your team."
}
]}
/>
/>

## Partners and privacy policies

No personal information is sent as part of partner requests, only information necessary to fulfill your API request. This means that Infura's partner service provider can service your request, but not store the content of your request.

For any parameters required in an RPC request, these could be the type that describe the method, addresses, gas, and session.

Rivet.Cloud (Terms of Service, Privacy Policy) is Infura's failover-protection partner. While Rivet.Cloud supports most Infura methods, it does not yet support the following methods:

- `eth_accounts`
- `eth_coinbase`
- `eth_getRootHash`
- `eth_getUncleByBlockNumberAndIndex`
- `eth_getWork`
- `eth_hashrate`
- `eth_mining`
- `eth_sendTransaction`
- `eth_sign`

0 comments on commit b76a655

Please sign in to comment.