FuelLabs/fuels-ts

Documentation for `B512`

Open

Aperta il 2 ott 2024

Vedi su GitHub
 (7 commenti) (0 reazioni) (0 assegnatari)TypeScript (43.186 star) (1370 fork)batch import
docsgood first issue

Descrizione

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)

Guida contributor

Tech stack
typescript
Dominio
documentation
Tipo issue
documentation
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
half day
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
active
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
TypeScriptGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80
Direzione di ricerca
Innanzitutto, rivedi la documentazione attuale per Bits512 all'indirizzo https://docs.fuel.network/docs/fuels ts/types/bits512/. Esamina l'esempio dell'SDK Rust su https://github.com/FuelLabs/fuels rs/blob/84266d27a9640b1f6c7b2d2c81186ff6b024b8ff/e2e/sway/types/contracts/b512/src/main.sw per capire come B512 è costruito da due B256. Quindi aggiorna la documentazione dell'SDK TS per rinominare Bits512 in B512, aggiungi un nuovo esempio che mostri la costruzione da due B256 e migliora gli esempi esistenti. Coordinati con i maintainer nei commenti dell'issue per confermare le modifiche desiderate.