diff options
| author | MarcoFalke <falke.marco@gmail.com> | 2019-04-15 11:20:50 -0400 |
|---|---|---|
| committer | MarcoFalke <falke.marco@gmail.com> | 2019-04-15 11:20:53 -0400 |
| commit | 2209b3ba25dea2dc461b5652b8733f93aec39ebf (patch) | |
| tree | ed5a40f4ddda430e113ddde4353e043bce00b335 | |
| parent | 2a854a17816675d258757061a2a7f6ed1de94fc1 (diff) | |
| parent | fa747498f79c9f6bf29b08f5f3cc01b276126abb (diff) | |
Merge #15799: doc: Clarify RPC versioning
fa747498f7 doc: Clarify RPC versioning (MarcoFalke)
Pull request description:
ACKs for commit fa7474:
Tree-SHA512: 4d374cc9ae77a06423acc9c73fe29f706f4349c548b17cb2414f15f72e0fc8c6ef7783ce099e938db2ab949717a4ef29e1aebc6aa09a350853d7f875b192ccb5
| -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, |