rust-bitcoin / rust-bitcoin/rust-miniscript
`sanity_check` methods throughout the codebase shouldn't be part of the API
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Rust
- Estrellas
- 426
- Forks
- 200
- Merge medio
- 7 d 17 h
- PR fusionados (30 d)
- 8
Descripción
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
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza inventariando los métodos sanity_check en todo el código y revisando la discusión vinculada del pull request, incluido el ejemplo de la documentación sobre las rutas de gasto de Bitcoin. Determina qué métodos se pueden invocar externamente y qué invariantes debería imponer en su lugar el sistema de tipos; se considerará terminado cuando la API ya no exponga comprobaciones inapropiadas y la validez de los objetos se gestione de forma coherente.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- rust
- Área
- blockchain
- Tipo de issue
- Refactorización
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 25/100