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

runes_getOrder

Previousrunes_etchNextSpeed up a Rune Mint or Etch order

Last updated 5 months ago

You can use the runes_getOrder method to fetch the status of

  • a

  • a

You can specify the Rune mint or etch order whose status you wish to retrieve, by passing a GetOrderParams object to the method, with the below properties:

GetOrderParams
Description

orderId

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_getOrder', { 
      id: "ORDER_ID", 
      network?: "Mainnet" });

    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_getOrder method will not trigger any operation or prompt your user to sign any transaction. It will return a GetOrderResponse object, intended for you and your user to track the status of the order:

GetOrderResponse
Description

orderId

a string representing the id of your mint or etch order.

orderType

a string representing the nature of the order. The possible values are:

  • runes_mint for a mint order

  • runes_etch for an etch order

state

  • new when the order has only just been created, and your user has not broadcast a funding transaction yet

  • pending when the order awaits the confirmation of your user's funding transaction before being processed

  • executing when the order is being processed and the required runes mint/etch transactions are being broadcast.

  • complete when the order has been processed and all runes mint/etch transactions have been confirmed.

  • failed when the order has failed. See the reason property for the nature of the order failure.

  • refunded when the funding transaction for a failed order has been refunded to your user's specified refund address

  • stale when the order status hasn't progressed from the new state for an extended period of time

If the order is in a failed state, a string representing the reason for the failure

createdAt

fundingAddress

a string representing the BTC address which will collect the funds required to process the order, and sign the required mint/etch transactions to process the order.

a string representing the id of your mint or etch order. the & methods will return the order id in their response objects.

network ( optional)

A string representing the current status of your order See & for details on the rune order workflows The possible values are:

reason ( optional)

the creation date for the order (this is the date when the or method was first invoked)

🔲
Rune mint order
Rune etch order
â„šī¸
â„šī¸
â„šī¸
runes_mint
runes_etch
â„šī¸
runes_mint
runes_etch
runes_mint
runes_etch