@vafanassieff/bitcoin-cli-ts/src/rpc/wallet/psbt-bump-fee.ts

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

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

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

type PsbtBumpFeeParams = {
  bitcoind: Bitcoind
  /* The txid to be bumped */
  txid: string
  /* [
       {                       (json object)
         "address": amount,    (numeric or string, required) A key-value pair. The key (string) is the bitcoin address,
                               the value (float or string) is the amount in BTC
         ...
       },
       {                       (json object)
         "data": "hex",        (string, required) A key-value pair. The key must be "data", the value is hex-encoded data
       },
       ...
     ] */
  options?: Json
}

/**
 * psbtbumpfee "txid" ( options )
 *
 * Bumps the fee of an opt-in-RBF transaction T, replacing it with a new transaction B.
 * Returns a PSBT instead of creating and signing a new transaction.
 * An opt-in RBF transaction with the given txid must be in the wallet.
 * The command will pay the additional fee by reducing change outputs or adding inputs when necessary.
 * It may add a new change output if one does not already exist.
 * All inputs in the original transaction will be included in the replacement transaction.
 * The command will fail if the wallet or mempool contains a transaction that spends one of T's outputs.
 * By default, the new fee will be calculated automatically using the estimatesmartfee RPC.
 * The user can specify a confirmation target for estimatesmartfee.
 * Alternatively, the user can specify a fee rate in sat/vB for the new transaction.
 * At a minimum, the new fee rate must be high enough to pay an additional new relay fee (incrementalfee
 * returned by getnetworkinfo) to enter the node's mempool.
 * * WARNING: before version 0.21, fee_rate was in BTC/kvB. As of 0.21, fee_rate is in sat/vB. *
 *
 */
export function psbtBumpFee(params: PsbtBumpFeeParams) {
  const { bitcoind, ...methodParams } = params
  return request({ method: 'psbtbumpfee', params: methodParams }, bitcoind)
}