-
Notifications
You must be signed in to change notification settings - Fork 28
docs: small revision to the documentation #512
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
Merged
Merged
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -78,7 +78,7 @@ chmod +x anchor | |
| <div className="stat-label">Stars</div> | ||
| </div> | ||
| <div className="stat-item"> | ||
| <div className="stat-number">12</div> | ||
| <div className="stat-number">13</div> | ||
|
||
| <div className="stat-label">Contributors</div> | ||
| </div> | ||
| <div className="stat-item"> | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,7 +10,8 @@ production setting. | |
|
|
||
| ## What is SSV? | ||
|
|
||
| Secret Shared Validators (SSV) is a protocol that splits a validator key into multiple shares, distributed across different operators. This approach provides: | ||
| Secret Shared Validators (SSV) is a protocol that splits a validator key into multiple shares, distributed across different operators. | ||
| Instead of running a validator on a single machine, SSV splits the validator's duties across multiple operators, creating a more resilient and decentralized staking infrastructure. This approach provides: | ||
|
|
||
| - **Fault Tolerance**: Your validator remains online even if some operators go offline | ||
| - **No Single Point of Failure**: No single operator can compromise your validator | ||
|
|
@@ -19,95 +20,33 @@ Secret Shared Validators (SSV) is a protocol that splits a validator key into mu | |
|
|
||
| ## Why Choose Anchor? | ||
|
|
||
| Anchor stands out as an SSV client with several key advantages: | ||
|
|
||
| ### 🔒 **Security First** | ||
| - Written in Rust for memory safety and security | ||
| - Comprehensive fuzzing and security testing | ||
| - Built by Sigma Prime, trusted Ethereum infrastructure experts | ||
|
|
||
| ### ⚡ **High Performance** | ||
| - Optimized for efficiency and low resource usage | ||
| - Fast consensus and networking implementation | ||
| - Minimal latency for time-sensitive validator duties | ||
|
|
||
| ### 🛠️ **Developer Friendly** | ||
| - Clean, well-documented codebase | ||
| - Extensive CLI tools for key management and operations | ||
| - Active open-source development | ||
| Written in Rust, Anchor focuses on memory safety and security. As an independent implementation of the SSV protocol, | ||
| Anchor promotes client diversity in the SSV space, reducing the risk of network-wide failures. Anchor is optimized for | ||
| efficiency, fast consensus and networking implementation. | ||
|
|
||
| ## Who Should Use Anchor? | ||
|
|
||
| ### Staking Pool Operators | ||
| Run distributed validators with enhanced security and fault tolerance for your staking infrastructure. | ||
|
|
||
| ### Solo Stakers | ||
| Increase the reliability of your validator setup by distributing risk across multiple operators. | ||
|
|
||
| ### SSV Network Operators | ||
| Operate as part of the SSV network, providing validator services to other users. | ||
|
|
||
| ## Quick Start Paths | ||
|
|
||
| Choose your path based on your role: | ||
|
|
||
| :::code-group | ||
|
|
||
| ```bash [🎯 New to SSV] | ||
| # Start here to understand the basics | ||
| → Read: What is SSV? | ||
| → Next: Installation Guide | ||
| ``` | ||
|
|
||
| ```bash [⚙️ Run an Operator] | ||
| # Become an SSV network operator | ||
| → Next: Installation → Running an Operator | ||
| → Then: Operator Configuration | ||
| ``` | ||
|
|
||
| ```bash [🔑 Manage Keys] | ||
| # Generate and split validator keys | ||
| → Next: Installation → CLI Reference | ||
| → Focus: Keygen and KeySplit tools | ||
| ``` | ||
|
|
||
| ```bash [🧑💻 Developer] | ||
| # Contribute or integrate | ||
| → Next: Development Environment | ||
| → Then: Architecture Overview | ||
| ``` | ||
|
|
||
| ::: | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| Before getting started, ensure you have: | ||
|
|
||
| - **System Requirements**: Linux, macOS, or Windows | ||
| - **Rust** (if building from source): Version 1.88.0 or later | ||
| - **Ethereum Knowledge**: Basic understanding of validators and staking | ||
| - **Command Line**: Comfort with terminal/command prompt usage | ||
| Anyone with a running staking infrastructure can opt to additionally run Anchor and become part of the SSV network. | ||
| This includes staking pool operators, node operators and solo stakers. | ||
|
|
||
| ## What's Next? | ||
|
|
||
| 1. **[Installation](/installation)** - Get Anchor running on your system | ||
| 2. **[Running an Operator](/running_an_operator)** - Start operating in the SSV network | ||
| 3. **[CLI Reference](/cli)** - Master the command-line tools | ||
| 4. **[Architecture](/architecture)** - Understand Anchor's technical design | ||
| 5. **[SSV documentation](https://docs.ssv.network/learn/introduction)** - read more about the SSV network | ||
|
|
||
|
|
||
| ## About This Documentation | ||
|
|
||
| This documentation is open source and community-driven. We welcome contributions to help improve the experience for all users. | ||
|
|
||
| - **Contribute**: [github.com/sigp/anchor/docs](https://github.com/sigp/anchor/tree/unstable/docs) | ||
| - **Community Support**: [GitHub Discussions](https://github.com/sigp/anchor/discussions) | ||
| - **Professional Support**: [Sigma Prime](https://sigmaprime.io) | ||
| This documentation is open source and community-driven. We welcome [contributions](https://github.com/sigp/anchor/tree/unstable/docs) to help improve the experience for all users. | ||
|
|
||
| --- | ||
|
|
||
| :::tip | ||
| Need Help? | ||
| - Check our [FAQ](/faq) for common questions | ||
| - Join the community on [GitHub](https://github.com/sigp/anchor) | ||
| - Join the community on [Discord] (https://discord.com/invite/cyAszAh) | ||
|
||
| - Report issues or request features in our [issue tracker](https://github.com/sigp/anchor/issues) | ||
| ::: | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Missing closing brace