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

Add FfiResultVoid type

Browse Source
This commit is contained in:
Steve Myers 2021-07-03 19:24:29 -07:00
parent d00cc73261
commit 8443265142
6 changed files with 43 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -30,27 +30,22 @@ interface LibJna : Library {
// typedef struct {
//
// int32_t ok;
//
// char * err;
//
//} FfiResult_int32_t;
open class FfiResult_int32_t : Structure() {
class ByValue : FfiResult_int32_t(), Structure.ByValue
class ByReference : FfiResult_int32_t(), Structure.ByReference
@JvmField
var ok: Int = 0
//} FfiResultVoid_t;
open class FfiResultVoid_t : Structure() {
class ByValue : FfiResultVoid_t(), Structure.ByValue
class ByReference : FfiResultVoid_t(), Structure.ByReference
@JvmField
var err: String = ""
override fun getFieldOrder() = listOf("ok", "err")
override fun getFieldOrder() = listOf("err")
}
// void free_int_result (
// FfiResult_int32_t int_result);
fun free_int_result(void_result: FfiResult_int32_t.ByValue)
// void free_void_result (
// FfiResultVoid_t void_result);
fun free_void_result(void_result: FfiResultVoid_t.ByValue)
// void free_string (
// char * string);
@ -241,9 +236,9 @@ interface LibJna : Library {
// FfiResult_Vec_LocalUtxo_t unspent_result);
fun free_unspent_result(unspent_result: FfiResultVec_LocalUtxo_t.ByValue)
// FfiResult_int32_t sync_wallet (
// FfiResultVoid_t sync_wallet (
// OpaqueWallet_t const * opaque_wallet);
fun sync_wallet(opaque_wallet: OpaqueWallet_t): FfiResult_int32_t.ByValue
fun sync_wallet(opaque_wallet: OpaqueWallet_t): FfiResultVoid_t.ByValue
// FfiResult_char_ptr_t new_address (
// OpaqueWallet_t const * opaque_wallet);

10
bdk-kotlin/jvm/src/main/kotlin/org/bitcoindevkit/bdk/types/VoidResult.kt
View File

@ -7,14 +7,14 @@ import org.bitcoindevkit.bdk.LibJna
import org.slf4j.Logger
import org.slf4j.LoggerFactory
class VoidResult constructor(private val ffiResultInt32T: LibJna.FfiResult_int32_t.ByValue) :
class VoidResult constructor(private val ffiResultVoidT: LibJna.FfiResultVoid_t.ByValue) :
LibBase() {
private val log: Logger = LoggerFactory.getLogger(VoidResult::class.java)
fun value(): Unit {
val err = ffiResultInt32T.err
//val ok = ffiResultInt32T.ok
val err = ffiResultVoidT.err
when {
err.isNotEmpty() -> {
log.error("JnaError: $err")
@ -27,7 +27,7 @@ class VoidResult constructor(private val ffiResultInt32T: LibJna.FfiResult_int32
}
protected fun finalize() {
libJna.free_int_result(ffiResultInt32T)
log.debug("$ffiResultInt32T freed")
libJna.free_void_result(ffiResultVoidT)
log.debug("$ffiResultVoidT freed")
}
}

18
cc/bdk_ffi.h
View File

@ -37,19 +37,13 @@ FfiResult_OpaqueWallet_ptr_t new_wallet_result (
void free_wallet_result (
FfiResult_OpaqueWallet_ptr_t wallet_result);
#include <stddef.h>
#include <stdint.h>
typedef struct {
int32_t ok;
char * err;
} FfiResult_int32_t;
} FfiResultVoid_t;
FfiResult_int32_t sync_wallet (
FfiResultVoid_t sync_wallet (
OpaqueWallet_t const * opaque_wallet);
typedef struct {
@ -63,6 +57,10 @@ typedef struct {
FfiResult_char_ptr_t new_address (
OpaqueWallet_t const * opaque_wallet);
#include <stddef.h>
#include <stdint.h>
typedef struct {
char * txid;
@ -137,8 +135,8 @@ void free_database_config (
void free_string_result (
FfiResult_char_ptr_t string_result);
void free_int_result (
FfiResult_int32_t int_result);
void free_void_result (
FfiResultVoid_t void_result);
/** \brief
* Free a Rust-allocated string

17
cc/bdk_ffi_test.c
View File

@ -48,10 +48,9 @@ int main (int argc, char const * const argv[])
OpaqueWallet_t *wallet = wallet_result.ok;
// sync wallet
FfiResult_int32_t sync_result = sync_wallet(wallet);
assert(sync_result.ok == 0);
FfiResultVoid_t sync_result = sync_wallet(wallet);
assert(strlen(sync_result.err) == 0);
free_int_result(sync_result);
free_void_result(sync_result);
// new address
FfiResult_char_ptr_t address1_result = new_address(wallet);
@ -75,7 +74,7 @@ int main (int argc, char const * const argv[])
//// free_wallet_result(wallet_result);
// verify sync_wallet after free_wallet fails (core dumped)
//// FfiResult_int32_t sync_result2 = sync_wallet(wallet);
//// FfiResultVoid_t sync_result2 = sync_wallet(wallet);
}
// test get unspent utxos
@ -97,10 +96,9 @@ int main (int argc, char const * const argv[])
OpaqueWallet_t *wallet = wallet_result.ok;
// sync wallet
FfiResult_int32_t sync_result = sync_wallet(wallet);
assert(sync_result.ok == 0);
FfiResultVoid_t sync_result = sync_wallet(wallet);
assert(strlen(sync_result.err) == 0);
free_int_result(sync_result);
free_void_result(sync_result);
// list unspent
FfiResult_Vec_LocalUtxo_t unspent_result = list_unspent(wallet);
@ -144,10 +142,9 @@ int main (int argc, char const * const argv[])
OpaqueWallet_t *wallet = wallet_result.ok;
// sync wallet
FfiResult_int32_t sync_result = sync_wallet(wallet);
assert(sync_result.ok == 0);
FfiResultVoid_t sync_result = sync_wallet(wallet);
assert(sync_result.err == NULL);
free_int_result(sync_result);
free_void_result(sync_result);
// get balance
FfiResultT_uint64_t balance_result = balance(wallet);

11
src/types.rs
View File

@ -9,14 +9,21 @@ pub struct FfiResult<T> {
pub err: char_p_boxed,
}
#[derive_ReprC]
#[repr(C)]
#[derive(Debug)]
pub struct FfiResultVoid {
pub err: char_p_boxed,
}
#[ffi_export]
fn free_string_result(string_result: FfiResult<char_p_boxed>) {
drop(string_result)
}
#[ffi_export]
fn free_int_result(int_result: FfiResult<i32>) {
drop(int_result)
fn free_void_result(void_result: FfiResultVoid) {
drop(void_result)
}
// TODO do we need this? remove?

10
src/wallet/mod.rs
View File

@ -13,7 +13,7 @@ use blockchain::BlockchainConfig;
use database::DatabaseConfig;
use crate::error::get_name;
use crate::types::FfiResult;
use crate::types::{FfiResult, FfiResultVoid};
use std::ffi::CString;
mod blockchain;
@ -77,15 +77,13 @@ fn free_wallet_result(wallet_result: FfiResult<Option<Box<OpaqueWallet>>>) {
// wallet operations
#[ffi_export]
fn sync_wallet(opaque_wallet: &OpaqueWallet) -> FfiResult<i32> {
fn sync_wallet(opaque_wallet: &OpaqueWallet) -> FfiResultVoid {
let int_result = opaque_wallet.raw.sync(log_progress(), Some(100));
match int_result {
Ok(_v) => FfiResult {
ok: 0,
Ok(_v) => FfiResultVoid {
err: char_p_boxed::from(CString::default()),
},
Err(e) => FfiResult {
ok: -1,
Err(e) => FfiResultVoid {
err: char_p_boxed::try_from(get_name(&e)).unwrap(),
},
}