Skip to content

Commit

Permalink
Rename validateable to validatable (#8784)
Browse files Browse the repository at this point in the history 
Co-authored-by: Enrico Del Fante <enrico.delfante@consensys.net>
  • Loading branch information
@jtraglia @tbenr
jtraglia and tbenr authored Oct 25, 2024
1 parent d1573c3 commit 110ce91
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 33 deletions.
2 changes: 1 addition & 1 deletion ...c/main/java/tech/pegasys/teku/spec/datastructures/attestation/ValidatableAttestation.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ public Attestation getAttestation() {

public SignedAggregateAndProof getSignedAggregateAndProof() {
return maybeAggregate.orElseThrow(
() -> new UnsupportedOperationException("ValidateableAttestation is not an aggregate."));
() -> new UnsupportedOperationException("ValidatableAttestation is not an aggregate."));
}

public AttestationData getData() {
Expand Down
2 changes: 1 addition & 1 deletion ...tatetransition/src/main/java/tech/pegasys/teku/statetransition/forkchoice/ForkChoice.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -893,7 +893,7 @@ private IndexedAttestation getIndexedAttestation(final ValidatableAttestation at
.orElseThrow(
() ->
new UnsupportedOperationException(
"ValidateableAttestation does not have an IndexedAttestation."));
"ValidatableAttestation does not have an IndexedAttestation."));
}

private SafeFuture<Void> onForkChoiceThread(final ExceptionThrowingRunnable task) {
Expand Down
18 changes: 9 additions & 9 deletions ...n/java/tech/pegasys/teku/statetransition/synccommittee/SyncCommitteeMessageValidator.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,9 @@ public SyncCommitteeMessageValidator(
}

public SafeFuture<InternalValidationResult> validate(
final ValidatableSyncCommitteeMessage validateableMessage) {
final ValidatableSyncCommitteeMessage validatableMessage) {

final SyncCommitteeMessage message = validateableMessage.getMessage();
final SyncCommitteeMessage message = validatableMessage.getMessage();

final Optional<SyncCommitteeUtil> maybeSyncCommitteeUtil =
spec.getSyncCommitteeUtil(message.getSlot());
Expand Down Expand Up @@ -104,11 +104,11 @@ public SafeFuture<InternalValidationResult> validate(
// Note this validation is _per topic_ so that for a given `slot`, multiple messages could be
// forwarded with the same `validator_index` as long as the `subnet_id`s are distinct.
final Optional<UniquenessKey> uniquenessKey;
if (validateableMessage.getReceivedSubnetId().isPresent()) {
if (validatableMessage.getReceivedSubnetId().isPresent()) {
final UniquenessKey key =
getUniquenessKey(
message,
validateableMessage.getReceivedSubnetId().getAsInt(),
validatableMessage.getReceivedSubnetId().getAsInt(),
message.getBeaconBlockRoot());
final Optional<Bytes32> maybeBestBlockRoot = recentChainData.getBestBlockRoot();

Expand Down Expand Up @@ -149,12 +149,12 @@ public SafeFuture<InternalValidationResult> validate(
}
final BeaconStateAltair state = maybeState.get();
return validateWithState(
validateableMessage, message, syncCommitteeUtil, state, uniquenessKey);
validatableMessage, message, syncCommitteeUtil, state, uniquenessKey);
});
}

private SafeFuture<InternalValidationResult> validateWithState(
final ValidatableSyncCommitteeMessage validateableMessage,
final ValidatableSyncCommitteeMessage validatableMessage,
final SyncCommitteeMessage message,
final SyncCommitteeUtil syncCommitteeUtil,
final BeaconStateAltair state,
Expand All @@ -164,7 +164,7 @@ private SafeFuture<InternalValidationResult> validateWithState(
// Always calculate the applicable subcommittees to ensure they are cached and can be used to
// send the gossip.
final SyncSubcommitteeAssignments assignedSubcommittees =
validateableMessage.calculateAssignments(spec, state);
validatableMessage.calculateAssignments(spec, state);

// [REJECT] The validator producing this sync_committee_message is in the current sync
// committee, i.e. state.validators[sync_committee_message.validator_index].pubkey in
Expand Down Expand Up @@ -198,10 +198,10 @@ private SafeFuture<InternalValidationResult> validateWithState(

// [REJECT] The subnet_id is correct, i.e. subnet_id in
// compute_subnets_for_sync_committee(state, sync_committee_message.validator_index).
if (validateableMessage.getReceivedSubnetId().isPresent()
if (validatableMessage.getReceivedSubnetId().isPresent()
&& !assignedSubcommittees
.getAssignedSubcommittees()
.contains(validateableMessage.getReceivedSubnetId().getAsInt())) {
.contains(validatableMessage.getReceivedSubnetId().getAsInt())) {
return completedFuture(
reject("Rejecting sync committee message because subnet id is incorrect"));
}
Expand Down
43 changes: 21 additions & 22 deletions ...va/tech/pegasys/teku/statetransition/synccommittee/SyncCommitteeMessageValidatorTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,12 +93,12 @@ void shouldAcceptWhenValid() {
chainBuilder.getLatestEpoch(),
message.getValidatorIndex());
final int validSubnetId = assignments.getAssignedSubcommittees().iterator().nextInt();
final ValidatableSyncCommitteeMessage validateableMessage =
final ValidatableSyncCommitteeMessage validatableMessage =
ValidatableSyncCommitteeMessage.fromNetwork(message, validSubnetId);

assertThat(validator.validate(validateableMessage)).isCompletedWithValue(ACCEPT);
assertThat(validator.validate(validatableMessage)).isCompletedWithValue(ACCEPT);
// Should store the computed subcommittee assignments for the validator.
assertThat(validateableMessage.getSubcommitteeAssignments()).contains(assignments);
assertThat(validatableMessage.getSubcommitteeAssignments()).contains(assignments);
}

@Test
Expand Down Expand Up @@ -128,16 +128,16 @@ void shouldAcceptWhenValidInSlotLastSlotOfSyncCommitteePeriod() {
syncCommitteeUtil.getEpochForDutiesAtSlot(lastSlotOfPeriod),
message.getValidatorIndex());
final int validSubnetId = assignments.getAssignedSubcommittees().iterator().nextInt();
final ValidatableSyncCommitteeMessage validateableMessage =
final ValidatableSyncCommitteeMessage validatableMessage =
ValidatableSyncCommitteeMessage.fromNetwork(message, validSubnetId);
timeProvider.advanceTimeByMillis(
spec.getSlotStartTime(lastSlotOfPeriod, recentChainData.getGenesisTime())
.times(1000)
.longValue());

assertThat(validator.validate(validateableMessage)).isCompletedWithValue(ACCEPT);
assertThat(validator.validate(validatableMessage)).isCompletedWithValue(ACCEPT);
// Should store the computed subcommittee assignments for the validator.
assertThat(validateableMessage.getSubcommitteeAssignments()).contains(assignments);
assertThat(validatableMessage.getSubcommitteeAssignments()).contains(assignments);
}

@Test
Expand Down Expand Up @@ -354,9 +354,9 @@ void shouldUseCorrectForkForSignatureVerificationWhenHeadStateIsBeforeNewMilesto
chainBuilder.getLatestEpoch(),
message.getValidatorIndex());
final int validSubnetId = assignments.getAssignedSubcommittees().iterator().nextInt();
final ValidatableSyncCommitteeMessage validateableMessage =
final ValidatableSyncCommitteeMessage validatableMessage =
ValidatableSyncCommitteeMessage.fromNetwork(message, validSubnetId);
assertThat(validator.validate(validateableMessage)).isCompletedWithValue(ACCEPT);
assertThat(validator.validate(validatableMessage)).isCompletedWithValue(ACCEPT);
}

@Test
Expand All @@ -380,42 +380,41 @@ void shouldUseCorrectForkForSignatureVerificationWhenSlotIsJustBeforeNewMileston
chainBuilder.getLatestEpoch(),
message.getValidatorIndex());
final int validSubnetId = assignments.getAssignedSubcommittees().iterator().nextInt();
final ValidatableSyncCommitteeMessage validateableMessage =
final ValidatableSyncCommitteeMessage validatableMessage =
ValidatableSyncCommitteeMessage.fromNetwork(message, validSubnetId);
assertThat(validator.validate(validateableMessage)).isCompletedWithValue(ACCEPT);
assertThat(validator.validate(validatableMessage)).isCompletedWithValue(ACCEPT);
}

