Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Make README.lint compliant. #211

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Make README.lint compliant. #211

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f50ae82
Make README.lint compliant.
jonathanpberger Oct 27, 2023
8052e2a
Merge branch 'main' into FEAT-make_readme_dot_lint_compliant
Reecepbcups Nov 9, 2023
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
34 changes: 27 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,38 @@
# Horcrux
[![Conforms to README.lint](https://img.shields.io/badge/README.lint-conforming-brightgreen)](https://github.com/strangelove-ventures/readme-dot-lint)

Horcrux is a [multi-party-computation (MPC)](https://en.wikipedia.org/wiki/Secure_multi-party_computation) signing service for CometBFT (Formerly known as Tendermint) nodes
🌌 Why use Horcrux?
=============================

## Why use Horcrux?
Tired of answering PagerDuty in the middle of the night? Eliminate the risk of double-signing, and harden and streamline your node ops.

Take your validator infrastructure to the next level of security and availability
🌌🌌 Who benefits from Horcrux?
=============================

Node operators who like their beauty sleep.


🌌🌌🌌 What exactly does Horcrux do?
=============================

Separate out signing, and node operations and ensure High Availability of signing keys by sharding. Horcrux is a [multi-party-computation (MPC)](https://en.wikipedia.org/wiki/Secure_multi-party_computation) signing service for CometBFT (Formerly known as Tendermint) nodes.

- Composed of a cluster of signer nodes in place of the [remote signer](https://docs.tendermint.com/master/nodes/remote-signer.html), enabling High Availability (HA) for block signing through fault tolerance.
- Secure your validator private key by splitting it across multiple private signer nodes using threshold Ed25519 signatures
- Add security and availability without sacrificing block sign performance.



🌌🌌🌌🌌 How do I use Horcrux?
=============================

## Running Horcrux

See documentation in [`docs/migrating.md`](/docs/migrating.md) to learn how to upgrade your validator infrastructure with Horcrux.


🌌🌌🌌🌌🌌 Extras
=============================

## Design

Validator operators balance operational and risk tradeoffs to avoid penalties via slashing for liveliness faults or double signing blocks.
Expand Down Expand Up @@ -37,9 +60,6 @@ Horcrux signer cluster configured with 5 total nodes, threshold 3.

[![Demo](https://img.youtube.com/vi/O-yy1CYBDsI/0.jpg)](https://www.youtube.com/watch?v=O-yy1CYBDsI)

## Running Horcrux

See documentation in [`docs/migrating.md`](/docs/migrating.md) to learn how to upgrade your validator infrastructure with Horcrux.

## Security

Expand Down
Loading