FuelLabs/fuels-ts

Document merkle tree usage

Open

#3374 aperta il 5 nov 2024

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)TypeScript (1370 fork)batch import
docsgood first issue

Metriche repository

Star
 (43.186 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Il problema richiede l'aggiunta di documentazione per il pacchetto `@fuel ts/merkle` che copra entrambe le varianti di alberi di Merkle: binaria e sparsa. Per ciascuna variante, documentare la costruzione, la generazione delle prove e la verifica. Consultare i file sorgente esistenti nel repository fuels ts, probabilmente sotto packages/merkle o simili, per comprendere l'API corrente e le funzioni esportate. Esaminare eventuali test esistenti per esempi di utilizzo. Scrivere una documentazione Markdown chiara con esempi di codice.
Tech stack
typescript
Dominio
blockchainbackend
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Merkle treesTypeScript
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60