Skip to content

Commit

Permalink
chore(readme): redesign (#1858) (#1920)
Browse files Browse the repository at this point in the history
* chore(readme): redesign

* rename bloxapp

* rename eth2-ssv

* fix badges

* fix discord link

* rename to SSV
  • Loading branch information
moshe-blox authored Dec 5, 2024
1 parent 8bcc2b4 commit 2315559
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 36 deletions.
79 changes: 44 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,61 +1,62 @@
[<img src="./docs/resources/ssv_header_image.png" >](https://www.ssvlabs.io/)
[<img src="https://i.ibb.co/cvn41hw/GIthub-banners.png" >](https://ssv.network/)

<br>
<br>

# SSV - Secret Shared Validator
# SSV Node

[![API Reference](
https://camo.githubusercontent.com/915b7be44ada53c290eb157634330494ebe3e30a/68747470733a2f2f676f646f632e6f72672f6769746875622e636f6d2f676f6c616e672f6764646f3f7374617475732e737667
)](https://pkg.go.dev/github.com/ethereum/eth2-ssv?tab=doc)
![Github Actions](https://github.com/ethereum/eth2-ssv/actions/workflows/full-test.yml/badge.svg?branch=stage)
![Github Actions](https://github.com/ethereum/eth2-ssv/actions/workflows/lint.yml/badge.svg?branch=stage)
[![API Reference](https://img.shields.io/badge/API%20Reference-blue)](https://pkg.go.dev/github.com/ssvlabs/ssv)
![Github Actions](https://github.com/ssvlabs/ssv/actions/workflows/unit-test.yml/badge.svg?branch=main)
![Github Actions](https://github.com/ssvlabs/ssv/actions/workflows/lint.yml/badge.svg?branch=main)
![Test Coverage](./docs/resources/cov-badge.svg)
[![Discord](https://img.shields.io/badge/discord-join%20chat-blue.svg)](https://discord.gg/eDXSP9R)
[![Discord](https://img.shields.io/badge/discord-join%20chat-blue.svg)](https://discord.gg/ssvnetworkofficial)

[comment]: <> ([![Go Report Card]&#40;https://goreportcard.com/badge/github.com/ethereum/eth2-ssv&#41;]&#40;https://goreportcard.com/report/github.com/ethereum/eth2-ssv&#41;)
[comment]: <> ([![Go Report Card]&#40;https://goreportcard.com/badge/github.com/ssvlabs/ssv&#41;]&#40;https://goreportcard.com/report/github.com/ssvlabs/ssv&#41;)

[comment]: <> ([![Travis]&#40;https://travis-ci.com/ethereum/eth2-ssv.svg?branch=stage&#41;]&#40;https://travis-ci.com/ethereum/eth2-ssv&#41;)
[comment]: <> ([![Travis]&#40;https://travis-ci.com/ssvlabs/ssv.svg?branch=main&#41;]&#40;https://travis-ci.com/ssvlabs/ssv&#41;)

## Introduction
## Introduction

Secret Shared Validator ('SSV') is a unique technology that enables the distributed control and operation of an Ethereum validator.
SSV is a secure and scalable staking infrastructure powering the future of distributed ETH re/staking.

SSV uses an MPC threshold scheme with a consensus layer on top ([Istanbul BFT](https://arxiv.org/pdf/2002.03613.pdf)),
SSV uses an MPC threshold scheme with a consensus layer on top ([Istanbul BFT](https://arxiv.org/pdf/2002.03613.pdf)),
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
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)
* Article by [Blox](https://medium.com/bloxstaking/an-introduction-to-secret-shared-validators-ssv-for-ethereum-2-0-faf49efcabee)
### 🔷 General SSV information (Semi technical read)

### Technical iBFT and SSV read
* [iBFT Paper](https://arxiv.org/pdf/2002.03613.pdf)
* [Fast sync for current instance](./ibft/sync/speedup/README.md)
* [iBFT annotated paper (By Blox)](./ibft/IBFT.md)
* [EIP650](https://github.com/ethereum/EIPs/issues/650)
* [Security proof for n-t honest parties](https://notes.ethereum.org/DYU-NrRBTxS3X0fu_MidnA)
* [MEV Research - Block proposer/ builder separation in SSV](https://hackmd.io/DHt98PC_S_60NbnW4Wgssg)
- Article by [SSV](https://medium.com/bloxstaking/an-introduction-to-secret-shared-validators-ssv-for-ethereum-2-0-faf49efcabee)

### 🔷 Technical iBFT and SSV read

- [iBFT Paper](https://arxiv.org/pdf/2002.03613.pdf)
- [iBFT annotated paper (By SSV)](./ibft/IBFT.md)
- [EIP650](https://github.com/ethereum/EIPs/issues/650)
- [Security proof for n-t honest parties](https://notes.ethereum.org/DYU-NrRBTxS3X0fu_MidnA)
- [MEV Research - Block proposer/ builder separation in SSV](https://hackmd.io/DHt98PC_S_60NbnW4Wgssg)

### 🔷 Audits

### Audits
- [Least Authority](/audits/Least%20Authority.pdf) (August 2023)

## Getting Started
## Getting Started

The following documents contain instructions and information on how to get started:
* [Operator Node Installation](https://docs.ssv.network/run-a-node/operator-node/installation)
* [Developers' Guide](./docs/DEV_GUIDE.md)
* [SSV API Docs](https://bloxapp.github.io/ssv/)

## Contribution
- [Operator Node Installation](https://docs.ssv.network/run-a-node/operator-node/installation)
- [Developers' Guide](./docs/DEV_GUIDE.md)
- [SSV API Docs](https://ssvlabs.github.io/ssv/)

## <img src="https://github.com/Anmol-Baranwal/Cool-GIFs-For-GitHub/assets/74038190/fa83eeb9-f4e2-4d85-93f0-688af11babf8" width="35">&nbsp; 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
In order to contribute to `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](https://discord.gg/eDXSP9R)
If you wish to submit more complex changes though, please check up with the core devs first on [our discord](https://discord.gg/ssvnetworkofficial)
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.
Expand All @@ -66,15 +67,23 @@ testing procedures.

## License

The eth2-ssv library (i.e. all code outside of the `cmd` directory) is licensed under the
The `ssv` library (i.e. all code outside of the `cmd` directory) is licensed under the
[GNU Lesser General Public License v3.0](https://www.gnu.org/licenses/lgpl-3.0.en.html),
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
The `ssv` binaries (i.e. all code inside of the `cmd` directory) is licensed under the
[GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html), also
included in our repository in the `LICENSE` file.

## Road Map
## Roadmap

For detailed roadmap please check out [ROADMAP.md](./ROADMAP.md)

<BR>

For detailed roadmap please check out [ROADMAP.md](./ROADMAP.md)
### 📌 Join the growing SSV community

<a href="https://discord.gg/ssvnetworkofficial" target="_blank">
<img src="https://user-images.githubusercontent.com/74038190/221352968-ac6f7b24-ed9a-4d00-a045-710caa6fc834.gif" width="100">
</a>
<br><br>
2 changes: 1 addition & 1 deletion docs/specs/NETWORKING.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ Once the committee reaches consensus, the nodes will publish the decided message

Consensus messages are being sent in the network over pubsub topics (see [subnets](#subnets))

More information regarding the protocol can be found in [iBFT annotated paper (By Blox)](/ibft/IBFT.md)
More information regarding the protocol can be found in [iBFT annotated paper (By SSV)](/ibft/IBFT.md)

### Message Structure

Expand Down

0 comments on commit 2315559

Please sign in to comment.