frost/bdk-ffi
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add classes to wrap LibJna native types

Browse Source
This commit is contained in:
Steve Myers
2021-06-21 17:01:53 -07:00
parent 90c4fd3328
commit d248bca299
13 changed files with 291 additions and 237 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
bdk-kotlin/jvm/build.gradle
View File

@@ -4,6 +4,12 @@ plugins {
id 'maven-publish'
}
test {
testLogging {
events "PASSED", "SKIPPED", "FAILED", "STANDARD_OUT", "STANDARD_ERROR"
}
}
dependencies {
implementation platform('org.jetbrains.kotlin:kotlin-bom')
implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"

43
bdk-kotlin/jvm/src/main/java/org/bitcoindevkit/bdk/Error.kt Normal file
View File

@@ -0,0 +1,43 @@
package org.bitcoindevkit.bdk
enum class Error {
InvalidU32Bytes,
Generic,
ScriptDoesntHaveAddressForm,
SingleRecipientMultipleOutputs,
SingleRecipientNoInputs,
NoRecipients,
NoUtxosSelected,
OutputBelowDustLimit,
InsufficientFunds,
BnBTotalTriesExceeded,
BnBNoExactMatch,
UnknownUtxo,
TransactionNotFound,
TransactionConfirmed,
IrreplaceableTransaction,
FeeRateTooLow,
FeeTooLow,
MissingKeyOrigin,
Key,
ChecksumMismatch,
SpendingPolicyRequired,
InvalidPolicyPathError,
Signer,
InvalidProgressValue,
ProgressUpdateError,
InvalidOutpoint,
Descriptor,
AddressValidator,
Encode,
Miniscript,
Bip32,
Secp256k1,
Json,
Hex,
Psbt,
Electrum,
// Esplora
// CompactFilters
Sled,
}

32
bdk-kotlin/jvm/src/main/java/org/bitcoindevkit/bdk/LibJna.kt
View File

@@ -35,10 +35,16 @@ interface LibJna : Library {
// void free_string_result (
// StringResult_t * string_result);
fun free_string_result(string_result: StringResult_t)
// void free_string (
// char * string);
fun free_string(string: Pointer?)
// typedef struct WalletRef WalletRef_t;
class WalletRef_t : PointerType {
constructor() : super()
constructor(pointer: Pointer) : super(pointer)
}
// void free_wallet_ref (
// WalletRef_t * wallet_ref);
fun free_wallet_ref(wallet_ref: WalletRef_t)
// typedef struct WalletResult WalletResult_t;
class WalletResult_t : PointerType {
@@ -58,17 +64,25 @@ interface LibJna : Library {
// char * get_wallet_err (
// WalletResult_t const * wallet_result);
// TODO
fun get_wallet_err(wallet_result: WalletResult_t): Pointer?
// WalletRef_t * get_wallet_ok (
// WalletResult_t const * wallet_result);
fun get_wallet_ok(wallet_result: WalletResult_t): WalletRef_t?
// VoidResult_t * sync_wallet (
// WalletResult_t const * wallet_result);
fun sync_wallet(wallet_result: WalletResult_t): VoidResult_t
// WalletRef_t const * wallet_ref);
fun sync_wallet(wallet_ref: Pointer): VoidResult_t
// StringResult_t * new_address (
// WalletResult_t const * wallet_result);
fun new_address(wallet_result: WalletResult_t): StringResult_t
// WalletRef_t const * wallet_ref);
fun new_address(wallet_ref: Pointer): StringResult_t
// void free_wallet_result (
// WalletResult_t * wallet_result);
fun free_wallet_result(wallet_result: WalletResult_t)
// void free_string (
// char * string);
fun free_string(string: Pointer?)
}

32
bdk-kotlin/jvm/src/main/java/org/bitcoindevkit/bdk/StringResult.kt Normal file
View File

@@ -0,0 +1,32 @@
package org.bitcoindevkit.bdk
import org.slf4j.Logger
import org.slf4j.LoggerFactory
class StringResult internal constructor(private val stringResultT: LibJna.StringResult_t) : LibBase() {
private val log: Logger = LoggerFactory.getLogger(StringResult::class.java)
fun isErr(): Boolean {
return libJna.get_string_err(stringResultT) != null
}
fun err(): String? {
val errPointer = libJna.get_string_err(stringResultT)
val err = errPointer?.getString(0)
libJna.free_string(errPointer)
return err
}
fun ok(): String? {
val okPointer = libJna.get_string_ok(stringResultT)
val ok = okPointer?.getString(0)
libJna.free_string(okPointer)
return ok
}
protected fun finalize() {
libJna.free_string_result(stringResultT)
log.debug("StringResult_t freed")
}
}

25
bdk-kotlin/jvm/src/main/java/org/bitcoindevkit/bdk/VoidResult.kt Normal file
View File

@@ -0,0 +1,25 @@
package org.bitcoindevkit.bdk
import org.slf4j.Logger
import org.slf4j.LoggerFactory
class VoidResult internal constructor(private val voidResultT: LibJna.VoidResult_t) : LibBase() {
private val log: Logger = LoggerFactory.getLogger(VoidResult::class.java)
fun isErr(): Boolean {
return libJna.get_void_err(voidResultT) != null
}
fun err(): String? {
val errPointer = libJna.get_void_err(voidResultT)
val err = errPointer?.getString(0)
libJna.free_string(errPointer)
return err
}
protected fun finalize() {
libJna.free_void_result(voidResultT)
log.debug("VoidResult_t freed")
}
}

25
bdk-kotlin/jvm/src/main/java/org/bitcoindevkit/bdk/Wallet.kt Normal file
View File

@@ -0,0 +1,25 @@
package org.bitcoindevkit.bdk
import org.slf4j.Logger
import org.slf4j.LoggerFactory
class Wallet internal constructor(
private val walletRefT: LibJna.WalletRef_t,
) : LibBase() {
private val log: Logger = LoggerFactory.getLogger(Wallet::class.java)
fun sync(): VoidResult {
return VoidResult(libJna.sync_wallet(walletRefT.pointer))
}
fun getAddress(): StringResult {
return StringResult(libJna.new_address(walletRefT.pointer))
}
protected fun finalize() {
libJna.free_wallet_ref(walletRefT)
log.debug("WalletRef_t freed")
}
}

36
bdk-kotlin/jvm/src/main/java/org/bitcoindevkit/bdk/WalletResult.kt Normal file
View File

@@ -0,0 +1,36 @@
package org.bitcoindevkit.bdk
import org.slf4j.Logger
import org.slf4j.LoggerFactory
class WalletResult(
name: String,
descriptor: String,
changeDescriptor: String?,
) : LibBase() {
private val log: Logger = LoggerFactory.getLogger(WalletResult::class.java)
private val walletResultT = libJna.new_wallet_result(name, descriptor, changeDescriptor)
fun isErr(): Boolean {
return libJna.get_wallet_err(walletResultT) != null
}
fun err(): String? {
val errPointer = libJna.get_wallet_err(walletResultT)
val err = errPointer?.getString(0)
libJna.free_string(errPointer)
return err
}
fun ok(): Wallet? {
val okWalletRef = libJna.get_wallet_ok(walletResultT)
return if (okWalletRef != null) Wallet(okWalletRef) else null
}
protected fun finalize() {
libJna.free_wallet_result(walletResultT)
log.debug("WalletResult_t freed")
}
}

1
bdk-kotlin/test-fixtures/build.gradle
View File

@@ -9,6 +9,7 @@ dependencies {
implementation "net.java.dev.jna:jna:5.8.0"
implementation (project(':jvm'))
implementation 'org.jetbrains.kotlin:kotlin-test-junit'
//implementation "org.mockito.kotlin:mockito-kotlin:3.2.0"
api "org.slf4j:slf4j-api:1.7.30"
}

92
bdk-kotlin/test-fixtures/src/main/java/org/bitcoindevkit/bdk/LibTest.kt
View File

@@ -1,71 +1,67 @@
package org.bitcoindevkit.bdk
import org.junit.*
import org.junit.Assert.assertEquals
import org.junit.Assert.*
import org.slf4j.Logger
import org.slf4j.LoggerFactory
import kotlin.test.assertNotNull
import kotlin.test.assertNull
/**
* Library test, which will execute on linux host.
*
*/
abstract class LibTest {
abstract class LibTest : LibBase() {
companion object : LibBase() {
private val log: Logger = LoggerFactory.getLogger(LibTest::class.java)
private lateinit var wallet_result: LibJna.WalletResult_t
private val log: Logger = LoggerFactory.getLogger(LibTest::class.java)
@BeforeClass
@JvmStatic
fun new_wallet() {
val name = "test_wallet"
val desc =
"wpkh([c258d2e4/84h/1h/0h]tpubDDYkZojQFQjht8Tm4jsS3iuEmKjTiEGjG6KnuFNKKJb5A6ZUCUZKdvLdSDWofKi4ToRCwb9poe1XdqfUnP4jaJjCB2Zwv11ZLgSbnZSNecE/0/*)"
val change =
"wpkh([c258d2e4/84h/1h/0h]tpubDDYkZojQFQjht8Tm4jsS3iuEmKjTiEGjG6KnuFNKKJb5A6ZUCUZKdvLdSDWofKi4ToRCwb9poe1XdqfUnP4jaJjCB2Zwv11ZLgSbnZSNecE/1/*)"
val name = "test_wallet"
val desc =
"wpkh([c258d2e4/84h/1h/0h]tpubDDYkZojQFQjht8Tm4jsS3iuEmKjTiEGjG6KnuFNKKJb5A6ZUCUZKdvLdSDWofKi4ToRCwb9poe1XdqfUnP4jaJjCB2Zwv11ZLgSbnZSNecE/0/*)"
val change =
"wpkh([c258d2e4/84h/1h/0h]tpubDDYkZojQFQjht8Tm4jsS3iuEmKjTiEGjG6KnuFNKKJb5A6ZUCUZKdvLdSDWofKi4ToRCwb9poe1XdqfUnP4jaJjCB2Zwv11ZLgSbnZSNecE/1/*)"
wallet_result = libJna.new_wallet_result(name, desc, change)
log.debug("wallet created")
}
@AfterClass
@JvmStatic
fun free_wallet() {
libJna.free_wallet_result(wallet_result)
log.debug("wallet freed")
@Test
fun walletResultError() {
val badWalletResult = WalletResult("bad", "bad", "bad")
assertTrue(badWalletResult.isErr())
val walletErr = badWalletResult.err()
assertNotNull(walletErr)
log.debug("wallet error $walletErr")
assertEquals("Descriptor", walletErr)
val wallet = badWalletResult.ok()
assertNull(wallet)
}
@Test
fun walletResultFinalize() {
val names = listOf("one", "two", "three")
names.map {
val wallet = WalletResult(it, desc, change)
assertNotNull(wallet)
}
System.gc()
// The only way to verify wallets freed is by checking the log
}
@Test
fun wallet_sync_error() {
val bad_wallet_result = libJna.new_wallet_result("test", "bad", null)
log.debug("wallet result created")
val sync_result = libJna.sync_wallet(bad_wallet_result)
val sync_err_pointer = libJna.get_void_err(sync_result)
assertNotNull(sync_err_pointer)
val sync_err = sync_err_pointer.getString(0)
log.debug("wallet sync error $sync_err")
fun walletSync() {
val walletResult = WalletResult(name, desc, change)
val wallet = walletResult.ok()
assertNotNull(wallet)
val syncResult = wallet!!.sync();
assertFalse(syncResult.isErr())
assertNull(syncResult.err())
}
@Test
fun sync() {
val sync_result = libJna.sync_wallet(wallet_result)
assertNull(libJna.get_void_err(sync_result))
libJna.free_void_result(sync_result)
}
@Test
fun new_newaddress_wallet() {
val address_result = libJna.new_address(wallet_result)
assertNull(libJna.get_string_err(address_result))
val address_pointer = libJna.get_string_ok(address_result);
val address = address_pointer!!.getString(0)
libJna.free_string_result(address_result)
libJna.free_string(address_pointer)
fun walletNewAddress() {
val walletResult = WalletResult(name, desc, change)
val wallet = walletResult.ok()
assertNotNull(wallet)
val addressResult = wallet!!.getAddress()
assertFalse(addressResult.isErr())
assertNull(addressResult.err())
val address = addressResult.ok()
assertNotNull(address)
log.debug("address created from kotlin: $address")
assertEquals(address, "tb1qzg4mckdh50nwdm9hkzq06528rsu73hjxxzem3e")
}