Skip to content

Commit

Permalink
docs(specs): add missing versioned consts
Browse files Browse the repository at this point in the history
  • Loading branch information
@rootulp
rootulp committed Nov 25, 2024
1 parent 0bfd074 commit 4f26e6a
Show file tree
Hide file tree
Showing 6 changed files with 38 additions and 23 deletions.
14 changes: 10 additions & 4 deletions pkg/appconsts/v1/app_consts.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,16 @@ const (
Version uint64 = 1
SquareSizeUpperBound int = 128
SubtreeRootThreshold int = 64
TimeoutPropose = time.Second * 10
TimeoutCommit = time.Second * 11
// 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 = 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.
// reached that the chain should upgrade to the new version. Assuming a
// block interval of 12 seconds, this is 7 days.
//
// TODO: why does this constant exist in v1? v1 does not contain the signal
// module.
UpgradeHeightDelay = int64(7 * 24 * 60 * 60 / 12) // 7 days * 24 hours * 60 minutes * 60 seconds / 12 seconds per block = 50,400 blocks.
)
7 changes: 5 additions & 2 deletions pkg/appconsts/v2/app_consts.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,11 @@ const (
Version uint64 = 2
SquareSizeUpperBound int = 128
SubtreeRootThreshold int = 64
TimeoutPropose = time.Second * 10
TimeoutCommit = time.Second * 11
// 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 = 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.
Expand Down
2 changes: 1 addition & 1 deletion pkg/appconsts/v3/app_consts.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.
)
9 changes: 5 additions & 4 deletions specs/src/parameters_v1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 13 for more details. | False |
| MaxBlockSizeBytes | 100 MiB | Hardcoded value in CometBFT for the protobuf encoded block. | False |

## Module parameters

Expand Down
11 changes: 6 additions & 5 deletions specs/src/parameters_v2.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 13 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

Expand Down
18 changes: 11 additions & 7 deletions specs/src/parameters_v3.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 13 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 for more details. | False |
| TimeoutCommit | 4200 ms | Specifies the duration that validators wait during the Commit phase of the consensus process. See CometBFT specs 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

Expand All @@ -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 |
Expand Down

0 comments on commit 4f26e6a

Please sign in to comment.