Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adhere DEX order to limit order behaviour with multiple counter orders support #14

Merged
merged 14 commits into from
Sep 13, 2021
Merged

Adhere DEX order to limit order behaviour with multiple counter orders support #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
9f9835c
comments;
greenhat May 7, 2020
f145b10
Merge branch 'dex-limit-order' into dex-limit-order-multiple-counter
greenhat May 7, 2020
ca88e94
calc full spread instead of spread per token;
greenhat May 7, 2020
fd95cc3
draft buyer contract for multiple counter orders;
greenhat May 7, 2020
be35c61
rewrite buy order contract full spread accumulation;
greenhat May 7, 2020
495c5ec
remove unused import;
greenhat May 9, 2020
f9fd75c
implement boxesAreSortedByTokenPrice;
greenhat May 10, 2020
65db8a8
draft fullSpread for seller contract;
greenhat May 10, 2020
43095cb
move TODOs to PR desc;
greenhat May 10, 2020
e9e9505
formatting;
greenhat May 11, 2020
e479862
add missing new(residual) order box requirements(registers)
greenhat May 18, 2020
31b6bac
fix missing checks for residual sell order box;
greenhat May 18, 2020
e42b5f1
for sell order contract require spread only if strictly "younger" than
greenhat May 18, 2020
152ede5
update Scastie link;
greenhat Jun 2, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ Enjoy:

### DEX with partial filling contracts

