mirror of
https://github.com/PR0M3TH3AN/bitlogin.git
synced 2026-10-27 08:31:21 +00:00
Claude
9408fef484
Preparing to open the project up beyond this repo's own use: - LICENSE: MIT, and a "license": "MIT" field on the root and all three workspace package.json files. - CONTRIBUTING.md: dev workflow, the mock-relay testing setup (most sandboxes/CI have no route to public Nostr relays, and registration needs a 2-of-N ack quorum so a single mock relay always fails), the spec-first process for anything touching wire format or crypto (docs/spec.md is canonical; speculative ideas go in their own doc, not the spec), and stricter expectations for crypto/key-handling changes. - SECURITY.md: private vulnerability disclosure via GitHub's advisory flow rather than public issues, given this handles private keys and password-derived secrets client-side; states current audit status plainly (none yet). - README: short "Contributing" section pointing at all three. Co-Authored-By: Claude <[email protected]> Claude-Session: https://claude.ai/code/session_01GWJbXXhvTx9wo59jSz57J6
107 lines
4.7 KiB
Markdown
107 lines
4.7 KiB
Markdown
# Contributing to BitLogin
|
|
|
|
Thanks for taking a look. BitLogin is a small monorepo — read this before your
|
|
first PR, it'll save you a round trip.
|
|
|
|
## Layout
|
|
|
|
See `README.md` for the full package breakdown. In short: `packages/core` is
|
|
the framework-free protocol implementation (crypto, capsules, Nostr relay
|
|
I/O, account flows), `packages/widget` is the `<bitlogin-auth>` custom
|
|
element and its crypto Web Worker, and `packages/demo` is the static site
|
|
that consumes both.
|
|
|
|
## Getting started
|
|
|
|
```bash
|
|
npm install
|
|
npm test # runs @bitlogin/core's vitest suite
|
|
npm run typecheck # tsc -b for core, tsc --noEmit for widget
|
|
npm run build # builds core, then widget
|
|
```
|
|
|
|
If you edit `packages/core` and a downstream typecheck seems stale (TS
|
|
happily reports success against old `.d.ts` output), delete the incremental
|
|
build cache and rebuild:
|
|
|
|
```bash
|
|
rm -f packages/core/tsconfig.tsbuildinfo packages/widget/tsconfig.tsbuildinfo
|
|
npm run build -w @bitlogin/core && npm run typecheck -w @bitlogin/widget
|
|
```
|
|
|
|
## Testing without a real Nostr relay
|
|
|
|
Most sandboxes (and CI) have no route to public Nostr relays. Protocol-level
|
|
tests instead run against an in-memory mock relay,
|
|
`packages/core/src/test-support/mockRelay.ts` — a minimal WebSocket server
|
|
implementing enough of NIP-01 (EVENT/REQ/CLOSE/OK, addressable/replaceable
|
|
replacement semantics) for real round trips: register → publish → login from
|
|
a "clean device," phrase recovery, password rotation, relay-loss → replica
|
|
repair, and so on. New account-flow tests should follow the existing pattern
|
|
in `packages/core/src/account/account.e2e.test.ts` — spin up 2-3 `MockRelay`
|
|
instances in `beforeEach`, close them in `afterEach` (registration/login
|
|
require a 2-of-N acknowledgement quorum by default, so a single mock relay
|
|
will fail every write).
|
|
|
|
For widget/UI changes, there's no equivalent automated browser suite yet —
|
|
verify manually against the built widget in a real browser (Chromium is
|
|
fine) pointed at a locally started `MockRelay` instance via the
|
|
`vault-relays`/`discovery-relays` attributes, since real relays aren't
|
|
reachable from most contributor sandboxes either.
|
|
|
|
## The spec is canonical
|
|
|
|
`docs/spec.md` (currently v0.3) is the source of truth for the protocol
|
|
itself — wire formats, KDF parameters, capsule structure, derivation paths,
|
|
threat model. Code comments reference it by section (`§11.2`, `§17.4`, …).
|
|
|
|
If a change affects anything the spec describes — a new capsule field, a
|
|
derivation change, a new recovery path — update `docs/spec.md` in the same
|
|
PR, not after the fact. Purely additive widget/UI features that don't touch
|
|
wire format or crypto (a new screen, a UX fix) don't need a spec change.
|
|
Speculative/future ideas that aren't decided yet belong in a separate doc
|
|
(see `docs/second-factor.md` and `docs/future-recovery-options.md` for the
|
|
pattern: proposal + pros/cons, explicitly marked as not implemented) rather
|
|
than in the spec itself.
|
|
|
|
## Working on cryptography or key handling
|
|
|
|
This code touches private keys and password-derived secrets, so changes
|
|
here get held to a higher bar than typical UI work:
|
|
|
|
- Prefer the audited libraries already in use (`@noble/curves`,
|
|
`@noble/hashes`, `@noble/ciphers`, `@scure/bip39`, native WebCrypto,
|
|
`hash-wasm`) over adding a new dependency or hand-rolled primitive.
|
|
- Private keys and passwords must never be logged, persisted in plaintext,
|
|
or held in memory longer than the operation needs (`§11.10`). In the
|
|
widget, they must never leave the crypto Web Worker — the main thread
|
|
only ever sees public keys, signed events, and ciphertext.
|
|
- If you're changing KDF parameters, encryption modes, or derivation paths,
|
|
explain why in the PR description, not just what — these are exactly the
|
|
kind of change that's cheap to review now and expensive to unwind once
|
|
real accounts depend on it.
|
|
- Add or update test vectors (`packages/core/src/crypto/crypto.test.ts`) for
|
|
any primitive-level change.
|
|
|
|
## Reporting a security vulnerability
|
|
|
|
Don't open a public issue for a suspected vulnerability in the crypto,
|
|
capsule handling, or key custody — see `SECURITY.md` for the private
|
|
disclosure process.
|
|
|
|
## Style
|
|
|
|
- TypeScript strict mode; `packages/core` stays framework- and DOM-free so
|
|
it can run in Node, a browser, or a worker.
|
|
- Comments explain *why*, not *what* — skip a comment if the code's already
|
|
clear without it.
|
|
- Match the existing code's structure rather than introducing a new
|
|
abstraction for something only used once.
|
|
|
|
## Pull requests
|
|
|
|
- Run `npm test` and `npm run typecheck` before opening a PR; both must
|
|
pass.
|
|
- Keep the description focused on *why*, not a restatement of the diff.
|
|
- Small, focused PRs review faster than one that bundles unrelated changes.
|