Skip to content

Commit 49df66e

Browse files
committed
Update docs
- Make them closer to the original implementation
1 parent 6945e50 commit 49df66e

1 file changed

Lines changed: 7 additions & 8 deletions

File tree

crates/charon/src/eth2wrap/valcache.rs

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -114,9 +114,8 @@ impl ValidatorCache {
114114
Ok(())
115115
}
116116

117-
/// Returns the cached active and complete validators, or fetches them
118-
/// from the beacon node using the head state and populates the cache if
119-
/// not already cached.
117+
/// Returns the cached active validators and complete validators response,
118+
/// or fetches them if not available populating the cache.
120119
pub async fn get_by_head(&self) -> Result<(ActiveValidators, CompleteValidators)> {
121120
{
122121
// Limit the scope of the lock
@@ -166,12 +165,12 @@ impl ValidatorCache {
166165
Ok((active_validators, complete_validators))
167166
}
168167

169-
/// Fetches active and complete validators by slot and populates the
170-
/// cache. If it fails to fetch by slot, it falls back to the head state.
168+
/// Fetches active and complete validators response by slot populating the
169+
/// cache. If it fails to fetch by slot, it falls back to head state.
171170
///
172-
/// Returns a tuple containing the active validators, complete validators,
173-
/// and a boolean indicating whether the data was fetched by slot (`true`)
174-
/// or fell back to head (`false`).
171+
/// Returns a tuple containing the active validators, complete validators
172+
/// response, and a boolean indicating whether the data was fetched by
173+
/// slot (`true`) or fell back to head (`false`).
175174
pub async fn get_by_slot(
176175
&self,
177176
slot: u64,

0 commit comments

Comments
 (0)