Skip to content

Commit 31343e8

Browse files
committed
Merge branch '707-getblobs' of github.com:Consensys/doc.teku into 707-getblobs
align with main
2 parents 2726b31 + d2388a7 commit 31343e8

File tree

79 files changed

+13182
-798
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

79 files changed

+13182
-798
lines changed

.github/workflows/spelling.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,3 @@ jobs:
1717

1818
- name: Vale
1919
uses: Consensys/github-actions/docs-spelling-check@main
20-
with:
21-
FILEPATHS: "docs"

.linkspector.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ ignorePatterns:
1818
- pattern: '^http(s)?://.+.etherscan.io'
1919
- pattern: '^http(s)?://help.figma.com'
2020
- pattern: '^http(s)?://metamask.io'
21+
- pattern: '^http(s)?://(www\.)?freedesktop\.org'
2122
aliveStatusCodes:
2223
- 200
2324
- 206

docs/reference/cli/index.md

Lines changed: 87 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2085,7 +2085,7 @@ p2p-direct-peers: ["/ip4/151.150.191.80/tcp/9000/p2p/16Ui...aXRz",
20852085
</Tabs>
20862086

20872087
A comma-separated list of
2088-
[multiaddresses](https://docs.libp2p.io/concepts/appendix/glossary/#multiaddr) of direct peers with
2088+
[multiaddresses](https://libp2p.io/guides/addressing/) of direct peers with
20892089
which to establish and maintain connections.
20902090
Direct peers are static peers with which this node will always exchange full messages, regardless of
20912091
peer scoring mechanisms.
@@ -2597,7 +2597,7 @@ p2p-static-peers: ["/ip4/151.150.191.80/tcp/9000/p2p/16Ui...aXRz",
25972597
</Tabs>
25982598

25992599
A comma-separated list of
2600-
[multiaddresses](https://docs.libp2p.io/concepts/appendix/glossary/#multiaddr) of static peers with
2600+
[multiaddresses](https://libp2p.io/guides/addressing/) of static peers with
26012601
which to establish and maintain connections.
26022602

26032603
### `p2p-static-peers-url`
@@ -2634,7 +2634,7 @@ p2p-static-peers-url: "https://my-peers-url"
26342634
</Tabs>
26352635

26362636
A URL or file that contains a list of
2637-
[multiaddresses](https://docs.libp2p.io/concepts/appendix/glossary/#multiaddr) of static peers with
2637+
[multiaddresses](https://libp2p.io/guides/addressing/) of static peers with
26382638
which to establish and maintain connections. The file should have one peer per line.
26392639

26402640
:::note
@@ -2989,6 +2989,90 @@ The default is `false`.
29892989
If set to `true`, use [`--rest-api-host-allowlist`](#rest-api-host-allowlist) to limit access to
29902990
trusted parties.
29912991

2992+
### `rest-api-getblobs-sidecars-download-enabled`
2993+
2994+
<Tabs>
2995+
<TabItem value="Syntax" label="Syntax" default>
2996+
2997+
```bash
2998+
--rest-api-getblobs-sidecars-download-enabled[=<BOOLEAN>]
2999+
```
3000+
3001+
</TabItem>
3002+
<TabItem value="Example" label="Example" >
3003+
3004+
```bash
3005+
--rest-api-getblobs-sidecars-download-enabled=true
3006+
```
3007+
3008+
</TabItem>
3009+
<TabItem value="Environment variable" label="Environment variable" >
3010+
3011+
```bash
3012+
REST_API_GETBLOBS_SIDECARS_DOWNLOAD_ENABLED=true
3013+
```
3014+
3015+
</TabItem>
3016+
<TabItem value="Configuration file" label="Configuration file" >
3017+
3018+
```bash
3019+
rest-api-getblobs-sidecars-download-enabled: true
3020+
```
3021+
3022+
</TabItem>
3023+
</Tabs>
3024+
3025+
Enables the `getBlobs` REST API to retrieve missing blob sidecars from the P2P network via RPC.
3026+
3027+
When set to `true`, if required sidecars are not available locally, the node attempts to fetch them from peers.
3028+
Successfully retrieved sidecars are persisted to the local database to satisfy subsequent requests.
3029+
This allows nodes to serve blob data without being configured for full custody, while custody backfill is in progress,
3030+
or for requests outside the local retention period (if peers still hold the data).
3031+
3032+
:::note
3033+
3034+
Retrieved sidecars are treated as standard custody data and are subject to the network pruning [retention limits](https://github.com/ethereum/consensus-specs/blob/master/specs/fulu/validator.md#sidecar-retention).
3035+
3036+
:::
3037+
3038+
### `rest-api-getblobs-sidecars-download-timeout`
3039+
3040+
<Tabs>
3041+
<TabItem value="Syntax" label="Syntax" default>
3042+
3043+
```bash
3044+
--rest-api-getblobs-sidecars-download-timeout=<INTEGER>
3045+
```
3046+
3047+
</TabItem>
3048+
<TabItem value="Example" label="Example" >
3049+
3050+
```bash
3051+
--rest-api-getblobs-sidecars-download-timeout=10
3052+
```
3053+
3054+
</TabItem>
3055+
<TabItem value="Environment variable" label="Environment variable" >
3056+
3057+
```bash
3058+
REST_API_GETBLOBS_SIDECARS_DOWNLOAD_TIMEOUT=10
3059+
```
3060+
3061+
</TabItem>
3062+
<TabItem value="Configuration file" label="Configuration file" >
3063+
3064+
```bash
3065+
rest-api-getblobs-sidecars-download-timeout: 10
3066+
```
3067+
3068+
</TabItem>
3069+
</Tabs>
3070+
3071+
Specifies the maximum time in seconds to wait for blob sidecars to be retrieved from the P2P network when serving `getBlobs` requests.
3072+
3073+
If the timeout is reached before the required sidecars are retrieved, the reconstruction attempt is aborted.
3074+
This option is only effective when [`--rest-api-getblobs-sidecars-download-enabled`](#rest-api-getblobs-sidecars-download-enabled) is set to `true`. The default is `5`.
3075+
29923076
### `rest-api-host-allowlist`
29933077

29943078
<Tabs>

0 commit comments

Comments
 (0)