Skip to content

Returning custody_group_count on node/identity Beacon API #9381

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lucassaldanha merged 5 commits into from
May 5, 2025
Merged

Returning custody_group_count on node/identity Beacon API #9381

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4ab8dfe
Returning custody_group_count on node/identity Beacon API
lucassaldanha Apr 29, 2025
5b6fb4f
Fix MetaData.json
lucassaldanha Apr 29, 2025
4087388
Fix schema registry usage
lucassaldanha Apr 30, 2025
e22f2e2
removed unused variable
lucassaldanha May 4, 2025
5643134
Merge branch 'master' into custody_group_count
lucassaldanha May 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions ...gration-test/java/tech/pegasys/teku/beaconrestapi/v1/node/GetIdentityIntegrationTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,25 @@ public void shouldReturnNetworkIdentityAltair() throws Exception {
"{\"seq_number\":\"4666673844721362956\",\"attnets\":\"0x0288000000000000\",\"syncnets\":\"0x0f\"}");
}

@Test
public void shouldReturnNetworkIdentityFulu() throws Exception {
startRestAPIAtGenesis(SpecMilestone.FULU);

final MetadataMessage metadataMessage =
spec.getGenesisSchemaDefinitions()
.getMetadataMessageSchema()
.create(seqnr, List.of(1, 11, 15), List.of(0, 1, 2, 3), Optional.of(UInt64.valueOf(4)));

when(eth2P2PNetwork.getMetadata()).thenReturn(metadataMessage);

final Response response = getResponse(GetIdentity.ROUTE);
assertThat(response.code()).isEqualTo(SC_OK);
checkResponseData(
response,
"{\"seq_number\":\"4666673844721362956\",\"attnets\":\"0x0288000000000000\",\"syncnets\":\"0x0f\","
+ "\"custody_group_count\":\"4\"}");
}

private void checkResponseData(final Response response, final String metadata)
throws IOException {
final JsonNode data = getResponseData(response);
Expand Down
6 changes: 6 additions & 0 deletions ...rc/integration-test/resources/tech/pegasys/teku/beaconrestapi/beacon/schema/MetaData.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,12 @@
"pattern" : "^0x[a-fA-F0-9]{2,}$",
"description" : "Bitvector representing the node's persistent sync committee subnet subscriptions.",
"format" : "bytes"
},
"custody_group_count" : {
"type" : "string",
"description" : "Uint64 representing the node's custody group count. The metadata is present from the Fulu fork.",
"example" : "1",
"format" : "uint64"
}
}
}
5 changes: 5 additions & 0 deletions ...onrestapi/src/main/java/tech/pegasys/teku/beaconrestapi/handlers/v1/node/GetIdentity.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,11 @@ private static SerializableTypeDefinition<MetadataMessage> createMetadataType(
.withDescription(
"Bitvector representing the node's persistent sync committee subnet subscriptions."),
MetadataMessage::getOptionalSyncnets)
.withOptionalField(
"custody_group_count",
UINT64_TYPE.withDescription(
"Uint64 representing the node's custody group count. The metadata is present from the Fulu fork."),
MetadataMessage::getOptionalCustodyGroupCount)
.build();
}

Expand Down
9 changes: 5 additions & 4 deletions ethereum/spec/src/main/java/tech/pegasys/teku/spec/schemas/SchemaDefinitionsAltair.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
import static tech.pegasys.teku.spec.schemas.registry.SchemaTypes.BEACON_BLOCK_BODY_SCHEMA;
import static tech.pegasys.teku.spec.schemas.registry.SchemaTypes.BEACON_BLOCK_SCHEMA;
import static tech.pegasys.teku.spec.schemas.registry.SchemaTypes.BEACON_STATE_SCHEMA;
import static tech.pegasys.teku.spec.schemas.registry.SchemaTypes.METADATA_MESSAGE_SCHEMA;
import static tech.pegasys.teku.spec.schemas.registry.SchemaTypes.SIGNED_AGGREGATE_AND_PROOF_SCHEMA;
import static tech.pegasys.teku.spec.schemas.registry.SchemaTypes.SIGNED_BEACON_BLOCK_SCHEMA;

