From 39f26441c099ffefcc3144b5d35914506e127105 Mon Sep 17 00:00:00 2001 From: Rootul Patel Date: Tue, 26 Nov 2024 16:45:18 -0500 Subject: [PATCH] improve comments --- pkg/appconsts/v1/app_consts.go | 9 +++++---- pkg/appconsts/v2/app_consts.go | 9 +++++---- 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/pkg/appconsts/v1/app_consts.go b/pkg/appconsts/v1/app_consts.go index fee33747e3..1a3890bedc 100644 --- a/pkg/appconsts/v1/app_consts.go +++ b/pkg/appconsts/v1/app_consts.go @@ -6,11 +6,12 @@ const ( Version uint64 = 1 SquareSizeUpperBound int = 128 SubtreeRootThreshold int = 64 - // Note: TimeoutPropose and TimeoutCommit weren't actually constants in v1, - // they were defaults for user-configurable timeouts. TODO: consider - // removing them from this package. + // TimeoutPropose wasn't a constant in v1, it was the default for a + // user-configurable timeout. TimeoutPropose = time.Second * 10 - TimeoutCommit = time.Second * 11 + // TimeoutCommit wasn't a constant in v1, it was the default for a + // user-configurable timeout. + TimeoutCommit = time.Second * 11 // UpgradeHeightDelay is the number of blocks after a quorum has been // reached that the chain should upgrade to the new version. Assuming a // block interval of 12 seconds, this is 7 days. diff --git a/pkg/appconsts/v2/app_consts.go b/pkg/appconsts/v2/app_consts.go index 78d6603668..cd574af755 100644 --- a/pkg/appconsts/v2/app_consts.go +++ b/pkg/appconsts/v2/app_consts.go @@ -6,11 +6,12 @@ const ( Version uint64 = 2 SquareSizeUpperBound int = 128 SubtreeRootThreshold int = 64 - // Note: TimeoutPropose and TimeoutCommit weren't actually constants in v1, - // they were defaults for user-configurable timeouts. TODO: consider - // removing them from this package. + // TimeoutPropose wasn't a constant in v2, it was the default for a + // user-configurable timeout. TimeoutPropose = time.Second * 10 - TimeoutCommit = time.Second * 11 + // TimeoutCommit wasn't a constant in v2, it was the default for a + // user-configurable timeout. + TimeoutCommit = time.Second * 11 // UpgradeHeightDelay is the number of blocks after a quorum has been // reached that the chain should upgrade to the new version. Assuming a block // interval of 12 seconds, this is 7 days.