Skip to content

Commit

Permalink
docs(drand): document the meaning of "IsChained" (#11692)
Browse files Browse the repository at this point in the history
  • Loading branch information
rvagg committed Mar 7, 2024
1 parent 4a1a7bd commit b4e7374
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
3 changes: 3 additions & 0 deletions chain/beacon/drand/drand.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
Expand Down
2 changes: 1 addition & 1 deletion node/modules/dtypes/beacon.go
Original file line number Diff line number Diff line change
Expand Up @@ -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)
}

0 comments on commit b4e7374

Please sign in to comment.