`encryptwallet`

Wallet

Summary

Encrypts the wallet with 'passphrase'. This is for first time encryption.

Description

Encrypts the wallet with 'passphrase'. This is for first time encryption. After this, any calls that interact with private keys such as sending or signing will require the passphrase to be set prior to making these calls. Use the walletpassphrase call for this, and then walletlock call. If the wallet is already encrypted, use the walletpassphrasechange call. ** IMPORTANT ** For security reasons, the encryption process will generate a new HD seed, resulting in the creation of a fresh set of active descriptors. Therefore, it is crucial to securely back up the newly generated wallet file using the backupwallet RPC.

Arguments

passphrase (STR, required): The pass phrase to encrypt the wallet with. It must be at least 1 character, but should be long.

Results

value (STR): A string with further instructions

Examples

Encrypt your wallet

qbit-cli encryptwallet "my pass phrase"

Now set the passphrase to use the wallet, such as for signing or sending QBT

qbit-cli walletpassphrase "my pass phrase"

Now we can do something like sign

qbit-cli signmessage "address" "test message"

Now lock the wallet again by removing the passphrase

qbit-cli walletlock

As a JSON-RPC call

curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "encryptwallet", "params": ["my pass phrase"]}' -H 'content-type: application/json' http://127.0.0.1:8352/