Skip to content

fix: inaccurate docs on perms config #42

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

Merged
merged 2 commits into from
Jun 27, 2025
Merged

fix: inaccurate docs on perms config #42

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9b6d0b6
fix: inaccurate docs on perms config
anna-carroll Jun 27, 2025
c72b6dd
update: slot duration
anna-carroll Jun 27, 2025
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
13 changes: 7 additions & 6 deletions src/perms/config.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,12 @@ pub struct SlotAuthzConfig {
/// number for a given timestamp.
calc: SlotCalculator,
/// The block query cutoff time in seconds. This is the slot second after
/// which requests will not be serviced. E.g. a value of 1 means that
/// requests will not be serviced for the last second of any given slot.
/// which requests will not be serviced. E.g. For a slot duration of 12,
/// a value of 10 means that requests will not be serviced for the last 2 seconds
/// of any given slot.
///
/// On loading from env, the number will be clamped between 0 and 11, as
/// the slot duration is 12 seconds.
/// On loading from env, the number will be clamped between 0 and slot_duration,
/// which is generally expected to be 12 seconds.
#[from_env(
var = "BLOCK_QUERY_CUTOFF",
desc = "The block query cutoff time in seconds."
Expand All @@ -24,8 +25,8 @@ pub struct SlotAuthzConfig {
/// which requests will not be serviced. E.g. a value of 1 means that
/// requests will not be serviced for the first second of any given slot.
///
/// On loading from env, the number will be clamped between 0 and 11, as
/// the slot duration is 12 seconds.
/// On loading from env, the number will be clamped between 0 and slot_duration, as
/// which is generally expected to be 12 seconds.
#[from_env(
var = "BLOCK_QUERY_START",
desc = "The block query start time in seconds."
Expand Down