Skip to content

Commit 42ec499

Browse files
committed
doc: developer notes guideline on RPCExamples addresses
to make explicit the use of invalid addresses for user safety and to encourage the use of bech32 addresses by default. Fix a typo to appease the linter.
1 parent b931f61 commit 42ec499

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
@@ -919,7 +919,7 @@ introduce accidental changes.
919919
Some good examples of scripted-diff:
920920

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

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

1050+
- Use *invalid* bech32 addresses for `RPCExamples` help documentation.
1051+
1052+
- *Rationale*: Prevent accidental transactions by users and encourage the use
1053+
of bech32 addresses by default.
1054+
10501055
- Use the `UNIX_EPOCH_TIME` constant when describing UNIX epoch time or
10511056
timestamps in the documentation.
10521057

0 commit comments

Comments
 (0)