Skip to content

Commit 145c504

Browse files
committed
introduced next steps
1 parent 896671d commit 145c504

File tree

1 file changed

+35
-13
lines changed

1 file changed

+35
-13
lines changed

pages/stack/operators/features/proxyd.mdx

Lines changed: 35 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ lang: en-US
44
description: Learn about the proxyd service and how to configure it for use in the OP Stack.
55
---
66

7+
import { Steps } from 'nextra/components'
8+
79
# proxyd
810

911
`proxyd` is an important RPC request router and proxy used within the OP Stack infrastructure. It enables operators to efficiently route and manage RPC requests across multiple backend services, ensuring performance, fault tolerance, and security.
@@ -19,37 +21,57 @@ description: Learn about the proxyd service and how to configure it for use in t
1921
* Caching of immutable responses
2022
* Metrics for request latency, error rates, and backend health
2123

22-
23-
## Usage
24+
## How it works
2425

2526
To start using `proxyd`, follow these steps:
2627

27-
1. **Build the Binary**:
28-
```bash
29-
make proxyd
30-
```
28+
<Steps>
29+
### **Build the Binary**:
30+
31+
* Run the following command to build the `proxyd` binary:
32+
```bash
33+
make proxyd
34+
```
35+
* This will build the `proxyd` binary. No additional dependencies are required.
3136

32-
This will build the proxyd binary. No additional dependencies are required.
37+
### **Configure `proxyd`**:
3338

34-
2. Configure `proxyd`: Create a configuration file to define your proxy backends and routing rules. Refer to [example.config.toml](https://github.com/ethereum-optimism/infra/blob/main/proxyd/example.config.toml) for a full list of options with commentary.
39+
* Create a configuration file to define your proxy backends and routing rules.
40+
* Refer to [example.config.toml](https://github.com/ethereum-optimism/infra/blob/main/proxyd/example.config.toml) for a full list of options with commentary.
3541

36-
3. Start the Service: Once the configuration file is ready, start the proxyd service using:
42+
### **Start the Service**:
3743

38-
```
39-
proxyd <path-to-config>.toml
40-
```
44+
Once the configuration file is ready, start the `proxyd` service using the following command:
45+
46+
```bash
47+
proxyd <path-to-config.toml>
48+
```
49+
</Steps>
4150

4251
## Consensus Awareness
43-
Version 4.0.0 and later include consensus awareness to minimize chain reorganizations. Set `consensus_aware` to `true` in the configuration to enable:
52+
53+
Version 4.0.0 and later include consensus awareness to minimize chain reorganizations.
54+
55+
Set `consensus_aware` to `true` in the configuration to enable:
56+
4457
* Polling backends for consensus data (latest block, safe block, peer count, etc.).
4558
* Resolving consensus groups based on healthiest backends
4659
* Enforcing consensus state across client requests
4760

4861
## Caching and Metrics
4962

5063
### Cacheable Methods
64+
5165
Certain immutable methods, such as `eth_chainId` and `eth_getBlockByHash`, can be cached using Redis to optimize performance.
5266

5367
### Metrics
68+
5469
Extensive metrics are available to monitor request latency, error rates, backend health, and more. These can be configured via `metrics.port` and `metrics.host` in the configuration file.
5570

71+
## Next Steps
72+
73+
* Read about the [OP Stack chain architecture](/builders/chain-operators/architecture).
74+
* Find out how you can support [snap sync](/builders/chain-operators/management/snap-sync).
75+
on your chain.
76+
* Find out how you can utilize [blob space](/builders/chain-operators/management/blobs)
77+
to reduce the transaction fee cost on your chain.

0 commit comments

Comments
 (0)