FuelLabs/fuels-ts

Document merkle tree usage

Open

#3,374 创建于 2024年11月5日

在 GitHub 查看
 (0 评论) (0 反应) (0 负责人)TypeScript (43,186 star) (1,370 fork)batch import
docsgood first issue

描述

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

贡献者指南

技术栈
typescript
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
basic TypeScriptunderstanding of merkle trees
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
85
研究方向
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.