Initial Commit
This commit is contained in:
@@ -0,0 +1,47 @@
|
||||
---
|
||||
name: crypto-vault
|
||||
description: Use when implementing or debugging code that uses @suaveplan/crypto-vault: BIP39 mnemonic, Argon2id-locked vault, and chain signer for @suaveplan/crypto — deterministic HD key derivation, zeroize-on-lock, typed events.
|
||||
---
|
||||
|
||||
# @suaveplan/crypto-vault
|
||||
|
||||
BIP39 mnemonic management, Argon2id-hardened hierarchical key derivation, and multi-algorithm signing registry for the Suaveplan platform. The `Vault` class generates or imports a 12/15/18/21/24-word BIP39 mnemonic, unlocks it into a locked/unlocked state machine, derives named signing keys from HD paths (`m/signing/0`, `m/auth/0`, etc.) using either Ed25519 or ECDSA-P256, and zeroizes all key material on `lock()`. The `ChainSigner` is a standalone multi-key registry that associates named keys with signing algorithms for multi-signature workflows. Events (unlock/lock/derive/sign) are emitted via `@suaveplan/events` for audit trails. This package sits above `@suaveplan/crypto-keys` (raw keypair generation) and `@suaveplan/crypto` (primitive operations) — use it when you need mnemonic-seeded key hierarchies, not just raw keypairs.
|
||||
|
||||
## When to use this skill
|
||||
|
||||
- Implementing or debugging code that imports `@suaveplan/crypto-vault`.
|
||||
- The task touches: see package README.
|
||||
- You need API guidance for this package's exports.
|
||||
|
||||
## Quick reference
|
||||
|
||||
```ts
|
||||
import { /* see API Reference below */ } from "@suaveplan/crypto-vault";
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Workspace dependencies: `@suaveplan/crypto`, `@suaveplan/crypto-hash`, `@suaveplan/crypto-keys`, `@suaveplan/error`, `@suaveplan/events`, `@suaveplan/types`
|
||||
|
||||
## Where to read more
|
||||
|
||||
This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:
|
||||
|
||||
1. **`packages/crypto/crypto-vault/README.md`** — overview, install, quick-start, module index
|
||||
2. **`packages/crypto/crypto-vault/src/**/*.md`** — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
|
||||
3. **`packages/crypto/crypto-vault/package.json`** `exports` map — every subpath you can import from
|
||||
|
||||
When the user asks an API question, read the relevant co-located `.md` first; do not answer from training-data memory.
|
||||
|
||||
## See also
|
||||
|
||||
- `@suaveplan/crypto`
|
||||
- `@suaveplan/crypto-hash`
|
||||
- `@suaveplan/crypto-keys`
|
||||
- `@suaveplan/error`
|
||||
- `@suaveplan/events`
|
||||
- `@suaveplan/types`
|
||||
|
||||
---
|
||||
|
||||
_This SKILL.md is auto-generated by `suaveplan-skills/scripts/generate-skills.ts` from the package's README. Do not edit by hand — re-run the generator after the README changes._
|
||||
Reference in New Issue
Block a user