@vafanassieff/bitcoin-cli-ts/src/rpc/wallet/migrate-wallet.ts

Auto-generated Bitcoin client library for bitcoind JSON-RPC API

// Auto synced from github actions. Don't change this file

import { Bitcoind } from '../../types.js'
import request from '../../rpc-request.js'

type MigrateWalletParams = {
  bitcoind: Bitcoind
  /* The name of the wallet to migrate. If provided both here and in the RPC endpoint, the two must be identical. */
  wallet_name?: string
  /* The wallet passphrase */
  passphrase?: string
}

/**
 * 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.
 *
 */
export function migrateWallet(params: MigrateWalletParams) {
  const { bitcoind, ...methodParams } = params
  return request({ method: 'migratewallet', params: methodParams }, bitcoind)
}