FuelLabs/fuels-rs

refactor how we expose the base asset to the user

Open

#1,349 opened on Apr 30, 2024

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Rust (43,211 stars) (1,360 forks)batch import
good first issue

Description

It would seem we have stale examples still using 0x00... as the base asset.

Also it seems that AssetId still has BASE as a constant with the value of 0x000.... If it's not going to be removed, we should hide this from the user by wrapping the type.

Contributor guide

Tech stack
rust
Domain
developer experiencebackend
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
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.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic Rust knowledgeFamiliarity with Fuel SDK types
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Examine the linked fuel types repository to understand the current AssetId::BASE constant and how it's used in the fuels rs SDK. Look at the stale examples in the documentation (e.g., accounts.html) using the zero address. Determine if the constant can be deprecated or hidden, and propose a wrapper type or alternative API to expose the base asset without exposing the zero address. Consider updating the documentation examples accordingly.