docs(drand): document the meaning of "IsChained" (#11692)

This commit is contained in:
Rod Vagg 2024-03-08 02:26:23 +11:00 committed by GitHub
parent 4a1a7bd29e
commit b4e7374cd5
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 4 additions and 1 deletions

View File

@ -53,6 +53,9 @@ type DrandBeacon struct {
localCache *lru.Cache[uint64, *types.BeaconEntry]
}
// IsChained tells us whether this particular beacon operates in "chained mode". Prior to Drand
// quicknet, beacons form a chain. After the introduction of quicknet, they do not, so we need to
// change how we interact with beacon entries. (See FIP-0063)
func (db *DrandBeacon) IsChained() bool {
return db.isChained
}

View File

@ -13,5 +13,5 @@ type DrandConfig struct {
Servers []string
Relays []string
ChainInfoJSON string
IsChained bool
IsChained bool // Prior to Drand quicknet, beacons form a chain, post quicknet they do not (FIP-0063)
}