added helper methods

Author: 0xmrree

configs/mainnet.yaml

@@ -180,8 +180,6 @@ SUBNETS_PER_NODE: 2
 ATTESTATION_SUBNET_COUNT: 64
 # 0 bits
 ATTESTATION_SUBNET_EXTRA_BITS: 0
-# ceillog2(ATTESTATION_SUBNET_COUNT) + ATTESTATION_SUBNET_EXTRA_BITS (= 6 + 0) bits
-ATTESTATION_SUBNET_PREFIX_BITS: 6
 
 # Deneb
 # 2**7 (= 128) blocks
@@ -192,24 +190,18 @@ MIN_EPOCHS_FOR_BLOB_SIDECARS_REQUESTS: 4096
 BLOB_SIDECAR_SUBNET_COUNT: 6
 # 6 blobs
 MAX_BLOBS_PER_BLOCK: 6
-# MAX_REQUEST_BLOCKS_DENEB * MAX_BLOBS_PER_BLOCK (= 128 * 6) sidecars
-MAX_REQUEST_BLOB_SIDECARS: 768
 
 # Electra
 # 9 subnets
 BLOB_SIDECAR_SUBNET_COUNT_ELECTRA: 9
 # 9 blobs
 MAX_BLOBS_PER_BLOCK_ELECTRA: 9
-# MAX_REQUEST_BLOCKS_DENEB * MAX_BLOBS_PER_BLOCK_ELECTRA (= 128 * 9) sidecars
-MAX_REQUEST_BLOB_SIDECARS_ELECTRA: 1152
 
 # Fulu
 # 2**7 (= 128) groups
 NUMBER_OF_CUSTODY_GROUPS: 128
 # 2**7 (= 128) subnets
 DATA_COLUMN_SIDECAR_SUBNET_COUNT: 128
-# MAX_REQUEST_BLOCKS_DENEB * NUMBER_OF_COLUMNS (= 128 * 128) sidecars
-MAX_REQUEST_DATA_COLUMN_SIDECARS: 16384
 # 2**3 (= 8) samples
 SAMPLES_PER_SLOT: 8
 # 2**2 (= 4) sidecars

configs/minimal.yaml

@@ -177,8 +177,6 @@ SUBNETS_PER_NODE: 2
 ATTESTATION_SUBNET_COUNT: 64
 # 0 bits
 ATTESTATION_SUBNET_EXTRA_BITS: 0
-# ceillog2(ATTESTATION_SUBNET_COUNT) + ATTESTATION_SUBNET_EXTRA_BITS (= 6 + 0) bits
-ATTESTATION_SUBNET_PREFIX_BITS: 6
 
 # Deneb
 # 2**7 (= 128) blocks
@@ -189,24 +187,18 @@ MIN_EPOCHS_FOR_BLOB_SIDECARS_REQUESTS: 4096
 BLOB_SIDECAR_SUBNET_COUNT: 6
 # 6 blobs
 MAX_BLOBS_PER_BLOCK: 6
-# MAX_REQUEST_BLOCKS_DENEB * MAX_BLOBS_PER_BLOCK (= 128 * 6) sidecars
-MAX_REQUEST_BLOB_SIDECARS: 768
 
 # Electra
 # 9 subnets
 BLOB_SIDECAR_SUBNET_COUNT_ELECTRA: 9
 # 9 blobs
 MAX_BLOBS_PER_BLOCK_ELECTRA: 9
-# MAX_REQUEST_BLOCKS_DENEB * MAX_BLOBS_PER_BLOCK_ELECTRA (= 128 * 9) sidecars
-MAX_REQUEST_BLOB_SIDECARS_ELECTRA: 1152
 
 # Fulu
 # 2**7 (= 128) groups
 NUMBER_OF_CUSTODY_GROUPS: 128
 # 2**7 (= 128) subnets
 DATA_COLUMN_SIDECAR_SUBNET_COUNT: 128
-# MAX_REQUEST_BLOCKS_DENEB * NUMBER_OF_COLUMNS (= 128 * 128) sidecars
-MAX_REQUEST_DATA_COLUMN_SIDECARS: 16384
 # 2**3 (= 8) samples
 SAMPLES_PER_SLOT: 8
 # 2**2 (= 4) sidecars

pysetup/helpers.py

@@ -395,7 +395,7 @@ def finalized_spec_object(spec_object: SpecObject) -> SpecObject:
     custom_types = {}
     ssz_objects = spec_object.ssz_objects
     for name, value in spec_object.custom_types.items():
