rust-bitcoin / rust-bitcoin/rust-miniscript
`sanity_check` methods throughout the codebase shouldn't be part of the API
Nessuno ha ancora preso questa issue.
- Lingua principale
- Rust
- Stelle
- 426
- Fork
- 200
- Merge medio
- 7g 17h
- PR unite (30g)
- 8
Descrizione
Actually I'll just file an issue. There are a lot of sanity_check methods in the code, many of which are not called from within the library, and at least one has a doc example suggesting to use it to check "whether all spend paths are accessible in the Bitcoin network".
So we need to re-assess all these functions and see if they can be pulled into the type system somehow so you simply can't create the objects without running the (non-pub) methods.
Originally posted by @apoelstra in https://github.com/rust-bitcoin/rust-miniscript/pull/652#discussion_r1514517762
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia facendo l’inventario dei metodi sanity_check nell’intera codebase e rivedendo la discussione collegata della pull request, incluso l’esempio nella documentazione sui percorsi di spesa di Bitcoin. Determina quali metodi sono chiamabili esternamente e quali invarianti dovrebbero invece essere garantite dal sistema dei tipi; il lavoro è completato quando l’API non espone più controlli inappropriati e la validità degli oggetti viene gestita in modo coerente.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- rust
- Ambito
- blockchain
- Tipo di issue
- Refactoring
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 25/100