Skip to content

Commit 5aec50c

Browse files
committed
October 2019 style guide updated
1 parent 8f511e6 commit 5aec50c

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

STYLE.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ sentence or heading.
2121

2222
- bech32
2323
- bitcoin (the currency)
24+
- eltoo
2425
- merkle (tree|root|branch|node)
2526
- schnorr
2627
- segwit
@@ -71,14 +72,20 @@ following abbreviations we assume readers will already know.
7172
|-|-|-|
7273
| block chain | blockchain | |
7374
| coinjoin | Coinjoin or coinJoin or coin-join | |
75+
| feerate | fee-rate or fee rate | |
7476
| mainnet | main net | |
7577
| multisig | multi-sig | |
7678
| multiparty | multi-party | |
7779
| MuSig | Musig or muSig or musig | |
7880
| offchain | off-chain | |
7981
| onchain | on-chain | |
82+
| opcode | OPCODE or OpCode or Opcode or op code | |
83+
| OP_RETURN (and all other opcodes) | op_return | |
8084
| preimage | pre-image | |
85+
| proof of work | proof-of-work | proof-of-work may be used as an adjective phrase (e.g. "Bitcoin's proof-of-work security is economic in nature"). | |
8186
| redeemScript | redeem script | |
87+
| secp256k1 | Secp256k1 or SECP256k1 or SECP256K1 | |
88+
| sigop | Sigop or SigOp or sig op | |
8289
| single-sig | singlesig | |
8390
| soft fork/hard fork | softfork/hardfork or soft-fork/hard-fork | soft-fork/hard-fork may be used as compound adjectives (eg "Foo proposed a soft-fork change") |
8491
| 2-of-3 | 2 of 3 | |
@@ -89,15 +96,19 @@ The author of the document gets to choose its flavor of English (e.g.
8996
American or British). However, the following terms should always be
9097
spelled the same.
9198

92-
| Use | Don't use |
93-
|-|-|
94-
| k-of-n multisig | m-of-n multisig |
95-
| light client | lite client |
99+
| Use | Don't use | Notes |
100+
|-|-|-|
101+
| adaptor signatures | adapter signatures | |
102+
| k-of-n multisig and n-of-n multisignature | m-of-n multisig or any_other_letter-of-any_other_letter multisig | When spoken, 'm-of-n' can easily be confused with 'n-of-n' |
103+
| light client | lite client | |
104+
| merklized | merkelized or merkleized | |
96105

97106
### Preferred terms
98107

99108
| Use | Don't use | Notes |
100109
|-|-|-|
110+
| coinbase transaction | generation transaction | |
111+
| Merklized Alternative Script Trees | Merklized Abstract Syntax Trees | https://bitcoinops.org/en/newsletters/2018/12/28/#fn:fn-mast |
101112
| spender | sender | "sender" may ambiguously refer to the sender of data |
102113
| receiver | recipient | |
103114

0 commit comments

Comments
 (0)