FuelLabs/fuels-ts

Documentation for `B512`

Open

#3,241 opened on Oct 2, 2024

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

Repository metrics

Stars
 (43,186 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Review the existing Bits512 documentation, rename to B512, and add examples for forming B512 from two B256. Consult the Rust SDK's B512::from function for alignment.
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
TypeScriptGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80