FuelLabs/fuels-ts

Document merkle tree usage

Open

#3.374 aberto em 5 de nov. de 2024

Ver no GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (1.370 forks)batch import
docsgood first issue

Métricas do repositório

Stars
 (43.186 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 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

Guia do colaborador

Direção de pesquisa
A issue requer a adição de documentação para o pacote `@fuel ts/merkle` cobrindo ambas as variantes de árvores de Merkle: binária e esparsa. Para cada variante, documentar a construção, geração de provas e verificação. Consulte os arquivos de origem existentes no repositório fuels ts, provavelmente em packages/merkle ou similar, para entender a API atual e as funções exportadas. Revise quaisquer testes existentes para exemplos de uso. Escreva uma documentação Markdown clara com exemplos de código.
Pilha de tecnologia
typescript
Domain
blockchainbackend
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Merkle treesTypeScript
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60