Skip to content

Commit 218274d

Browse files
author
MarcoFalke
committed
Merge #17819: doc: developer notes guideline on RPCExamples addresses
42ec499 doc: developer notes guideline on RPCExamples addresses (Jon Atack) Pull request description: to make explicit the use of invalid addresses for user safety and to encourage the use of bech32 addresses by default. See bitcoin/bitcoin#17578 (comment) and bitcoin/bitcoin#17578 (comment). Fix a typo to appease the linter. ACKs for top commit: promag: ACK 42ec499, no strong opinion as whether this belongs to developer notes or not but why not. fjahr: ACK 42ec499 michaelfolkson: ACK 42ec499 Tree-SHA512: 64f90e227d256aa194c4fd48435440bdc233a51213dd4a6ac5b05d04263f729c6b4bb5f3afd3b87719b20cb1b159d5a9673d58a11b72823a4a6a16e8a26ae10e
2 parents f018d0c + 42ec499 commit 218274d

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

doc/developer-notes.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -957,7 +957,7 @@ introduce accidental changes.
957957
Some good examples of scripted-diff:
958958

959959
- [scripted-diff: Rename InitInterfaces to NodeContext](https://github.com/bitcoin/bitcoin/commit/301bd41a2e6765b185bd55f4c541f9e27aeea29d)
960-
uses an elegant script to replace occurences of multiple terms in all source files.
960+
uses an elegant script to replace occurrences of multiple terms in all source files.
961961

962962
- [scripted-diff: Remove g_connman, g_banman globals](https://github.com/bitcoin/bitcoin/commit/301bd41a2e6765b185bd55f4c541f9e27aeea29d)
963963
replaces specific terms in a list of specific source files.
@@ -1085,6 +1085,11 @@ A few guidelines for introducing and reviewing new RPC interfaces:
10851085
new RPC is replacing a deprecated RPC, to avoid both RPCs confusingly
10861086
showing up in the command list.
10871087

1088+
- Use *invalid* bech32 addresses for `RPCExamples` help documentation.
1089+
1090+
- *Rationale*: Prevent accidental transactions by users and encourage the use
1091+
of bech32 addresses by default.
1092+
10881093
- Use the `UNIX_EPOCH_TIME` constant when describing UNIX epoch time or
10891094
timestamps in the documentation.
10901095

0 commit comments

Comments
 (0)