Resize a provision

post/dex/provisions/{boxId}/resizeapi_key

Change a provision's size without closing it. Bound it with maxAmountX / maxAmountY when increasing or minAmountX / minAmountY when decreasing. The provision gets a new box id, returned as boxId.

Path parameters

boxIdstringrequired
UTXO id of the provision box

Request body

LDResizeRequest · application/json

newSharesstringrequired
Size the provision should become. Must be positive — a resize to zero is a redemption. Decimal string.
maxAmountXstring
Most you will contribute on the ERG side, when increasing. Decimal string.
maxAmountYstring
Most you will contribute on the token side, when increasing. Decimal string.
minAmountXstring
Least you will take back on the ERG side, when decreasing. Decimal string.
minAmountYstring
Least you will take back on the token side, when decreasing. Decimal string.
expectedPoolBoxIdstring
The pool box this was quoted against
expectedVaultBoxIdstring
Vault box the quote was made against. A resize also flushes.
expectedProvisionBoxIdstring
The provision box this was quoted against

Responses

200Result of the resize transactionLDResizeResult▶

outcomestringrequired
Node submission outcome; uncertain retains the known transaction ID and input ownership.
one ofacceptedrejecteduncertain
boxIdstringrequired
New provision box id. Use it for the next request.
newSharesstringrequired
amountXstringrequired
amountYstringrequired
txIdstringrequired

400Malformed body, or `newShares` is not a different positive size.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 pool, vault or provision moved. Re-read and quote 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

422Falls outside the given bounds, or the pool refuses the resize.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 provision resize Next →Check a pending fee flush

curl -X POST "http://localhost:9000/dex/provisions/{boxId}/resize" \ -H "api_key: $LITHOS_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "newShares": "20000000000", "maxAmountX": "31875000000", "maxAmountY": "963000000", "minAmountX": "21250000000", "minAmountY": "642000000", "expectedPoolBoxId": "a1f4c2e8b7d93052416fbc8e07d21935a8c4f60b2e91d7385c06a4b1f2e83d97", "expectedVaultBoxId": "88c297f99da7172f6aa20efbead69aa40e2b7734a1873d66ca1db6b19d214db6", "expectedProvisionBoxId": "ce00d6e0f4fd3390c0519bb0d24824e1e6b06978163f4845a7cf2c1c7d8f1b65" }'

{ "outcome": "accepted", "boxId": "ce00d6e0f4fd3390c0519bb0d24824e1e6b06978163f4845a7cf2c1c7d8f1b65", "newShares": "20000000000", "amountX": "31875000000", "amountY": "963000000", "txId": "40b7d045a858d537cdbf072e46ffbb86c0c9f6b0e93c369c1ffcba76797636d7" }