Repository navigation
docs: fix stale code comments and markdown - #1702
Open
gjermundgaraba wants to merge 3 commits into
Open
gjermundgaraba wants to merge 3 commits into
gjermundgaraba wants to merge 3 commits into
Conversation
Vulnerable dependencies1 advisory across 1 library need attention, 2 accepted. 🚨 Needs attention
|
| Advisory | CVE | Fixed in | Summary |
|---|---|---|---|
| GO-2026-6859 | CVE-2026-97054 | go1.26.11 |
HTTP/1 server crash due to MaxBytesReader header race in net/http |
Run make vulncheck for the call paths. Either upgrade the library, or add the
advisory to cli/osv-scanner.toml with a reason if no fix exists yet.
Accepted
Listed in cli/osv-scanner.toml with a reason.
github.com/cosmos/evm
In use: v0.7.3 — reached from e2e
| Advisory | CVE | Fixed in | Summary |
|---|---|---|---|
| GO-2025-3684 | — | no fix yet | Cosmos EVM Allows Partial Precompile State Writes in github.com/cosmos/evm |
golang.org/x/crypto
In use: v0.58.0 — reached from cli, e2e
| Advisory | CVE | Fixed in | Summary |
|---|---|---|---|
| GO-2026-5932 | — | v0.58.1-0.20261009181718-2f1f834330b2 |
The golang.org/x/crypto/openpgp package is unmaintained, unsafe by design, and has known security issues |
From make vulncheck-json on this run: logs.
Welcome to Codecov 🎉Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests. ℹ️ You can also turn on project coverage checks and project coverage reporting on Pull Request comment Thanks for integrating Codecov - We've got you covered ☂️ |
7 of 9 tasks
dianab-cl
approved these changes
Nov 16, 2026
dhfang
approved these changes
Nov 17, 2026
swift1337
approved these changes
Nov 17, 2026
Correct code comments and markdown that no longer match the code (renamed identifiers, changed defaults, removed features, broken links), and drop comments that only restate the next line. Signed-off-by: agentconnect-md[bot] <297319493+agentconnect-md[bot]@users.noreply.github.com> Assisted-by: Claude Opus 5.5 Signed-off-by: Gjermund Garaba <gjermund@garaba.net>
Drop the PacketAttestationRequest note claiming the request has no height (it carries height = 3), list receipts among commitment types, say "attestor" rather than "attestation" in the --attestors usage, and name the JSON key file in the keys help text. Regenerate the attestor bindings and the CLI and API reference pages. Signed-off-by: agentconnect-md[bot] <297319493+agentconnect-md[bot]@users.noreply.github.com> Assisted-by: Claude Opus 5.5 Signed-off-by: Gjermund Garaba <gjermund@garaba.net>
Fix comments the sweep left inconsistent: the deploy_test alias note, the otel README example (record, caller attribute), the readiness test rationale, the Deploy step order and its IFT send-call constructor, and the OptionsFromConfig signer-alias mapping. Report awaited rather than succeeded in the catalyst progress log, since failures are counted too. Assisted-by: Claude Opus 5.5 Signed-off-by: agentconnect-md[bot] <297319493+agentconnect-md[bot]@users.noreply.github.com> Signed-off-by: Gjermund Garaba <gjermund@garaba.net>
gjermundgaraba
force-pushed
the
chore/stale-docs-comments
branch
from
November 17, 2026 13:47
08e39ae to
82e5652
Compare
swift1337
approved these changes
Nov 17, 2026
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Sweep of code comments and markdown outside
docs/andspec/, correcting text that no longer matches the code and removing comments that only restated it. Every edit was checked against the code it describes (e.g.latestProvableHeighttakes the threshold-th highest height, not the minimum; the default dispatch poll is 1s, not 5s; the in-memory SQLite DB is per-connection, not shared; the attestation domain-separation note was checked against the pinned ibc-contracts commit).Two commits:
#Lline citations in the reference pages moved.PacketAttestationRequesthas no height (it hasheight = 3), list receipts among commitment types, say "attestor names" in--attestors, and name the JSON key file in thekeyshelp. Regeneratedattestor.pb.go(make -C cli codegen-proto) and the reference pages (refgen.py all).Out of scope, not changed here:
clearOnStart: falseis dropped.ibccli/relayer_config.gowrites a plain bool withomitempty, and the CLI defaults a missing key totrue.relayer_lifecycle_test.go:143andtraffic_setup.go:399therefore never disable startup clearing.store_test.go:524-526discards the result of the inverted-rangeListPacketSequencescall, so that case is never checked.e2e/scripts/clean.shsweep gap. It misses relayers started with--config ibc.ymlby the deploy tests, andtestproverprocesses.RELEASES.mdlost its "Cut a release" and "Verify a release" sections in 8dfc82d; the README and release-tracker links now no longer point at them.osv-scanner.tomlGO-2026-4479. The ignore blamespion/dtls/v2, which nogo.sumcontains.Dependencies.sol:4version. It says Solidity IBC v3.0.2, but the pin is v4.0.0-rc.1. Not edited, because a comment change alters the bytecode metadata.Reference documentation
Derived from source: 89 regions across 3 pages.
refgen.py all --checkis clean.Written by hand, not derived
cli/cmd/ibc/keys.go:keys new/import/showLong text (rendered into 02-cli-commands.mdx)The hand-written CLI pages (overview, tutorial, guides) were grepped for the changed wording and need no update: the second commit changes only help text and comments, not behaviour.
Checklist