FuelLabs/fuels-ts

Document merkle tree usage

Open

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

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
 (30d に merged 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
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
半日
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
新着
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
Merkle treesTypeScript
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
60