[rpc] Give users one final warning before removing getinfo #10841

jnewbery · 2017-07-16T05:28:22Z

Alternative to #10838

This PR disables getinfo by default in v0.15.0. getinfo will return a string informing the user that getinfo is deprecated, but can be enabled in v0.15.0 by running with -enablegetinfo. v0.15.1 will remove getinfo entirely.

Should address @achow101's objection to #10838 by giving clients a final warning before removing the RPC in v0.15.1.

Draws a final line in the sand. getinfo will be gone in v0.15.1

@TheBlueMatt

TheBlueMatt · 2017-07-16T16:50:13Z

utACK 6c9f2c1c5326a158bffff8b4ca9822f6fdb81ca9, though I'd prefer to say that we'll disable it in 16, not 15.1.

achow101 · 2017-07-16T18:11:54Z

utACK 6c9f2c1c5326a158bffff8b4ca9822f6fdb81ca9

I also prefer that getinfo be actually disabled in 0.16.0 not 0.15.1.

sipa · 2017-07-16T19:04:27Z

Agree that we shouldn't remove getinfo in a minor release. I wouldn't explicitly name a version number in the source code either, just say it will be removed in a next release.

jnewbery · 2017-07-16T23:19:06Z

Yes, best practice would be to not make a breaking API change in a point release. Changed getinfo End Of Life to v0.16 as suggested.

@sipa - I prefer to have a hard EOL version. Users will ignore deprecation warnings if there is no hard date/release. Such is the way of the world. We can always slip v0.16 if there's a strongly compelling reason to retain getinfo.

Any feedback on the warning text?

return "getinfo is deprecated and will be fully removed in v0.16. To use getinfo in v0.15, restart bitcoind with -enablegetinfo.\n"
    "Projects should transition to using getblockchaininfo, getnetworkinfo and getwalletinfo before upgrading to v0.16";

TheBlueMatt · 2017-07-16T23:27:06Z

utACK dbcbb86

laanwj · 2017-07-17T06:10:09Z

test/functional/p2p-versionbits-warning.py

@@ -88,7 +88,6 @@ def run_test(self):
        self.nodes[0].generate(VB_PERIOD - VB_THRESHOLD + 1)
        # Check that we're not getting any versionbit-related errors in
        # get*info()
-        assert(not VB_PATTERN.match(self.nodes[0].getinfo()["errors"]))


errors moved to getblockchaininfo

laanwj · 2017-07-17T06:12:07Z

I think it's too late in the release window to be disabling this. ~~We'd probably wanted to have merged #8843 too in that case.~~

laanwj · 2017-07-17T07:34:36Z

An alternative that was proposed on IRC by @gmaxwell was to add a "nag": "This RPC will be deprecated." to the output with the message, instead of requiring a command-line argument. This would have less last-minute API impact (could still do this for 0.16).

@gmaxwell

1c9b818 getinfo deprecation warning (Andrew Chow) Pull request description: This is an alternative to #10841 This PR implements @gmaxwell's suggestion of a `nag` field for getinfo which warns about the deprecation. Instead of calling it `nag`, I have named it `deprecation-warning`. The output of `getinfo` will look like this: ``` { "version": 149900, "protocolversion": 70015, "walletversion": 139900, "balance": 0.00000000, "blocks": 476281, "timeoffset": 0, "connections": 2, "proxy": "", "difficulty": 804525194568.1318, "testnet": false, "keypoololdest": 1496858803, "keypoolsize": 197, "unlocked_until": 0, "paytxfee": 0.00000000, "relayfee": 0.00001000, "errors": "This is a pre-release test build - use at your own risk - do not use for mining or merchant applications", "deprecation-warning": "WARNING: getinfo is deprecated and will be fully removed in 0.16. Projects should transition to using getblockchaininfo, getnetworkinfo, and getwalletinfo before upgrading to 0.16" } ``` I think this should be tagged for 0.15 Tree-SHA512: ea1bac96a67f797519e8748ddd661cf0a1127cbc38f145b98f10cf9b54dcf0519b353062ce9888e1f51875497299c75ff5147566944451bc3fc117620e773489

