Skip to content

Commit fa74749

Browse files
author
MarcoFalke
committed
doc: Clarify RPC versioning
1 parent bb68abe commit fa74749

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

doc/JSON-RPC-interface.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,18 @@ The headless daemon `bitcoind` has the JSON-RPC API enabled by default, the GUI
55
option. In the GUI it is possible to execute RPC methods in the Debug Console
66
Dialog.
77

8+
## Versioning
9+
10+
The RPC interface might change from one major version of Bitcoin Core to the
11+
next. This makes the RPC interface implicitly versioned on the major version.
12+
The version tuple can be retrieved by e.g. the `getnetworkinfo` RPC in
13+
`version`.
14+
15+
Usually deprecated features can be re-enabled during the grace-period of one
16+
major version via the `-deprecatedrpc=` command line option. The release notes
17+
of a new major release come with detailed instructions on what RPC features
18+
were deprecated and how to re-enable them temporarily.
19+
820
## Security
921

1022
The RPC interface allows other programs to control Bitcoin Core,

0 commit comments

Comments
 (0)