-
Notifications
You must be signed in to change notification settings - Fork 87
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Natural language syntax for currencies (#440)
* Convert CurrencyUnit and LnCurrencyUnit Scalacheck to Scalatest * Add Int and Long syntax to LnCurrencyUnit, MilliSatoshis and CurrencyUnit * Tweak toString methods
- Loading branch information
1 parent
0f27370
commit 1f10d35
Showing
10 changed files
with
484 additions
and
241 deletions.
There are no files selected for viewing
126 changes: 0 additions & 126 deletions
126
core-test/src/test/scala/org/bitcoins/core/currency/CurrencyUnitSpec.scala
This file was deleted.
Oops, something went wrong.
167 changes: 167 additions & 0 deletions
167
core-test/src/test/scala/org/bitcoins/core/currency/CurrencyUnitTest.scala
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,167 @@ | ||
package org.bitcoins.core.currency | ||
|
||
import org.bitcoins.core.currency._ | ||
|
||
import org.bitcoins.testkit.util.BitcoinSUnitTest | ||
import org.bitcoins.testkit.core.gen.CurrencyUnitGenerator | ||
import scala.util.Try | ||
import org.bitcoins.core.number.Int64 | ||
import scala.util.Success | ||
import scala.util.Failure | ||
import org.scalacheck.Gen | ||
import org.scalacheck.Shrink | ||
|
||
class CurrencyUnitTest extends BitcoinSUnitTest { | ||
|
||
behavior of "Satoshis" | ||
|
||
it must "have symmetry serialization" in { | ||
forAll(CurrencyUnitGenerator.satoshis) { satoshis => | ||
assert(Satoshis(satoshis.hex) == satoshis) | ||
} | ||
} | ||
|
||
it must "have Int syntax" in { | ||
forAll(Gen.choose(0, Int.MaxValue)) { num => | ||
assert(num.bitcoins == Bitcoins(num)) | ||
assert(num.bitcoin == Bitcoins(num)) | ||
assert(num.BTC == Bitcoins(num)) | ||
|
||
assert(num.satoshis == Satoshis(Int64(num))) | ||
assert(num.satoshi == Satoshis(Int64(num))) | ||
assert(num.sats == Satoshis(Int64(num))) | ||
assert(num.sat == Satoshis(Int64(num))) | ||
} | ||
} | ||
|
||
it must "have Long syntax" in { | ||
forAll(Gen.choose(0, Satoshis.max.toLong / 100000000)) { num => | ||
assert(num.bitcoins == Bitcoins(num)) | ||
assert(num.bitcoin == Bitcoins(num)) | ||
assert(num.BTC == Bitcoins(num)) | ||
} | ||
|
||
forAll(Gen.choose(0, Satoshis.max.toLong)) { num => | ||
assert(num.satoshis == Satoshis(Int64(num))) | ||
assert(num.satoshi == Satoshis(Int64(num))) | ||
assert(num.sats == Satoshis(Int64(num))) | ||
assert(num.sat == Satoshis(Int64(num))) | ||
} | ||
} | ||
|
||
it must "have additive identity" in { | ||
forAll(CurrencyUnitGenerator.satoshis) { satoshis => | ||
assert(satoshis + CurrencyUnits.zero == satoshis) | ||
} | ||
} | ||
|
||
it must "add satoshis" in { | ||
forAll(CurrencyUnitGenerator.satoshis, CurrencyUnitGenerator.satoshis) { | ||
(num1, num2) => (num1: Satoshis, num2: Satoshis) => | ||
val result: Try[Int64] = Try(Int64(num1.toBigInt + num2.toBigInt)) | ||
if (result.isSuccess && result.get >= Int64(Satoshis.min.toLong) && | ||
result.get <= Int64(Satoshis.max.toLong)) | ||
assert(num1 + num2 == Satoshis(result.get)) | ||
else assert(Try(num1 + num2).isFailure) | ||
} | ||
} | ||
|
||
it must "have subtractive identity for satoshis" in { | ||
forAll(CurrencyUnitGenerator.satoshis) { satoshis => | ||
assert(satoshis - CurrencyUnits.zero == satoshis) | ||
} | ||
} | ||
|
||
it must "subtract satoshis " in { | ||
forAll(CurrencyUnitGenerator.satoshis, CurrencyUnitGenerator.satoshis) { | ||
(num1: Satoshis, num2: Satoshis) => | ||
val result: Try[Int64] = Try(Int64(num1.toBigInt - num2.toBigInt)) | ||
if (result.isSuccess && result.get >= Int64(Satoshis.min.toLong) && | ||
result.get <= Int64(Satoshis.max.toLong)) | ||
assert(num1 - num2 == Satoshis(result.get)) | ||
else assert(Try(num1 - num2).isFailure) | ||
} | ||
} | ||
|
||
it must "multiply satoshis by zero" in { | ||
forAll(CurrencyUnitGenerator.satoshis) { satoshis => | ||
assert(satoshis * CurrencyUnits.zero == CurrencyUnits.zero) | ||
} | ||
} | ||
|
||
it must "have multiplicative identity" in { | ||
forAll(CurrencyUnitGenerator.satoshis) { satoshis => | ||
assert(satoshis * Satoshis.one == satoshis) | ||
} | ||
} | ||
|
||
it must "multiply satoshis" in { | ||
forAll(CurrencyUnitGenerator.satoshis, CurrencyUnitGenerator.satoshis) { | ||
(num1, num2) => | ||
val result: Try[Int64] = Try(Int64(num1.toBigInt * num2.toBigInt)) | ||
if (result.isSuccess && result.get >= Int64(Satoshis.min.toLong) && | ||
result.get <= Int64(Satoshis.max.toLong)) | ||
num1 * num2 == Satoshis(result.get) | ||
else Try(num1 * num2).isFailure | ||
} | ||
} | ||
|
||
private val satoshiWithInt: Gen[(Satoshis, Int)] = for { | ||
sat <- CurrencyUnitGenerator.satoshis | ||
num <- Gen.choose(Int.MinValue, Int.MaxValue) | ||
} yield (sat, num) | ||
|
||
it must "multiply a satoshi value with an int" in { | ||
forAll(satoshiWithInt) { | ||
case (sat, int) => | ||
val safeProduct = sat.multiplySafe(int) | ||
val underlyingProduct = sat.toBigInt * int | ||
if (underlyingProduct < Satoshis.max.toBigInt && underlyingProduct > Satoshis.min.toBigInt) { | ||
assert(safeProduct.isSuccess) | ||
assert(safeProduct.get.satoshis.toBigInt == underlyingProduct) | ||
} else { | ||
assert(safeProduct.isFailure) | ||
} | ||
} | ||
} | ||
|
||
it must "have '< & >=' property" in { | ||
forAll(CurrencyUnitGenerator.satoshis, CurrencyUnitGenerator.satoshis) { | ||
(num1, num2) => | ||
assert((num1 < num2) || (num1 >= num2)) | ||
} | ||
} | ||
|
||
it must "have '<= & >' property" in { | ||
forAll(CurrencyUnitGenerator.satoshis, CurrencyUnitGenerator.satoshis) { | ||
(num1, num2) => | ||
assert((num1 <= num2) || (num1 > num2)) | ||
} | ||
} | ||
|
||
it must "have '== & !=' property" in { | ||
forAll(CurrencyUnitGenerator.satoshis, CurrencyUnitGenerator.satoshis) { | ||
(num1, num2) => | ||
assert((num1 == num2) || (num1 != num2)) | ||
} | ||
} | ||
|
||
it must "convert satoshis to bitcoin and then back to satoshis" in { | ||
forAll(CurrencyUnitGenerator.satoshis) { satoshis => | ||
val b = Bitcoins(satoshis) | ||
assert(b.satoshis == satoshis) | ||
} | ||
} | ||
|
||
it must "be able to add two unique currency unit types" in { | ||
forAll(CurrencyUnitGenerator.satoshis, CurrencyUnitGenerator.bitcoins) { | ||
(sats: Satoshis, btc: Bitcoins) => | ||
val result = | ||
Try(Satoshis(Int64(sats.toBigInt + btc.satoshis.toBigInt))) | ||
val expected = result.map(Bitcoins(_)) | ||
val actual: Try[CurrencyUnit] = Try(sats + btc) | ||
if (actual.isSuccess && expected.isSuccess) actual.get == expected.get | ||
else actual.isFailure && expected.isFailure | ||
} | ||
} | ||
} |
96 changes: 0 additions & 96 deletions
96
core-test/src/test/scala/org/bitcoins/core/protocol/ln/currency/LnCurrencyUnitSpec.scala
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.