ssv

module
v1.2.2-unstable Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 24, 2023 License: GPL-3.0

README



SSV - Secret Shared Validator

API Reference Github Actions Github Actions Test Coverage Discord

Introduction

Secret Shared Validator ('SSV') is a unique technology that enables the distributed control and operation of an Ethereum validator.

SSV uses an MPC threshold scheme with a consensus layer on top (Istanbul BFT), that governs the network.
Its core strength is in its robustness and fault tolerance which leads the way for an open network of staking operators to run validators in a decentralized and trustless way.

Information

General SSV information (Semi technical read)
Technical iBFT and SSV read
Audits

Getting Started

The following documents contain instructions and information on how to get started:

Contribution

Thank you for considering a contribution to the source code.

In order to contribute to eth2-ssv, please fork, add your code, commit and send a pull request for the maintainers to review and merge into the main code base.
If you wish to submit more complex changes though, please check up with the core devs first on our discord to ensure those changes are in line with the general philosophy of the project and/or get some early feedback which can make both your efforts much lighter as well as our review and merge procedures quick and simple.

Please see the Developers' Guide for more details on configuring your environment, managing project dependencies, and testing procedures.

License

The eth2-ssv library (i.e. all code outside of the cmd directory) is licensed under the GNU Lesser General Public License v3.0, also included in our repository in the LICENSE file.

The eth2-ssv binaries (i.e. all code inside of the cmd directory) is licensed under the GNU General Public License v3.0, also included in our repository in the LICENSE file.

Road Map

For detailed roadmap please check out ROADMAP.md

Directories

Path Synopsis
api
beacon
cli
cmd
e2e module
eth
contract
Package contract generates the contract bindings for v1 contract.
Package contract generates the contract bindings for v1 contract.
eventhandler
Package eventhandler provides support for handling registry contract events and persisting them to the database.
Package eventhandler provides support for handling registry contract events and persisting them to the database.
eventparser
Package eventparser implements functions for parsing registry contract events from Ethereum logs into their respective structured types.
Package eventparser implements functions for parsing registry contract events from Ethereum logs into their respective structured types.
eventsyncer
Package eventsyncer implements functions for syncing registry contract events by reading them using executionclient and processing them using eventhandler.
Package eventsyncer implements functions for syncing registry contract events by reading them using executionclient and processing them using eventhandler.
executionclient
Package executionclient implements functions for interacting with Ethereum execution clients.
Package executionclient implements functions for interacting with Ethereum execution clients.
exporter
api
ibft
integration
mocks
Package mocks is a generated GoMock package.
Package mocks is a generated GoMock package.
message
validation
Package validation provides functions and structures for validating messages.
Package validation provides functions and structures for validating messages.
monitoring
p2p
duties
Package duties is a generated GoMock package.
Package duties is a generated GoMock package.
duties/mocks
Package mocks is a generated GoMock package.
Package mocks is a generated GoMock package.
fee_recipient/mocks
Package mocks is a generated GoMock package.
Package mocks is a generated GoMock package.
slotticker/mocks
Package mocks is a generated GoMock package.
Package mocks is a generated GoMock package.
validator/mocks
Package mocks is a generated GoMock package.
Package mocks is a generated GoMock package.
protocol
v2/blockchain/beacon
Package beacon is a generated GoMock package.
Package beacon is a generated GoMock package.
v2/blockchain/beacon/mocks
Package mocks is a generated GoMock package.
Package mocks is a generated GoMock package.
v2/qbft/roundtimer/mocks
Package mocks is a generated GoMock package.
Package mocks is a generated GoMock package.
registry
scripts
differ Module
storage
kv
boot_node
Code generated by fastssz.
Code generated by fastssz.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL