FuelLabs/fuels-ts

Documentation for `B512`

Open

#3241 opened on Oct 2, 2024

View on GitHub
 (7 comments) (0 reactions) (0 assignees)TypeScript (43,186 stars) (1,370 forks)batch import
docsgood first issue

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)

Contributor guide

Tech stack
typescript
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic TypeScriptFamiliarity with Fuel SDK types
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
First, review the current documentation for Bits512 at https://docs.fuel.network/docs/fuels ts/types/bits512/. Examine the Rust SDK example at https://github.com/FuelLabs/fuels rs/blob/84266d27a9640b1f6c7b2d2c81186ff6b024b8ff/e2e/sway/types/contracts/b512/src/main.sw to understand how B512 is constructed from two B256. Then update the TS SDK documentation to rename Bits512 to B512, add a new example showing construction from two B256, and improve existing examples. Coordinate with maintainers in the issue comments to confirm the desired changes.