rust-bitcoin / rust-bitcoin/rust-miniscript
`sanity_check` methods throughout the codebase shouldn't be part of the API
Personne n'a encore pris cette issue.
- Langage dominant
- Rust
- Étoiles
- 426
- Forks
- 200
- Merge moyen
- 7 j 17 h
- PR mergées (30 j)
- 8
Description
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
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par inventorier les méthodes sanity_check dans toute la base de code et par examiner la discussion liée de la pull request, y compris l’exemple de documentation concernant les chemins de dépense de Bitcoin. Déterminez quelles méthodes sont appelables depuis l’extérieur et quelles invariantes devraient plutôt être garanties par le système de types ; le travail sera considéré comme terminé lorsque l’API n’exposera plus de vérifications inappropriées et que la validité des objets sera gérée de manière cohérente.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- rust
- Domaine
- blockchain
- Type d'issue
- Refactorisation
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Activité
- À l'abandon
- Clarté
- À clarifier
- Accessibilité débutants
- 25/100