Improve SlotColumn's code comment. (#28447)

Improve SlotColumn's code comment to include how
LedgerCleanupService manages the clean-up of a SlotColumn.
This commit is contained in:
Yueh-Hsuan Chiang 2022-10-18 23:50:22 -07:00 committed by GitHub
parent ca115594ff
commit 9be7ada68d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 0 deletions

View File

@ -627,6 +627,11 @@ pub trait ProtobufColumn: Column {
/// SlotColumn is a trait for slot-based column families. Its index is
/// essentially Slot (or more generally speaking, has a 1:1 mapping to Slot).
///
/// The clean-up of any LedgerColumn that implements SlotColumn is managed by
/// [`LedgerCleanupService`], which will periodically deprecate and purge
/// oldest entries that are older than the latest root in order to maintain the
/// configured --limit-ledger-size under the validator argument.
pub trait SlotColumn<Index = u64> {}
impl<T: SlotColumn> Column for T {