Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove unnecessary return values from Storage{Read, Write} methods #907

Merged
merged 3 commits into from
Feb 9, 2025

Conversation

Dentosal
Copy link
Member

@Dentosal Dentosal commented Feb 6, 2025

When reviewing this fix FuelLabs/fuel-core#2673, it became apparent that the return values from StorageRead and StorageWrite traits are not useful and quite misleading. We require the target buffer to be filled completely, which means the caller already knows the number of bytes written after successful invocation.

The PR removes the return values indicating number of bytes written. It's a breaking change, but the fix on caller side is simple and likely affects fuel-core and execution-tracing only.

Checklist

  • Breaking changes are clearly marked as such in the PR description and changelog
  • New behavior is reflected in tests
  • If performance characteristic of an instruction change, update gas costs as well or make a follow-up PR for that
  • The specification matches the implemented behavior (link update PR if changes are needed)

Before requesting review

  • I have reviewed the code myself
  • I have created follow-up issues caused by this PR and linked them here

@Dentosal Dentosal added breaking A breaking api change tech-debt fuel-storage Related to the `fuel-storage` crate. labels Feb 6, 2025
@Dentosal Dentosal self-assigned this Feb 6, 2025
@Dentosal Dentosal marked this pull request as ready for review February 6, 2025 06:48
@Dentosal Dentosal requested a review from a team February 6, 2025 06:48
@Dentosal Dentosal requested a review from a team February 7, 2025 20:06
@Dentosal Dentosal added this pull request to the merge queue Feb 9, 2025
Merged via the queue into master with commit 4c0abec Feb 9, 2025
40 checks passed
@Dentosal Dentosal deleted the dento/StorageRead-trait-correction branch February 9, 2025 23:28
@Dentosal Dentosal mentioned this pull request Feb 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking A breaking api change fuel-storage Related to the `fuel-storage` crate. tech-debt
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants