Skip to content

Commit a2e21e5

Browse files
committed
fix layout, readability
1 parent 4681c05 commit a2e21e5

3 files changed

Lines changed: 35 additions & 21 deletions

File tree

docs/base-chain/api-reference/flashblocks-api/flashblocks-api-overview.mdx

Lines changed: 30 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,38 @@
11
---
2-
title: 'Flashblocks API Overview'
3-
sidebarTitle: 'Flashblocks API Overview'
4-
description: 'Reference for Flashblocks-specific RPC methods, WebSocket subscriptions, and the infrastructure stream schema.'
2+
title: 'Overview'
3+
sidebarTitle: 'Overview'
4+
description: 'Flashblocks-specific RPC methods, WebSocket subscriptions, and the infrastructure stream schema for Base pre-confirmations.'
55
---
66

7-
This page covers what is unique to Flashblocks: Flashblocks-only RPC methods, real-time WebSocket subscriptions, and the raw infrastructure stream schema.
7+
Flashblocks endpoints expose all standard Ethereum JSON-RPC methods plus a set of pre-confirmation-specific additions. These let you read state, simulate transactions, and stream events against sequencer-ordered data up to ~1.8 seconds before a block seals.
8+
9+
<Info>
10+
All [standard Ethereum JSON-RPC methods](/base-chain/api-reference/rpc-overview) work identically on Flashblocks endpoints. Use the `"pending"` block tag to resolve against pre-confirmed state instead of the transaction pool. See the [Overview](/base-chain/api-reference/rpc-overview#what-is-the-flashblocks-tier) for endpoint URLs and a full explanation of the two tiers.
11+
</Info>
12+
13+
## HTTP Methods
14+
15+
| Method | Description |
16+
| :--- | :--- |
17+
| [eth_simulateV1](/base-chain/api-reference/flashblocks-api/eth_simulateV1) | Simulate transaction bundles against pre-confirmed state |
18+
| [base_transactionStatus](/base-chain/api-reference/flashblocks-api/base_transactionStatus) | Check if a transaction has been received by the node mempool |
19+
20+
## WebSocket Subscriptions
21+
22+
On a Flashblocks WSS endpoint, `eth_subscribe` with `newHeads` emits a new event approximately every 200ms per Flashblock instead of every 2 seconds. Three additional subscription types are also available that are exclusive to Flashblocks endpoints:
23+
24+
| Subscription | Description |
25+
| :--- | :--- |
26+
| [newFlashblockTransactions](/base-chain/api-reference/flashblocks-api/newFlashblockTransactions) | Stream individual transactions as they are pre-confirmed (~200ms each) |
27+
| [pendingLogs](/base-chain/api-reference/flashblocks-api/pendingLogs) | Stream filtered event logs from pre-confirmed transactions |
28+
| [newFlashblocks](/base-chain/api-reference/flashblocks-api/newFlashblocks) | Stream full Flashblock payload objects from the sequencer |
29+
30+
## Infrastructure Stream
31+
32+
The raw Flashblocks infrastructure stream is the upstream WebSocket feed consumed by Flashblocks-aware RPC nodes. It emits a new message approximately every 200ms as the sequencer pre-confirms transactions.
833

934
<Warning>
10-
**Applications should not connect directly to the infrastructure stream.** These endpoints are for node infrastructure only. App developers should use the [WebSocket subscription methods](/base-chain/api-reference/flashblocks-api/newFlashblocks) via a Flashblocks-aware RPC provider instead.
35+
**Applications should not connect directly to the infrastructure stream.** These endpoints are for node operators only. App developers should use the [WebSocket subscription methods](#websocket-subscriptions) above via a Flashblocks-aware RPC provider.
1136
</Warning>
1237

1338
| Network | Raw stream URL |

docs/base-chain/api-reference/rpc-overview.mdx

Lines changed: 4 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ Base exposes a single, fully EVM-compatible JSON-RPC API across two performance
1717

1818
| | Mainnet | Sepolia |
1919
| :--- | :--- | :--- |
20-
| **Standard HTTP** | `https://mainnet.base.org` | `https://sepolia.base.org` |
21-
| **Standard WSS** | `wss://mainnet.base.org` | `wss://sepolia.base.org` |
20+
| **HTTP** | `https://mainnet.base.org` | `https://sepolia.base.org` |
21+
| **WSS** | `wss://mainnet.base.org` | `wss://sepolia.base.org` |
2222
| **Flashblocks HTTP** | `https://mainnet-preconf.base.org` | `https://sepolia-preconf.base.org` |
2323
| **Flashblocks WSS** | `wss://mainnet-preconf.base.org` | `wss://sepolia-preconf.base.org` |
2424

@@ -35,29 +35,18 @@ Flashblocks endpoints are fully EVM-equivalent; every standard `eth_` method wor
3535

3636
Calls like `eth_getBalance`, `eth_getStorageAt`, and `eth_call` run against real sequencer state up to 1.8 seconds before the block seals, with sub-second latency.
3737

38-
## Real-Time Event Streams (WebSocket)
39-
40-
On a **Flashblocks WSS** endpoint, `eth_subscribe` with `newHeads` emits a new event approximately every 200ms as each Flashblock is appended, rather than every 2 seconds.
41-
42-
Flashblocks endpoints also expose three additional subscription types not present on Standard endpoints:
43-
44-
| Subscription | Description |
45-
| --- | --- |
46-
| [`newFlashblockTransactions`](/base-chain/api-reference/flashblocks-api/newFlashblockTransactions) | Stream of individual transactions as they are pre-confirmed |
47-
| [`pendingLogs`](/base-chain/api-reference/flashblocks-api/pendingLogs) | Filtered logs from pre-confirmed transactions |
48-
| [`newFlashblocks`](/base-chain/api-reference/flashblocks-api/newFlashblocks) | Full Flashblock payload stream (block state objects) |
49-
5038
## API Reference
5139

5240
### Ethereum JSON-RPC API
5341

54-
Core Ethereum protocol methods for account queries, block and transaction data, gas estimation, and log filtering. All methods work on both Standard and Flashblocks endpoints.
42+
Core Ethereum protocol methods for account queries, block and transaction data, gas estimation, and log filtering. All methods work on both Standard and Flashblocks endpoints.
5543

5644
<Info>
5745
Methods marked ✓ support the `"pending"` block tag on Flashblocks endpoints.
5846
</Info>
5947

6048
| Method | Flashblocks `pending` |
49+
| :--- | :--- |
6150
| [eth_blockNumber](/base-chain/api-reference/ethereum-json-rpc-api/eth_blockNumber) ||
6251
| [eth_getBalance](/base-chain/api-reference/ethereum-json-rpc-api/eth_getBalance) ||
6352
| [eth_getTransactionCount](/base-chain/api-reference/ethereum-json-rpc-api/eth_getTransactionCount) ||

docs/docs.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@
158158
]
159159
},
160160
{
161-
"group": "Reference",
161+
"group": "API Reference",
162162
"pages": [
163163
"base-chain/api-reference/rpc-overview",
164164
{

0 commit comments

Comments
 (0)