private ValidatableSyncCommitteeMessage fromValidatorSpy(
final SyncCommitteeMessage message, final IntSet subcommitteeIds) {
final ValidatableSyncCommitteeMessage validateableMessage =
final ValidatableSyncCommitteeMessage validatableMessage =
ValidatableSyncCommitteeMessage.fromValidator(message);
return createSpy(validateableMessage, subcommitteeIds);
return createSpy(validatableMessage, subcommitteeIds);
}

private ValidatableSyncCommitteeMessage fromNetworkSpy(
final SyncCommitteeMessage message,
final int receivedSubnetId,
final IntSet subcommitteeIds) {
final ValidatableSyncCommitteeMessage validateableMessage =
final ValidatableSyncCommitteeMessage validatableMessage =
ValidatableSyncCommitteeMessage.fromNetwork(message, receivedSubnetId);
return createSpy(validateableMessage, subcommitteeIds);
return createSpy(validatableMessage, subcommitteeIds);
}

private ValidatableSyncCommitteeMessage createSpy(
final ValidatableSyncCommitteeMessage validateableMessage, final IntSet subcommitteeIds) {
final ValidatableSyncCommitteeMessage validatableMessage, final IntSet subcommitteeIds) {
// Create spies
final ValidatableSyncCommitteeMessage validateableMessageSpy = spy(validateableMessage);
validateableMessage.calculateAssignments(
spec, chainBuilder.getLatestBlockAndState().getState());
final ValidatableSyncCommitteeMessage validatableMessageSpy = spy(validatableMessage);
validatableMessage.calculateAssignments(spec, chainBuilder.getLatestBlockAndState().getState());
SyncSubcommitteeAssignments assignments =
validateableMessage.getSubcommitteeAssignments().orElseThrow();
validatableMessage.getSubcommitteeAssignments().orElseThrow();
SyncSubcommitteeAssignments assignmentsSpy = spy(assignments);

// Overwrite some functionality
doReturn(assignmentsSpy).when(validateableMessageSpy).calculateAssignments(any(), any());
doReturn(Optional.of(assignmentsSpy)).when(validateableMessageSpy).getSubcommitteeAssignments();
doReturn(assignmentsSpy).when(validatableMessageSpy).calculateAssignments(any(), any());
doReturn(Optional.of(assignmentsSpy)).when(validatableMessageSpy).getSubcommitteeAssignments();
doReturn(subcommitteeIds).when(assignmentsSpy).getAssignedSubcommittees();

return validateableMessageSpy;
return validatableMessageSpy;
}
}

0 comments on commit 110ce91

Please sign in to comment.