diff --git a/Cargo.toml b/Cargo.toml index a27eef2..4babf5c 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -6,7 +6,7 @@ resolver = "3" members = ["crates/ksp-app-config-desk", "crates/ksp-config-lib", "crates/ksp-core-lib", "crates/ksp-logging-lib"] [workspace.package] -version = "0.2.0-pre.1" +version = "0.2.0-pre.2" edition = "2024" license = "MIT" repository = "https://git.sasedev.com/Sasedev/khadhroony-solana-project" diff --git a/ROADMAP.md b/ROADMAP.md index a873c9e..aa215cf 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -1,11 +1,9 @@ - + # Roadmap KSP -Le roadmap décrit les objectifs à atteindre et les grandes étapes prévues pour y parvenir. Une série `X.Y.x` regroupe une famille fonctionnelle de travaux ; elle peut contenir plusieurs releases concrètes et plusieurs sessions. - -Les décisions architecturales négatives ou de prudence n'apparaissent pas comme des tâches à cocher. Elles sont conservées dans les règles et documents d'architecture. +Le roadmap décrit les objectifs à atteindre et les grandes étapes prévues. Une série `X.Y.x` regroupe une famille fonctionnelle ; chaque release concrète reste une unité de développement/session distincte. ## Légende @@ -15,6 +13,13 @@ Les décisions architecturales négatives ou de prudence n'apparaissent pas comm - `[C]` — annulé ; - `[R]` — reporté. +## Discipline de livraison + +- Une prerelease vise environ **15 à 20 minutes de travail effectif**. +- Une release concrète doit être dimensionnée pour pouvoir être ouverte et clôturée dans **une seule session de chat**. +- Si `pre.001` révèle qu'une release est trop grosse, elle est scindée avant implémentation fonctionnelle lourde. +- À partir des couches Program/Decode, KSP progresse verticalement groupe par groupe plutôt que par grandes vagues horizontales de decoders/materializers/executors séparés. + ## 0.0.x — Fondation - [X] `0.0.1` — Initialiser le dépôt. @@ -25,99 +30,125 @@ Les décisions architecturales négatives ou de prudence n'apparaissent pas comm ## 0.1.x — Fondations N1 -### Objectifs +- [X] `0.1.1` — `ksp-core-lib` : Error/Result, Program IDs fondamentaux et primitives N1. +- [X] `0.1.2` — `ksp-logging-lib` : façade KSP de tracing. +- [X] `0.1.3` — `ksp-config-lib` : documents, profils, environnement, persistence et adapters. +- [X] `0.1.4` — `ksp-app-config-desk` : première application Tauri de référence. -Regrouper les releases consacrées aux fondations N1. Chaque release concrète est une unité de développement/session distincte et commence par son propre `pre.001` de brainstorming/audit/planification. +## 0.2.x — Accès Solana, Wallet et contrats d'extension initiaux -### Releases concrètes +### Cadrage -- [X] `0.1.1` — Stabiliser `ksp-core-lib` : `Error`/`Result`, Program IDs fondamentaux et primitives réellement N1. -- [X] `0.1.2` — Introduire `ksp-logging-lib` comme façade KSP de `tracing`, `tracing-appender` et `tracing-subscriber`. -- [X] `0.1.3` — Stabiliser `ksp-config-lib` : documents, profils, résolution, validation, environnement KSP/KSPB, management/persistence et adapter Logging. -- [X] `0.1.4` — Introduire `ksp-app-config-desk` pour valider réellement Config et la frontière Tauri. +- [/] `0.2.0` — Auditer bot3, fixer l'ordre de `0.2.x`, actualiser l'architecture et préparer `0.2.1`. +- [X] `0.2.0-pre.001` — Méthode d'audit, cartographie initiale et matrice provisoire. +- [/] `0.2.0-pre.002` — Fixer l'ordre fonctionnel, la discipline de sizing, le pipeline RAW/CORE/DECODE/SPECIALIZED et préparer le prompt `0.2.1`. -`0.1.1`, `0.1.2`, `0.1.3` et `0.1.4` sont désormais stables. `0.1.4` publie `ksp-app-config-desk` comme première validation desktop/Tauri de Config et modèle de référence des futures applications Tauri KSP. La prochaine session est `0.2.0`, release intermédiaire d’audit de `khadhroony-bot3` et de planification du reste de `0.2.x`. +### Releases fonctionnelles décidées/pressenties -Les contrats publics supplémentaires ne sont introduits que lorsqu'une release concrète en démontre le besoin. +- [ ] `0.2.1` — Introduire `ksp-onchain-transport-lib` avec HTTP Solana/JSON-RPC, settings publics, document Config standard + adapter, pools, rôles, priorités, limites, retry/backoff et couverture complète de la documentation HTTP ciblée. +- [ ] `0.2.2` — Introduire `ksp-wallet-lib`, le format `.kspwallet`, la gestion sûre des secrets et une architecture d'import/export extensible ; exclure `WalletPolicy`. +- [ ] `0.2.3` — Introduire `ksp-app-wallet-desk` utilisant Config composite + Wallet + transport HTTP, notamment pour afficher l'identité et le solde d'un wallet. +- [ ] `0.2.4` — Étendre `ksp-onchain-transport-lib` au WebSocket Solana standard complet ; permettre plusieurs sessions sur une même URL sans imposer encore un pool automatique complexe. +- [ ] `0.2.5` — Ajouter Helius LaserStream WebSocket comme extension du moteur WebSocket standard, sans duplication de client. +- [ ] `0.2.6` — Ajouter une première fondation Yellowstone gRPC standard/provider-neutral ; dimensionner la surface exacte à `pre.001` selon la documentation normative actuelle. +- [ ] `0.2.7` — Introduire `ksp-offchain-transport-lib` avec un premier lecteur de prix, au minimum SOL/USD et SOL/EUR. +- [ ] `0.2.8` — Introduire une petite application desk de visualisation des prix. +- [ ] `0.2.9` — Introduire la première surface de `ksp-interface-lib`, comprenant une API wire publique utilisable par les implémentations officielles et externes. +- [ ] `0.2.10` — Introduire `ksp-program-api` comme premier contrat Program extensible, sans imposer encore `ksp-program-lib` complet. -## 0.2.x — Accès Solana et fondation programmes +### Règles Transport pour toute la série -### Release de cadrage `0.2.0` +- [ ] Couvrir toutes les méthodes/opérations documentées pour la surface normative ciblée par chaque release. +- [ ] Conserver les méthodes deprecated/obsolete encore fonctionnelles et émettre un `warn` KSP lors de leur utilisation. +- [ ] Implémenter les méthodes unstable/experimental ciblées et émettre un `warn` KSP lors de leur utilisation. +- [ ] Centraliser la metadata de statut des méthodes plutôt que disperser des warnings ad hoc. +- [ ] Garder `ksp-onchain-transport-lib` indépendant de `ksp-config-lib`, du Store et des modèles Program/métier. -- [/] `0.2.0` — Auditer les fonctionnalités pertinentes de `khadhroony-bot3`, décider ce qui doit être repris, refondu, abandonné ou ajouté dans KSP, puis découper et ordonner les releases fonctionnelles restantes de `0.2.x`. +## Architecture de données — progression canonique -`0.2.0` est une release intermédiaire de transition et de planification de série. Elle ne doit pas démarrer par l'implémentation arbitraire d'un composant N2 : elle établit d'abord la cartographie fonctionnelle, les écarts avec KSP, les dépendances, les contrats à préserver ou redéfinir et le découpage concret de `0.2.1`, `0.2.2`, etc. +La chaîne durable cible est : -`0.2.0-pre.001` ouvre ce travail avec la méthode d'audit, une première cartographie de Wallet/Transport/Interface/Program/Execution/scenarios et une matrice initiale. Aucun numéro `0.2.1+` n'est encore figé ; le plan actif est `docs/plans/007-V0_2_0_SERIES_PLANNING.md`. +```text +RAW -> CORE -> DECODE -> SPECIALIZED +``` -### Capacités à répartir dans les releases fonctionnelles suivantes +- **RAW** et **CORE** ne nécessitent aucun décodage Program. +- À la fin de chaque couche horizontale RAW/CORE, ajouter les jobs/workers/apps nécessaires pour la rendre réellement exploitable avant d'ouvrir la couche suivante. +- À partir de **DECODE**, avancer verticalement groupe par groupe : wire -> decode -> matérialisation -> projection spécialisée si utile -> préparation d'exécution -> policy -> execution -> scénarios Devnet. -- [ ] Introduire `ksp-onchain-transport-lib` avec des modèles de transport homogènes indépendants du store. -- [ ] Introduire `ksp-wallet-lib` et `ksp-app-wallet-desk`. -- [ ] Développer la première surface utile de `ksp-interface-lib`. -- [ ] Introduire `ksp-program-api` puis `ksp-program-lib`. -- [ ] Définir `ksp-execution-policy-api` comme contrat de policy commun à plusieurs contextes. -- [ ] Introduire `ksp-execution-lib` lorsque le premier cycle d'exécution réel justifie l'orchestration programme/policy/wallet/transport. -- [ ] Introduire `ksp-offchain-transport-lib` seulement au premier besoin réel. +## 0.3.x — RAW / acquisition persistée -## 0.3.x — Données, stockage et acquisition raw +- [ ] `0.3.1` — Introduire `ksp-store-api` + `ksp-store-lib` avec PostgreSQL de référence et **modèles/persistence RAW uniquement**. +- [ ] `0.3.2` — Étendre `ksp-interface-lib` avec les wires génériques nécessaires aux acquisitions et à la future normalisation CORE. +- [ ] `0.3.3` — Introduire `ksp-job-api` et un job de backfill historique concret. +- [ ] `0.3.4` — Introduire une application spécialisée de backfill/inspection RAW. +- [ ] Compléter ensuite la couche RAW avec le worker/service live, son contrôle et les outils d'exploitation réellement nécessaires avant de passer à CORE. -- [ ] Introduire `ksp-materializer-api` / `ksp-materializer-lib`. -- [ ] Introduire `ksp-store-api` / `ksp-store-lib` avec PostgreSQL de référence. -- [ ] Établir les niveaux durables D1 Raw, D2 Core, D3 journal de matérialisation générique et D4 projections de domaine. -- [ ] Garantir des replays indépendants D1 -> D2, D2 -> D3 et D3 -> D4. -- [ ] Introduire `ksp-app-store-desk`. -- [ ] Introduire `ksp-worker-api` et `ksp-worker-raw-retriever`. -- [ ] Introduire `ksp-worker-control-lib` lorsque le manager W1 crée le premier besoin concret. -- [ ] Introduire `ksp-job-api` et `ksp-job-backfill`. -- [ ] Introduire les pipelines spécialisés raw ingestion, Core processing, generic materialization et domain projection lorsque leurs premières frontières fonctionnelles sont développées. -- [ ] Introduire les jobs de replay indépendants D1 -> D2, D2 -> D3 et D3 -> D4. -- [ ] Normaliser les notifications de données persistées indépendamment de leur producteur et conserver le Store comme source de vérité du backlog. -- [ ] Mettre en place claim/lease, outcomes durables et reprise après crash pour les traitements concurrents. +## Série CORE suivante -## 0.4.x — Baseline Solana, SPL et metadata +- [ ] Définir la persistence CORE canonique Solana générique. +- [ ] Implémenter `RAW -> CORE` sans decoder Program : blocs, slots, signatures, transactions/messages, comptes, instructions/CPI brutes, logs/meta et relations structurelles. +- [ ] Ajouter replay/backfill RAW -> CORE. +- [ ] Ajouter worker/service CORE. +- [ ] Ajouter l'application de contrôle/inspection CORE utile. -- [ ] Ajouter progressivement les decoders et `ProgramExecutionPreparer` Core/SPL nécessaires. -- [ ] Ajouter Token, Token-2022, ATA et metadata utiles. -- [ ] Introduire `ksp-offchain-transport-lib` au plus tard au premier besoin externe. -- [ ] Ajouter materializers et jobs ponctuels nécessaires. -- [ ] Ajouter les crates `ksp-scenario--lib` spécialisées. -- [ ] Ajouter les demos `ksp-app-scenario---desk-demo` correspondantes. -- [ ] Garder Memo, Token, ATA, Token-2022 séparés ; regrouper uniquement Metaplex Token Metadata + Token-2022 Metadata dans la famille metadata ; garder SPM séparé. +## Séries DECODE/SPECIALIZED/EXECUTION — progression verticale -## 0.5.x — Anchor et protocoles trading +### Priorité 1 — Solana Core Programs -- [ ] Introduire Anchor. -- [ ] Étendre Meteora par surfaces bornées. -- [ ] Étendre Raydium par surfaces bornées. -- [ ] Ajouter progressivement Pump, Orca, Jupiter, OKX et autres intégrations utiles. -- [ ] Ajouter interfaces, program implementations, materializers, jobs/scénarios/demos nécessaires pour chaque surface. +- [ ] Wire/decoding des programmes Core nécessaires transversalement. +- [ ] Matérialisation et projections utiles. +- [ ] Préparation d'exécution, policy et scénarios Devnet pour les opérations retenues. -## 0.6.x — Processing autonome et orchestration +### Priorité 2 — SPL token/trading -- [ ] Introduire `ksp-worker-core-processor` pour D1 Raw -> D2 Core canonique. -- [ ] Introduire `ksp-worker-generic-materializer` pour D2 Core -> D3 journal de matérialisation générique. -- [ ] Introduire `ksp-worker-domain-projector` pour D3 -> D4 projections spécialisées ; nom révisable. -- [ ] Exploiter les mêmes pipelines spécialisés pour les workers live et les jobs de replay afin d'éviter la duplication des frontières de processing. -- [ ] Étendre `ksp-worker-control-lib` à la gouvernance de plusieurs workers autonomes. -- [ ] Fournir pour chaque worker un mode service autonome, avec logique réutilisable séparée du binaire d'enveloppe. -- [ ] Construire d'abord les applications spécialisées nécessaires au développement, test et exploitation de chaque capacité. -- [ ] Garder jobs et workers sous des lifecycle APIs séparées. +- [ ] SPL Token. +- [ ] Associated Token Account. +- [ ] Token-2022 et extensions pertinentes. +- [ ] Pour chaque famille : decode -> materialize -> specialized -> prepare -> policy -> execute -> scenarios. -## 0.7.x — Trading Intelligence +### Priorité 3 — Metadata token -- [ ] Statistiques et métriques. -- [ ] Features et datasets historiques. -- [ ] Signaux et risque. +- [ ] Metaplex Token Metadata. +- [ ] Token-2022 Metadata. +- [R] Solana Program Metadata (SPM) — redéveloppement plus tard avec le décodage généraliste. + +### Priorité 4 — Anchor + +- [ ] Introduire les contrats et mécanismes Anchor nécessaires aux protocoles trading suivants. + +### Priorité 5 — DEX à fort intérêt + +- [ ] Meteora, y compris vaults/fees/positions/états auxiliaires nécessaires à son groupe. +- [ ] Raydium, y compris programmes satellites nécessaires. +- [ ] Pump, y compris fee program et composants launch/bonding/pool nécessaires. +- [ ] Orca, y compris programmes satellites nécessaires. +- [ ] Chaque groupe est terminé verticalement avant de devenir secondaire au profit du suivant. + +### Market Desk V1 + +- [ ] Après les premiers groupes Meteora/Raydium/Pump/Orca, introduire une petite `ksp-app-market-desk` spécialisée. +- [ ] Visualiser tokens, pools/markets, liquidité, swaps/trades, prix, volumes, OHLC/candles et activité live/récente lorsque disponible. +- [ ] Lire les projections SPECIALIZED KSP ; ne pas reconstruire la logique protocolaire dans l'UI. + +### Routing + +- [ ] Jupiter. +- [ ] OKX et autres routeurs selon besoin réel. +- [ ] Enrichir Market Desk avec routes, legs, DEX impliqués, fees/slippage et comparaison quote/execution lorsque disponible. + +### Trading-adjacent puis décodage généraliste + +- [ ] Ajouter ensuite les programmes indépendants utiles au trading : oracles, locks/vesting indépendants, lifecycle token, risk/signaux, etc. +- [ ] Ne jamais y repousser un satellite appartenant à un groupe DEX déjà ciblé. +- [ ] Étendre enfin le décodage au reste de Solana selon valeur fonctionnelle. + +## Trading Intelligence et produits ultérieurs + +- [ ] Statistiques/features/datasets historiques. +- [ ] Signaux, risque, anomalies et patterns. - [ ] Replay analytique/backtests. -- [ ] Patterns/anomalies. -- [ ] XGBoost puis autres modèles lorsque les contrats sont stables. - -## 0.8.x et suivantes — Trading opérationnel et expansion produits - -- [ ] Construire les couches puis l'application de trading monoposte au-dessus de Trading Intelligence. -- [ ] Étendre l'automatisation de trading. -- [ ] Étendre continuellement Program IDs, decoders, execution preparers et materializers. -- [ ] Construire progressivement l'explorer Solana. -- [ ] Construire progressivement l'explorer/analyse DEX. -- [ ] Étudier plus tard d'autres applications utilisant `ksp-wallet-lib`, notamment mobile, extensions navigateur et web. +- [ ] XGBoost puis autres modèles lorsque les données et contrats sont stables. +- [ ] Construire ensuite les produits de trading opérationnel au-dessus de ces couches. +- [ ] Faire évoluer Market Desk vers davantage d'analyse sans la confondre avec l'application globale ou l'orchestrateur. +- [ ] Étudier plus tard les autres applications Wallet : mobile, extensions navigateur et web. diff --git a/deltas/0.2.0/pre.002.md b/deltas/0.2.0/pre.002.md new file mode 100644 index 0000000..0f9ee7d --- /dev/null +++ b/deltas/0.2.0/pre.002.md @@ -0,0 +1,195 @@ + + + +# Delta `0.2.0-pre.002` + +## Identité + +```text +release : 0.2.0 +prerelease : pre.002 +identifiant de commit attendu : v0.2.0-pre.002 +workspace.package.version : 0.2.0-pre.2 +base : 0.2.0-pre.001 +``` + +Cette livraison est une **nouvelle tranche planifiée** et non un `pre.001-fix.001` : `pre.001` avait volontairement laissé le découpage `0.2.1+` ouvert. `pre.002` ajoute de nouvelles décisions de planification/architecture issues de l'audit et du brainstorming suivants. + +## Mission + +Consolider le plan de série `0.2.x`, fixer la première séquence fonctionnelle, corriger l'ancienne ambiguïté D1/D2 liée au décodage Program, établir la progression `RAW -> CORE -> DECODE -> SPECIALIZED`, formaliser la discipline de sizing d'une release/session et préparer un prompt de démarrage complet pour `0.2.1`. + +Aucune capacité Solana runtime N2 n'est implémentée dans cette tranche. + +## Décisions principales + +### Dimensionnement + +- une prerelease vise environ 15–20 minutes de travail effectif ; +- une release concrète doit être entièrement clôturable dans une seule session de chat ; +- si `pre.001` révèle un risque de dépassement, la release est scindée avant implémentation fonctionnelle lourde. + +### Début de `0.2.x` + +```text +0.2.1 HTTP Solana foundation +0.2.2 ksp-wallet-lib / .kspwallet +0.2.3 ksp-app-wallet-desk +0.2.4 standard WebSocket +0.2.5 Helius LaserStream WebSocket +0.2.6 Yellowstone gRPC standard foundation +0.2.7 off-chain price transport +0.2.8 price desk +0.2.9 ksp-interface-lib foundation +0.2.10 ksp-program-api foundation +``` + +HTTP précède Wallet afin que Wallet Desk puisse être validé avec un solde réseau réel. + +### Transport + +- `ksp-onchain-transport-lib` possède ses settings publics et ne dépend pas de Config ; +- `ksp-config-lib` peut fournir un document standard Transport et un adapter Config -> Transport ; +- pools/rôles/priorités/limites HTTP sont retenus ; +- toute méthode documentée de la surface normative ciblée doit être inventoriée/implémentée sauf impossibilité documentée ; +- une méthode deprecated/obsolete encore fonctionnelle émet un warning KSP à l'utilisation ; +- une méthode unstable/experimental émet également un warning KSP ; +- WebSocket autorise plusieurs sessions sur une même URL mais n'impose pas encore un pool automatique ; +- Helius WS réutilise le moteur standard ; +- Yellowstone reste provider-neutral dans sa première version ; +- providers avancés/shred streams sont reportés dans IDEAS. + +### Wallet + +- format natif KSP : `.kspwallet` ; +- temporary wallet JSON historique abandonné ; +- `WalletPolicy` sort de Wallet et relève de la future execution policy ; +- import/export reste extensible, formats supplémentaires suivis dans IDEAS. + +### Interface / Program / Policy + +- `ksp-interface-lib` expose sa propre API publique wire ; pas de `ksp-interface-api` séparée actuellement ; +- nomenclature confirmée : `ksp-program-api` / `ksp-program-lib` ; +- `ksp-execution-policy-api` reste le contrat commun ; petites policies locales dans scenarios/orchestrateurs, libs communes uniquement si réutilisation réelle. + +### Données + +La chaîne durable devient explicitement : + +```text +RAW -> CORE -> DECODE -> SPECIALIZED +``` + +- RAW et CORE ne nécessitent aucun decoder Program ; +- CORE est une normalisation générique Solana ; +- Program decoding commence à CORE -> DECODE ; +- à partir de DECODE, progression verticale groupe par groupe. + +### Groupes Program + +Ordre prioritaire : + +```text +Solana Core Programs +-> SPL token/trading +-> token metadata +-> Anchor +-> Meteora +-> Raydium +-> Pump +-> Orca +-> Market Desk V1 +-> Jupiter/OKX routing +-> Market Desk V2 +-> trading-adjacent +-> general decoding +``` + +Les programmes satellites nécessaires restent dans leur groupe : Meteora vaults avec Meteora, Pump fee avec Pump, etc. + +### Market Desk + +Une première `ksp-app-market-desk` est prévue après les DEX prioritaires pour afficher notamment tokens, pools, liquidity, trades, prix et OHLC. Elle est enrichie après routing avec routes/legs/fees/slippage/quote-execution. + +## Fichiers modifiés + +```text +Cargo.toml +ROADMAP.md +docs/000-README.md +docs/IDEAS.md +docs/architecture/002-LAYERS_AND_DEPENDENCIES.md +docs/architecture/003-COMPONENT_CONTRACTS.md +docs/architecture/004-COMPONENT_INVENTORY.md +docs/architecture/005-DEPENDENCY_GRAPH.md +docs/architecture/006-WIRE_AND_PROGRAM.md +docs/architecture/007-EXECUTION_AND_POLICY.md +docs/architecture/008-DATA_MATERIALIZATION_AND_STORE.md +docs/architecture/009-ACQUISITION_WORKERS_AND_JOBS.md +docs/architecture/010-APPS_SERVICES_SCENARIOS_AND_CONTROL.md +docs/plans/000-README.md +docs/plans/001-V0_0_3_PLAN.md +docs/plans/002-FUNCTIONAL_RELEASE_SEQUENCE.md +docs/plans/007-V0_2_0_SERIES_PLANNING.md +docs/rules/PROMPT_STRUCTURE.md +docs/rules/RULES_DEPENDENCIES.md +docs/rules/RULES_KSP.md +prompts/000-README.md +``` + +## Fichier ajouté + +```text +prompts/006-V0_2_1_START_PROMPT.md +``` + +Le prompt `0.2.1` impose notamment : + +- audit bot3 précis ; +- consultation des sources officielles Solana actuelles ; +- matrice exhaustive des méthodes HTTP ; +- classification stable/deprecated/unstable ; +- warnings runtime appropriés ; +- ownership Config/Transport ; +- pools/rôles/limites ; +- tests/canaries ; +- gate de sizing avant grosse implémentation ; +- préparation du futur plan `docs/plans/008-V0_2_1_ONCHAIN_HTTP_PLAN.md`. + +## Validations réalisées dans l'environnement d'échange + +- parsing TOML du `Cargo.toml` via Python `tomllib` ; +- contrôle de la version Cargo `0.2.0-pre.2` ; +- contrôle des en-têtes `` / `` des fichiers modifiés ; +- contrôle des fences Markdown équilibrées ; +- contrôle des liens Markdown locaux des fichiers modifiés ; +- recherche de contradictions actives principales (`ksp-program-api-lib`, ancienne dépendance Program dans RAW -> CORE, anciennes chaînes de workers/pipelines figées) ; +- annotation explicite du plan historique `0.0.3` pour distinguer ses anciennes décisions des règles désormais actives ; +- contrôle de l'archive d'échange et calcul SHA-256. + +## Validations non exécutables dans cet environnement + +Le conteneur d'échange ne fournit ni `cargo` ni `rustc`. Les commandes Rust doivent donc être exécutées après application sur le dépôt canonique : + +```bash +cargo fmt --all +cargo check --workspace +cargo clippy --workspace --all-targets +cargo test --workspace +``` + +Aucune de ces commandes n'est déclarée réussie dans ce delta. + +## Commit attendu + +Après application et validations sur le dépôt canonique : + +```text +v0.2.0-pre.002 +``` + +Conformément aux règles KSP, ce commit de prerelease ne reçoit pas de tag Git stable. + +## Suite + +Le travail restant de `0.2.0` est volontairement court : audit de cohérence final, correction des écarts documentaires restants, finalisation du prompt `0.2.1`, puis publication `0.2.0-rel.001` lorsque le cadrage est validé. diff --git a/docs/000-README.md b/docs/000-README.md index 5350098..6ea785d 100644 --- a/docs/000-README.md +++ b/docs/000-README.md @@ -1,5 +1,5 @@ - + # Documentation KSP @@ -59,7 +59,7 @@ D'autres sous-répertoires seront ajoutés uniquement lorsque leur rôle aura é ## Documents de planification -Le plan historique de la phase fondatrice clôturée est conservé dans [`plans/001-V0_0_3_PLAN.md`](plans/001-V0_0_3_PLAN.md). La séquence active des premières releases fonctionnelles est définie dans [`plans/002-FUNCTIONAL_RELEASE_SEQUENCE.md`](plans/002-FUNCTIONAL_RELEASE_SEQUENCE.md). Le plan détaillé de la release stable `0.1.1` est conservé comme historique clôturé dans [`plans/003-V0_1_1_CORE_FOUNDATION_PLAN.md`](plans/003-V0_1_1_CORE_FOUNDATION_PLAN.md). Le plan détaillé de la release stable `0.1.2` est conservé comme historique clôturé dans [`plans/004-V0_1_2_LOGGING_FOUNDATION_PLAN.md`](plans/004-V0_1_2_LOGGING_FOUNDATION_PLAN.md). Le plan détaillé de la release stable `0.1.3 — Configuration foundation` est conservé comme historique clôturé dans [`plans/005-V0_1_3_CONFIG_FOUNDATION_PLAN.md`](plans/005-V0_1_3_CONFIG_FOUNDATION_PLAN.md). Le plan détaillé de la release stable `0.1.4 — ksp-app-config-desk` est conservé comme historique clôturé dans [`plans/006-V0_1_4_CONFIG_DESKTOP_PLAN.md`](plans/006-V0_1_4_CONFIG_DESKTOP_PLAN.md), avec sa matrice finale [`validation/001-V0_1_4_CONFIG_DESKTOP.md`](validation/001-V0_1_4_CONFIG_DESKTOP.md). Son prompt d'ouverture historique reste [`../prompts/004-V0_1_4_START_PROMPT.md`](../prompts/004-V0_1_4_START_PROMPT.md). La session active est `0.2.0`, ouverte par [`../prompts/005-V0_2_0_START_PROMPT.md`](../prompts/005-V0_2_0_START_PROMPT.md). Son plan directeur d'audit et de découpage de série est [`plans/007-V0_2_0_SERIES_PLANNING.md`](plans/007-V0_2_0_SERIES_PLANNING.md), créé par `0.2.0-pre.001`. +Le plan historique de la phase fondatrice clôturée est conservé dans [`plans/001-V0_0_3_PLAN.md`](plans/001-V0_0_3_PLAN.md). La séquence active des premières releases fonctionnelles est définie dans [`plans/002-FUNCTIONAL_RELEASE_SEQUENCE.md`](plans/002-FUNCTIONAL_RELEASE_SEQUENCE.md). Le plan détaillé de la release stable `0.1.1` est conservé comme historique clôturé dans [`plans/003-V0_1_1_CORE_FOUNDATION_PLAN.md`](plans/003-V0_1_1_CORE_FOUNDATION_PLAN.md). Le plan détaillé de la release stable `0.1.2` est conservé comme historique clôturé dans [`plans/004-V0_1_2_LOGGING_FOUNDATION_PLAN.md`](plans/004-V0_1_2_LOGGING_FOUNDATION_PLAN.md). Le plan détaillé de la release stable `0.1.3 — Configuration foundation` est conservé comme historique clôturé dans [`plans/005-V0_1_3_CONFIG_FOUNDATION_PLAN.md`](plans/005-V0_1_3_CONFIG_FOUNDATION_PLAN.md). Le plan détaillé de la release stable `0.1.4 — ksp-app-config-desk` est conservé comme historique clôturé dans [`plans/006-V0_1_4_CONFIG_DESKTOP_PLAN.md`](plans/006-V0_1_4_CONFIG_DESKTOP_PLAN.md), avec sa matrice finale [`validation/001-V0_1_4_CONFIG_DESKTOP.md`](validation/001-V0_1_4_CONFIG_DESKTOP.md). Son prompt d'ouverture historique reste [`../prompts/004-V0_1_4_START_PROMPT.md`](../prompts/004-V0_1_4_START_PROMPT.md). La session active est `0.2.0`, ouverte par [`../prompts/005-V0_2_0_START_PROMPT.md`](../prompts/005-V0_2_0_START_PROMPT.md). Son plan directeur d'audit et de découpage de série est [`plans/007-V0_2_0_SERIES_PLANNING.md`](plans/007-V0_2_0_SERIES_PLANNING.md), créé par `0.2.0-pre.001` puis restructuré par `0.2.0-pre.002` autour de la séquence Transport HTTP -> Wallet -> transports live -> off-chain -> Interface/Program et de l'architecture RAW -> CORE -> DECODE -> SPECIALIZED. Le prompt préparatoire de la première release fonctionnelle est [`../prompts/006-V0_2_1_START_PROMPT.md`](../prompts/006-V0_2_1_START_PROMPT.md). `IDEAS.md` conserve les pistes et questions qui ne sont pas encore des engagements du roadmap ni des décisions architecturales. diff --git a/docs/IDEAS.md b/docs/IDEAS.md index e545cd0..1b32183 100644 --- a/docs/IDEAS.md +++ b/docs/IDEAS.md @@ -1,5 +1,5 @@ - + # Idées à explorer @@ -70,6 +70,14 @@ Définir avec les premières APIs réelles les conventions de nommage des traits Définir avec les premières crates fonctionnelles les conventions d'arborescence, façades `lib.rs`, modules API et réexports publics. +### API Interface séparée + +**Status :** Rejetée pour l'instant + +`ksp-interface-lib` expose sa propre API publique wire afin que des crates Program externes puissent expérimenter contre les mêmes contrats que les implementations officielles. + +Ne créer `ksp-interface-api` que si un futur problème réel de graphe de dépendances, de poids d'implémentation ou de publication démontre qu'un contrat séparé est nécessaire. La symétrie avec `ksp-program-api` n'est pas une justification suffisante. + ## Transport ### Modèles homogènes on-chain @@ -94,17 +102,44 @@ Réévaluer seulement si les premières implémentations montrent une duplicatio `ksp-offchain-transport-lib` regroupe metadata, prix, quotes, routage et autres accès externes afin d'éviter une explosion de crates. Il n'est pas nécessaire de leur inventer une API métier commune. +### Pool automatique de sessions WebSocket + +**Status :** À explorer après `0.2.4` + +Le contrat WebSocket doit autoriser plusieurs sessions physiques sur une même URL, chaque session portant plusieurs subscriptions. + +Ne pas implémenter automatiquement un scheduler/pool de sessions tant qu'un besoin réel de distribution de charge, quotas provider, isolation de flux ou reconnexion indépendante ne le justifie pas. + +### Providers Yellowstone avancés + +**Status :** À explorer après la fondation standard + +Candidats à intégrer ultérieurement par adapters/capabilities sans dupliquer le client Yellowstone générique : + +- Helius LaserStream gRPC ; +- Triton One / Dragon's Mouth ; +- ERPC ; +- Chainstack ; +- Shyft ; +- autres providers compatibles réellement utiles. + +Le choix dépendra des capacités, quotas, replay, authentification, prix et besoins opérationnels au moment de leur introduction. + +### Streaming pré-exécution / shreds + +**Status :** À explorer plus tard + +Conserver comme pistes séparées les offres pré-exécution/shred/deshred (Helius Shred Delivery, Triton/Yellowstone deshred, Shyft RabbitStream ou équivalents). Leur sémantique n'est pas identique à un flux exécuté Yellowstone standard et elles ne doivent pas être ajoutées comme simples aliases provider sans audit. + ## Workers et jobs ### Workers de processing -**Status :** Retenue +**Status :** Retenue, granularité révisée -Après `ksp-worker-raw-retriever`, les responsabilités de processing actuellement prévues sont séparées : +RAW et CORE peuvent disposer de workers dédiés à la fin de leur couche respective. -- `ksp-worker-core-processor` ; -- `ksp-worker-generic-materializer` ; -- `ksp-worker-domain-projector` (nom provisoire). +À partir de DECODE, ne pas figer à l'avance une chaîne globale `generic-materializer -> domain-projector` pour tout Solana : la granularité des workers/processors doit émerger des vertical slices Program réels et réutiliser les mêmes transformations que les jobs de replay correspondants. ### Worker control @@ -145,6 +180,24 @@ Le modèle de sécurité, la frontière Rust/WebAssembly/native et le stockage d Un wallet web/online utilisant les contrats KSP est envisagé. La gestion des secrets et le modèle de confiance devront être traités comme une question architecturale majeure avant développement. +### Formats Wallet import/export supplémentaires + +**Status :** À explorer avec `0.2.2` et après + +Le format natif KSP est `.kspwallet`. L'architecture d'import/export doit rester extensible, mais seules les conversions réellement nécessaires sont implémentées immédiatement. + +Formats/cibles à inventorier et prioriser selon usage réel : + +- Solana CLI keypair JSON ; +- keypair Base58 complet lorsque pertinent ; +- Phantom ; +- Solflare ; +- autres wallets logiciels Solana ; +- hardware wallets / standards de dérivation si un besoin apparaît ; +- migrations depuis formats historiques KSP/bot uniquement si utiles aux utilisateurs réels. + +Chaque format doit être étudié côté sécurité, round-trip, secret/public, dépendances et compatibilité avant engagement. + ## Pipelines ### Pas de pipeline monolithique @@ -276,6 +329,24 @@ Checkpoint/restart est nécessaire pour backfill/replay. Déterminer si pause/re Backlog count, oldest pending age, processing rate et failure rate doivent être observables. Décider plus tard si health/status + logging suffisent ou si une API/metrics exporter dédiée devient nécessaire. +### Market Desk évolutive + +**Status :** Transférée au roadmap + +Introduire une première `ksp-app-market-desk` après les groupes DEX prioritaires Meteora/Raydium/Pump/Orca, puis l'enrichir après Jupiter/OKX. + +Pistes futures au-delà de la V1/V2 : + +- profondeur/market microstructure si les sources le permettent ; +- indicateurs dérivés ; +- alertes/anomalies ; +- overlays de risk ; +- outputs XGBoost/ML ; +- comparaison de providers/latence ; +- vues replay historiques. + +Ces extensions restent séparées de l'application de trading opérationnel tant que leur responsabilité est l'observation/analyse. + ## Applications et orchestration futures ### Application globale de contrôle/exploitation @@ -318,8 +389,8 @@ Si cette capacité devient utile, l’intégration doit être conçue dans la pi ### Numérotation fine après `0.1.x` -**Status :** À décider à l'approche de chaque série +**Status :** Transférée au roadmap pour le début de `0.2.x` -`0.1.1` et `0.1.2` sont fixées ; `0.1.3` / `0.1.4` constituent la séquence par défaut sous réserve d'une éventuelle scission de Config. +`0.2.0-pre.002` fixe désormais le début concret `0.2.1 -> 0.2.10` sous réserve du gate de dimensionnement de chaque `pre.001`. -Pour `0.2.x+`, ne pas attribuer prématurément un numéro précis à chaque composant. L'ordre candidat est documenté dans `docs/plans/002-FUNCTIONAL_RELEASE_SEQUENCE.md` et sera converti en releases concrètes lorsque les dépendances et premiers cas d'usage de la série seront connus. +Les séries après RAW/CORE ne sont volontairement pas numérotées programme par programme à ce stade : la règle est de redécouper chaque vertical slice selon sa taille réelle et de ne jamais ouvrir une release qui ne peut pas être clôturée dans sa session. diff --git a/docs/architecture/002-LAYERS_AND_DEPENDENCIES.md b/docs/architecture/002-LAYERS_AND_DEPENDENCIES.md index d01a81d..cbbba90 100644 --- a/docs/architecture/002-LAYERS_AND_DEPENDENCIES.md +++ b/docs/architecture/002-LAYERS_AND_DEPENDENCIES.md @@ -1,202 +1,201 @@ - + # Couches et dépendances KSP -## Rôle des niveaux +## Rôle des niveaux architecturaux -Les niveaux N1 à N4 servent à raisonner sur les responsabilités, la stabilité et le sens des dépendances. Ils ne constituent pas une chaîne d'appels obligatoire. +Les niveaux architecturaux N1–N4 décrivent les familles de composants du projet. Ils ne doivent pas être confondus avec les niveaux durables D1–D4. -Les niveaux durables de données utilisent une nomenclature distincte **D1 à D4** afin de ne jamais être confondus avec les couches architecturales N1 à N4 : D1 Raw, D2 Core canonique, D3 journal de matérialisation générique et D4 projections spécialisées. +### N1 — Fondations communes -Une couche supérieure peut dépendre directement d'une bibliothèque KSP plus basse lorsque cette bibliothèque est exactement la propriétaire de la capacité recherchée. +- `ksp-core-lib` ; +- `ksp-logging-lib` ; +- `ksp-config-lib` ; +- premières règles/outils transversaux. -## N1 — Fondations - -N1 contient les contrats et services transversaux qui doivent rester bas dans le graphe de dépendances. - -Positionnement actuellement retenu : - -- `ksp-core-lib` — primitives et contrats fondamentaux réellement transversaux, type d'erreur commun KSP et responsabilité autrefois séparée des identifiants de programmes ; -- `ksp-interface-lib` — façade KSP des interfaces/wire on-chain nécessaires aux autres bibliothèques ; -- `ksp-config-lib` — contrats, chargement/résolution et manipulation autorisée de la configuration et des profils ; -- `ksp-logging-lib` — façade commune de logging/tracing, propriétaire de l'initialisation et des dépendances directes `tracing`, `tracing-appender` et `tracing-subscriber`. - -`ksp-logging-lib` peut dépendre de `ksp-core-lib` pour le contrat commun `Error` / `Result`. La relation inverse n'est pas requise : `ksp-core-lib` reste sans dépendance logging tant qu'aucun besoin réel ne la justifie. - -Les crates KSP contenant du comportement/runtime peuvent dépendre directement de `ksp-logging-lib` afin de produire des logs structurés aux niveaux `error`, `warn`, `info`, `debug` et `trace`. Les crates `*-api` purement déclaratives n'ajoutent pas cette dépendance sans comportement réel à logger. - -Une bibliothèque N1 ne doit pas dépendre d'une fonctionnalité métier située dans une couche supérieure. - -## N2 — Capacités Solana - -N2 regroupe les capacités réutilisables opérant sur Solana au-dessus des fondations. - -Le nom `ksp-program-lib` est retenu pour la bibliothèque propriétaire du traitement des programmes : décodage et préparation technique d'opérations via `ProgramExecutionPreparer`. Elle doit s'appuyer sur `ksp-interface-lib` plutôt que faire porter les contrats wire aux applications. - -Les autres responsabilités N2 candidates comprennent notamment : +### N2 — Capacités Solana réutilisables - `ksp-onchain-transport-lib` ; -- `ksp-offchain-transport-lib` lorsqu'un premier besoin réel justifiera son implémentation ; -- `ksp-wallet-lib`. +- `ksp-offchain-transport-lib` ; +- `ksp-wallet-lib` ; +- `ksp-interface-lib` ; +- `ksp-program-api` puis implementations Program ; +- `ksp-execution-policy-api` et orchestration d'exécution lorsqu'un vertical slice réel le justifie. -Le transport off-chain est général : il ne se limite pas aux metadata et pourra servir à des ressources telles que metadata externes, prix de référence, services de routage ou autres données hors blockchain. +### N3 — Données, jobs, workers et processing -## N3 — Données et orchestration réutilisable +- `ksp-store-api` / `ksp-store-lib` ; +- `ksp-materializer-api` / implementations lorsque DECODE s'ouvre ; +- `ksp-job-api` et jobs ; +- `ksp-worker-api` et workers ; +- processors/pipelines spécialisés réellement réutilisés. -N3 doit accueillir les responsabilités qui interprètent, persistent ou orchestrent des capacités inférieures, notamment : +### N4 — Exécutables -- matérialisation ; -- stockage ; -- replay/reconstruction ; -- pipelines ; -- scénarios réutilisables ; -- contrôle/orchestration de workers lorsqu'il sera introduit. +- applications desk ; +- services workers ; +- outils/jobs exécutables ; +- demos/scenarios ; +- future orchestration globale. -### W1 +## Chaîne durable indépendante des niveaux N1–N4 -W1 est un worker d'acquisition live/quasi-live uniquement. - -Il consomme au minimum les contrats de configuration, transport on-chain et stockage nécessaires pour : - -1. écouter les sources configurées ; -2. rapatrier les données ; -3. les persister sous forme raw ; -4. notifier qu'une nouvelle information raw est disponible. - -W1 : - -- ne décode pas ; -- ne matérialise pas ; -- ne réalise pas de replay ; -- ne décide pas de l'utilisation métier des données collectées ; -- doit pouvoir faire évoluer à chaud ce qu'il écoute, rapatrie ou stocke selon les mécanismes de configuration/commande qui seront définis. - -Les notifications W1 servent de wake-up. Les workers/jobs downstream reconstruisent leur backlog depuis le Store et appliquent les pipelines spécialisés correspondant aux frontières D1 -> D2 -> D3 -> D4. - -### Workers de processing futurs - -Le processing continu n'est plus modélisé comme un unique W2. Il sépare `ksp-worker-core-processor`, `ksp-worker-generic-materializer` et `ksp-worker-domain-projector` afin de respecter les frontières durables D1 Raw -> D2 Core -> D3 journal de matérialisation générique -> D4 projections de domaine. Le lifecycle, backlog, claim/lease et replay sont détaillés dans `009-ACQUISITION_WORKERS_AND_JOBS.md`. - -## N4 — Exécutables - -N4 contient les applications, demos et workers. - -### Dépendances directes autorisées - -N4 n'est pas obligé de traverser N3 puis N2 pour atteindre N1. - -Exemples valides : +La chaîne de données canonique est : ```text -ksp-app-config-desk - └── ksp-config-lib - -ksp-app-store-desk - ├── ksp-store-lib - └── ksp-config-lib +D1 RAW + -> D2 CORE + -> D3 DECODE + -> D4 SPECIALIZED ``` -Une application de configuration n'a aucune raison de dépendre de couches Solana qui ne participent pas à sa fonction. +Aliases fonctionnels : -Une application de store peut utiliser `ksp-config-lib` pour sélectionner/résoudre un profil et `ksp-store-lib` pour valider, initialiser ou reconstruire le stockage. Elle ne doit pas réimplémenter ces opérations ni appeler directement le backend propriétaire. +```text +RAW -> CORE -> DECODE -> SPECIALIZED +``` -## Applications et demos +RAW et CORE sont indépendants du décodage Program. -Une application ou demo : +CORE est une normalisation générique de Solana : structure des blocs, transactions, messages, comptes, instructions/CPI brutes, logs/meta et relations fondamentales. -- recueille et présente les données ; -- effectue les conversions/validations strictement liées à son interface ; -- sélectionne les options, profils et scénarios autorisés ; -- appelle les bibliothèques KSP propriétaires ; -- affiche ou exporte les résultats. +Le premier decoder Program intervient seulement à `CORE -> DECODE`. -Elle ne doit pas réécrire : +## Progression par couche -- le décodage ; -- la logique protocolaire ; -- les PDA et layouts ; -- la construction d'instructions ; -- la matérialisation ; -- les opérations de stockage ; -- les scénarios réutilisables ; -- les autres opérations appartenant à une bibliothèque inférieure. +### RAW et CORE -Lorsqu'une bibliothèque de scénarios possède déjà un workflow de démonstration, l'application demo doit l'appeler. +Ces deux couches sont construites horizontalement. -Les demos/scénarios doivent rester séparés par responsabilité fonctionnelle cohérente. Un regroupement n'est autorisé que lorsque plusieurs interfaces représentent réellement le même domaine fonctionnel. +À la fin de chaque couche, KSP ajoute les composants d'exploitation nécessaires : persistence, replay/backfill, worker/service et application de contrôle lorsque utiles. -Exemples actuellement retenus : +### DECODE et SPECIALIZED -- Memo : demo/scénarios séparés ; -- SPL Token classique : demo/scénarios séparés ; -- Associated Token Account : demo/scénarios séparés ; -- Token-2022 : demo/scénarios séparés ; -- metadata d'assets/tokens : Metaplex Token Metadata et Token-2022 Metadata peuvent partager une même famille de demo/scénarios ; -- Solana Program Metadata (SPM) reste séparé car il n'appartient pas à la même catégorie fonctionnelle. +À partir du décodage, KSP progresse verticalement par groupe fonctionnel : -## Workers +```text +wire + -> decode + -> materialize + -> specialized projection si utile + -> execution preparation + -> policy + -> execute + -> scenarios +``` -Les workers sont différents des interfaces utilisateur. Ils peuvent contenir l'orchestration runtime strictement nécessaire à leur responsabilité. +Cela évite de développer tous les decoders avant les matérialisations et toutes les executions. -Un worker doit néanmoins consommer les bibliothèques KSP propriétaires des contrats Solana et ne doit pas dépendre directement de crates Solana/protocoles externes. +## Séparation maximale des dépendances -Les premiers managers de workers sont spécialisés et séparés. Une application globale est un produit futur, tandis qu'un orchestrateur commun reste une abstraction à réévaluer seulement lorsqu'un besoin opérationnel concret le justifie. +Chaque composant possède son contrat et reçoit explicitement les données nécessaires. + +Exemples structurants : + +```text +ksp-onchain-transport-lib -X-> ksp-config-lib +ksp-onchain-transport-lib -X-> ksp-store-api +ksp-wallet-lib -X-> ksp-onchain-transport-lib +ksp-wallet-lib -X-> execution policy +ksp-interface-lib -X-> ksp-program-api +ksp-execution-lib -X-> ksp-program-lib +``` + +La composition supérieure relie les composants. + +## Configuration + +`ksp-config-lib` est l'unique propriétaire des documents Config, `.env` et variables KSP/KSPB. + +Un composant ne dépend pas de Config pour être utilisable. Il expose des settings publics. + +Config peut fournir un document standard et un adapter vers ces settings lorsque cela devient utile : + +```text +ksp-config-lib -> public settings du composant +``` + +sans dépendance inverse. + +## Logging + +`ksp-logging-lib` reste l'unique façade KSP de tracing runtime. + +Les crates comportant du comportement runtime peuvent en dépendre. Les crates `*-api` purement déclaratives n'ajoutent cette dépendance que si elles ont réellement un comportement à logger. + +## Applications + +Les applications Tauri restent minces : + +- DTOs applicatifs ; +- composition de services KSP ; +- lifecycle fenêtre/UI ; +- instrumentation frontend ; +- aucun déplacement de logique de transport, Wallet, Config, Program, Store ou Materializer dans Tauri. + +Des applications spécialisées sont ajoutées au fur et à mesure pour valider les couches : Config Desk, Wallet Desk, Price Desk, backfill/RAW tooling, CORE tooling puis Market Desk. + +## Workers et jobs + +Un worker est un service continu/autonome ; un job est borné/terminable. + +Ils utilisent des APIs lifecycle distinctes et ne s'appellent pas entre eux pour transférer les payloads du data plane. + +Le Store reste le point durable de synchronisation entre couches de processing. ## Firewall des dépendances externes -Les exécutables KSP dépendent des bibliothèques KSP pour les capacités Solana. +Les exécutables et couches supérieures n'importent pas directement les crates Solana/protocoles métier lorsqu'une façade KSP existe ou est prévue. -```text -application / demo / worker - │ - ▼ - bibliothèques KSP - │ - ▼ -primitives externes explicitement autorisées - │ - ▼ - Solana -``` +Exceptions bas niveau explicitement autorisées restent limitées aux primitives stables décidées par les règles KSP. -Une dépendance externe Solana ou protocolaire doit être possédée par la bibliothèque KSP la plus basse et la plus cohérente avec sa responsabilité. - -## Sens des dépendances - -Le principe recherché est : - -```text -N4 ───────► N3 / N2 / N1 -N3 ───────► N2 / N1 -N2 ───────► N1 -N1 ───────► fondations externes explicitement autorisées -``` - -Il n'est pas permis d'introduire une dépendance vers une couche supérieure pour résoudre localement un problème. Si cela semble nécessaire, le classement des responsabilités doit être réexaminé. +`ksp-interface-lib` concentre les interfaces/wires officielles ou compatibles afin d'éviter les doublons de générations et les dépendances protocolaires dans les couches supérieures. ## Principe contract-first -Les contrats minimaux entre couches doivent être définis suffisamment tôt pour que les composants futurs puissent se construire contre une frontière KSP stable, même lorsque l'implémentation complète arrive dans une version ultérieure. +Une crate `*-api` est créée uniquement lorsque l'extension externe/backend/lifecycle exige un contrat séparé. -Ce principe s'applique notamment aux futurs : +Cas décidés : -- decoders ; -- `ProgramExecutionPreparer` / constructeurs d'opérations ; -- materializers ; -- store/repositories ; -- transports ; -- scénarios ; -- notifications et contrôle des workers ; -- orchestrateur. +```text +ksp-program-api +ksp-materializer-api +ksp-store-api +ksp-worker-api +ksp-job-api +ksp-execution-policy-api +``` -Il ne signifie pas qu'il faut implémenter prématurément toutes les fonctionnalités. Les interfaces/traits peuvent évoluer légèrement lorsque l'expérience révèle un besoin réel, mais une dépendance entre couches ne doit pas être remplacée par un couplage ad hoc sous prétexte que le contrat final n'existe pas encore. +`ksp-interface-lib`, Wallet et transports conservent pour l'instant leurs APIs publiques dans leur bibliothèque d'implémentation. + +## Groupes Program prioritaires + +Après RAW/CORE : + +```text +Solana Core Programs +-> SPL token/trading +-> token metadata +-> Anchor +-> Meteora +-> Raydium +-> Pump +-> Orca +-> Market Desk V1 +-> Jupiter/OKX routing +-> Market Desk V2 +-> trading-adjacent +-> general decoding +``` + +Un satellite nécessaire à un protocole reste dans son groupe : Pump fee avec Pump, Meteora vault avec Meteora, etc. ## Questions encore ouvertes -- représentation interne exacte du type d'erreur commun KSP, à traiter dès `0.1.1-pre.001` ; -- types publics précis de `ksp-program-api` et format ouvert/persistable des résultats décodés ; -- méthode de conformité wire contre les projets externes ; +- forme exacte des settings publics Transport ; +- nécessité future d'un pool automatique de sessions WebSocket ; +- split éventuel d'une API Interface séparée uniquement si un vrai besoin apparaît ; +- contrats Rust exacts de Program/Materializer/Store ; - mécanisme IPC du premier manager de worker autonome ; -- besoins de contexte des futurs `DomainProjector` stateful ; -- nécessité réelle d'un orchestrateur commun lorsque plusieurs services/managers existeront. +- granularité future des workers DECODE/SPECIALIZED par groupe. diff --git a/docs/architecture/003-COMPONENT_CONTRACTS.md b/docs/architecture/003-COMPONENT_CONTRACTS.md index 3abb563..d0ccf1e 100644 --- a/docs/architecture/003-COMPONENT_CONTRACTS.md +++ b/docs/architecture/003-COMPONENT_CONTRACTS.md @@ -1,30 +1,17 @@ - + # Contrats initiaux des composants KSP ## Objet -Ce document enregistre les frontières déjà suffisamment claires pour guider la planification. Il ne définit pas encore les API Rust finales. - -Le principe commun est de définir tôt les contrats nécessaires entre composants, puis d'enrichir les implémentations lorsque le besoin réel apparaît. - -L'inventaire détaillé courant est maintenu dans [`004-COMPONENT_INVENTORY.md`](004-COMPONENT_INVENTORY.md), le graphe autorisé/interdit dans [`005-DEPENDENCY_GRAPH.md`](005-DEPENDENCY_GRAPH.md), Wire/Program dans [`006-WIRE_AND_PROGRAM.md`](006-WIRE_AND_PROGRAM.md) Execution/Policy dans [`007-EXECUTION_AND_POLICY.md`](007-EXECUTION_AND_POLICY.md), Data/Materialization/Store dans [`008-DATA_MATERIALIZATION_AND_STORE.md`](008-DATA_MATERIALIZATION_AND_STORE.md) Acquisition/Workers/Jobs dans [`009-ACQUISITION_WORKERS_AND_JOBS.md`](009-ACQUISITION_WORKERS_AND_JOBS.md) et Apps/Services/Scenarios/Control dans [`010-APPS_SERVICES_SCENARIOS_AND_CONTROL.md`](010-APPS_SERVICES_SCENARIOS_AND_CONTROL.md). +Ce document synthétise les responsabilités des composants KSP. Les types Rust exacts restent définis au moment de leur première implémentation réelle. ## Convention API / implémentation -Lorsqu'un domaine doit exposer des contrats publics pouvant être implémentés indépendamment, KSP peut séparer : +Une crate de contrats extensibles se nomme `ksp--api`. Une implémentation réutilisable se nomme `ksp--lib`. -```text -ksp--api -ksp--lib -``` - -La crate `ksp--api` est techniquement une bibliothèque Rust mais ne porte volontairement pas le suffixe `-lib`. - -Cette séparation n'est pas automatique. Elle est utilisée lorsqu'une vraie frontière d'extension/backend/lifecycle la justifie. - -Couples retenus : +Couples explicitement retenus : ```text ksp-program-api / ksp-program-lib @@ -32,185 +19,192 @@ ksp-materializer-api / ksp-materializer-lib ksp-store-api / ksp-store-lib ``` -APIs lifecycle retenues : +Lifecycle APIs séparées : ```text ksp-worker-api ksp-job-api +ksp-execution-policy-api ``` -Aucune API commune worker+job n'est prévue. +Une crate `*-api` n'est jamais créée uniquement pour la symétrie des noms. -## Execution policy +## Core -`ksp-execution-policy-api` est un contrat public de décision séparé de `ksp-program-lib`, du wallet, du transport et de l'UI. +`ksp-core-lib` porte les primitives transversales réellement fondamentales, dont `Error`/`Result` et le registre KSP des Program IDs fondamentaux. -Une exécution réelle via `ksp-execution-lib` reçoit explicitement une policy ; aucun fallback permissif implicite n'est prévu. - -La policy peut être évaluée à plusieurs checkpoints afin d'intégrer des informations obtenues pendant le cycle, notamment le résultat de simulation. - -Une policy peut autoriser, refuser ou imposer des requirements ; elle ne réalise pas elle-même la simulation, la signature, le réseau ou une interaction Tauri. - -Les implémentations appartiennent aux crates de contexte appropriées : scenario Devnet, future bibliothèque d'application générale, future policy trading, etc. - -Aucune `ksp-execution-policy-lib` générique n'est prévue sans logique réellement commune. - -## Execution orchestration - -`ksp-execution-lib` consomme fondamentalement `PreparedProgramExecution` conforme à `ksp-program-api` et ne dépend pas de `ksp-program-lib`. - -Il orchestre : - -- policy checkpoints ; -- assemblage message/transaction ; -- simulation via `ksp-onchain-transport-lib` ; -- résolution des signers et signature via `ksp-wallet-lib` ; -- submission ; -- confirmation ; -- retry d'exécution lorsque celui-ci change le lifecycle ; -- suspension/reprise lorsqu'une approbation externe est requise. - -Le wallet et le provider/réseau sont sélectionnés/fournis par la composition supérieure ; `ksp-execution-lib` les utilise sans définir une policy de sélection implicite. - -Le retry d'un appel réseau identique reste une responsabilité transport, distincte du retry d'exécution nécessitant reconstruction/resimulation/resignature. - -`ksp-execution-lib` ne persiste pas automatiquement son résultat et ne dépend pas du store. +Il ne devient pas une crate de modèles métier ou de transport. ## Logging -`ksp-logging-lib` est la façade KSP unique pour le logging/tracing runtime. Elle importe/initialise directement `tracing`, `tracing-appender` et `tracing-subscriber` et peut dépendre de `ksp-core-lib` pour `Error` / `Result`. +`ksp-logging-lib` est la façade unique KSP de tracing runtime. -Les crates comportementales KSP utilisent sa façade pour leurs événements `error`, `warn`, `info`, `debug`, `trace` et pour leurs spans sync/async. Elles n'émettent pas leurs propres logs via une dépendance directe à la stack tracing. +Les composants runtime émettent leurs événements via cette façade. Les targets tiers sont silencieux par défaut et les informations utiles sont réémises sous le target du composant KSP propriétaire. -Chaque émission KSP indique un target correspondant au nom Cargo de la crate propriétaire ; `domain`, `component` et les autres champs structurés décrivent les subdivisions fonctionnelles sans multiplier les targets. +## Config -Le subscriber KSP rend les targets tiers silencieux par défaut. Lorsqu'une information provenant d'une dépendance externe est nécessaire, la crate KSP qui possède l'opération la réémet explicitement sous son propre target ; Logging ne renomme pas les événements tiers. +`ksp-config-lib` est l'unique propriétaire des documents Config, `.env`, variables KSP/KSPB et persistence Config. -Logging possède ses `LoggingSettings`, ses writers/guards et son lifecycle. Le subscriber global est installé une fois, puis la configuration peut être rechargée à chaud via la façade KSP sans dépendance vers Config. - -`ksp-core-lib` n'a pas de dépendance logging requise. Les crates `*-api` purement déclaratives restent sans logging par défaut. - -Une application Tauri peut exceptionnellement avoir une dépendance/framework tracing imposée par un plugin, sans définir une politique parallèle à `ksp-logging-lib`; les événements KSP restent émis via la façade KSP. - -## Frontière materializer / store - -Les niveaux durables utilisent D1 Raw, D2 Core canonique, D3 journal de matérialisation générique et D4 projections spécialisées. - -`ksp-materializer-api` peut dépendre de `ksp-program-api` pour consommer des contrats Core ouverts. Il doit pouvoir distinguer conceptuellement une matérialisation générique D2 -> D3 et une projection spécialisée D3 -> D4. - -`ksp-materializer-lib` reste une bibliothèque de transformation et ne dépend ni de `ksp-store-api` ni de `ksp-store-lib`. - -`ksp-store-api` possède les DTO/contrats persistants et reste indépendant des APIs Program/Materializer. Les workers/jobs de processing convertissent explicitement entre modèles runtime et modèles persistants. - -D3 est un journal durable obligatoire ; D4 reste plus évolutif. Cette séparation évite d'introduire un `ksp-data-api` monolithique uniquement pour partager des modèles entre couches. +Les composants exposent leurs settings publics ; Config peut fournir un document standard et un adapter vers ces settings sans créer de dépendance inverse. ## Transport on-chain Aucune `ksp-onchain-transport-api` séparée n'est prévue. -`ksp-onchain-transport-lib` regroupe les transports/providers on-chain et expose des modèles de sortie homogènes par catégorie de données. +`ksp-onchain-transport-lib` possède : -Il ne dépend pas de `ksp-store-api`. +- settings runtime publics ; +- endpoints/providers/clusters ; +- pools/rôles/capabilities ; +- HTTP JSON-RPC ; +- WebSocket ; +- Yellowstone gRPC et futurs adapters provider lorsque introduits ; +- modèles homogènes par catégorie de donnée ; +- observabilité transport. -Les modèles de transport doivent cependant être conçus pour une conversion explicite et simple vers les modèles raw persistants du store, sans décodage protocolaire. +Il ne dépend pas de Config, Store ou Program. + +Pour toute surface normative ciblée, toutes les méthodes documentées sont inventoriées/implémentées sauf impossibilité documentée. Les méthodes deprecated/obsolete encore fonctionnelles et unstable/experimental émettent un warning KSP à l'utilisation. ## Transport off-chain Aucune `ksp-offchain-transport-api` commune n'est prévue. -La crate est volontairement hétérogène : metadata, prix, quotes, routage et autres ressources externes peuvent avoir des modules/APIs distincts à l'intérieur d'une seule crate afin d'éviter une prolifération de crates artificielles. +`ksp-offchain-transport-lib` peut contenir plusieurs modules/APIs distincts : prix, metadata HTTP/IPFS/Arweave, quotes et autres accès externes. La première surface engagée est le prix SOL/USD et SOL/EUR. ## Wallet -Aucune `ksp-wallet-api` n'est prévue. +Aucune `ksp-wallet-api` séparée n'est prévue. -`ksp-wallet-lib` possède le format wallet KSP et les capacités de lecture/protection/import/export/pubkey/secret/signature nécessaires à ses consommateurs. +`ksp-wallet-lib` possède le format `.kspwallet`, le secret protégé, l'identité publique, signature, import/export et conversions utiles. -## Store et notifications de données +Il ne possède pas `WalletPolicy` ni les règles d'autorisation d'exécution. -`ksp-store-api` reste la frontière backend-agnostic. `ksp-store-lib` contient PostgreSQL comme implémentation de référence. +Le wallet temporaire JSON historique n'est pas migré. -Les notifications de données persistées sont normalisées indépendamment de leur producteur. W1, un job de backfill, un import ou un replay utilisent le même contrat pour signaler le même type de donnée. +## Interface / wire -Une notification est seulement un signal de réveil : le Store et les marqueurs d'idempotence/backlog restent la source de vérité. La publication suit l'ordre `persist -> commit -> notify`. +`ksp-interface-lib` est la façade wire officielle KSP et expose aussi une API publique wire réutilisable par `ksp-program-lib` et les extensions Program externes. -Le contrat de notification est distinct de son transport concret. +Aucune `ksp-interface-api` séparée n'est retenue actuellement. + +La crate sélectionne entre réexport contrôlé, wrapper ou implémentation wire compatible selon stabilité, ownership et graphe de dépendances des interfaces externes. + +## Program + +`ksp-program-api` porte les contrats extensibles de Program : descriptors/capabilities, decoders, outputs et préparation d'exécution lorsque ces contrats sont démontrés. + +`ksp-program-lib` porte les implementations officielles et dépend de `ksp-program-api`. + +Une crate externe peut implémenter `ksp-program-api` sans dépendre de `ksp-program-lib`. + +## Execution policy + +`ksp-execution-policy-api` est le contrat commun de décision/safety. + +Une policy décide ; elle ne signe pas, n'envoie pas et ne possède ni Wallet ni Transport. + +Une petite policy de scenario/orchestrateur peut être implémentée localement. Des bibliothèques communes sont créées uniquement si une réutilisation réelle apparaît. + +## Execution orchestration + +`ksp-execution-lib` est introduit lorsque le premier vertical slice réel nécessite une orchestration stable entre : + +```text +ksp-program-api +ksp-execution-policy-api +ksp-wallet-lib +ksp-onchain-transport-lib +``` + +Il ne dépend pas de `ksp-program-lib` afin d'accepter des implementations Program externes. + +## Store et niveaux durables + +La chaîne durable est : + +```text +D1 RAW + -> D2 CORE + -> D3 DECODE + -> D4 SPECIALIZED +``` + +### RAW + +Acquisition replayable + provenance, sans décodage Program. + +### CORE + +Normalisation générique Solana, sans décodage Program. + +### DECODE + +Interprétation Program/protocole puis matérialisation générique/journal durable. + +### SPECIALIZED + +Projections queryables de domaine : token, metadata, pools, trades, OHLC, routes, etc. + +`ksp-store-api` possède les contrats backend-agnostic. `ksp-store-lib` fournit PostgreSQL comme backend officiel. + +La première Store release est RAW-only ; les couches suivantes sont ajoutées quand elles sont réellement ouvertes. + +## Materializer + +`ksp-materializer-api`/`ksp-materializer-lib` sont introduits avec le premier besoin DECODE réel, pas avant. + +Program et Materializer restent indépendants du backend Store ; les composants de composition convertissent leurs outputs vers les DTO persistants. ## Workers -`ksp-worker-api` est une lifecycle API pour services continus/live. +`ksp-worker-api` est la lifecycle API des services continus. -`ksp-worker-control-lib` est une implémentation réutilisable de gouvernance pouvant être consommée d'abord par les applications manager spécialisées, puis éventuellement par un futur orchestrateur ou une future application globale. +RAW et CORE peuvent recevoir leurs workers à la fin de leur couche respective. -Workers retenus : - -```text -ksp-worker-raw-retriever -ksp-worker-core-processor -ksp-worker-generic-materializer -ksp-worker-domain-projector -``` - -Le dernier nom reste provisoire. - -Chaque worker doit pouvoir fonctionner comme service/processus indépendant afin d'être arrêté, redémarré ou mis à jour sans imposer l'arrêt des autres. La direction de packaging préférée est un package `ksp-worker-*` avec cible bibliothèque réutilisable et binaire autonome mince. - -Les workers de processing utilisent le Store comme source de vérité du backlog, peuvent être réveillés par notification, et doivent pouvoir reprendre après crash. Le raw retriever possède en plus une capacité de hot reconfiguration de sa sélection d'acquisition. +Les workers DECODE/SPECIALIZED sont introduits avec les groupes Program réels, afin de ne pas créer une orchestration générique vide avant les processors. ## Jobs -`ksp-job-api` est une lifecycle API distincte pour travaux déclenchés et terminables. +`ksp-job-api` est la lifecycle API des travaux déclenchés/terminables. -Jobs de données retenus : +Le premier job retenu est le backfill RAW. + +Les jobs de replay suivent ensuite les frontières durables ouvertes : RAW -> CORE, CORE -> DECODE, DECODE -> SPECIALIZED. + +Aucune `ksp-job-control-lib` n'est prévue sans duplication concrète. + +## Scenarios + +Les scenarios restent dans `ksp-scenario--lib` et sont appelables sans desktop. + +Ils composent les Program implementations, policy, Wallet, transport et execution nécessaires à leur vertical slice. + +L'application demo correspondante reste une UI mince. + +## Applications + +KSP privilégie des applications spécialisées servant à valider/exploiter une capacité réelle : ```text -ksp-job-backfill -ksp-job-replay-core -ksp-job-replay-generic-materialization -ksp-job-replay-domain-projection +ksp-app-config-desk +ksp-app-wallet-desk +price desk +backfill/raw tooling +CORE tooling +ksp-app-market-desk ``` -Les trois jobs de replay correspondent exactement aux frontières D1 -> D2, D2 -> D3 et D3 -> D4. +Une application globale reste future. -Aucune `ksp-job-control-lib` n'est prévue actuellement. D'autres jobs pourront apparaître pour metadata, quotes ou autres besoins ponctuels. +## Progression verticale Program -## Scénarios - -Les scénarios restent dans des crates spécialisées `ksp-scenario--lib`. - -`ksp-scenario-api` n'est pas retenu actuellement : `docs/rules/SCENARIO_CONVENTION.md` porte la norme commune tant qu'un vrai contrat Rust réutilisable n'a pas émergé. - -Les demos desktop de scénario suivent provisoirement la forme : +À partir de DECODE : ```text -ksp-app-scenario---desk-demo +wire -> decode -> materialize -> specialized -> prepare -> policy -> execute -> scenario ``` -et réutilisent la crate de scénario correspondante. +Ordre prioritaire actuel : Solana Core Programs, SPL token/trading, token metadata, Anchor, Meteora, Raydium, Pump, Orca, routing, trading-adjacent, puis décodage généraliste. -## Applications, services et control plane - -Les applications spécialisées sont développées avant toute application globale. - -Les apps restent des interfaces/compositions et ne réimplémentent pas les workflows des bibliothèques/services sous-jacents. - -Les workers sont des services autonomes et ne communiquent pas directement leurs données entre eux. D1–D4 constituent le data plane ; `ksp-worker-api`, `ksp-worker-control-lib`, `ksp-job-api` et le futur IPC constituent le control plane. - -Aucun `ksp-ipc-api` générique ni `ksp-orchestrator-lib` n'est retenu comme crate actuelle. - -Une future application globale est conservée comme idée produit, pas comme tâche du roadmap présent. - -## Pipelines - -Aucun `ksp-pipeline-lib` monolithique. - -Quatre pipelines spécialisés sont maintenant retenus parce qu'ils évitent de dupliquer une même frontière entre worker live et job : - -```text -ksp-pipeline-raw-ingestion-lib -ksp-pipeline-core-processing-lib -ksp-pipeline-generic-materialization-lib -ksp-pipeline-domain-projection-lib -``` - -Ils dépendent des APIs de domaine nécessaires, pas des implémentations officielles `ksp-store-lib`, `ksp-program-lib` ou `ksp-materializer-lib`. Les workers/jobs réalisent cette composition. +Un satellite nécessaire reste dans son groupe protocolaire. diff --git a/docs/architecture/004-COMPONENT_INVENTORY.md b/docs/architecture/004-COMPONENT_INVENTORY.md index af6b421..2e25a6d 100644 --- a/docs/architecture/004-COMPONENT_INVENTORY.md +++ b/docs/architecture/004-COMPONENT_INVENTORY.md @@ -1,344 +1,153 @@ - + # Inventaire initial des composants KSP ## Objet -Ce document constitue le premier inventaire architectural de `0.0.3-pre.002`. - -Il répond principalement à la question : **quel composant possède quelle responsabilité ?** - -Le premier inventaire a été produit en `0.0.3-pre.002`. `pre.003` l'a corrigé à partir du graphe, puis `pre.004` a détaillé Wire/Program dans [`006-WIRE_AND_PROGRAM.md`](006-WIRE_AND_PROGRAM.md), `pre.005` Execution/Policy, `pre.006` les niveaux durables/Materialization/Store, `pre.007` l'exploitation workers/jobs/pipelines, `pre.008` Apps/Services/Scenarios/Control, puis `pre.009` le séquencement des premières releases fonctionnelles. La séquence détaillée est dans `docs/plans/002-FUNCTIONAL_RELEASE_SEQUENCE.md`. Les détails de types Rust restent révisables avec les premières implémentations. +Ce document maintient l'inventaire synthétique des composants retenus ou pressentis. Les numéros de release précis restent soumis au sizing de chaque session. ## Statuts -- **Retenu** — composant ou responsabilité considérée nécessaire dans la trajectoire actuelle ; -- **Candidat fort** — composant très probable mais dont la frontière exacte doit encore être validée ; -- **Futur retenu** — responsabilité acquise mais implémentation différée ; -- **À la demande** — ne doit être créé que lorsqu'un premier besoin concret le justifie ; -- **Non retenu actuellement** — idée volontairement non créée ; elle peut être réévaluée si l'usage réel change. +- `Stable` — implémenté et publié ; +- `Retenu` — composant/contrat décidé ; +- `Pressenti` — direction décidée mais périmètre exact à confirmer ; +- `À la demande` — créé seulement au premier besoin réel ; +- `Non retenu` — explicitement écarté pour l'instant. ## Inventaire synthétique -| Domaine | Composant | Nature | Niveau provisoire | Statut | Première série envisagée | Responsabilité principale | -|----------------------------------|---------------------------------------------|-------------------------|-------------------|-----------------------------------|-----------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------| -| Core | `ksp-core-lib` | lib | N1 | Retenu | `0.1.1` | `Error` commun, Program IDs, primitives/contrats réellement transversaux | -| Configuration | `ksp-config-lib` | lib | N1 | Retenu | `0.1.3` par défaut | documents de configuration, profils, résolution, modifications autorisées | -| Logging | `ksp-logging-lib` | lib | N1 | Retenu | `0.1.2` | façade unique `tracing`/appender/subscriber, initialisation et logging structuré KSP ; peut dépendre de core pour Error/Result | -| Config desktop | `ksp-app-config-desk` | app | N4 | Retenu | `0.1.4` par défaut | app spécialisée Tauri validant chargement, profils, édition, sauvegarde, validation et diagnostics Config | -| Wire Solana | `ksp-interface-lib` | lib | N1 | Retenu | `0.2.x` | façade wire on-chain, réexports contrôlés et réimplémentations compatibles | -| Program API | `ksp-program-api` | API | N2 contrat | Retenu | `0.2.x` | contrats publics ouverts de décodage, préparation d'exécution, descriptors et registry | -| Program impl. | `ksp-program-lib` | lib | N2 | Retenu | `0.2.x+` | decoders et `ProgramExecutionPreparer` officiels organisés par domaine/programme/capacité | -| Program extension | `ksp-program--lib` | lib externe/optionnelle | N2 | À la demande | dès besoin | implémentation externe de `ksp-program-api` pour un Program ID non encore intégré officiellement | -| Execution policy | `ksp-execution-policy-api` | API | N3 contrat | Retenu | premier besoin d'exécution réelle | policy obligatoire, multi-checkpoints, décision/requirements sans wallet/réseau/UI | -| Execution orchestration | `ksp-execution-lib` | lib | N3 | Retenu | premier besoin d'exécution réelle | consomme `PreparedProgramExecution`; orchestre policy/simulation/signature/submission/confirmation/retry sans dépendre de `ksp-program-lib` ou du store | -| Transport on-chain | `ksp-onchain-transport-lib` | lib | N2 | Retenu | `0.2.x` | RPC/WS/providers et modèles de transport homogènes, sans dépendance store | -| Transport off-chain | `ksp-offchain-transport-lib` | lib | N2 | Retenu, implémentation différable | premier besoin réel | accès metadata, prix, quotes, routage et autres ressources hors blockchain | -| Wallet | `ksp-wallet-lib` | lib | N2 | Retenu | `0.2.x` | format wallet KSP, lecture/protection/import/export, pubkey, secret/signature | -| Materializer API | `ksp-materializer-api` | API | N3 contrat | Retenu | `0.3.x` | contrats publics/extensibles de matérialisation | -| Materializer impl. | `ksp-materializer-lib` | lib | N3 | Retenu | `0.3.x+` | materializers officiels KSP | -| Store API | `ksp-store-api` | API | N3 contrat | Retenu | `0.3.x` | contrats backend-agnostic, modèles persistants et notifications de données persistées | -| Store impl. | `ksp-store-lib` | lib | N3 | Retenu | `0.3.x` | PostgreSQL de référence, migrations, repositories, queries, backlog/replay et notification backend | -| Worker lifecycle | `ksp-worker-api` | API | N3 contrat | Retenu | `0.3.x` | lifecycle commun des services continus | -| Worker control | `ksp-worker-control-lib` | lib | N3 | Retenu | `0.3.x+` | gouvernance réutilisable de services workers autonomes pour apps spécialisées puis futurs managers/orchestrateurs | -| Live raw acquisition | `ksp-worker-raw-retriever` | worker | N4 | Retenu | `0.3.x` | acquisition live/quasi-live -> raw persisté -> notification data | -| Raw -> Core | `ksp-worker-core-processor` | worker | N4 | Futur retenu | `0.6.x` | transformer le raw persisté en Core canonique | -| Core -> generic mat. | `ksp-worker-generic-materializer` | worker | N4 | Futur retenu | `0.6.x` | produire la matérialisation/journal générique depuis le Core | -| Domain projection | `ksp-worker-domain-projector` | worker | N4 | Futur retenu, nom provisoire | `0.6.x` | matérialiser/classer/stocker les projections spécialisées par domaine | -| Job lifecycle | `ksp-job-api` | API | N3 contrat | Retenu | `0.3.x` | lifecycle/progression commun des travaux déclenchés et terminables | -| Historical backfill | `ksp-job-backfill` | job | N4 | Retenu | `0.3.x` | acquisition historique avec pagination, progression, checkpoint/reprise | -| Core replay | `ksp-job-replay-core` | job | N4 | Retenu | `0.3.x/0.6.x` | replay borné D1 -> D2 via le pipeline Core | -| Generic materialization replay | `ksp-job-replay-generic-materialization` | job | N4 | Retenu | `0.3.x/0.6.x` | replay borné D2 -> D3 via le pipeline générique | -| Domain projection replay | `ksp-job-replay-domain-projection` | job | N4 | Retenu | `0.3.x/0.6.x` | replay borné D3 -> D4 via le pipeline de projection | -| Other jobs | `ksp-job-` | job | N4 | À la demande | `0.4.x+` | metadata, quotes et autres travaux ponctuels/historiques | -| Scenarios | `ksp-scenario--lib` | lib | N3 | Retenu | `0.4.x+` | scénarios de validation spécialisés par domaine | -| Scenario common API | `ksp-scenario-api` | API | — | Non retenu actuellement | — | préférer une norme de scénario souple plutôt qu'un trait commun contraignant | -| Scenario demo apps | `ksp-app-scenario---desk-demo` | app | N4 | Retenu | `0.4.x+` | interface desktop appelant la crate scénario correspondante | -| Raw ingestion pipeline | `ksp-pipeline-raw-ingestion-lib` | lib | N3 | Retenu | `0.3.x` | conversion/persistence transport model -> D1 partagée par worker live et backfill | -| Core processing pipeline | `ksp-pipeline-core-processing-lib` | lib | N3 | Retenu | `0.3.x/0.6.x` | logique D1 -> D2 partagée par worker et replay, basée sur `ksp-program-api` | -| Generic materialization pipeline | `ksp-pipeline-generic-materialization-lib` | lib | N3 | Retenu | `0.3.x/0.6.x` | logique D2 -> D3 partagée par worker et replay, basée sur `ksp-materializer-api` | -| Domain projection pipeline | `ksp-pipeline-domain-projection-lib` | lib | N3 | Retenu | `0.3.x/0.6.x` | logique D3 -> D4 partagée par worker et replay, basée sur `ksp-materializer-api` | -| Trading Intelligence | noms à définir | API/libs/jobs | N3+ | Futur retenu | `0.7.x` | statistiques, features, signaux, anomalies, backtests, ML | -| Trading operation/app | noms à définir | libs/apps | N3/N4 | Futur retenu | après Trading Intelligence | politique/automatisation de trading et application monoposte | -| Solana explorer | noms à définir | libs/apps | N3/N4 | Futur retenu | futur | exploration générale Solana | -| DEX explorer | noms à définir | libs/apps | N3/N4 | Futur retenu | futur | exploration/analyse DEX | +| Domaine | Composant | Type | Statut | Première cible actuelle | Mission | +|-------------------------|------------------------------------------|--------------------|--------------|---------------------------------|----------------------------------------------------------| +| Core | `ksp-core-lib` | lib | Stable | `0.1.1` | Error/Result, Program IDs et primitives fondamentales | +| Logging | `ksp-logging-lib` | lib | Stable | `0.1.2` | façade unique tracing KSP | +| Config | `ksp-config-lib` | lib | Stable | `0.1.3` | documents, profils, env et persistence Config | +| Config Desk | `ksp-app-config-desk` | app | Stable | `0.1.4` | validation/management Config | +| On-chain HTTP | `ksp-onchain-transport-lib` | lib | Retenu | `0.2.1` | JSON-RPC HTTP complet, settings, pools, rôles | +| Wallet | `ksp-wallet-lib` | lib | Retenu | `0.2.2` | `.kspwallet`, secrets, signature, import/export | +| Wallet Desk | `ksp-app-wallet-desk` | app | Retenu | `0.2.3` | Wallet + Config composite + HTTP/balance | +| Standard WS | `ksp-onchain-transport-lib` | lib | Retenu | `0.2.4` | WebSocket Solana complet, sessions/subscriptions | +| Helius WS | `ksp-onchain-transport-lib` | lib | Retenu | `0.2.5` | LaserStream WebSocket comme extension du moteur standard | +| Yellowstone | `ksp-onchain-transport-lib` | lib | Pressenti | `0.2.6` | client gRPC standard/provider-neutral | +| Off-chain price | `ksp-offchain-transport-lib` | lib | Retenu | `0.2.7` | première abstraction/provider de prix SOL/USD, SOL/EUR | +| Price Desk | nom à fixer | app | Retenu | `0.2.8` | visualisation/validation des prix | +| Wire | `ksp-interface-lib` | lib | Retenu | `0.2.9` | façade wire officielle + API publique wire | +| Program API | `ksp-program-api` | API | Retenu | `0.2.10` | contrats extensibles Program | +| Program impl. | `ksp-program-lib` | lib | Retenu | vertical slices ultérieurs | implementations Program officielles | +| Program extension | `ksp-program--lib` | lib externe | À la demande | dès besoin | implementation externe de `ksp-program-api` | +| Store API | `ksp-store-api` | API | Retenu | `0.3.1` | contrats persistence backend-agnostic, RAW d'abord | +| Store PostgreSQL | `ksp-store-lib` | lib | Retenu | `0.3.1` | backend PostgreSQL officiel, RAW d'abord | +| Job lifecycle | `ksp-job-api` | API | Retenu | `0.3.3` | lifecycle des jobs terminables | +| Backfill | `ksp-job-backfill` | job/lib à préciser | Retenu | `0.3.3` | acquisition historique vers RAW | +| Backfill Desk | nom à fixer | app | Retenu | `0.3.4` | contrôle/inspection du backfill RAW | +| Worker lifecycle | `ksp-worker-api` | API | Retenu | fin couche RAW | lifecycle des services continus | +| RAW worker | `ksp-worker-raw-retriever` ou nom révisé | worker | Retenu | fin couche RAW | acquisition live vers RAW | +| CORE processor | nom à fixer | processor/lib | Retenu | couche CORE | normalisation Solana générique RAW -> CORE | +| CORE worker | nom à fixer | worker | Retenu | fin couche CORE | backlog RAW -> CORE continu | +| Materializer API | `ksp-materializer-api` | API | Retenu | premier groupe DECODE | contrats extensibles matérialisation | +| Materializer impl. | `ksp-materializer-lib` | lib | Retenu | premier groupe DECODE | implementations officielles communes | +| Execution policy | `ksp-execution-policy-api` | API | Retenu | premier vrai besoin execution | décision/safety multi-contexte | +| Execution orchestration | `ksp-execution-lib` | lib | Retenu | premier vrai cycle execution | Program + policy + Wallet + transport | +| Scenarios | `ksp-scenario--lib` | lib | Retenu | vertical slices | validation métier/devnet par groupe | +| Scenario API | `ksp-scenario-api` | API | Non retenu | — | norme souple avant trait commun | +| Market Desk | `ksp-app-market-desk` | app | Pressenti | après Meteora/Raydium/Pump/Orca | tokens, pools, trades, liquidity, price, OHLC | +| Trading Intelligence | noms à définir | libs/jobs | Futur | après données stables | features/signaux/anomalies/ML | -## APIs séparées retenues - -Les couples suivants ont une justification d'extensibilité suffisante : +## Contrats séparés retenus ```text -ksp-program-api -> ksp-program-lib -ksp-materializer-api -> ksp-materializer-lib -ksp-store-api -> ksp-store-lib +ksp-program-api +ksp-materializer-api +ksp-store-api +ksp-worker-api +ksp-job-api +ksp-execution-policy-api ``` -Les APIs lifecycle sont également séparées : +Pas de crates séparées actuellement pour : ```text -ksp-worker-api -> workers continus -ksp-job-api -> jobs terminables +ksp-interface-api +ksp-wallet-api +ksp-onchain-transport-api +ksp-offchain-transport-api +ksp-scenario-api +ksp-job-control-lib +ksp-data-api ``` -Aucune API commune worker+job n'est prévue. +## Transport -## Execution policy et orchestration +`ksp-onchain-transport-lib` doit couvrir l'intégralité des opérations documentées de la surface ciblée par chaque release. Les statuts deprecated/obsolete encore fonctionnels et unstable/experimental restent exposés avec warning runtime KSP. -La frontière détaillée est définie dans [`007-EXECUTION_AND_POLICY.md`](007-EXECUTION_AND_POLICY.md). +La Config standard Transport appartient à `ksp-config-lib`, qui adapte vers les settings publics du transport ; le transport ne dépend jamais de Config. -Principes retenus : +Les WebSockets supportent plusieurs sessions pour un même endpoint URL, mais un pool/scheduler automatique n'est créé qu'après besoin démontré. -```text -PreparedProgramExecution - | - v -ksp-execution-lib - | | | - policy wallet onchain transport -``` - -- `ksp-execution-lib` dépend de `ksp-program-api`, pas de `ksp-program-lib` ; -- une policy est explicitement fournie pour toute exécution réelle ; -- la policy peut être évaluée à plusieurs checkpoints ; -- une policy décide/contraint mais n'exécute pas de réseau/signature/UI ; -- Program constraints, options caller et policy constraints restent trois sources distinctes ; -- wallet/signers et transport/provider sont fournis par la composition supérieure ; -- simulation/submission/status sont des primitives transport orchestrées par execution ; -- signature est une capacité wallet orchestrée par execution ; -- retry réseau identique et retry de lifecycle d'exécution restent distincts ; -- une approbation externe peut suspendre/reprendre l'exécution sans faire dépendre la policy de l'UI ; -- aucun accès Store depuis `ksp-execution-lib`. - -`ksp-logging-lib` est consommé transversalement par les crates runtime qui doivent logger, sans imposer une dépendance aux crates `*-api` déclaratives ni à `ksp-core-lib`. - -## Transport on-chain - -Aucune crate `ksp-onchain-transport-api` n'est prévue. - -`ksp-onchain-transport-lib` peut contenir plusieurs familles hétérogènes : - -- HTTP RPC ; -- WebSocket RPC ; -- Helius avancé ; -- Yellowstone ; -- autres providers/transports futurs. - -Les adapters providers doivent toutefois faire sortir de la crate des **modèles de transport homogènes par catégorie de donnée**, afin que les consommateurs n'aient pas à comprendre chaque réponse propriétaire. - -Ces modèles : - -- restent indépendants de `ksp-store-api` ; -- conservent les informations raw/provenance nécessaires ; -- ne réalisent aucun décodage métier/protocolaire ; -- doivent être facilement et explicitement convertibles par `ksp-worker-raw-retriever` vers les modèles raw persistants de `ksp-store-api`. - -Les principes de cette frontière sont désormais fixés : transport et Store restent indépendants, et la conversion explicite transport -> D1 appartient au pipeline/composant de composition. Les DTO exacts seront définis avec les premières implémentations Transport/Store. - -## Transport off-chain - -Aucune crate `ksp-offchain-transport-api` ni trait global `OffchainTransport` n'est prévu. - -`ksp-offchain-transport-lib` regroupe volontairement des accès hétérogènes afin d'éviter une explosion de petites crates. Metadata externes, quotes, prix hors blockchain ou routage peuvent conserver des APIs/modules spécialisés à l'intérieur de cette crate sans prétendre partager une abstraction métier commune. +Les providers Yellowstone spécifiques restent des extensions futures ; le contrat standard est provider-neutral. ## Wallet -Aucune crate `ksp-wallet-api` n'est prévue. +Le format natif est `.kspwallet`. -`ksp-wallet-lib` est propriétaire du format wallet KSP, des opérations de protection/import/export et de l'accès contrôlé aux capacités pubkey/secret/signature nécessaires aux couches supérieures. +Les anciens temporary wallets JSON ne sont pas migrés. -Les applications futures utilisant ce wallet restent des consommateurs de `ksp-wallet-lib`, pas des implémentations alternatives du contrat wallet. +`WalletPolicy` est exclu du Wallet et relève de l'execution policy. -## Workers +Import/export reste extensible ; les formats supplémentaires sont suivis dans `docs/IDEAS.md`. -### `ksp-worker-api` - -`ksp-worker-api` est une **lifecycle API de services continus**. - -Elle pourra porter des contrats communs comme identité, état, health, start/stop/shutdown et événements de lifecycle. Une capacité optionnelle comme la reconfiguration à chaud ne doit devenir universelle que si plusieurs workers la partagent réellement. - -Elle ne contient aucun concept de progression/checkpoint terminal propre aux jobs. - -### `ksp-worker-control-lib` - -`ksp-worker-control-lib` est une implémentation réutilisable de gouvernance au-dessus de `ksp-worker-api`. - -Elle doit pouvoir être consommée par : - -- une application desktop manager spécialisée ; -- une future application globale ; -- un éventuel orchestrateur commun si un besoin opérationnel concret le justifie ; -- des tools/tests lorsque pertinent. - -Les applications restent des interfaces et ne réimplémentent pas elles-mêmes registre, dispatch start/stop, agrégation d'état ou reconfiguration générique. - -### Packaging des workers - -Chaque package `ksp-worker-` doit pouvoir fournir : +## Data plane ```text -library target - -> logique/runtime service réutilisable - -binary target - -> bootstrap autonome mince +RAW -> CORE -> DECODE -> SPECIALIZED ``` -Cette direction permet de tester/réutiliser la logique sans perdre la propriété « service indépendant ». +- RAW : acquisition replayable ; +- CORE : normalisation blockchain générique sans decoder Program ; +- DECODE : interpretation Program + matérialisation générique/journal ; +- SPECIALIZED : projections queryables de domaine. -Le binaire autonome n'est pas une seconde implémentation du worker. +## Progression des processors -### Workers de processing +RAW et CORE sont complétés couche par couche avec jobs/workers/apps utiles. -Le modèle initial d'un unique W2 est remplacé par une chaîne de responsabilités plus étroites : +À partir de DECODE, progression verticale par groupe : ```text -raw persisted - | - v -ksp-worker-core-processor - | - v -canonical Core - | - v -ksp-worker-generic-materializer - | - v -generic materialization/journal - | - v -ksp-worker-domain-projector - | - v -domain projections +wire -> decode -> materialize -> specialized -> prepare -> policy -> execute -> scenario ``` -Le nom `ksp-worker-domain-projector` est explicitement provisoire jusqu'à ce que les contrats de matérialisation spécialisée soient définis. - -## Jobs - -`ksp-job-api` est une **lifecycle API de travaux déclenchés et terminables**. - -Elle peut porter identité, état, progression, cancel, résultat et, lorsque pertinent, pause/resume/checkpoint. - -Aucune `ksp-job-control-lib` n'est prévue actuellement. Le fait que plusieurs jobs implémentent `ksp-job-api` suffit tant qu'aucune duplication concrète de gouvernance ne justifie une bibliothèque commune. - -## Notifications de données - -Les notifications de données restent indépendantes du lifecycle des workers et des jobs. - -Le même type de donnée persistée doit produire le même contrat de notification quelle que soit son origine : +Groupes prioritaires : ```text -worker live -----\ -job backfill -----+--> même notification de donnée -import -----------/ +Solana Core Programs +SPL token/trading +token metadata +Anchor +Meteora +Raydium +Pump +Orca +Market Desk V1 +Jupiter/OKX routing +Market Desk V2 +trading-adjacent +general decoding ``` -`ksp-store-api` reste le propriétaire candidat de ces références/notifications lorsqu'elles signifient qu'une donnée persistée est disponible. +Meteora vaults, Pump fees et autres satellites nécessaires restent dans leur groupe. -Le transport de notification reste distinct du contrat de donnée. +## Applications spécialisées -## Scénarios et demos +Les applications servent de validations/exploitations réelles sans absorber la logique des bibliothèques. -Aucune crate monolithique de scénarios n'est prévue. +Market Desk est progressive : V1 après les DEX prioritaires, puis enrichissement routing après Jupiter/OKX. -Les scénarios vivent dans des crates spécialisées : +## Questions restantes -```text -ksp-scenario-memo-lib -ksp-scenario-token-lib -ksp-scenario-ata-lib -ksp-scenario-token-2022-lib -ksp-scenario-metadata-lib -ksp-scenario-spm-lib -... -``` - -`ksp-scenario-api` n'est pas retenu actuellement. La norme commune est documentée dans `docs/rules/SCENARIO_CONVENTION.md` et peut évoluer avec les premières implémentations. - -Les applications de démonstration correspondantes suivent la forme : - -```text -ksp-app-scenario---desk-demo -``` - -Exemples : - -```text -ksp-app-scenario-memo-devnet-desk-demo -ksp-app-scenario-token-2022-devnet-desk-demo -ksp-app-scenario-metadata-devnet-desk-demo -``` - -Chaque application appelle la crate `ksp-scenario--lib` correspondante et ne duplique pas son scénario. La crate scenario doit également pouvoir être appelée hors desktop. - -## Applications spécialisées et control plane - -Les applications spécialisées sont prioritaires sur une future application globale. - -Une app worker spécialisée passe par `ksp-worker-control-lib` / `ksp-worker-api` et ne manipule pas directement l'état interne du worker dans le Store. - -Le data plane est D1–D4. Le control plane porte start/stop/status/health/reconfigure et reste séparé des payloads de processing. - -Les workers doivent être exploitables comme services autonomes. Le mécanisme IPC exact reste à définir à la première implémentation manager/service ; aucun `ksp-ipc-api` générique n'est créé maintenant. - -Une future application globale est conservée dans `docs/IDEAS.md` seulement. - -## Pipelines - -`ksp-pipeline-lib` reste rejeté. - -Le premier besoin concret de réutilisation est maintenant identifié : worker live et job de replay/backfill doivent partager la même logique d'une frontière durable. - -Pipelines retenus : - -```text -ksp-pipeline-raw-ingestion-lib -ksp-pipeline-core-processing-lib -ksp-pipeline-generic-materialization-lib -ksp-pipeline-domain-projection-lib -``` - -Les pipelines sont backend/implementation agnostic autant que possible : ils dépendent des APIs (`ksp-store-api`, `ksp-program-api`, `ksp-materializer-api`) et reçoivent les implémentations concrètes par composition depuis worker/job. - -## Modèle opérationnel workers/jobs - -Le backlog de processing est défini par les inputs applicables moins les processing outcomes terminaux du processor/version/capability cible. - -L'absence d'output n'est pas une preuve d'absence de traitement. - -KSP retient : - -```text -notification wake-up + periodic polling -Store backlog = source de vérité -claim/lease = ownership temporaire -at-least-once + idempotence = sémantique de traitement -``` - -Le raw retriever expose une hot reconfiguration avec distinction desired/effective configuration. - -Les jobs de replay restent distincts des workers continus et réutilisent les mêmes pipelines. - -## Corrections issues de `pre.003` - -Le graphe confirme les principes suivants : - -- Program et Materializer restent indépendants du store et des I/O réseau ; -- `ksp-execution-policy-api` et `ksp-execution-lib` sont retenus ; -- `ksp-execution-lib` consomme `ksp-program-api`, pas l'implémentation officielle `ksp-program-lib` ; -- `ksp-materializer-api` peut dépendre de `ksp-program-api`, mais ni Materializer API/lib ni Store API/lib ne se dépendent mutuellement ; -- les workers/jobs spécialisés réalisent les conversions explicites entre modèles de transport, processing et persistence ; -- aucun `ksp-data-api` global n'est introduit ; -- `ksp-worker-control-lib` est retenu comme gouvernance workers réutilisable ; aucune `ksp-job-control-lib` n'est retenue. - -## Questions restantes après la fondation - -- types Rust exacts des contrats ouverts de `ksp-program-api` ; -- DTO exacts des modèles transport et D1/D2/D3/D4 avec les premières implémentations concernées ; -- schémas SQL, indexes, claims/leases et pagination du Store PostgreSQL ; -- première implémentation manager/service : mécanisme IPC et proxy distant Worker ; -- contexte requis par les projectors stateful ; -- futur : orchestrateur commun seulement si un besoin opérationnel concret le justifie ; l'application globale reste un produit futur après validation des apps spécialisées. +- noms exacts de Price Desk et Backfill Desk ; +- surface exacte Yellowstone après audit normatif de `0.2.6-pre.001` ; +- nécessité future d'un pool automatique WS ; +- types exacts `ksp-program-api`/`ksp-materializer-api`/`ksp-store-api` ; +- nom/packaging précis du premier RAW worker et du CORE normalizer ; +- granularité des workers DECODE/SPECIALIZED par groupe. diff --git a/docs/architecture/005-DEPENDENCY_GRAPH.md b/docs/architecture/005-DEPENDENCY_GRAPH.md index d8de513..66e0809 100644 --- a/docs/architecture/005-DEPENDENCY_GRAPH.md +++ b/docs/architecture/005-DEPENDENCY_GRAPH.md @@ -1,204 +1,204 @@ - + # Graphe de dépendances KSP ## Objet -Ce document constitue la sortie principale de `0.0.3-pre.003`. - -Il répond à la question : **quels composants peuvent dépendre de quels autres composants, et où doivent se produire la composition, l'I/O et les conversions de modèles ?** - -Convention des graphes : - -```text -A -> B -``` - -signifie : **A peut dépendre de B**. - -Le graphe exprime une direction architecturale. Une dépendance autorisée n'est pas obligatoire si l'implémentation peut rester plus faible. +Ce document décrit les directions de dépendances retenues. Il complète les règles de naming/API et le plan de progression fonctionnelle. ## Principes structurants -### 1. APIs sous les implémentations - -Une crate `ksp--api` est placée sous les implémentations de son domaine. +### APIs sous les implémentations ```text -implementation -> domain-api +ksp-program-api <- ksp-program-lib / external program libs +ksp-materializer-api <- ksp-materializer-lib / external materializers +ksp-store-api <- ksp-store-lib / alternative backends +ksp-worker-api <- concrete workers / control adapters +ksp-job-api <- concrete jobs ``` -Une API publique ne dépend pas de son implémentation officielle. +Une crate `*-api` est créée uniquement lorsqu'un vrai besoin d'extension/backend/lifecycle le justifie. -### 2. Transformations séparées de l'I/O +### Transformations séparées de l'I/O -Les bibliothèques de sémantique/transformation comme `ksp-program-lib` et `ksp-materializer-lib` ne deviennent pas propriétaires : +Transport, persistence, Program decoding, materialization et execution restent séparés. -- du transport réseau ; -- du wallet ; -- du backend PostgreSQL ; -- du lifecycle d'un worker/job. +### Composition supérieure -Les workers, jobs, scenarios et pipelines spécialisés composent ces capacités lorsqu'ils ont réellement besoin d'I/O. +Les applications/jobs/workers/scenarios composent les implementations concrètes. Les couches basses ne dépendent pas de leurs consommateurs. -### 3. Modèles de domaine distincts des DTO persistants +### Workers et jobs distincts -KSP ne crée pas actuellement un `ksp-data-api` global. +Workers continus et jobs bornés gardent des lifecycle APIs séparées. -Chaque frontière possède les modèles nécessaires à sa responsabilité : - -- transport : modèles homogènes de transport ; -- program : contrats de décodage/opération préparée ; -- materializer : entrées/sorties de matérialisation ; -- store : modèles persistants et références de données persistées. - -La conversion entre ces modèles est explicite dans la couche qui relie les deux responsabilités, principalement les workers/jobs spécialisés. - -### 4. Composition supérieure pour l'exécution - -`ksp-program-lib` ne dépend pas de `ksp-wallet-lib` ou de `ksp-onchain-transport-lib`. - -Le cycle signature/simulation/envoi/confirmation est composé au-dessus, par `ksp-execution-lib`. - -### 5. Workers et jobs restent deux familles - -`ksp-worker-api` et `ksp-job-api` n'ont pas de parent lifecycle commun. - -Un orchestrateur futur peut consommer les deux familles séparément sans les fusionner. - ---- - -# Graphe fondations N1 +# Fondations N1 ```text ksp-core-lib -ksp-logging-lib -> ksp-core-lib -ksp-config-lib -> ksp-core-lib -ksp-config-lib -> ksp-logging-lib # warnings/diagnostics Config runtime -ksp-interface-lib -> ksp-core-lib -ksp-interface-lib -> ksp-logging-lib # lorsque du runtime logging est nécessaire -``` - -`ksp-core-lib` ne dépend d'aucun composant KSP supérieur. - -`ksp-interface-lib` est propriétaire de la façade wire et peut dépendre des crates externes Solana/interface explicitement autorisées par `RULES_DEPENDENCIES.md`. - -`ksp-logging-lib` est la façade logging/tracing KSP et peut dépendre de `ksp-core-lib` pour `Error` / `Result`. `ksp-core-lib` n'a pas de dépendance inverse vers le logging. Les composants comportant du runtime peuvent dépendre directement de `ksp-logging-lib`; cette permission n'oblige pas les crates purement déclaratives à le faire. Depuis `0.1.3-pre.010`, `ksp-config-lib` utilise cette dépendance pour ses warnings/diagnostics runtime, sans dépendance inverse Logging -> Config. - ---- - -# Graphe Logging - -```text ksp-logging-lib -> ksp-core-lib - -> tracing / tracing-appender / tracing-subscriber -runtime crate +ksp-config-lib + -> ksp-core-lib -> ksp-logging-lib ``` -`ksp-logging-lib` est la seule façade KSP propriétaire de l'initialisation/configuration tracing. Une crate runtime KSP n'utilise pas directement `tracing`, `tracing-subscriber` ou `tracing-appender` pour émettre ses propres événements/spans. +`ksp-logging-lib` est la façade unique de tracing KSP. -Le subscriber global KSP est installé une seule fois puis sa configuration peut être rechargée à chaud par `ksp-logging-lib`. Les targets externes sont silencieux par défaut ; les informations tierces utiles sont réémises par le composant KSP propriétaire sous son propre target. +`ksp-config-lib` est l'unique propriétaire des documents Config, `.env` et variables KSP/KSPB. -Exception technique possible : une application/framework, notamment Tauri, peut devoir intégrer un plugin tracing. Cette adaptation ne crée pas une seconde politique de logging parallèle et les événements KSP restent émis via la façade KSP. +# Transport on-chain -`ksp-core-lib` et les crates `*-api` purement déclaratives n'ont pas de dépendance logging obligatoire. +```text +ksp-onchain-transport-lib + -> ksp-core-lib + -> ksp-logging-lib + -> external HTTP/WS/gRPC crates réellement nécessaires +``` ---- +Interdictions : -# Propriété des codecs wire +```text +ksp-onchain-transport-lib -X-> ksp-config-lib +ksp-onchain-transport-lib -X-> ksp-store-api +ksp-onchain-transport-lib -X-> ksp-store-lib +ksp-onchain-transport-lib -X-> ksp-program-api +ksp-onchain-transport-lib -X-> ksp-program-lib +``` -Pour les surfaces wire officielles KSP : +Le transport possède ses settings publics runtime. + +Lorsque Config fournit un document standard Transport : + +```text +ksp-config-lib + -> ksp-onchain-transport-lib # adapter vers les contrats publics Transport + +ksp-onchain-transport-lib + -X-> ksp-config-lib +``` + +Cette direction est analogue à Config -> Logging : Config exprime/adapte la configuration, le composant reste propriétaire de ses contrats runtime. + +## HTTP + +```text +HttpEndpointConfig +HttpRoleConfig +HttpEndpointPool + | + v +JSON-RPC read/write methods +``` + +Le pool HTTP sélectionne des endpoints/clients logiques selon rôles/capabilities/priorités/limites. + +## WebSocket + +```text +WsEndpoint + 1 -> N WsSession + +WsSession + 1 -> N WsSubscription +``` + +Plusieurs sessions sur une même URL sont autorisées. Un scheduler/pool automatique de sessions n'est pas imposé tant qu'un besoin réel ne le justifie pas. + +Helius LaserStream WebSocket étend le même moteur/session ; il ne duplique pas le client standard. + +## Yellowstone + +Yellowstone gRPC est un backend standard/provider-neutral. Les adapters/capabilities Helius/Triton/ERPC/Chainstack/Shyft peuvent venir plus tard sans redéfinir le contrat générique. + +# Transport off-chain + +```text +ksp-offchain-transport-lib + -> ksp-core-lib + -> ksp-logging-lib + -> external HTTP/client crates nécessaires +``` + +Aucune `ksp-offchain-transport-api` globale n'est prévue. + +La première surface est un reader de prix ; metadata HTTP/IPFS/Arweave et autres besoins sont ajoutés lorsqu'ils deviennent concrets. + +# Wallet + +```text +ksp-wallet-lib + -> ksp-core-lib + -> ksp-logging-lib + -> low-level crypto/key primitives explicitement retenues +``` + +Interdictions : + +```text +ksp-wallet-lib -X-> ksp-config-lib +ksp-wallet-lib -X-> ksp-onchain-transport-lib +ksp-wallet-lib -X-> ksp-execution-policy-api +``` + +Le Wallet stocke/ouvre/signe. Il ne décide pas si une dépense est autorisée. + +`WalletPolicy` historique migre conceptuellement vers execution policy, pas vers `ksp-wallet-lib`. + +# Interface / wire ```text ksp-interface-lib - -> codecs wire nécessaires (borsh/wincode/...) + -> ksp-core-lib + -> ksp-logging-lib lorsque runtime logging réel + -> official/compatible wire dependencies retenues ``` -`ksp-program-lib` n'ajoute pas directement une autre génération de codec pour les mêmes surfaces. +`ksp-interface-lib` contient **à la fois** la façade wire officielle et une API publique wire utilisable par les implémentations Program officielles/externes. -Une extension Program externe peut temporairement posséder son wire lorsqu'il n'est pas encore officiellement intégré à `ksp-interface-lib`. +Aucune `ksp-interface-api` séparée n'est retenue actuellement. -Le critère d'adoption d'une crate d'interface externe inclut la compatibilité de son graphe de dépendances avec le stack KSP actuel. +Interdictions : ---- +```text +ksp-interface-lib -X-> ksp-program-api +ksp-interface-lib -X-> ksp-program-lib +ksp-interface-lib -X-> transport +ksp-interface-lib -X-> Store +ksp-interface-lib -X-> Wallet +``` -# Graphe Program +# Program ```text ksp-program-api -> ksp-core-lib - -> ksp-interface-lib + -> ksp-interface-lib si types wire publics communs nécessaires ksp-program-lib -> ksp-program-api -> ksp-interface-lib -> ksp-core-lib + -> ksp-logging-lib ``` -## Frontière de `ksp-program-api` - -`ksp-program-api` doit porter les contrats publics nécessaires à une implémentation externe de decoder/execution preparation. - -Il est également le propriétaire candidat du **contrat d'opération préparée** produit par la sémantique programme et consommé par la couche d'exécution. - -Le contrat de préparation retenu est centré sur : - -```text -ProgramExecutionRequest - ↓ -ProgramExecutionPreparer - ↓ -PreparedProgramExecution -``` - -Les champs Rust exacts restent à définir avec la première implémentation, sans rouvrir la séparation préparation/exécution. - -## Interdictions Program - -```text -ksp-program-api -X-> ksp-wallet-lib -ksp-program-api -X-> ksp-onchain-transport-lib -ksp-program-api -X-> ksp-store-api -ksp-program-api -X-> ksp-materializer-api - -ksp-program-lib -X-> ksp-wallet-lib -ksp-program-lib -X-> ksp-onchain-transport-lib -ksp-program-lib -X-> ksp-store-api -ksp-program-lib -X-> ksp-store-lib -ksp-program-lib -X-> ksp-materializer-lib -ksp-program-lib -X-> ksp-execution-lib -``` - -Le decoder/execution preparation de programme reste donc testable sans réseau, wallet ou base de données. - ---- - - -## Implémentations Program externes - -Une implémentation externe peut dépendre de : +Une extension externe : ```text ksp-program--lib -> ksp-program-api - -> ksp-core-lib - -> ksp-interface-lib # lorsque le wire officiel nécessaire existe + -> ksp-interface-lib si interface officielle disponible ``` -Elle ne dépend pas obligatoirement de `ksp-program-lib`. +Elle n'a pas besoin de dépendre de `ksp-program-lib`. -Le runtime peut composer registry officiel + registry/implémentations externes derrière `ksp-program-api`. - -# Graphe Execution / Policy +# Execution / Policy ```text ksp-execution-policy-api - -> ksp-program-api -> ksp-core-lib ksp-execution-lib @@ -206,615 +206,270 @@ ksp-execution-lib -> ksp-execution-policy-api -> ksp-wallet-lib -> ksp-onchain-transport-lib + -> ksp-core-lib -> ksp-logging-lib - -> ksp-core-lib ``` -`ksp-execution-lib` ne dépend pas de `ksp-program-lib` et reçoit fondamentalement une opération déjà préparée conforme à `ksp-program-api`. - -## Policy obligatoire et multi-checkpoints - -Toute exécution réelle reçoit explicitement une implémentation de `ksp-execution-policy-api`. - -La policy peut être consultée à plusieurs checkpoints (préflight, après simulation, avant submission ou autres points réellement justifiés). Le contrat exact ne doit pas imposer plus de callbacks que nécessaire. - -La policy peut autoriser/refuser/ajouter des requirements, mais n'appelle ni wallet, ni transport, ni UI. - -## Composition supérieure - -Le caller fournit notamment : - -- réseau/provider/transport sélectionné ; -- wallet/signers sélectionnés ; -- options d'exécution. - -`ksp-execution-lib` vérifie/compose ces éléments avec les contraintes techniques de `PreparedProgramExecution` et les contraintes supplémentaires de policy. - -## Simulation / signature / submission / confirmation - -- primitive simulation/submission/status -> `ksp-onchain-transport-lib` ; -- orchestration de ces étapes -> `ksp-execution-lib` ; -- primitive signature -> `ksp-wallet-lib` ; -- résolution/coordination des signers -> `ksp-execution-lib`. - -## Retry - -Retry technique d'un appel réseau identique -> transport. - -Retry qui change le lifecycle (nouveau blockhash, reconstruction, resimulation, resignature, resubmission) -> execution, éventuellement limité par policy. - -## Approbation externe - -Une policy peut produire un requirement d'approbation externe. `ksp-execution-lib` peut retourner un état suspendu/reprenable ; l'UI obtient l'approbation sans être appelée directement par la policy ou l'execution lib. - -## Store +Interdiction structurante : ```text -ksp-execution-policy-api -X-> ksp-store-api -ksp-execution-lib -X-> ksp-store-api -ksp-execution-lib -X-> ksp-store-lib +ksp-execution-lib -X-> ksp-program-lib ``` -La persistence d'un `ExecutionOutcome` est une composition supérieure. +Une petite policy spécifique peut vivre dans une crate scenario/orchestrateur. Une ou plusieurs bibliothèques de policies communes ne sont créées qu'après démonstration d'une réutilisation réelle. ---- - -# Graphe Wallet +# Data plane durable ```text -ksp-wallet-lib - -> ksp-core-lib +D1 RAW + -> D2 CORE + -> D3 DECODE + -> D4 SPECIALIZED ``` -`ksp-wallet-lib` peut consommer config/logging si nécessaire à son implémentation, sans que ces dépendances deviennent partie obligatoire du contrat wallet. +## RAW + +```text +transport model + | + v +composition/RAW ingestion + | + v +ksp-store-api + | + v +ksp-store-lib +``` + +## CORE + +```text +D1 RAW + | + v +Solana generic normalizer + | + v +D2 CORE +``` + +Le normalizer CORE peut utiliser `ksp-interface-lib` pour des wires Solana génériques. Interdictions : ```text -ksp-wallet-lib -X-> ksp-program-lib -ksp-wallet-lib -X-> ksp-execution-lib -ksp-wallet-lib -X-> ksp-store-lib +RAW -> CORE -X-> ksp-program-api +RAW -> CORE -X-> ksp-program-lib +RAW -> CORE -X-> ksp-materializer-api ``` -Le wallet fournit les capacités de clés/signature ; il n'orchestre pas une opération Solana. - ---- - -# Graphe Transport - -## On-chain +## DECODE ```text -ksp-onchain-transport-lib - -> ksp-core-lib +D2 CORE + | + v +ksp-program-api implementation + | + v +decoded facts + | + v +ksp-materializer-api implementation + | + v +D3 DECODE / generic journal ``` -Il peut consommer config/logging lorsque nécessaire. - -Il peut posséder plusieurs familles internes : +## SPECIALIZED ```text -HTTP RPC -WS RPC -Helius advanced -Yellowstone -... +D3 DECODE + | + v +specialized projector/materializer + | + v +D4 SPECIALIZED ``` -sans créer `ksp-onchain-transport-api`. - -### Modèles homogènes - -Chaque famille provider convertit ses réponses propriétaires vers des modèles KSP homogènes **à l'intérieur de la frontière transport**. - -Exemple conceptuel : - -```text -Solana RPC ------\ -Helius -----------+--> transport raw model -Yellowstone ------/ -``` - -Ces modèles : - -- sont indépendants du store ; -- conservent le raw et la provenance nécessaire ; -- sont faciles à convertir vers les modèles persistants. - -Interdiction ferme : - -```text -ksp-onchain-transport-lib -X-> ksp-store-api -ksp-onchain-transport-lib -X-> ksp-store-lib -``` - -## Off-chain - -```text -ksp-offchain-transport-lib - -> ksp-core-lib -``` - -Config/logging sont autorisés selon le besoin. - -La crate reste volontairement hétérogène. Aucun `ksp-offchain-transport-api` global n'est introduit. - ---- - -# Graphe Materialization +# Materialization ```text ksp-materializer-api -> ksp-core-lib - -> ksp-program-api ksp-materializer-lib -> ksp-materializer-api - -> ksp-program-api -> ksp-core-lib + -> ksp-logging-lib ``` -`ksp-interface-lib` peut être consommée par une implémentation de materializer lorsqu'un contrat wire officiel est réellement requis, sans devenir une dépendance obligatoire de l'API. +Program/Materializer ne dépendent pas du Store backend. -## Capacités - -`ksp-materializer-api` doit permettre de distinguer conceptuellement : - -```text -GenericMaterializer - D2 runtime/Core -> output générique D3 - -DomainProjector - D3/canonical inputs -> output spécialisé D4 -``` - -Les noms exacts ne sont pas figés. - -## Indépendance du Store - -```text -ksp-materializer-api -X-> ksp-store-api -ksp-materializer-lib -X-> ksp-store-api -ksp-materializer-lib -X-> ksp-store-lib -``` - -Un materializer transforme ; un worker/job/pipeline spécialisé convertit son output vers le DTO Store et le persiste. - -Une implémentation externe peut produire un output générique D3 sans migration PostgreSQL spécialisée. - ---- - -# Graphe Store +# Store ```text ksp-store-api -> ksp-core-lib ksp-store-lib - -> ksp-store-api - -> ksp-core-lib - -> ksp-config-lib - -> ksp-logging-lib -``` - -PostgreSQL est l'implémentation de référence. - -## Niveaux durables - -```text -D1 Raw -D2 Core canonique -D3 journal de matérialisation générique -D4 projections spécialisées -``` - -`ksp-store-api` possède les contrats persistants de ces niveaux sans dépendre des modèles runtime de Program/Materializer/Transport. - -Interdictions : - -```text -ksp-store-api -X-> ksp-program-api -ksp-store-api -X-> ksp-materializer-api -ksp-store-api -X-> ksp-onchain-transport-lib - -ksp-store-lib -X-> ksp-program-lib -ksp-store-lib -X-> ksp-materializer-lib -ksp-store-lib -X-> ksp-onchain-transport-lib -``` - -Les composants de composition réalisent les conversions explicites. - -## Replay - -Les frontières de replay restent indépendantes : - -```text -D1 -> D2 -D2 -> D3 -D3 -> D4 -``` - -Les jobs de replay consomment le Store et les processors appropriés ; ils ne sont pas des modes des workers live. - -## Notifications persistées - -`ksp-store-api` possède le contrat canonique de notification lorsqu'une donnée durable est disponible. - -```text -live worker ----\ -backfill job ----+--> PersistedDataAvailable (nom conceptuel) -import ----------/ -replay ----------/ -``` - -La notification est un signal de réveil et peut être perdue ou dupliquée. - -Le consumer reconstruit toujours son backlog via le Store, les versions de processor et les marqueurs d'idempotence. - -L'ordre est : - -```text -persist -commit -notify -``` - -Le payload privilégie une référence durable compacte. - -Le contrat reste indépendant du mécanisme. PostgreSQL `LISTEN/NOTIFY` est retenu comme mécanisme initial de référence de wake-up, combiné à un polling périodique du backlog. - ---- - -# Graphe des pipelines spécialisés - -Les pipelines réutilisent une frontière de processing sans prendre le lifecycle worker/job. - -```text -ksp-pipeline-raw-ingestion-lib - -> ksp-onchain-transport-lib - -> ksp-store-api - -> ksp-core-lib - -> ksp-logging-lib - -ksp-pipeline-core-processing-lib - -> ksp-program-api - -> ksp-store-api - -> ksp-core-lib - -> ksp-logging-lib - -ksp-pipeline-generic-materialization-lib - -> ksp-materializer-api - -> ksp-store-api - -> ksp-core-lib - -> ksp-logging-lib - -ksp-pipeline-domain-projection-lib - -> ksp-materializer-api -> ksp-store-api -> ksp-core-lib -> ksp-logging-lib + -> PostgreSQL dependencies ``` Interdictions : ```text -pipelines -X-> ksp-store-lib -core-processing pipeline -X-> ksp-program-lib -materialization pipelines -X-> ksp-materializer-lib -pipelines -X-> ksp-worker-api -pipelines -X-> ksp-job-api +ksp-store-api -X-> transport/program/materializer +ksp-store-lib -X-> transport/program/materializer ``` -Les workers/jobs fournissent les implémentations officielles ou externes aux pipelines. +La première release Store (`0.3.1`) est RAW-only ; les contrats CORE/DECODE/SPECIALIZED sont ajoutés avec leurs couches. ---- - -# Graphe lifecycle Worker - -```text -ksp-worker-api - -> ksp-core-lib - -ksp-worker-control-lib - -> ksp-worker-api - -> ksp-core-lib -``` - -`ksp-worker-control-lib` ne dépend pas des workers concrets. Il fournit une gouvernance réutilisable au-dessus de l'API. - -Les managers/apps/orchestrateurs composent les implémentations concrètes avec cette bibliothèque. - -Interdictions : - -```text -ksp-worker-api -X-> ksp-job-api -ksp-worker-control-lib -X-> ksp-job-api -``` - -Le contrôle des jobs ne fuit pas dans la gouvernance workers. - ---- - -# Graphe lifecycle Job +# Jobs ```text ksp-job-api -> ksp-core-lib ``` -Aucune `ksp-job-control-lib` n'est prévue actuellement. - -Interdictions : - -```text -ksp-job-api -X-> ksp-worker-api -ksp-job-api -X-> ksp-worker-control-lib -``` - -Un futur orchestrateur peut utiliser workers et jobs séparément sans créer de superclass lifecycle commune. - ---- - -# Graphe des composants concrets d'acquisition/processing - -## `ksp-worker-raw-retriever` - -```text -ksp-worker-raw-retriever - -> ksp-worker-api - -> ksp-pipeline-raw-ingestion-lib - -> ksp-onchain-transport-lib - -> ksp-store-lib - -> ksp-config-lib - -> ksp-logging-lib -``` - -Il pilote l'acquisition live, puis transmet chaque modèle transport homogène au pipeline raw ingestion. - -Il possède une capacité spécifique de hot reconfiguration et distingue configuration desired/effective. - -## `ksp-job-backfill` +Premier job pressenti : ```text ksp-job-backfill -> ksp-job-api - -> ksp-pipeline-raw-ingestion-lib -> ksp-onchain-transport-lib - -> ksp-store-lib + -> ksp-store-api -> ksp-config-lib -> ksp-logging-lib ``` -Il pilote pagination/range/checkpoint historique puis transmet les modèles acquis au même pipeline D1 que W1. +Il remplit RAW et ne décode rien. -## `ksp-worker-core-processor` +# Workers ```text -ksp-worker-core-processor - -> ksp-worker-api - -> ksp-pipeline-core-processing-lib - -> ksp-program-lib # composition officielle - -> ksp-store-lib - -> ksp-config-lib - -> ksp-logging-lib -``` - -Une composition alternative peut fournir une implémentation externe compatible avec `ksp-program-api`. - -## `ksp-job-replay-core` - -```text -ksp-job-replay-core - -> ksp-job-api - -> ksp-pipeline-core-processing-lib - -> ksp-program-lib ou implémentation compatible - -> ksp-store-lib - -> ksp-config-lib - -> ksp-logging-lib -``` - -Worker live et replay partagent donc exactement la logique D1 -> D2. - -## `ksp-worker-generic-materializer` - -```text -ksp-worker-generic-materializer - -> ksp-worker-api - -> ksp-pipeline-generic-materialization-lib - -> ksp-materializer-lib # composition officielle - -> ksp-store-lib - -> ksp-config-lib - -> ksp-logging-lib -``` - -## `ksp-job-replay-generic-materialization` - -```text -ksp-job-replay-generic-materialization - -> ksp-job-api - -> ksp-pipeline-generic-materialization-lib - -> ksp-materializer-lib ou implémentation compatible - -> ksp-store-lib - -> ksp-config-lib - -> ksp-logging-lib -``` - -## `ksp-worker-domain-projector` - -```text -ksp-worker-domain-projector - -> ksp-worker-api - -> ksp-pipeline-domain-projection-lib - -> ksp-materializer-lib # projectors officiels - -> ksp-store-lib - -> ksp-config-lib - -> ksp-logging-lib -``` - -## `ksp-job-replay-domain-projection` - -```text -ksp-job-replay-domain-projection - -> ksp-job-api - -> ksp-pipeline-domain-projection-lib - -> ksp-materializer-lib ou implémentation compatible - -> ksp-store-lib - -> ksp-config-lib - -> ksp-logging-lib -``` - -## Backlog / notification - -Tous les workers de processing : - -```text -LISTEN/NOTIFY wake-up - + -periodic polling - | - v -Store backlog query - | - v -claim/lease bounded batch - | - v -pipeline - | - v -outputs + processing outcome -``` - -La notification ne remplace jamais le Store. - ---- - -# Graphe applications / services / control plane - -## Worker service autonome - -```text -package ksp-worker- - -library target - -> ksp-worker-api - -> pipeline spécialisé - -> implémentations KSP nécessaires - -binary target - -> library target du même package - -> ksp-config-lib - -> ksp-logging-lib - -> bootstrap/service control adapter -``` - -Le binaire ne contient pas une seconde logique de processing. - -## App worker spécialisée - -```text -ksp-app-worker--desk - -> ksp-worker-control-lib - -> ksp-worker-api - -> future remote proxy / IPC adapter -``` - -L'app ne dépend pas du worker concret pour réimplémenter son lifecycle interne. - -## Data plane - -```text -transport -> D1 -> D2 -> D3 -> D4 -``` - -## Control plane - -```text -specialized app/tool - | - v -ksp-worker-control-lib - | - v ksp-worker-api - | - v -local handle / future remote proxy + -> ksp-core-lib + +ksp-worker-control-lib + -> ksp-worker-api + -> ksp-core-lib ``` -Jobs restent parallèlement sous `ksp-job-api`. +RAW worker et CORE worker sont introduits à la fin de leur couche respective, lorsque persistence/backlog sont disponibles. -Interdictions : +Les workers DECODE/SPECIALIZED sont introduits avec les groupes Program concernés plutôt que tous anticipés en bloc. + +# Apps + +## Wallet Desk ```text -worker A -X-> worker B -control plane -X-> payload transfer D1/D2/D3/D4 -scenario demo app -X-> duplicate scenario workflow +ksp-app-wallet-desk + -> ksp-config-lib + -> ksp-wallet-lib + -> ksp-onchain-transport-lib + -> ksp-logging-lib ``` -Aucun `ksp-ipc-api` générique n'est retenu maintenant. +L'app compose ; elle ne déplace pas Config/Wallet/Transport dans Tauri. ---- +## Price Desk -# Scenarios et applications demo +```text +price desk + -> ksp-config-lib + -> ksp-offchain-transport-lib + -> ksp-logging-lib +``` -La logique du scénario s'exécute dans la crate scenario elle-même et reste appelable sans desktop. +## Backfill app -Une crate scénario peut composer les capacités nécessaires à son domaine : +```text +backfill app + -> ksp-job-api + -> concrete backfill job + -> ksp-config-lib + -> ksp-logging-lib +``` + +## Market Desk + +```text +ksp-app-market-desk + -> ksp-store-api + -> live transport only where explicitly useful + -> KSP domain/query contracts +``` + +Elle consomme les projections SPECIALIZED normalisées ; elle ne dépend pas directement des bibliothèques protocole externes. + +# Scenarios ```text ksp-scenario--lib -> ksp-program-api - -> ksp-program-lib + -> program implementation(s) -> ksp-execution-policy-api -> ksp-execution-lib -> ksp-wallet-lib -> ksp-onchain-transport-lib - -> ksp-config-lib + -> ksp-config-lib si configuration nécessaire ``` -Toutes ces dépendances ne sont pas obligatoires pour chaque scénario. +Une policy Devnet petite et spécifique peut être implémentée dans la crate scenario. -La crate scénario peut implémenter une policy Devnet adaptée à son besoin. +L'app demo correspondante reste un adapter UI mince. -L'application correspondante reste une interface : +# Progression verticale Program + +À partir de DECODE : ```text -ksp-app-scenario--devnet-desk-demo - -> ksp-scenario--lib +wire + -> decode + -> materialize/D3 + -> specialized/D4 si utile + -> prepare + -> policy + -> execute + -> Devnet scenario ``` -Le scenario ne réside jamais dans l'application. +Les satellites nécessaires restent dans le même groupe protocolaire. -Elle peut dépendre de bibliothèques KSP d'interface/configuration strictement nécessaires à son UI, mais ne réimplémente ni scénario ni policy métier. +# Contrôle des cycles ---- - -# Orchestrateur futur — concept uniquement - -Un futur orchestrateur pourra être au-dessus des contrôles spécialisés, mais aucune crate n'est retenue comme livrable actuel. - -Conceptuellement : +Le sens général reste descendant : ```text -orchestrator - -> ksp-worker-control-lib - -> ksp-job-api # séparément, si coordination de jobs nécessaire - -> autres contrôles spécialisés au besoin +core + <- interface + <- program-api + <- program implementations + +store-api + <- store-lib + +worker-api + <- worker-control / workers + +job-api + <- jobs ``` -Cette dépendance simultanée ne crée pas d'API lifecycle commune. +Les applications/orchestrateurs réalisent les compositions explicites ; aucune boucle inverse ne doit être créée pour éviter une conversion au bon niveau. -L'orchestrateur coordonne ; il ne fusionne pas les modèles worker/job. - ---- - -# Dépendances explicitement non retenues - -Les composants suivants ne sont pas introduits dans le graphe actuel : +# Dépendances non retenues actuellement ```text ksp-api-lib +ksp-interface-api ksp-onchain-transport-api ksp-offchain-transport-api ksp-wallet-api @@ -824,43 +479,4 @@ ksp-pipeline-lib ksp-data-api ``` -Ils pourront être réévalués uniquement si un besoin concret démontre que la frontière actuelle ne suffit plus. - ---- - -# Contrôle des cycles - -Le graphe impose notamment : - -```text -core - <- interface - <- program-api - <- materializer-api - -store-api - <- store-lib - -worker-api - <- worker-control - -job-api - <- concrete jobs -``` - -et interdit toute boucle inverse depuis les couches basses vers leurs consommateurs. - -Les conversions entre Program/Materializer/Store ne sont pas résolues par des dépendances croisées mais par des composants de composition explicites. - ---- - -# Questions restantes - -Les grandes frontières de dépendances sont désormais fixées. Restent à résoudre avec les premières implémentations : - -- types Rust exacts de `ksp-program-api`, `ksp-materializer-api` et `ksp-store-api` ; -- représentation ouverte/persistable des résultats Program ; -- schémas SQL, transactions, claims/leases et pagination PostgreSQL ; -- mécanisme IPC du premier manager de worker autonome ; -- injection du contexte nécessaire aux `DomainProjector` stateful ; -- éventuel orchestrateur commun uniquement si un besoin opérationnel concret apparaît. +Elles ne seront réévaluées qu'après démonstration d'un besoin concret. diff --git a/docs/architecture/006-WIRE_AND_PROGRAM.md b/docs/architecture/006-WIRE_AND_PROGRAM.md index f38ac8b..b1534bd 100644 --- a/docs/architecture/006-WIRE_AND_PROGRAM.md +++ b/docs/architecture/006-WIRE_AND_PROGRAM.md @@ -1,5 +1,5 @@ - + # Wire, Program API et implémentations Program @@ -46,6 +46,21 @@ Les Program IDs fondamentaux restent possédés par `ksp-core-lib`. - policy/safety ; - lifecycle d'exécution réseau. +## API publique de `ksp-interface-lib` + +`ksp-interface-lib` reste une seule crate pour l'instant : aucune `ksp-interface-api` séparée n'est créée. + +La façade doit néanmoins exposer une API publique wire stable et réutilisable par : + +```text +ksp-program-lib +external ksp-program--lib +``` + +Une implementation externe peut donc expérimenter contre les mêmes contrats wire publics avant intégration officielle dans KSP. Lorsqu'un wire externe devient officiel, son intégration dans `ksp-interface-lib` doit rester compatible avec l'API publique retenue, sauf évolution de contrat explicitement versionnée/documentée. + +Si une future contrainte de dépendances démontre qu'un split `ksp-interface-api` apporte une valeur réelle, il pourra être étudié selon `KSP-API-007`; la symétrie avec Program ne suffit pas. + ## Propriété des codecs wire Pour le code KSP officiel, les dépendances directement utilisées pour encoder/décoder les formats wire, notamment `borsh`, `wincode` ou codecs équivalents, appartiennent normalement à `ksp-interface-lib`. @@ -403,6 +418,18 @@ Les validations peuvent combiner selon le cas : Une crate externe provoquant volontairement une génération incompatible de dépendances fondamentales ne doit pas être ajoutée au workspace simplement pour faciliter un test si des fixtures/vecteurs indépendants permettent la même vérification. +## Progression verticale par groupe + +Après les couches RAW/CORE, les Program implementations ne sont pas développées horizontalement comme une longue liste de decoders isolés. Chaque groupe prioritaire avance successivement : + +```text +wire -> decode -> materialize -> specialized -> execution preparation -> policy -> execution -> scenario +``` + +Un composant satellite nécessaire à un protocole reste dans son groupe : Meteora vaults avec Meteora, Pump fee avec Pump, etc. + +Ordre prioritaire actuel : Solana Core Programs, SPL token/trading, token metadata, Anchor, Meteora, Raydium, Pump, Orca, routing, trading-adjacent puis décodage généraliste. + ## Questions laissées ouvertes La première implémentation Program devra encore fixer précisément : @@ -415,4 +442,4 @@ La première implémentation Program devra encore fixer précisément : - stratégie précise de warning/log pour opérations abandonnées ; - convention finale `dec` / `exec_prep`. -La tranche suivante doit traiter `ksp-execution-policy-api` et `ksp-execution-lib` sans rouvrir les responsabilités Program définies ici. +Les releases exactes d'introduction de `ksp-program-lib`, `ksp-execution-policy-api` et `ksp-execution-lib` suivent désormais les vertical slices définis par le roadmap ; les responsabilités Program décrites ici restent valables. diff --git a/docs/architecture/007-EXECUTION_AND_POLICY.md b/docs/architecture/007-EXECUTION_AND_POLICY.md index 949c3b6..cd5ce65 100644 --- a/docs/architecture/007-EXECUTION_AND_POLICY.md +++ b/docs/architecture/007-EXECUTION_AND_POLICY.md @@ -1,5 +1,5 @@ - + # Execution et Policy @@ -311,6 +311,18 @@ ksp-execution-lib -X-> ksp-store-api ksp-execution-lib -X-> ksp-store-lib ``` +## Ownership des implementations de policy + +`ksp-execution-policy-api` est le contrat commun. Une crate générale `ksp-execution-policy-lib` n'est pas créée par symétrie. + +Une petite policy strictement propre à un scenario, un orchestrateur ou une application spécialisée peut être implémentée directement dans cette crate. Une ou plusieurs bibliothèques de policies communes ne sont introduites que lorsque plusieurs consommateurs démontrent une réutilisation réelle. + +Les anciennes règles historiques de type `WalletPolicy` qui concernent limites de dépense, réseau, programme, simulation ou autorisation sont déplacées conceptuellement vers cette frontière policy et non vers `ksp-wallet-lib`. + +## Execution dans les vertical slices + +L'exécution n'est pas reportée après « tous les decoders ». Pour chaque groupe Program prioritaire, les opérations pertinentes avancent après décodage/matérialisation jusqu'à préparation, policy, execution et scénarios Devnet lorsque le réseau/protocole permet une validation réelle. + ## Questions laissées à l'implémentation - types Rust exacts des checkpoints et décisions de policy ; diff --git a/docs/architecture/008-DATA_MATERIALIZATION_AND_STORE.md b/docs/architecture/008-DATA_MATERIALIZATION_AND_STORE.md index 58227f0..93f8f44 100644 --- a/docs/architecture/008-DATA_MATERIALIZATION_AND_STORE.md +++ b/docs/architecture/008-DATA_MATERIALIZATION_AND_STORE.md @@ -1,614 +1,344 @@ - + # Data, Materialization et Store ## Objet -Ce document constitue la sortie principale de `0.0.3-pre.006`. +Ce document définit la chaîne durable KSP, la responsabilité du Store et les frontières de replay. -Il définit les frontières durables de données KSP et précise : - -- les niveaux D1 à D4 ; -- la séparation `ksp-materializer-api` / `ksp-materializer-lib` / Store ; -- le rôle backend-agnostic de `ksp-store-api` ; -- PostgreSQL comme implémentation de référence de `ksp-store-lib` ; -- provenance et temporalités ; -- idempotence et versionnement des processors ; -- replay indépendant par frontière ; -- sémantique des notifications de données persistées ; -- stabilité différente entre niveaux structurants et projections spécialisées. - -Le lifecycle complet, batching, concurrence, backlog et reprise des workers/jobs sont détaillés dans `009-ACQUISITION_WORKERS_AND_JOBS.md`. - -## Nomenclature des niveaux durables - -Les niveaux de données ne réutilisent pas N1 à N4, déjà réservés aux couches architecturales KSP. - -La nomenclature durable retenue est : +La nomenclature canonique est désormais : ```text -D1 — Raw -D2 — Core canonique -D3 — Journal de matérialisation générique -D4 — Projections spécialisées/queryables par domaine +RAW -> CORE -> DECODE -> SPECIALIZED ``` -Flux général : +Les aliases D1–D4 restent utilisés pour les niveaux persistés : ```text -source on-chain - | - v -ksp-worker-raw-retriever - | - v -D1 Raw - | - v -ksp-worker-core-processor - | - v -D2 Core canonique - | - v -ksp-worker-generic-materializer - | - v -D3 journal générique - | - v -ksp-worker-domain-projector - | - v -D4 projections de domaine +D1 = RAW +D2 = CORE +D3 = DECODE / matérialisation générique décodée +D4 = SPECIALIZED ``` -Le nom `ksp-worker-domain-projector` reste révisable ; la frontière D3 -> D4 est, elle, retenue. +Cette clarification remplace l'ancienne interprétation où D1 -> D2 pouvait déjà dépendre de `ksp-program-api`. **RAW et CORE sont indépendants de tout decoder Program.** -# D1 — Raw +## Principes structurants + +- le Store persiste des contrats de données ; il ne possède ni transport, ni decoder, ni materializer ; +- chaque frontière durable peut être rejouée indépendamment ; +- les données de provenance/versioning permettent de savoir quel processor a produit quel output ; +- les couches dérivées ne rendent jamais obligatoire une nouvelle acquisition réseau lorsque l'input durable nécessaire existe déjà ; +- D4 privilégie les faits métier génériques lorsqu'une normalisation inter-protocoles est pertinente. + +# D1 — RAW ## Mission -D1 conserve l'acquisition suffisamment fidèlement pour permettre un nouveau processing sans redemander la donnée à la blockchain lorsque l'information nécessaire a déjà été capturée. +RAW conserve l'acquisition suffisamment fidèlement pour reconstruire CORE sans redemander la donnée au provider lorsqu'elle a déjà été capturée. -`raw` ne signifie pas nécessairement « enveloppe propriétaire du provider conservée sans aucune normalisation ». Le transport peut normaliser ses différentes sources vers des modèles KSP homogènes. +Le transport peut normaliser plusieurs providers vers un modèle KSP homogène, mais D1 doit rester lossless pour les besoins de replay couverts. -La persistance D1 doit toutefois rester **lossless pour les besoins de replay couverts** : toute information nécessaire à la reconstruction du Core doit être conservée, y compris le contenu brut et la provenance utile. +D1 ne décode aucun programme Solana/SPL/Metaplex/DEX. -## Frontière transport -> D1 +## Frontière Transport -> RAW ```text -Solana RPC ------\ -Helius -----------+--> modèle homogène ksp-onchain-transport-lib -Yellowstone ------/ - | - v - conversion explicite - | - v - DTO D1 de ksp-store-api +HTTP / WS / gRPC / provider + | + v +ksp-onchain-transport-lib + | + v +conversion explicite + | + v +ksp-store-api RAW DTO + | + v +ksp-store-lib ``` `ksp-onchain-transport-lib` ne dépend ni de `ksp-store-api` ni de `ksp-store-lib`. -La conversion appartient au composant de composition, principalement `ksp-worker-raw-retriever` ou `ksp-job-backfill`. +## Provenance RAW -## Provenance D1 +Selon la catégorie, D1 doit pouvoir conserver notamment : -Selon la catégorie de donnée, D1 doit pouvoir conserver notamment : - -- réseau ; -- identité blockchain : slot, signature, pubkey ou autre identifiant applicable ; -- contenu raw/replayable ; +- cluster/network ; +- slot/signature/pubkey/identité blockchain applicable ; +- payload replayable ; - provider ; -- transport/source ; -- rôle d'acquisition : live, backfill, import ou autre ; -- instant d'observation/acquisition ; +- endpoint/source/transport ; +- rôle d'acquisition : live, backfill, import ; +- instant d'observation ; - instant de persistence ; -- hash/identité d'idempotence ; -- informations de pagination/capture nécessaires à la reprise lorsque pertinentes. +- identité/hash d'idempotence ; +- cursor/page/range/checkpoint lorsque pertinent. -`block_time` reste optionnel et n'est jamais inventé lorsqu'il n'est pas fourni ou reconstructible de manière fiable. - -# D2 — Core canonique +# D2 — CORE ## Mission -D2 contient les faits canoniques Solana produits à partir de D1. +CORE est une **normalisation canonique générique de la blockchain Solana**. -Le Core doit être suffisamment durable et général pour être rejoué vers les matérialisations futures sans repasser par l'acquisition ou le décodage raw. +Cette couche doit fonctionner même si `ksp-program-api` et `ksp-program-lib` ne sont pas encore capables de décoder le moindre programme métier. -Conceptuellement, D2 peut accueillir notamment : +Exemples de faits CORE candidats : -- transactions canoniques ; -- instructions top-level ; -- instructions CPI ; -- comptes/états canoniques ; -- résultats de décodage Program ouverts ; -- événements/return data lorsqu'ils sont supportés ; -- autres faits génériques Solana qui appartiennent réellement au Core. +- slots ; +- blocks et block metadata ; +- signatures ; +- transactions ; +- messages legacy/versioned ; +- account keys et address lookups ; +- comptes et états bruts structurés génériquement ; +- instructions top-level brutes ; +- instructions CPI brutes ; +- logs ; +- transaction meta ; +- balances/fees/rewards lorsqu'ils appartiennent au contrat blockchain générique ; +- return data brute ; +- relations structurelles transaction/message/instruction/account. -## Top-level / CPI +Un fait CORE peut contenir un `program_id`, des bytes et des indexes sans savoir que l'instruction représente un `Transfer`, un `Swap` ou une mutation Metadata. -Les instructions top-level et CPI restent des faits distincts. - -Leur modèle peut partager des champs, mais KSP ne doit pas les fusionner artificiellement lorsque leurs invariants ou requêtes diffèrent. - -La séparation physique exacte sera décidée dans la première release Store. - -## Frontière D1 -> D2 +## Frontière RAW -> CORE ```text -DTO D1 store - | - v -ksp-worker-core-processor - | - +--> conversion vers entrée ksp-program-api - | - +--> ksp-program-lib / extension compatible - | - +--> sortie Core ouverte - | - v -conversion vers DTO D2 store +D1 RAW + | + v +normalisation Solana générique + | + v +D2 CORE ``` -`ksp-program-api` / `ksp-program-lib` restent indépendants du Store. +Interdictions : -## Provenance D2 +```text +RAW -> CORE -X-> ksp-program-api +RAW -> CORE -X-> ksp-program-lib +RAW -> CORE -X-> ksp-materializer-api +``` -D2 doit pouvoir relier un résultat à : +Les codecs/wires génériques nécessaires à la structure Solana peuvent provenir de `ksp-interface-lib` lorsqu'ils appartiennent à la façade wire officielle, sans transformer cette étape en décodage Program. + +## Provenance CORE + +D2 doit pouvoir relier chaque résultat à : - son input D1 ; -- l'identité/version du processor ; -- l'identité/version de l'implémentation Program/decoder lorsque pertinente ; -- la capacité de décodage utilisée ; -- un hash de l'input logique ; +- l'identité/version du normalizer CORE ; +- un hash logique d'input ; - l'instant de processing/persistence ; -- l'état de processing lorsqu'un lifecycle durable est nécessaire. +- son état de processing durable lorsque nécessaire. -# D3 — Journal de matérialisation générique +# D3 — DECODE / matérialisation générique ## Mission -D3 est un **journal durable**, pas une étape volatile. +DECODE commence lorsque KSP interprète un `program_id`, un layout d'instruction, un compte ou un événement selon un contrat Program/protocole. -Il conserve l'équivalent conceptuel obligatoire de l'ancien journal `k_sol_mat_outputs` de `ks-store`, sans figer encore le nom exact de la table KSP. - -Il doit permettre de répondre à des questions telles que : +La progression logique d'un groupe est : ```text -quel input D2 ? +CORE + | + v +decoder Program + | + v +decoded facts + | + v +materialisation générique / journal durable + | + v +D3 DECODE +``` + +D3 conserve l'équivalent conceptuel obligatoire du journal générique de matérialisation de bot3 (`k_sol_mat_outputs`), sans imposer son ancien schéma ou son nom physique. + +Le journal doit pouvoir répondre au minimum : + +```text +quel input CORE ? +quel program/decoder ? +quelle version ? quel materializer ? quelle version ? quel output logique ? quel type/domaine ? quel hash ? quel instant ? -quel état courant/superseded/failed/replay ? +quel état/superseded/failed/replay ? ``` -D3 permet notamment de reconstruire D4 après évolution d'un projector sans refaire D1 -> D2 ou D2 -> D3. +Les types exacts de decoded facts et du journal sont décidés lorsque les premiers vertical slices Program existent. -## Frontière D2 -> D3 +## Frontière CORE -> DECODE ```text -D2 Core +D2 CORE | v -ksp-worker-generic-materializer - | - +--> conversion vers ksp-materializer-api - | - +--> GenericMaterializer +ksp-program-api implementation | v -generic materialization output +decoded output | v -conversion vers DTO D3 store +ksp-materializer-api implementation + | + v +D3 journal / decoded materialization ``` -Les noms Rust exacts ne sont pas figés. +Les implémentations officielles pourront provenir de `ksp-program-lib` et `ksp-materializer-lib`; des implémentations externes compatibles restent possibles. -## Extensibilité externe +Program et Materializer ne dépendent pas du backend Store. -Une implémentation externe de materializer doit pouvoir produire un output générique compatible avec D3 sans exiger une nouvelle table PostgreSQL spécialisée. - -Cela rend possible : - -```text -external materializer - | - v -ksp-materializer-api - | - v -D3 journal générique -``` - -avant une éventuelle intégration officielle complète en D4. - -# D4 — Projections spécialisées de domaine +# D4 — SPECIALIZED ## Mission -D4 contient les représentations optimisées pour les requêtes métier, analytiques et produit. - -Exemples futurs : - -- assets/tokens ; -- metadata d'assets/tokens ; -- Solana Program Metadata ; -- liquidity pools ; -- order books ; -- swaps/trades ; -- prices/volumes ; -- positions ; -- autres projections de domaine. - -## Faits canoniques, pas familles par protocole - -D4 reste organisé par **fait canonique**, pas par Program ID/protocole. - -Éviter par défaut : - -```text -meteora_pools -raydium_pools -orca_pools -``` - -au profit d'une projection canonique telle que : - -```text -liquidity_pools -``` - -avec provenance/identité du protocole lorsque nécessaire. - -La même règle s'applique aux swaps, order books et autres faits pouvant être normalisés. - -## Metadata - -Les metadata d'assets/tokens constituent une famille canonique commune pouvant recevoir des données provenant notamment : - -- Metaplex Token Metadata ; -- Token-2022 Metadata. - -Solana Program Metadata reste une projection distincte car le domaine fonctionnel est différent. - -## Nouvelle projection externe - -Une nouvelle projection D4 relationnelle implique nécessairement un contrat de persistence et une implémentation backend. - -KSP ne masque pas cette réalité derrière une API de matérialisation « magique ». - -Une extension externe peut fonctionner jusqu'à D3 sans migration Store spécialisée. Pour obtenir une nouvelle projection D4 officielle, il faut intégrer : - -- le contrat DTO/repository approprié dans `ksp-store-api` ; -- la migration/repository PostgreSQL dans `ksp-store-lib` ; -- la conversion/projector appropriée dans le composant de processing. - -Un mécanisme de backend/projection entièrement externe pourra être étudié seulement si un besoin concret apparaît. - -# Stabilité des niveaux durables - -La direction retenue est : - -```text -D1 — fortement stable -D2 — fortement stable -D3 — fortement stable -D4 — volontairement plus évolutif -``` - -Après stabilisation de la première série Store réelle, les contrats D1/D2/D3 doivent changer seulement en cas : - -- d'erreur structurelle ; -- d'omission majeure ; -- de nécessité de compatibilité impossible à résoudre additivement. - -D4 peut évoluer plus librement lorsque de nouveaux décodeurs, materializers ou produits révèlent des besoins queryables supplémentaires. - -# `ksp-materializer-api` - -## Rôle - -Une seule crate publique est retenue : - -```text -ksp-materializer-api -``` - -Elle expose les contrats de matérialisation réutilisables sans dépendre du Store. - -Deux capacités conceptuelles doivent pouvoir être distinguées : - -```text -GenericMaterializer -DomainProjector -``` - -Les noms exacts restent à valider. - -### GenericMaterializer - -Transforme une représentation Core/runtime en output générique persistable en D3. - -### DomainProjector - -Transforme un ou plusieurs inputs génériques/canoniques en représentation spécialisée de domaine destinée à D4. - -Le second contrat peut évoluer en fonction des premiers cas réels. La séparation des responsabilités est plus importante que le nom du trait. - -## Dépendances - -```text -ksp-materializer-api - -> ksp-core-lib - -> ksp-program-api -``` - -Pas de dépendance vers Store. - -# `ksp-materializer-lib` - -`ksp-materializer-lib` contient les implémentations officielles KSP de `ksp-materializer-api`. - -Organisation conceptuelle possible : - -```text -generic/ - ... - -domain/ - metadata/ - token/ - dex/ - ... -``` - -La structure finale suivra les règles de domaine établies avec les premières implémentations. - -Interdictions : - -```text -ksp-materializer-lib -X-> ksp-store-api -ksp-materializer-lib -X-> ksp-store-lib -``` - -Un materializer transforme ; il ne persiste pas directement. - -Le worker/job/pipeline spécialisé relie la transformation à la persistence. - -# `ksp-store-api` - -## Rôle - -`ksp-store-api` expose la frontière backend-agnostic de persistence KSP. - -Il possède les contrats persistants correspondant aux niveaux durables : - -```text -raw -core -materialization -domain -``` - -La structure exacte des modules Rust sera définie avec la première implémentation. - -`ksp-store-api` ne dépend pas de Program, Materializer ou Transport. - -## Contrats génériques et contrats de domaine - -D1/D2/D3 doivent rester génériques et fortement structurants. - -D4 peut croître progressivement avec les domaines officiellement supportés. - -Cette différence est volontaire : l'API Store doit pouvoir ajouter de nouvelles projections queryables sans déstabiliser les contrats de replay historiques. - -# `ksp-store-lib` - -`ksp-store-lib` est l'implémentation officielle de référence de `ksp-store-api`. - -PostgreSQL est le backend de référence prévu. - -La crate possède notamment : - -- configuration backend/connexion ; -- pool/transactions backend ; -- migrations ; -- repositories ; -- queries ; -- persistence D1/D2/D3/D4 ; -- primitives de backlog/replay nécessaires au backend ; -- mécanismes PostgreSQL de notification lorsqu'ils sont retenus. - -Les autres crates KSP ne contournent pas `ksp-store-lib` pour exécuter directement leurs propres opérations PostgreSQL. - -Un second backend n'est pas créé abstraitement ; il devra justifier l'évolution de l'architecture lorsqu'un besoin réel apparaît. - -# Temporalités - -Les temporalités blockchain et locales sont distinctes. - -Exemples blockchain : - -```text -slot -block_time: Option<...> -``` - -Exemples locaux : - -```text -observed_at -acquired_at -persisted_at -processed_at -materialized_at -projected_at -``` - -Toutes ne doivent pas nécessairement être présentes dans chaque DTO/table. Leur sémantique doit cependant être explicite lorsqu'elles existent. - -Aucune date locale ne remplace silencieusement un `block_time` absent. - -# Provenance - -Un niveau dérivé doit permettre de remonter à son input durable et au processor qui l'a produit. - -## D1 - -Provenance d'acquisition : - -- network ; -- provider/source ; -- transport ; -- rôle d'acquisition ; -- identité blockchain ; -- temporalités d'observation/persistence. - -## D2 - -En plus : - -- input D1 ; -- processor/decoder identity ; -- processor/decoder version ; -- input hash ; -- processing time/state. - -## D3 - -En plus : - -- input D2 ; -- materializer identity/version ; -- output identity/type/domain ; -- output/input hash ; -- materialization time/state. - -## D4 - -En plus : - -- input(s) D3 ou références canoniques explicitement définies ; -- projector identity/version ; -- projection time/state. - -La représentation exacte de la provenance sera conçue pour éviter de répéter inutilement de gros payloads. - -# Idempotence et versionnement - -Chaque frontière dérivée doit pouvoir rejouer le même input sans créer de doublons logiquement distincts. - -Principe conceptuel : - -```text -same logical input -+ same processor identity -+ same processor version -+ same logical output identity -= same durable result -``` - -Une nouvelle version du processor doit pouvoir coexister avec ou superséder le résultat précédent selon la politique du niveau. - -Le système doit pouvoir représenter selon besoin des états tels que : - -```text -current -superseded -pending -failed -replay -``` - -Les noms, colonnes et contraintes SQL exacts seront décidés avec la première implémentation. - -L'idempotence ne doit pas reposer uniquement sur l'espoir qu'une notification soit livrée une seule fois. - -# Replay - -Les replays sont séparés par frontière durable : - -```text -D1 -> D2 -D2 -> D3 -D3 -> D4 -``` - -Ils doivent pouvoir être exécutés indépendamment. +SPECIALIZED expose des projections queryables utiles aux applications, analyses et futurs modèles ML. Exemples : -- nouveau decoder/Core processor : rejouer D1 -> D2 ; -- nouveau materializer générique : rejouer D2 -> D3 ; -- nouvelle version d'un projector : rejouer D3 -> D4. +- token/asset state ; +- metadata canonique d'asset ; +- pools/markets ; +- reserves/liquidity ; +- positions ; +- swaps/trades ; +- fees ; +- observations de prix ; +- OHLC/candles ; +- routes et legs ; +- faits trading-adjacent ; +- projections d'autres domaines futurs. -Il ne doit pas être nécessaire de refaire toute la chaîne lorsqu'un niveau inférieur inchangé contient déjà l'information requise. +## Faits métier génériques -Les replays sont des **jobs bornés**, pas des modes cachés des workers live. +Les projections de trading ne sont pas séparées automatiquement par protocole. -Les jobs de replay retenus sont `ksp-job-replay-core`, `ksp-job-replay-generic-materialization` et `ksp-job-replay-domain-projection`. - -# Notifications de données persistées - -## Contrat - -`ksp-store-api` est le propriétaire du contrat canonique lorsqu'une notification signifie : - -> une donnée durable de telle catégorie/référence est disponible. - -Le même type de donnée utilise le même format de notification quelle que soit son origine : +Préférer lorsque possible : ```text -worker live -backfill job -import -replay -autre source +liquidity_pools +trades +positions +price_observations +ohlc +routes +route_legs ``` -## Notification != source de vérité - -Une notification est un **signal de réveil/accélération**, jamais la source de vérité du backlog. - -Elle peut être : - -- perdue ; -- dupliquée ; -- retardée ; -- reçue après un restart. - -Le consumer doit toujours pouvoir reconstruire son travail depuis le Store. - -Exemple conceptuel : +plutôt que : ```text -notification RawAvailable - | - v -wake-up core worker - | - v -store query: -"quels inputs D1 ne sont pas encore traités - par CoreProcessor version X ?" +meteora_trades +raydium_trades +orca_trades +pump_trades ``` -Le Store, l'idempotence et les checkpoints durables constituent la vérité. +Les champs réellement protocol-specific peuvent être conservés dans une extension ou une projection dédiée uniquement lorsqu'un besoin de requête/invariant le justifie. -Cette règle évite d'exiger immédiatement un broker exactly-once. +## Metadata -## Ordre de publication +La direction reste : -Une donnée n'est annoncée disponible qu'après persistence réussie : +- projection canonique commune pour metadata d'assets/tokens alimentée par Metaplex Token Metadata et Token-2022 Metadata ; +- SPM reste distinct et sera redéveloppé plus tard avec le décodage généraliste. + +## OHLC + +Les candles sont des projections SPECIALIZED calculées à partir des trades/price observations persistés. + +Une application marché lit les OHLC matérialisés ; elle ne reparcourt pas toutes les transactions pour reconstruire les candles à chaque affichage. + +# Vertical slices Program + +RAW et CORE sont développés horizontalement. + +À partir de DECODE, la progression est verticale par groupe : + +```text +wire + -> decode + -> generic materialization / D3 + -> specialized projection / D4 si utile + -> execution preparation + -> execution policy + -> execution + -> Devnet scenarios / validation +``` + +Un groupe doit atteindre une cohérence verticale suffisante avant que le groupe suivant devienne prioritaire. + +Les composants satellites nécessaires à un protocole appartiennent à son groupe : Pump fees avec Pump, Meteora vaults avec Meteora, etc. + +# `ksp-store-api` + +`ksp-store-api` est backend-agnostic et porte les contrats nécessaires aux consommateurs. + +La première implementation `0.3.1` est volontairement **RAW-only** : elle ne crée pas prématurément les contrats physiques D2/D3/D4. + +Les surfaces CORE/DECODE/SPECIALIZED sont ajoutées quand leurs couches sont réellement ouvertes. + +# `ksp-store-lib` + +`ksp-store-lib` fournit PostgreSQL comme backend officiel de référence derrière `ksp-store-api`. + +Il possède : + +- migrations ; +- SQL ; +- transactions ; +- mapping backend ; +- pagination ; +- claim/lease lorsque nécessaire ; +- notifications backend si retenues. + +Il ne possède pas : + +- transport réseau ; +- decoder Program ; +- materializer ; +- orchestration de worker/job. + +# `ksp-materializer-api` et `ksp-materializer-lib` + +Ils sont introduits seulement lorsque le premier groupe DECODE démontre le contrat réel. + +`ksp-materializer-api` porte les contrats extensibles ; `ksp-materializer-lib` contient les implementations officielles communes. + +Une projection très locale/spécifique peut rester dans son groupe si la création d'une implémentation commune séparée n'apporte pas de réutilisation réelle. + +# Replay + +Les frontières durables restent replayables indépendamment : + +```text +RAW -> CORE +CORE -> DECODE +DECODE -> SPECIALIZED +``` + +Un replay d'une couche dérivée ne doit pas refaire arbitrairement les couches précédentes. + +# Notifications persistées + +Le Store reste source de vérité du backlog. + +Les notifications ne sont qu'un wake-up : elles peuvent être perdues ou dupliquées. + +Ordre : ```text persist @@ -616,118 +346,35 @@ commit notify ``` -et non : - -```text -notify -persist -``` - -## Payload - -La notification privilégie une référence durable compacte plutôt que la duplication de tout le payload : - -- catégorie/type ; -- réseau ; -- identifiant/range/cursor durable ; -- autres informations minimales nécessaires au consumer. - -Les noms de DTO exacts restent à définir. - -## Mécanisme de diffusion - -Le contrat est indépendant du mécanisme. - -Candidats : - -```text -channel in-process -PostgreSQL LISTEN/NOTIFY -IPC -broker externe -``` - -`ksp-store-lib` peut fournir PostgreSQL LISTEN/NOTIFY comme mécanisme de référence si cela répond au premier besoin. - -Le mécanisme initial de référence et la reprise opérationnelle sont détaillés dans `009-ACQUISITION_WORKERS_AND_JOBS.md`. +Le consumer reconstruit toujours son backlog depuis le Store avec les versions de processor et les marqueurs d'idempotence. # Acquisition live et backfill -`ksp-worker-raw-retriever` et `ksp-job-backfill` diffèrent par leur lifecycle/orchestration mais produisent le **même contrat D1** pour la même catégorie de donnée. +Live et backfill alimentent la même frontière RAW : ```text -live source ----------\ - +--> D1 Raw -historical backfill --/ +live worker ----\ + +--> RAW persistence +backfill job ----/ ``` -Cela garantit que le processing downstream ne dépend pas de la manière dont la donnée a été acquise. +Ils ne dupliquent pas le contrat durable. -Le backfill n'est pas un mode historique du worker live. +# Stabilité -# Workers de processing +La stabilité cible est différente selon la couche : -Les frontières de responsabilité sont désormais : - -```text -ksp-worker-raw-retriever - transport -> D1 - -ksp-worker-core-processor - D1 -> D2 - -ksp-worker-generic-materializer - D2 -> D3 - -ksp-worker-domain-projector - D3 -> D4 -``` - -Chaque worker : - -- peut utiliser les notifications pour réduire la latence ; -- doit pouvoir reconstruire son backlog depuis le Store ; -- écrit seulement le niveau durable dont il est propriétaire ; -- ne transforme pas silencieusement plusieurs frontières en une étape monolithique. - -Le lifecycle, la concurrence, les cursors/checkpoints et la hot reconfiguration sont détaillés dans `009-ACQUISITION_WORKERS_AND_JOBS.md`. - -# Projections de trading et autres domaines - -Le trading reste une priorité produit mais ne détermine pas la structure D1/D2/D3. - -D4 doit accueillir progressivement des faits canoniques de nombreux domaines : - -- token ; -- metadata ; -- staking ; -- programmes ; -- trading/DEX ; -- autres domaines futurs. - -Pour le trading, les materializers/projectors doivent normaliser les noms et structures propres aux protocoles vers des faits communs lorsque les invariants le permettent. +- RAW : fortement stable après mise en production ; +- CORE : fortement stable après validation de la normalisation Solana générique ; +- DECODE : extensible par nouveaux Program/versions ; +- SPECIALIZED : plus évolutif selon les besoins de query, trading et analytics. # Questions laissées ouvertes -La première implémentation Store devra encore fixer : - -- schémas SQL et noms exacts des tables ; -- clés/idempotence exactes ; -- représentation des hashes ; -- états de processing exacts ; -- temporalités obligatoires/optionnelles par table ; -- format exact des DTO D1/D2/D3 ; -- structure des repositories/transactions backend ; -- pagination/cursors ; -- conversion u64/slot/PostgreSQL ; -- stratégie des migrations initiales. - -Les sujets opérationnels worker/job ont été précisés dans `009-ACQUISITION_WORKERS_AND_JOBS.md`. - -Restent à définir à l'implémentation : - -- schémas SQL et contraintes exactes ; -- format concret des DTO D1/D2/D3/D4 ; -- claim/lease PostgreSQL ; -- contexte des projectors stateful ; -- mécanisme IPC des managers de services autonomes. +- schémas SQL exacts RAW puis CORE ; +- représentation persistable exacte d'un decoded output ; +- contrat exact du journal D3 ; +- granularité des projectors SPECIALIZED ; +- politique de supersession/versioning des outputs ; +- fenêtres OHLC initiales ; +- mécanisme de contexte pour les projections stateful. diff --git a/docs/architecture/009-ACQUISITION_WORKERS_AND_JOBS.md b/docs/architecture/009-ACQUISITION_WORKERS_AND_JOBS.md index 8808131..c7964b8 100644 --- a/docs/architecture/009-ACQUISITION_WORKERS_AND_JOBS.md +++ b/docs/architecture/009-ACQUISITION_WORKERS_AND_JOBS.md @@ -1,183 +1,215 @@ - + # Acquisition, workers, jobs et pipelines spécialisés ## Objet -Ce document constitue la sortie principale de `0.0.3-pre.007`. - -Il transforme les frontières durables D1–D4 en modèle opérationnel et définit : - -- quatre pipelines spécialisés correspondant chacun à une frontière durable ; -- quatre workers continus ; -- le job de backfill historique ; -- trois jobs de replay indépendants ; -- la séparation worker/job lifecycle ; -- le backlog durable par input + processor/version ; -- les processing outcomes ; -- claim/lease et concurrence multi-instance ; -- at-least-once + idempotence plutôt qu'un faux exactly-once ; -- reprise après crash ; -- notification wake-up + periodic polling ; -- hot reconfiguration du raw retriever ; -- batching, backpressure et métriques opérationnelles minimales. - -Les apps spécialisées, services autonomes, control plane, scenarios et frontière IPC sont détaillés dans `010-APPS_SERVICES_SCENARIOS_AND_CONTROL.md`. Une application globale reste future ; un orchestrateur commun n'est pas une crate retenue actuellement. - -# Principe : une frontière de processing, une logique réutilisable - -Un worker live et un job de replay ne doivent pas réimplémenter séparément la même transformation durable. - -KSP introduit donc les premiers pipelines spécialisés justifiés par un besoin concret : +Ce document définit le lifecycle opérationnel autour des couches : ```text -ksp-pipeline-raw-ingestion-lib -ksp-pipeline-core-processing-lib -ksp-pipeline-generic-materialization-lib -ksp-pipeline-domain-projection-lib +RAW -> CORE -> DECODE -> SPECIALIZED ``` -Il ne s'agit pas d'un retour vers un `ksp-pipeline-lib` monolithique. +Il conserve la séparation stricte entre : -Chaque pipeline correspond à **une seule frontière durable**. +- **pipeline/processor** : logique réutilisable d'une transformation ; +- **worker** : service continu/live ; +- **job** : traitement borné/historique/replay ; +- **application** : contrôle/visualisation, sans duplication de la logique métier. + +## Règle de progression + +RAW et CORE sont les deux premières couches horizontales. Elles ne nécessitent aucun decoder Program. + +Pour chacune, KSP peut terminer successivement : ```text -transport model -> D1 -D1 -> D2 -D2 -> D3 -D3 -> D4 +persistence +-> backfill/replay +-> worker live si nécessaire +-> application de contrôle/inspection si utile ``` -Le pipeline porte la logique réutilisable de la frontière ; le worker/job porte le lifecycle et le scope d'exécution. +À partir de DECODE, les processors/jobs/workers/scenarios sont introduits **avec le groupe Program concerné**, en vertical slice, au lieu de créer à l'avance une grande flotte générique de workers de décodage/materialisation sans programme réel. -# Frontière des pipelines +# RAW -## `ksp-pipeline-raw-ingestion-lib` +## Pipeline RAW ingestion -Mission : +Concept : ```text -homogeneous on-chain transport model +homogeneous transport model | v -conversion D1 +conversion RAW DTO | v -persistence D1 +ksp-store-api + | + v +persistence D1 RAW | v notification after commit ``` -Le pipeline ne choisit pas et ne pilote pas la stratégie d'acquisition réseau. +Une crate spécialisée `ksp-pipeline-raw-ingestion-lib` peut être introduite lorsque la réutilisation worker + job le justifie réellement. -Le worker live et le job de backfill lui fournissent les données déjà acquises. +Elle ne choisit pas le provider réseau et ne pilote pas le range historique. -Dépendances conceptuelles : +## `ksp-job-backfill` + +Le premier backfill historique appartient à la couche RAW : ```text -ksp-pipeline-raw-ingestion-lib - -> ksp-onchain-transport-lib - -> ksp-store-api - -> ksp-core-lib - -> ksp-logging-lib +range/cursor historique + | + v +ksp-onchain-transport-lib + | + v +RAW ingestion + | + v +D1 RAW ``` -Il ne dépend pas de `ksp-store-lib`. +Le job : -Le backend concret est fourni par composition via les contrats de `ksp-store-api`. +- utilise `ksp-job-api` pour son lifecycle ; +- gère scope/range/pagination/checkpoint ; +- n'effectue aucun décodage Program ; +- n'écrit pas directement des faits CORE/DECODE/SPECIALIZED. -## `ksp-pipeline-core-processing-lib` +## Worker RAW live -Mission : +Le worker live futur : ```text -D1 input - | - v -conversion vers ksp-program-api - | - v -decoder/registry fourni - | - v -Core output + processing outcome - | - v -persistence D2 +subscriptions/fetch live + | + v +ksp-onchain-transport-lib + | + v +RAW ingestion + | + v +D1 RAW ``` -Dépendances conceptuelles : +Il ne décode pas et ne matérialise pas. + +Sa hot reconfiguration peut concerner selon le transport : + +- endpoints/providers ; +- rôles ; +- accounts/program IDs suivis ; +- types de subscriptions ; +- filtres ; +- limites/concurrence. + +La configuration desired/effective reste distinguée lorsqu'une reconfiguration est asynchrone. + +# CORE + +## Pipeline RAW -> CORE + +La normalisation CORE est générique Solana : ```text -ksp-pipeline-core-processing-lib - -> ksp-program-api - -> ksp-store-api - -> ksp-core-lib - -> ksp-logging-lib +D1 RAW + | + v +Solana generic normalizer + | + v +D2 CORE ``` -Il ne dépend pas de `ksp-program-lib` ni de `ksp-store-lib`. - -L'implémentation officielle Program ou une extension externe est fournie par composition. - -## `ksp-pipeline-generic-materialization-lib` - -Mission : +Dépendances interdites : ```text -D2 input - | - v -GenericMaterializer fourni - | - v -generic output - | - v -D3 journal + processing outcome +CORE normalizer -X-> ksp-program-api +CORE normalizer -X-> ksp-program-lib +CORE normalizer -X-> ksp-materializer-api ``` -Dépendances conceptuelles : +`ksp-interface-lib` peut fournir les wires Solana génériques nécessaires à la structure blockchain. + +## Job replay CORE + +Un job borné peut rejouer : ```text -ksp-pipeline-generic-materialization-lib - -> ksp-materializer-api - -> ksp-store-api - -> ksp-core-lib - -> ksp-logging-lib +RAW persisted range + | + v +CORE normalizer + | + v +D2 CORE ``` -Il ne dépend pas de `ksp-materializer-lib` ni de `ksp-store-lib`. +sans redemander les données au réseau. -## `ksp-pipeline-domain-projection-lib` +## Worker CORE -Mission : +Un worker CORE continu peut consommer le backlog RAW nouvellement persisté et produire CORE. + +Le Store reste source de vérité du backlog ; les notifications ne sont qu'un wake-up. + +# DECODE et SPECIALIZED + +## Introduction par groupe fonctionnel + +KSP ne crée pas d'abord un unique « worker decoder de tout Solana » puis tous les materializers plusieurs séries plus tard. + +Chaque groupe prioritaire introduit les capacités nécessaires : ```text -D3 input + contexte nécessaire - | - v -DomainProjector fourni - | - v -D4 projection + processing outcome +CORE inputs du groupe + | + v +Program decoder + | + v +decoded facts + | + v +generic materialization / DECODE persistence + | + v +SPECIALIZED projection si utile ``` -Dépendances conceptuelles : +Puis le même groupe avance vers préparation d'exécution, policy, execution et scénarios Devnet. + +Les jobs de replay et workers live correspondants réutilisent les mêmes processors du groupe. + +## Ordre fonctionnel + +Direction actuelle : ```text -ksp-pipeline-domain-projection-lib - -> ksp-materializer-api - -> ksp-store-api - -> ksp-core-lib - -> ksp-logging-lib +Solana Core Programs +-> SPL token/trading +-> token metadata +-> Anchor +-> Meteora +-> Raydium +-> Pump +-> Orca +-> Market Desk V1 +-> Jupiter / OKX routing +-> Market Desk V2 +-> trading-adjacent +-> general decoding ``` -Il ne dépend pas de `ksp-materializer-lib` ni de `ksp-store-lib`. - -Lorsqu'un projector est stateful, le pipeline/composant de composition charge via Store le contexte requis et le fournit au projector. Le projector reste indépendant du backend. +Un satellite protocolaire reste avec son groupe : Meteora vaults avec Meteora, Pump fee avec Pump, etc. # Worker API @@ -193,20 +225,7 @@ WorkerHealth WorkerCapabilities ``` -États conceptuels possibles : - -```text -Stopped -Starting -Running -Degraded -Stopping -Failed -``` - -Les noms Rust exacts ne sont pas figés. - -Les opérations communes attendues sont au minimum : +Opérations minimales candidates : ```text start @@ -215,122 +234,11 @@ status health ``` -Une capability telle que `reconfigure` n'est pas imposée à tous les workers. Un worker expose les capacités qu'il supporte réellement. - -Le lifecycle Worker ne contient aucune progression terminale propre aux jobs. - -# `ksp-worker-raw-retriever` - -## Mission - -Service continu/live ou quasi-live : - -```text -subscription/fetch live - | - v -homogeneous transport model - | - v -ksp-pipeline-raw-ingestion-lib - | - v -D1 -``` - -Il ne décode pas, ne matérialise pas, ne backfill pas et ne rejoue pas les niveaux dérivés. - -## Hot reconfiguration - -Le raw retriever doit pouvoir modifier à chaud au moins les dimensions réellement supportées par son transport, par exemple : - -- Program IDs suivis ; -- accounts/adresses suivis ; -- types de données/subscriptions ; -- filtres d'acquisition ; -- endpoints/providers lorsque le transport permet une transition sûre. - -La configuration runtime doit distinguer : - -```text -desired configuration generation -effective/applied configuration generation -``` - -Une reconfiguration est considérée appliquée seulement lorsque les subscriptions/filtres correspondants sont réellement actifs. - -En cas d'échec partiel, le status/health doit pouvoir refléter la divergence entre desired et effective. - -La stratégie exacte de diff/subscription est propre au worker/transport, pas à `ksp-worker-api`. - -# `ksp-worker-core-processor` - -Service continu : - -```text -D1 backlog - | - v -ksp-pipeline-core-processing-lib - | - v -D2 -``` - -Il utilise : - -- `ksp-worker-api` pour son lifecycle ; -- `ksp-store-lib` comme backend officiel de composition ; -- `ksp-program-lib` ou d'autres implémentations compatibles ; -- le pipeline Core commun. - -Il peut être réveillé par une notification D1 mais reconstruit toujours son backlog depuis le Store. - -# `ksp-worker-generic-materializer` - -Service continu : - -```text -D2 backlog - | - v -ksp-pipeline-generic-materialization-lib - | - v -D3 -``` - -Il compose : - -- `ksp-store-lib` ; -- `ksp-materializer-lib` et/ou materializers compatibles ; -- le pipeline générique. - -Le backlog est suivi par input + materializer identity/version. - -# `ksp-worker-domain-projector` - -Service continu : - -```text -D3 backlog - | - v -ksp-pipeline-domain-projection-lib - | - v -D4 -``` - -Le nom reste provisoire, mais la responsabilité D3 -> D4 est retenue. - -Il compose Store, projectors officiels/externes et pipeline de projection. - -Un projector peut nécessiter un contexte existant D4 ou canonique. Le worker/pipeline charge ce contexte depuis le Store et le fournit explicitement ; `ksp-materializer-lib` ne dépend toujours pas du Store. +Une capability comme `reconfigure` n'est pas imposée à tous les workers. # Job API -`ksp-job-api` reste distinct de `ksp-worker-api`. +`ksp-job-api` reste distinct de Worker API. Concepts candidats : @@ -339,566 +247,147 @@ JobId JobDescriptor JobState JobProgress -JobResult +JobOutcome JobCapabilities ``` -Le job est déclenché, borné et terminable. - -Les capacités suivantes peuvent exister lorsqu'elles sont pertinentes : +Un job est borné/terminable et peut exposer selon besoin : ```text -cancel +start pause resume -checkpoint +cancel +status +progress ``` -Elles ne sont pas obligatoirement universelles. +Les types exacts sont décidés à `0.3.3` avec le premier vrai backfill. -Aucune `ksp-job-control-lib` n'est introduite. +Aucune `ksp-job-control-lib` n'est créée sans duplication concrète. -# `ksp-job-backfill` +# Backlog, claim et idempotence -## Mission - -Acquisition historique uniquement : - -```text -historical fetch/pagination - | - v -homogeneous transport model - | - v -ksp-pipeline-raw-ingestion-lib - | - v -D1 -``` - -Il ne produit pas D2/D3/D4. - -Live acquisition et backfill produisent donc le même contrat D1. - -## Scope et progression - -Un backfill doit pouvoir enregistrer durablement selon sa stratégie : - -- network ; -- provider/source ; -- catégorie d'acquisition ; -- filtre/range demandé ; -- pagination/cursor ; -- slot/signature ranges lorsque pertinents ; -- candidats vus/traités ; -- records D1 persistés ; -- erreurs/retries ; -- checkpoint de reprise. - -Le checkpoint backfill décrit également la progression dans une source externe ; il ne se réduit donc pas à un processing outcome D1. - -# Jobs de replay - -Trois jobs distincts sont retenus : - -```text -ksp-job-replay-core -ksp-job-replay-generic-materialization -ksp-job-replay-domain-projection -``` - -Ils réutilisent les mêmes pipelines que les workers continus. - -## `ksp-job-replay-core` - -```text -scope D1 - | - v -ksp-pipeline-core-processing-lib - | - v -D2 -``` - -Il compose l'implémentation Program cible et son identité/version. - -## `ksp-job-replay-generic-materialization` - -```text -scope D2 - | - v -ksp-pipeline-generic-materialization-lib - | - v -D3 -``` - -Il cible un ou plusieurs materializers/versions. - -## `ksp-job-replay-domain-projection` - -```text -scope D3 - | - v -ksp-pipeline-domain-projection-lib - | - v -D4 -``` - -Il cible un ou plusieurs projectors/versions. - -## Scope de replay - -Selon la frontière, un replay peut être borné par : - -- network ; -- slot/range ; -- Program ID ; -- type de donnée ; -- processor/materializer/projector ; -- domaine ; -- autres filtres canoniques disponibles. - -Les scopes exacts sont définis par les contrats Store réels et non par une query PostgreSQL fuite dans `ksp-job-api`. - -# Processing outcome durable - -L'absence d'output ne signifie jamais automatiquement qu'un input n'a pas été traité. - -Un traitement valide peut produire zéro output parce qu'il est : - -- non applicable ; -- unsupported par cette version ; -- volontairement sans output ; -- reconnu mais ignoré selon le contrat du processor. - -Chaque frontière dérivée doit donc conserver un outcome durable associé conceptuellement à : - -```text -input identity -processor identity -processor version -logical capability/output identity -attempt/provenance -outcome -timestamps -``` - -Outcomes conceptuels possibles : - -```text -Produced -NoOutput -NotApplicable -Unsupported -FailedDeterministic -``` - -Les noms exacts restent ouverts. - -Les erreurs transitoires ne doivent pas nécessairement devenir immédiatement un outcome terminal. - -# Backlog par processor/version - -La vérité du backlog n'est pas : - -```text -"aucune row de sortie" -``` - -La vérité est conceptuellement : - -```text -inputs applicables -MINUS -outcomes terminaux pour processor/version/capability cible -``` - -Ainsi : - -```text -D1 X + CoreProcessor v1 -> Unsupported -``` - -est traité pour v1. - -Plus tard : - -```text -D1 X + CoreProcessor v2 -``` - -constitue un nouveau travail si v2 a changé sa capability. - -Pour D2 -> D3 et D3 -> D4, un même input peut être candidat pour plusieurs materializers/projectors. Le backlog existe donc séparément pour chaque identité/version/capability. - -# Claim / lease - -Pour supporter plusieurs instances concurrentes et la reprise après crash, un candidat peut être temporairement possédé : - -```text -candidate - | - v -claim - | - v -lease(owner, expires_at) - | - v -process - | - v -complete -``` - -Si l'instance meurt : - -```text -lease expires - | - v -candidate claimable again -``` - -La sémantique de claim appartient au contrat Store. - -L'implémentation PostgreSQL choisira plus tard la technique SQL appropriée. - -Le claim n'est pas une preuve de completion. - -# Sémantique de livraison - -KSP préfère : - -```text -at-least-once processing -+ -idempotent durable writes -+ -durable outcomes -``` - -à une promesse distribuée `exactly-once`. - -Après crash, un même input peut être retraité. - -L'idempotence garantit que : - -```text -same logical input -+ same processor/version -+ same logical output identity -``` - -ne crée pas un second fait logique incohérent. - -# Atomicité de l'unité de traitement - -Pour une unité logique de processing, doivent être cohérents/atomiques du point de vue durable : - -```text -output(s) -processing outcome -notification request/publication contract -``` - -Un outcome `Completed/Produced` ne peut pas être durable si seule une partie des outputs obligatoires a été persistée. - -L'unité atomique est généralement un input, sauf lorsqu'un projector définit explicitement un groupe indivisible. - -La transaction backend concrète appartient à `ksp-store-lib`; le pipeline l'oriente via `ksp-store-api`. - -# Erreurs de processing - -Trois familles conceptuelles au minimum : - -## Transient - -Exemples : - -- timeout ; -- backend temporairement indisponible ; -- rate limit ; -- ressource temporairement indisponible. - -Traitement : - -```text -retry + backoff -``` - -avec limite/configuration. - -## Deterministic failure - -Exemples : - -- donnée malformée connue ; -- invariant impossible ; -- erreur de transformation reproductible. - -Un état durable permet d'éviter une boucle infinie pour la même version. - -## Not applicable / unsupported - -Ce ne sont pas nécessairement des erreurs. - -Ils constituent des outcomes terminaux pour la version/capability considérée et peuvent être réévalués avec une nouvelle version. - -# Reprise après crash - -Un worker/job de processing doit pouvoir suivre la séquence : - -```text -restart - | - v -load configuration/scope - | - v -recover/ignore expired claims - | - v -query backlog from Store - | - v -resume processing -``` - -Aucune notification perdue pendant l'arrêt ne doit rendre la reprise impossible. - -# Cursor et checkpoint - -Un cursor peut accélérer le scan : - -```text -last scanned slot -last durable id -last page -``` - -mais il ne prouve pas qu'un input a été traité. - -Pour les workers de processing : - -```text -durable processing outcomes = vérité -cursor = optimisation -``` - -Pour `ksp-job-backfill`, le checkpoint possède aussi une sémantique de progression dans la source externe. - -# Replay normal et replay forcé - -Deux intentions doivent être distinguées. - -## Compléter/reprendre - -Traiter uniquement ce qui manque/échoue selon le scope et la version cible. - -## Force replay - -Retraiter même si un résultat actuel existe. - -Un force replay : - -- ne supprime pas silencieusement l'historique ; -- conserve la provenance ; -- produit ou supersède les résultats selon les règles du niveau ; -- reste idempotent pour l'identité logique choisie. - -Les règles SQL exactes seront fixées avec les premiers modèles D2/D3/D4. - -# Notifications : mécanisme de référence - -Le mécanisme initial de référence retenu pour PostgreSQL est : - -```text -LISTEN / NOTIFY -``` - -sans en faire une garantie de livraison. - -Le modèle attendu est : - -```text -persist outputs/outcome - | - v -commit - | - v -NOTIFY / wake-up -``` - -L'implémentation exacte peut exploiter le comportement transactionnel PostgreSQL de notification. - -Chaque consumer combine : +Pour les processors asynchrones : ```text notification wake-up -+ -periodic backlog polling + + +periodic polling + | + v +Store backlog query + | + v +claim/lease bounded batch + | + v +processor + | + v +output + durable outcome ``` -Le polling périodique constitue le filet de sécurité. +Les notifications ne remplacent jamais le Store. -Le contrat public reste dans `ksp-store-api` et ne dépend pas de PostgreSQL. +La sémantique cible reste at-least-once avec idempotence durable, plutôt qu'un faux exactly-once. -# Batching et concurrence +# Processing outcomes -Un worker/job de processing peut suivre : +Les états exacts seront définis avec le premier processor durable, mais doivent distinguer au minimum les familles conceptuelles : -```text -claim bounded batch - | - v -process with bounded concurrency - | - v -persist outcomes - | - v -repeat -``` +- success ; +- transient failure ; +- deterministic failure ; +- not applicable ; +- unsupported ; +- superseded/replayed lorsque pertinent. -Paramètres potentiels : +# Reprise après crash -- batch size ; -- max concurrency ; -- poll interval ; -- retry/backoff ; -- lease duration. +Un worker/job doit reconstruire son état depuis : -Ces paramètres ne sont pas nécessairement des champs universels de `ksp-worker-api` ou `ksp-job-api`. +- inputs persistés ; +- claims/leases ; +- outcomes ; +- cursors/checkpoints ; +- versions de processor. -Ils appartiennent au composant qui sait les interpréter. - -# Backpressure - -Un backlog croissant n'est pas automatiquement une erreur : - -```text -D1 production rate > D2 processing rate -``` - -Le système doit pouvoir observer au minimum conceptuellement : - -- backlog count ; -- âge du plus ancien input pending ; -- processing rate ; -- retry/failure rate ; -- état degraded éventuel. - -Le raw retriever n'est pas automatiquement ralenti par un backlog downstream. D1 sert précisément de tampon durable permettant de préserver l'acquisition. - -Une stratégie de backpressure globale pourra être décidée plus tard par un manager/orchestrateur ou une configuration produit. +La mémoire du processus ne constitue jamais l'unique source de reprise. # Logging -Tous les pipelines, workers et jobs runtime utilisent `ksp-logging-lib`. +Tous les pipelines/workers/jobs runtime utilisent `ksp-logging-lib`. -Les logs doivent couvrir selon pertinence : +Les événements utiles comprennent notamment : -- lifecycle ; -- claims/releases ; -- batch start/end ; -- retries/backoff ; -- outcomes unsupported/not applicable ; -- failures ; -- checkpoints ; -- replay scopes ; -- hot reconfiguration ; -- divergences desired/effective ; -- notifications/polling. +- start/stop ; +- batch/range ; +- progression ; +- retries ; +- claim/lease ; +- rate-limit/backpressure ; +- processing outcome ; +- checkpoint ; +- reconfiguration desired/effective ; +- erreurs redacted. -Les secrets et données sensibles ne sont jamais loggés. +# Dépendances de composition -# Graphe de composition - -## Raw live - -```text -ksp-worker-raw-retriever - -> ksp-worker-api - -> ksp-pipeline-raw-ingestion-lib - -> ksp-onchain-transport-lib - -> ksp-store-lib - -> ksp-config-lib - -> ksp-logging-lib -``` - -## Backfill +## RAW backfill ```text ksp-job-backfill -> ksp-job-api - -> ksp-pipeline-raw-ingestion-lib -> ksp-onchain-transport-lib - -> ksp-store-lib - -> ksp-config-lib + -> ksp-store-api / backend injecté + -> ksp-config-lib # orchestration/config, pas ownership transport -> ksp-logging-lib ``` -## Core live/replay +## RAW worker ```text -ksp-worker-core-processor -ksp-job-replay-core - -> lifecycle API correspondant - -> ksp-pipeline-core-processing-lib - -> ksp-program-lib ou implémentation compatible - -> ksp-store-lib +ksp-worker-raw-retriever + -> ksp-worker-api + -> ksp-onchain-transport-lib + -> ksp-store-api / backend injecté -> ksp-config-lib -> ksp-logging-lib ``` -## Generic materialization live/replay +## CORE replay/worker ```text -ksp-worker-generic-materializer -ksp-job-replay-generic-materialization - -> lifecycle API correspondant - -> ksp-pipeline-generic-materialization-lib - -> ksp-materializer-lib ou implémentation compatible - -> ksp-store-lib - -> ksp-config-lib +CORE processor + -> ksp-interface-lib si wires génériques nécessaires + -> ksp-store-api + -> ksp-core-lib -> ksp-logging-lib ``` -## Domain projection live/replay +Pas de Program API. + +## Groupes DECODE/SPECIALIZED + +Le composant de composition du groupe peut utiliser : ```text -ksp-worker-domain-projector -ksp-job-replay-domain-projection - -> lifecycle API correspondant - -> ksp-pipeline-domain-projection-lib - -> ksp-materializer-lib ou implémentation compatible - -> ksp-store-lib - -> ksp-config-lib - -> ksp-logging-lib +ksp-program-api +ksp-program-lib ou extension compatible +ksp-materializer-api +ksp-materializer-lib ou implementation compatible +ksp-store-api ``` +selon les capacités réellement introduites. + # Questions laissées ouvertes -Les premières implémentations doivent encore fixer : - -- types Rust précis Worker/Job state, health et progress ; -- modèle SQL exact de claim/lease ; -- durée/renouvellement d'une lease ; -- granularité des transactions par frontière ; -- nombre de retries et politique de backoff ; -- conflict handling entre plusieurs processor implementations ; -- type exact des processing outcomes ; -- contexte déclarable d'un `DomainProjector` stateful ; -- stratégie de graceful shutdown d'un batch en cours ; -- politique précise de pause/resume des jobs ; -- métriques/export telemetry au-delà des logs et health. - -La couche supérieure est désormais cadrée dans `010-APPS_SERVICES_SCENARIOS_AND_CONTROL.md`. Le mécanisme IPC exact et l'éventuel orchestrateur restent à décider uniquement sur besoin concret. +- nom final de la crate pipeline RAW si la réutilisation justifie une crate dédiée ; +- nom final du worker RAW ; +- contrat exact de `ksp-job-api` ; +- modèle de claim/lease PostgreSQL ; +- taille de batch et stratégie backpressure ; +- découpage des workers DECODE/SPECIALIZED par groupe lorsque les premiers groupes existent ; +- mécanisme IPC des applications de contrôle futures. diff --git a/docs/architecture/010-APPS_SERVICES_SCENARIOS_AND_CONTROL.md b/docs/architecture/010-APPS_SERVICES_SCENARIOS_AND_CONTROL.md index 9709372..c721f91 100644 --- a/docs/architecture/010-APPS_SERVICES_SCENARIOS_AND_CONTROL.md +++ b/docs/architecture/010-APPS_SERVICES_SCENARIOS_AND_CONTROL.md @@ -1,5 +1,5 @@ - + # Applications, services, scenarios et control plane @@ -47,6 +47,12 @@ Elle ne doit pas réimplémenter : - lifecycle interne d'un worker/job ; - logique de pipeline réutilisable. +# Applications de validation par couche + +KSP peut ajouter une petite application spécialisée à la fin d'une couche RAW ou CORE lorsque cela permet de valider et exploiter réellement la couche avant de passer à la suivante. Ces applications lisent les contrats KSP et ne recopient pas les processors dans Tauri. + +À partir des vertical slices Program, les applications restent attachées aux besoins réels : demos de scenarios pour l'exécution et Market Desk pour les projections de marché. + # Priorité aux applications spécialisées KSP ne planifie pas actuellement de cockpit desktop global. @@ -151,11 +157,12 @@ Exemples conceptuels : ```text ksp-worker-raw-retriever -ksp-worker-core-processor -ksp-worker-generic-materializer -ksp-worker-domain-projector +future CORE worker +future group-specific DECODE/SPECIALIZED workers when justified ``` +RAW et CORE reçoivent leurs workers à la fin de leur couche respective. Les workers DECODE/SPECIALIZED ne sont plus tous anticipés comme une chaîne globale fixe : leur granularité doit émerger des premiers vertical slices Program. + Le binaire doit rester mince. Il ne duplique pas le pipeline ni la logique de worker contenue dans la cible bibliothèque du même package. @@ -232,7 +239,7 @@ Le data plane transporte/persiste les données Solana et les résultats de proce ksp-onchain-transport-lib | v -D1 -> D2 -> D3 -> D4 +RAW -> CORE -> DECODE -> SPECIALIZED ``` avec notifications de données persistées comme wake-up. @@ -469,6 +476,16 @@ worker status Une app spécialisée peut éditer une configuration puis demander son application, mais ne doit pas considérer l'écriture du document comme la preuve que le worker l'a appliquée. +# Market Desk progressive + +Après les groupes Meteora/Raydium/Pump/Orca, KSP prévoit une première application spécialisée candidate `ksp-app-market-desk`. + +V1 peut afficher tokens, pools/markets, liquidité, trades/swaps, prix, volumes, OHLC et activité live/récente à partir des projections SPECIALIZED et des contrats KSP. Elle ne dépend pas directement des SDK/protocoles DEX pour reconstruire leurs modèles dans l'UI. + +Après Jupiter/OKX, la même application est enrichie avec routes, legs, DEX impliqués, fees/slippage et comparaison quote/execution lorsqu'elle existe. + +Les OHLC sont matérialisés dans SPECIALIZED et consommés par l'application; ils ne sont pas recalculés à partir de tout l'historique lors de chaque rendu. + # Future orchestrator Un orchestrateur global pourra devenir utile lorsque plusieurs services/managers/jobs devront être coordonnés. @@ -522,7 +539,7 @@ control/application adapters Data plane séparé : ```text -transport -> D1 -> D2 -> D3 -> D4 +transport -> RAW -> CORE -> DECODE -> SPECIALIZED ``` Aucun payload de processing n'a besoin de transiter via l'UI/control plane. diff --git a/docs/plans/000-README.md b/docs/plans/000-README.md index 1b5b467..9f2aab4 100644 --- a/docs/plans/000-README.md +++ b/docs/plans/000-README.md @@ -1,5 +1,5 @@ - + # Plans KSP @@ -15,7 +15,7 @@ Un plan décrit le périmètre, les décisions déjà acquises, les questions ou - [`004-V0_1_2_LOGGING_FOUNDATION_PLAN.md`](004-V0_1_2_LOGGING_FOUNDATION_PLAN.md) — plan historique clôturé de la release stable `0.1.2`, établi par `0.1.2-pre.001` puis consolidé jusqu'à `0.1.2-rel.001`. - [`005-V0_1_3_CONFIG_FOUNDATION_PLAN.md`](005-V0_1_3_CONFIG_FOUNDATION_PLAN.md) — plan historique clôturé de la release stable `0.1.3 — Configuration foundation`, établi par `0.1.3-pre.001`, exécuté jusqu'à `pre.015` puis publié par `0.1.3-rel.001`. - [`006-V0_1_4_CONFIG_DESKTOP_PLAN.md`](006-V0_1_4_CONFIG_DESKTOP_PLAN.md) — plan historique clôturé de la release stable `0.1.4 — ksp-app-config-desk`, établi par `0.1.4-pre.001` puis consolidé jusqu'à `0.1.4-rel.001`. -- [`007-V0_2_0_SERIES_PLANNING.md`](007-V0_2_0_SERIES_PLANNING.md) — plan actif de `0.2.0`, ouvert par `0.2.0-pre.001` pour auditer `khadhroony-bot3` et découper le reste de `0.2.x` sans implémentation N2 prématurée. +- [`007-V0_2_0_SERIES_PLANNING.md`](007-V0_2_0_SERIES_PLANNING.md) — plan actif de `0.2.0`, ouvert par `pre.001` puis consolidé par `pre.002` avec l'ordre `0.2.1+`, la stratégie RAW/CORE/DECODE/SPECIALIZED, les vertical slices Program et le prompt préparatoire `0.2.1`. Le `pre.001` de chaque release fonctionnelle peut introduire son propre plan détaillé lorsque la release s'ouvre. diff --git a/docs/plans/001-V0_0_3_PLAN.md b/docs/plans/001-V0_0_3_PLAN.md index a746a2a..54e1f64 100644 --- a/docs/plans/001-V0_0_3_PLAN.md +++ b/docs/plans/001-V0_0_3_PLAN.md @@ -1,8 +1,11 @@ - + # Plan KSP 0.0.3 +> **Note de supersession — `0.2.0-pre.002`** +> Ce document conserve le cadrage historique établi pendant `0.0.3`. Les mentions ci-dessous de quatre pipelines fixes, de `ksp-worker-generic-materializer`, de `ksp-worker-domain-projector` ou d'un Core processing dépendant du décodage Program décrivent l'état de décision de cette ancienne release et **ne constituent plus l'architecture courante**. Depuis `0.2.0-pre.002`, les documents normatifs/actifs sont `docs/architecture/008-DATA_MATERIALIZATION_AND_STORE.md`, `docs/architecture/009-ACQUISITION_WORKERS_AND_JOBS.md`, `docs/plans/002-FUNCTIONAL_RELEASE_SEQUENCE.md`, `docs/plans/007-V0_2_0_SERIES_PLANNING.md` et les règles associées. Le modèle courant est `RAW -> CORE -> DECODE -> SPECIALIZED`, RAW/CORE ne dépendent pas d'un decoder Program, et les capacités de DECODE/SPECIALIZED sont introduites verticalement groupe par groupe. + ## Mission Transformer le brainstorming KSP en architecture, règles, inventaire et plan suffisamment précis pour ouvrir la première série fonctionnelle `0.1.x` sans développement fonctionnel prématuré. @@ -15,7 +18,7 @@ Transformer le brainstorming KSP en architecture, règles, inventaire et plan su Les tranches `pre.004` (Wire/Program), `pre.005` (Execution/Policy), `pre.006` (Data/Materialization/Store), `pre.007` (Acquisition/Workers/Jobs), `pre.008` (Apps/Services/Scenarios/Control) et `pre.009` (Functional Release Sequence) sont maintenant livrées séparément afin de conserver des prereleases de planification bornées. -## Décisions structurantes actuelles +## Décisions structurantes à la clôture de `0.0.3` — historique - `0.1.x`, `0.2.x`, etc. sont des séries fonctionnelles, pas des unités de session. - Chaque release concrète d'une série est dimensionnée séparément. diff --git a/docs/plans/002-FUNCTIONAL_RELEASE_SEQUENCE.md b/docs/plans/002-FUNCTIONAL_RELEASE_SEQUENCE.md index 73471cd..3e25c5b 100644 --- a/docs/plans/002-FUNCTIONAL_RELEASE_SEQUENCE.md +++ b/docs/plans/002-FUNCTIONAL_RELEASE_SEQUENCE.md @@ -1,5 +1,5 @@ - + # Séquence des releases fonctionnelles KSP @@ -349,122 +349,207 @@ Par défaut : - prompt de la release suivante ; - vérification de cohérence des versions. -# Série `0.2.x` — ordre candidat uniquement +# Série `0.2.x` — accès Solana, Wallet et contrats initiaux -`0.2.x` ouvre les capacités Solana N2. - -L'ordre exact des numéros n'est **pas figé** en `0.0.3`. - -Ordre candidat à réévaluer à l'approche de la série : +`0.2.0` reste la release de cadrage. `0.2.0-pre.002` fixe maintenant le début de la séquence fonctionnelle suivante : ```text -wallet foundation - -> wallet specialized app - -on-chain transport foundation - -> specialized transport/demo validation - -interface/wire foundation - -> first concrete Program surface - -program-api / program-lib - -> first real decoder + ProgramExecutionPreparer + registry validation - -execution-policy-api / execution-lib - -> first real execution cycle - -scenario/demo validating the complete path +0.2.1 on-chain transport HTTP foundation +0.2.2 wallet foundation (.kspwallet) +0.2.3 Wallet Desk +0.2.4 standard Solana WebSocket +0.2.5 Helius LaserStream WebSocket +0.2.6 Yellowstone gRPC standard foundation +0.2.7 off-chain price transport +0.2.8 price visualization desk +0.2.9 interface/wire foundation +0.2.10 program-api foundation ``` -Wallet, Transport et Interface sont en grande partie indépendants ; leur ordre précis peut donc être réordonné selon le premier cas fonctionnel choisi. +Cette séquence est motivée par les dépendances fonctionnelles : un Wallet Desk utile doit pouvoir lire le solde du wallet, donc HTTP précède Wallet ; les transports live arrivent ensuite ; Interface/Program sont préparés avant les couches de données décodées. -`ksp-offchain-transport-lib` reste need-driven. +## `0.2.1` — HTTP Solana foundation -# Série `0.3.x` — ordre candidat uniquement +Mission : créer `ksp-onchain-transport-lib` avec une surface HTTP JSON-RPC complète et indépendante de Config/Store/Program. -Direction : +Inclure : + +- settings publics transport ; +- endpoint/provider/cluster ; +- pools logiques ; +- rôles/capabilities/request kinds ; +- priorités/limites/concurrence ; +- timeout/retry/backoff ; +- JSON-RPC ; +- méthodes read et write/execution technique ; +- statut centralisé `stable/deprecated/unstable` ; +- warning runtime KSP pour deprecated/obsolete encore fonctionnel et unstable/experimental ; +- document Config standard Transport + adapter dans `ksp-config-lib`, sans dépendance Transport -> Config. + +La documentation officielle actuelle de la surface ciblée doit être inventoriée exhaustivement dans `pre.001`. + +## `0.2.2` — Wallet foundation + +Mission : créer `ksp-wallet-lib` et le format `.kspwallet`. + +Inclure protection du secret, pubkey/identity, signature, import/export extensible, changement de mot de passe et publication sûre. + +Exclure : temporary wallet JSON historique et `WalletPolicy`. + +## `0.2.3` — Wallet Desk + +Mission : valider Config composite + `.kspwallet` + transport HTTP dans une application Tauri mince. + +Le solde d'un wallet constitue un premier cas de validation réseau obligatoire. + +## `0.2.4` — WebSocket Solana standard + +Mission : couvrir la surface WebSocket standard officielle ciblée. + +Une URL peut avoir plusieurs sessions physiques ; une session peut avoir plusieurs subscriptions. Un pool automatique de sessions est reporté jusqu'à besoin concret. + +## `0.2.5` — Helius LaserStream WebSocket + +Mission : étendre le moteur WebSocket standard avec les opérations/filtres/capabilities Helius ciblés sans copier le client. + +## `0.2.6` — Yellowstone gRPC standard + +Mission : introduire un backend Yellowstone standard/provider-neutral. + +Le `pre.001` est un gate de sizing : inventorier toute la surface normative cible et scinder la release avant implémentation si sa clôture dans une session paraît incertaine. + +Les profiles/adapters Helius/Triton/ERPC/Chainstack/Shyft sont reportés après les priorités fondatrices. + +## `0.2.7` / `0.2.8` — Off-chain price + app + +`0.2.7` introduit `ksp-offchain-transport-lib` avec au minimum SOL/USD et SOL/EUR via une abstraction indépendante du premier provider. + +`0.2.8` ajoute une petite application desk de visualisation/validation. + +Metadata HTTP/IPFS/Arweave viendra au premier besoin Metadata réel. + +## `0.2.9` — Interface foundation + +`ksp-interface-lib` devient la façade wire officielle et expose une API publique wire utilisable par les implementations officielles et externes. + +Aucune `ksp-interface-api` séparée n'est retenue pour l'instant. + +## `0.2.10` — Program API foundation + +Introduire `ksp-program-api`, sans suffixe `-lib`, comme contrat d'extension Program. + +`ksp-program-lib` et les vertical slices réels arrivent plus tard. + +# Architecture durable : RAW -> CORE -> DECODE -> SPECIALIZED + +La chaîne de données est : ```text -store-api + PostgreSQL store foundation - | - v -D1 raw persistence - | - v -specialized Store app - | - v -worker-api / job-api - | - v -raw-ingestion pipeline - | - +--> raw-retriever service - | - +--> backfill job +D1 RAW + -> D2 CORE + -> D3 DECODE + -> D4 SPECIALIZED ``` -Les contrats Materializer et les frontières D2/D3/D4 sont introduits lorsque les sorties Program/Core réelles nécessaires existent. +RAW et CORE ne nécessitent aucun decoder Program. -Store/D1/acquisition peuvent donc être validés avant une matérialisation complète. +`RAW -> CORE` est une normalisation générique Solana ; le premier decoder intervient à `CORE -> DECODE`. -# Séries suivantes +# Série `0.3.x` — RAW / acquisition persistée -Les directions restent celles du roadmap : +Début décidé : ```text -0.4.x Core/SPL/metadata + scenarios/demos -0.5.x Anchor + protocoles trading -0.6.x processing autonome D1 -> D4 -0.7.x Trading Intelligence -0.8.x+ trading opérationnel + explorers + expansion produits +0.3.1 ksp-store-api + ksp-store-lib, RAW only +0.3.2 ksp-interface-lib, wires génériques acquisition/CORE +0.3.3 ksp-job-api + backfill +0.3.4 application backfill/RAW ``` -Ces séries sont des objectifs fonctionnels, pas un calendrier contractuel. +La suite de la série termine la couche RAW avec worker/service live et outils d'exploitation utiles avant l'ouverture de CORE. + +`0.3.1` ne doit pas créer par anticipation les modèles/tables DECODE/SPECIALIZED. + +# Série CORE suivante + +Objectif : rendre CORE exploitable sans aucun decoder Program : + +```text +RAW persisted + -> Solana generic normalization + -> CORE persistence + -> RAW->CORE replay/backfill + -> CORE worker/service + -> CORE inspection/control app +``` + +# Séries DECODE/SPECIALIZED/EXECUTION suivantes + +À partir du décodage, KSP progresse par vertical slices complets et non par grandes couches de crates isolées : + +```text +wire + -> decode + -> materialize + -> specialized projection si utile + -> execution preparation + -> execution policy + -> execute + -> Devnet scenario +``` + +Ordre prioritaire : + +```text +Solana Core Programs + -> SPL token/trading + -> token metadata + -> Anchor + -> Meteora + -> Raydium + -> Pump + -> Orca + -> Market Desk V1 + -> Jupiter/OKX routing + -> Market Desk V2 + -> trading-adjacent + -> general decoding +``` + +Un programme satellite nécessaire reste dans son groupe protocolaire : Pump fee avec Pump, Meteora vaults avec Meteora, etc. + +SPM est reporté au décodage généraliste ultérieur. + +# Market Desk + +Après les DEX prioritaires, introduire une petite `ksp-app-market-desk` consommant les projections KSP pour afficher tokens, pools, liquidité, trades, prix, volumes et OHLC. + +Après Jupiter/OKX, enrichir la même app avec routes, legs, DEX impliqués, fees/slippage et quote/execution lorsque disponible. + +L'app ne réimplémente pas les SDK/protocoles DEX ; elle consomme les faits SPECIALIZED normalisés. + +# Discipline de sizing + +Chaque prerelease vise environ 15–20 minutes de travail effectif. + +Chaque release concrète doit pouvoir être ouverte et clôturée dans une seule session de chat. Si `pre.001` montre que ce n'est pas réaliste, scinder la release avant implémentation fonctionnelle lourde. # Progression de la série `0.1.x` -La première release fonctionnelle est : +Les releases `0.1.1` à `0.1.4` sont stables et leurs plans/prompts restent historiques. + +# Ouverture de `0.2.0` + +`0.2.0` a été ouverte par : ```text -0.1.1 — Core foundation -``` - -Son prompt historique d'ouverture reste : - -```text -prompts/001-V0_1_1_START_PROMPT.md -``` - -`0.1.1-rel.001` publie la surface Core stable après validation complète de `pre.005`. Le commit de release reçoit le tag `v0.1.1`. La release suivante s'ouvre avec : - -```text -0.1.2 — Logging foundation -prompts/002-V0_1_2_START_PROMPT.md -``` - -## Ouverture de `0.2.0` - -Après publication stable de `0.1.4`, la session suivante s’ouvre avec : - -```text -0.2.0-pre.001 prompts/005-V0_2_0_START_PROMPT.md ``` -`0.2.0` est une **release intermédiaire de cadrage de la série `0.2.x`**. Sa mission n'est pas de choisir immédiatement un premier composant N2 à implémenter, mais de reprendre méthodiquement les capacités pertinentes de `khadhroony-bot3` et de définir le plan de migration/refondation de la série. +`0.2.0-pre.001` a construit la première cartographie. `0.2.0-pre.002` fixe la trajectoire ci-dessus et prépare : -La série `0.2.0` doit notamment produire : - -- un inventaire des fonctionnalités `khadhroony-bot3` pertinentes pour `0.2.x` ; -- pour chaque capacité, une décision explicite `reprendre / adapter / refondre / abandonner / ajouter` ; -- les écarts entre les contrats historiques et les règles KSP déjà stabilisées en `0.1.x` ; -- une cartographie des dépendances entre Wallet, transport on-chain, Interface/wire, Program API/Program, policy/execution et les éventuels besoins off-chain ; -- les nouvelles fonctionnalités nécessaires qui n'existaient pas dans bot3 ou dont le contrat doit être modifié ; -- le découpage concret du reste de `0.2.x` en releases bornées `0.2.1`, `0.2.2`, etc., avec ordre, objectifs, dépendances, hors-périmètre et critères de clôture ; -- le prompt de démarrage de la première release fonctionnelle résultant de ce découpage. - -Le document directeur attendu pour cette session est `docs/plans/007-V0_2_0_SERIES_PLANNING.md`. Les numéros et périmètres des releases `0.2.1+` ne deviennent contractuels qu'après validation de ce plan. - -`0.2.0-pre.001` a ouvert ce document avec la méthode d'audit, une première cartographie et une matrice provisoire. Les lots Wallet, Transport, Interface, Program et Execution restent volontairement non numérotés à ce stade ; les audits spécialisés suivants doivent encore challenger leur ordre et leur taille. +```text +prompts/006-V0_2_1_START_PROMPT.md +``` +Le prompt `0.2.1` reste un brouillon vivant jusqu'à la publication stable de `v0.2.0`. diff --git a/docs/plans/007-V0_2_0_SERIES_PLANNING.md b/docs/plans/007-V0_2_0_SERIES_PLANNING.md index 4ba2c0f..158c1c9 100644 --- a/docs/plans/007-V0_2_0_SERIES_PLANNING.md +++ b/docs/plans/007-V0_2_0_SERIES_PLANNING.md @@ -1,589 +1,626 @@ - + # Plan `0.2.0` — audit bot3 et planification de la série `0.2.x` -## 1. Statut, base et objectif +## 1. Statut et objectif -Ce document ouvre `0.2.0` avec `0.2.0-pre.001`. +`0.2.0` est une release intermédiaire de transition, d'audit et de planification. Elle ne livre pas directement une nouvelle capacité Solana complète ; elle transforme l'expérience de `khadhroony-bot3` en une trajectoire KSP cohérente, bornée et compatible avec les règles stabilisées en `0.1.x`. -`0.2.0` est une release intermédiaire de transition, d'audit et de planification. Elle ne livre pas de capacité Solana N2 fonctionnelle. Son résultat attendu est un cadrage suffisamment étayé pour découper le reste de `0.2.x` en releases concrètes et bornées sans reproduire mécaniquement l'architecture historique de `khadhroony-bot3`. - -Base KSP fournie : +Base KSP attendue à l'ouverture de `0.2.0` : ```text -khadhroony-solana-project v0.1.4 -workspace.package.version = 0.1.4 +v0.1.4 +ksp-core-lib +ksp-logging-lib +ksp-config-lib +ksp-app-config-desk ``` -Snapshot bot3 audité : +Snapshot bot3 principal audité pendant `0.2.0` : ```text -archive d'échange : khadhroony-bot3_v0.5.3-pre.005-fix010.zip -workspace.package.version = 0.5.3-pre.5 +khadhroony-bot3_v0.5.3-pre.005-fix010.zip ``` -L'archive bot3 ne porte pas de métadonnée Git permettant de vérifier ici le commit correspondant au suffixe d'échange `fix010`. L'audit se fonde sur le contenu effectivement fourni. +Les fondations déjà refondues en `0.1.x` ne sont pas remigrées. Elles servent de contraintes pour juger les capacités historiques. -Les fondations déjà stabilisées par KSP en `0.1.x` ne sont pas remigrées : +## 2. Discipline de découpage -- `ksp-core-lib` ; -- `ksp-logging-lib` ; -- `ksp-config-lib` ; -- `ksp-app-config-desk`. +KSP applique désormais deux garde-fous cumulatifs : -Elles constituent des contraintes de jugement des composants historiques. +1. une prerelease vise environ **15 à 20 minutes de travail effectif** ; +2. une release fonctionnelle concrète doit être dimensionnée pour pouvoir être **ouverte, développée, validée et clôturée dans une seule session de chat**. -## 2. Principes de l'audit +Une release fonctionnelle ne doit pas être laissée volontairement ouverte pour être continuée dans une autre session. -### 2.1 Ne pas confondre cinq objets différents +Le `pre.001` de chaque release sert donc aussi de **gate de dimensionnement**. Si l'inventaire réel montre que la release ne pourra vraisemblablement pas être clôturée dans la session, elle est scindée avant de commencer l'implémentation fonctionnelle lourde. -Chaque élément bot3 doit être séparé en cinq dimensions avant décision : +Un nouveau besoin planifié produit une nouvelle prerelease. Un défaut livré dans une tranche existante produit un `fix.NNN` et n'est pas réécrit silencieusement. -1. **fonctionnalité** — besoin utilisateur ou système réellement utile ; -2. **implémentation historique** — code, algorithme, organisation de modules et choix techniques utilisés dans bot3 ; -3. **contrat public** — types, traits, invariants et comportements observables dont des consommateurs peuvent réellement dépendre ; -4. **dépendance externe** — crate ou protocole tiers utilisé pour réaliser le contrat ; -5. **convention de projet** — règle locale de nommage, validation, documentation ou composition qui peut être historique sans être intrinsèque à la fonctionnalité. +## 3. Méthode d'audit bot3 -Une décision de reprise porte d'abord sur la fonctionnalité et le contrat utile. Elle ne vaut jamais autorisation implicite de copier le code ou son graphe de dépendances. +Chaque capacité historique est étudiée en séparant cinq dimensions : -### 2.2 Statuts de décision +1. **fonctionnalité** — besoin réellement utile ; +2. **implémentation historique** — code et organisation bot3 ; +3. **contrat public** — types, traits, invariants et comportements observables utiles ; +4. **dépendance externe** — crate, protocole ou provider tiers ; +5. **convention de projet** — choix local qui n'est pas intrinsèque au besoin. -Chaque capacité significative reçoit l'un des statuts suivants. +Les statuts de décision sont : -#### `reprendre` +- `reprendre` — reprendre le besoin/contrat utile ; +- `adapter` — conserver le besoin avec ajustements de frontière/API ; +- `refondre` — conserver le besoin mais remplacer l'architecture historique ; +- `abandonner` — ne pas migrer ; +- `ajouter` — besoin KSP absent ou insuffisant dans bot3. -Le besoin et l'essentiel du contrat sont adaptés à KSP. L'implémentation peut néanmoins être réécrite, revalidée ou simplifiée. +`reprendre` ne signifie jamais « copier mécaniquement le code ». -#### `adapter` +## 4. Décisions de `0.2.0-pre.002` -Le besoin reste valable mais son API, son ownership, sa composition, ses DTOs ou une partie de ses invariants doivent être alignés sur KSP. +### 4.1 Ordre fonctionnel initial de la série -#### `refondre` +Le premier besoin Wallet a montré qu'une application Wallet réellement testable doit pouvoir lire le solde d'une adresse. Le transport HTTP Solana doit donc précéder le Wallet. -Le besoin demeure utile mais l'architecture historique ou les couplages sont incompatibles avec les frontières KSP ; une nouvelle conception est nécessaire avant implémentation. - -#### `abandonner` - -L'élément est legacy, redondant, hors objectif, dangereux ou remplacé par une capacité KSP déjà stabilisée. - -#### `ajouter` - -Le besoin est requis par les objectifs KSP mais bot3 ne fournit pas de contrat suffisant ou n'offre pas cette capacité. - -### 2.3 Critères appliqués à chaque décision - -La décision est évaluée avec les critères suivants : - -- utilité concrète pour les cas d'usage KSP ; -- cohérence avec les niveaux N1/N2/N3/N4 ; -- ownership unique Config/Logging/Wire/Program/Execution ; -- stabilité et ouverture du contrat public ; -- séparation secret/public ; -- indépendance vis-à-vis de Tauri ; -- respect du firewall des dépendances externes ; -- compatibilité avec les versions récentes des primitives/codecs ; -- testabilité hors UI ; -- observabilité via `ksp-logging-lib` ; -- comportement async/concurrence ; -- capacité d'évolution sans enum centrale ou couplage protocolaire fermé ; -- dette connue, code legacy ou duplication ; -- coût réel de réimplémentation contre valeur du contrat. - -## 3. Méthode d'analyse - -L'audit est mené par domaine et non par ordre historique des crates. - -Pour chaque capacité : - -1. localiser les crates, modules, applications et documents sources ; -2. relever les APIs publiques et DTOs réellement consommables ; -3. relever les dépendances Cargo directes et les dépendances fonctionnelles implicites ; -4. relever Config, environnement, secrets et paramètres runtime nécessaires ; -5. relever les usages directs de `tracing` et les exigences d'observabilité ; -6. relever tests, scénarios, matrices et invariants de sécurité ; -7. identifier les couplages historiques et duplications ; -8. comparer avec les règles KSP stabilisées ; -9. produire une ligne de matrice de décision ; -10. relier la capacité au graphe de dépendances `0.2.x` ; -11. seulement ensuite proposer un lot/release candidate. - -La fiche d'audit canonique utilise la forme : +Le début de série est désormais ordonné ainsi : ```text -capacité / contrat -source bot3 -fonctionnalité -contrat public utile -implémentation historique notable -dépendances externes -configuration / environnement -logging / tracing -scénarios / tests / invariants -statut : reprendre | adapter | refondre | abandonner | ajouter -justification -propriétaire KSP pressenti -dépendances KSP -risques / dette à éviter -release 0.2.x candidate non figée +0.2.1 ksp-onchain-transport-lib — HTTP Solana foundation +0.2.2 ksp-wallet-lib — format natif .kspwallet +0.2.3 ksp-app-wallet-desk — Wallet + Config composite + HTTP +0.2.4 ksp-onchain-transport-lib — WebSocket Solana standard +0.2.5 ksp-onchain-transport-lib — Helius LaserStream WebSocket +0.2.6 ksp-onchain-transport-lib — Yellowstone gRPC standard foundation +0.2.7 ksp-offchain-transport-lib — première surface prix +0.2.8 application desk de visualisation des prix +0.2.9 ksp-interface-lib — première surface wire/API publique +0.2.10 ksp-program-api — première API extensible Program ``` -## 4. Cartographie initiale de bot3 +Les providers Yellowstone avancés ou spécifiques ne sont pas prioritaires dans cette première séquence. Ils seront ajoutés plus tard lorsque le besoin opérationnel le justifiera. -Cette section est volontairement un inventaire de départ. Elle sera complétée par les prereleases d'audit spécialisées. +### 4.2 Frontière Config / Transport -### 4.1 Crates de fondation historiques +`ksp-onchain-transport-lib` **ne dépend pas de `ksp-config-lib`**. -| Source bot3 | Rôle historique | Décision de `pre.001` | -|------------------|------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------| -| `ks-core` | erreurs/primitives minimales | ne pas remigrer ; comparer seulement les anciens consommateurs avec `ksp-core-lib` | -| `ks-program-ids` | registre de Program IDs | abandonner comme composant KSP séparé ; ownership déjà repris par `ksp-core-lib` | -| `ks-config` | documents Config, environnement, profils | ne pas remigrer ; ses anciens documents Wallet/Transport/Execution servent d'entrée d'audit pour de futures extensions de `ksp-config-lib` | -| `ks-logging` | runtime tracing | ne pas remigrer ; tous les appels directs `tracing` des capacités historiques devront passer par `ksp-logging-lib` | +Le transport possède ses contrats runtime publics : endpoints, pools, rôles, limites, timeouts, retry/backoff et autres settings réellement nécessaires. -### 4.2 Wallet - -Sources principales : +Lorsque KSP fournit un document standard Transport, son ownership reste dans `ksp-config-lib`, sur le même principe que Config -> Logging : ```text -ks-wallet/ -ks-wallet-demo-scenarios/ -kb-app-demo-desktop/src/demo_wallet.rs -ks-config/src/wallet.rs -docs/NATIVE_FORMAT.md -docs/WALLET_FORMAT_COMPATIBILITY.md -docs/guides/WALLETS.md -docs/validation/V0_5_2_WALLET_VALIDATION_REPORT.md +config/std.transport.json + | + v +ksp-config-lib + | + | adapter vers contrats publics Transport + v +ksp-onchain-transport-lib ``` -Le Wallet bot3 est une surface relativement mature. L'inventaire initial identifie : - -- alias validé ; -- identité publique minimale sans secret ; -- wallet temporaire en mémoire ; -- manager multi-wallet borné à une racine ; -- handle opaque de fichier wallet ; -- format natif versionné `.kswallet` ; -- Argon2id + XChaCha20-Poly1305 ; -- mot de passe possédé, non clonable et redacted ; -- capacité `UnlockedWallet` non clonable ; -- signature sans getter public des octets privés ; -- création atomique/no-clobber du format natif ; -- changement de mot de passe sans changement de keypair ; -- inspection externe sans import ; -- migration legacy JSON non destructive ; -- import/export `SolanaCliJson` 64 octets ; -- import/export Base58 du keypair Solana complet 64 octets ; -- détection de collisions d'alias/pubkey ; -- validation indépendante de Tauri via `ks-wallet-demo-scenarios`. - -Dette/éléments à ne pas reprendre tels quels : - -- `TemporaryWalletStore` persiste encore un format JSON legacy et n'offre pas la même publication crash-safe que le format natif ; -- `WalletPolicy` contient un `lamport_spend_limit` qui relève conceptuellement de la policy d'exécution supérieure, pas du stockage/secret wallet ; -- la crate appelle directement `tracing` ; -- les types `solana-keypair`/`solana-signer` font partie du contrat historique et doivent être réévalués contre la politique de primitives KSP, pas repris automatiquement ; -- la fenêtre Wallets du desktop mélange inventaire wallet, RPC, balances, comptes token, transactions et sélection d'exécution ; KSP doit séparer application wallet et validation transport/execution selon les responsabilités réelles. - -### 4.3 Transport on-chain - -Sources principales : +La dépendance inverse est interdite : ```text -ks-onchain-transport/ -ks-config/src/transport.rs -kb-app-demo-desktop/src/demo_http.rs -kb-app-demo-desktop/src/demo_ws.rs -kb-app-demo-desktop/src/demo_transport.rs +ksp-onchain-transport-lib -X-> ksp-config-lib ``` -La crate historique contient 23 fichiers Rust et 124 tests annotés dans le snapshot fourni. Elle couvre notamment : +Les applications, workers et jobs peuvent aussi construire directement les settings publics du transport sans utiliser Config. -- JSON-RPC 2.0 ; -- clients HTTP et WebSocket ; -- pools d'endpoints ; -- rôles, priorités, quotas et concurrence ; +### 4.3 Couverture documentaire complète du transport + +Pour toute surface de transport officiellement ciblée par une release, KSP doit inventorier puis implémenter **toutes les méthodes/opérations exposées par la documentation normative sélectionnée**, sauf impossibilité technique explicitement documentée. + +Chaque méthode/opération est classée au minimum : + +```text +Stable +Deprecated / Obsolete mais encore fonctionnelle +Unstable / Experimental +``` + +Règles runtime : + +- `Stable` : comportement normal ; +- `Deprecated/Obsolete` encore fonctionnelle : API conservée + `warn` via `ksp-logging-lib` lors de son utilisation ; +- `Unstable/Experimental` : API disponible + `warn` via `ksp-logging-lib` lors de son utilisation. + +La metadata de statut doit être centralisée afin d'éviter des warnings codés en dur de manière dispersée. + +Une méthode supprimée du protocole et réellement non utilisable n'est pas simulée artificiellement ; son historique peut rester documenté. + +### 4.4 HTTP : pools et rôles + +Le transport HTTP doit reprendre/refondre les besoins utiles de bot3 : + +- JSON-RPC ; +- endpoints nommés ; +- provider/cluster metadata ; +- activation/désactivation ; +- pool logique d'endpoints ; +- rôles ; +- priorités ; +- request kinds/capabilities ; +- rate limits et burst lorsque configurés ; +- concurrence maximale ; +- pause/backoff après limitation ; - timeouts ; -- sessions WebSocket ; -- subscribe/unsubscribe ; -- reconnect borné ; -- snapshots de session et événements ; -- catalogue de méthodes HTTP standard ; -- catalogue de subscriptions WS standard ; -- typed requests/configs pour comptes, blocs, cluster, économie, tokens et transactions ; -- méthodes techniques utiles à l'exécution : blockhash, fee, simulation, send, status/confirmation, airdrop ; -- adaptation de `getSignaturesForAddress` et `getTransaction`. +- retry transport borné ; +- health/snapshots utiles ; +- méthodes read **et** write/execution technique documentées. -Écarts déjà identifiés : +Le pool HTTP est un pool **logique d'endpoints/clients**. KSP ne réimplémente pas un gestionnaire bas niveau de sockets que la bibliothèque HTTP sait déjà gérer. -- les clients publics consomment directement des types `ks-config` ; -- `SolanaRpcClient` dépend d'un type `ks_lib::MdSignature` ; -- l'adaptation `getTransaction` produit directement `ks_lib::MdCanonicalTransaction` ; -- la crate appelle directement `tracing` ; -- les modèles transport, modèles canoniques Core et responsabilités d'exécution technique sont partiellement entremêlés ; -- le découpage KSP exige des modèles homogènes possédés par le transport, indépendants du futur Store et du Program processing. +### 4.5 WebSocket : session avant pool automatique -Le besoin transport est donc clairement à reprendre, mais la frontière publique doit être auditée avant toute migration. - -### 4.4 Interface/wire - -Bot3 ne possède pas une crate `ks-interface` dédiée. Les contrats wire sont dispersés principalement dans `ks-lib` et dans ses dépendances externes. - -Le manifest bot3 montre notamment des dépendances directes à : - -- interfaces Solana/Anza ; -- interfaces SPL ; -- `mpl-token-metadata` ; -- `borsh` 1.x et un alias `borsh_0_10` ; -- `wincode` ; -- primitives Solana diverses. - -`ks-lib` contient dans le snapshot fourni 188 fichiers sous `src/decoder/`, dont des modules `wire.rs`, `state.rs`, payloads, adapters et code de décodage. Cette organisation est une source d'inventaire, pas un modèle cible. - -KSP exige que : - -- `ksp-interface-lib` possède/réexporte le wire officiel nécessaire ; -- les codecs wire y soient confinés lorsqu'ils servent au protocole ; -- les dépendances protocole externes remplaçables ne forcent pas des générations anciennes ; -- `ksp-program-lib` consomme des contrats typés au lieu de redécoder directement le wire ; -- Metaplex Token Metadata et certaines interfaces SPL puissent être réimplémentés de manière compatible plutôt qu'importés comme dépendances runtime. - -L'audit Interface doit donc être mené par **contrat wire utilisé**, pas par copie des modules `ks-lib`. - -### 4.5 Program API / Program - -Sources principales : +Une URL WebSocket doit pouvoir avoir plusieurs sessions physiques simultanées : ```text -ks-lib/src/decoder/api/ -ks-lib/src/decoder/** -ks-lib/src/executor/api/ -ks-lib/src/executor/** -ks-lib/tests/external_decoder_api.rs -ks-lib/tests/external_executor_api.rs +endpoint URL + 1 -> N sessions + +session + 1 -> N subscriptions ``` -Bot3 possède déjà des idées utiles : +Cette capacité est nécessaire pour permettre ultérieurement l'isolation de familles de subscriptions, des limites provider différentes, des reconnects indépendants ou une répartition de charge. -- identité/descripteur de decoder ; -- déclaration de couverture ; -- reconnaissance compatible/incompatible ; -- diagnostics et preuves ; -- outcome explicite ; -- trait de decoder d'instruction ; -- capacités d'exécution ; -- plan préparé ; -- comptes et signers requis ; -- politiques de cluster/simulation/blockhash/coûts ; -- traits d'executor typé et générique. +En revanche, `0.2.4` ne doit pas créer par anticipation un scheduler/pool automatique complexe de sessions tant qu'un besoin concret ne le démontre pas. -Mais `ks-lib` regroupe decoder, executor et materializer dans une seule crate, avec 477 fichiers Rust dans le snapshot fourni. KSP a déjà décidé de séparer : +Les concepts attendus sont d'abord du type : + +```text +WsEndpoint +WsSession +WsSessionId +WsSubscription +WsSubscriptionId +``` + +Un éventuel `WsSessionPool`/routing automatique reste need-driven. + +### 4.6 Helius LaserStream WebSocket + +`0.2.5` n'est pas une copie du client WebSocket standard. + +Les extensions Helius doivent réutiliser le moteur/session/lifecycle WebSocket construit en `0.2.4` et ajouter uniquement les contrats, filtres, notifications et capabilities spécifiques nécessaires. + +Le modèle multi-session d'une même URL reste identique. + +### 4.7 Yellowstone gRPC + +`0.2.6` introduit un premier backend/client Yellowstone gRPC standard et provider-neutral. + +La release ne doit pas figer l'architecture autour de Helius, Triton, ERPC, Chainstack, Shyft ou d'un autre provider. Un provider disponible peut servir à la validation réseau, mais il reste un **environnement de test**, pas le propriétaire du contrat KSP. + +Le `pre.001` de `0.2.6` devra inventorier la surface normative Yellowstone réellement actuelle et appliquer le gate de dimensionnement. Si la couverture complète de la surface ciblée ne tient pas dans une release clôturable dans la session, elle sera divisée avant implémentation. + +Les adaptations/provider profiles plus avancés sont reportés après les fondations prioritaires. + +## 5. Wallet + +### 5.1 `0.2.2` — format natif `.kspwallet` + +Le format KSP devient : + +```text +.kspwallet +``` + +L'ancien `.kswallet` de bot3 est une référence historique, pas le nom KSP final. + +Les fonctionnalités utiles à reprendre/refondre comprennent : + +- création ; +- ouverture/déverrouillage ; +- identité publique/pubkey sans exposition du secret ; +- secret chiffré ; +- signature ; +- mot de passe ; +- changement de mot de passe sans changement de keypair ; +- publication atomique/no-clobber ; +- redaction/zeroization adaptées ; +- alias/organisation ; +- import/export ; +- inspection d'un format externe sans import lorsque pertinent ; +- migrations/conversions utiles. + +### 5.2 Abandon du wallet temporaire JSON + +Le `TemporaryWalletStore`/wallet JSON temporaire de bot3 est un héritage de bot2 utilisé principalement pour les anciens scénarios. + +Il n'est pas migré dans KSP. + +Les futurs scénarios utilisent de vrais `.kspwallet`, y compris des wallets dédiés Devnet/tests si nécessaire. + +### 5.3 `WalletPolicy` + +`WalletPolicy` ne fait pas partie de `ksp-wallet-lib`. + +Les règles de dépense, réseau, programme, simulation, limites ou autorisations appartiennent à la future execution policy : + +```text +ksp-execution-policy-api +``` + +Une policy petite et spécifique à un scenario/orchestrateur peut être implémentée directement dans sa crate. Une ou plusieurs bibliothèques de policies communes ne seront créées que lorsque des comportements réellement réutilisables le justifieront. + +### 5.4 Import/export extensible + +`0.2.2` doit conserver une architecture d'import/export extensible et fournir les formats réellement nécessaires à sa validation. + +Les formats additionnels à étudier restent dans `docs/IDEAS.md` tant qu'ils ne sont pas engagés. Le projet ne doit pas ajouter toutes leurs dépendances « au cas où ». + +## 6. `0.2.3` — Wallet Desk + +`ksp-app-wallet-desk` est une application Tauri mince construite selon le modèle validé par Config Desk. + +Elle doit valider ensemble : + +```text +ksp-config-lib ++ configuration composite ++ ksp-wallet-lib ++ ksp-onchain-transport-lib HTTP figé par 0.2.1 +``` + +La première version doit au minimum permettre d'observer l'identité d'un wallet et son solde via le transport HTTP afin que le Wallet ne soit pas validé uniquement hors réseau. + +L'application ne réimplémente ni cryptographie Wallet, ni JSON-RPC, ni Config. + +## 7. Off-chain transport + +### 7.1 Première surface volontairement petite + +`0.2.7` introduit `ksp-offchain-transport-lib` avec un premier besoin réel : récupération de prix, au minimum : + +```text +SOL/USD +SOL/EUR +``` + +La bibliothèque doit séparer le besoin « lire un prix » de l'API propriétaire du premier provider retenu. + +La première release n'a pas à introduire immédiatement IPFS, Arweave, metadata HTTP, quotes/routing ou tous les providers imaginables. + +### 7.2 Application prix + +`0.2.8` introduit une petite application desk utilisant Config + `ksp-offchain-transport-lib` pour visualiser les prix et valider la capacité hors chaîne dans une UI réelle. + +Les readers/retrievers metadata HTTP/IPFS/Arweave arriveront lorsqu'un groupe Metadata en aura réellement besoin. + +## 8. `ksp-interface-lib` + +### 8.1 Une seule crate pour l'instant + +`ksp-interface-lib` reste la façade wire officielle KSP. + +Aucune crate `ksp-interface-api` séparée n'est décidée actuellement. + +La bibliothèque doit toutefois exposer une **API publique wire suffisamment propre** pour qu'une crate Program externe puisse utiliser les mêmes contrats que les implémentations officielles KSP. + +Ainsi : ```text ksp-interface-lib + = implémentations/réexports wire officiels + + API publique wire réutilisable +``` + +Une extension externe peut expérimenter contre cette API avant intégration officielle dans KSP. + +Si une future contrainte de dépendance démontre qu'un split `ksp-interface-api` est réellement nécessaire, la décision pourra être revue selon `KSP-API-007`. La symétrie de nommage ne suffit pas. + +### 8.2 Interfaces officielles et wires compatibles + +La politique reste : + +- réutiliser/réexporter de manière contrôlée une interface officielle suffisamment stable et compatible ; +- wrapper lorsqu'une frontière publique KSP est nécessaire ; +- posséder/réimplémenter une définition wire compatible lorsqu'une bibliothèque protocolaire externe est instable, ancienne, lourde ou impose des générations de dépendances incompatibles ; +- supporter au besoin des anciens wires réellement observables sans forcer le workspace entier à utiliser les anciennes bibliothèques. + +Metaplex Token Metadata reste un exemple important de wire à posséder/compatibiliser plutôt que d'imposer directement `mpl-token-metadata` aux couches supérieures. + +## 9. `ksp-program-api` + +La nomenclature canonique est : + +```text ksp-program-api ksp-program-lib -ksp-execution-policy-api -ksp-execution-lib -ksp-materializer-api / lib plus tard ``` -Les traits `DcApi*` / `ExApi*` sont donc des sources de concepts et de tests de compatibilité, pas des contrats à recopier. +et jamais `ksp-program-api-lib`. -### 4.6 Pipeline et execution historique +`ksp-program-api` est la crate de contrats extensibles. `ksp-program-lib` utilisera et implémentera ces contrats. -`ks-pipeline` orchestre dans bot3 backfill, Core extraction, replay, stateful processing, preflight et execution. Ce regroupement n'est pas retenu par KSP. +Une future crate externe pourra également implémenter `ksp-program-api` sans dépendre de `ksp-program-lib`. -Pour `0.2.x`, seules les parties utiles à la future frontière Program/policy/execution doivent être étudiées. Les responsabilités Store, materialization, replay et workers restent hors périmètre et appartiennent à `0.3.x+`. +`0.2.10` ouvre uniquement la première API Program ; les implémentations Program réelles sont décalées vers la progression verticale ultérieure. -Point important : les opérations techniques `simulateTransaction`, `sendTransaction`, blockhash, fee et signature status peuvent rester des capacités du transport, tandis que le lifecycle « préparer -> policy -> blockhash -> signer -> simuler -> envoyer -> confirmer -> valider » appartient à `ksp-execution-lib` lorsque le premier scénario réel le justifie. +## 10. Architecture de données canonique -### 4.7 Scénarios et demos - -Sources principales : +La progression durable KSP est désormais exprimée comme : ```text -ks-wallet-demo-scenarios/ -ks-pipeline-demo-scenarios/ -kb-app-demo-desktop/ +RAW + ↓ +CORE + ↓ +DECODE + ↓ +SPECIALIZED ``` -Éléments positifs : - -- scénario wallet réutilisable hors Tauri ; -- campagnes Devnet spécialisées ; -- fixtures contractuelles ; -- validations de postconditions ; -- séparation progressive entre logique réutilisable et DTO/UI desktop. - -Éléments à corriger dans KSP : - -- `ks-pipeline-demo-scenarios` reste très large et regroupe plusieurs domaines ; -- il dépend directement de nombreuses crates Solana/SPL/Metaplex ; -- `kb-app-demo-desktop` reste une application omnibus ; -- certaines responsabilités ont historiquement été dupliquées entre desktop et scénarios. - -KSP conserve le principe de validation réutilisable, mais avec des crates `ksp-scenario--lib` et des applications spécialisées minces lorsque le scénario le justifie. - -### 4.8 Off-chain - -Aucune crate off-chain générale n'existe dans le snapshot bot3. Les documents bot3 indiquent explicitement que la résolution off-chain Metadata avait été reportée. - -Il n'existe donc rien à migrer ici. `ksp-offchain-transport-lib` reste `need-driven` et sera classé `ajouter` seulement lorsqu'un premier besoin réel de `0.2.x` ou d'une série suivante l'exigera. - -## 5. Première matrice de décision - -Les décisions ci-dessous sont **provisoires**. Elles servent à orienter les audits spécialisés et ne figent aucun numéro `0.2.1+`. - -| Capacité / contrat | Source bot3 | Statut initial | Justification | Propriétaire KSP pressenti | Dépendances / risques | Release candidate non figée | -|----------------------------------------------------|---------------------------------------------------|----------------------------------|-------------------------------------------------------------------------|----------------------------------------------------------------------------------------|----------------------------------------------------|----------------------------------------------| -| identité/alias wallet public | `ks-wallet::WalletAlias`, `WalletIdentity` | reprendre | contrat non secret utile et simple | `ksp-wallet-lib` | aligner erreurs/types Core | `0.2.x — lot Wallet` | -| password possédé/redacted | `WalletPassword` | reprendre | invariant sécurité utile | `ksp-wallet-lib` | zeroization, pas de serde/clone | `0.2.x — lot Wallet` | -| capacité wallet unlocked non clonable | `UnlockedWallet` | adapter | bonne frontière secret/signature, API externe à réévaluer | `ksp-wallet-lib` | primitives signer/keypair, lifetime mémoire | `0.2.x — lot Wallet` | -| format natif `.kswallet` v1 | `ks-wallet/native.rs`, `NATIVE_FORMAT.md` | adapter | format versionné et authentifié utile ; doit être revalidé pour KSP | `ksp-wallet-lib` | compatibilité bot3, crypto, migration | `0.2.x — lot Wallet` | -| création native atomique/no-clobber | `WalletManager::create` | reprendre | invariant de persistence utile | `ksp-wallet-lib` | filesystem/permissions/concurrence | `0.2.x — lot Wallet` | -| scan/lookup borné | `WalletManager` | reprendre | limite de confiance claire | `ksp-wallet-lib` | symlinks/permissions à réauditer | `0.2.x — lot Wallet` | -| import/export Solana CLI JSON + Base58 64 octets | `transfer.rs` | adapter | formats utiles mais secrets explicitement privilégiés | `ksp-wallet-lib` + app DTO | confirmations UI, path policy, zeroization | `0.2.x — lot Wallet/app` | -| migration legacy JSON | `migrate_legacy` | adapter | utile si compatibilité bot3 réellement requise | `ksp-wallet-lib` | ne pas faire du legacy le format normal | `0.2.x — lot Wallet` | -| `TemporaryWalletStore` JSON legacy | `wallet.rs` | abandonner | persistence historique plus faible et redondante | aucun | éviter deux stores secrets concurrents | `0.2.x — aucun` | -| `WalletPolicy::lamport_spend_limit` | `wallet.rs` | refondre | policy métier mal placée dans Wallet | `ksp-execution-policy-api` ou policy de scenario | ne pas coupler secrets et safety | `0.2.x — lot Execution si nécessaire` | -| document Config wallet | `ks-config/src/wallet.rs` | adapter | besoin de racine/profil/alias, mais Config KSP est déjà propriétaire | `ksp-config-lib` | aucun secret/mot de passe | même release que premier besoin Wallet | -| app Wallet spécialisée | panneau `demo_wallet.rs` | refondre | bot3 mélange Wallet/RPC/execution ; KSP veut une app spécialisée | `ksp-app-wallet-desk` | DTO applicatifs, Config Desk comme référence | `0.2.x — lot Wallet app` | -| scénario lifecycle Wallet | `ks-wallet-demo-scenarios` | adapter | validation hors Tauri utile | `ksp-scenario-wallet-lib` si le workflow justifie une crate | ne pas créer une API scénario générique | `0.2.x — avec Wallet/app` | -| JSON-RPC HTTP générique | `ks-onchain-transport` | adapter | capacité fondamentale | `ksp-onchain-transport-lib` | reqwest, erreurs KSP, Logging | `0.2.x — lot Transport` | -| sessions/subscriptions WS | `WsSession`, `standard_ws` | adapter | besoin acquisition/demos futur | `ksp-onchain-transport-lib` | reconnect, backpressure, cancellation | `0.2.x — lot Transport` | -| pools/rôles/quota endpoints | `HttpEndpointPool`, `WsEndpointPool`, role config | adapter | utile pour providers multiples | `ksp-onchain-transport-lib` + Config adapter | éviter API publique dépendante de shape Config | `0.2.x — lot Transport` | -| typed standard RPC contracts | `standard_http*`, `standard_ws` | reprendre | couverture et tests constituent une bonne référence | `ksp-onchain-transport-lib` | vérifier conformité RPC actuelle | `0.2.x — lot Transport par surfaces bornées` | -| modèles techniques simulation/send/status | `execution_rpc.rs` | adapter | nécessaires au transport d'exécution, pas à la policy | `ksp-onchain-transport-lib` | lifecycle supérieur hors transport | `0.2.x — Transport puis Execution` | -| `getTransaction -> ks_lib::MdCanonicalTransaction` | `get_transaction.rs` | refondre | dépendance Transport -> monolithe métier interdite | `ksp-onchain-transport-lib` pour acquisition homogène ; futur Core processing ailleurs | frontière raw/canonical à redéfinir | `0.2.x — lot Transport` | -| `SolanaRpcClient` utilisant `ks_lib::MdSignature` | `client.rs` | refondre | contrat transport ne doit pas dépendre de Program/lib historique | `ksp-onchain-transport-lib` | choisir primitive/DTO transport minimal | `0.2.x — lot Transport` | -| wire Solana/SPL officiel | dépendances + modules `ks-lib` | adapter | besoin certain mais ownership change | `ksp-interface-lib` | générations codecs/primitives | `0.2.x — lot Interface` | -| wire Metaplex runtime via `mpl-token-metadata` | `ks-lib` | refondre | contraire à la politique KSP déjà décidée | `ksp-interface-lib` | compatibilité wire à prouver | `0.2.x/0.4.x selon première surface` | -| double génération Borsh historique | `borsh_0_10` + `borsh` | abandonner comme stratégie cible | dette historique à ne pas institutionnaliser | `ksp-interface-lib` | audit `cargo tree -d` au premier wire réel | `0.2.x — lot Interface` | -| contrats decoder ouverts | `decoder/api` | adapter | concepts utiles mais noms/types/ownership à redéfinir | `ksp-program-api` | extensibilité/persistabilité | `0.2.x — lot Program API` | -| implementations decoder | `decoder/**` | refondre par surfaces | aucune migration massive ; seulement premiers besoins réels | `ksp-program-lib` | dépend de `ksp-interface-lib` | `0.2.x puis 0.4.x+` | -| executor bot3 | `executor/**` | refondre | KSP remplace l'idée d'executor programme par `ProgramExecutionPreparer` | `ksp-program-api` + `ksp-program-lib` | aucune signature/RPC/policy dans Program | `0.2.x — lot Program` | -| policy d'exécution | `ExApiExecutionPolicy`, pipeline preflight | refondre | les règles utiles sont dispersées entre executor/pipeline/config | `ksp-execution-policy-api` | ne créer qu'au premier scenario réel | `0.2.x — conditionnel` | -| orchestration d'exécution | `ks-pipeline` | refondre | pipeline monolithique non retenu | `ksp-execution-lib` | Wallet + Transport + Program API + policy | `0.2.x — conditionnel` | -| `ks-pipeline` comme crate monolithique | `ks-pipeline` | abandonner | explicitement contraire au découpage KSP | aucun | extraire seulement concepts utiles | `0.2.x — aucun` | -| scenario crate multi-domaines | `ks-pipeline-demo-scenarios` | refondre | validation utile, granularité/dep firewall incorrects | `ksp-scenario--lib` | pas de dépendances Solana directes depuis scénario | `0.2.x selon scenario` | -| desktop demo omnibus | `kb-app-demo-desktop` | abandonner comme modèle cible | Config Desk a déjà établi la référence Tauri spécialisée | apps spécialisées | éviter agrégation progressive | `0.2.x — aucun` | -| transport off-chain général | absent/reporté | ajouter conditionnellement | bot3 ne le fournit pas ; KSP le veut seulement au besoin | `ksp-offchain-transport-lib` | ne pas introduire par anticipation | à décider au premier besoin réel | - -## 6. Écarts KSP déjà confirmés - -### 6.1 Config - -Les documents historiques `wallet.config.json`, `transport.config.json` et `execution.config.json` ne doivent pas être copiés comme sous-système Config parallèle. - -Lorsqu'une capacité `0.2.x` a besoin d'un document : - -- le document est enregistré dans `ksp-config-lib` ; -- schema, profils, environnement, sensibilité et persistence restent gérés par `ksp-config-lib` ; -- la bibliothèque fonctionnelle reçoit un settings/runtime model adapté sans parser elle-même `.env` ou les fichiers Config ; -- aucun mot de passe ou keypair wallet n'est persisté dans Config. - -### 6.2 Logging - -Les appels `tracing::*` directs de bot3 sont des implémentations historiques. - -Les nouvelles crates KSP comportementales utilisent la façade `ksp-logging-lib`. Aucun composant Wallet, Transport, Program ou Scenario ne crée son propre subscriber/runtime. - -### 6.3 Tauri - -`kb-app-demo-desktop` ne sert plus de modèle architectural général. Le modèle de référence est `ksp-app-config-desk` : app mince, DTOs applicatifs, bridge Logging, modals Bootstrap, séparation services/commands, validations frontend/Tauri et build Tauri final en dernière opération. - -### 6.4 Dépendances externes - -La centralisation workspace est obligatoire. L'audit doit distinguer : - -- primitives fondamentales explicitement autorisées ; -- crates d'interface officielles réexportables ; -- crates protocole à réimplémenter ; -- codecs wire appartenant à Interface ; -- dépendances purement test/conformité. - -Aucune version upstream n'est figée dans `pre.001`; les versions seront vérifiées depuis les sources officielles au moment où un lot décide réellement d'introduire la dépendance. - -### 6.5 Program / Execution - -La frontière cible reste : +Les aliases durables D1–D4 restent utilisables : ```text -wire - | - v -ksp-interface-lib - | - v -ksp-program-api <---- implementation externe éventuelle - ^ | - | v -ksp-program-lib - -PreparedProgramExecution - | - +--> policy explicite - +--> wallet/signers - +--> transport RPC - v -ksp-execution-lib +D1 = RAW +D2 = CORE +D3 = DECODE / matérialisation générique décodée +D4 = SPECIALIZED ``` -Program prépare techniquement ; Execution orchestre ; Policy autorise/refuse/contraint ; Wallet détient les secrets ; Transport réalise les appels réseau. +### 10.1 RAW -## 7. Graphe de dépendances fonctionnelles initial +Acquisition suffisamment fidèle et replayable, avec provenance. -Le graphe de départ est : +Aucun décodage Program n'est requis. + +### 10.2 CORE + +Normalisation canonique **générique de la blockchain Solana** : blocs, slots, signatures, transactions/messages, comptes, instructions brutes, CPI, logs, meta et relations structurelles générales. + +CORE ne dépend pas du décodage d'un programme SPL/Metaplex/DEX. + +La transformation `RAW -> CORE` doit fonctionner même si aucun decoder Program n'existe. + +### 10.3 DECODE + +À partir de CORE commencent les interprétations Program/protocole. + +La frontière couvre successivement, selon le groupe : ```text - ksp-core-lib - / | \ - v v v - ksp-config-lib | ksp-logging-lib - | | | - | | | - v v v - +-------------------------------+ - | | - v v - ksp-wallet-lib ksp-onchain-transport-lib - | | - | transport models - | | - | v - | future acquisition consumers - | - | ksp-interface-lib - | | - | v - | ksp-program-api - | ^ - | | - | ksp-program-lib - | | - +-------+--------+ - | - v - ksp-execution-policy-api [seulement si besoin réel] - | - v - ksp-execution-lib [seulement si cycle réel] - | - v - ksp-scenario--lib - | - v - app scenario spécialisée +decoding + -> materialisation générique / journal durable ``` -Relations importantes : +D3 conserve suffisamment de provenance/versioning pour rejouer les projections spécialisées sans refaire l'acquisition. -- Wallet, Transport et Interface peuvent commencer indépendamment ; -- Program dépend d'Interface pour la première surface wire réelle ; -- Execution dépend de Program API + Policy + Wallet + Transport ; -- une app Wallet peut exister avant Program/Execution si elle valide le lifecycle Wallet sans exécuter de transaction ; -- un scenario Transport peut valider HTTP/WS sans Store ; -- Store/Materializer/worker restent exclus de `0.2.x` sauf découverte d'un contrat strictement nécessaire, qui devra alors être justifiée avant tout changement de roadmap. +### 10.4 SPECIALIZED -## 8. Hypothèses de découpage du reste de `0.2.x` +D4 contient les projections queryables spécialisées : token facts, metadata assets, pools, trades/swaps, positions, liquidité, prix, OHLC, routes et autres faits de domaine. -`pre.001` ne fixe **aucun** numéro `0.2.1+`. +Les modèles spécialisés sont conçus par **faits métier génériques** lorsqu'une normalisation inter-protocoles est pertinente ; ils ne sont pas automatiquement découpés en tables `meteora_*`, `raydium_*`, etc. -Les lots suivants sont uniquement des hypothèses à tester : +## 11. Ordre de développement par couches + +### 11.1 RAW et CORE : progression horizontale + +Les deux premières couches ne nécessitent pas de décodage Program. + +KSP peut donc les construire horizontalement jusqu'à disposer, pour chaque couche, de ses outils d'exploitation : ```text -Lot A — Wallet foundation -Lot B — Wallet specialized app + validation lifecycle -Lot C — On-chain transport foundation -Lot D — Transport validation/demo surfaces -Lot E — Interface/wire foundation -Lot F — Program API + first Program surface -Lot G — Execution policy + execution orchestration, seulement si un premier scenario l'exige +persistence +replay/backfill +worker/service lorsque nécessaire +application de contrôle/validation lorsque utile ``` -Deux ordres restent plausibles à ce stade : +Le principe est : terminer une couche exploitable avant d'ouvrir la suivante. + +### 11.2 À partir de DECODE : progression verticale par groupe + +À partir du premier groupe Program, KSP ne doit pas développer tous les decoders, puis tous les materializers, puis toutes les executions. + +Chaque groupe progresse verticalement : ```text -A -> B -> C -> D -> E -> F -> G +interfaces/wires nécessaires + -> decoding + -> materialisation générique + -> materialisation/projection SPECIALIZED si utile + -> préparation d'exécution + -> execution policy nécessaire + -> exécution + -> scénarios Devnet / validation ``` -ou : +Puis seulement le groupe prioritaire suivant devient le centre du travail. + +Cette règle évite une grande surface horizontalement incomplète. + +## 12. Ordre prioritaire des groupes Program + +L'ordre fonctionnel pressenti après RAW/CORE est : + +1. **Solana Core Programs** utilisés transversalement ; +2. **SPL orienté token/trading** : Token, ATA, Token-2022 et extensions pertinentes ; +3. **Metadata orientées token** : Metaplex Token Metadata + metadata Token-2022 ; +4. **Anchor** nécessaire aux protocoles suivants ; +5. **Meteora** ; +6. **Raydium** ; +7. **Pump** ; +8. **Orca** ; +9. première **Market Desk** ; +10. **routing** : Jupiter puis OKX et autres besoins réels ; +11. enrichissement Market Desk ; +12. programmes **trading-adjacent** indépendants ; +13. reste du décodage généraliste Solana. + +L'ordre exact entre Meteora/Raydium/Pump/Orca pourra être ajusté selon le trafic, les données réellement observées et les possibilités de validation au moment de leur ouverture, sans casser la règle de vertical slice. + +SPM est volontairement repoussé vers le décodage généraliste ultérieur ; il n'est pas inclus dans le premier groupe metadata token. + +## 13. Programmes satellites d'un protocole + +Un composant nécessaire à la compréhension ou au fonctionnement d'un protocole reste **dans le groupe de ce protocole**, même s'il n'est pas lui-même l'AMM/DEX principal. + +Exemples : ```text -C -> D -> A -> B -> E -> F -> G +Meteora + + vaults nécessaires + + fee/state programs nécessaires + + positions/bin arrays/auxiliaires + +Pump + + fee program + + launch/bonding/pool/state auxiliaire ``` -Le choix dépendra notamment de : +Même principe pour Raydium, Orca et les futurs protocoles. -- la maturité réellement récupérable du Wallet ; -- la taille minimale cohérente du transport HTTP/WS ; -- le premier cas d'usage Program retenu ; -- la nécessité ou non d'un cycle d'exécution réel avant `0.3.x`/`0.4.x`. +La catégorie `trading-adjacent` ne sert jamais de poubelle pour reporter les satellites d'un protocole déjà ciblé. -Aucun numéro ne sera attribué tant que les audits Wallet, Transport, Interface et Program ne sont pas suffisamment complets. +`trading-adjacent` désigne des programmes indépendants utiles au trading : oracles, vesting/locks indépendants, lifecycle token, signaux/risk ou autres capacités transversales. -## 9. Prévision souple des prereleases `0.2.0` +## 14. Market Desk progressive -Prévision initiale : +Une petite application marché spécialisée doit apparaître **après le premier ensemble Meteora/Raydium/Pump/Orca**, avant le routing si le vertical slice DEX fournit déjà suffisamment de données utiles. + +Nom candidat actuel : ```text -pre.001 méthode d'audit + cartographie initiale + première matrice -pre.002 audit Wallet + Config Wallet + app/scenario wallet -pre.003 audit transport on-chain HTTP/WS + Config transport + modèles -pre.004 audit Interface/wire + dépendances Solana/SPL/Metaplex + codecs -pre.005 audit Program API/Program + decoder + ProgramExecutionPreparer -pre.006 audit policy/execution + séparation transport/wallet/program + besoin réel -pre.007 audit scenarios/demos + validation infrastructure + off-chain gaps -pre.008 matrice consolidée + graphe final + découpage candidat 0.2.1+ -pre.009 challenge du découpage + missions/hors-scope/critères/prereleases par release -pre.010 clôture : cohérence documentaire, nettoyage, prompt première release fonctionnelle +ksp-app-market-desk ``` -Cette séquence peut être scindée ou réordonnée. En particulier, `pre.006` peut conclure que `ksp-execution-policy-api` / `ksp-execution-lib` doivent être reportés si aucun scénario `0.2.x` ne justifie encore leur implémentation. +La V1 pourra visualiser notamment : -## 10. Critères de clôture de `0.2.0` +- tokens ; +- pools/markets ; +- protocoles ; +- liquidité ; +- swaps/trades ; +- volumes ; +- prix ; +- OHLC/candles ; +- activité récente/live lorsque disponible ; +- provenance/diagnostics utiles. -`0.2.0` ne peut être clôturée que lorsque : +L'application consomme les faits KSP normalisés/spécialisés. Elle ne réimplémente pas un client Meteora/Raydium/Pump/Orca dans l'UI. -- les domaines Wallet, Transport, Interface, Program et Scenario ont un inventaire suffisant ; -- policy/execution ont une décision explicite d'introduction ou de report ; -- off-chain a une décision explicite `need-driven` ; -- chaque capacité significative a un statut de matrice et une justification ; -- les dépendances externes problématiques et doublons de générations sont identifiés ; -- le graphe de dépendances cible est cohérent avec les règles KSP ; -- le nombre et l'ordre des releases `0.2.1+` sont bornés par des missions concrètes ; -- chaque release proposée possède mission, périmètre, hors-périmètre, dépendances, critères de clôture et estimation souple des prereleases ; -- la première release fonctionnelle suivante est sélectionnée ; -- son prompt de démarrage est préparé ; -- les sujets non nécessaires sont reportés dans `docs/IDEAS.md` au lieu d'être introduits par anticipation. +Les OHLC appartiennent aux matérialisations/projections SPECIALIZED : l'application les lit ; elle ne reconstruit pas toutes les candles à chaque rendu. -## 11. Questions ouvertes après `pre.001` +Après Jupiter/OKX, la même application est enrichie avec : -Les questions suivantes structurent les audits suivants ; elles ne bloquent pas la clôture de `pre.001` : +- routes ; +- legs ; +- DEX utilisés ; +- quote vs execution lorsque disponible ; +- fees/slippage ; +- activité cross-DEX/routée. -1. Le format `.kswallet` bot3 doit-il être conservé byte-for-byte comme format KSP v1 compatible, ou KSP peut-il démarrer avec un nouveau magic/version et un import de compatibilité ? -2. Quelle primitive de signer doit constituer le contrat public minimal de `ksp-wallet-lib` sans propager inutilement `solana-keypair` ? -3. Les surfaces HTTP et WS de `ksp-onchain-transport-lib` tiennent-elles dans une même release bornée ou doivent-elles être séparées ? -4. Quels modèles `getTransaction` sont réellement transport-level et lesquels appartiennent au futur Core processing ? -5. Quelles interfaces Solana/SPL peuvent être réexportées directement et lesquelles doivent être possédées/réimplémentées par KSP ? -6. Quel premier Program réel est le meilleur canari pour valider `ksp-interface-lib` + `ksp-program-api` + `ksp-program-lib` sans anticiper la grosse phase Core/SPL `0.4.x` ? -7. Ce premier Program exige-t-il réellement un cycle d'exécution dans `0.2.x`, ou la préparation technique suffit-elle ? -8. Une crate `ksp-scenario-wallet-lib` apporte-t-elle une valeur durable distincte des tests d'intégration Wallet et de `ksp-app-wallet-desk` ? -9. Quel niveau de compatibilité opérateur avec les wallets/imports bot3 est réellement requis au démarrage de KSP ? +Plus tard elle pourra accueillir trading-adjacent, anomalies, indicateurs et outputs ML sans devenir prématurément l'application globale de KSP. -## 12. Hors périmètre de `pre.001` +## 15. Nouvelle trajectoire `0.3.x+` -Cette tranche ne : +### `0.3.x` — RAW / acquisition persistée -- crée aucune nouvelle crate N2 ; -- n'ajoute aucune dépendance Solana/SPL/Metaplex ; -- ne copie aucun source bot3 ; -- ne modifie aucun document Config runtime ; -- ne crée aucun Store/Materializer/worker ; -- ne fixe aucun numéro `0.2.1+` ; -- ne sélectionne pas encore la première release fonctionnelle de la série ; -- ne prétend pas avoir audité exhaustivement les 477 fichiers Rust de `ks-lib`. +Début actuellement retenu : -Le prochain travail porte sur l'audit Wallet détaillé et la confirmation de ses contrats récupérables. +```text +0.3.1 ksp-store-api + ksp-store-lib — modèles/persistence RAW uniquement +0.3.2 ksp-interface-lib — extension des wires génériques nécessaires à acquisition/CORE +0.3.3 ksp-job-api + ksp-job-backfill +0.3.4 application spécialisée de backfill +``` + +La suite de `0.3.x` doit terminer la couche RAW avec les workers/services/apps utiles avant l'ouverture de CORE. + +`0.3.1` ne doit pas introduire prématurément les tables DECODE/SPECIALIZED. + +### Série suivante — CORE + +Après RAW : + +```text +RAW -> CORE normalization +persistence CORE +replay RAW -> CORE +worker/service CORE +application de contrôle CORE +``` + +Cette couche reste indépendante des decoders Program. + +### Séries suivantes — vertical slices DECODE/SPECIALIZED/EXECUTION + +À partir de Solana Core Programs puis SPL/Metadata/Anchor/DEX, les séries seront découpées selon la taille réelle de chaque groupe et la règle « une release = une session ». + +Il est volontairement prématuré de figer maintenant chaque numéro jusqu'aux DEX. + +## 16. Matrice synthétique de décision + +| Capacité | Source bot3 | Statut | Propriétaire KSP | Release candidate | +|---------------------------------|---------------------------------|----------------------|----------------------------------------|------------------------| +| HTTP JSON-RPC standard | `ks-onchain-transport` | refondre | `ksp-onchain-transport-lib` | `0.2.1` | +| Config transport standard | `ks-config` transport | adapter/refondre | `ksp-config-lib` -> contrats Transport | `0.2.1` | +| Pools/rôles HTTP | `ks-onchain-transport` | reprendre/adapter | `ksp-onchain-transport-lib` | `0.2.1` | +| Wallet natif | `ks-wallet` | adapter/refondre | `ksp-wallet-lib` | `0.2.2` | +| `.kswallet` | bot3 | abandonner comme nom | `.kspwallet` | `0.2.2` | +| Temporary wallet JSON | bot2/bot3 | abandonner | aucun | — | +| `WalletPolicy` | `ks-wallet` | déplacer/refondre | execution policy | plus tard | +| Wallet Desk | desktop bot3 dispersé | refondre | `ksp-app-wallet-desk` | `0.2.3` | +| WebSocket standard | `ks-onchain-transport` | refondre | `ksp-onchain-transport-lib` | `0.2.4` | +| Multi-session même URL | besoin KSP | ajouter | `ksp-onchain-transport-lib` | `0.2.4` | +| Pool automatique de sessions WS | — | à démontrer | transport si besoin | IDEAS | +| Helius LaserStream WS | absent/incomplet bot3 | ajouter | `ksp-onchain-transport-lib` | `0.2.5` | +| Yellowstone gRPC | absent | ajouter | `ksp-onchain-transport-lib` | `0.2.6` | +| Providers gRPC spécifiques | absent | ajouter plus tard | adapters/capabilities Transport | IDEAS/futur | +| Prix SOL/USD, SOL/EUR | absent | ajouter | `ksp-offchain-transport-lib` | `0.2.7` | +| Price Desk | absent | ajouter | app spécialisée | `0.2.8` | +| Wire officiel | dispersé dans `ks-lib`/deps | refondre | `ksp-interface-lib` | `0.2.9` | +| API wire publique | absent comme frontière claire | ajouter | `ksp-interface-lib` | `0.2.9` | +| Program extension contract | `ks-lib` decoder/executor | refondre | `ksp-program-api` | `0.2.10` | +| Store RAW | `ks-store` | refondre | `ksp-store-api`/`ksp-store-lib` | `0.3.1` | +| Backfill | bot3 pipelines/jobs historiques | refondre | `ksp-job-api` + job concret | `0.3.3` | +| Market Desk | absent comme app KSP dédiée | ajouter | app spécialisée | après DEX prioritaires | + +## 17. Prévision souple des prereleases restantes de `0.2.0` + +`pre.001` a ouvert la méthode et la cartographie. + +`pre.002` fixe la direction fonctionnelle principale de `0.2.x`, la stratégie RAW/CORE/DECODE/SPECIALIZED, la progression verticale Program, le dimensionnement de session et prépare le prompt `0.2.1`. + +La suite de `0.2.0` doit rester courte : + +### `pre.003` candidate — audit de cohérence finale + +- relire le découpage complet `0.2.1 -> 0.3.x` ; +- vérifier qu'aucune capacité bot3 pertinente au transport/wallet/interface/program n'est perdue ; +- vérifier les dépendances et hors-périmètre ; +- corriger les incohérences documentaires restantes ; +- confirmer que `0.2.1` est suffisamment bornée. + +### dernière prerelease candidate + +- validations documentaires finales ; +- nettoyage/archivage ; +- mise à jour finale du changelog si prévue par le workflow ; +- finalisation du prompt `0.2.1` ; +- préparation de `0.2.0-rel.001`. + +Le nombre exact reste souple : ne pas créer artificiellement une prerelease vide si `pre.003` suffit pour clôturer. + +## 18. Première release fonctionnelle décidée : `0.2.1` + +La première release fonctionnelle de la série est désormais : + +```text +0.2.1 — ksp-onchain-transport-lib / Solana HTTP foundation +``` + +Sa mission est de fournir la première frontière réseau Solana KSP réellement exploitable par Wallet, applications futures, acquisition RAW et execution technique ultérieure. + +Le prompt préparatoire est : + +```text +prompts/006-V0_2_1_START_PROMPT.md +``` + +Il reste un brouillon vivant jusqu'à la publication stable de `0.2.0`, puis devient le prompt de reprise de `0.2.1`. diff --git a/docs/rules/PROMPT_STRUCTURE.md b/docs/rules/PROMPT_STRUCTURE.md index e40bf09..722e7a1 100644 --- a/docs/rules/PROMPT_STRUCTURE.md +++ b/docs/rules/PROMPT_STRUCTURE.md @@ -1,5 +1,5 @@ - + # Structure des prompts KSP @@ -41,6 +41,10 @@ Exemple : si `0.1.1` devient trop large, créer `0.1.2` plutôt que forcer tout Une série complète peut naturellement s'étendre sur de nombreuses sessions. +Une **release concrète**, en revanche, doit être planifiée pour être ouverte et clôturée dans une seule session de chat. Une version volontairement laissée ouverte pour être reprise dans une autre session n'est pas un découpage acceptable. + +Si `pre.001` révèle qu'une clôture dans la session est incertaine, la release est scindée **avant l'implémentation fonctionnelle lourde**. Cette contrainte s'ajoute au budget de 15–20 minutes par prerelease ; elle ne le remplace pas. + ## Structure recommandée d'un prompt 1. Identité de la série et de la release concrète visée ; diff --git a/docs/rules/RULES_DEPENDENCIES.md b/docs/rules/RULES_DEPENDENCIES.md index bdb72ca..8e55952 100644 --- a/docs/rules/RULES_DEPENDENCIES.md +++ b/docs/rules/RULES_DEPENDENCIES.md @@ -1,5 +1,5 @@ - + # Règles des dépendances KSP @@ -88,26 +88,27 @@ Elles complètent les règles Rust générales et le graphe de `docs/architectur - **DEP-TRANSPORT-002** — Les providers on-chain normalisent leurs réponses dans des modèles KSP homogènes par catégorie de données avant exposition aux consommateurs. - **DEP-TRANSPORT-003** — Les modèles de transport ne réalisent pas de décodage métier/protocolaire et doivent rester facilement convertibles en DTO raw persistants. - **DEP-TRANSPORT-004** — Aucun `ksp-onchain-transport-api` ou `ksp-offchain-transport-api` global n'est créé dans l'architecture actuelle. +- **DEP-TRANSPORT-005** — `ksp-onchain-transport-lib` et `ksp-offchain-transport-lib` ne dépendent pas de `ksp-config-lib` : ils possèdent leurs settings/runtime contracts publics, tandis qu'une couche de composition ou un adaptateur appartenant à Config traduit les documents de configuration vers ces contrats. ## Pipelines spécialisés - **DEP-PIPE-001** — KSP ne crée pas de `ksp-pipeline-lib` monolithique. -- **DEP-PIPE-002** — Les pipelines spécialisés retenus pour les frontières durables sont `ksp-pipeline-raw-ingestion-lib`, `ksp-pipeline-core-processing-lib`, `ksp-pipeline-generic-materialization-lib` et `ksp-pipeline-domain-projection-lib`. +- **DEP-PIPE-002** — Les frontières canoniques de processing sont `RAW -> CORE -> DECODE -> SPECIALIZED`. Une crate pipeline dédiée n'est créée que lorsqu'une logique doit réellement être réutilisée entre plusieurs lifecycle hosts (worker/job/app/test) ; aucune liste globale de quatre crates pipeline n'est imposée par symétrie. - **DEP-PIPE-003** — Un pipeline de processing dépend des APIs nécessaires à sa frontière et non des implémentations officielles correspondantes lorsque l'API permet l'injection/composition. - **DEP-PIPE-004** — Les pipelines spécialisés ne dépendent pas de `ksp-worker-api` ou `ksp-job-api`; worker et job possèdent le lifecycle. - **DEP-PIPE-005** — Worker live et job de replay/backfill réutilisent le même pipeline pour une même frontière durable afin d'éviter la duplication de logique. - **DEP-PIPE-006** — Le pipeline raw ingestion peut dépendre des modèles homogènes de `ksp-onchain-transport-lib` et de `ksp-store-api`, mais pas de `ksp-store-lib`. -- **DEP-PIPE-007** — Le pipeline Core processing dépend de `ksp-program-api` et non de `ksp-program-lib`. -- **DEP-PIPE-008** — Les pipelines de matérialisation/projection dépendent de `ksp-materializer-api` et non de `ksp-materializer-lib`. +- **DEP-PIPE-007** — La transformation `RAW -> CORE` est Solana-générique et ne dépend ni de `ksp-program-api`, ni de `ksp-program-lib`, ni de `ksp-materializer-api`; les premiers contrats Program interviennent seulement à partir de `CORE -> DECODE`. +- **DEP-PIPE-008** — À partir de `CORE -> DECODE`, les pipelines/processors verticaux peuvent dépendre de `ksp-program-api` et de `ksp-materializer-api` selon leur rôle, sans dépendre par défaut des implémentations officielles correspondantes lorsque l'injection/composition suffit. `DECODE -> SPECIALIZED` utilise de même les contrats de matérialisation/projection nécessaires sans imposer une implémentation globale unique. ## Worker / Job lifecycle - **DEP-WORKER-001** — `ksp-worker-control-lib` dépend de `ksp-worker-api` et ne dépend pas de `ksp-job-api`. - **DEP-WORKER-002** — Les workers de processing reconstruisent leur backlog depuis `ksp-store-api`/Store ; une notification ne suffit pas à prouver qu'un input a été traité. -- **DEP-WORKER-003** — Les workers concrets peuvent dépendre de `ksp-store-lib` et des implémentations officielles Program/Materializer nécessaires à la composition. +- **DEP-WORKER-003** — La logique réutilisable d'un worker/job dépend en priorité des APIs KSP (`ksp-store-api`, `ksp-program-api`, `ksp-materializer-api`, etc.) et reçoit les implémentations par composition. Le binaire/service mince peut câbler `ksp-store-lib` ou les implémentations officielles nécessaires sans transférer cet ownership à la logique du worker/job. - **DEP-JOB-001** — `ksp-job-api` ne dépend ni de `ksp-worker-api` ni de `ksp-worker-control-lib`. - **DEP-JOB-002** — Un orchestrateur futur peut consommer séparément les APIs/contrôles workers et jobs sans introduire un lifecycle parent commun. -- **DEP-JOB-003** — Les jobs de replay réutilisent les pipelines des workers correspondants au lieu de dupliquer la logique D1 -> D2, D2 -> D3 ou D3 -> D4. +- **DEP-JOB-003** — Lorsqu'une même transformation existe en live et en replay, jobs et workers réutilisent la même logique de transformation au lieu de dupliquer `RAW -> CORE`, `CORE -> DECODE` ou `DECODE -> SPECIALIZED`. ## Services, applications et control plane diff --git a/docs/rules/RULES_KSP.md b/docs/rules/RULES_KSP.md index 56d95c6..39976fe 100644 --- a/docs/rules/RULES_KSP.md +++ b/docs/rules/RULES_KSP.md @@ -1,5 +1,5 @@ - + # Règles spécifiques à KSP @@ -136,7 +136,7 @@ - **KSP-WORKER-005** — `ksp-worker-raw-retriever` est le worker d'acquisition raw live/quasi-live. Il ne décode pas, ne matérialise pas et ne réalise pas de replay/backfill historique. - **KSP-WORKER-006** — `ksp-worker-raw-retriever` persiste les données raw puis notifie leur disponibilité selon les contrats de données normalisés. - **KSP-WORKER-007** — `ksp-worker-raw-retriever` doit pouvoir faire évoluer à chaud les listeners et la sélection des données qu'il rapatrie/stocke. -- **KSP-WORKER-008** — Les workers de processing actuellement retenus sont `ksp-worker-core-processor`, `ksp-worker-generic-materializer` et `ksp-worker-domain-projector`; le dernier nom reste provisoire. +- **KSP-WORKER-008** — Les workers de processing ne sont pas figés à l'avance sous une chaîne globale `core -> generic materializer -> domain projector`. RAW et CORE peuvent disposer de workers horizontaux propres à leur couche ; à partir de DECODE, les workers/processors sont introduits au besoin avec chaque groupe fonctionnel vertical afin que décodage, matérialisation, projection spécialisée et validation d'exécution évoluent ensemble. - **KSP-WORKER-009** — Les workers de processing utilisent notification comme wake-up mais reconstruisent leur backlog depuis le Store. - **KSP-WORKER-010** — `ksp-worker-raw-retriever` distingue une configuration desired et une configuration effective lors des reconfigurations à chaud. - **KSP-WORKER-011** — Un cursor de scan est une optimisation ; les processing outcomes durables constituent la preuve qu'un input a été traité pour un processor/version/capability. @@ -176,7 +176,7 @@ ## Pipelines et scénarios - **KSP-PIPE-001** — KSP ne crée pas de `ksp-pipeline-lib` monolithique. -- **KSP-PIPE-002** — Les quatre pipelines spécialisés retenus pour les frontières durables sont raw ingestion, Core processing, generic materialization et domain projection. +- **KSP-PIPE-002** — Les frontières canoniques de données/processing sont `RAW -> CORE -> DECODE -> SPECIALIZED`. Les pipelines RAW et CORE peuvent être développés horizontalement jusqu'à leur acquisition/persistence/replay/worker/app ; à partir de DECODE, KSP progresse par groupes fonctionnels verticaux et ne pré-déclare pas une chaîne globale de crates pipeline pour tous les protocoles. - **KSP-PIPE-003** — Un pipeline spécialisé contient la logique réutilisable d'une frontière mais aucun lifecycle worker/job. - **KSP-PIPE-004** — Les pipelines utilisent les APIs Program/Materializer/Store lorsque ces frontières doivent être injectables ; les implémentations officielles sont composées par workers/jobs. - **KSP-PIPE-005** — Le traitement est at-least-once avec persistence idempotente et outcomes durables, plutôt qu'une promesse exactly-once distribuée. @@ -253,3 +253,7 @@ - **KSP-REL-013** — Toute bibliothèque KSP considérée comme complétée possède un `USAGE.md` durable, sans notes de version, présentant sa surface publique et un exemple d'utilisation pour chaque API publique destinée à être consommée directement ; plusieurs APIs étroitement liées peuvent partager un même exemple lorsque leur usage réel est composé. Les changements de release appartiennent au changelog/delta, pas au guide d'utilisation. - **KSP-REL-014** — Toute application/binaire Tauri KSP considéré comme complété possède un `USAGE.md` durable décrivant ses fenêtres, leurs objectifs, leurs flux principaux et leur utilisation opérateur. - **KSP-REL-015** — Une application Tauri complétée ne crée `PRESENTATION.md` que si elle possède réellement une vue de présentation embarquée ; dans ce cas le fichier est finalisé comme contenu UI sans liens navigables et reste distinct du `README.md` et du `USAGE.md`. +- **KSP-REL-016** — Une prerelease vise environ 15 à 20 minutes de travail effectif. Le `pre.001` dimensionne aussi la release concrète entière : une release doit pouvoir être ouverte, développée, validée et clôturée dans une seule session de chat. Si cette clôture paraît incertaine, la release est scindée avant l'implémentation fonctionnelle lourde ; une version volontairement répartie sur plusieurs sessions est interdite. +- **KSP-TRANSPORT-001** — Pour une surface de transport explicitement ciblée, KSP inventorie et implémente toutes les méthodes/opérations exposées par la documentation normative retenue, sauf impossibilité technique explicitement documentée. Les opérations `deprecated`/`obsolete` encore fonctionnelles et `unstable`/`experimental` restent utilisables mais émettent un `warn` via `ksp-logging-lib` à chaque utilisation concernée ; leur statut est décrit par une metadata centralisée et non par des warnings dispersés. +- **KSP-DATA-001** — La progression durable canonique est `RAW -> CORE -> DECODE -> SPECIALIZED`. RAW et CORE ne nécessitent aucun decoder Program ; le passage RAW -> CORE reste une normalisation générique de la blockchain Solana. À partir de DECODE, KSP progresse verticalement par groupe fonctionnel à travers wire, décodage, matérialisation, projection spécialisée si utile, préparation d'exécution, policy, exécution et scénarios de validation. +- **KSP-DATA-002** — Un programme ou composant satellite nécessaire à la compréhension, la matérialisation ou l'exécution correcte d'un protocole appartient au groupe de ce protocole. Il n'est pas reporté artificiellement dans une catégorie `trading-adjacent`. diff --git a/prompts/000-README.md b/prompts/000-README.md index 86133bc..b35b85d 100644 --- a/prompts/000-README.md +++ b/prompts/000-README.md @@ -1,5 +1,5 @@ - + # Prompts KSP @@ -26,3 +26,5 @@ Le prompt générique `0.1.x` a été affiné pendant `0.0.3` puis remplacé par - [`003-V0_1_3_START_PROMPT.md`](003-V0_1_3_START_PROMPT.md) — prompt historique destiné à ouvrir `0.1.3 — Configuration foundation` après publication stable de `0.1.2` ; - [`004-V0_1_4_START_PROMPT.md`](004-V0_1_4_START_PROMPT.md) — prompt final destiné à ouvrir `0.1.4 — ksp-app-config-desk` après publication stable de `0.1.3`. - [`005-V0_2_0_START_PROMPT.md`](005-V0_2_0_START_PROMPT.md) — prompt de reprise préparé à la clôture de `0.1.4`; il ouvre `0.2.0-pre.001`, release intermédiaire d'audit de `khadhroony-bot3`, de comparaison avec KSP et de planification/découpage du reste de `0.2.x`. + +- [`006-V0_2_1_START_PROMPT.md`](006-V0_2_1_START_PROMPT.md) — prompt préparatoire destiné à ouvrir `0.2.1 — ksp-onchain-transport-lib / HTTP Solana foundation` après publication stable de `0.2.0`; il impose l'audit exhaustif de la documentation HTTP Solana, la séparation Config/Transport, les pools/rôles et le gate de sizing « une release = une session ». diff --git a/prompts/006-V0_2_1_START_PROMPT.md b/prompts/006-V0_2_1_START_PROMPT.md new file mode 100644 index 0000000..2f35305 --- /dev/null +++ b/prompts/006-V0_2_1_START_PROMPT.md @@ -0,0 +1,655 @@ + + + +# Prompt de démarrage `0.2.1` — `ksp-onchain-transport-lib` HTTP Solana foundation + +## 1. Contexte de reprise + +La base attendue est la release stable `v0.2.0` de `khadhroony-solana-project`. + +`0.2.0` a audité `khadhroony-bot3`, refondu la roadmap et décidé que la première capacité fonctionnelle de `0.2.x` doit être le transport HTTP Solana, car les capacités suivantes — en particulier `ksp-wallet-lib` puis `ksp-app-wallet-desk` — doivent pouvoir interroger réellement le réseau, par exemple pour lire le solde d'un wallet. + +Les fondations stables à préserver sont : + +```text +ksp-core-lib +ksp-logging-lib +ksp-config-lib +ksp-app-config-desk +``` + +La release à ouvrir est : + +```text +0.2.1 — ksp-onchain-transport-lib / Solana HTTP foundation +``` + +La première tranche est : + +```text +0.2.1-pre.001 +``` + +`pre.001` est une tranche d'**audit, conception, inventaire exhaustif et dimensionnement**. Elle ne doit pas devenir automatiquement une grosse implémentation. + +## 2. Mission de `0.2.1` + +Créer la première version stable de `ksp-onchain-transport-lib` pour le transport **HTTP JSON-RPC Solana**, avec une API publique KSP indépendante de Config, du Store et des futures couches Program. + +La release doit fournir : + +- transport HTTP async ; +- JSON-RPC 2.0 ; +- settings runtime publics possédés par le transport ; +- endpoints nommés ; +- metadata provider/cluster ; +- pools logiques d'endpoints ; +- rôles/capabilities/request kinds ; +- priorités ; +- limites de débit/burst/concurrence lorsque configurées ; +- timeout ; +- retry/backoff transport borné ; +- observabilité via `ksp-logging-lib` ; +- toutes les méthodes HTTP exposées par la documentation normative Solana ciblée par la release ; +- méthodes read et méthodes write/execution technique ; +- classification centralisée des méthodes selon leur statut documentaire ; +- warnings runtime pour méthodes deprecated/obsolete encore fonctionnelles et unstable/experimental ; +- premier document Config standard Transport dans `ksp-config-lib` et adapter Config -> settings publics Transport ; +- tests, fixtures, documentation `README.md`/`USAGE.md` et preuve de complétude de la surface. + +`0.2.1` doit être un transport générique KSP utilisable directement par une bibliothèque, une application, un job ou un worker. Il ne doit pas être conçu uniquement pour Wallet Desk. + +## 3. Sources de vérité internes obligatoires + +Avant toute modification, relire au minimum : + +```text +ROADMAP.md +docs/000-README.md +docs/IDEAS.md + +docs/plans/002-FUNCTIONAL_RELEASE_SEQUENCE.md +docs/plans/007-V0_2_0_SERIES_PLANNING.md + +docs/architecture/002-LAYERS_AND_DEPENDENCIES.md +docs/architecture/003-COMPONENT_CONTRACTS.md +docs/architecture/004-COMPONENT_INVENTORY.md +docs/architecture/005-DEPENDENCY_GRAPH.md +docs/architecture/008-DATA_MATERIALIZATION_AND_STORE.md +docs/architecture/009-ACQUISITION_WORKERS_AND_JOBS.md + +docs/rules/RULES_KSP.md +docs/rules/RULES_DEPENDENCIES.md +docs/rules/RULES_RUST.md +docs/rules/PROMPT_STRUCTURE.md +docs/rules/VERSION_WORKFLOW.md +docs/rules/FILE_CONTRACTS.md +``` + +Relire également les contrats publics actuels de : + +```text +crates/ksp-core-lib +crates/ksp-logging-lib +crates/ksp-config-lib +``` + +Ne pas supposer leurs APIs à partir de bot3. + +## 4. Référence historique bot3 + +Auditer la dernière archive bot3 fournie disponible, en particulier : + +```text +ks-onchain-transport/ +ks-config/src/transport.rs +ks-config/src/settings.rs +kb-app-demo-desktop/src/demo_http.rs +kb-app-demo-desktop/src/demo_transport.rs +``` + +Sur `ks-onchain-transport`, examiner au minimum : + +```text +client.rs +endpoint_role.rs +execution_rpc.rs +get_signatures_for_address.rs +get_transaction.rs +http_client.rs +http_pool.rs +json_rpc.rs +standard_http.rs +standard_http_accounts.rs +standard_http_blocks.rs +standard_http_cluster.rs +standard_http_economics.rs +standard_http_tokens.rs +standard_http_transactions.rs +standard_methods.rs +validation.rs +README.md +USAGE.md +TODO.md +``` + +Bot3 est une **source fonctionnelle et historique**, pas une source normative d'architecture. + +Reprendre les besoins/invariants utiles ; ne pas reproduire : + +- dépendance publique Transport -> Config ; +- dépendance vers `ks-lib`/modèles canoniques ; +- appels directs `tracing` ; +- DTOs couplés au futur Store ; +- anciens stacks de dépendances uniquement parce qu'ils existent ; +- duplication inutile de modèles ou de codecs. + +## 5. Sources externes normatives + +Au début de `pre.001`, consulter la documentation **officielle et actuelle** de Solana pour JSON-RPC HTTP et identifier précisément la surface normative de la release. + +Ne pas utiliser une liste mémorisée ou la liste bot3 comme vérité. + +Pour chaque méthode HTTP documentée, relever au minimum : + +```text +nom RPC +catégorie +paramètres +config/commitment/encoding éventuels +forme du résultat +erreurs/nullable/optional importants +statut documentaire +stable | deprecated/obsolete | unstable/experimental +notes/version minimum éventuelles +lien/source normative +tests nécessaires +``` + +Vérifier également les spécifications/projets officiels nécessaires pour JSON-RPC et les crates externes retenues. + +Lorsque la documentation officielle Solana et une implementation/provider divergent, documenter l'écart au lieu de modifier silencieusement le contrat standard. + +## 6. Règle de couverture exhaustive + +`0.2.1` ne se limite pas aux méthodes actuellement utilisées par Wallet ou bot3. + +Pour la surface Solana HTTP officiellement ciblée : + +> **toute méthode exposée par la documentation normative doit être implémentée, sauf impossibilité technique explicitement documentée et validée.** + +Le `pre.001` doit créer une matrice de conformité durable, par exemple dans le plan `0.2.1` ou un document de validation dédié, permettant de vérifier qu'aucune méthode n'a été oubliée. + +Une méthode ne peut pas être déclarée couverte uniquement parce qu'un appel JSON générique existe : la release doit décider quelle surface publique typée/générique KSP est réellement promise et tester ce contrat. + +## 7. Méthodes deprecated, obsolete et unstable + +Chaque méthode possède une metadata de statut centralisée, conceptuellement : + +```text +Stable +Deprecated +Unstable +``` + +Les noms Rust exacts sont décidés en `pre.001`. + +### Deprecated / obsolete mais encore fonctionnelle + +- implémenter/conserver la méthode ; +- ne pas la masquer ; +- émettre un `warn` via `ksp-logging-lib` lorsqu'elle est utilisée ; +- inclure méthode, statut et contexte sûr dans le log ; +- ne jamais logguer de secrets/tokens/provider credentials. + +### Unstable / experimental + +- implémenter la méthode lorsqu'elle appartient à la documentation ciblée ; +- émettre un `warn` via `ksp-logging-lib` à l'utilisation ; +- documenter que son contrat externe peut évoluer. + +### Méthode réellement supprimée/non fonctionnelle + +Ne pas simuler un succès. Documenter l'historique et l'absence de support runtime si la méthode n'existe plus dans la surface normative actuelle. + +Les warnings ne doivent pas être dispersés à la main dans chaque méthode si une metadata/descripteur commun permet de garantir le comportement de manière centralisée. + +## 8. Frontière Config / Transport + +### Règle absolue + +```text +ksp-onchain-transport-lib -X-> ksp-config-lib +``` + +Le transport doit pouvoir être construit et testé sans Config. + +Il possède ses settings publics, conceptuellement : + +```text +HttpTransportSettings +HttpEndpointSettings +EndpointRoleSettings +RetrySettings +PoolSettings +... +``` + +Les noms/types exacts ne sont pas imposés par ce prompt. + +### Document standard Config + +`0.2.1` doit également introduire dans `ksp-config-lib` le premier document standard Transport HTTP et son schema, selon le moteur Config déjà stabilisé. + +Direction : + +```text +config/std.transport.json +config/schemas/std.transport.schema.json +config/examples/std.transport.example.json # si la convention Config l'exige/retient +``` + +Les `file_id` exacts suivent les conventions `ksp-config-lib` et sont décidés après audit des documents existants. + +Le document Config : + +- peut contenir plusieurs profils ; +- sélectionne/configure endpoints, rôles et paramètres HTTP ; +- utilise les placeholders d'environnement KSP pour URLs/tokens seulement selon le mécanisme Config existant ; +- ne lit jamais directement l'environnement dans Transport ; +- doit être extensible plus tard à WS/gRPC sans préremplir aujourd'hui des champs sans implementation ; +- reste manageable par Config Desk grâce au moteur générique existant, sans développer une UI Transport dédiée dans `0.2.1`. + +Adapter : + +```text +ksp-config-lib -> ksp-onchain-transport-lib public settings +``` + +La dépendance inverse reste interdite. + +Toute nouvelle variable d'environnement réellement utilisée est ajoutée à `.env.example` dans la même tranche, avec commentaire et namespace correct. + +## 9. Pools, rôles et capabilities + +Reprendre/refondre l'idée utile de bot3 sans figer ses structures exactes. + +Un endpoint HTTP doit pouvoir déclarer : + +- identité/name ; +- enabled ; +- provider ; +- cluster/network ; +- URL ; +- timeout/settings connexion ; +- rôles/capabilities ; +- priorités ; +- limites applicables. + +Un rôle peut porter selon le design retenu : + +- request kinds/méthodes supportées ; +- priorité ; +- requests per second ; +- burst ; +- max concurrent requests ; +- pause après rate-limit ; +- autres limites réellement justifiées. + +Ne pas créer une enum centrale fermée si des rôles configurables/string descriptors permettent une extension plus propre. + +Le pool HTTP sélectionne un **endpoint/client logique**, pas une socket brute. + +Le client HTTP sous-jacent reste propriétaire de son propre pooling de connexions réseau. + +Le `pre.001` doit décider explicitement : + +- stratégie de sélection ; +- comportement si aucun endpoint ne satisfait le rôle/méthode ; +- comportement sur endpoint disabled ; +- round-robin/priority/fallback éventuel ; +- gestion d'un endpoint rate-limited ; +- health/snapshot nécessaires ; +- thread-safety/concurrence. + +## 10. Retry, timeout et erreurs + +Distinguer strictement : + +### Retry transport + +Peut concerner une requête HTTP qui n'a pas obtenu de résultat exploitable en raison d'un problème transport/provider clairement retryable. + +### Retry d'exécution métier + +N'appartient pas à `0.2.1` et ne doit pas être inventé dans Transport. + +Le transport ne doit jamais décider de renvoyer une transaction Solana sur la seule base d'une erreur métier ou d'un timeout ambigu. + +Définir une classification d'erreurs KSP suffisamment précise pour distinguer au minimum : + +- invalid settings ; +- endpoint selection ; +- connection/HTTP ; +- timeout ; +- rate-limit ; +- JSON encode/decode ; +- JSON-RPC protocol ; +- RPC application error ; +- unsupported/deprecated status si nécessaire ; +- invalid response/invariant. + +Utiliser le type d'erreur KSP existant ; ne pas créer une deuxième hiérarchie publique incompatible. + +## 11. Modèles et ownership des types + +`0.2.1` ne doit pas dépendre du futur Store, de `ksp-program-api` ou de modèles DECODE/SPECIALIZED. + +Les réponses du transport appartiennent au domaine Transport ou utilisent les primitives KSP/bas niveau explicitement admises. + +Ne pas reproduire le couplage bot3 : + +```text +getTransaction -> ks_lib::MdCanonicalTransaction +``` + +Le transport doit préserver les informations nécessaires à la future persistence RAW et à la normalisation CORE sans effectuer lui-même ces transformations. + +Le `pre.001` doit inventorier les méthodes dont les réponses nécessitent une décision de représentation importante, notamment transactions/messages/accounts/blocks/token amounts/statuses, et fixer l'ownership avant code massif. + +Éviter `solana-client` ou un SDK haut niveau uniquement pour obtenir des DTOs si cela réintroduit un graphe massif et empêche KSP de posséder son contrat transport. Toute dépendance Solana supplémentaire doit être justifiée par un besoin précis et compatible avec le firewall KSP. + +## 12. Dépendances externes + +Toutes les dépendances tierces communes sont déclarées au `Cargo.toml` racine sous `[workspace.dependencies]`, puis consommées avec `.workspace = true`. + +Avant ajout, `pre.001` doit vérifier les versions actuelles et le graphe de dépendances des candidates. + +Bot3 utilisait notamment : + +```text +reqwest +serde +serde_json +tokio +base64 +bs58 +``` + +Cette liste est une référence d'audit, **pas une décision automatique**. + +Ne pas ajouter dans `0.2.1` les dépendances WebSocket/gRPC réservées aux releases suivantes, sauf nécessité technique démontrée pour le build HTTP. + +Exécuter les `cargo tree` pertinents après ajout : + +```bash +cargo tree -p ksp-onchain-transport-lib +cargo tree -p ksp-onchain-transport-lib -d +cargo tree -p ksp-onchain-transport-lib -e features +cargo tree -p ksp-onchain-transport-lib -e normal +``` + +et auditer les doublons réellement significatifs. + +## 13. Logging et observabilité + +`ksp-onchain-transport-lib` utilise `ksp-logging-lib` et ne dépend pas directement de `tracing` pour ses événements KSP. + +Target attendu : nom Cargo de la crate. + +Événements utiles à couvrir : + +- création client/pool ; +- sélection endpoint/role ; +- start/end d'une requête aux niveaux debug/trace appropriés ; +- retry ; +- timeout ; +- rate-limit/backoff ; +- endpoint unavailable/degraded ; +- RPC error ; +- méthode deprecated/unstable utilisée ; +- snapshots/health importants. + +Ne jamais logguer : + +- API key ; +- token provider ; +- URL contenant un secret non redacted ; +- transaction/signature payload sensible sans raison explicite ; +- contenu massif de réponses par défaut. + +Les informations provenant de `reqwest` ou d'autres dépendances sont réémises sous le target KSP lorsque réellement utiles ; ne pas ouvrir globalement leurs targets. + +## 14. Tests obligatoires + +### Tests unitaires + +Prévoir au minimum : + +- validation settings ; +- endpoint/role matching ; +- pool selection ; +- priority/fallback ; +- limiter/concurrence ; +- retry/backoff borné ; +- JSON-RPC request/response ; +- RPC error mapping ; +- nullable/optional responses ; +- method status metadata ; +- warning path deprecated/unstable ; +- aucune fuite de secret dans Debug/loggable snapshots. + +### Tests par méthodes + +Chaque méthode documentée doit être couverte par au moins une preuve adaptée : + +- request serialization ; +- response deserialization ; +- paramètres/configs ; +- cas optional/null/error importants. + +Utiliser des fixtures déterministes lorsque le réseau n'apporte aucune valeur au test. + +### Tests réseau opt-in + +Prévoir un petit nombre de smoke tests Devnet/Mainnet non destructifs si nécessaire pour démontrer l'interop réelle, sans rendre la suite par défaut dépendante d'Internet ou d'une clé provider. + +Les tests réseau nécessitant un provider/secret doivent être opt-in et utiliser Config/env via les mécanismes KSP, jamais des secrets versionnés. + +### Canaries architecturales + +Ajouter des tests/audits empêchant au minimum : + +```text +ksp-onchain-transport-lib -> ksp-config-lib +ksp-onchain-transport-lib -> ksp-store-* +ksp-onchain-transport-lib -> ksp-program-* +direct tracing ownership +``` + +et vérifiant la complétude de la matrice de méthodes si elle peut être automatisée. + +## 15. Hors périmètre strict de `0.2.1` + +Ne pas ouvrir : + +- WebSocket Solana — `0.2.4` ; +- Helius LaserStream WebSocket — `0.2.5` ; +- Yellowstone gRPC — `0.2.6` ; +- providers gRPC avancés ; +- Wallet — `0.2.2` ; +- Wallet Desk — `0.2.3` ; +- Store/persistence RAW — `0.3.1` ; +- decoders Program ; +- `ksp-interface-lib` fonctionnel complet ; +- materializers ; +- execution policy ; +- orchestration d'exécution métier ; +- worker/job d'acquisition ; +- Tauri app Transport dédiée ; +- trading/DEX/ML. + +Une méthode HTTP permettant techniquement `sendTransaction`, `simulateTransaction`, `requestAirdrop` ou autre opération write peut appartenir au **transport standard** et doit être implémentée si documentée ; cela ne signifie pas que `0.2.1` construit l'orchestration d'exécution KSP. + +## 16. Première mission : `0.2.1-pre.001` + +`pre.001` doit livrer un plan détaillé de `0.2.1`, candidat : + +```text +docs/plans/008-V0_2_1_ONCHAIN_HTTP_PLAN.md +``` + +Il doit contenir au minimum : + +1. audit exact de la base stable `v0.2.0` ; +2. audit détaillé de `ks-onchain-transport` bot3 ; +3. inventaire **exhaustif** des méthodes HTTP Solana documentées actuellement ; +4. statut `stable/deprecated/unstable` de chaque méthode ; +5. matrice méthode -> module/API KSP -> request -> response -> tests -> prerelease candidate ; +6. inventaire des contrats bot3 utiles à reprendre/adapter/refondre/abandonner ; +7. décision exacte sur les settings publics Transport ; +8. décision exacte pools/rôles/capabilities/priority/rate-limit/concurrence ; +9. stratégie retry/backoff/timeout ; +10. stratégie d'erreurs ; +11. ownership des modèles de réponse difficiles ; +12. dépendances externes retenues après vérification de versions/features ; +13. design du document `std.transport` et de l'adapter Config -> Transport ; +14. nouvelles variables `.env.example` réellement nécessaires, sans secret concret ; +15. architecture de tests/fixtures/smoke tests ; +16. canaries de dépendances/ownership ; +17. hors-périmètre confirmés ; +18. critères de clôture ; +19. prévision souple des prereleases ; +20. **gate de sizing de la release entière**. + +### Gate de sizing obligatoire + +À la fin de `pre.001`, répondre explicitement : + +```text +La release 0.2.1 peut-elle raisonnablement être entièrement clôturée dans cette session de chat +avec des prereleases de ~15–20 minutes ? +``` + +Si la réponse est non ou incertaine, **ne pas commencer la grosse implémentation**. Scinder immédiatement le périmètre en plusieurs releases `0.2.x`, mettre à jour ROADMAP/plan/prompt, puis seulement commencer la première release réduite. + +La contrainte de couverture documentaire exhaustive ne doit jamais être contournée en masquant des méthodes pour faire tenir artificiellement la release. + +## 17. Prévision souple initiale des prereleases + +Cette prévision est un point de départ et doit être recalibrée par `pre.001` à partir de la matrice réelle des méthodes. + +### `pre.001` — audit, matrice exhaustive, architecture et sizing + +Aucune grosse implementation. + +### `pre.002` — crate foundation + settings + JSON-RPC + method descriptors + +Candidat : + +- package/workspace ; +- contrats settings ; +- validation ; +- JSON-RPC envelope/error ; +- metadata de méthode/status ; +- base Logging. + +### Tranches méthodes HTTP + +Répartir les méthodes par familles cohérentes **après inventaire officiel**, par exemple accounts/cluster, blocks/transactions, tokens/economics, write/execution technique ou toute meilleure découpe révélée par la documentation. + +Aucune de ces tranches ne doit dépasser le budget 15–20 minutes ; ajouter des prereleases si nécessaire **uniquement si la release entière reste clôturable dans la session**. + +### Tranche pools/rôles/resilience + +- pools ; +- role matching ; +- priority/fallback ; +- rate-limit ; +- concurrency ; +- retry/backoff ; +- health/snapshots. + +### Tranche Config standard + +- schema/document/example ; +- registration/file IDs ; +- adapter Config -> Transport ; +- env inventory ; +- intégration tests. + +### Dernière prerelease + +- matrice de complétude 100 % de la surface ciblée ; +- tests ciblés et workspace ; +- cargo tree audits ; +- README/USAGE ; +- documentation durable ; +- cleanup/TODO ; +- prompt `0.2.2` Wallet ; +- préparation `rel.001`. + +## 18. Validation de chaque tranche Rust + +Après toute modification Rust : + +```bash +cargo fmt --all +cargo check --workspace +cargo clippy --workspace --all-targets +``` + +Pendant le développement : + +```bash +cargo test -p ksp-onchain-transport-lib +cargo test -p ksp-config-lib # lorsque Config est modifié +``` + +`cargo test --workspace` est exécuté aux frontières globales prévues par les règles, notamment ouverture/fermeture de version et validation finale. + +Exécuter les `cargo tree` pertinents pour les crates modifiées. + +Ne jamais déclarer une commande réussie si elle n'a pas été exécutée. + +## 19. Critères de clôture `0.2.1` + +La release ne peut pas être déclarée stable tant que : + +- `ksp-onchain-transport-lib` existe comme crate KSP propre ; +- aucune dépendance Transport -> Config/Store/Program n'existe ; +- les settings publics sont documentés ; +- le document Config Transport + adapter fonctionnent sans inverser l'ownership ; +- toutes les méthodes de la surface HTTP Solana normative ciblée sont présentes dans la matrice ; +- toutes les méthodes supportables ciblées sont implémentées ; +- deprecated/obsolete encore fonctionnel et unstable/experimental émettent le warning KSP prévu ; +- pools/rôles/priority/limites/timeouts/retry retenus sont testés ; +- les réponses restent transport/raw-compatible et ne produisent pas des modèles Program/Store ; +- aucun secret/provider token n'est loggué ; +- les tests ciblés passent ; +- les validations workspace finales passent ; +- le graphe de dépendances est audité ; +- `README.md` et `USAGE.md` sont complets ; +- TODO/hors scope sont fermés ou reportés explicitement ; +- le prompt final `0.2.2` est prêt ; +- la release entière a été clôturée dans la session qui l'a ouverte. + +## 20. Release suivante + +La release suivante prévue est : + +```text +0.2.2 — ksp-wallet-lib / .kspwallet foundation +``` + +Elle devra utiliser les fondations N1 mais **ne pas dépendre du transport** pour son cœur cryptographique/format. + +Le transport `0.2.1` sera ensuite composé avec Wallet dans `0.2.3 — ksp-app-wallet-desk` pour afficher notamment le solde réseau du wallet. + +## Instruction d'ouverture + +Commencer `0.2.1-pre.001` par la relecture des sources internes, l'audit exact du transport bot3 et la consultation de la documentation officielle Solana HTTP actuelle. + +Construire ensuite la matrice exhaustive des méthodes et le plan `008` **avant toute grosse migration/implémentation**. + +Ne pas copier `ks-onchain-transport` tel quel, ne pas introduire WebSocket/Yellowstone par anticipation, ne pas coupler Transport à Config, et ne pas commencer une release dont le sizing ne garantit pas raisonnablement la clôture dans cette même session.