@vafanassieff/bitcoin-cli-ts/src/rpc/wallet/wallet-passphrase.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 WalletPassphraseParams = {
  bitcoind: Bitcoind
  /* The wallet passphrase */
  passphrase: string
  /* The time to keep the decryption key in seconds; capped at 100000000 (~3 years). */
  timeout: number
}

/**
 * walletpassphrase "passphrase" timeout
 *
 * Stores the wallet decryption key in memory for 'timeout' seconds.
 * This is needed prior to performing transactions related to private keys such as sending bitcoins
 * Note:
 * Issuing the walletpassphrase command while the wallet is already unlocked will set a new unlock
 * time that overrides the old one.
 *
 */
export function walletPassphrase(params: WalletPassphraseParams) {
  const { bitcoind, ...methodParams } = params
  return request({ method: 'walletpassphrase', params: methodParams }, bitcoind)
}