Quote a new LithosDex pool

post/dex/pools/create/check

What creating a pool with reserves amountX and amountY would do. tokenX is ERG for an ERG/token pool. All of it goes into the pool at genesis, at the price the two amounts set, and genesis gives this wallet a provision for all of the supply but 1,000,000 shares. Those shares are locked for good, and with them a millionth of the pool. An ERG/token pool box must always keep over 0.01 ERG, so a warning says when a full exit by its only provider would leave more than the locked share behind. Lists any pool already trading the pair.

Request body

LDPoolCreateRequest · application/json

tokenXstringrequired
ERG for an ERG/token pool, or a token/token pool's first token id
tokenYstringrequired
The pool's other token id
amountXstringrequired
The pool's reserve of X at genesis; nanoERG for ERG, at least 0.01 ERG
amountYstringrequired
▶
feeParamsLDFeeParams
Fee numerators over feeDenom. dexFeeNum stays in the pool; ergFeeNum / tokenFeeNum are set aside for liquidity providers.
- dexFeeNuminteger · int64required
- ergFeeNuminteger · int64required
- tokenFeeNuminteger · int64required
- feeDenominteger · int64required
  Denominator of every numerator above

Responses

200The quoteLDPoolCreateQuote▶

kindstringrequired
one ofn2tt2t
tokenXstringrequired
tokenYstringrequired
▶
feeParamsLDFeeParamsrequired
Fee numerators over feeDenom. dexFeeNum stays in the pool; ergFeeNum / tokenFeeNum are set aside for liquidity providers.
- dexFeeNuminteger · int64required
- ergFeeNuminteger · int64required
- tokenFeeNuminteger · int64required
- feeDenominteger · int64required
  Denominator of every numerator above
reserveXstringrequired
reserveYstringrequired
sharesstringrequired
The creator's provision: all of the genesis supply but lockedShares
lockedSharesstringrequired
Supply no provision may represent, so its share of the reserves is locked for good
lockedSharenumber · doublerequired
That supply's fraction of the pool
lockedErgstringrequired
nanoERG nobody can take back: the vault box, and a token/token pool box
▶
lockedTokensLDTokenAmount[]required
Tokens nobody can take back beyond the locked share: a token/token vault's one of each
- tokenIdstringrequired
- amountstringrequired
  Raw token units. Decimal string.
poolBoxValuestringrequired
vaultBoxValuestringrequired
provisionBoxValuestringrequired
nanoERG the provision box holds, which a redeem returns
totalErgRequiredstringrequired
nanoERG that leaves the wallet across the four transactions
▶
tokensRequiredLDTokenAmount[]required
- tokenIdstringrequired
- amountstringrequired
  Raw token units. Decimal string.
networkFeestringrequired
The four transactions' fees together
warningsstring[]required
Pools already trading this pair or why none were looked for, and an ERG/token pool's exit floor

400The request is malformed, names ERG as tokenY or one token twice, offers an ERG reserve under 0.01 ERG, or gives fees out of bounds.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

← PreviousA provision's fee history on a verified pool Next →Create a LithosDex pool

curl -X POST "http://localhost:9000/dex/pools/create/check" \ -H "Content-Type: application/json" \ -d '{ "tokenX": "string", "tokenY": "string", "amountX": "string", "amountY": "string", "feeParams": { "dexFeeNum": 9985, "ergFeeNum": 15, "tokenFeeNum": 15, "feeDenom": 10000 } }'

{ "kind": "n2t", "tokenX": "string", "tokenY": "string", "feeParams": { "dexFeeNum": 9985, "ergFeeNum": 15, "tokenFeeNum": 15, "feeDenom": 10000 }, "reserveX": "string", "reserveY": "string", "shares": "string", "lockedShares": "string", "lockedShare": 0, "lockedErg": "string", "lockedTokens": [ { "tokenId": "86e272f770aa4ef48ad7e6d6dbe98b5069edd8383a403a8edb3ceed8a3d5cea3", "amount": "152000000" } ], "poolBoxValue": "string", "vaultBoxValue": "string", "provisionBoxValue": "string", "totalErgRequired": "string", "tokensRequired": [ { "tokenId": "86e272f770aa4ef48ad7e6d6dbe98b5069edd8383a403a8edb3ceed8a3d5cea3", "amount": "152000000" } ], "networkFee": "string", "warnings": [ "string" ] }