diff --git a/README.md b/README.md index 5ac42d57..ca2eccec 100644 --- a/README.md +++ b/README.md @@ -14,11 +14,11 @@ Take your validator infrastructure to the next level of security and availabilit 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 fail over detection bugs. Low-availability systems, or manual fail over, 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. +Multi-party computation using threshold signatures is able to provide high-availability while maintaining high security and avoiding double signing via consensus and fail over detection mechanisms. -For more on how the Horcrux MPC signing flow works, see [`docs/signing.md`](/docs/signing.md) +For more on how the Horcrux MPC signing flow works, see [`docs/signing.md`](./docs/signing.md) ![Screenshot from 2022-03-07 18-09-49](https://user-images.githubusercontent.com/6722152/157145772-8557b4b5-a0cc-4073-8834-86afda1900fc.png) @@ -39,7 +39,7 @@ Horcrux signer cluster configured with 5 total nodes, threshold 3. ## Running Horcrux -See documentation in [`docs/migrating.md`](/docs/migrating.md) to learn how to upgrade your validator infrastructure with Horcrux. +See documentation in [`docs/migrating.md`](./docs/migrating.md) to learn how to upgrade your validator infrastructure with Horcrux. ## Security diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md index b5fc1364..6f138f46 100644 --- a/docs/CODE_OF_CONDUCT.md +++ b/docs/CODE_OF_CONDUCT.md @@ -2,7 +2,7 @@ ## Our Pledge -In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. +In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socioeconomic status, nationality, personal appearance, race, religion, or sexual identity and orientation. ## Our Standards diff --git a/docs/metrics.md b/docs/metrics.md index 24afd6f9..03526684 100644 --- a/docs/metrics.md +++ b/docs/metrics.md @@ -51,7 +51,7 @@ Single node signers don't execute any cosigner code, so the basic metrics are: If the 'seconds_since' metrics exceeds the normal block time, it may indicate a sentry failure or a network stall/halt. -If there are skips in the block heights requested to be signed the following counters will increase AFTER the sentry is able to report the latest block height. Until then, from the perspective of horcrux, it looks no different than a network stall. +If there are skips in the block heights requested to be signed the following counters will increase AFTER the sentry is able to report the latest block height. Until then, from the perspective of horcrux, it looks no different from a network stall. * signer_total_missed_precommits * signer_total_missed_prevotes @@ -87,7 +87,7 @@ As a result, followers also do not update these metrics ## Checking Signing Performance -We currently only have metrics between the leader and followers (not full p2p metrics). However it is still useful in determining when a particular peer lags significantly. +We currently only have metrics between the leader and followers (not full p2p metrics). However, it is still useful in determining when a particular peer lags significantly. Your cluster should reach the threshold for availability in a short time. Monitor the following: diff --git a/docs/migrating.md b/docs/migrating.md index b3046a41..9216e98a 100644 --- a/docs/migrating.md +++ b/docs/migrating.md @@ -206,7 +206,7 @@ The signer will continue retrying attempts to reach the sentries until we turn t - Misnaming or incorrect structure of the files in `~/.horcrux/state`. Double check these if you see errors - Misnaming or misplacement of the `~/.horcrux/{chain-id}_shard.json` file -> **NOTE:** leaving these logs streaming in seperate terminal windows will enable you to watch the cluster connect to the sentries. +> **NOTE:** leaving these logs streaming in separate terminal windows will enable you to watch the cluster connect to the sentries. ### 8. Configure and start your full nodes diff --git a/signer/metrics.go b/signer/metrics.go index 2145ba77..58b093da 100644 --- a/signer/metrics.go +++ b/signer/metrics.go @@ -252,7 +252,7 @@ var ( failedSignVote = promauto.NewCounterVec( prometheus.CounterOpts{ Name: "signer_total_failed_sign_vote", - Help: "Total Times Signer Failed to sign block - Unstarted and Unexepcted Height", + Help: "Total Times Signer Failed to sign block - Unstarted and Unexpected Height", }, []string{"chain_id"}, )