kona icon indicating copy to clipboard operation
kona copied to clipboard

feat(book): `kona-derive` extension docs

Open clabby opened this issue 1 year ago • 0 comments

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 avatar Sep 23 '24 16:09 clabby