diff options
| author | MarcoFalke <falke.marco@gmail.com> | 2020-01-16 15:23:30 -0500 |
|---|---|---|
| committer | MarcoFalke <falke.marco@gmail.com> | 2020-01-16 15:23:40 -0500 |
| commit | 218274de7d1f3aeebc86dcacb4ffaaff32bd237f (patch) | |
| tree | f29017ae20628ec10d3ae7fe0ef32b05dfca714d /doc/developer-notes.md | |
| parent | f018d0c9cd7f408dac016b6bfc873670de713d27 (diff) | |
| parent | 42ec4994892e67e3430f867af069aafcc2e08593 (diff) | |
| download | bitcoin-218274de7d1f3aeebc86dcacb4ffaaff32bd237f.tar.xz | |
Merge #17819: doc: developer notes guideline on RPCExamples addresses
42ec4994892e67e3430f867af069aafcc2e08593 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 https://github.com/bitcoin/bitcoin/pull/17578#discussion_r361752570 and https://github.com/bitcoin/bitcoin/pull/17578#discussion_r362564492.
Fix a typo to appease the linter.
ACKs for top commit:
promag:
ACK 42ec4994892e67e3430f867af069aafcc2e08593, no strong opinion as whether this belongs to developer notes or not but why not.
fjahr:
ACK 42ec499
michaelfolkson:
ACK 42ec4994892e67e3430f867af069aafcc2e08593
Tree-SHA512: 64f90e227d256aa194c4fd48435440bdc233a51213dd4a6ac5b05d04263f729c6b4bb5f3afd3b87719b20cb1b159d5a9673d58a11b72823a4a6a16e8a26ae10e
Diffstat (limited to 'doc/developer-notes.md')
| -rw-r--r-- | doc/developer-notes.md | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/doc/developer-notes.md b/doc/developer-notes.md index 5f91296f57..3ef35cfcfa 100644 --- a/doc/developer-notes.md +++ b/doc/developer-notes.md @@ -957,7 +957,7 @@ introduce accidental changes. Some good examples of scripted-diff: - [scripted-diff: Rename InitInterfaces to NodeContext](https://github.com/bitcoin/bitcoin/commit/301bd41a2e6765b185bd55f4c541f9e27aeea29d) -uses an elegant script to replace occurences of multiple terms in all source files. +uses an elegant script to replace occurrences of multiple terms in all source files. - [scripted-diff: Remove g_connman, g_banman globals](https://github.com/bitcoin/bitcoin/commit/301bd41a2e6765b185bd55f4c541f9e27aeea29d) replaces specific terms in a list of specific source files. @@ -1085,6 +1085,11 @@ A few guidelines for introducing and reviewing new RPC interfaces: new RPC is replacing a deprecated RPC, to avoid both RPCs confusingly showing up in the command list. +- Use *invalid* bech32 addresses for `RPCExamples` help documentation. + + - *Rationale*: Prevent accidental transactions by users and encourage the use + of bech32 addresses by default. + - Use the `UNIX_EPOCH_TIME` constant when describing UNIX epoch time or timestamps in the documentation. |