16 lines
1.0 KiB
Markdown
16 lines
1.0 KiB
Markdown
# n_signer API
|
||
|
||
The complete, authoritative API reference is now in [`README.md`](README.md) §4 (API).
|
||
|
||
It covers:
|
||
|
||
- **§4.1 Request format** — JSON-RPC 2.0-style request shape.
|
||
- **§4.2 Response format** — success/error shapes and the full error-code table.
|
||
- **§4.3 Verbs** — the verb table (positional params + options), the `scheme` option for secp256k1, and the enforcement matrix.
|
||
- **§4.4 Algorithms** — the algorithm table (secp256k1, ed25519, x25519, ml-dsa-65, slh-dsa-128s, ml-kem-768, otp), derivation paths, key sizes, and the OTP one-time-pad model.
|
||
- **§4.5 Examples** — worked request/response examples for every verb.
|
||
- **§4.6 Role-based selectors** — `nostr_index` / `role` / `role_path` for the `nostr_*` verbs.
|
||
- **§4.7 Pre-approval** — `--preapprove` syntax for algorithm-based and Nostr verbs.
|
||
|
||
For the security model, transports, and operational behavior, see [`README.md`](README.md) §1–§3 and §5–§8. For the migration plan from the legacy verb names, see [`plans/legacy_verb_aliases.md`](plans/legacy_verb_aliases.md).
|