digital-asset / digital-asset/ex-java-json-api-bindings

Clarify documentation of intended usage of the hash of a prepared transaction

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

Dieses Issue hat noch niemand übernommen.

documentation
Vorherrschende Sprache
Java
Sterne
1
Forks
0
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

@amarqueslee-da called out that he found this comment confusing / unhelpful.

> Only provided for convenience, clients MUST recompute the hash from the raw transaction if the preparing participant is not trusted.

Let's figure out how to do better.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

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, den zitierten Kommentar zum Hash einer vorbereiteten Transaktion und die umgebende Dokumentation zu prüfen, um festzustellen, welche beabsichtigte Verwendung unklar ist. Kläre die Vertrauensanforderung und erkläre, wann Clients den Hash verwenden oder neu berechnen sollten; die Dokumentation ist fertig, wenn ein Leser die erwartete Verwendung ohne Verwirrung verstehen kann.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
java
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

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