Skip to content
This repository has been archived by the owner on Jul 5, 2024. It is now read-only.

Remove assembly in geth-utils #1553

Merged
merged 5 commits into from
Aug 7, 2023
Merged

Remove assembly in geth-utils #1553

merged 5 commits into from
Aug 7, 2023

Conversation

ChihChengLiang
Copy link
Collaborator

Description

Remove geth-utils and examples.

Type of change

New feature (non-breaking change which adds functionality)

Rationale

  • Assembly was introduced in EVM trace generation from rust #91 to build examples to use geth-util. It was not used elsewhere in the codebase.
  • The examples are removed as we currently don't use geth-util like the way the examples show. (Note that the examples also fail to run now. The transactions in the examples would fail because the trace config defaults to a 0 block gas limit. It runs after adding a block gas limit.)
  • I found those examples unused when reviewing how we use the tracing API. It is much easier to review the tracing code after removing the Assembly.
  • The Readme mentioned a TODO CLI, which we never built. I think it might be interesting to create a good first issue for people to extend testool(
    - `../target/release/testool --oneliner "call 12;60016002"`: call contract `0x...12` that contains the code PUSH1(1) PUSH1(2)
    ) for it.

@github-actions github-actions bot added the crate-geth-utils Issues related to the geth-utils workspace member label Aug 4, 2023
@ChihChengLiang ChihChengLiang marked this pull request as ready for review August 4, 2023 22:22
Copy link
Collaborator

@Brechtpd Brechtpd left a comment

Choose a reason for hiding this comment

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

Looks good! If I remember correctly, I copied these files into this project because they were part of Han's code for generating these traces that I basically just copied. I guess even at the time it was pretty unlikely this would ever get used here so I probably should not have included them in the first place, so good that these are finally removed! Thanks for cleaning things up.

@ChihChengLiang
Copy link
Collaborator Author

@Brechtpd My pleasure! Thank you for elaborating on the background of the decision.

@hero78119 hero78119 self-requested a review August 7, 2023 08:21
Copy link
Member

@hero78119 hero78119 left a comment

Choose a reason for hiding this comment

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

LGTM!

@ChihChengLiang ChihChengLiang added this pull request to the merge queue Aug 7, 2023
Merged via the queue into main with commit 3b81787 Aug 7, 2023
11 checks passed
@ChihChengLiang ChihChengLiang deleted the rm-asm branch August 7, 2023 10:23
lispc pushed a commit to scroll-tech/zkevm-circuits that referenced this pull request Sep 2, 2023
Remove geth-utils and examples.

New feature (non-breaking change which adds functionality)

- Assembly was introduced in #91 to build examples to use geth-util. It
was not used elsewhere in the codebase.
- The examples are removed as we currently don't use geth-util like the
way the examples show. (Note that the examples also fail to run now. The
transactions in the examples would fail because the trace config
defaults to a 0 block gas limit. It runs after adding a block gas
limit.)
- I found those examples unused when reviewing how we use the tracing
API. It is much easier to review the tracing code after removing the
Assembly.
- The Readme mentioned a TODO CLI, which we never built. I think it
might be interesting to create a good first issue for people to extend
testool(https://github.com/privacy-scaling-explorations/zkevm-circuits/blob/690b2f143a94b7474f0c99493a99b0f2c53d93b8/testool/README.md#L38)
for it.
lispc added a commit to scroll-tech/zkevm-circuits that referenced this pull request Sep 2, 2023
* Remove assembly in geth-utils (privacy-scaling-explorations#1553)

Remove geth-utils and examples.

New feature (non-breaking change which adds functionality)

- Assembly was introduced in #91 to build examples to use geth-util. It
was not used elsewhere in the codebase.
- The examples are removed as we currently don't use geth-util like the
way the examples show. (Note that the examples also fail to run now. The
transactions in the examples would fail because the trace config
defaults to a 0 block gas limit. It runs after adding a block gas
limit.)
- I found those examples unused when reviewing how we use the tracing
API. It is much easier to review the tracing code after removing the
Assembly.
- The Readme mentioned a TODO CLI, which we never built. I think it
might be interesting to create a good first issue for people to extend
testool(https://github.com/privacy-scaling-explorations/zkevm-circuits/blob/690b2f143a94b7474f0c99493a99b0f2c53d93b8/testool/README.md#L38)
for it.

* rewrite geth_utils with go.work

* fix make doc

---------

Co-authored-by: Chih Cheng Liang <chihchengliang@gmail.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
crate-geth-utils Issues related to the geth-utils workspace member
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants