Skip to content
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

fix: improve light client testing coverage #1636

Merged
merged 1 commit into from
Jan 14, 2025
Merged

fix: improve light client testing coverage #1636

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
219 changes: 110 additions & 109 deletions crates/ethportal-api/src/types/content_value/beacon.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -548,140 +548,141 @@ impl ContentValue for BeaconContentValue {

#[cfg(test)]
mod test {
use std::fs;
use std::{fs, str::FromStr};

use alloy::primitives::Bytes;
use serde::Deserialize;
use serde_yaml::Value;

use super::*;

#[test]
fn light_client_bootstrap_encode_decode() {
let file = fs::read_to_string(
"../../test_assets/portalnet/content/beacon/light_client_bootstrap.json",
)
#[rstest::rstest]
#[case("capella", 6718368)]
#[case("deneb", 10248000)]
fn light_client_bootstrap_encode_decode(#[case] fork_name: &str, #[case] expected_slot: u64) {
let file = fs::read_to_string(format!(
"./../../portal-spec-tests/tests/mainnet/beacon_chain/light_client/{fork_name}/bootstrap.yaml",
))
.unwrap();
let json: serde_json::Value = serde_json::from_str(&file).unwrap();
let json = json.as_object().unwrap();
for (slot_num, obj) in json {
let slot_num: u64 = slot_num.parse().unwrap();
let content_key = BeaconContentKey::deserialize(&obj["content_key"]).unwrap();
let content_bytes = RawContentValue::deserialize(&obj["content_value"]).unwrap();
let beacon_content = BeaconContentValue::decode(&content_key, &content_bytes).unwrap();

match &beacon_content {
BeaconContentValue::LightClientBootstrap(value) => {
assert_eq!(
slot_num,
value.bootstrap.header_capella().unwrap().beacon.slot
);
}
_ => panic!("Invalid beacon content type!"),
}

assert_eq!(content_bytes, beacon_content.encode());
let value: Value = serde_yaml::from_str(&file).unwrap();
let content_key: BeaconContentKey =
serde_yaml::from_value(value["content_key"].clone()).unwrap();
let raw_content_value = Bytes::from_str(value["content_value"].as_str().unwrap()).unwrap();
let content_value = BeaconContentValue::decode(&content_key, raw_content_value.as_ref())
.expect("unable to decode content value");

assert_str_roundtrip(content_key, content_value.clone());

assert_str_roundtrip(content_key, beacon_content);
match content_value {
BeaconContentValue::LightClientBootstrap(value) => {
assert_eq!(expected_slot, value.get_slot());
}
_ => panic!("Invalid beacon content type!"),
}
}

#[test]
fn light_client_updates_by_range_encode_decode() {
let file = fs::read_to_string(
"../../test_assets/portalnet/content/beacon/light_client_updates_by_range.json",
)
#[rstest::rstest]
#[case("capella", 6684738)]
#[case("deneb", 10240088)]
fn light_client_updates_by_range_encode_decode(
#[case] fork_name: &str,
#[case] expected_slot: u64,
) {
let file = fs::read_to_string(format!(
"./../../portal-spec-tests/tests/mainnet/beacon_chain/light_client/{fork_name}/updates.yaml",
))
.unwrap();
let json: serde_json::Value = serde_json::from_str(&file).unwrap();
let json = json.as_object().unwrap();
for (slot_num, obj) in json {
let slot_num: u64 = slot_num.parse().unwrap();
let content_key = BeaconContentKey::deserialize(&obj["content_key"]).unwrap();
let content_bytes = RawContentValue::deserialize(&obj["content_value"]).unwrap();
let beacon_content = BeaconContentValue::decode(&content_key, &content_bytes).unwrap();

match &beacon_content {
BeaconContentValue::LightClientUpdatesByRange(updates) => {
assert_eq!(
slot_num,
updates[0]
.update
.attested_header_capella()
.unwrap()
.beacon
.slot
);
assert_eq!(updates.len(), 4)
}
_ => panic!("Invalid beacon content type!"),
}

assert_eq!(content_bytes, beacon_content.encode());
let value: Value = serde_yaml::from_str(&file).unwrap();
let content_key: BeaconContentKey =
serde_yaml::from_value(value["content_key"].clone()).unwrap();
let raw_content_value = Bytes::from_str(value["content_value"].as_str().unwrap()).unwrap();
let content_value = BeaconContentValue::decode(&content_key, raw_content_value.as_ref())
.expect("unable to decode content value");

assert_str_roundtrip(content_key, beacon_content);
}
}
assert_str_roundtrip(content_key, content_value.clone());

#[test]
fn light_client_optimistic_update_encode_decode() {
let file = fs::read_to_string(
"../../test_assets/portalnet/content/beacon/light_client_optimistic_update.json",
)
let update = match content_value {
BeaconContentValue::LightClientUpdatesByRange(value) => value[0].update.clone(),
_ => panic!("Invalid beacon content type!"),
};
let actual_slot = match fork_name {
"capella" => update.attested_header_capella().unwrap().beacon.slot,
"deneb" => update.attested_header_deneb().unwrap().beacon.slot,
_ => panic!("Invalid fork name!"),
};
assert_eq!(actual_slot, expected_slot);
}

#[rstest::rstest]
#[case("capella", 6718463)]
#[case("deneb", 10248457)]
fn light_client_optimistic_update_encode_decode(
#[case] fork_name: &str,
#[case] expected_slot: u64,
) {
let file = fs::read_to_string(format!(
"./../../portal-spec-tests/tests/mainnet/beacon_chain/light_client/{fork_name}/optimistic_update.yaml",
))
.unwrap();
let json: serde_json::Value = serde_json::from_str(&file).unwrap();
let json = json.as_object().unwrap();
for (slot_num, obj) in json {
let slot_num: u64 = slot_num.parse().unwrap();
let content_key = BeaconContentKey::deserialize(&obj["content_key"]).unwrap();
let content_bytes = RawContentValue::deserialize(&obj["content_value"]).unwrap();
let beacon_content = BeaconContentValue::decode(&content_key, &content_bytes).unwrap();

match &beacon_content {
BeaconContentValue::LightClientOptimisticUpdate(value) => {
assert_eq!(
slot_num,
value.update.attested_header_capella().unwrap().beacon.slot
);
}
_ => panic!("Invalid beacon content type!"),
}

assert_eq!(content_bytes, beacon_content.encode());
let value: Value = serde_yaml::from_str(&file).unwrap();
let content_key: BeaconContentKey =
serde_yaml::from_value(value["content_key"].clone()).unwrap();
let raw_content_value = Bytes::from_str(value["content_value"].as_str().unwrap()).unwrap();
let content_value = BeaconContentValue::decode(&content_key, raw_content_value.as_ref())
.expect("unable to decode content value");

assert_str_roundtrip(content_key, beacon_content);
}
}
assert_str_roundtrip(content_key, content_value.clone());

#[test]
fn light_client_finality_update_encode_decode() {
let file = fs::read_to_string(
"../../test_assets/portalnet/content/beacon/light_client_finality_update.json",
)
let update = match content_value {
BeaconContentValue::LightClientOptimisticUpdate(value) => value.update,
_ => panic!("Invalid beacon content type!"),
};
let actual_slot = match fork_name {
"capella" => update.attested_header_capella().unwrap().beacon.slot,
"deneb" => update.attested_header_deneb().unwrap().beacon.slot,
_ => panic!("Invalid fork name!"),
};
assert_eq!(actual_slot, expected_slot);
}

#[rstest::rstest]
#[case("capella", 6718463)]
#[case("deneb", 10248453)]
fn light_client_finality_update_encode_decode(
#[case] fork_name: &str,
#[case] expected_slot: u64,
) {
let file = fs::read_to_string(format!(
"./../../portal-spec-tests/tests/mainnet/beacon_chain/light_client/{fork_name}/finality_update.yaml"
))
.unwrap();
let json: serde_json::Value = serde_json::from_str(&file).unwrap();
let json = json.as_object().unwrap();
for (slot_num, obj) in json {
let slot_num: u64 = slot_num.parse().unwrap();
let content_key = BeaconContentKey::deserialize(&obj["content_key"]).unwrap();
let content_bytes = RawContentValue::deserialize(&obj["content_value"]).unwrap();
let beacon_content = BeaconContentValue::decode(&content_key, &content_bytes).unwrap();

match &beacon_content {
BeaconContentValue::LightClientFinalityUpdate(value) => {
assert_eq!(
slot_num,
value.update.attested_header_capella().unwrap().beacon.slot
);
}
_ => panic!("Invalid beacon content type!"),
}

assert_eq!(content_bytes, beacon_content.encode());
let value: Value = serde_yaml::from_str(&file).unwrap();
let content_key: BeaconContentKey =
serde_yaml::from_value(value["content_key"].clone()).unwrap();
let raw_content_value = Bytes::from_str(value["content_value"].as_str().unwrap()).unwrap();
let content_value = BeaconContentValue::decode(&content_key, raw_content_value.as_ref())
.expect("unable to decode content value");

assert_str_roundtrip(content_key, beacon_content);
}
assert_str_roundtrip(content_key, content_value.clone());

let update = match content_value {
BeaconContentValue::LightClientFinalityUpdate(value) => value.update,
_ => panic!("Invalid beacon content type!"),
};
let actual_slot = match fork_name {
"capella" => update.attested_header_capella().unwrap().beacon.slot,
"deneb" => update.attested_header_deneb().unwrap().beacon.slot,
_ => panic!("Invalid fork name!"),
};
assert_eq!(actual_slot, expected_slot);
}

#[test]
fn historical_summaries_with_proof_encode_decode() {
fn deneb_historical_summaries_with_proof_encode_decode() {
let file = fs::read_to_string("./../../portal-spec-tests/tests/mainnet/beacon_chain/historical_summaries_with_proof/deneb/historical_summaries_with_proof.yaml").unwrap();
let value: serde_yaml::Value = serde_yaml::from_str(&file).unwrap();
let content_key = BeaconContentKey::deserialize(&value["content_key"]).unwrap();
Expand Down
2 changes: 1 addition & 1 deletion portal-spec-tests
Open in desktop
Submodule portal-spec-tests updated 4 files
+18 −19 tests/mainnet/beacon_chain/hive/test_data.yaml
+1 −1 tests/mainnet/beacon_chain/light_client/deneb/finality_update.yaml
+1 −1 tests/mainnet/beacon_chain/light_client/deneb/optimistic_update.yaml
+1 −1 tests/mainnet/beacon_chain/light_client/deneb/updates.yaml
6 changes: 0 additions & 6 deletions test_assets/portalnet/content/beacon/light_client_bootstrap.json
View file
Open in desktop

This file was deleted.

6 changes: 0 additions & 6 deletions test_assets/portalnet/content/beacon/light_client_finality_update.json
View file
Open in desktop

This file was deleted.

6 changes: 0 additions & 6 deletions test_assets/portalnet/content/beacon/light_client_optimistic_update.json
View file
Open in desktop

This file was deleted.

6 changes: 0 additions & 6 deletions test_assets/portalnet/content/beacon/light_client_updates_by_range.json
View file
Open in desktop

This file was deleted.