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(book): kona-derive extension docs #554

Open
clabby opened this issue Sep 23, 2024 · 0 comments
Open

feat(book): kona-derive extension docs #554

clabby opened this issue Sep 23, 2024 · 0 comments
Assignees
Labels
K-documentation Kind: documentation K-feature Kind: feature

Comments

@clabby
Copy link
Collaborator

clabby commented Sep 23, 2024

Overview

kona-derive is a very extensible crate, allowing for swapping out stages entirely, defining custom data sources, custom DA layers, etc.

For people looking to build new protocol features, it's important for this sort of functionality to be documented at a high level so that consumers can get an idea of what they're working with, without having to crawl through the rust docs etc. The book should have a section under the Kona SDK for things like:

  • Creating a new DA provider, i.e. the DataAvailabilityProvider trait / kona-plasma.
  • Creating a new stage implementation that can be swapped in.
  • Defining a custom payload attributes builder

These docs should be focused primarily on how to extend the pipeline to create non-canonical OP Stack features. Extending the pipeline for custom data sources is already covered @ https://anton-rs.github.io/kona/sdk/custom-backend.html

Example here being the block executor docs, though these are largely able to point towards revm since we re-use their handler abstractions. The derive docs should showcase the abstractions we provide.

@clabby clabby added K-feature Kind: feature K-documentation Kind: documentation labels Sep 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
K-documentation Kind: documentation K-feature Kind: feature
Projects
None yet
Development

No branches or pull requests

2 participants