FuelLabs/fuels-ts

Document merkle tree usage

Open

#3,374 opened on Nov 5, 2024

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

Repository metrics

Stars
 (43,186 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Read the source code of the binary and sparse merkle tree variants in @fuel ts/merkle, then document constructors, proof generation, and verification with examples.
Tech stack
typescript
Domain
blockchainbackend
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.
Half day
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
Merkle treesTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60