FuelLabs/fuels-ts

Documentation for `B256`

Open

#3,240 opened on Oct 2, 2024

View on GitHub
 (5 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 docs

  • We could rename these to B256 from Bits256to better align with the wider ecosystem.
  • Currently we display how use getRandomB256 however I believe we should use actual addresses for a better showcase of their use cases.
  • We're missing how to use these addresses with an actual contract.
  • We're also missing how these can be used in Sway programs.

Contributor guide

Research direction
Update the reference docs to rename Bits256 to B256, replace random examples with actual addresses, and add usage examples with contracts and Sway programs.
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.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
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
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85