🔲runes_estimateRbfOrder

The runes_estimateRbfOrder method currently only supports Etch orders. Support for Mint orders will be added soon.

You can use the runes_estimateRbfOrder method to estimate the cost of a speeding up a Rune mint or etch order for your user.

You can specify the order you wish to speed up, and the new fee rate to use for the mint/etch transactions, by passing an EsimateRbfOrderParams object to the method, with the below properties:

EsimateRbfOrderParamsDescription

orderId

a string representing the id of your mint or etch order. ℹī¸ the runes_mint & runes_etch methods will return the order id in their response objects.

network (ℹī¸ optional)

a string representing the Bitcoin network to use for the mint runes transactions: 'Mainnet' or 'Testnet'

newFeeRate

a number representing the new increased fee rate to set for the Rune mint transaction(s) or etch transaction, in sats per vbytes

ℹī¸ newFeeRate must be higher than the feeRate used for the initial runes_mint or runes_etch order execution, and the increase must be at least equal to the minimum relay fee (the lowest fee that the network will accept).

import { Wallet } from "sats-connect";

    const response = await Wallet.request('runes_runes_estimateRbfOrder', { 
      id: "ORDER_ID", 
      network?: "Mainnet",
      newFeeRate: 500 });

    if (response.status === 'success') {
      console.log(response.result.rbfAmount);
      console.log(response.result.fundingAddress);
    } else {
      console.error(response.error);
      alert('Error Fetching Estimate. See console for details.');
    }

The runes_estimateRbfOrder method will not trigger any operation or prompt your user to sign any transaction. It will return an EstimateRbfOrderResponse object, intended for you and your user to anticipate the cost of speeding up the order:

EstimateRbfOrderResponse Description

rbfCost

a number representing the total cost of speeding up the order using RBF at the specified newFeeRate This corresponds to the additional BTC amount required for Sats Connect to replace the stuck mint/etch transactions with new transactions broadcast at the higher fee rate.

fundingAddress

a string representing the BTC address which will collect the BTC amount required to speed up the order, and sign the replacement mint/etch transactions broadcast at the higher fee rate. ℹī¸ The runes_rbfOrder method will prompt your user to sign a transaction to send the required BTC amount to this funding address.

See the runes_rbfOrder method if you wish to speed up your Rune mint or etch order, and prompt your user to sign the funding transaction required to process the order at an increased fee rate.

Last updated