Bring the repo agent context up to date (32.6)

This commit is contained in:
ai-bot committed 2026-10-25 18:21:35 +00:00
1 parent eec5883c29
commit 3248038883
1 file changed
+22 -6
+22 -6
View File
@@ -2,9 +2,9 @@
This repository holds **both** the VardKey application and its StartOS package, side by side at the This repository holds **both** the VardKey application and its StartOS package, side by side at the
repository root. The application is the Python source at the top level (`app.py`, `database.py`, repository root. The application is the Python source at the top level (`app.py`, `database.py`,
`alerts.py`, `export.py`, `validation.py`, `static/`, `tests/`); the package is `startos/` together `alerts.py`, `export.py`, `validation.py`, `auth.py`, `maintenance.py`, `secret_guard.py`,
with the `Dockerfile`, `Makefile`, `package.json`, `tsconfig.json`, and the rest of the StartOS `static/`, `tests/`); the package is `startos/` together with the `Dockerfile`, `Makefile`,
skeleton. `package.json`, `tsconfig.json`, and the rest of the StartOS skeleton.
## Repository mechanics ## Repository mechanics
@@ -18,9 +18,17 @@ skeleton.
with `make`. with `make`.
- **The image is built by `Dockerfile`**, referenced as `dockerBuild: {}` in - **The image is built by `Dockerfile`**, referenced as `dockerBuild: {}` in
`startos/manifest/index.ts`, which makes the build context the repository root. Anything the `startos/manifest/index.ts`, which makes the build context the repository root. Anything the
`Dockerfile` does not `COPY` is not in the image. `Dockerfile` does not `COPY` is not in the image. The `COPY *.py ./` line is what keeps a new
module from being left out; see the traps in `ai-note.md`.
- **The application is pure Python standard library.** There is no `requirements.txt` and no - **The application is pure Python standard library.** There is no `requirements.txt` and no
package-installation step in the image. package-installation step in the image.
- **The admin account is touched outside the HTTP API only by `maintenance.py`.** The two StartOS
actions, `delete-all-data` and `set-admin-password`, run it in a `withTemp` subcontainer, and the
generated password never travels from the host into the container, as an argument or on stdin:
`maintenance.py` generates it inside the container and prints the credentials back. The task that
asks the user to set the password is raised and cleared by `startos/init/requireAdmin.ts`, which
is registered in `sdk.setupInit()` after the actions; on the box it shows as *recommended*, so it
does not hold the service back. Its probe fails open.
## Things that look right and are not ## Things that look right and are not
@@ -46,6 +54,13 @@ python3 -m unittest discover -s tests
The suite is the application's regression net and does not exercise the package. It must stay The suite is the application's regression net and does not exercise the package. It must stay
green, on Linux and on the Windows copy alike. green, on Linux and on the Windows copy alike.
It also covers `secret_guard.py`, the one place that decides whether a piece of free text looks like
a wallet secret. That module is local, silent, and narrow by design: it makes no network call, never
puts the text in a log, a message, or an exception, and matches only unmistakable shapes. The
embedded BIP39 wordlist is pinned by the suite — 2048 words, alphabetical, 3–8 lower-case letters,
and no two words sharing their first four letters — and so are the shapes the guard recognises and
the shapes it deliberately does not. **Do not edit the wordlist without that test.**
## Build ## Build
```sh ```sh
@@ -53,5 +68,6 @@ make x86 # or: make arm
``` ```
Building needs a StartOS packaging workspace — see the packaging guide's Environment Setup. Building needs a StartOS packaging workspace — see the packaging guide's Environment Setup.
`make install` needs `host.default` in the workspace `.startos/config.yaml` and one `make x86` also runs `prettier --check startos` with the SDK's own config, so the TypeScript files
`start-cli auth login`. under `startos/` have to be formatted the way prettier would write them. `make install` needs
`host.default` in the workspace `.startos/config.yaml` and one `start-cli auth login`.