24 KiB
AI Agent Note — VardKey
Short working handover for the next model. Keep it short.
TODO.md(Norwegian) is the requirement specification. Sections 1–18 are the binding spec; sections 19–29 are short summaries of the rounds that are implemented and verified, and section 30 is the StartOS package round. The full reasoning is in the git history.- The binding rules live in
TODO.mdandREADME.md. This note does not repeat them — it carries the handover, the rules that are easy to get wrong, and the traps that already cost time. HANDOVER.mdwas deleted as outdated. Do not recreate it.
Status
- Done and verified: sections 19–29 and section 18 steps 1–8. Schema version 11. 346 green tests.
- Section 30 is written, not built and not installed. The StartOS package lives in this repository beside the application:
startos/,Dockerfile,.dockerignore,Makefile,package.json,tsconfig.json,.prettierrc,LICENSE,icon.svg,instructions.md,UPDATING.md,AGENTS.md,README.md, andCLAUDE.md. What is left is the build, the install, and the manual tests — section 13'sBuild .s9pkand the install verification, section 14, the StartOS test in section 16, and section 17. - Section 29 is done. The app is VardKey, described as Bitcoin Multisig Health Monitor, the database file is
data/vardkey.sqlite3, and the export isvardkey-export.csv. The Gitea repo and the project id stayai-bot/helsesjekk. - A round stops when it is done. Section 30 is the round; do not roll into anything after it. In particular, do not install on a StartOS box, and do not start on anything beyond section 30.
- Verified how: the automated suite and the user's manual browser testing. The remaining manual tests are the ones in section 16 of
TODO.md; the StartOS test there is still open. - Tests: the user runs them:
python3 -m unittest discover -s tests. They run on a Windows copy atC:\Users\<brukarnamn>\Downloads\helsesjekk, so they must pass there as well as on Linux. - Future work, deliberately not built: more than three keys, and another threshold than 2-of-3.
Section 30 — the StartOS package
The package is one service: one daemon, one container, one SQLite database on the persistent main volume, mounted at /data. No Postgres, no Redis, no external backend, no extra container.
The decisions are recorded in TODO.md section 30; this is what the next model needs on top of them.
Where the files live, and why
The application and the package share one repository, at the root. That is a deliberate deviation from the guide's "a package repo is not a fork of the application": the rule assumes a published upstream image or a git submodule, and VardKey has neither. AGENTS.md states the deviation so nobody adds an upstream-project/ submodule to "fix" it.
The image is built by the root Dockerfile, referenced as dockerBuild: {} in startos/manifest/index.ts, which makes the build context the repository root. Anything the Dockerfile does not COPY is not in the image. In particular static/ must be copied: app.py answers /health from code, but every page is read from ROOT/static, so an image without it reports a healthy service whose entire UI answers 404.
There is no CI. The guide assumes GitHub Actions; this repository is on Gitea, so there are no .github/workflows/ and there must not be any. The .s9pk is built locally with make.
The three things that must agree
startos/utils.ts holds uiPort (8080). startos/main.ts passes it as PORT to the daemon and uses it in the readiness URL; startos/interfaces.ts binds it. Change one alone and the readiness check never goes green. The DATABASE_PATH constant in the same file is what puts the database on the volume instead of the application's own default of data/vardkey.sqlite3 relative to the working directory.
The readiness check is checkWebUrl against http://127.0.0.1:8080/health, not checkPortListening — section 30 asks for the endpoint, and /health is the application's own.
Backups
startos/backups.ts is sdk.Backups.ofVolumes('main'). The open question section 30 raised — whether setupBackups has a hook for a consistent SQLite snapshot — turned out not to need one: StartOS stops the service for the duration of a backup, so the database file is quiescent while it is copied. That is written up in README.md and in startos/backups.ts; it is not a known limitation.
What is not verified
Nothing about this package has been run. make has not been invoked, no .s9pk exists, and no StartOS box has seen it. Treat every claim in README.md about runtime behaviour as intended, not observed.
Two specific things to reconcile on the first build:
- The skeleton was written by hand.
package.json,tsconfig.json,Makefile,.prettierrc,startos/sdk.ts,startos/index.ts,startos/actions/index.ts,startos/i18n/,startos/fileModels/.gitkeep, andassets/.gitkeepwere written to match the Start9 template rather than generated bys9pk init-workspace, because that command was not available in the environment that wrote them. Runs9pk init-packagein a scratch directory and diff, above all the@start9labs/start-sdkversion inpackage.json— it is pinned to the latest published release, not to whatever a current scaffold would pick. - The icon is a placeholder. Section 30 defers the real
icon.svgto the round that raises the package to1.0.0; a minimal placeholder sits in the repository so the build has an icon to pack.
Documentation layout
README.md is now the StartOS package README, with the guide's fixed heading set. The application's own reference — the HTTP API, the alerts table, the schema history — moved to docs/application.md, which is what instructions.md links to under ## Documentation. AGENTS.md is the repo-specific agent context, and CLAUDE.md is the one-line @AGENTS.md import.
Sections 27 and 28 — implemented and verified
What the code does now, and the parts that are easy to get wrong:
- The acknowledgement stores the key.
alert_acknowledgements.key_idis nullable and holds the key the alert belonged to, orNULLfor a software alert raised by the settings list. An alert with a key is acknowledged and hidden by(code, key_id); an alert without one stays on(code, source). This closed a real bug: a rename — or arotatewithkeep_name=false— used to reopen a closed alert, becausesourcecarries the name the key has now. - The contact alert belongs to the checked key. It gets
key_idandsource=Key N: <name>, and its message names the key:The contact details for Key 1: SeedSigner need an external update. Update them in your external documentation, then close this alert.The severity staysinfoand the action stayscontact_updated. It blocks its key like every other key alert, becauseblocking_alert()and theblockingAlertsfilter in the form only look atkey_id. A record without a key check raises no contact alert at all. software_incompatiblehas two forms. A software from the settings list keepssource= the software name,key_id=None, actions[remove_software], and carriessoftware. A wallet software that is the name of a configured cloud key can never be removed from the settings, so that form belongs to the checked key instead:key_id= the checked key,source=Key N: <name>, actions[replace_hardware], and nosoftwarevalue, so a settings removal can never close it.alerts.pyneeds the cloud key names.build_alerts()andcollect_alerts()takecloud_names=(), threaded throughrotation_alert_targets(),software_alert_targets(), and the four call sites inapp.py(_send_alerts,_blocking_alert,_rotate_key,_close_removed_software), plusnewest_alert_check_id().app.cloud_key_names(keys)builds the tuple. Ifnewest_alert_check_id()does not get exactly the same names ascollect_alerts(), the alert'ssourcediffers, the acknowledgement storescheck_id = None,_is_acknowledged()refuses to hide an alert without a check id, and the alert can never be closed. Keep the default()onbuild_alerts().- The closures that belong to a key are shown.
app.closed_alerts()anddatabase._grouped_closures()both filter onkey_id IS NOT NULL, so a rotation, a replaced hardware, an updated contact, and an ignored key alert are listed, whileremove_softwareand a software-sourcedignoreare not.GET /api/health-checks/<id>returns them asclosed_alerts(code, source, action, acknowledged_at), and the CSV has one last column,Follow-up closed, withcode: action (YYYY-MM-DD). A closure hangs on the check it closed, throughcheck_id. - The key card shows the dates and the note together.
createKeyCard()instatic/app.jsalways rendersLast checked/Next check due, and adds the alert note on top. It used to replace the dates with the note, which cost the dates for a key whose only alert was the informational contact one. - The type is part of a key's identity (section 28). The setup locks it, the settings never change it, and only a rotation may pick the other one:
POST /api/keys/<id>/rotatetakes an optionaltype(hardware/cloud), and leaving it out keeps the current type.save_key_settings(..., key_type=None)usesCOALESCE(?, type), so the settings and a rotation share one statement. - A key that becomes a cloud key must not take a taken name. A cloud key offers its own name as a wallet software choice, and the settings list holds the other choices, so a name the list already holds is refused with
409throughWalletSoftwareNameInUse— aValidationErrorsubclass, so it has to be caught before the generalValidationErrorin_rotate_key, or the409turns into a400.validate_rotation()therefore takes the wallet software list as a fourth argument. - The settings page has two sections:
01 / Wallet softwareand02 / Key rotation. The old01 / Keyssection is gone, because the name now belongs with the rest of the key identity. - A rename needs no rotation and no confirmation. In the rotation section the name can be changed on its own through
POST /api/settings/keys, for any key, and the address path of a key with no saved check can be changed there the same way. Marking a key withRotate this keyand ticking the confirmation box (#rotation-replaced, "I confirm that each selected key has been replaced by a new key or hardware wallet") sends it through the rotate endpoint instead, together with the type and the new path. The single button isSave keys; it reports what was saved, and says so when there is nothing to save.
Deliberately left out
remove_software is still a dead end in two places: a software-sourced security_vulnerable offers it next to ignore (so the alert stays closable, but one button leads nowhere), and a software-sourced security_compromised offers it as its only action, so an alert whose "software" is a cloud key name can never be closed. Neither is fixed.
Rules that are easy to get wrong — do not re-open
- One submission records one key. There is no "round" grouping, and each key's next check is its own date plus one calendar year, computed on the server and not editable in the form.
- A key that could not be checked records nothing else. That covers
available=0and a recorded address path that does not match.wallet_softwareandai_security_checksmust be empty; a non-empty value is a400, not something dropped silently. Nothing is stored for them, andsoftware_compatibility_statusbecomesNOT_ASSESSED. Availabilityis required and offers only Yes/No. A cloud key collects onlyAvailability; its compatibility is derived from it, and its own name is the wallet software.- A hardware key needs an explicit compatibility status, and
Hardware worksneeds an explicitYesorNo. A missing value,""andNOT_ASSESSEDare all a400. - The contact confirmation is required for every submission, including one for a key that could not be checked, and it has no "not assessed" value.
NOT_ASSESSEDis not offered or accepted anywhere else. No field but the derivedsoftware_compatibility_statusaccepts it.Address path verifiedis never a form field again. The server derives it from the comparison. The stored column stays, so the history, the export and the alerts keep working.- The address path is locked after the first saved check, and no two keys may share one — in the setup, in the settings or in a rotation.
- The type is locked by the setup, and only a rotation may change it. The settings never take a
type, and a rename alone is not a rotation. - An alert is closed by the user, not by a newer check. A newer check that raises nothing does not clear an older alert, and a key with an open alert cannot get a new check at all.
- An acknowledgement stores the action name, not a free reason, and only the actions the endpoint performs are accepted.
rotatehas its own endpoint, because it requires a new address path. - The export is plain CSV only. XLSX is not built and the app does not promise Excel compatibility.
- The prohibition lists in sections 1 and 13 of
TODO.mdstay unticked. They are standing prohibitions, to be re-confirmed before release. - Whether a date is overdue is decided in the browser, so
/api/key-statusstays independent of the current date. /api/previous-valuesstill returns asecuritymap that nothing consumes any more, and itsaddress_pathper key is no longer used by the form, which pre-fills the path fromkeys.address_path. Both are deliberate: removing them would shrink the endpoint, but nothing breaks while they stay.
Data model (schema version 11)
keys:key_number(1–3),name,type(hardware/cloud),address_path,created_at. There is nodevicecolumn. The name is editable in the settings; the type and the address path are the identity of the key, the path must be unique across the three rows, and the type only changes through a rotation.health_checks:checked_at,next_check_due,wallet_software,software_version,software_compatibility_status,software_comments,contact_info_verified,comments, plus the legacysparrow_version/nunchuk_version.wallet_softwareandcontact_info_verifiedare free text.key_checks: one row per submission —available,hardware_works,firmware_version,seed_backup_verified,address_path_verified,address_path,comments. The two cloud columns are gone.ai_security_checks:provider(free text),status,comments, withUNIQUE (health_check_id, provider).wallet_software:name,created_at. Stored whole, seeded withSparrow Walletwhen the list is empty, never emptied through the API.alert_acknowledgements:code,source,key_id,check_id,reason,acknowledged_at.reasonholds the action name that closed the alert, andkey_idholds the key the alert belonged to, orNULLfor a software alert from the settings list.tool_checksno longer exists.- Startup migration rebuilds
keyswhen it still hasdevice,key_checkswhen it uses the old layout or still holds the two cloud columns, andhealth_checksandkey_checkswhen theirCHECKconstraints still allow the old values. It then dropstool_checksif it is there, and adds the newer columns throughOPTIONAL_COLUMNS— includingalert_acknowledgements.key_id. - The table definitions are
{table}templates, so a rebuild can create the same table under a temporary name.health_checksis a parent table, so the whole migration runs withPRAGMA foreign_keys = OFF, checksPRAGMA foreign_key_checkbefore committing, and rolls back on any failure. tests/test_database.pycarriesLEGACY_SCHEMA,SCHEMA_VERSION_5,SCHEMA_VERSION_8,SCHEMA_VERSION_9andSCHEMA_VERSION_10as literal older schemas. Copy that pattern for a new migration test: write the old schema, runinitialize_database(), then assert on the migrated rows.- There is no data migration for an older test database: the user deletes the
datafolder and configures the setup again. An acknowledgement written before version 11 has no key, and the older contact alert used the sourceContact information, which no longer matches, so the alert it closed is raised again. Section 29 renamed the database file for the same reason, and the old file is discarded with the rest.
API
Pages: /, /setup, /settings, /health-check, /history. Endpoints: GET /health, GET /api/setup, POST /api/setup, GET /api/keys, GET /api/key-status, GET /api/previous-values, GET /api/settings, POST /api/settings/keys, POST /api/settings/wallet-software, POST /api/keys/<id>/rotate, GET /api/health-checks, GET /api/health-checks/<id>, GET /api/alerts, POST /api/alerts/acknowledge, GET /api/export, POST /api/health-checks. Field details are in docs/application.md.
The rotate payload is replaced + keep_name + name + type + address_path, and type is optional. GET /api/health-checks/<id> also returns closed_alerts. The settings page has two sections, and POST /api/settings/keys is what a rename alone goes through.
Five things that are easy to break:
- New static files must be added to
STATIC_FILESinapp.py, or they return404. That includes/settingsand/settings.js. /api/setup,/api/settings,/api/alerts,/api/key-statusand/api/previous-valuesare extra endpoints that are not in the minimum list in section 11.STORAGE_ERRORSinapp.pyincludesRuntimeError, becauselist_keys()raises it for a partial setup. Keep it there, or a broken database answers with a traceback instead of a500.- The settings, rotation and acknowledgement endpoints keep the same error handling as the existing ones: a bad payload is a
400, an unknown key or alert is a404, a locked or duplicate address path is a409, and a broken database is a500.DuplicateAddressPathandWalletSoftwareNameInUsemust be caught before the generalValidationError— in_save_key_settingsand_rotate_keyrespectively — or the409turns into a400. newest_alert_check_id()inapp.pyderives the check id for the acknowledgement, the rotation and the software removal, so the same comparison rule is used in all three places.blocking_alert()is the module-level helper the409is built on, and_blocking_alert()reads the key id straight from the payload, so the rule applies before validation.
Traps that already cost time — do not repeat
with sqlite3.connect(...)does not close the connection. It only commits or rolls back the transaction. On Windows the database file stays locked andTemporaryDirectory.cleanup()fails withWinError 32. Always close explicitly withtry/finally; seewrite_schema()intests/test_database.py.- A
requiredcontrol inside adisplay:nonecontainer still blocks submission. The browser refuses to submit and logs "An invalid form field is not focusable". Hiding a section is not enough: the required flags must be cleared, or the section must render something other than required fields. That is whyrenderSecurityChecks()shows an empty note instead of cards when a key could not be checked, whysyncUncheckableState()clears the flags on the wallet software and the compatibility select — also for a cloud key, whose grid is hidden — and whysyncRequiredFields()clears the flag onhardware_worksandseed_backup_verified. The rotation fields follow the same rule: the type isdisableduntil the key is marked for rotation, the path isdisabledwhen the key has a saved check and is not marked, and the script refuses to send an empty path. - The mismatch confirmation follows its warning.
#address-path-confirmedisrequiredonly while#address-path-warningis visible, so the browser itself stops the submission and a required control is never hidden. - The page heading uses
class="eyebrow"too. A regex overhealth-check.htmlfindsAnnual security checkbefore the numbered sections.settings.htmlstarts withSettings, then01 / Wallet softwareand02 / Key rotation. A test on the section order must expect that first.tests/test_health_check_form.pyasserts those two lists exactly, so a new eyebrow on either page breaks it — the section 29 description line went on the dashboard only. - Do not assert on the quoting style of the JavaScript.
static/health-check.jsuses single quotes for constant selectors and template literals where a${...}substitution is needed, andstatic/settings.jsuses double quotes. Assert on the selector text, e.g.[name="address_path"], and on quote-free substrings such as/api/settingsand/settings?rotate=. clean_record()intests/test_alerts.pyhas a fixed provider list and carrieskey_idandwallet_software. A test that needs another provider must replace the entry itself, and the recorded software isSparrow Wallet, which is what a software alert names. A test that exercises the cloud-key form ofsoftware_incompatiblehas to passcloud_namestobuild_alerts().sample_payload()/unavailable_payload()are duplicated intests/test_validation.py,tests/test_database.pyandtests/test_app.py. They build the labels from the key's name and the selected software, they always sendcontact_info_verified, and for a hardware keyhardware_works. They must send the key's ownaddress_path, because the server compares it with the stored one.- Every test fixture uses one address path per key (
ADDRESS_PATH,SECOND_ADDRESS_PATH,THIRD_ADDRESS_PATH), because the setup refuses duplicates.tests/test_app.pyalso hasROTATION_PATHSand therotate()helper, which picks an unused path per key so a test can rotate several keys in one run. validate_health_check()takes a third argument (the wallet software list), andvalidate_rotation()takes a fourth for the same reason.tests/test_validation.pyandtests/test_database.pywrap the first one in a smallvalidate()helper.tests/test_app.pyhas six test classes.ServerTestCasestarts the server,AppHandlerTestsstores the default setup insetUp,RenamedSetupTestsstores the renamed one,SettingsApiTests,RotationApiTestsandAcknowledgementApiTestsstore the default one, andKeySetupApiTestsleaves the database empty. A new test must go in the class whose setup it needs.- Section 19 records one key per submission, so a
Check idin the export can cover up to three keys only for rows saved before section 19. A legacy record with severalkey_checksis read through its first one when an alert needs the key it belongs to. - The database path default is repeated in sixteen places.
database.pycarriesdatabase_path="data/vardkey.sqlite3"as the default of every storage function (fifteen of them), andapp.pycarries it inget_database_path(). A missed one makes a single code path read or create the other file, silently. Grep for the old name before and after a rename round.
Product clarification
The key's configured name is its product label, and a cloud key's name is also a wallet-software choice. A hardware key name is never a wallet-software choice, and a cloud key records its own name as its software. A key is identified by its type and its address path, while the name is only a label that the user may change. The address path is unique per key, and a rotation replaces the key with a new one that must carry a new address path and may carry the other type. A rotation creates a new wallet, so the funds have to be moved from the old multisig setup to the new one before the old keys are discarded. An alert is closed by the user with the action that belongs to it, and a key with an open alert cannot be checked until the alert is closed.