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

Horcrux should be README.lint compliant. #268

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Horcrux should be README.lint compliant. #268

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
46 changes: 29 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,30 @@
# 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?

Take your validator infrastructure to the next level of security and availability
Take your validator infrastructure to the next level of security and availability.

- 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.


🌌🌌 Who benefits from Horcrux?
=============================

Validator operators who want high {availability, security} via multi-party computation using threshold signatures.

🌌🌌🌌 What exactly does Horcrux _do_?
=============================

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.

## Design

Validator operators balance operational and risk tradeoffs to avoid penalties via slashing for liveliness faults or double signing blocks.

Traditional high-availability systems where the keys exist on hot spares risk double signing if there are failover detection bugs. Low-availability systems, or manual failover, risk downtime if manual intervention cannot respond in a timely manner.
Traditional high-availability systems where the keys exist on hot spares risk double-signing if there are failover detection bugs. Low-availability systems, or manual failover, risk downtime if manual intervention cannot respond in a timely manner.

Multi-party computation using threshold signatures is able to provide high-availability while maintaining high security and avoiding double signing via consensus and failover detection mechanisms.

Expand All @@ -23,34 +33,36 @@ For more on how the Horcrux MPC signing flow works, see [`docs/signing.md`](/doc
![Screenshot from 2022-03-07 18-09-49](https://user-images.githubusercontent.com/6722152/157145772-8557b4b5-a0cc-4073-8834-86afda1900fc.png)


🌌🌌🌌🌌 How do I run Horcrux?
=============================

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


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

## Raft

Horcrux v2.x introduces [Raft](https://raft.github.io/) For leader election and high watermark consensus.

### Benchmarks
## Benchmarks

![Screenshot from 2022-01-31 13-50-36](https://user-images.githubusercontent.com/6722152/151871074-32cb5d7a-b9f5-4466-8333-abc00bf7aa68.png)

### Demo
## Demo

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
# Security

Security and management of any key material is outside the scope of this service. Always consider your own security and risk profile when dealing with sensitive keys, services, or infrastructure.

## No Liability

As far as the law allows, this software comes as is,
without any warranty or condition, and no contributor
will be liable to anyone for any damages related to this
software or this license, under any kind of legal claim.
As far as the law allows, this software comes as is, without any warranty or condition, and no contributor will be liable to anyone for any damages related to this software or this license, under any kind of legal claim.

## References

Expand Down
Loading