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

Wiki - PBS research content #162

Merged
merged 81 commits into from
Apr 10, 2024
Merged

Wiki - PBS research content #162

merged 81 commits into from
Apr 10, 2024

Conversation

taxmeifyoucan
Copy link
Contributor

@taxmeifyoucan taxmeifyoucan commented Apr 9, 2024

PBS wiki

Adding multiple pages on PBS and related MEV topics.

  • Locally run aspell on the .md files and fix any spelling errors before pushing the commit.
  • Review the overall structure
  • Link relevant content in new and existing files
  • If you need feedback for your content from wider community, share the PR in our Discord
  • Review changes to ensure there are no typos, see instructions bellow

shyam-patel-kira and others added 30 commits March 15, 2024 00:43
* Add page on PBS

* Update PBS entry

* Update PBS entry

* Fixed typos

* Incorporate feedback into PBS entry

* Fix typos

* Nits and fixes

---------

Co-authored-by: Mário Havel <[email protected]>
Copy link
Member

@shyam-patel-kira shyam-patel-kira left a comment

Choose a reason for hiding this comment

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

Alot of relevant details are not readable, due to sheer length of the ePBS entry. Also the relevant parts' readability is undermined due some other parts like desirable properties, for and against arguments and other alike parts.

docs/wiki/research/PBS/ePBS.md Show resolved Hide resolved
docs/wiki/research/PBS/ePBS.md Show resolved Hide resolved
@thogiti
Copy link
Contributor

thogiti commented Apr 10, 2024

Alot of relevant details are not readable, due to sheer length of the ePBS entry. Also the relevant parts' readability is undermined due some other parts like desirable properties, for and against arguments and other alike parts.

Can you please identify which specific parts are not readable for you?

I wrote ePBS to be a self-contained page where you can learn all the nuances about enshrining PBS.

If you follow the feedback from outside Ethereum (e.g. Flashbots group, Hasu, Jon Charbonneau, relayers, etc.), you will see two main categories of discussion and opposition to the current implementations:

  1. What is the problem a specific ePBS implementation is trying to solve?
  2. How to address "bypassability"?

So, understanding from the first principles which specific properties a minimum viable ePBS implementation should have helps addressing two above problems.

I added these references and the Ethereum Foundation's ePBS rollcalls/breakout meetings in my document fully grasp the nuances of enshrining PBS mechanism.

@shyam-patel-kira
Copy link
Member

shyam-patel-kira commented Apr 10, 2024

Alot of relevant details are not readable, due to sheer length of the ePBS entry. Also the relevant parts' readability is undermined due some other parts like desirable properties, for and against arguments and other alike parts.

Can you please identify which specific parts are not readable for you?

I wrote ePBS to be a self-contained page where you can learn all the nuances about enshrining PBS.

The content is definitely well researched, and I think this PR should be merged since it has been open for too long anyway, but some points to consider, maybe us or someone else can curate it in future PR:

  • Streamline some of content, condense the background and overview of ePBS for brevity and maintain the focus on core concepts, since we already provide plenty of background in PBS and MEV entries
  • Simplify the language to reduce the complexity of the technical description. I suppose the idea of the wiki entry is to aid understanding for other developers so it should cover it
  • condense arguments that describes pros and cons of ePBS, I think key-arguments can summarized succinctly
  • Highlighting critical information, and focus on clarity in order to ensure that the entry conveys the significance of ePBS in improving some aspects of Ethereum, without overwhelming readers with excessive detail.

What do you think @thogiti? but I agree that this can be potentially done in future PR, this serves as a good foundation for this wiki page

@thogiti thogiti marked this pull request as ready for review April 10, 2024 02:27
Copy link
Contributor

@thogiti thogiti 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. The PBS wiki pages are ready to be shipped to the main branch.

Additional changes and glossary will be added in future PR.

@thogiti
Copy link
Contributor

thogiti commented Apr 10, 2024

@taxmeifyoucan This PBS section is ready to be merged into main branch.

Thank you for your contributions @shyam-patel-kira @arynyestos @raxhvl @taxmeifyoucan @thogiti.

@shyam-patel-kira shyam-patel-kira linked an issue Apr 10, 2024 that may be closed by this pull request
@shyam-patel-kira
Copy link
Member

This should close #93

@thogiti
Copy link
Contributor

thogiti commented Apr 10, 2024

This should close #93

Once this PR is merged, you can close the issue at #93.

This comment was marked as resolved.

@thogiti
Copy link
Contributor

thogiti commented Apr 10, 2024

  1. commmunication

I will push another commit to address these typos. Give me five minutes.

@taxmeifyoucan
Copy link
Contributor Author

Once again, huge thanks to all of you for working on all of this! Great job guys, it's an amazing piece of content.

I read it again and added some resources, rephrased few things. I agree with points by @shyam-patel-kira above, the content could be more lean and improve readability of long section. Also, there still are more resources that could be linked, I was surprised that the builder spec was not mentioned. Maybe after Barnabes talk today you will find some more improvements. For now let's merge it and have another PR in the future, thanks a lot

@taxmeifyoucan taxmeifyoucan merged commit d5c6495 into main Apr 10, 2024
2 checks passed
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.

PBS wiki page
5 participants