Added brief concept topics for EigenLayer core and middleware contracts #421
Conversation
MadelineAu
requested review from
dabit3,
wesfloyd,
bryangreen,
shrimalmadhur,
antojoseph,
NimaVaziri,
scotthconner,
MC1823315,
nelsonijih,
mmurrs and
non-fungible-nelson
as code owners
|
@MadelineAu is attempting to deploy a commit to the EigenLabs Team on Vercel. A member of the Team first needs to authorize it. |
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
@MadelineAu this is a good idea to add references to these contracts, however the wording can be improved for accuracy. Do you mind if we loop in Protocol Core Eng to advise on the wording for eigenlayer-contracts repo and AVS Eng to advise on the wording to describe eigenlayer-middleware repo? Until now, we do not have a succinct, accurate, and comprehensive definition of the purpose of those repos. |
| title: EigenLayer Core Contracts | ||
| --- | ||
|
|
||
| The contracts for an AVS interact with the EigenLayer contracts. The EigenLayer core contracts are documented in |
There was a problem hiding this comment.
The contracts for an AVS interact with the EigenLayer contracts.
This description feels more appropriate for the middleware contracts. Eg middleware is intended to allow AVSs to have a simplified set of contracts to interact with EigenLayer "core" Contracts.
I would instead describe "EigenLayer Core Contracts" as:
"the set of contracts that comprise the core EigenLayer protocol including Staking, Operations, AVS registration and allocation." (or similar)
cc @wadealexc @ypatil12 @jbrower95 in case they have better guidance.
| title: EigenLayer Middleware Contracts | ||
| --- | ||
|
|
||
| The EigenLayer middleware contracts are reference implementations of the contracts an AVS uses to interact with the [EigenLayer contracts](core-contracts.md). |
There was a problem hiding this comment.
Please check with smarter folks like @stevennevins @0xrajath @afkbyte , but here is a recommended rephrasing:
"The EigenLayer middleware contracts are higher level interfaces to the EigenLayer core contracts, recommended as the entry point for new AVS builders."
Adding connection points between the docs and the contracts documentation that currently lives in the repo.
The topics are deliberately brief to avoid a maintenance overhead duplicating content in the short term.