-
Notifications
You must be signed in to change notification settings - Fork 89
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
interop: Add initial indexing api spec #283
base: main
Are you sure you want to change the base?
Conversation
a7bf94d
to
1136590
Compare
specs/interop/indexing_api.md
Outdated
@@ -0,0 +1,92 @@ | |||
# Indexing API |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thoughts on calling this the "Superchain API"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm slightly against that because I think this is an entirely optional thing that could be used as part of implementing interop. Calling it Superchain API makes it sound like a critical component. While our implementation will depend on it, it's certainly possible to implement interop without it or with a different API if you make different architectural decisions.
dc30274
to
4da15b1
Compare
1917a52
to
d65d9eb
Compare
@protolambda I think we moved away from this approach again and should just close this right? |
@ajsutton I am not entirely sure yet. We'll likely run into something like this as part of devnet 2 reorg support planning, although maybe we can simplify it. I'm fine with keeping this open for now. |
We likely should revisit this PR to make sure that the supervisor API is specified |
Description
Adds a spec for the first method in the "indexing backend" RPC API. This is designed to specify a standard API for tools that indexing logs across chains to optimise lookups for sequencing and verifying nodes. Written in a way that tries to be independent of any particular design for the indexer.
Still todo:
GetCrossUnsafe
methodNextDeriveTask
methodOnDerived
methodCrossSafe
methodTryFinalize
method