Uh oh!
There was an error while loading. Please reload this page.
update Cometbft and SDK docs for v0.55 and v0.40 release - #332
Conversation
| The safety statement above concerns protocol validity rules. It does not remove an operational double-signing risk for validators. | ||
| <Warning> | ||
| Enable `adaptive_sync` on a validator node only if you understand and accept this risk. With `adaptive_sync` enabled, consensus starts immediately, and the node signs votes whenever it is in the validator set. A catching-up validator can sign a vote for one block at a given height while the blocksync ingestor commits a different, already-decided block at that same height. The HRS file and the KMS double-sign protection are not sufficient backstops for this case. Non-validator full nodes are not affected. |
There was a problem hiding this comment.
@Eric-Warehime is this BS or should it be included?
There was a problem hiding this comment.
It's not true, adaptive sync still respects the HRS file so you'll never sign for a height/round/step you've already signed for.
Greptile SummaryThis PR updates the
Confidence Score: 4/5Safe to merge after fixing the The regenerated cometbft/next/docs/core/configuration.mdx deserves a close pass; the regenerated config.toml block has two comment-level errors and the TLS note inconsistency all introduced in the same chunk. Important Files Changed
|
| # Bootstrap peers to connect to | ||
| # format: { host, id, private (opt), persistent (opt), unconditional (opt) }bootstrap_peers = [] |
There was a problem hiding this comment.
bootstrap_peers = [] is swallowed by the comment — it sits on the same line as the # comment, so a TOML parser treats it as comment text. Any reader copying this config block will end up with bootstrap_peers silently absent. The key needs to be on its own line.
| # Bootstrap peers to connect to | |
| # format: {host, id, private (opt), persistent (opt), unconditional (opt) }bootstrap_peers = [] | |
| # Bootstrap peers to connect to | |
| # format: {host, id, private (opt), persistent (opt), unconditional (opt) } | |
| bootstrap_peers = [] |
| # Maximum number of unique queries a given client can /subscribe to | ||
| # If you're using GRPC (or Local RPC client) and /broadcast_tx_commit, set to | ||
| # the estimated maximum number of broadcast_tx_commit calls per block. | ||
| # the estimated # maximum number of broadcast_tx_commit calls per block. |
There was a problem hiding this comment.
A stray
# was introduced mid-comment during regeneration, turning a plain description into # the estimated # maximum number.... This looks like a copy error from the upstream source.
| # the estimated # maximum number of broadcast_tx_commit calls per block. | |
| # the estimated maximum number of broadcast_tx_commit calls per block. |
| # The path to a file containing matching private key that is used to create the HTTPS server. | ||
| # Might be either absolute path or path related to CometBFT's config directory. | ||
| # NOTE: both tls_cert_file and tls_key_file must be present for CometBFT to create HTTPS server. | ||
| # NOTE: both tls-cert-file and tls-key-file must be present for CometBFT to create HTTPS server. |
There was a problem hiding this comment.
The comment immediately above
tls_cert_file (line 207) correctly uses snake_case (tls_cert_file / tls_key_file), but this PR changed the identical note above tls_key_file to kebab-case (tls-cert-file / tls-key-file). Users scanning for the matching config key will find a mismatch, since the actual TOML keys below both use underscores.
| # NOTE: both tls-cert-file and tls-key-file must be present for CometBFT to create HTTPS server. | |
| # NOTE: both tls_cert_file and tls_key_file must be present for CometBFT to create HTTPS server. |
| - `SIGN_MODE_DIRECT_AUX`: allows N-1 signers in a multi-signer transaction to sign over only `TxBody` and their own `SignerInfo`, without specifying fees. The designated fee payer signs last using `SIGN_MODE_DIRECT`. This simplifies multi-signature UX. | ||
| The sign mode is negotiated at transaction construction time and does not affect how state is stored or how validators execute transactions. It only affects what bytes are signed. The full list of sign modes is defined in [`signing.proto`](https://github.com/cosmos/cosmos-sdk/blob/release/v0.54.x/proto/cosmos/tx/signing/v1beta1/signing.proto#L17). |
There was a problem hiding this comment.
The
signing.proto link still targets release/v0.54.x in a next/ page being updated for SDK v0.55. Per the CLAUDE.md style guide, stable-version links should use the release/v{X}.{Y}.x branch that matches the documented version — consider updating this to release/v0.55.x.
Context Used: CLAUDE.md (source)
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
| )) | ||
| ``` | ||
| ### Configuration via app.toml |
There was a problem hiding this comment.
@Eric-Warehime multiple reviewers suggested adding this. wdyt?
There was a problem hiding this comment.
Yeah it probably works, I've not tested this though.
Uh oh!
There was an error while loading. Please reload this page.
* add pq docs * add po and staking page * add docs * docs(sdk): kms rotation guide, release-impact fixes, prerequisites pass docs(sdk): kms rotation guide, release-impact fixes, prerequisites pass Add rotate-key-remote-signer: rotate a consensus key held in Cosmos-KMS (second signer process, shadow node, pubkey from /status). Test-verified e2e on a localnet; includes the show-validator stray-key trap as a Danger. Release-impact fixes to existing pages: - run-production: replace the deprecated TMKMS walkthrough with Cosmos-KMS links and a deprecation note - keyring: correct key algorithms to secp256k1 + ml_dsa_65 via --key-type (was ed25519 via --algo), link the new keys pages, fix a broken in-page anchor - run-node: next-step links to key rotation and remote signing; jq links moved to jqlang.org Guide improvements: - complete, linked prerequisites on every keys/ and kms/ guide - migrate-validator-ml-dsa: step 2 split into labeled staking / PoA / remote signer paths with the exact deltas (PoA passes ml_dsa_65) - state-sync pointers on both shadow-node rotation pages - post-quantum-keys: EIP-7702/8051/8141 linked and corrected - Cosmos-KMS naming in prose, bare "kms" replaced with "the signer" - remote-signing next steps completed (resolves placeholder TODO) * update todos * Update rotate-key-remote-signer.mdx * Update configuration-reference.mdx * Update rotate-key-remote-signer.mdx * Update remote-signing.mdx * Update security-release.md * Update key-rotation.mdx * Update migrate-from-tmkms.mdx * Update post-quantum-keys.mdx * Update rotate-key-remote-signer.mdx * Update security-release.md * Update enable-ml-dsa-keys.mdx * Update migrate-validator-ml-dsa.mdx * Update rotate-validator-key-poa.mdx * Update rotate-validator-key.mdx * Update configure-backend.mdx * Update remote-signing.mdx * Update rotate-key-remote-signer.mdx * Update rotate-key-remote-signer.mdx * Update migrate-validator-ml-dsa.mdx * update guides * Update migrate-from-tmkms.mdx * Update security-release.md * Update tutorial-file-backend.mdx * fix inaccuracies and unclear wording in post-quantum-keys.mdx * updates * update after eng passes * update * updates * update Cometbft and SDK docs for v0.55 and v0.40 release (#332) * update Cometbft and SDK docs for v0.55 and v0.40 release * Update block-sync.mdx * Update configuration.mdx * update warning * add upgrade guide * Update v0.55.mdx * Update security-release.md * Update rotate-validator-key-poa.mdx * Update post-quantum-keys.mdx * Update accounts.mdx * Update accounts.mdx * Update architecture.mdx * Update key-rotation.mdx * updates * audit runs and changes * updates * update * update * updates * updates * Update v0.55.mdx * updates * update versions (#334) --------- Co-authored-by: Dennis Fang <dhsfang@gmail.com>
Summary
Updates the
next/docs for the 2026.1 (Ledger Security) release, covering thenon-headline delta of Cosmos SDK 0.55 and CometBFT 0.40: removed modules, changed
params and config, new key types, and stale references. The post-quantum key,
consensus key rotation, and Cosmos-KMS feature pages were reviewed separately and
are not re-audited here.
Every change was verified against source code:
CHANGELOG.md(0.55 / UNRELEASED): https://github.com/cosmos/cosmos-sdk/blob/main/CHANGELOG.mdCHANGELOG.md(0.40 / UNRELEASED): https://github.com/cometbft/cometbft/blob/main/CHANGELOG.mdAudited at
cosmos-sdk@3d3b901ce5andcometbft@6ac238b.Changes
Cosmos SDK (
sdk/next/)x/protocolpoolmodule docs (module removed in 0.55): deleted theREADME, dropped the
docs.jsonnav entry, added a redirect to the distributionREADME, and removed the
modules.mdxbullet. Rewrote the distribution README todrop the fully-removed external community pool apparatus. Added a
protocolpooldeleted-store step to the upgrade guide.
SIGN_MODE_TEXTUAL(removed in 0.55): cut the bullet from the encodingconcept page and archived ADR-050 plus annex1 and annex2.
SigVerifyCostMlDsa65auth param (default 750) to the auth paramstable and YAML.
app.tomlkeys (block-executor,block-stm-workers,block-stm-pre-estimate) in the experimental Block-STM guide.key_rotation_fee(field 7) to the reproduced stakingParamsproto.BeginBlock, capped at 200 per block).OTEL_EXPERIMENTAL_CONFIG_FILE->OTEL_CONFIG_FILE).--consensus-key-algoinit flag note and anapp.tomlreference link tothe run-node guide.
mempool.type = "app"(InsertTx/ReapTxs).CometBFT (
cometbft/next/)secp256k1ethandml_dsa_65consensus key types in the encodingspec, and updated the
pub_key_typesenumerations in the genesis spec and ABCIrequirements.
config.tomlin the configuration reference fromcometbft init(restores 20 drifted fields, includingevent_bus_buffer_capacityand
adaptive_sync).adaptive_syncto the block-syncguide.
Verification
npx mint broken-links: clean.docs.json: valid JSON, redirect added, no dangling nav entry.config.tomlreproduction: field parity confirmed against a freshlygenerated file.
changes confirmed accurate to code, zero blockers.