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.

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

chore(ci): codespell + broken link checks #261

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .codespellrc
Original file line number Diff line number Diff line change
@@ -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
34 changes: 34 additions & 0 deletions .github/workflows/chores.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: chores

on:
pull_request:

jobs:
link-check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: gaurav-nelson/[email protected]

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/[email protected]
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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)

Expand All @@ -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

Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/migrating.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion signer/metrics.go
Original file line number Diff line number Diff line change
Expand Up @@ -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"},
)
Expand Down
Loading