048e0c3 [rpc] [tests] Add deprecated RPC test (Cristian Mircea Messel) d4cdbd6 [rpc] Deprecate estimatefee RPC (John Newbery) Pull request description: Deprecates estimatefee in v0.16, for final removal in v0.17. This commit introduces a phased removal of RPC methods. RPC method is disabled by default in version x, but can be enabled by using the `-deprecatedrpc=<methodname>` argument. RPC method is removed entirely in version (x+1). This gives users fair warning that an RPC is to be removed, and time to change client software if necessary. Deprecation warnings in RPC return values or release notes are easily ignored. This is a more generic version of the approach I tried to use in #10841, which too late to make it into v0.15. Tree-SHA512: 9695a600e84b812974387333e4a6805d18972da30befb754e9e4da77cd9815d00c5cc2ee0b0350bdbbdb5fdc6ba47789f8b2c6f5b15c8cd5a1deefcc4832da30

@gmaxwell

1c9b818 getinfo deprecation warning (Andrew Chow) Pull request description: This is an alternative to bitcoin#10841 This PR implements @gmaxwell's suggestion of a `nag` field for getinfo which warns about the deprecation. Instead of calling it `nag`, I have named it `deprecation-warning`. The output of `getinfo` will look like this: ``` { "version": 149900, "protocolversion": 70015, "walletversion": 139900, "balance": 0.00000000, "blocks": 476281, "timeoffset": 0, "connections": 2, "proxy": "", "difficulty": 804525194568.1318, "testnet": false, "keypoololdest": 1496858803, "keypoolsize": 197, "unlocked_until": 0, "paytxfee": 0.00000000, "relayfee": 0.00001000, "errors": "This is a pre-release test build - use at your own risk - do not use for mining or merchant applications", "deprecation-warning": "WARNING: getinfo is deprecated and will be fully removed in 0.16. Projects should transition to using getblockchaininfo, getnetworkinfo, and getwalletinfo before upgrading to 0.16" } ``` I think this should be tagged for 0.15 Tree-SHA512: ea1bac96a67f797519e8748ddd661cf0a1127cbc38f145b98f10cf9b54dcf0519b353062ce9888e1f51875497299c75ff5147566944451bc3fc117620e773489

@gmaxwell

1c9b818 getinfo deprecation warning (Andrew Chow) Pull request description: This is an alternative to bitcoin#10841 This PR implements @gmaxwell's suggestion of a `nag` field for getinfo which warns about the deprecation. Instead of calling it `nag`, I have named it `deprecation-warning`. The output of `getinfo` will look like this: ``` { "version": 149900, "protocolversion": 70015, "walletversion": 139900, "balance": 0.00000000, "blocks": 476281, "timeoffset": 0, "connections": 2, "proxy": "", "difficulty": 804525194568.1318, "testnet": false, "keypoololdest": 1496858803, "keypoolsize": 197, "unlocked_until": 0, "paytxfee": 0.00000000, "relayfee": 0.00001000, "errors": "This is a pre-release test build - use at your own risk - do not use for mining or merchant applications", "deprecation-warning": "WARNING: getinfo is deprecated and will be fully removed in 0.16. Projects should transition to using getblockchaininfo, getnetworkinfo, and getwalletinfo before upgrading to 0.16" } ``` I think this should be tagged for 0.15 Tree-SHA512: ea1bac96a67f797519e8748ddd661cf0a1127cbc38f145b98f10cf9b54dcf0519b353062ce9888e1f51875497299c75ff5147566944451bc3fc117620e773489

@gmaxwell

