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: eth: remove support for ETH tracing APIs #11596

Closed
wants to merge 2 commits into from

Conversation

Stebalien
Copy link
Member

@Stebalien Stebalien commented Jan 24, 2024

Related Issues

#11356

Proposed Changes

Unfortunately, these APIs turned out to be very difficult to correctly support given all the differences between Filecoin and Ethereum. The fact of the matter is that Filecoin is not Ethereum. We strive for Ethereum compatibility from the perspective of builders, but that doesn't mean that the Filecoin chain can be accurately indexed as if it were an Ethereum chain.

Issues with the Eth-JSON RPC API include:

  1. Mapping contract creation semantics from Filecoin to Ethereum requires mapping multiple calls into a single "CREATE" operation.
  2. Address translation from Filecoin Actor IDs to Ethereum addresses is error prone, especially in the face of reverts.
  3. Representing native calls in an EVM friendly way is non-trivial.

That's not to say that all this is impossible to fix. However:

  1. This code would require significant testing before we'd feel comfortable recommending that it be used for indexing.
  2. Any indexers built on this code would likely be sub-par.
  3. There's no guarantee that we won't make future changes that are fundamentally incompatible with Ethereum-style tracing.

Additional Info

This is a request for comments, not a final proposal. But "do nothing" isn't really an option. We either need to remove it and or fix it.

For some context, I also have a 90% done patch to "fix" most of the issues in the trace API (required some changes in the FVM itself to expose more information in traces). Unfortunately, that's 90% feature-complete not 90% tested. There are no tests right now and writing enough tests to be sure of this API would take quite a bit of work. And even then, I this isn't something I want to maintain.

Checklist

Before you mark the PR ready for review, please make sure that:

  • Commits have a clear commit message.
  • PR title is in the form of of <PR type>: <area>: <change being made>
    • example: fix: mempool: Introduce a cache for valid signatures
    • PR type: fix, feat, build, chore, ci, docs, perf, refactor, revert, style, test
    • area, e.g. api, chain, state, market, mempool, multisig, networking, paych, proving, sealing, wallet, deps
  • If the PR affects users (e.g., new feature, bug fix, system requirements change), update the CHANGELOG.md and add details to the UNRELEASED section.
  • New features have usage guidelines and / or documentation updates in
  • Tests exist for new functionality or change in behavior
  • CI is green

Unfortunately, these APIs turned out to be very difficult to correctly
support given all the differences between Filecoin and Ethereum. The
fact of the matter is that Filecoin is not Ethereum. We strive for
Ethereum compatibility from the perspective of _builders_, but that
doesn't mean that the Filecoin chain can be accurately indexed as if it
were an Ethereum chain.

Issues with the Eth-JSON RPC API include:

1. Mapping contract creation semantics from Filecoin to Ethereum
   requires mapping multiple calls into a single "CREATE" operation.
2. Address translation from Filecoin Actor IDs to Ethereum addresses is
   error prone, especially in the face of reverts.
3. Representing native calls in an EVM friendly way is non-trivial.

That's not to say that all this is impossible to fix. However:

1. This code would require significant testing before we'd feel
   comfortable recommending that it be used for indexing.
2. Any indexers built on this code would likely be sub-par.
3. There's no guarantee that we won't make future changes that are
   fundamentally incompatible with Ethereum-style tracing.
Unfortunately, these APIs turned out to be very difficult to correctly
support given all the differences between Filecoin and Ethereum. The
fact of the matter is that Filecoin is not Ethereum. We strive for
Ethereum compatibility from the perspective of _builders_, but that
doesn't mean that the Filecoin chain can be accurately indexed as if it
were an Ethereum chain.

Issues with the Eth-JSON RPC API include:

1. Mapping contract creation semantics from Filecoin to Ethereum
   requires mapping multiple calls into a single "CREATE" operation.
2. Address translation from Filecoin Actor IDs to Ethereum addresses is
   error prone, especially in the face of reverts.
3. Representing native calls in an EVM friendly way is non-trivial.

That's not to say that all this is impossible to fix. However:

1. This code would require significant testing before we'd feel
   comfortable recommending that it be used for indexing.
2. Any indexers built on this code would likely be sub-par.
3. There's no guarantee that we won't make future changes that are
   fundamentally incompatible with Ethereum-style tracing.
@Stebalien Stebalien changed the title [WIP] feat: eth: remove support for ETH tracing APIs feat: eth: remove support for ETH tracing APIs Jan 29, 2024
@Stebalien Stebalien marked this pull request as ready for review January 29, 2024 15:24
@Stebalien Stebalien requested a review from a team as a code owner January 29, 2024 15:24
@Stebalien
Copy link
Member Author

Ok, we've decided that we need this.

@Stebalien Stebalien closed this Jan 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant