FuelLabs/fuels-ts

Documentation for `B512`

Open

#3 241 ouverte le 2 oct. 2024

Voir sur GitHub
 (7 commentaires) (0 réactions) (0 assignés)TypeScript (1 370 forks)batch import
docsgood first issue

Métriques du dépôt

Stars
 (43 186 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

Summary

Reference

  • We could rename these to B512 from Bits512 to better align with the wider ecosystem.
  • We're missing documentation on how to form a B512, from two B256.
  • I think the example of just using the wallet public key could be changed to show how to form this with two b256.
  • We could also improve the Sway example with a more complex use-case, rather than just echoing out the response.
  • The Rust SDK are using the B512::from function (here) and I was unclear how to imitate this with the TS SDK. (this could be a feature request)

Guide contributeur

Direction de recherche
Tout d'abord, consultez la documentation actuelle de Bits512 à l'adresse https://docs.fuel.network/docs/fuels ts/types/bits512/. Examinez l'exemple du SDK Rust à l'adresse https://github.com/FuelLabs/fuels rs/blob/84266d27a9640b1f6c7b2d2c81186ff6b024b8ff/e2e/sway/types/contracts/b512/src/main.sw pour comprendre comment B512 est construit à partir de deux B256. Ensuite, mettez à jour la documentation du SDK TS pour renommer Bits512 en B512, ajoutez un nouvel exemple montrant la construction à partir de deux B256 et améliorez les exemples existants. Coordonnez vous avec les mainteneurs dans les commentaires de l'issue pour confirmer les modifications souhaitées.
Stack technique
typescript
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
TypeScriptGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80