Skip to content
This repository has been archived by the owner on Mar 20, 2024. It is now read-only.

remove install and montoring #63

Merged
merged 5 commits into from
Oct 27, 2023
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# AVS Specification

This is a specification for the packaging, installation, update, and monitoring process of [EigenLayer](https://www.eigenlayer.xyz/) AVS Nodes. AVS is used to participate in the EigenLayer restake system, to know more about EigenLayer see its [documentation page](https://docs.eigenlayer.xyz/overview/readme). This specification could be used to manage multiple Nodes in the same host machine with the [Node wizard setup tool](https://eigen.nethermind.io/docs/wizard/intro).
This is a specification for running of [EigenLayer](https://www.eigenlayer.xyz/) AVS Nodes. AVS is used to participate in the EigenLayer restake system, to know more about EigenLayer see its [documentation page](https://docs.eigenlayer.xyz/overview/readme).

## Docs

Expand Down
3 changes: 1 addition & 2 deletions docs/docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,11 @@ sidebar_position: 0

The [EigenLayer](https://www.eigenlayer.xyz/) ecosystem allows Ethereum validators to restake their ETH and provide services to the network, such as a Data Availability Layer with a particular type of node software called [Actively Validated Services (AVS)](/docs/glossary#avs-actively-validated-service).

With the increasing number of AVS use cases, there is a need for a convention on how to develop, maintain, create interoperability, and monitor them. Eigenlayer has partnered with Nethermind to create an [AVS Node](/docs/glossary#avs-node) Specification with those goals in mind. We also decided to build an AVS Node Setup Wizard to install and manage AVS Nodes that follow such specification. This documentation describes the AVS Node Specification and the AVS Node Setup Wizard.
With the increasing number of AVS use cases, there is a need for a convention on how to develop, maintain, create interoperability, and monitor them. Eigenlayer has partnered with Nethermind to create an [AVS Node](/docs/glossary#avs-node) Specification with those goals in mind. This documentation describes the AVS Node Specification.

The documentation is divided into the following sections:

- [AVS Node Specification](/docs/category/avs-node-specification): A full description of the specification that covers from AVS packaging to Standard Metrics.
- [Setup wizard](/docs/category/avs-setup-wizard): An AVS setup wizard tool aimed to simplify AVS Node management for node operators.
- [Keys Management](/docs/category/keys-management): Good practices for keys management.

## Definitions
Expand Down
11 changes: 2 additions & 9 deletions docs/docs/keys/developers.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,20 +36,13 @@ A good choice for a remote signer is [Web3signer](https://docs.web3signer.consen

## Key Management Recommendation for Developers

The AVS can implement a feasible and sufficient method of loading the keys. This is asking for a path to a keystore folder. This keystore needs to follow some structure either the AVS knows how to read, or an AVS [plugin](/docs/category/plugin) knows how to transform to something the AVS knows how to read.
The AVS can implement a feasible and sufficient method of loading the keys. This is asking for a path to a keystore folder. This keystore needs to follow some structure that AVS knows how to read. Currently [eigenlayer-cli](https://github.com/NethermindEth/eigenlayer#create-and-list-keys) supports creation of encrypted ecdsa and bn254 keys in the [web3 secret storage](https://ethereum.org/en/developers/docs/data-structures-and-encoding/web3-secret-storage/) format.

Usually, the plugin idea is the most recommended because the AVS has the freedom to use whatever structure they need or want for the keystore. Also, no constraint is being put on users or key generation tools. This also fits the idea of the [AVS setup wizard tool](/docs/category/avs-setup-wizard) supporting such plugins. Apart from the wizard domain, users could use this plugin (as an AVS command/subcommand) to process the raw keystore if they go for a manual setup.

Plugins could be made to generate the keys directly to a keystore folder the AVS knows how to read. Generation would be made according to user inputs. Third party tools could be used to generate keystores.

Ideally, after providing the keystore path to the AVS, it would listen to any changes to the folder so it could handle the keys automatically without requiring a restart.

:::note

By keys, we refer to any kind of secret, either in plain text or encrypted.

:::

This keystore structure requires a strict specifications on the file names, folder names, and contents within the keystore. Plugins can help enormously to get the burden of maintaining such structure off the user.

The path to this keystore folder can be provided via an environment variable or argument. Either way, a target for an option in [the profile file](/docs/spec/packaging/profiles) of the packaging proposal for Nodes can be used to allow the AVS setup wizard tool to get his path from the user.
The path to this keystore folder can be provided via an environment variable or argument.
5 changes: 2 additions & 3 deletions docs/docs/spec/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Introduction"
sidebar_position: 1
---

This is a specification for the packaging, installation, update, and monitoring process of [EigenLayer](https://www.eigenlayer.xyz/) Nodes. AVS is used to participate in the EigenLayer restaking system, to know more about EigenLayer see its [documentation page](https://docs.eigenlayer.xyz/overview/readme).
This is a specification for running of [EigenLayer](https://www.eigenlayer.xyz/) AVS Nodes. AVS is used to participate in the EigenLayer restaking system, to know more about EigenLayer see its [documentation page](https://docs.eigenlayer.xyz/overview/readme).
shrimalmadhur marked this conversation as resolved.
Show resolved Hide resolved

The current version of the specification is `v0.0.1`.

Expand All @@ -15,7 +15,6 @@ The current version of the AVS Node specification should be considered a public

The description of the Specification is divided into the following sections:

- [Packaging & Upgrading](/docs/spec/packaging/): How developers can package their AVS Nodes and how an AVS wizard setup tool can install and upgrade them.
- [AVS Node API](/docs/category/avs-node-api): HTTP RESTful API for AVS Nodes.
- [Metrics](/docs/category/metrics): Prometheus standard metrics for AVS implementations.
- [Plugin](/docs/spec/plugin/intro): How developers can provide a plugin to extend the AVS wizard setup tool with AVS-specific features.
- [Plugin](/docs/spec/plugin/intro): How developers can provide an interface to execute on-time features.
8 changes: 0 additions & 8 deletions docs/docs/spec/packaging/_category_.json

This file was deleted.

83 changes: 0 additions & 83 deletions docs/docs/spec/packaging/guidelines.md

This file was deleted.

114 changes: 0 additions & 114 deletions docs/docs/spec/packaging/manifest.md

This file was deleted.

Loading