FuelLabs/fuels-ts

Document merkle tree usage

Open

#3374 opened on Nov 5, 2024

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (43,186 stars) (1,370 forks)batch import
docsgood first issue

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

Contributor guide

Tech stack
typescript
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic TypeScriptunderstanding of merkle trees
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
The issue requires adding documentation for the `@fuel ts/merkle` package covering both binary and sparse merkle tree variants. For each variant, document construction, proof generation, and verification. Consult the existing source files in the fuels ts repository, likely under packages/merkle or similar, to understand the current API and export functions. Review any existing tests for examples of usage. Write clear Markdown documentation with code examples.