From fa747498f79c9f6bf29b08f5f3cc01b276126abb Mon Sep 17 00:00:00 2001 From: MarcoFalke Date: Thu, 11 Apr 2019 15:53:06 -0400 Subject: [PATCH] doc: Clarify RPC versioning --- doc/JSON-RPC-interface.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/doc/JSON-RPC-interface.md b/doc/JSON-RPC-interface.md index 982afd5d563..a0cfe84a3e5 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,