Skip to content

docs: nightly doc-gardening sweep 2026-06-28 - #810

Closed
litbot-9000 wants to merge 1 commit into
mainfrom
doc-gardening/nightly-2026-06-28-0
Closed

docs: nightly doc-gardening sweep 2026-06-28#810
litbot-9000 wants to merge 1 commit into
mainfrom
doc-gardening/nightly-2026-06-28-0

Conversation

@litbot-9000

Copy link
Copy Markdown
Collaborator

Automated nightly doc-gardening sweep for 2026-06-28.

Changes

New CLAUDE.md/AGENTS.md pairs created:

  • cmd/walletdk-wasm — browser/WASM syscall/js bridge over sdk/walletdk/mobile (PR walletdk: browser (js/wasm) wallet bindings #803)
  • sdk/walletdk/mobile — gomobile-safe JSON facade over sdk/walletdk (PR walletdk: browser (js/wasm) wallet bindings #803)
  • chainfeeschainfee.Estimator implementations (WalletKitEstimator, MempoolSpaceEstimator, MinEstimator)
  • coinselect — coin-type-agnostic largest-first selector (generic, no wallet dependencies)
  • internal/sqlbase — WASM-only SQL walletdb backend for lwwallet (js && wasm build tag)

Updated CLAUDE.md/AGENTS.md:

  • sdk/walletdk — add GetExitPlan/SweepWallet RPC methods, new Entry sub-types (EntryPhase, EntryProgress, EntryRequest, EntryFailureCode, FailureCode field), error reconstruction mechanism (errmap.go)
  • oor — add ErrOutputPolicyViolation and ErrUserBalanceExceeded typed submit errors (PR oor: add OOR_REJECT_USER_BALANCE typed reject code + classifier #807)
  • db — sync AGENTS.md to CLAUDE.md (pre-existing migration-entry ordering drift)

Infrastructure:

  • ARCHITECTURE.md — add five new packages to layer tables
  • docs/index.md — add walletdk_mobile.md entry

Review

Please check the updated CLAUDE.md/AGENTS.md diffs and the ARCHITECTURE.md layer table additions for accuracy.


Generated by the nightly doc-gardening workflow.

Automated sweep via .claude/skills/doc-gardening.
Updates per-package CLAUDE.md/AGENTS.md, docs/index.md
entries, and ARCHITECTURE.md as needed.

New packages documented (from wasm-wallet-bindings PR #803):
- cmd/walletdk-wasm: browser WASM entry point over mobile facade
- sdk/walletdk/mobile: gomobile-safe JSON facade over sdk/walletdk

New packages documented (pre-existing, missing docs):
- chainfees: chainfee.Estimator implementations and combinators
- coinselect: coin-type-agnostic largest-first selector
- internal/sqlbase: WASM-only SQL walletdb backend for lwwallet

Updated stale packages:
- sdk/walletdk: add GetExitPlan, SweepWallet RPC methods; new
  Entry DTOs (EntryPhase, EntryProgress, EntryRequest,
  EntryFailureCode, FailureCode field); error reconstruction
  mechanism via errmap.go
- oor: add ErrOutputPolicyViolation, ErrUserBalanceExceeded
  typed submit errors (PR #807)

Infra:
- db: sync AGENTS.md to CLAUDE.md (pre-existing drift)
- ARCHITECTURE.md: add five new packages to layer tables
- docs/index.md: add walletdk_mobile.md entry
@litbot-9000 litbot-9000 added documentation Improvements or additions to documentation automation Automated changes from CI bots labels Jun 28, 2026

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces several new packages and documentation files, including a coin-type-agnostic coin-selection algorithm (coinselect), reusable chain fee estimators (chainfees), a WASM-only SQL database backend (internal/sqlbase), and a gomobile-safe facade over the wallet SDK (sdk/walletdk/mobile) with its browser/WASM entry point (cmd/walletdk-wasm). The reviewer feedback highlights minor inconsistencies in the newly added documentation, specifically regarding the chronological ordering of migration notes in db/AGENTS.md and signature discrepancies for certain JSON RPC verbs in sdk/walletdk/mobile/AGENTS.md and sdk/walletdk/mobile/CLAUDE.md.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread db/AGENTS.md
Comment on lines +150 to +157
- `000021_vhtlc_recovery_job_generations` — rebuilds `vhtlc_recovery_jobs`
to widen the uniqueness key from `(swap_id, action)` to
`(swap_id, action, vtxo_txid, vtxo_vout)`, so a refreshed vHTLC (new
outpoint) arms a new recovery "generation" instead of colliding with the
prior job. SQLite cannot widen a UNIQUE constraint in place, so the table
is recreated, rows are copied, and the state / swap-action / unroll-target
indexes are rebuilt. The down migration collapses each `(swap_id, action)`
to its newest row before restoring the narrower constraint.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The migration notes are listed in descending chronological order (from highest migration number to lowest). However, 000021_vhtlc_recovery_job_generations has been placed below 000020_accounting_wallet_sweeps. To maintain the correct descending order, please move the 000021 migration note to the very top of the 'Migration notes' section (above 000020).

Comment on lines +36 to +38
All verbs take a JSON request body (`[]byte`, nil treated as zero request) and
return a JSON response body. Host apps marshal/unmarshal with their native JSON
library.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

There is a minor inconsistency here: the text states that 'All verbs take a JSON request body ([]byte...)', but the table below lists GetInfo(), Balance(), and Status() with empty signatures, indicating they do not accept any arguments. Please update the description to clarify that some verbs do not take a request body, or update the signatures if they actually do accept a []byte parameter.

Comment on lines +36 to +38
All verbs take a JSON request body (`[]byte`, nil treated as zero request) and
return a JSON response body. Host apps marshal/unmarshal with their native JSON
library.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

There is a minor inconsistency here: the text states that 'All verbs take a JSON request body ([]byte...)', but the table below lists GetInfo(), Balance(), and Status() with empty signatures, indicating they do not accept any arguments. Please update the description to clarify that some verbs do not take a request body, or update the signatures if they actually do accept a []byte parameter.

@litbot-9000

Copy link
Copy Markdown
Collaborator Author

Superseded by tonight's doc-gardening sweep.

@litbot-9000
litbot-9000 deleted the doc-gardening/nightly-2026-06-28-0 branch June 29, 2026 08:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation Automated changes from CI bots documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant