đ˛runes_getOrder
You can use the runes_getOrder
method to fetch the status of
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:
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'
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:
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 orderrunes_etch
for an etch order
state
A string representing the current status of your order
âšī¸See runes_mint
& runes_etch
for details on the rune order workflows
The possible values are:
new
when the order has only just been created, and your user has not broadcast a funding transaction yetpending
when the order awaits the confirmation of your user's funding transaction before being processedexecuting
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 thereason
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 addressstale
when the order status hasn't progressed from thenew
state for an extended period of time
reason
(âšī¸ optional)
If the order is in a failed
state, a string representing the reason for the failure
createdAt
the creation date for the order (this is the date when the runes_mint or runes_etch method was first invoked)
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.
Last updated