RogueWave
c20094ab56
pnpm + TypeScript workspace per design doc §13:
- apps/{web,api,worker} skeletons (Next.js 16, Fastify 5, BullMQ)
- packages/{core,solana,prometheus,db,config} (core has real types/DTOs;
solana/prometheus are stubs)
- programs/pyre-core placeholder (future Anchor, v1.0)
- docs/: PYRE_MVP_DESIGN (canonical), ARCHITECTURE, SECURITY, TOKEN_CLASSIFICATION
- CLAUDE.md, README, .env.example (no private-key var by design)
Skeleton + docs only — no Solana/business logic yet. All workspaces typecheck clean.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
33 lines
1.2 KiB
Markdown
33 lines
1.2 KiB
Markdown
# @pyre/core
|
|
|
|
Shared types and business logic for PYRE / Prometheus Protocol.
|
|
|
|
## Purpose
|
|
|
|
The canonical home for cross-cutting type definitions and (eventually) pure
|
|
business logic shared by `apps/*` and the other `packages/*`. Per §13 its
|
|
responsibilities are:
|
|
|
|
- **Classification enums** — `TokenClassification` (§6).
|
|
- **Risk rules** — conservative safety-rule types/constants (§7). _Placeholder._
|
|
- **Shared DTOs** — request/response shapes for the HTTP API (§14).
|
|
- **Receipt schema** — `CleanupReceipt` (§8, §15).
|
|
- **Prometheus I/O schema** — `PrometheusInput` / `PrometheusOutput` (§9).
|
|
|
|
This package carries **real type definitions** but **no application logic** in
|
|
the skeleton.
|
|
|
|
## Modules
|
|
|
|
- `src/classification.ts` — `TokenClassification` enum.
|
|
- `src/dto.ts` — API request/response DTOs.
|
|
- `src/receipt.ts` — cleanup receipt schema.
|
|
- `src/prometheus.ts` — Prometheus meta-mixer input/output.
|
|
- `src/risk.ts` — risk-rule placeholder.
|
|
|
|
## TODO
|
|
|
|
- Define concrete risk-rule identifiers, threshold shapes, and pure evaluators.
|
|
- Tighten DTO shapes flagged `TODO` once the scan/classify/build pipeline lands.
|
|
- Define the concrete token `metadata` JSON shape used by receipts and Prometheus.
|