Expand All @@ -37,7 +38,7 @@
import tech.pegasys.teku.spec.datastructures.lightclient.LightClientHeaderSchema;
import tech.pegasys.teku.spec.datastructures.lightclient.LightClientUpdateResponseSchema;
import tech.pegasys.teku.spec.datastructures.lightclient.LightClientUpdateSchema;
import tech.pegasys.teku.spec.datastructures.networking.libp2p.rpc.metadata.versions.altair.MetadataMessageSchemaAltair;
import tech.pegasys.teku.spec.datastructures.networking.libp2p.rpc.metadata.MetadataMessageSchema;
import tech.pegasys.teku.spec.datastructures.operations.AggregateAndProof.AggregateAndProofSchema;
import tech.pegasys.teku.spec.datastructures.operations.Attestation;
import tech.pegasys.teku.spec.datastructures.operations.AttestationSchema;
Expand Down Expand Up @@ -69,7 +70,7 @@ public class SchemaDefinitionsAltair extends AbstractSchemaDefinitions {
private final SyncCommitteeContributionSchema syncCommitteeContributionSchema;
private final ContributionAndProofSchema contributionAndProofSchema;
private final SignedContributionAndProofSchema signedContributionAndProofSchema;
private final MetadataMessageSchemaAltair metadataMessageSchema;
private final MetadataMessageSchema<?> metadataMessageSchema;
private final LightClientHeaderSchema lightClientHeaderSchema;
private final LightClientBootstrapSchema lightClientBootstrapSchema;
private final LightClientUpdateSchema lightClientUpdateSchema;
Expand All @@ -92,7 +93,7 @@ public SchemaDefinitionsAltair(final SchemaRegistry schemaRegistry) {
ContributionAndProofSchema.create(syncCommitteeContributionSchema);
this.signedContributionAndProofSchema =
SignedContributionAndProofSchema.create(contributionAndProofSchema);
this.metadataMessageSchema = new MetadataMessageSchemaAltair(specConfig.getNetworkingConfig());
this.metadataMessageSchema = schemaRegistry.get(METADATA_MESSAGE_SCHEMA);
this.lightClientHeaderSchema = new LightClientHeaderSchema();
this.lightClientBootstrapSchema = new LightClientBootstrapSchema(specConfig);
this.lightClientUpdateSchema = new LightClientUpdateSchema(specConfig);
Expand Down Expand Up @@ -195,7 +196,7 @@ public BeaconBlockBodyBuilder createBeaconBlockBodyBuilder() {
}

@Override
public MetadataMessageSchemaAltair getMetadataMessageSchema() {
public MetadataMessageSchema<?> getMetadataMessageSchema() {
return metadataMessageSchema;
}

Expand Down
10 changes: 5 additions & 5 deletions ethereum/spec/src/main/java/tech/pegasys/teku/spec/schemas/SchemaDefinitionsPhase0.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
import static tech.pegasys.teku.spec.schemas.registry.SchemaTypes.BEACON_BLOCK_BODY_SCHEMA;
import static tech.pegasys.teku.spec.schemas.registry.SchemaTypes.BEACON_BLOCK_SCHEMA;
import static tech.pegasys.teku.spec.schemas.registry.SchemaTypes.BEACON_STATE_SCHEMA;
import static tech.pegasys.teku.spec.schemas.registry.SchemaTypes.METADATA_MESSAGE_SCHEMA;
import static tech.pegasys.teku.spec.schemas.registry.SchemaTypes.SIGNED_AGGREGATE_AND_PROOF_SCHEMA;
import static tech.pegasys.teku.spec.schemas.registry.SchemaTypes.SIGNED_BEACON_BLOCK_SCHEMA;

Expand All @@ -31,7 +32,7 @@
import tech.pegasys.teku.spec.datastructures.blocks.blockbody.BeaconBlockBodyBuilder;
import tech.pegasys.teku.spec.datastructures.blocks.blockbody.BeaconBlockBodySchema;
import tech.pegasys.teku.spec.datastructures.blocks.blockbody.versions.phase0.BeaconBlockBodyBuilderPhase0;
import tech.pegasys.teku.spec.datastructures.networking.libp2p.rpc.metadata.versions.phase0.MetadataMessageSchemaPhase0;
import tech.pegasys.teku.spec.datastructures.networking.libp2p.rpc.metadata.MetadataMessageSchema;
import tech.pegasys.teku.spec.datastructures.operations.AggregateAndProof.AggregateAndProofSchema;
import tech.pegasys.teku.spec.datastructures.operations.Attestation;
import tech.pegasys.teku.spec.datastructures.operations.AttestationSchema;
Expand All @@ -53,13 +54,12 @@ public class SchemaDefinitionsPhase0 extends AbstractSchemaDefinitions {
private final BeaconStateSchema<? extends BeaconState, ? extends MutableBeaconState>
beaconStateSchema;
private final BeaconBlockBodySchema<?> beaconBlockBodySchema;
private final MetadataMessageSchemaPhase0 metadataMessageSchema;
private final MetadataMessageSchema<?> metadataMessageSchema;
private final BeaconBlockSchema beaconBlockSchema;
private final SignedBeaconBlockSchema signedBeaconBlockSchema;

public SchemaDefinitionsPhase0(final SchemaRegistry schemaRegistry) {
super(schemaRegistry);
final SpecConfig specConfig = schemaRegistry.getSpecConfig();
this.indexedAttestationSchema = schemaRegistry.get(SchemaTypes.INDEXED_ATTESTATION_SCHEMA);
this.attesterSlashingSchema = schemaRegistry.get(SchemaTypes.ATTESTER_SLASHING_SCHEMA);

Expand All @@ -68,7 +68,7 @@ public SchemaDefinitionsPhase0(final SchemaRegistry schemaRegistry) {
this.signedAggregateAndProofSchema = schemaRegistry.get(SIGNED_AGGREGATE_AND_PROOF_SCHEMA);
this.beaconStateSchema = schemaRegistry.get(BEACON_STATE_SCHEMA);
this.beaconBlockBodySchema = schemaRegistry.get(BEACON_BLOCK_BODY_SCHEMA);
this.metadataMessageSchema = new MetadataMessageSchemaPhase0(specConfig.getNetworkingConfig());
this.metadataMessageSchema = schemaRegistry.get(METADATA_MESSAGE_SCHEMA);
this.beaconBlockSchema = schemaRegistry.get(BEACON_BLOCK_SCHEMA);
this.signedBeaconBlockSchema = schemaRegistry.get(SIGNED_BEACON_BLOCK_SCHEMA);
}
Expand Down Expand Up @@ -164,7 +164,7 @@ public BeaconBlockBodyBuilder createBeaconBlockBodyBuilder() {
}

@Override
public MetadataMessageSchemaPhase0 getMetadataMessageSchema() {
public MetadataMessageSchema<?> getMetadataMessageSchema() {
return metadataMessageSchema;
}

Expand Down