typos
is a powerful source code spell checker.
Adds a CI job that runs on every PR and
push to master (but can also be run manually with
workflow_dispatch) that checks for typos.
Adds a config file .typos.toml that deals with
false positives and only checks for top-level/one-level
.mediawiki and .md files. This config can be extended
quite easily with actual terms or regexes to whitelist
(false-positives)
Fixes some typos in several BIPs that were flagged locally by typos.
14+ uses: actions/checkout@v4
15+
16+ - name: Check spelling
17+ uses: crate-ci/typos@master
18+ with:
19+ files: ./*.mediawiki
0@@ -0,0 +1,19 @@
1+name: Check Typos
2+on:
3+ push:
4+ branches:
5+ - master
on: [push, pull_request]
master)
(but can also be run manually with workflow_dispatch)
Can you provide a cross-platform command to run this check manually?
(but can also be run manually with workflow_dispatch)
Can you provide the cross-platform command to run this check manually? (I tried with macOS)
Install typos and then run from the root dir:
0typos ./*.mediawiki ./*.md ./**/*.mediawiki ./**/*.md
EDIT: add a typo to any md or mediawiki file and see it being flagged
Thanks! Tested.
Install
typosand then run from the root dir:
0typos ./*.mediawiki ./*.md ./**/*.mediawiki ./**/*.md
Would you please update the PR description with that documentation? (Separate from this PR, it may be a good idea to add a CONTRIBUTING file, or a section to the readme, that documents how to run the CI checks manually.)
Would it make sense to add this task into github-action-checks.yml, and/or make the CI output more like the other tasks:
0@@ -1,4 +1,4 @@
1-name: Check Typos
2+name: GitHub Actions Check
3 on:
4 push:
5 branches:
6@@ -8,6 +8,7 @@ on:
7
8 jobs:
9 typos:
10+ name: "Spelling Checks"
11 runs-on: ubuntu-latest
12 steps:
13 - name: Checkout Actions Repository
218@@ -219,7 +219,7 @@ message EncryptedProtocolMessage {
219 ==Payment Protocol Process with InvoiceRequests==
220 The full process overview for using '''InvoiceRequests''' in the Payment Protocol is defined below.
221 <br/><br/>
222-All Payment Protocol messages MUST be encapsulated in either a [[#ProtocolMessage|ProtocolMessage]] or [[#EncryptedProcotolMessage|EncryptedProtocolMessage]]. Once the process begins using [[#EncryptedProtocolMessage|EncryptedProtocolMessage]] messages, all subsequent communications MUST use [[#EncryptedProtocolMessage|EncryptedProtocolMessages]].
223+All Payment Protocol messages MUST be encapsulated in either a [[#ProtocolMessage|ProtocolMessage]] or [[#EncryptedProtocolMessage|EncryptedProtocolMessage]]. Once the process begins using [[#EncryptedProtocolMessage|EncryptedProtocolMessage]] messages, all subsequent communications MUST use [[#EncryptedProtocolMessage|EncryptedProtocolMessages]].
- Would you please update the PR description with that documentation? (Separate from this PR, it may be a good idea to add a
CONTRIBUTINGfile, or a section to the readme, that documents how to run the CI checks manually.)
Done, added a CONTRIBUTING.md in ce4351d6bf5cca5e19efe577fdcc74b953a70e21.
- Would it make sense to add this task into
github-action-checks.yml, and/or make the CI output more like the other tasks:
Good idea! I’ve removed the new typos.yml and added the job in the already existing github-action-checks.yml in ce4351d6bf5cca5e19efe577fdcc74b953a70e21.
208@@ -209,7 +209,7 @@ There are several design goals for the Short ID calculation:
209 * '''Space''' cmpctblock messages are never optional in this protocol, and contain a short ID for each non-prefilled transaction in the block. Thus, the size of short IDs is directly proportional to the maximum bandwidth savings possible.
210 * '''Collision resistance''' It should be hard for network participants to create transactions that cause collisions. If an attacker were able to cause such collisions, filling mempools (and, thus, blocks) with them would cause poor network propagation of new (or non-attacker, in the case of a miner) blocks.
211
212-SipHash is a secure, fast, and simple 64-bit MAC designed for network traffic authentication and collision-resistant hash tables. We truncate the output from SipHash-2-4 to 48 bits (see next section) in order to minimize space. The resulting 48-bit hash is certainly not large enough to avoid intentionally created individual collisons, but by using the block hash as a key to SipHash, an attacker cannot predict what keys will be used once their transactions are actually included in a relayed block. We mix in a per-connection 64-bit nonce to obtain independent short IDs on every connection, so that even block creators cannot control where collisions occur, and random collisions only ever affect a small number of connections at any given time. The mixing is done using SHA256(block_header || nonce), which is slow compared to SipHash, but only done once per block. It also adds the ability for nodes to choose the nonce in a better than random way to minimize collisions, though that is not necessary for correct behaviour. Conversely, nodes can also abuse this ability to increase their ability to introduce collisions in the blocks they relay themselves. However, they can already cause more problems by simply refusing to relay blocks. That is inevitable, and this design only seeks to prevent network-wide misbehavior.
213+SipHash is a secure, fast, and simple 64-bit MAC designed for network traffic authentication and collision-resistant hash tables. We truncate the output from SipHash-2-4 to 48 bits (see next section) in order to minimize space. The resulting 48-bit hash is certainly not large enough to avoid intentionally created individual collisions, but by using the block hash as a key to SipHash, an attacker cannot predict what keys will be used once their transactions are actually included in a relayed block. We mix in a per-connection 64-bit nonce to obtain independent short IDs on every connection, so that even block creators cannot control where collisions occur, and random collisions only ever affect a small number of connections at any given time. The mixing is done using SHA256(block_header || nonce), which is slow compared to SipHash, but only done once per block. It also adds the ability for nodes to choose the nonce in a better than random way to minimize collisions, though that is not necessary for correct behaviour. Conversely, nodes can also abuse this ability to increase their ability to introduce collisions in the blocks they relay themselves. However, they can already cause more problems by simply refusing to relay blocks. That is inevitable, and this design only seeks to prevent network-wide misbehavior.
WDYT about simplifying running the linter with something like the following:
0diff --git a/.github/workflows/github-action-checks.yml b/.github/workflows/github-action-checks.yml
1index 3f1fce9..17f19c1 100644
2--- a/.github/workflows/github-action-checks.yml
3+++ b/.github/workflows/github-action-checks.yml
4@@ -29,5 +29,3 @@ jobs:
5 - name: Check spelling
6 uses: crate-ci/typos@master
7- with:
8- files: ./*.mediawiki ./*.md ./**/*.mediawiki ./**/*.md
9diff --git a/.typos.toml b/.typos.toml
10index e645929..e81f41c 100644
11--- a/.typos.toml
12+++ b/.typos.toml
13@@ -27,3 +27,5 @@ Atack = "Atack"
14 Meni = "Meni"
15
16+[files]
17+extend-exclude = ["/*/*.csv", "/*.d*", "/*/*.d*", "/*/*.go", "/*/*.json", "/*/*/*.json", "/*/*.mod", "/*/*.proto", "scripts", "/*/*.s*", "/*/*.t*"]
18diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
19index 506a295..df6d947 100644
20--- a/CONTRIBUTING.md
21+++ b/CONTRIBUTING.md
22@@ -8,5 +8,5 @@ install [`typos`](https://github.com/crate-ci/typos)
23 and then run in the root directory:
24
25-typos ./*.mediawiki ./*.md ./**/*.mediawiki ./**/*.md
26+typos
This seems to work better for me locally and it also allows debugging the linter with its built-in options like typos --files.
Edit: about the commit order, it seems best to fix the typos before adding the linter, or in the same commit, as otherwise the commits after adding the linter are non-hygienic.
.py files since we are not typo checking the scripts for now.
38+ "/*/*/*.json",
39+ "/*/*.mod",
40+ "/*/*.proto",
41+ "scripts",
42+ "/*/*.s*",
43+ "/*/*.t*"
0 "/*/*.t*",
23+ser = "ser"
24+anc = "anc"
25+# Names
26+Atack = "Atack"
27+Ono = "Ono"
28+Meni = "Meni"
sort
0 [default.extend-words]
1 # NOTE: use here for false-positives
2+anc = "anc"
3 PSBT = "PSBT"
4 ser = "ser"
5-anc = "anc"
6 # Names
7 Atack = "Atack"
8-Ono = "Ono"
9 Meni = "Meni"
10+Ono = "Ono"
11
12 [files]
13 extend-exclude = [
14 "/*/*.csv",
15 "/*.d*",
16 "/*/*.d*",
17- "/*/*.py",
18 "/*/*.go",
19 "/*/*.json",
20 "/*/*/*.json",
21 "/*/*.mod",
22 "/*/*.proto",
23+ "/*/*.py",
24 "scripts",
25 "/*/*.s*",
26 "/*/*.t*"
26+ steps:
27+ - name: Checkout Actions Repository
28+ uses: actions/checkout@v4
29+
30+ - name: Check spelling
31+ uses: crate-ci/typos@master
steps: entries in this file
@storopoli looks good to me (thanks!) A few nits follow. Let me know if you’d like to update for them or merge this pull as-is.
Edit: also suggest doing the spelling fixups in a single commit.
typos is a powerful source code spell checker.
Adds a CI job that runs on every PR and
push to master (but can also be run manually with
workflow_dispatch) that checks for typos.
Adds a config file .typos.toml that deals with
false positives and only checks for top-level/one-level
.mediawiki and .md files.
ACK 52fdb00b6d5844f48cb30b5c39b6fe23708281e4 (thanks!)
We could fill out the contributing guide a bit more.