Place a redeem order

post/dex/orders/redeemapi_key

Move a provision's ownerNFT into an order that any miner can fill for executorFee, closing the provision and paying the owner its share of the reserves. Settled fees are claimed in the same transaction; fees not yet flushed, and any earned while the order waits, are lost when it fills. Until then the provision cannot be claimed, resized or redeemed directly.

Request body

LDRedeemOrderRequest · application/json

provisionBoxIdstringrequired
executorFeestring
nanoERG paid to whoever fills the order, out of the ERG it releases. A fill broadcast to the mempool pays its miner fee out of this. Miners skip orders paying less than they accept. Omit for the client's default. Decimal string.
maxMinerFeestring
Most nanoERG a fill may pay as a miner fee, out of executorFee. Must be below executorFee. Omit for the client's default. Decimal string.

Responses

200The placement transaction and the order it createdLDOrderPlacementResult▶

outcomestringrequired
Node submission outcome; uncertain retains the known transaction ID and input ownership.
one ofacceptedrejecteduncertain
txIdstringrequired
▶
orderLDOrderrequired
An outstanding LithosDex order owned by this wallet. Which term fields are present depends on type.
- boxIdstringrequired
  Order box id. Pass it to POST /dex/orders/{boxId}/cancel.
- typestringrequired
  one ofSWAPDEPOSITREDEEM
- statusstringrequired
  PENDING: the placement is unconfirmed. OPEN: placed and waiting for a fill. FILLING: an unconfirmed transaction fills it. CANCELLING: an unconfirmed transaction cancels it. Only PENDING and OPEN orders can be cancelled.
  one ofPENDINGOPENFILLINGCANCELLING
- placementTxIdstringrequired
  Transaction that created the order box
- placedHeightinteger · int32
  Height the placement confirmed at. Absent while it is unconfirmed.
- spendingTxIdstring
  The unconfirmed transaction filling or cancelling the order. Present when FILLING or CANCELLING.
- ownerstringrequired
  Address that receives the fill, and the only key that can cancel
- valuestringrequired
  nanoERG held by the order box. Decimal string.
- executorFeestringrequired
  nanoERG the order pays whoever fills it. Decimal string.
- maxMinerFeestringrequired
  Most nanoERG a fill may pay as a miner fee, out of executorFee. Decimal string.
- ergInboolean
  SWAP only. True when selling ERG for the token.
- amountInstring
  SWAP only. nanoERG or raw token units sold into the pool. Decimal string.
- minOutputstring
  SWAP only. Least the owner receives: tokens when selling ERG, or nanoERG after executorFee when selling the token. Decimal string.
- amountXstring
  DEPOSIT only. Most nanoERG offered to the reserves. Decimal string.
- amountYstring
  DEPOSIT only. Raw token units offered. Decimal string.
- minSharesstring
  DEPOSIT only. Fewest shares the order accepts. Decimal string.
- ownerNFTstring
  REDEEM only. Ownership NFT of the provision the order closes.
- provisionBoxIdstring
  REDEEM only. Current box of that provision. Absent when it cannot be found.
- fillableNowbooleanrequired
  Whether the order would fill against the current pool. False when the pool cannot meet the order's minimum or refuses it; the order waits until that changes or it is cancelled. Always true while FILLING and false while CANCELLING.
claimedXstring
REDEEM only. Settled ERG fees the placement claimed. Decimal string.
claimedYstring
REDEEM only. Token side of claimedX. Decimal string.

400Malformed body, or a `maxMinerFee` not below `executorFee`.ApiError▶

errorintegerrequired
Error code
reasonstringrequired
Error message explaining the reason of the error
detailstringrequirednullable
Detailed error description

404No live provision with that id.ApiError▶

errorintegerrequired
Error code
reasonstringrequired
Error message explaining the reason of the error
detailstringrequirednullable
Detailed error description

409The vault or provision moved. Re-read and try again.LDStateChangedResponse▶

errorintegerrequired
reasonstringrequired
detailstringrequired
What moved, and what it moved to
poolBoxIdstring
Current pool box id
vaultBoxIdstring
Current vault box id
provisionBoxIdstring
Current provision box id

422Closing the provision would take supply under the pool's minimum, the vault cannot pay the fees the placement claims, this wallet does not hold its `ownerNFT`, or the wallet cannot cover the network fee. ApiError▶

errorintegerrequired
Error code
reasonstringrequired
Error message explaining the reason of the error
detailstringrequirednullable
Detailed error description

503Node or wallet unavailable. Retry.ApiError▶

errorintegerrequired
Error code
reasonstringrequired
Error message explaining the reason of the error
detailstringrequirednullable
Detailed error description

defaultErrorApiError▶

errorintegerrequired
Error code
reasonstringrequired
Error message explaining the reason of the error
detailstringrequirednullable
Detailed error description

← PreviousQuote a redeem order Next →Cancel an order

curl -X POST "http://localhost:9000/dex/orders/redeem" \ -H "api_key: $LITHOS_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "provisionBoxId": "ce00d6e0f4fd3390c0519bb0d24824e1e6b06978163f4845a7cf2c1c7d8f1b65", "executorFee": "3000000", "maxMinerFee": "1000000" }'

{ "outcome": "accepted", "txId": "40b7d045a858d537cdbf072e46ffbb86c0c9f6b0e93c369c1ffcba76797636d7", "order": { "boxId": "5035b2e112b4f5b873dd3444c01df1e7e697807fd84fe96790eacb128e46428d", "type": "SWAP", "status": "OPEN", "placementTxId": "40b7d045a858d537cdbf072e46ffbb86c0c9f6b0e93c369c1ffcba76797636d7", "placedHeight": 484719, "spendingTxId": "9f3c1ab7d2e45806c91f7b3ad4e2091856cbf740e3a92d5178cc0b46e21f5d38", "owner": "3WwbzR34YmLRy3Z6WLON5hBBkX8Zm1gUHmC7tEXDNRJfHBqhsZr", "value": "1004000000", "executorFee": "3000000", "maxMinerFee": "1000000", "ergIn": true, "amountIn": "1000000000", "minOutput": "29974258", "amountX": "5000000000", "amountY": "152000000", "minShares": "1170587", "ownerNFT": "a1f4c2e8b7d93052416fbc8e07d21935a8c4f60b2e91d7385c06a4b1f2e83d97", "provisionBoxId": "ce00d6e0f4fd3390c0519bb0d24824e1e6b06978163f4845a7cf2c1c7d8f1b65", "fillableNow": true }, "claimedX": "253000000", "claimedY": "7690000" }