-        if any(k in name for k in all_config_dependencies):
+        if any(name in k for k in all_config_dependencies):
             custom_types[name] = value
         else:
             ssz_objects[name] = gen_new_type_definition(name, value)

specs/deneb/p2p-interface.md

@@ -4,6 +4,9 @@
 
 - [Introduction](#introduction)
 - [Modifications in Deneb](#modifications-in-deneb)
+  - [Helper functions](#helper-functions)
+    - [Modified `compute_fork_version`](#modified-compute_fork_version)
+    - [New `compute_max_request_blob_sidecars`](#new-compute_max_request_blob_sidecars)
   - [Preset](#preset)
   - [Configuration](#configuration)
   - [Containers](#containers)
@@ -43,6 +46,36 @@ specifications of previous upgrades, and assumes them as pre-requisite.
 
 ## Modifications in Deneb
 
+### Helper functions
+
+#### Modified `compute_fork_version`
+
+```python
+def compute_fork_version(epoch: Epoch) -> Version:
+    """
+    Return the fork version at the given ``epoch``.
+    """
+    if epoch >= DENEB_FORK_EPOCH:
+        return DENEB_FORK_VERSION
+    if epoch >= CAPELLA_FORK_EPOCH:
+        return CAPELLA_FORK_VERSION
+    if epoch >= BELLATRIX_FORK_EPOCH:
+        return BELLATRIX_FORK_VERSION
+    if epoch >= ALTAIR_FORK_EPOCH:
+        return ALTAIR_FORK_VERSION
+    return GENESIS_FORK_VERSION
+```
+
+#### New `compute_max_request_blob_sidecars`
+
+```python
+def compute_max_request_blob_sidecars() -> uint64:
+    """
+    Return the maximum number of blob sidecars in a single request.
+    """
+    return uint64(MAX_REQUEST_BLOCKS_DENEB * MAX_BLOBS_PER_BLOCK)
+```
+
 ### Preset
 
 *[New in Deneb:EIP4844]*
@@ -55,12 +88,11 @@ specifications of previous upgrades, and assumes them as pre-requisite.
 
 *[New in Deneb:EIP4844]*
 
-| Name                                    | Value                                            | Description                                                        |
-| --------------------------------------- | ------------------------------------------------ | ------------------------------------------------------------------ |
-| `MAX_REQUEST_BLOCKS_DENEB`              | `2**7` (= 128)                                   | Maximum number of blocks in a single request                       |
-| `MAX_REQUEST_BLOB_SIDECARS`             | `MAX_REQUEST_BLOCKS_DENEB * MAX_BLOBS_PER_BLOCK` | Maximum number of blob sidecars in a single request                |
-| `MIN_EPOCHS_FOR_BLOB_SIDECARS_REQUESTS` | `2**12` (= 4096 epochs, ~18 days)                | The minimum epoch range over which a node must serve blob sidecars |
-| `BLOB_SIDECAR_SUBNET_COUNT`             | `6`                                              | The number of blob sidecar subnets used in the gossipsub protocol. |
+| Name                                    | Value                             | Description                                                        |
+| --------------------------------------- | --------------------------------- | ------------------------------------------------------------------ |
+| `MAX_REQUEST_BLOCKS_DENEB`              | `2**7` (= 128)                    | Maximum number of blocks in a single request                       |
+| `MIN_EPOCHS_FOR_BLOB_SIDECARS_REQUESTS` | `2**12` (= 4096 epochs, ~18 days) | The minimum epoch range over which a node must serve blob sidecars |
+| `BLOB_SIDECAR_SUBNET_COUNT`             | `6`                               | The number of blob sidecar subnets used in the gossipsub protocol. |
 
 ### Containers
 
@@ -365,7 +397,7 @@ Response Content:
 
 ```
 (
-  List[BlobSidecar, MAX_REQUEST_BLOB_SIDECARS]
+  List[BlobSidecar, compute_max_request_blob_sidecars()]
 )
 ```
 
@@ -406,7 +438,7 @@ and/or temporarily ban such an un-synced or semi-synced client.
 
 Clients MUST respond with at least the blob sidecars of the first blob-carrying
 block that exists in the range, if they have it, and no more than
-`MAX_REQUEST_BLOB_SIDECARS` sidecars.
+`compute_max_request_blob_sidecars()` sidecars.
 
 Clients MUST include all blob sidecars of each block from which they include
 blob sidecars.
@@ -456,15 +488,15 @@ Request Content:
 
 ```
 (
-  List[BlobIdentifier, MAX_REQUEST_BLOB_SIDECARS]
+  List[BlobIdentifier, compute_max_request_blob_sidecars()]
 )
 ```
 
 Response Content:
 
 ```
 (
-  List[BlobSidecar, MAX_REQUEST_BLOB_SIDECARS]
+  List[BlobSidecar, compute_max_request_blob_sidecars()]
 )
 ```
 
@@ -476,7 +508,7 @@ Before consuming the next response chunk, the response reader SHOULD verify the
 blob sidecar is well-formatted, has valid inclusion proof, and is correct w.r.t.
 the expected KZG commitments through `verify_blob_kzg_proof`.
 
-No more than `MAX_REQUEST_BLOB_SIDECARS` may be requested at a time.
+No more than `compute_max_request_blob_sidecars()` may be requested at a time.
 
 `BlobSidecarsByRoot` is primarily used to recover recent blobs (e.g. when
 receiving a block with a transaction whose corresponding blob is missing).

specs/electra/p2p-interface.md

@@ -7,6 +7,7 @@
   - [Configuration](#configuration)
   - [Helpers](#helpers)
     - [Modified `compute_fork_version`](#modified-compute_fork_version)
+    - [Modified `compute_max_request_blob_sidecars`](#modified-compute_max_request_blob_sidecars)
   - [The gossip domain: gossipsub](#the-gossip-domain-gossipsub)
     - [Topics and messages](#topics-and-messages)
       - [Global topics](#global-topics)
@@ -64,6 +65,17 @@ def compute_fork_version(epoch: Epoch) -> Version:
     return GENESIS_FORK_VERSION
 ```
 
+#### Modified `compute_max_request_blob_sidecars`
+
+```python
+def compute_max_request_blob_sidecars() -> uint64:
+    """
+    Return the maximum number of blob sidecars in a single request.
+    """
+    # [Modified in Electra:EIP7691]
+    return uint64(MAX_REQUEST_BLOCKS_DENEB * MAX_BLOBS_PER_BLOCK_ELECTRA)
+```
+
 ### The gossip domain: gossipsub
 
 Some gossip meshes are upgraded in the fork of Electra to support upgraded
@@ -187,51 +199,14 @@ beacon block type.
 
 *[Modified in Electra:EIP7691]*
 
-Request Content:
-
-```
-(
-  start_slot: Slot
-  count: uint64
-)
-```
-
-Response Content:
-
-```
-(
-  List[BlobSidecar, MAX_REQUEST_BLOB_SIDECARS_ELECTRA]
-)
-```
-
-*Updated validation*
-
-Clients MUST respond with at least the blob sidecars of the first blob-carrying
-block that exists in the range, if they have it, and no more than
-`MAX_REQUEST_BLOB_SIDECARS_ELECTRA` sidecars.
+*Note*: The `compute_max_request_blob_sidecars` function has been modified which
+affects the request, response, and validation logic.
 
 ##### BlobSidecarsByRoot v1
 
 **Protocol ID:** `/eth2/beacon_chain/req/blob_sidecars_by_root/1/`
 
 *[Modified in Electra:EIP7691]*
 
-Request Content:
-
-```
-(
-  List[BlobIdentifier, MAX_REQUEST_BLOB_SIDECARS_ELECTRA]
-)
-```
-
-Response Content:
-
-```
-(
-  List[BlobSidecar, MAX_REQUEST_BLOB_SIDECARS_ELECTRA]
-)
-```
-
-*Updated validation*
-
-No more than `MAX_REQUEST_BLOB_SIDECARS_ELECTRA` may be requested at a time.
+*Note*: The `compute_max_request_blob_sidecars` function has been modified which
+affects the request, response, and validation logic.

specs/fulu/p2p-interface.md

@@ -4,6 +4,9 @@
 
 - [Introduction](#introduction)
 - [Modifications in Fulu](#modifications-in-fulu)
+  - [Helper functions](#helper-functions)
+    - [Modified `compute_fork_version`](#modified-compute_fork_version)
+    - [New `compute_max_request_data_column_sidecars`](#new-compute_max_request_data_column_sidecars)
   - [Preset](#preset)
   - [Configuration](#configuration)
   - [Containers](#containers)
@@ -50,6 +53,40 @@ specifications of previous upgrades, and assumes them as pre-requisite.
 
 ## Modifications in Fulu
 
+### Helper functions
+
+#### Modified `compute_fork_version`
+
+```python
+def compute_fork_version(epoch: Epoch) -> Version:
+    """
+    Return the fork version at the given ``epoch``.
+    """
+    if epoch >= FULU_FORK_EPOCH:
+        return FULU_FORK_VERSION
+    if epoch >= ELECTRA_FORK_EPOCH:
+        return ELECTRA_FORK_VERSION
+    if epoch >= DENEB_FORK_EPOCH:
+        return DENEB_FORK_VERSION
+    if epoch >= CAPELLA_FORK_EPOCH:
+        return CAPELLA_FORK_VERSION
+    if epoch >= BELLATRIX_FORK_EPOCH:
+        return BELLATRIX_FORK_VERSION
+    if epoch >= ALTAIR_FORK_EPOCH:
+        return ALTAIR_FORK_VERSION
+    return GENESIS_FORK_VERSION
+```
+
+#### New `compute_max_request_data_column_sidecars`
+
+```python
+def compute_max_request_data_column_sidecars() -> uint64:
+    """
+    Return the maximum number of data column sidecars in a single request.
+    """
+    return uint64(MAX_REQUEST_BLOCKS_DENEB * NUMBER_OF_COLUMNS)
+```
+
 ### Preset
 
 | Name                                    | Value                                                                                     | Description                                                       |
@@ -60,11 +97,10 @@ specifications of previous upgrades, and assumes them as pre-requisite.
 
 *[New in Fulu:EIP7594]*
 
-| Name                                           | Value                                          | Description                                                               |
-| ---------------------------------------------- | ---------------------------------------------- | ------------------------------------------------------------------------- |
-| `DATA_COLUMN_SIDECAR_SUBNET_COUNT`             | `128`                                          | The number of data column sidecar subnets used in the gossipsub protocol  |
-| `MAX_REQUEST_DATA_COLUMN_SIDECARS`             | `MAX_REQUEST_BLOCKS_DENEB * NUMBER_OF_COLUMNS` | Maximum number of data column sidecars in a single request                |
-| `MIN_EPOCHS_FOR_DATA_COLUMN_SIDECARS_REQUESTS` | `2**12` (= 4096 epochs, ~18 days)              | The minimum epoch range over which a node must serve data column sidecars |
+| Name                                           | Value                             | Description                                                               |
+| ---------------------------------------------- | --------------------------------- | ------------------------------------------------------------------------- |
+| `DATA_COLUMN_SIDECAR_SUBNET_COUNT`             | `128`                             | The number of data column sidecar subnets used in the gossipsub protocol  |
+| `MIN_EPOCHS_FOR_DATA_COLUMN_SIDECARS_REQUESTS` | `2**12` (= 4096 epochs, ~18 days) | The minimum epoch range over which a node must serve data column sidecars |
 
 ### Containers
 
@@ -382,7 +418,7 @@ Response Content:
 
 ```
 (
-  List[DataColumnSidecar, MAX_REQUEST_DATA_COLUMN_SIDECARS]
+  List[DataColumnSidecar, compute_max_request_data_column_sidecars()]
 )
 ```
 
@@ -428,7 +464,7 @@ and/or temporarily ban such an un-synced or semi-synced client.
 
 Clients MUST respond with at least the data column sidecars of the first
 blob-carrying block that exists in the range, if they have it, and no more than
-`MAX_REQUEST_DATA_COLUMN_SIDECARS` sidecars.
+`compute_max_request_data_column_sidecars()` sidecars.
 
 Clients MUST include all data column sidecars of each block from which they
 include data column sidecars.
@@ -488,7 +524,7 @@ Response Content:
 
 ```
 (
-  List[DataColumnSidecar, MAX_REQUEST_DATA_COLUMN_SIDECARS]
+  List[DataColumnSidecar, compute_max_request_data_column_sidecars()]
 )
 ```
 
@@ -504,7 +540,8 @@ valid inclusion proof through `verify_data_column_sidecar_inclusion_proof`, and
 is correct w.r.t. the expected KZG commitments through
 `verify_data_column_sidecar_kzg_proofs`.
 
-No more than `MAX_REQUEST_DATA_COLUMN_SIDECARS` may be requested at a time.
+No more than `compute_max_request_data_column_sidecars()` may be requested at a
+time.
 
 The response MUST consist of zero or more `response_chunk`. Each _successful_
 `response_chunk` MUST contain a single `DataColumnSidecar` payload.