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

Add documentation around client compatibility issues #5

Open
randomishwalk opened this issue May 26, 2023 · 2 comments
Open

Add documentation around client compatibility issues #5

randomishwalk opened this issue May 26, 2023 · 2 comments

Comments

@randomishwalk
Copy link

Idea

Add a simple table laying out known / potential EL client compatibility issues. Something like the following:

Bundler implementation Execution Client Links to open GitHub issues / PRs
Infinitism Nethermind eth-infinitism/bundler#112
[Example 2] [Example 2] [Example 2]

Purpose

For those looking to test out bundler deployments, would be helpful to know if there are known or highly likely compatibility issues between various bundler implementations and existing EL clients.

Landing page placement

Perhaps it might make the most sense here under "Bundlers"?
image

Areas for improvement

I suspect there's probably an effective way to have this table be automatically updated based on open issues or PRs (maybe we can add a label that's something like EL client compatibility) in the repos of the various bundlers that are out there.

The other way to improve this table might be to have it displayed as a 2x2 table where one axis could be bundlers and the other could be EL clients

@tomteman
Copy link
Collaborator

I think this info should appear on the dedicated bundler page (https://www.erc4337.io/bundlers), where we show the test results.

For an automatic display of known EL issues (much preferable to manually maintaining it), I would add a relevant label to those issues (like you suggested), and run a query from the client to fetch all the relevant issues for each bundler repo (https://docs.github.com/en/rest/issues/issues?apiVersion=2022-11-28#list-repository-issues). The challenge here is that such a query requires a GitHub session token, which means we'll need to require users to log in with their GitHub account (which isn't that bad, since only devs will care about that info). I want to avoid running a backend if we can (and also a db, since we'll need to cache results instead of querying with our own credentials every time someone hits "refresh" on the page, which can get us throttled).

We could also show another reference table like you suggested, with bundlers as columns and ELs as rows, and show the compatibility (number of known bundler issues for each intersection).

Perhaps we should also consider that issues can be created the other way around - for the EL projects themselves

@randomishwalk
Copy link
Author

randomishwalk commented Jun 5, 2023

I think this info should appear on the dedicated bundler page (https://www.erc4337.io/bundlers), where we show the test results.

That's a much better idea, thanks! Hadn't noticed that page but agree that's a more natural place to put this information.

Perhaps we should also consider that issues can be created the other way around - for the EL projects themselves

This is an interesting idea. And would also I guess be subject to the maintenance issue, which for this purpose would be non-negligible.

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

No branches or pull requests

2 participants