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

forc-debug: Add ABI support for decoding log values #6856

Merged
merged 25 commits into from
Feb 4, 2025
Merged

Conversation

JoshuaBatty
Copy link
Member

@JoshuaBatty JoshuaBatty commented Jan 23, 2025

Description

Adds support for ABI files in forc-debug to decode log values while debugging using the CLI. Users can now:

for example:

tx tx.json abi.json 

When the Sway ABI Registry is available, the debugger will automatically fetch ABIs for deployed contracts. Have an issue open to implement this here #6862

Updates documentation to show decoded log output, adds tab completion for ABI files, and refreshes bytecode examples to match current output.

The test_cli test has been updated to take an ABI and check that the correct decoded value is returned.

Checklist

  • I have linked to any relevant issues.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have updated the documentation where relevant (API docs, the reference, and the Sway book).
  • I have added tests that prove my fix is effective or that my feature works.
  • I have added (or requested a maintainer to add) the necessary Breaking* or New Feature labels where relevant.
  • I have done my best to ensure that my PR adheres to the Fuel Labs Code Review Standards.
  • I have requested a review from the relevant team or maintainers.

@JoshuaBatty JoshuaBatty requested review from a team as code owners January 23, 2025 02:51
@JoshuaBatty JoshuaBatty marked this pull request as draft January 23, 2025 02:51
@JoshuaBatty JoshuaBatty self-assigned this Jan 23, 2025
@JoshuaBatty JoshuaBatty added forc-debug Everything related to forc-debug documentation labels Jan 23, 2025
@JoshuaBatty JoshuaBatty marked this pull request as ready for review January 28, 2025 00:46
Copy link
Contributor

@calldelegation calldelegation left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@JoshuaBatty JoshuaBatty requested a review from IGI-111 February 4, 2025 00:29
@IGI-111 IGI-111 merged commit 0a56930 into master Feb 4, 2025
43 checks passed
@IGI-111 IGI-111 deleted the josh/decode branch February 4, 2025 05:16
tritao pushed a commit to tritao/sway that referenced this pull request Feb 7, 2025
## Description
Adds support for ABI files in `forc-debug` to decode log values while
debugging using the CLI. Users can now:

for example:

```
tx tx.json abi.json 
```

When the Sway ABI Registry is available, the debugger will automatically
fetch ABIs for deployed contracts. Have an issue open to implement this
here FuelLabs#6862

Updates documentation to show decoded log output, adds tab completion
for ABI files, and refreshes bytecode examples to match current output.

The `test_cli` test has been updated to take an ABI and check that the
correct decoded value is returned.

## Checklist

- [x] I have linked to any relevant issues.
- [x] I have commented my code, particularly in hard-to-understand
areas.
- [x] I have updated the documentation where relevant (API docs, the
reference, and the Sway book).
- [x] If my change requires substantial documentation changes, I have
[requested support from the DevRel
team](https://github.com/FuelLabs/devrel-requests/issues/new/choose)
- [x] I have added tests that prove my fix is effective or that my
feature works.
- [x] I have added (or requested a maintainer to add) the necessary
`Breaking*` or `New Feature` labels where relevant.
- [x] I have done my best to ensure that my PR adheres to [the Fuel Labs
Code Review
Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md).
- [x] I have requested a review from the relevant team or maintainers.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation forc-debug Everything related to forc-debug
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants