FuelLabs/fuels-ts

Document merkle tree usage

Ouverte

#3 374 ouverte le 5 nov. 2024

Voir sur GitHubGuide contributeur
 (0 commentaire) (0 réaction) (0 personne assignée)TypeScript (1 370 forks)batch import
docsgood first issue

Métriques du dépôt

Stars
 (43 186 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

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

Guide contributeur

Direction de recherche
Le problème nécessite l'ajout d'une documentation pour le package `@fuel ts/merkle` couvrant les deux variantes d'arbres de Merkle : binaire et éparse. Pour chaque variante, documentez la construction, la génération de preuves et la vérification. Consultez les fichiers sources existants dans le dépôt fuels ts, probablement sous packages/merkle ou similaire, pour comprendre l'API actuelle et les fonctions exportées. Examinez les tests existants pour des exemples d'utilisation. Rédigez une documentation Markdown claire avec des exemples de code.
Stack technique
typescript
Domaine
blockchainbackend
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Merkle treesTypeScript
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60