1c9b818 getinfo deprecation warning (Andrew Chow) Pull request description: This is an alternative to bitcoin#10841 This PR implements @gmaxwell's suggestion of a `nag` field for getinfo which warns about the deprecation. Instead of calling it `nag`, I have named it `deprecation-warning`. The output of `getinfo` will look like this: ``` { "version": 149900, "protocolversion": 70015, "walletversion": 139900, "balance": 0.00000000, "blocks": 476281, "timeoffset": 0, "connections": 2, "proxy": "", "difficulty": 804525194568.1318, "testnet": false, "keypoololdest": 1496858803, "keypoolsize": 197, "unlocked_until": 0, "paytxfee": 0.00000000, "relayfee": 0.00001000, "errors": "This is a pre-release test build - use at your own risk - do not use for mining or merchant applications", "deprecation-warning": "WARNING: getinfo is deprecated and will be fully removed in 0.16. Projects should transition to using getblockchaininfo, getnetworkinfo, and getwalletinfo before upgrading to 0.16" } ``` I think this should be tagged for 0.15 Tree-SHA512: ea1bac96a67f797519e8748ddd661cf0a1127cbc38f145b98f10cf9b54dcf0519b353062ce9888e1f51875497299c75ff5147566944451bc3fc117620e773489

@gmaxwell

1c9b818 getinfo deprecation warning (Andrew Chow) Pull request description: This is an alternative to bitcoin#10841 This PR implements @gmaxwell's suggestion of a `nag` field for getinfo which warns about the deprecation. Instead of calling it `nag`, I have named it `deprecation-warning`. The output of `getinfo` will look like this: ``` { "version": 149900, "protocolversion": 70015, "walletversion": 139900, "balance": 0.00000000, "blocks": 476281, "timeoffset": 0, "connections": 2, "proxy": "", "difficulty": 804525194568.1318, "testnet": false, "keypoololdest": 1496858803, "keypoolsize": 197, "unlocked_until": 0, "paytxfee": 0.00000000, "relayfee": 0.00001000, "errors": "This is a pre-release test build - use at your own risk - do not use for mining or merchant applications", "deprecation-warning": "WARNING: getinfo is deprecated and will be fully removed in 0.16. Projects should transition to using getblockchaininfo, getnetworkinfo, and getwalletinfo before upgrading to 0.16" } ``` I think this should be tagged for 0.15 Tree-SHA512: ea1bac96a67f797519e8748ddd661cf0a1127cbc38f145b98f10cf9b54dcf0519b353062ce9888e1f51875497299c75ff5147566944451bc3fc117620e773489

048e0c3 [rpc] [tests] Add deprecated RPC test (Cristian Mircea Messel) d4cdbd6 [rpc] Deprecate estimatefee RPC (John Newbery) Pull request description: Deprecates estimatefee in v0.16, for final removal in v0.17. This commit introduces a phased removal of RPC methods. RPC method is disabled by default in version x, but can be enabled by using the `-deprecatedrpc=<methodname>` argument. RPC method is removed entirely in version (x+1). This gives users fair warning that an RPC is to be removed, and time to change client software if necessary. Deprecation warnings in RPC return values or release notes are easily ignored. This is a more generic version of the approach I tried to use in bitcoin#10841, which too late to make it into v0.15. Tree-SHA512: 9695a600e84b812974387333e4a6805d18972da30befb754e9e4da77cd9815d00c5cc2ee0b0350bdbbdb5fdc6ba47789f8b2c6f5b15c8cd5a1deefcc4832da30

@gmaxwell

1c9b818 getinfo deprecation warning (Andrew Chow) Pull request description: This is an alternative to bitcoin#10841 This PR implements @gmaxwell's suggestion of a `nag` field for getinfo which warns about the deprecation. Instead of calling it `nag`, I have named it `deprecation-warning`. The output of `getinfo` will look like this: ``` { "version": 149900, "protocolversion": 70015, "walletversion": 139900, "balance": 0.00000000, "blocks": 476281, "timeoffset": 0, "connections": 2, "proxy": "", "difficulty": 804525194568.1318, "testnet": false, "keypoololdest": 1496858803, "keypoolsize": 197, "unlocked_until": 0, "paytxfee": 0.00000000, "relayfee": 0.00001000, "errors": "This is a pre-release test build - use at your own risk - do not use for mining or merchant applications", "deprecation-warning": "WARNING: getinfo is deprecated and will be fully removed in 0.16. Projects should transition to using getblockchaininfo, getnetworkinfo, and getwalletinfo before upgrading to 0.16" } ``` I think this should be tagged for 0.15 Tree-SHA512: ea1bac96a67f797519e8748ddd661cf0a1127cbc38f145b98f10cf9b54dcf0519b353062ce9888e1f51875497299c75ff5147566944451bc3fc117620e773489

