rust-bitcoin / rust-bitcoin/rust-miniscript

`sanity_check` methods throughout the codebase shouldn't be part of the API

Offen
#653 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
Rust
Sterne
426
Forks
200
Ø Merge
7 T. 17 Std.
Gemergte PRs (30 T.)
8

Beschreibung

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

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, die sanity_check-Methoden im gesamten Codebestand zu inventarisieren und die verknüpfte Pull-Request-Diskussion einschließlich des Dokumentationsbeispiels zu Bitcoin-Ausgabepfaden zu prüfen. Ermittle, welche Methoden extern aufrufbar sind und welche Invarianten stattdessen vom Typsystem erzwungen werden sollten; abgeschlossen ist die Aufgabe, wenn die API keine unangemessenen Prüfungen mehr offenlegt und die Gültigkeit von Objekten konsistent behandelt wird.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
rust
Bereich
blockchain
Issue-Typ
Refactoring
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.