From 033d87f70d7f86200eafcd0b9ca16da568d84c65 Mon Sep 17 00:00:00 2001 From: Reece Williams Date: Mon, 25 Mar 2024 15:14:36 -0500 Subject: [PATCH 1/4] codespell --- .codespellrc | 5 +++++ docs/migrating.md | 2 +- signer/metrics.go | 2 +- 3 files changed, 7 insertions(+), 2 deletions(-) create mode 100644 .codespellrc diff --git a/.codespellrc b/.codespellrc new file mode 100644 index 00000000..e393c29a --- /dev/null +++ b/.codespellrc @@ -0,0 +1,5 @@ +[codespell] +skip = *.pulsar.go,*.pb.go,*.pb.gw.go,*.json,*.git,*.bin,*.sum,*.mod,query_test.go +ignore-words-list = usera,pres,crate +count = +quiet-level = 3 \ No newline at end of file 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"}, ) From 717df74318090084f980b621290e5d3a61803330 Mon Sep 17 00:00:00 2001 From: Reece Williams Date: Mon, 25 Mar 2024 15:15:02 -0500 Subject: [PATCH 2/4] action: link lint + typos --- .github/workflows/chores.yml | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 .github/workflows/chores.yml diff --git a/.github/workflows/chores.yml b/.github/workflows/chores.yml new file mode 100644 index 00000000..b4597340 --- /dev/null +++ b/.github/workflows/chores.yml @@ -0,0 +1,34 @@ +name: chores + +on: + pull_request: + +jobs: + link-check: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: gaurav-nelson/github-action-markdown-link-check@1.0.15 + + typos: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Run codespell + continue-on-error: true + run: | + # .codespellrc is used + sudo apt-get install codespell -y + codespell -w --config .codespellrc + exit $? + pr-title-format: + name: Lint PR Title + permissions: + pull-requests: read + statuses: write + contents: read + runs-on: ubuntu-latest + steps: + - uses: amannn/action-semantic-pull-request@v5.4.0 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} From 5026441481255ad7632b9850201d511855293c87 Mon Sep 17 00:00:00 2001 From: Reece Williams Date: Mon, 25 Mar 2024 15:24:13 -0500 Subject: [PATCH 3/4] broken links --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 5ac42d57..6c45084e 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Horcrux is a [multi-party-computation (MPC)](https://en.wikipedia.org/wiki/Secur 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. +- Composed of a cluster of signer nodes in place of the [remote signer](https://docs.tendermint.com/v0.34/tools/remote-signer-validation.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. @@ -18,7 +18,7 @@ Traditional high-availability systems where the keys exist on hot spares risk do 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. -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 @@ -54,8 +54,8 @@ software or this license, under any kind of legal claim. ## References -- [CometBFT Validator Documentation](https://docs.cometbft.com/main/core/validators) -- [Cosmos Hub Validator Documentation](https://hub.cosmos.network/master/validators/overview.html) +- [CometBFT Validator Documentation](https://docs.cometbft.com/v0.38/core/validators) +- [Cosmos Hub Validator Documentation](https://hub.cosmos.network/validators/overview) - [Provably Secure Distributed Schnorr Signatures and a (t, n) Threshold Scheme for Implicit Certificates](http://cacr.uwaterloo.ca/techreports/2001/corr2001-13.ps) ## Acknowledgement From 96e703cb6287d8e7ce11a5e746bfc2eec4ba981a Mon Sep 17 00:00:00 2001 From: Reece Williams Date: Mon, 25 Mar 2024 15:25:20 -0500 Subject: [PATCH 4/4] Empty-Commit