048e0c3 [rpc] [tests] Add deprecated RPC test (Cristian Mircea Messel) d4cdbd6 [rpc] Deprecate estimatefee RPC (John Newbery) Pull request description: Deprecates estimatefee in v0.16, for final removal in v0.17. This commit introduces a phased removal of RPC methods. RPC method is disabled by default in version x, but can be enabled by using the `-deprecatedrpc=<methodname>` argument. RPC method is removed entirely in version (x+1). This gives users fair warning that an RPC is to be removed, and time to change client software if necessary. Deprecation warnings in RPC return values or release notes are easily ignored. This is a more generic version of the approach I tried to use in bitcoin#10841, which too late to make it into v0.15. Tree-SHA512: 9695a600e84b812974387333e4a6805d18972da30befb754e9e4da77cd9815d00c5cc2ee0b0350bdbbdb5fdc6ba47789f8b2c6f5b15c8cd5a1deefcc4832da30

jnewbery changed the title ~~[rpc] Give users one final warning before depracating getinfo~~ [rpc] Give users one final warning before removing getinfo Jul 16, 2017

fanquake added this to the 0.15.0 milestone Jul 16, 2017

fanquake added the RPC/REST/ZMQ label Jul 16, 2017

[rpc] Give users one final warning before depracating getinfo

dbcbb86

jnewbery force-pushed the deprecate_getinfo branch from 6c9f2c1 to dbcbb86 Compare July 16, 2017 23:17

jnewbery mentioned this pull request Jul 16, 2017

(finally) remove getinfo #10838

Merged

laanwj reviewed Jul 17, 2017

View reviewed changes

jnewbery closed this Jul 17, 2017

achow101 mentioned this pull request Jul 17, 2017

[RPC] Add a deprecation warning to getinfo's output #10857

Merged

jnewbery mentioned this pull request Aug 11, 2017

[rpc] deprecate estimatefee #11031

Merged

jnewbery mentioned this pull request Jan 16, 2018

rpc: Add deprecation error for getinfo #12198

Merged

bitcoin locked as resolved and limited conversation to collaborators Sep 8, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[rpc] Give users one final warning before removing getinfo #10841

[rpc] Give users one final warning before removing getinfo #10841

Uh oh!

jnewbery commented Jul 16, 2017

Uh oh!

TheBlueMatt commented Jul 16, 2017

Uh oh!

achow101 commented Jul 16, 2017

Uh oh!

sipa commented Jul 16, 2017 •

edited

Loading

Uh oh!

jnewbery commented Jul 16, 2017

Uh oh!

TheBlueMatt commented Jul 16, 2017

Uh oh!

laanwj Jul 17, 2017

Uh oh!

laanwj commented Jul 17, 2017 •

edited

Loading

Uh oh!

laanwj commented Jul 17, 2017 •

edited

Loading

Uh oh!

Uh oh!

[rpc] Give users one final warning before removing getinfo #10841

[rpc] Give users one final warning before removing getinfo #10841

Uh oh!

Conversation

jnewbery commented Jul 16, 2017

Uh oh!

TheBlueMatt commented Jul 16, 2017

Uh oh!

achow101 commented Jul 16, 2017

Uh oh!

sipa commented Jul 16, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jnewbery commented Jul 16, 2017

Uh oh!

TheBlueMatt commented Jul 16, 2017

Uh oh!

laanwj Jul 17, 2017

Choose a reason for hiding this comment

Uh oh!

laanwj commented Jul 17, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

laanwj commented Jul 17, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

sipa commented Jul 16, 2017 •

edited

Loading

laanwj commented Jul 17, 2017 •

edited

Loading

laanwj commented Jul 17, 2017 •

edited

Loading