Sats Connect - Wallet API for Bitcoin & Stacks
  • Introduction
  • Wallet Providers
    • getInfo
    • getProviders & getProviderById
  • Connecting to the wallet
    • Connect to Xverse Wallet
    • Disconnect from Xverse Wallet
    • Connect to other wallets
      • Manage a user's default wallet
    • [Legacy âš ī¸] getAccounts
  • Wallet Methods
    • request methods
    • wallet_getAccount
    • wallet_getNetwork
    • wallet_changeNetwork
    • Xverse Custom Methods
  • Xverse Wallet Permissions
  • Xverse Wallet events
  • BITCOIN METHODS
    • 🟠getAddresses
    • 🟠signMessage
    • 🟠signPsbt
    • 🟠sendTransfer
    • 🟠signMultipleTransactions
    • 🟠getBalance
    • 🎨createInscription
    • 🎨createRepeatInscriptions
    • 🎨ord_getInscriptions
    • 🎨ord_sendInscriptions
    • 🔲runes_getBalance
    • 🔲runes_transfer
    • 🔲Mint Runes
      • runes_estimateMint
      • runes_mint
    • 🔲Etch Runes
      • runes_estimateEtch
      • runes_etch
    • 🔲runes_getOrder
    • 🔲Speed up a Rune Mint or Etch order
      • 🔲runes_estimateRbfOrder
      • 🔲runes_rbfOrder
  • STACKS METHODS
    • 🔴stx_getAccounts
    • 🔴stx_signMessage
    • 🔴stx_signStructuredMessage
    • 🔴stx_transferStx
    • 🔴stx_signTransaction
    • 🔴stx_callContract
    • 🔴stx_deployContract
  • GUIDES
    • Verify Bitcoin message signatures
    • Creating Bitcoin PSBTs
    • 📱Mobile Integration
    • Next.js support
  • RESOURCES
    • App Template
    • Demo App
    • Changelog
    • Github Issues
    • Developer forum
    • BIP322
Powered by GitBook
On this page
  1. BITCOIN METHODS
  2. Mint Runes

runes_estimateMint

Use the runes_estimateMint method to estimate the cost of a Rune mint order for your user, before executing it.

You can specify the characteristics of the Runes mint order you wish to estimate, by passing an EstimateMintParams object to the method, with the below properties:

EstimateMintParams
Description

runeName

repeats

destinationAddress

feeRate

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

a number representing the sats value of the fee to charge your user for your service.

a string representing the Bitcoin address which will receive the appServiceFee, if a fee is specified

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

import { request } from "sats-connect";

    const response = await request('runes_estimateMint', {
      destinationAddress: ordinalsAddress,
      feeRate: +feeRate,
      repeats: +repeats,
      runeName: runeName,
    });

    if (response.status === 'success') {
      setTotalCost(response.result.totalCost);
      setTotalSize(response.result.totalSize);
    } else {
      console.error(response.error);
      alert('Error Fetching Estimate. See console for details.');
    }

The runes_estimateMint method will not trigger any mint operation or prompt your user to sign any transaction. It will return an EstimateMintResponse object, intended for you and your user to anticipate the mint costs and their breakdown:

EstimateMintResponse property
Description

totalSize

a number representing the total size of the mint transaction(s), in vbytes

totalCost

a number representing the total cost of the mint transaction(s) in sats

costBreakdown

An object representing the cost breakdown of the mint transaction(s), with the below properties:

  • postage a number representing the total size of the Rune UTXOs minted, in sats

  • networkFee a number representing the total network fee for the mint transaction(s), in sats

  • serviceFee a number representing the total Sats Connect fee for processing the mint order, in sats

  • appServiceFee a number representing the optional service fee your app charges the user for the mint order

PreviousMint RunesNextrunes_mint

Last updated 4 months ago

a string representing the to mint

a number representing the number of mint transactions to create. Every mint transaction creates a of new units of a rune, you can use repeats to mint a multiple of that amount. Note that there is a 4000 repeat limit per order

The Bitcoin address to which the minted runes should be allocated. If minting Runes for your user, you can fetch their wallet addresses with the method. We recommend managing runes holdings on taproot/ordinal addresses.

appServiceFee ( optional)

appServiceFeeAddress ( optional)

network ( optional)

See the method if you wish to execute a Runes mint order after estimating its cost.

🔲
runes_mint
â„šī¸
â„šī¸
â„šī¸
name of the Rune
â„šī¸
fixed amount
â„šī¸
âš ī¸
getAccounts