43 lines
1.2 KiB
Markdown
43 lines
1.2 KiB
Markdown
<!-- file: docs/PROGRAM_CODE_INDEX.md -->
|
|
<!-- version: 1 -->
|
|
|
|
# Index court des programmes
|
|
|
|
L'idée d'un préfixe hexadécimal `00` à `ff` peut être utile comme identifiant court interne, mais elle ne doit pas remplacer le nom canonique lisible.
|
|
|
|
## Décision
|
|
|
|
Le nom de crate reste descriptif :
|
|
|
|
```text
|
|
kb_decoder_amm_pump_swap
|
|
kb_decoder_router_jupiter_aggregator_v6
|
|
kb_decoder_clmm_orca_whirlpool
|
|
```
|
|
|
|
Un code court optionnel peut être ajouté dans le registre :
|
|
|
|
```toml
|
|
registry_code = "00"
|
|
canonical_surface_code = "amm_pump_swap"
|
|
target_crate = "kb_decoder_amm_pump_swap"
|
|
```
|
|
|
|
## Pourquoi ne pas mettre `00_` dans les crates
|
|
|
|
- Le code `00` ne décrit pas la fonction du programme.
|
|
- L'ordre peut changer quand de nouvelles surfaces sont ajoutées.
|
|
- Deux cent cinquante-six valeurs peuvent devenir insuffisantes si toutes les surfaces, sysvars, routers, vaults, perps, bridges et variantes historiques sont incluses.
|
|
- Les renommages de crates deviendraient fréquents et inutiles.
|
|
|
|
## Usage acceptable
|
|
|
|
Le code court est acceptable pour :
|
|
|
|
- affichage UI compact ;
|
|
- clé stable optionnelle dans PostgreSQL ;
|
|
- tri manuel dans les matrices ;
|
|
- identifiant de configuration humain court.
|
|
|
|
Le code court ne doit pas servir de préfixe principal de nommage Rust.
|