FuelLabs/fuels-ts

Document merkle tree usage

Open

#3,374 opened on 2024年11月5日

GitHub で見る
 (0 comments) (0 reactions) (0 assignees)TypeScript (43,186 stars) (1,370 forks)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
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.