diff options
| author | MarcoFalke <falke.marco@gmail.com> | 2019-04-11 15:53:06 -0400 |
|---|---|---|
| committer | MarcoFalke <falke.marco@gmail.com> | 2019-04-15 11:20:16 -0400 |
| commit | fa747498f79c9f6bf29b08f5f3cc01b276126abb (patch) | |
| tree | 43687e358ed7d12009f567c9454ffd7e5045d654 | |
| parent | bb68abe784b9fd49bddf38105d142a31ef0f9e77 (diff) | |
| download | bitcoin-fa747498f79c9f6bf29b08f5f3cc01b276126abb.tar.xz | |
doc: Clarify RPC versioning
| -rw-r--r-- | doc/JSON-RPC-interface.md | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/JSON-RPC-interface.md b/doc/JSON-RPC-interface.md index 982afd5d56..a0cfe84a3e 100644 --- a/doc/JSON-RPC-interface.md +++ b/doc/JSON-RPC-interface.md @@ -5,6 +5,18 @@ The headless daemon `bitcoind` has the JSON-RPC API enabled by default, the GUI option. In the GUI it is possible to execute RPC methods in the Debug Console Dialog. +## Versioning + +The RPC interface might change from one major version of Bitcoin Core to the +next. This makes the RPC interface implicitly versioned on the major version. +The version tuple can be retrieved by e.g. the `getnetworkinfo` RPC in +`version`. + +Usually deprecated features can be re-enabled during the grace-period of one +major version via the `-deprecatedrpc=` command line option. The release notes +of a new major release come with detailed instructions on what RPC features +were deprecated and how to re-enable them temporarily. + ## Security The RPC interface allows other programs to control Bitcoin Core, |