wallet: walletpassphrase timeout to be set to MAX_SLEEP_TIME in non-mainnet

In this change we allow the timeout for walletpassphrase to be
set to MAX_SLEEP_TIME,
if set as 0 then we then use the MAX_SLEEP_TIME amount,
this will only happen in non-mainnet

context from PR 28403

added release notes for RPC Wallet

Also tests were modified to use the max timeout amount using timeout=0

Author: kevkevinpal

doc/release-notes-28454.md

@@ -0,0 +1,5 @@
+RPC Wallet
+----------
+
+- The `walletpassphrase` call will now uses the value of 100,000,000 seconds (~3 years)
+  if the user passes a `timeout` value of `0`. (#28454)

src/wallet/rpc/encrypt.cpp

@@ -5,6 +5,7 @@
 #include <rpc/util.h>
 #include <wallet/rpc/util.h>
 #include <wallet/wallet.h>
+#include <chainparams.h>
 
 
 namespace wallet {
@@ -18,7 +19,7 @@ RPCHelpMan walletpassphrase()
             "time that overrides the old one.\n",
                 {
                     {"passphrase", RPCArg::Type::STR, RPCArg::Optional::NO, "The wallet passphrase"},
-                    {"timeout", RPCArg::Type::NUM, RPCArg::Optional::NO, "The time to keep the decryption key in seconds; capped at 100000000 (~3 years)."},
+                    {"timeout", RPCArg::Type::NUM, RPCArg::Optional::NO, "The time to keep the decryption key in seconds; capped at 100000000 (~3 years), will use cap if 0 specified in non-mainnet."},
                 },
                 RPCResult{RPCResult::Type::NONE, "", ""},
                 RPCExamples{
@@ -59,6 +60,12 @@ RPCHelpMan walletpassphrase()
         }
         // Clamp timeout
         constexpr int64_t MAX_SLEEP_TIME = 100000000; // larger values trigger a macos/libevent bug?
+
+        // Allow sleep time to be set to max time by using zero in non mainnet
+        if (Params().GetChainType() != ChainType::MAIN && nSleepTime == 0) {
+            nSleepTime = MAX_SLEEP_TIME;
+        }
+
         if (nSleepTime > MAX_SLEEP_TIME) {
             nSleepTime = MAX_SLEEP_TIME;
         }

test/functional/wallet_createwallet.py

@@ -109,7 +109,7 @@ def run_test(self):
         assert_raises_rpc_error(-4, "Error: This wallet has no available keys", w4.getnewaddress)
         assert_raises_rpc_error(-4, "Error: This wallet has no available keys", w4.getrawchangeaddress)
         # Now set a seed and it should work. Wallet should also be encrypted
-        w4.walletpassphrase('pass', 60)
+        w4.walletpassphrase('pass', 0)
         if self.options.descriptors:
             w4.importdescriptors([{
                 'desc': descsum_create('wpkh(tprv8ZgxMBicQKsPcwuZGKp8TeWppSuLMiLe2d9PupB14QpPeQsqoj3LneJLhGHH13xESfvASyd4EFLJvLrG8b7DrLxEuV7hpF9uUc6XruKA1Wq/0h/*)'),
@@ -142,7 +142,7 @@ def run_test(self):
         self.nodes[0].createwallet(wallet_name='wblank', disable_private_keys=False, blank=True, passphrase='thisisapassphrase')
         wblank = node.get_wallet_rpc('wblank')
         assert_raises_rpc_error(-13, "Error: Please enter the wallet passphrase with walletpassphrase first.", wblank.signmessage, "needanargument", "test")
-        wblank.walletpassphrase('thisisapassphrase', 60)
+        wblank.walletpassphrase('thisisapassphrase', 0)
         assert_raises_rpc_error(-4, "Error: This wallet has no available keys", wblank.getnewaddress)
         assert_raises_rpc_error(-4, "Error: This wallet has no available keys", wblank.getrawchangeaddress)
 
@@ -151,7 +151,7 @@ def run_test(self):
         self.nodes[0].createwallet(wallet_name='w6', disable_private_keys=False, blank=False, passphrase='thisisapassphrase')
         w6 = node.get_wallet_rpc('w6')
         assert_raises_rpc_error(-13, "Error: Please enter the wallet passphrase with walletpassphrase first.", w6.signmessage, "needanargument", "test")
-        w6.walletpassphrase('thisisapassphrase', 60)
+        w6.walletpassphrase('thisisapassphrase', 0)
         w6.signmessage(w6.getnewaddress('', 'legacy'), "test")
         w6.keypoolrefill(1)
         # There should only be 1 key for legacy, 3 for descriptors

test/functional/wallet_descriptor.py

@@ -129,7 +129,7 @@ def run_test(self):
 
         # Encrypt wallet 0
         send_wrpc.encryptwallet('pass')
-        send_wrpc.walletpassphrase('pass', 10)
+        send_wrpc.walletpassphrase('pass', 0)
         addr = send_wrpc.getnewaddress()
         info2 = send_wrpc.getaddressinfo(addr)
         assert info1['hdmasterfingerprint'] != info2['hdmasterfingerprint']
@@ -143,7 +143,7 @@ def run_test(self):
             send_wrpc.getnewaddress()
 
         self.log.info("Test that unlock is needed when deriving only hardened keys in an encrypted wallet")
-        send_wrpc.walletpassphrase('pass', 10)
+        send_wrpc.walletpassphrase('pass', 0)
         send_wrpc.importdescriptors([{
             "desc": "wpkh(tprv8ZgxMBicQKsPd7Uf69XL1XwhmjHopUGep8GuEiJDZmbQz6o58LninorQAfcKZWARbtRtfnLcJ5MQ2AtHcQJCCRUcMRvmDUjyEmNUWwx8UbK/0h/*h)#y4dfsj7n",
             "timestamp": "now",

test/functional/wallet_dump.py

@@ -173,7 +173,7 @@ def run_test(self):
 
         # encrypt wallet, restart, unlock and dump
         self.nodes[0].encryptwallet('test')
-        self.nodes[0].walletpassphrase('test', 100)
+        self.nodes[0].walletpassphrase('test', 0)
         # Should be a no-op:
         self.nodes[0].keypoolrefill()
         self.nodes[0].dumpwallet(wallet_enc_dump)

test/functional/wallet_encryption.py

@@ -96,8 +96,8 @@ def run_test(self):
         passphrase_with_nulls = "Phrase\0With\0Nulls"
         self.nodes[0].walletpassphrasechange(passphrase2, passphrase_with_nulls)
         # walletpassphrasechange should not stop at null characters
-        assert_raises_rpc_error(-14, "wallet passphrase entered was incorrect", self.nodes[0].walletpassphrase, passphrase_with_nulls.partition("\0")[0], 10)
-        self.nodes[0].walletpassphrase(passphrase_with_nulls, 10)
+        assert_raises_rpc_error(-14, "wallet passphrase entered was incorrect", self.nodes[0].walletpassphrase, passphrase_with_nulls.partition("\0")[0], 0)
+        self.nodes[0].walletpassphrase(passphrase_with_nulls, 0)
         sig = self.nodes[0].signmessage(address, msg)
         assert self.nodes[0].verifymessage(address, sig, msg)
         self.nodes[0].walletlock()

test/functional/wallet_fundrawtransaction.py

@@ -582,7 +582,7 @@ def test_locked_wallet(self):
         wallet.encryptwallet("test")
 
         if self.options.descriptors:
-            wallet.walletpassphrase('test', 10)
+            wallet.walletpassphrase('test', 0)
             wallet.importdescriptors([{
                 'desc': descsum_create('wpkh(tprv8ZgxMBicQKsPdYeeZbPSKd2KYLmeVKtcFA7kqCxDvDR13MQ6us8HopUR2wLcS2ZKPhLyKsqpDL2FtL73LMHcgoCL7DXsciA8eX8nbjCR2eG/0h/*h)'),
                 'timestamp': 'now',
@@ -620,7 +620,7 @@ def test_locked_wallet(self):
         assert_raises_rpc_error(-4, "Transaction needs a change address, but we can't generate it.", wallet.fundrawtransaction, rawtx)
 
         # Refill the keypool.
-        wallet.walletpassphrase("test", 100)
+        wallet.walletpassphrase("test", 0)
         wallet.keypoolrefill(8) #need to refill the keypool to get an internal change address
         wallet.walletlock()
 
@@ -635,7 +635,7 @@ def test_locked_wallet(self):
         assert fundedTx["changepos"] != -1
 
         # Now we need to unlock.
-        wallet.walletpassphrase("test", 600)
+        wallet.walletpassphrase("test", 0)
         signedTx = wallet.signrawtransactionwithwallet(fundedTx['hex'])
         wallet.sendrawtransaction(signedTx['hex'])
         self.generate(self.nodes[1], 1)

test/functional/wallet_keypool.py

@@ -85,7 +85,7 @@ def run_test(self):
         assert_raises_rpc_error(-12, "Error: Keypool ran out, please call keypoolrefill first", nodes[0].getnewaddress)
 
         # put six (plus 2) new keys in the keypool (100% external-, +100% internal-keys, 1 in min)
-        nodes[0].walletpassphrase('test', 12000)
+        nodes[0].walletpassphrase('test', 0)
         nodes[0].keypoolrefill(6)
         nodes[0].walletlock()
         wi = nodes[0].getwalletinfo()
@@ -131,7 +131,7 @@ def run_test(self):
             nodes[0].getnewaddress()
         assert_raises_rpc_error(-12, "Keypool ran out", nodes[0].getnewaddress)
 
-        nodes[0].walletpassphrase('test', 100)
+        nodes[0].walletpassphrase('test', 0)
         nodes[0].keypoolrefill(100)
         wi = nodes[0].getwalletinfo()
         if self.options.descriptors:
@@ -170,7 +170,7 @@ def run_test(self):
         else:
             res = w2.importmulti([{'desc': desc, 'timestamp': 'now'}])
         assert_equal(res[0]['success'], True)
-        w1.walletpassphrase('test', 100)
+        w1.walletpassphrase('test', 0)
 
         res = w1.sendtoaddress(address=address, amount=0.00010000)
         self.generate(nodes[0], 1)