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

feat: extend trace decoder err info #148

Merged
merged 14 commits into from
Apr 18, 2024
Merged

Conversation

vladimir-trifonov
Copy link
Contributor

Extend trace decoder err info

Issue: #121

@github-actions github-actions bot added the crate: trace_decoder Anything related to the trace_decoder crate. label Apr 5, 2024
lastminutedev and others added 3 commits April 5, 2024 16:34
* feat: swap out the internal U512 inside nibbles

* fix: comment fix

* fix: fix clippy pr issues

* fix: fix clippy issue

* fix: fix pr comments

* docs: update changelog

* fix: update impl_to_nibbles

---------

Co-authored-by: Vladimir Trifonov <trifonov.vp@gmail.com>
* MAX fixes for clippy

* fix transmut without annotations

* please the fmt gods
Copy link
Contributor

@BGluth BGluth left a comment

Choose a reason for hiding this comment

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

Nice! You did this pretty much exactly the way I was thinking about doing it, and the builder pattern ended up working nicely here.

trace_decoder/src/decoding.rs Outdated Show resolved Hide resolved
trace_decoder/src/decoding.rs Show resolved Hide resolved
trace_decoder/src/decoding.rs Show resolved Hide resolved
trace_decoder/src/decoding.rs Show resolved Hide resolved
@Nashtare Nashtare linked an issue Apr 9, 2024 that may be closed by this pull request
Comment on lines 62 to 64
pub(crate) fn write_optional<T: std::fmt::Display>(
f: &mut std::fmt::Formatter,
label: &str,
value: Option<T>,
) -> std::fmt::Result {
if let Some(v) = value {
writeln!(f, "{}: {}", label, v)?;
}
Ok(())
pub(crate) fn optional_field<T: std::fmt::Debug>(label: &str, value: Option<T>) -> String {
value.map_or(String::new(), |v| format!("{}: {:?}\n", label, v))
}
Copy link
Contributor

Choose a reason for hiding this comment

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

I actually prefer your original direct call to write! just because it avoids the Vec allocation 😅, but this is totally fine! I know we've already had a back an fourth on this.

Copy link
Collaborator

@Nashtare Nashtare left a comment

Choose a reason for hiding this comment

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

LGTM!

@muursh
Copy link
Contributor

muursh commented Apr 18, 2024

@vladimir-trifonov can you update the change log and we'll merge? Also are there other PRs of yours we missed from the change log?

@vladimir-trifonov
Copy link
Contributor Author

@vladimir-trifonov can you update the change log and we'll merge? Also are there other PRs of yours we missed from the change log?

one more, but I just added it

@muursh muursh merged commit 4a9dfda into develop Apr 18, 2024
6 checks passed
@muursh muursh deleted the extend_trace_decoder_err_info branch April 18, 2024 16:03
BGluth added a commit that referenced this pull request Apr 19, 2024
* Update plonky2 dependencies (#119)

* Update plonky2 dependencies

* Modify changelog

* Charge gas before SLOAD and refactor `insert_accessed_storage_keys` (#117)

* Charge gas before SLOAD and refactor `insert_accessed_storage_keys`

* fmt

* Only store value for cold access

* PR feedback

---------

Co-authored-by: BGluth <gluthb@gmail.com>

* Increased the public interface for `trie_tools` (#123)

- `trie_tools` needs to access a bit of currently private logic.
  Specifically, it needs to be able to process compact bytecode into
  `mpt_tries` directly.
- I think this change is actually reasonable. I can see realistic use
  cases where we don't need to process an entire block trace but instead
  just want to decode some compact bytecode.
- With the current public interface, the caller can only pass in an
  entire block trace to process.

* Mpt trie panic refactor (#118)

* refactor: refactoring mpt_trie to use more Results

* fix: replace anyhow with this-error for mpt_trie

* style: formatting

* fix: fix results

* fix: pr fixes

* fix: fix error message

* fix: format

* fix: fix unusefull return type

* fix: fix formatting

* fix: pr fixes

* fix: pr fixes

* fix: pr fixes

* tests: refactor some tests

---------

Co-authored-by: Vladimir Trifonov <trifonov.vp@gmail.com>

* refactor: remove some reallocations from decoder (#126)

Co-authored-by: Vladimir Trifonov <trifonov.vp@gmail.com>

* Charge cold access cost in *CALL* before accessing state (#124)

* Charge cold access cost in CALL before accessing state

* PR feedback

---------

Co-authored-by: BGluth <gluthb@gmail.com>

* chore: add debug function for better logging in development (#134)

* chore: add debug function for better logging in development

* chore: fix clippy issue

---------

Co-authored-by: Vladimir Trifonov <trifonov.vp@gmail.com>

* Make test_receipt_encoding more meaningful. (#131)

* Make test_receipt_encoding more meaningful.

* Apply comment

* Add a getter for the KERNEL codehash (#136)

* Update CHANGELOG

* Version bump for next release (#137)

* Bumped sub-crate versions for a new release

* Added in missing change log entries

- Other PRs missed updating `CHANGELOG.md`

* feat: swap out the internal U512 inside nibbles (#132)

* feat: swap out the internal U512 inside nibbles

* fix: comment fix

* fix: fix clippy pr issues

* fix: fix clippy issue

* fix: fix pr comments

* docs: update changelog

* fix: update impl_to_nibbles

---------

Co-authored-by: Vladimir Trifonov <trifonov.vp@gmail.com>

* Some clippy fixes (#149)

* MAX fixes for clippy

* fix transmut without annotations

* please the fmt gods

* Remove interpreter-specific preinialization logic from State trait (#139)

* Remove interpreter specific methods from State trait

* Changelog

* Make some more functions constant (#154)

* Make some more functions constant

* Update changelog

* fix(keccak-sponge): properly constrain padding bytes (#158)

* fix(keccak-sponge): properly constrain padding bytes

* fix: block bytes offset

* fix: constrain zero padding bytes

* fix: use collect_vec

* feat: replace is_final_input_len with is_padding_byte

* fix: remove unnecessary iterators

* Update evm_arithmetization/src/keccak_sponge/keccak_sponge_stark.rs

Co-authored-by: Robin Salen <30937548+Nashtare@users.noreply.github.com>

* Update evm_arithmetization/src/keccak_sponge/keccak_sponge_stark.rs

Co-authored-by: Robin Salen <30937548+Nashtare@users.noreply.github.com>

* Update evm_arithmetization/src/keccak_sponge/keccak_sponge_stark.rs

Co-authored-by: Robin Salen <30937548+Nashtare@users.noreply.github.com>

* Update evm_arithmetization/src/keccak_sponge/keccak_sponge_stark.rs

Co-authored-by: Robin Salen <30937548+Nashtare@users.noreply.github.com>

* Update evm_arithmetization/src/keccak_sponge/keccak_sponge_stark.rs

Co-authored-by: Robin Salen <30937548+Nashtare@users.noreply.github.com>

* Update evm_arithmetization/src/keccak_sponge/keccak_sponge_stark.rs

Co-authored-by: Robin Salen <30937548+Nashtare@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Robin Salen <30937548+Nashtare@users.noreply.github.com>

* fix: remove redundant constraint

* docs: define padding byte in comment

---------

Co-authored-by: Robin Salen <30937548+Nashtare@users.noreply.github.com>

* Reduce verbosity in logs (#160)

* Reduce verbosity in logs

* CHANGELOG

* Add entry for 158 in CHANGELOG

* Bump with latest starky (#161)

* Bump with latest plonky2

* CHANGELOG

* feat: decouple trace_decoder and proof_gen (#163)

Co-authored-by: Vladimir Trifonov <trifonov.vp@gmail.com>

* Simplify withdrawals logic (#168)

* Simplify withdrawals logic

* Update CHANGELOG

* Clippy

* feat: extend trace decoder err info (#148)

* feat: extend trace decoder err info

* fix: fix clippy issue

* feat: swap out the internal U512 inside nibbles (#132)

* feat: swap out the internal U512 inside nibbles

* fix: comment fix

* fix: fix clippy pr issues

* fix: fix clippy issue

* fix: fix pr comments

* docs: update changelog

* fix: update impl_to_nibbles

---------

Co-authored-by: Vladimir Trifonov <trifonov.vp@gmail.com>

* Some clippy fixes (#149)

* MAX fixes for clippy

* fix transmut without annotations

* please the fmt gods

* fix: add pr comments fixes

* fix: add pr comments fix

* fix: add pr comment fix

* docs: update changelog

---------

Co-authored-by: Vladimir Trifonov <trifonov.vp@gmail.com>
Co-authored-by: Ben <bmarsh94@gmail.com>

* Moved `Unreleased` changes to `0.3.0` (#173)

- Also added two missing PRs

---------

Co-authored-by: Hamy Ratoanina <hamy.ratoanina@toposware.com>
Co-authored-by: wborgeaud <williamborgeaud@gmail.com>
Co-authored-by: Vladimir Trifonov <vladimir-trifonov@users.noreply.github.com>
Co-authored-by: Vladimir Trifonov <trifonov.vp@gmail.com>
Co-authored-by: Linda Guiga <101227802+LindaGuiga@users.noreply.github.com>
Co-authored-by: Robin Salen <30937548+Nashtare@users.noreply.github.com>
Co-authored-by: Robin Salen <salenrobin@gmail.com>
Co-authored-by: Ben <bmarsh94@gmail.com>
Co-authored-by: Ayush Shukla <shuklaayush247@gmail.com>
BGluth pushed a commit that referenced this pull request Apr 22, 2024
* feat: extend trace decoder err info

* fix: fix clippy issue

* feat: swap out the internal U512 inside nibbles (#132)

* feat: swap out the internal U512 inside nibbles

* fix: comment fix

* fix: fix clippy pr issues

* fix: fix clippy issue

* fix: fix pr comments

* docs: update changelog

* fix: update impl_to_nibbles

---------

Co-authored-by: Vladimir Trifonov <trifonov.vp@gmail.com>

* Some clippy fixes (#149)

* MAX fixes for clippy

* fix transmut without annotations

* please the fmt gods

* fix: add pr comments fixes

* fix: add pr comments fix

* fix: add pr comment fix

* docs: update changelog

---------

Co-authored-by: Vladimir Trifonov <trifonov.vp@gmail.com>
Co-authored-by: Ben <bmarsh94@gmail.com>
LindaGuiga added a commit that referenced this pull request Apr 26, 2024
* Moved `Unreleased` changes to `0.3.0` (#173)

- Also added two missing PRs

* `main` --> `0.3.0` (#138)

* Update plonky2 dependencies (#119)

* Update plonky2 dependencies

* Modify changelog

* Charge gas before SLOAD and refactor `insert_accessed_storage_keys` (#117)

* Charge gas before SLOAD and refactor `insert_accessed_storage_keys`

* fmt

* Only store value for cold access

* PR feedback

---------

Co-authored-by: BGluth <gluthb@gmail.com>

* Increased the public interface for `trie_tools` (#123)

- `trie_tools` needs to access a bit of currently private logic.
  Specifically, it needs to be able to process compact bytecode into
  `mpt_tries` directly.
- I think this change is actually reasonable. I can see realistic use
  cases where we don't need to process an entire block trace but instead
  just want to decode some compact bytecode.
- With the current public interface, the caller can only pass in an
  entire block trace to process.

* Mpt trie panic refactor (#118)

* refactor: refactoring mpt_trie to use more Results

* fix: replace anyhow with this-error for mpt_trie

* style: formatting

* fix: fix results

* fix: pr fixes

* fix: fix error message

* fix: format

* fix: fix unusefull return type

* fix: fix formatting

* fix: pr fixes

* fix: pr fixes

* fix: pr fixes

* tests: refactor some tests

---------

Co-authored-by: Vladimir Trifonov <trifonov.vp@gmail.com>

* refactor: remove some reallocations from decoder (#126)

Co-authored-by: Vladimir Trifonov <trifonov.vp@gmail.com>

* Charge cold access cost in *CALL* before accessing state (#124)

* Charge cold access cost in CALL before accessing state

* PR feedback

---------

Co-authored-by: BGluth <gluthb@gmail.com>

* chore: add debug function for better logging in development (#134)

* chore: add debug function for better logging in development

* chore: fix clippy issue

---------

Co-authored-by: Vladimir Trifonov <trifonov.vp@gmail.com>

* Make test_receipt_encoding more meaningful. (#131)

* Make test_receipt_encoding more meaningful.

* Apply comment

* Add a getter for the KERNEL codehash (#136)

* Update CHANGELOG

* Version bump for next release (#137)

* Bumped sub-crate versions for a new release

* Added in missing change log entries

- Other PRs missed updating `CHANGELOG.md`

* feat: swap out the internal U512 inside nibbles (#132)

* feat: swap out the internal U512 inside nibbles

* fix: comment fix

* fix: fix clippy pr issues

* fix: fix clippy issue

* fix: fix pr comments

* docs: update changelog

* fix: update impl_to_nibbles

---------

Co-authored-by: Vladimir Trifonov <trifonov.vp@gmail.com>

* Some clippy fixes (#149)

* MAX fixes for clippy

* fix transmut without annotations

* please the fmt gods

* Remove interpreter-specific preinialization logic from State trait (#139)

* Remove interpreter specific methods from State trait

* Changelog

* Make some more functions constant (#154)

* Make some more functions constant

* Update changelog

* fix(keccak-sponge): properly constrain padding bytes (#158)

* fix(keccak-sponge): properly constrain padding bytes

* fix: block bytes offset

* fix: constrain zero padding bytes

* fix: use collect_vec

* feat: replace is_final_input_len with is_padding_byte

* fix: remove unnecessary iterators

* Update evm_arithmetization/src/keccak_sponge/keccak_sponge_stark.rs

Co-authored-by: Robin Salen <30937548+Nashtare@users.noreply.github.com>

* Update evm_arithmetization/src/keccak_sponge/keccak_sponge_stark.rs

Co-authored-by: Robin Salen <30937548+Nashtare@users.noreply.github.com>

* Update evm_arithmetization/src/keccak_sponge/keccak_sponge_stark.rs

Co-authored-by: Robin Salen <30937548+Nashtare@users.noreply.github.com>

* Update evm_arithmetization/src/keccak_sponge/keccak_sponge_stark.rs

Co-authored-by: Robin Salen <30937548+Nashtare@users.noreply.github.com>

* Update evm_arithmetization/src/keccak_sponge/keccak_sponge_stark.rs

Co-authored-by: Robin Salen <30937548+Nashtare@users.noreply.github.com>

* Update evm_arithmetization/src/keccak_sponge/keccak_sponge_stark.rs

Co-authored-by: Robin Salen <30937548+Nashtare@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Robin Salen <30937548+Nashtare@users.noreply.github.com>

* fix: remove redundant constraint

* docs: define padding byte in comment

---------

Co-authored-by: Robin Salen <30937548+Nashtare@users.noreply.github.com>

* Reduce verbosity in logs (#160)

* Reduce verbosity in logs

* CHANGELOG

* Add entry for 158 in CHANGELOG

* Bump with latest starky (#161)

* Bump with latest plonky2

* CHANGELOG

* feat: decouple trace_decoder and proof_gen (#163)

Co-authored-by: Vladimir Trifonov <trifonov.vp@gmail.com>

* Simplify withdrawals logic (#168)

* Simplify withdrawals logic

* Update CHANGELOG

* Clippy

* feat: extend trace decoder err info (#148)

* feat: extend trace decoder err info

* fix: fix clippy issue

* feat: swap out the internal U512 inside nibbles (#132)

* feat: swap out the internal U512 inside nibbles

* fix: comment fix

* fix: fix clippy pr issues

* fix: fix clippy issue

* fix: fix pr comments

* docs: update changelog

* fix: update impl_to_nibbles

---------

Co-authored-by: Vladimir Trifonov <trifonov.vp@gmail.com>

* Some clippy fixes (#149)

* MAX fixes for clippy

* fix transmut without annotations

* please the fmt gods

* fix: add pr comments fixes

* fix: add pr comments fix

* fix: add pr comment fix

* docs: update changelog

---------

Co-authored-by: Vladimir Trifonov <trifonov.vp@gmail.com>
Co-authored-by: Ben <bmarsh94@gmail.com>

* Moved `Unreleased` changes to `0.3.0` (#173)

- Also added two missing PRs

---------

Co-authored-by: Hamy Ratoanina <hamy.ratoanina@toposware.com>
Co-authored-by: wborgeaud <williamborgeaud@gmail.com>
Co-authored-by: Vladimir Trifonov <vladimir-trifonov@users.noreply.github.com>
Co-authored-by: Vladimir Trifonov <trifonov.vp@gmail.com>
Co-authored-by: Linda Guiga <101227802+LindaGuiga@users.noreply.github.com>
Co-authored-by: Robin Salen <30937548+Nashtare@users.noreply.github.com>
Co-authored-by: Robin Salen <salenrobin@gmail.com>
Co-authored-by: Ben <bmarsh94@gmail.com>
Co-authored-by: Ayush Shukla <shuklaayush247@gmail.com>

* Fix withdrawals accesses in state trie (#176)

* Bumped `trace_decoder` version for new `zk_evm` release (#177)

* Bumped `trace_decoder` version for new `zk_evm` release

* Updated `CHANGELOG.md`

* Revert "`main` --> `0.3.0` (#138)" (#179)

This reverts commit 88d75ed.

* Some cleanup (#190)

* Cleanup perform_op

* Move interpreter test methods to test module

* Some more cleanup and removal

* more cleanup

* More cleanup misc and doc

* Remove outdated arg

* Fix clippy

---------

Co-authored-by: BGluth <gluthb@gmail.com>
Co-authored-by: Hamy Ratoanina <hamy.ratoanina@toposware.com>
Co-authored-by: wborgeaud <williamborgeaud@gmail.com>
Co-authored-by: Vladimir Trifonov <vladimir-trifonov@users.noreply.github.com>
Co-authored-by: Vladimir Trifonov <trifonov.vp@gmail.com>
Co-authored-by: Robin Salen <30937548+Nashtare@users.noreply.github.com>
Co-authored-by: Robin Salen <salenrobin@gmail.com>
Co-authored-by: Ben <bmarsh94@gmail.com>
Co-authored-by: Ayush Shukla <shuklaayush247@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
crate: trace_decoder Anything related to the trace_decoder crate.
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Add additional metadata to decoder errors
5 participants