FuelLabs/fuels-ts

Document merkle tree usage

Offen

#3.374 geöffnet am 05.11.2024

Auf GitHub ansehenContributor Guide
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (1.370 Forks)batch import
docsgood first issue

Repository-Metriken

Stars
 (43.186 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

Summary

We should add documentation on using Merkle trees using the @fuel-ts/merkle package. Currently, we export the binary and sparse variants, each of which should have documentation around their:

  • construction
  • proof generation
  • verification

Contributor Guide

Research-Richtung
Das Issue erfordert die Hinzufügung von Dokumentation für das Paket `@fuel ts/merkle`, das sowohl binäre als auch sparse Merkle Baum Varianten abdeckt. Dokumentieren Sie für jede Variante die Konstruktion, Proof Generierung und Verifizierung. Konsultieren Sie die vorhandenen Quelldateien im fuels ts Repository, wahrscheinlich unter packages/merkle oder ähnlich, um die aktuelle API und exportierten Funktionen zu verstehen. Überprüfen Sie vorhandene Tests auf Nutzungsbeispiele. Schreiben Sie eine klare Markdown Dokumentation mit Codebeispielen.
Tech Stack
typescript
Domain
blockchainbackend
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Merkle treesTypeScript
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60