docs: add default params to the spec (backport #2416) (#2419)

This is an automatic backport of pull request #2416 done by [Mergify](https://mergify.com). Cherry-pick of 4e62d2d has failed: ``` On branch mergify/bp/v1.x/pr-2416 Your branch is up to date with 'origin/v1.x'. You are currently cherry-picking commit 4e62d2d. (fix conflicts and run "git cherry-pick --continue") (use "git cherry-pick --skip" to skip this patch) (use "git cherry-pick --abort" to cancel the cherry-pick operation) Changes to be committed: new file: specs/src/specs/params.md Unmerged paths: (use "git add <file>..." to mark resolution) both modified: specs/src/README.md both modified: specs/src/SUMMARY.md ``` To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/github/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally --- <details> <summary>Mergify commands and options</summary> <br /> More conditions and actions can be found in the [documentation](https://docs.mergify.com/). You can also trigger Mergify actions by commenting on this pull request: - `@Mergifyio refresh` will re-evaluate the rules - `@Mergifyio rebase` will rebase this PR on its base branch - `@Mergifyio update` will merge the base branch into this PR - `@Mergifyio backport <destination>` will backport this PR on `<destination>` branch Additionally, on Mergify [dashboard](https://dashboard.mergify.com) you can: - look at your merge queues - generate the Mergify configuration with the config editor. Finally, you can contact us on https://mergify.com </details> --------- Co-authored-by: Evan Forbes <[email protected]> Co-authored-by: evan-forbes <[email protected]>
celestiaorg · Sep 5, 2023 · 76f4a72 · 76f4a72
1 parent cd48a95
commit 76f4a72
Show file tree

Hide file tree

Showing 3 changed files with 72 additions and 12 deletions.
diff --git a/specs/src/README.md b/specs/src/README.md
@@ -13,9 +13,10 @@
   - [Public-Key Cryptography](./specs/public_key_cryptography.md)
   - [Data Square Layout](./specs/data_square_layout.md)
 - [State Machine Modules](./specs/state_machine_modules.md)
-  - [blob](../../x/blob/README.md)
-  - [qgb](../../x/qgb/README.md)
-  - [mint](../../x/mint/README.md)
-  - [paramfilter](../../x/paramfilter/README.md)
-  - [upgrade](../../x/upgrade/README.md)
-  - [tokenfilter](../../x/tokenfilter/README.md)
+  - [blob](https://github.com/celestiaorg/celestia-app/blob/v1.x/x/blob/README.md)
+  - [qgb](https://github.com/celestiaorg/celestia-app/blob/v1.x/x/qgb/README.md)
+  - [mint](https://github.com/celestiaorg/celestia-app/blob/v1.x/x/mint/README.md)
+  - [paramfilter](https://github.com/celestiaorg/celestia-app/blob/v1.x/x/paramfilter/README.md)
+  - [upgrade](https://github.com/celestiaorg/celestia-app/blob/v1.x/x/upgrade/README.md)
+  - [tokenfilter](https://github.com/celestiaorg/celestia-app/blob/v1.x/x/tokenfilter/README.md)
+- [Mainnet Parameters](./specs/params.md)
diff --git a/specs/src/SUMMARY.md b/specs/src/SUMMARY.md
@@ -15,9 +15,10 @@
   - [Public-Key Cryptography](./specs/public_key_cryptography.md)
   - [Data Square Layout](./specs/data_square_layout.md)
 - [State Machine Modules](./specs/state_machine_modules.md)
-  - [blob](../../x/blob/README.md)
-  - [qgb](../../x/qgb/README.md)
-  - [mint](../../x/mint/README.md)
-  - [paramfilter](../../x/paramfilter/README.md)
-  - [upgrade](../../x/upgrade/README.md)
-  - [tokenfilter](../../x/tokenfilter/README.md)
+  - [blob](https://github.com/celestiaorg/celestia-app/blob/v1.x/x/blob/README.md)
+  - [qgb](https://github.com/celestiaorg/celestia-app/blob/v1.x/x/qgb/README.md)
+  - [mint](https://github.com/celestiaorg/celestia-app/blob/v1.x/x/mint/README.md)
+  - [paramfilter](https://github.com/celestiaorg/celestia-app/blob/v1.x/x/paramfilter/README.md)
+  - [upgrade](https://github.com/celestiaorg/celestia-app/blob/v1.x/x/upgrade/README.md)
+  - [tokenfilter](https://github.com/celestiaorg/celestia-app/blob/v1.x/x/tokenfilter/README.md)
+- [Mainnet Parameters](./specs/params.md)
diff --git a/specs/src/specs/params.md b/specs/src/specs/params.md
@@ -0,0 +1,58 @@
+# Celestia Governance Params
+
+These are the parameters for mainnet. Note that not all of these parameters are
+changable via governance. This list also includes parameter that require a
+hardfork to change due to being manually hardcoded in the application or they
+are blocked by the `x/paramfilter` module.
+
+## Parameters
+
+| Module.Parameter | Default | Summary | Changeable via Governance |
+| --- | --- | --- | --- |
+| auth.MaxMemoCharacters | 256 | Largest allowed size for a memo in bytes. | True |
+| auth.TxSigLimit | 7 | Max number of signatures allowed in a multisig transaction. | True |
+| auth.TxSizeCostPerByte | 10 | Gas used per transaction byte. | True |
+| auth.SigVerifyCostED25519 | 590 | Gas used to verify Ed25519 signature. | True |
+| auth.SigVerifyCostSecp256k1 | 1000 | Gas used to verify secp256k1 signature. | True |
+| bank.SendEnabled | true | Allow transfers. | False |
+| blob.GasPerBlobByte | 8 | Gas used per blob byte. | True |
+| MaxBlockBytes | 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 |
+| blob.GovMaxSquareSize | 64 | Governance parameter for the maximum square size determined per shares per row or column for the original data square (not yet extended)s. If larger than MaxSquareSize, MaxSquareSize is used. | True |
+| consensus.block.MaxBytes | 1.88MiB | 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 |
+| consensus.block.TimeIotaMs | 1000 | Minimum time added to the time in the header each block. | False |
+| consensus.evidence.MaxAgeNumBlocks | 100000 | The maximum number of blocks before evidence is considered invalid. This value will stop CometBFT from pruning block data. | True |
+| consensus.evidence.MaxAgeDuration | 1814400000000000 (21 days) | The maximum age of evidence before it is considered invalid in nanoseconds. This value should be identical to the unbonding period. | True |
+| consensus.evidence.MaxBytes | 1MiB | Maximum size in bytes used by evidence in a given block. | True |
+| consensus.validator.PubKeyTypes | Ed25519 | The type of public key used by validators. | False |
+| consensus.Version.AppVersion | 1 | Determines protocol rules used for a given height. Incremented by the application upon an upgrade. | False |
+| distribution.communitytax | 2.0% | Percentage of the inflation sent to the community pool. | True |
+| distribution.WithdrawAddrEnabled | true | Enables delegators to withdraw funds to a different address. | True |
+| distribution.BaseProposerReward | 0 | Reward in the mint demonination for proposing a block. | True |
+| distribution.BonusProposerReward | 0 | Extra reward in the mint denomination for proposers based on the voting power included in the commit. | True |
+| gov.DepositParams.MinDeposit | 1000000000utia (1000 TIA) | Minimum deposit for a proposal to enter voting period. | True |
+| gov.DepositParams.MaxDepositPeriod | 172800 (2 days) | Maximum period for token holders to deposit on a proposal in seconds. | True |
+| gov.VotingParams.VotingPeriod | 172800 (2 days) | Duration of the voting period in seconds. | True |
+| gov.TallyParams.Quorum | 33.4% | Minimum percentage of total stake needed to vote for a result to be considered valid. | True |
+| gov.TallyParams.Threshold | 50.0% | Minimum proportion of Yes votes for proposal to pass. | True |
+| gov.TallyParams.VetoThreshold | 33.4% | Minimum value of Veto votes to Total votes ratio for proposal to be vetoed. | True |
+| ibc.ClientGenesis.AllowedClients | []string{"06-solomachine", "07-tendermint"} | List of allowed IBC light clients. | True |
+| ibc.ConnectionGenesis.MaxExpectedTimePerBlock | 7500000000000 (75 seconds) | Maximum expected time per block in nanoseconds under normal operation. | True |
+| ibc.Transfer.SendEnabled | true | Enable sending tokens via IBC. | True |
+| ibc.Transfer.ReceiveEnabled | true | Enable receiving tokens via IBC. | True |
+| slashing.SignedBlocksWindow | 5000 | The range of blocks used to count for downtime. | True |
+| slashing.MinSignedPerWindow | 5 | Minumum signatures in the block. | True |
+| slashing.DowntimeJailDuration | 10 mins | Duration of time a validator must stay jailed. | True |
+| slashing.SlashFractionDoubleSign | 5.0% | Percentage slashed after a validator is jailed for downtime. | True |
+| slashing.SlashFractionDowntime | 1.0% | Percentage slashed after a validator is jailed for downtime. | True |
+| staking.UnbondingTime | 1814400 (21 days) | Duration of time for unbonding in seconds. | False |
+| staking.MaxValidators | 100 | Maximum number of validators. | False |
+| staking.MaxEntries | 7 | Maximum number of entries in the redelegation queue. | True |
+| staking.HistoricalEntries | 10000 | Number of historical entries to persist in store. | True |
+| staking.BondDenom | utia | Bondable coin denomination. | False |
+| staking.MinCommissionRate | 0.05 (5%) | Minimum commission rate used by all validators. | True |
+| mint.BondDenom | utia | Denomination that is inflated and sent to the distribution module account. | True |
+| mint.InflationRateChange | 10.0% | The rate at which the annual provisions decrease each year. | False |
+| mint.InflationRate | 8.0% | Initial annual inflation rate used to calculate the annual provisions. | False |
+| qgb.DataCommitmentWindow | 400 | Number of blocks that are included in a signed batch (DataCommitment). | True |