docs: correct the README's claims, state the limits, and CI on macOS

The README said the quiet rule holds for the quietest markets (it can't
judge one under 3 changes a minute) and that all four extensions were
done (two of the brief's latency ideas were not tried); LATENCY.md said
the slow recycle was not seen to fire live, two lines after the run where
it did. Limits gains the process going down, the quiet rule's blind
spots and Kalshi's skipped-change case.

CLAUDE.md loses the home network's details and the server's key paths,
of no use to a reader of the public repo.

scripts/test_watch.sh no longer puts a here-document inside `$( )`:
bash 3.2, which is sh on macOS, stopped at an apostrophe there and
scripts/ci.sh ended on a syntax error.
This commit is contained in:
pascal committed 2026-11-12 23:17:10 +01:00
1 parent 6b3b2c1ca4
commit 00202bbc51
4 files changed
+71 -77

No files matched your search

+5 -10
View File
@@ -2,8 +2,7 @@
A collector for prediction-market order books (Polymarket, then Kalshi) that
emits SBE-encoded updates and per-minute snapshots, built inside the challenge
template. The brief is `../website/Engineering Challenge _ Voluntas.html`,
outside this repo.
template. The brief is https://voluntas.io/engineering-challenge.
## Where things are
@@ -80,11 +79,8 @@ and let the user settle it. Claude owns the data model.
## Environment traps
- **DNS: the exchanges resolve normally on the server** (a remote-claude
workspace, since 2026-11-09). The Mac's dev network blocks them (its resolver
answers `195.186.4.210` / `2001:4d98:4:b10c::1`, a Swisscom block page);
there the user pins the hosts with `sudo ../host.sh on` (workspace root,
outside this repo; `off` removes them), rerun when the CDN addresses rotate.
- **DNS: a network can block the exchanges** (its resolver answers a block
page's address): check what the hosts resolve to before blaming the code.
A 403 is not DNS (see `docs/notes.md`, REST from scripts).
- **Write 64 MiB chunks**: `AlignedSbeReader::open` hardcodes 64 MiB
(`open_with_chunk_size` is private), so any other chunk size is unreadable.
@@ -120,9 +116,8 @@ and let the user settle it. Claude owns the data model.
Check `cat /proc/loadavg` before a live run whose numbers are compared, and
alternate the builds in short rounds rather than running them back to back.
- **Kalshi needs a key; nothing else does**: `KALSHI_KEY_ID_FILE` and
`KALSHI_PRIVATE_KEY_FILE` name its two files (on the server
`/run/secrets/kalshi-demo-key-id` and `kalshi-demo-private-key`; never read
or print them). The key is Ed25519 or RSA (RSA-PSS-SHA256), told apart
`KALSHI_PRIVATE_KEY_FILE` name its two files (never read or print
them). The key is Ed25519 or RSA (RSA-PSS-SHA256), told apart
by the parsed key. Opening ~100 connections at once gets some handshakes
refused with 429; each retries after 1 s and gets in.
- **cargo keeps a build whose source got an older mtime**: a script that