[Run in Scastie](https://scastie.scala-lang.org/YCzvl8NBQwa7R0pVI5mHnA)
[Run in Scastie](https://scastie.scala-lang.org/mh3h6SrESnKJwdqZjKnVkw)

[Source code](https://github.com/ergoplatform/ergo-playgrounds/blob/c91117ae0b1434b7a554028592e30a5bba15a14b/playgrounds/src/main/scala/org/ergoplatform/playgrounds/examples/AssetsAtomicExchangePlayground.scala#L1-L1)
[Source code](https://github.com/ergoplatform/ergo-playgrounds/blob/e42b5f14e9bfc50be27d69db44e40e17a3d7e58f/playgrounds/src/main/scala/org/ergoplatform/playgrounds/examples/DEXPlayground.scala#L3)

### Assets Atomic Exchange contracts

Expand Down
149 changes: 95 additions & 54 deletions playgrounds/src/main/scala/org/ergoplatform/playgrounds/examples/DEXPlayground.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,52 +30,64 @@ object DEXPlayground {
}
}

// TODO: only part of it is matched
// TODO: for multiplse sell orders sort by price
// val spendingSellOrderTokenInfo = spendingSellOrders.map { (b: Box) =>
// (b.tokens(0)._2, b.R5[Long].get)
// }
// val totalSpendingSellOrdersValue = spendingSellOrderTokenInfo.fold(0L, { (acc: Long, t: (Long, Long)) =>
// acc + (t._1 * t._2)
// })

val returnBoxes = OUTPUTS.filter { (b: Box) =>
b.R4[Coll[Byte]].isDefined && b.R4[Coll[Byte]].get == SELF.id && b.propositionBytes == buyerPk.propBytes
}

returnBoxes.size == 1 && {
val boxesAreSortedByTokenPrice = { (boxes: Coll[Box]) =>
boxes.fold((0L, true), { (t: (Long, Boolean), box: Box) =>
val prevBoxTokenPrice = t._1
val isSorted = t._2
val boxTokenPrice = box.R5[Long].getOrElse(0L)
(boxTokenPrice, isSorted && boxTokenPrice >= prevBoxTokenPrice)
})._2
}

returnBoxes.size == 1 && spendingSellOrders.size > 0 && boxesAreSortedByTokenPrice(spendingSellOrders) && {
val returnBox = returnBoxes(0)
val returnTokenAmount = if (returnBox.tokens.size == 1) returnBox.tokens(0)._2 else 0L

val expectedDexFee = dexFeePerToken * returnTokenAmount

val foundNewOrderBoxes = OUTPUTS.filter { (b: Box) =>
val contractParametersAreCorrect = b.R4[Coll[Byte]].get == tokenId && b.R5[Long].get == tokenPrice
b.R6[Coll[Byte]].isDefined && b.R6[Coll[Byte]].get == SELF.id && b.propositionBytes == SELF.propositionBytes
val tokenIdParameterIsCorrect = b.R4[Coll[Byte]].isDefined && b.R4[Coll[Byte]].get == tokenId
val tokenPriceParameterIsCorrect = b.R5[Long].isDefined && b.R5[Long].get == tokenPrice
val dexFeePerTokenParameterIsCorrect = b.R6[Long].isDefined && b.R6[Long].get == dexFeePerToken
val contractParametersAreCorrect = tokenIdParameterIsCorrect && tokenPriceParameterIsCorrect
val referenceMe = b.R7[Coll[Byte]].isDefined && b.R7[Coll[Byte]].get == SELF.id
val guardedByTheSameContract = b.propositionBytes == SELF.propositionBytes
contractParametersAreCorrect && referenceMe && guardedByTheSameContract
}

val spreadPerToken = {
if (spendingSellOrders.size == 1) {
val sellOrder = spendingSellOrders(0)
val fullSpread = {
spendingSellOrders.fold((returnTokenAmount, 0L), { (t: (Long, Long), sellOrder: Box) =>
val returnTokensLeft = t._1
val accumulatedFullSpread = t._2
val sellOrderTokenPrice = sellOrder.R5[Long].get
// TODO: if both orders were in the same block who gets the spread?
if (sellOrder.creationInfo._1 >=SELF.creationInfo._1 && sellOrderTokenPrice <=tokenPrice)
tokenPrice - sellOrderTokenPrice
else
0L
} else
0L
val sellOrderTokenAmount = sellOrder.tokens(0)._2
if (sellOrder.creationInfo._1 >= SELF.creationInfo._1 && sellOrderTokenPrice <= tokenPrice) {
// spread is ours
val spreadPerToken = tokenPrice - sellOrderTokenPrice
val tokenAmount = min(returnTokensLeft, sellOrderTokenAmount)
val sellOrderSpread = spreadPerToken * tokenAmount
(returnTokensLeft - tokenAmount, accumulatedFullSpread + sellOrderSpread)
}
else {
// spread is not ours
(returnTokensLeft - min(returnTokensLeft, sellOrderTokenAmount), accumulatedFullSpread)
}
})._2
}

val totalMatching = (SELF.value - expectedDexFee) == returnTokenAmount * tokenPrice &&
returnBox.value >=returnTokenAmount * spreadPerToken
returnBox.value >= fullSpread
val partialMatching = {
foundNewOrderBoxes.size == 1 &&
foundNewOrderBoxes(0).value == (SELF.value - returnTokenAmount * tokenPrice - expectedDexFee) &&
returnBox.value >=returnTokenAmount * spreadPerToken
returnBox.value >= fullSpread
}

val coinsSecured = partialMatching ||totalMatching
val coinsSecured = partialMatching || totalMatching

val tokenIdIsCorrect = returnBox.tokens.getOrElse(0, (Coll[Byte](), 0L))._1 == tokenId

Expand Down Expand Up @@ -113,32 +125,57 @@ object DEXPlayground {
b.R4[Coll[Byte]].isDefined && b.R4[Coll[Byte]].get == SELF.id && b.propositionBytes == sellerPk.propBytes
}

returnBoxes.size == 1 && {
val returnBox = returnBoxes(0)
val spendingBuyOrders = INPUTS.filter { (b: Box) =>
b.R4[Coll[Byte]].isDefined && b.R5[Long].isDefined && {
val buyOrderTokenId = b.R4[Coll[Byte]].get
buyOrderTokenId == tokenId && {
b.tokens.size == 1 && b.tokens(0)._1 == tokenId
}
}
val boxesAreSortedByTokenPrice = { (boxes: Coll[Box]) =>
boxes.fold((0L, true), { (t: (Long, Boolean), box: Box) =>
val prevBoxTokenPrice = t._1
val isSorted = t._2
val boxTokenPrice = box.R5[Long].getOrElse(0L)
(boxTokenPrice, isSorted && boxTokenPrice >= prevBoxTokenPrice)
})._2
}

val spendingBuyOrders = INPUTS.filter { (b: Box) =>
b.R4[Coll[Byte]].isDefined && b.R5[Long].isDefined && b.R6[Long].isDefined && {
val buyOrderTokenId = b.R4[Coll[Byte]].get
buyOrderTokenId == tokenId && b.tokens.size == 0
}
}

val buyOrder = spendingBuyOrders(0)
returnBoxes.size == 1 && spendingBuyOrders.size > 0 && boxesAreSortedByTokenPrice(spendingBuyOrders) && {
val returnBox = returnBoxes(0)

val foundNewOrderBoxes = OUTPUTS.filter { (b: Box) =>
val contractParametersAreCorrect = b.R4[Coll[Byte]].get == tokenId && b.R5[Long].get == tokenPrice
val contractIsTheSame = b.propositionBytes == SELF.propositionBytes
b.R6[Coll[Byte]].isDefined && b.R6[Coll[Byte]].get == SELF.id && contractIsTheSame
val tokenIdParameterIsCorrect = b.R4[Coll[Byte]].isDefined && b.R4[Coll[Byte]].get == tokenId
val tokenPriceParameterIsCorrect = b.R5[Long].isDefined && b.R5[Long].get == tokenPrice
val dexFeePerTokenParameterIsCorrect = b.R6[Long].isDefined && b.R6[Long].get == dexFeePerToken
val contractParametersAreCorrect = tokenIdParameterIsCorrect && tokenPriceParameterIsCorrect
val referenceMe = b.R7[Coll[Byte]].isDefined && b.R7[Coll[Byte]].get == SELF.id
val guardedByTheSameContract = b.propositionBytes == SELF.propositionBytes
contractParametersAreCorrect && referenceMe && guardedByTheSameContract
}

val buyOrderTokenPrice = buyOrder.R5[Long].get
val spreadPerToken = if (buyOrder.creationInfo._1 > SELF.creationInfo._1)
buyOrderTokenPrice - tokenPrice
else
0L
val fullSpread = { (tokenAmount: Long) =>
spendingBuyOrders.fold((tokenAmount, 0L), { (t: (Long, Long), buyOrder: Box) =>
val returnTokensLeft = t._1
val accumulatedFullSpread = t._2
val buyOrderTokenPrice = buyOrder.R5[Long].get
val buyOrderDexFeePerToken = buyOrder.R6[Long].get
val buyOrderTokenAmount = buyOrder.value / (buyOrderTokenPrice + buyOrderDexFeePerToken)
if (buyOrder.creationInfo._1 > SELF.creationInfo._1 && buyOrderTokenPrice <= tokenPrice) {
// spread is ours
val spreadPerToken = tokenPrice - buyOrderTokenPrice
val tokenAmountLeft = min(returnTokensLeft, buyOrderTokenAmount)
val buyOrderSpread = spreadPerToken * tokenAmountLeft
(returnTokensLeft - tokenAmountLeft, accumulatedFullSpread + buyOrderSpread)
}
else {
// spread is not ours
(returnTokensLeft - min(returnTokensLeft, buyOrderTokenAmount), accumulatedFullSpread)
}
})._2
}

val totalMatching = (returnBox.value == selfTokenAmount * (tokenPrice + spreadPerToken))
val totalMatching = (returnBox.value == selfTokenAmount * tokenPrice + fullSpread(selfTokenAmount))

val partialMatching = {
foundNewOrderBoxes.size == 1 && {
Expand All @@ -153,12 +190,12 @@ object DEXPlayground {
val tokenIdIsCorrect = newOrderTokenId == tokenId

val newOrderValueIsCorrect = newOrderBox.value == (SELF.value - expectedDexFee)
val returnBoxValueIsCorrect = returnBox.value == soldTokenAmount * (tokenPrice + spreadPerToken)
val returnBoxValueIsCorrect = returnBox.value == soldTokenAmount * tokenPrice + fullSpread(soldTokenAmount)
tokenIdIsCorrect && soldTokenAmount >= 1 && newOrderValueIsCorrect && returnBoxValueIsCorrect
}
}

(totalMatching ||partialMatching) && buyOrderTokenPrice >=tokenPrice
(totalMatching || partialMatching)
}

}""".stripMargin
Expand Down Expand Up @@ -217,7 +254,8 @@ object DEXPlayground {
value = buyOrderBoxValue,
script = buyOrderContract,
registers = R4 -> token.tokenId,
R5 -> buyersBidTokenPrice
R5 -> buyersBidTokenPrice,
R6 -> buyerDexFeePerToken
)

val buyOrderTransaction = Transaction(
Expand Down Expand Up @@ -279,7 +317,8 @@ object DEXPlayground {
script = newSellOrderContract,
registers = R4 -> token.tokenId,
R5 -> sellerAskTokenPrice,
R6 -> sellOrderTxSigned.outputs(0).id
R6 -> sellerDexFeePerToken,
R7 -> sellOrderTxSigned.outputs(0).id
)

val buyerTokenAmountBought = buyerBidTokenAmount / 2
Expand All @@ -299,8 +338,9 @@ object DEXPlayground {
value = newBuyOrderBoxValue,
script = newBuyOrderContract,
registers = R4 -> token.tokenId,
R5 -> sellerAskTokenPrice,
R6 -> buyOrderTxSigned.outputs(0).id
R5 -> buyersBidTokenPrice,
R6 -> buyerDexFeePerToken,
R7 -> buyOrderTxSigned.outputs(0).id
)

val dexParty = blockchainSim.newParty("DEX")
Expand Down Expand Up @@ -422,7 +462,8 @@ object DEXPlayground {
value = buyOrderBoxValue,
script = buyOrderContract,
registers = R4 -> token.tokenId,
R5 -> buyersBidTokenPrice
R5 -> buyersBidTokenPrice,
R6 -> buyerDexFeePerToken
)

val buyOrderTransaction = Transaction(
Expand Down Expand Up @@ -512,9 +553,9 @@ object DEXPlayground {
val cancelTxFee = MinTxFee

val sellerReturnBox = Box(
value = sellOrderBox.value - cancelTxFee,
token = (token -> sellerAskTokenAmount),
script = contract(sellerParty.wallet.getAddress.pubKey)
value = sellOrderBox.value - cancelTxFee,
token = (token -> sellerAskTokenAmount),
script = contract(sellerParty.wallet.getAddress.pubKey)
)

val cancelSellTransaction = Transaction(
Expand Down
1 change: 0 additions & 1 deletion ...grounds/src/test/scala/org/ergoplatform/playgrounds/examples/test/DEXPlaygroundSpec.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
package org.ergoplatform.playgrounds.examples.test

import org.ergoplatform.playgrounds.examples.AssetsAtomicExchangePlayground
import org.scalatest.PropSpec
import org.ergoplatform.playgrounds.examples.DEXPlayground

Expand Down