FuelLabs/fuels-ts

Document merkle tree usage

Open

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

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

仓库指标

Star
 (43,186 star)
PR 合并指标
 (30 天内没有已合并 PR)

描述

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

贡献者指南

研究方向
此问题要求为 `@fuel ts/merkle` 包添加文档，涵盖二进制和稀疏默克尔树两种变体。针对每种变体，记录其构建、证明生成和验证过程。查阅 fuels ts 仓库中的现有源文件（可能在 packages/merkle 或类似目录下），以了解当前的 API 和导出函数。查看任何现有测试以获取使用示例。编写清晰的 Markdown 文档并附上代码示例。
技术栈
typescript
领域
blockchainbackend
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
半天
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
新近可参与
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
Merkle treesTypeScript
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
60