migratewallet

migratewallet ( "wallet_name" "passphrase" ) Migrate the wallet to a descriptor wallet. A new wallet backup will need to be made. The migration process will create a backup of the wallet before migrating. This backup file will be named <wallet name>-<timestamp>.legacy.bak and can be found in the directory for this wallet. In the event of an incorrect migration, the backup can be restored using restorewallet. Encrypted wallets must have the passphrase provided as an argument to this call. This RPC may take a long time to complete. Increasing the RPC client timeout is recommended. Arguments: 1. wallet_name (string, optional, default=the wallet name from the RPC endpoint) The name of the wallet to migrate. If provided both here and in the RPC endpoint, the two must be identical. 2. passphrase (string, optional) The wallet passphrase Result: { (json object) "wallet_name" : "str", (string) The name of the primary migrated wallet "watchonly_name" : "str", (string, optional) The name of the migrated wallet containing the watchonly scripts "solvables_name" : "str", (string, optional) The name of the migrated wallet containing solvable but not watched scripts "backup_path" : "str" (string) The location of the backup of the original wallet } Examples: > bitcoin-cli migratewallet > curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "migratewallet", "params": []}' -H 'content-type: application/json' http://127.0.0.1:8332/

Signature

migratewallet(wallet_name?: string, passphrase?: string) → any

Code samples

curl --user "$RPC_USER:$RPC_PASS" \
  --data-binary '{"jsonrpc":"1.0","id":"docs","method":"migratewallet","params":["the wallet name from the RPC endpoint","\"<passphrase>\""]}' \
  -H 'content-type: text/plain;' \
  http://127.0.0.1:8332/

bitcoin-cli migratewallet

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

import requests
r = requests.post(
    "http://127.0.0.1:8332/",
    auth=("$RPC_USER", "$RPC_PASS"),
    json={
        "jsonrpc": "1.0",
        "id": "docs",
        "method": "migratewallet",
        "params": ["the wallet name from the RPC endpoint", "\"<passphrase>\""],
    },
    timeout=30,
)
print(r.json())

const res = await fetch("http://127.0.0.1:8332/", {
  method: "POST",
  headers: {
    "content-type": "application/json",
    "authorization": "Basic " + btoa(`${process.env.RPC_USER}:${process.env.RPC_PASS}`),
  },
  body: JSON.stringify({
    jsonrpc: "1.0",
    id: "docs",
    method: "migratewallet",
    params: ["the wallet name from the RPC endpoint","\"<passphrase>\""],
  }),
});
console.log(await res.json());

Parameters

Name	Type	Req.	Description
wallet_name	`string`	—	The name of the wallet to migrate. If provided both here and in the RPC endpoint, the two must be identical.
passphrase	`string`	—	The wallet passphrase

Result

Type: any

{ (json object) "wallet_name" : "str", (string) The name of the primary migrated wallet "watchonly_name" : "str", (string, optional) The name of the migrated wallet containing the watchonly scripts "solvables_name" : "str", (string, optional) The name of the migrated wallet containing solvable but not watched scripts "backup_path" : "str" (string) The location of the backup of the original wallet }

Source: services/core-node/bcore/src/wallet/rpc/wallet.cpp:667

C++ symbol: migratewallet

Code samples

curl --user "$RPC_USER:$RPC_PASS" \
  --data-binary '{"jsonrpc":"1.0","id":"docs","method":"migratewallet","params":["the wallet name from the RPC endpoint","\"<passphrase>\""]}' \
  -H 'content-type: text/plain;' \
  http://127.0.0.1:8332/

bitcoin-cli migratewallet

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

import requests
r = requests.post(
    "http://127.0.0.1:8332/",
    auth=("$RPC_USER", "$RPC_PASS"),
    json={
        "jsonrpc": "1.0",
        "id": "docs",
        "method": "migratewallet",
        "params": ["the wallet name from the RPC endpoint", "\"<passphrase>\""],
    },
    timeout=30,
)
print(r.json())

const res = await fetch("http://127.0.0.1:8332/", {
  method: "POST",
  headers: {
    "content-type": "application/json",
    "authorization": "Basic " + btoa(`${process.env.RPC_USER}:${process.env.RPC_PASS}`),
  },
  body: JSON.stringify({
    jsonrpc: "1.0",
    id: "docs",
    method: "migratewallet",
    params: ["the wallet name from the RPC endpoint","\"<passphrase>\""],
  }),
});
console.log(await res.json());