From 904ba75472d1d30af12de1c36ff5738ed6ca6d2f Mon Sep 17 00:00:00 2001 From: Rootul P Date: Wed, 4 Dec 2024 13:51:07 -0500 Subject: [PATCH] docs(specs): add missing versioned consts (#4054) Closes https://github.com/celestiaorg/celestia-app/issues/4010 --------- Co-authored-by: CHAMI Rachid --- pkg/appconsts/v1/app_consts.go | 13 ++++++++----- pkg/appconsts/v2/app_consts.go | 8 ++++++-- pkg/appconsts/v3/app_consts.go | 2 +- specs/src/parameters_v1.md | 9 +++++---- specs/src/parameters_v2.md | 11 ++++++----- specs/src/parameters_v3.md | 18 +++++++++++------- 6 files changed, 37 insertions(+), 24 deletions(-) diff --git a/pkg/appconsts/v1/app_consts.go b/pkg/appconsts/v1/app_consts.go index 873d3ec18a..478ce6ac3e 100644 --- a/pkg/appconsts/v1/app_consts.go +++ b/pkg/appconsts/v1/app_consts.go @@ -6,10 +6,13 @@ const ( Version uint64 = 1 SquareSizeUpperBound int = 128 SubtreeRootThreshold int = 64 - TimeoutPropose = time.Second * 10 - 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. + // TimeoutPropose is deprecated because it was not a constant + // in v1, it was the default for a user-configurable timeout. + TimeoutPropose = time.Second * 10 + // TimeoutCommit is deprecated because it was not a constant + // in v1, it was the default for a user-configurable timeout. + TimeoutCommit = time.Second * 11 + // UpgradeHeightDelay is deprecated because v1 does not contain the signal + // module so this constant should not be used. UpgradeHeightDelay = int64(7 * 24 * 60 * 60 / 12) // 7 days * 24 hours * 60 minutes * 60 seconds / 12 seconds per block = 50,400 blocks. ) diff --git a/pkg/appconsts/v2/app_consts.go b/pkg/appconsts/v2/app_consts.go index d02a97079b..b2e187eaf0 100644 --- a/pkg/appconsts/v2/app_consts.go +++ b/pkg/appconsts/v2/app_consts.go @@ -6,8 +6,12 @@ const ( Version uint64 = 2 SquareSizeUpperBound int = 128 SubtreeRootThreshold int = 64 - TimeoutPropose = time.Second * 10 - TimeoutCommit = time.Second * 11 + // TimeoutPropose is deprecated because it was not a constant + // in v2, it was the default for a user-configurable timeout. + TimeoutPropose = time.Second * 10 + // TimeoutCommit is deprecated because it was not 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. diff --git a/pkg/appconsts/v3/app_consts.go b/pkg/appconsts/v3/app_consts.go index 3f9279518d..e5b660bf2e 100644 --- a/pkg/appconsts/v3/app_consts.go +++ b/pkg/appconsts/v3/app_consts.go @@ -13,6 +13,6 @@ const ( TimeoutCommit = time.Millisecond * 4200 // 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. + // interval of 6 seconds, this is 7 days. UpgradeHeightDelay = int64(7 * 24 * 60 * 60 / 6) // 7 days * 24 hours * 60 minutes * 60 seconds / 6 seconds per block = 100,800 blocks. ) diff --git a/specs/src/parameters_v1.md b/specs/src/parameters_v1.md index 436b8cb471..5bfdd1eee1 100644 --- a/specs/src/parameters_v1.md +++ b/specs/src/parameters_v1.md @@ -8,10 +8,11 @@ hardcoded in the application or they are blocked by the `x/paramfilter` module. ## Global parameters -| Parameter | Default | Summary | Changeable via Governance | -|-------------------|---------|------------------------------------------------------------------------------------------------------------------------|---------------------------| -| MaxBlockSizeBytes | 100MiB | Hardcoded value in CometBFT for the protobuf encoded block. | False | -| MaxSquareSize | 128 | Hardcoded maximum square size determined per shares per row or column for the original data square (not yet extended). | False | +| Parameter | Value | Summary | Changeable via Governance | +|----------------------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| SquareSizeUpperBound | 128 | Hardcoded maximum square size which limits the number of shares per row or column for the original data square (not yet extended). | False | +| SubtreeRootThreshold | 64 | See [ADR-013](https://github.com/celestiaorg/celestia-app/blob/main/docs/architecture/adr-013-non-interactive-default-rules-for-zero-padding.md) for more details. | False | +| MaxBlockSizeBytes | 100 MiB | Hardcoded value in CometBFT for the protobuf encoded block. | False | ## Module parameters diff --git a/specs/src/parameters_v2.md b/specs/src/parameters_v2.md index ec93c9acda..411e4c0778 100644 --- a/specs/src/parameters_v2.md +++ b/specs/src/parameters_v2.md @@ -8,11 +8,12 @@ hardcoded in the application or they are blocked by the `x/paramfilter` module. ## Global parameters -| Parameter | Default | Summary | Changeable via Governance | -|--------------------|---------|------------------------------------------------------------------------------------------------------------------------|---------------------------| -| MaxBlockSizeBytes | 100MiB | Hardcoded value in CometBFT for the protobuf encoded block. | False | -| MaxSquareSize | 128 | Hardcoded maximum square size determined per shares per row or column for the original data square (not yet extended). | False | -| UpgradeHeightDelay | 50400 | Height based delay after a successful `MsgTryUpgrade` has been submitted. | False | +| Parameter | Value | Summary | Changeable via Governance | +|----------------------|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| SquareSizeUpperBound | 128 | Hardcoded maximum square size which limits the number of shares per row or column for the original data square (not yet extended). | False | +| SubtreeRootThreshold | 64 | See [ADR-013](https://github.com/celestiaorg/celestia-app/blob/main/docs/architecture/adr-013-non-interactive-default-rules-for-zero-padding.md) for more details. | False | +| UpgradeHeightDelay | 50400 blocks | Height based delay after a successful `MsgTryUpgrade` has been submitted. | False | +| MaxBlockSizeBytes | 100 MiB | Hardcoded value in CometBFT for the protobuf encoded block. | False | ## Module parameters diff --git a/specs/src/parameters_v3.md b/specs/src/parameters_v3.md index 6f8d84fccb..40c043c576 100644 --- a/specs/src/parameters_v3.md +++ b/specs/src/parameters_v3.md @@ -8,11 +8,15 @@ hardcoded in the application or they are blocked by the `x/paramfilter` module. ## Global parameters -| Parameter | Default | Summary | Changeable via Governance | -|--------------------|---------|------------------------------------------------------------------------------------------------------------------------|---------------------------| -| MaxBlockSizeBytes | 100MiB | Hardcoded value in CometBFT for the protobuf encoded block. | False | -| MaxSquareSize | 128 | Hardcoded maximum square size determined per shares per row or column for the original data square (not yet extended). | False | -| UpgradeHeightDelay | 100800 | Height based delay after a successful `MsgTryUpgrade` has been submitted. | False | +| Parameter | Value | Summary | Changeable via Governance | +|----------------------|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| SquareSizeUpperBound | 128 | Hardcoded maximum square size which limits the number of shares per row or column for the original data square (not yet extended). | False | +| SubtreeRootThreshold | 64 | See [ADR-013](https://github.com/celestiaorg/celestia-app/blob/main/docs/architecture/adr-013-non-interactive-default-rules-for-zero-padding.md) for more details. | False | +| MaxTxSize | 2 MiB | Maximum size of a transaction in bytes. | False | +| TimeoutPropose | 3500 ms | Specifies the time that validators wait during the proposal phase of the consensus process. See CometBFT [specs](https://github.com/celestiaorg/celestia-core/blob/v0.34.x-celestia/spec/consensus/consensus.md#propose-step-heighthroundr) for more details. | False | +| TimeoutCommit | 4200 ms | Specifies the duration that validators wait during the Commit phase of the consensus process. See CometBFT [specs](https://github.com/celestiaorg/celestia-core/blob/v0.34.x-celestia/spec/consensus/consensus.md#precommit-step-heighthroundr) for more details. | False | +| UpgradeHeightDelay | 100800 blocks | Height based delay after a successful `MsgTryUpgrade` has been submitted. | False | +| MaxBlockSizeBytes | 100 MiB | Hardcoded value in CometBFT for the protobuf encoded block. | False | ## Module parameters @@ -22,9 +26,9 @@ hardcoded in the application or they are blocked by the `x/paramfilter` module. | auth.SigVerifyCostED25519 | 590 | Gas used to verify Ed25519 signature. | True | | auth.SigVerifyCostSecp256k1 | 1000 | Gas used to verify secp256k1 signature. | True | | auth.TxSigLimit | 7 | Max number of signatures allowed in a multisig transaction. | True | -| auth.TxSizeCostPerByte | 10 | Gas used per transaction byte. | False | +| auth.TxSizeCostPerByte | 10 | Gas used per transaction byte. | False | | bank.SendEnabled | true | Allow transfers. | False | -| blob.GasPerBlobByte | 8 | Gas used per blob byte. | False | +| blob.GasPerBlobByte | 8 | Gas used per blob byte. | False | | blob.GovMaxSquareSize | 64 | Governance parameter for the maximum square size of the original data square. | True | | consensus.block.MaxBytes | 1974272 bytes (~1.88 MiB) | Governance parameter for the maximum size of the protobuf encoded block. | True | | consensus.block.MaxGas | -1 | Maximum gas allowed per block (-1 is infinite). | True |