Upgrade bdk dependency to 0.11

This commit is contained in:
Steve Myers 2021-09-25 21:17:40 -07:00
parent 342c4c4aa8
commit 39e5efe5c0
9 changed files with 226 additions and 83 deletions

1
.gitignore vendored
View File

@ -6,3 +6,4 @@ Cargo.lock
wallet_db wallet_db
bdk_ffi_test bdk_ffi_test
local.properties local.properties
*.log

View File

@ -9,7 +9,7 @@ edition = "2018"
crate-type = ["cdylib"] crate-type = ["cdylib"]
[dependencies] [dependencies]
bdk = { version = "^0.7", features = ["all-keys"] } bdk = { version = "^0.11", features = ["all-keys"] }
safer-ffi = { version = "0.0.6", features = ["proc_macros"]} safer-ffi = { version = "0.0.6", features = ["proc_macros"]}
[features] [features]

View File

@ -1,4 +1,16 @@
Setup build environment
1. Add Android rust targets
```sh
rustup target add x86_64-apple-darwin x86_64-unknown-linux-gnu x86_64-linux-android aarch64-linux-android armv7-linux-androideabi i686-linux-android
```
2. Set ANDROID_NDK_HOME
```sh
export ANDROID_NDK_HOME=/home/<user>/Android/Sdk/ndk/<NDK version, ie. 21.4.7075529>
```
Adding new structs and functions Adding new structs and functions

View File

@ -1,34 +1,62 @@
#!/usr/bin/env bash #!/usr/bin/env bash
set -eo pipefail -o xtrace set -eo pipefail
# rust # functions
## help
help()
{
# Display Help
echo "Build bdk-ffi and related libraries."
echo
echo "Syntax: build [-a|h|k]"
echo "options:"
echo "-a Android aar."
echo "-h Print this Help."
echo "-k JVM jar."
echo
}
## rust
build_rust() {
echo "Build Rust library and C headers"
cargo fmt cargo fmt
cargo build cargo build
cargo test --features c-headers -- generate_headers cargo test --features c-headers -- generate_headers
}
# cc ## cc
build_cc() {
echo "Build C test library"
export LD_LIBRARY_PATH=`pwd`/target/debug export LD_LIBRARY_PATH=`pwd`/target/debug
cc cc/bdk_ffi_test.c -o cc/bdk_ffi_test -L target/debug -l bdk_ffi -l pthread -l dl -l m cc cc/bdk_ffi_test.c -o cc/bdk_ffi_test -L target/debug -l bdk_ffi -l pthread -l dl -l m
}
# bdk-kotlin jar ## copy to bdk-kotlin
OS=$(uname) copy_lib_kotlin() {
echo -n "Copy "
case $OS in case $OS in
"Darwin") "Darwin")
echo "Darwin build system" echo -n "darwin "
mkdir -p bdk-kotlin/jvm/src/main/resources/darwin-x86-64 mkdir -p bdk-kotlin/jvm/src/main/resources/darwin-x86-64
cp target/debug/libbdk_ffi.dylib bdk-kotlin/jvm/src/main/resources/darwin-x86-64 cp target/debug/libbdk_ffi.dylib bdk-kotlin/jvm/src/main/resources/darwin-x86-64
;; ;;
"Linux") "Linux")
echo "Linux build system" echo -n "linux "
mkdir -p bdk-kotlin/jvm/src/main/resources/linux-x86-64 mkdir -p bdk-kotlin/jvm/src/main/resources/linux-x86-64
cp target/debug/libbdk_ffi.so bdk-kotlin/jvm/src/main/resources/linux-x86-64 cp target/debug/libbdk_ffi.so bdk-kotlin/jvm/src/main/resources/linux-x86-64
;; ;;
esac esac
echo "libs to kotlin sub-project"
}
(cd bdk-kotlin && gradle :jvm:build && gradle :jvm:publishToMavenLocal) ## bdk-kotlin jar
build_kotlin() {
# rust android (cd bdk-kotlin && ./gradlew :jvm:build && ./gradlew :jvm:publishToMavenLocal)
}
## rust android
build_android() {
# If ANDROID_NDK_HOME is not set then set it to github actions default # If ANDROID_NDK_HOME is not set then set it to github actions default
[ -z "$ANDROID_NDK_HOME" ] && export ANDROID_NDK_HOME=$ANDROID_HOME/ndk-bundle [ -z "$ANDROID_NDK_HOME" ] && export ANDROID_NDK_HOME=$ANDROID_HOME/ndk-bundle
@ -61,4 +89,26 @@ if echo $BUILD_TARGETS | grep "i686"; then
fi fi
# bdk-kotlin aar # bdk-kotlin aar
(cd bdk-kotlin && gradle :android:build && gradle :android:publishToMavenLocal) (cd bdk-kotlin && ./gradlew :android:build && ./gradlew :android:publishToMavenLocal)
}
OS=$(uname)
if [ $1 = "-h" ]
then
help
else
build_rust
build_cc
copy_lib_kotlin
while [ -n "$1" ]; do # while loop starts
case "$1" in
-k) build_kotlin ;;
-a) build_android ;;
-h) help ;;
*) echo "Option $1 not recognized" ;;
esac
shift
done
fi

View File

@ -9,8 +9,6 @@ pub enum FfiError {
InvalidU32Bytes, InvalidU32Bytes,
Generic, Generic,
ScriptDoesntHaveAddressForm, ScriptDoesntHaveAddressForm,
SingleRecipientMultipleOutputs,
SingleRecipientNoInputs,
NoRecipients, NoRecipients,
NoUtxosSelected, NoUtxosSelected,
OutputBelowDustLimit, OutputBelowDustLimit,
@ -23,12 +21,14 @@ pub enum FfiError {
IrreplaceableTransaction, IrreplaceableTransaction,
FeeRateTooLow, FeeRateTooLow,
FeeTooLow, FeeTooLow,
FeeRateUnavailable,
MissingKeyOrigin, MissingKeyOrigin,
Key, Key,
ChecksumMismatch, ChecksumMismatch,
SpendingPolicyRequired, SpendingPolicyRequired,
InvalidPolicyPathError, InvalidPolicyPathError,
Signer, Signer,
InvalidNetwork,
InvalidProgressValue, InvalidProgressValue,
ProgressUpdateError, ProgressUpdateError,
InvalidOutpoint, InvalidOutpoint,
@ -41,6 +41,7 @@ pub enum FfiError {
Json, Json,
Hex, Hex,
Psbt, Psbt,
PsbtParse,
Electrum, Electrum,
// Esplora, // Esplora,
// CompactFilters, // CompactFilters,
@ -53,8 +54,6 @@ impl From<&bdk::Error> for FfiError {
Error::InvalidU32Bytes(_) => FfiError::InvalidU32Bytes, Error::InvalidU32Bytes(_) => FfiError::InvalidU32Bytes,
Error::Generic(_) => FfiError::Generic, Error::Generic(_) => FfiError::Generic,
Error::ScriptDoesntHaveAddressForm => FfiError::ScriptDoesntHaveAddressForm, Error::ScriptDoesntHaveAddressForm => FfiError::ScriptDoesntHaveAddressForm,
Error::SingleRecipientMultipleOutputs => FfiError::SingleRecipientMultipleOutputs,
Error::SingleRecipientNoInputs => FfiError::SingleRecipientNoInputs,
Error::NoRecipients => FfiError::NoRecipients, Error::NoRecipients => FfiError::NoRecipients,
Error::NoUtxosSelected => FfiError::NoUtxosSelected, Error::NoUtxosSelected => FfiError::NoUtxosSelected,
Error::OutputBelowDustLimit(_) => FfiError::OutputBelowDustLimit, Error::OutputBelowDustLimit(_) => FfiError::OutputBelowDustLimit,
@ -67,12 +66,14 @@ impl From<&bdk::Error> for FfiError {
Error::IrreplaceableTransaction => FfiError::IrreplaceableTransaction, Error::IrreplaceableTransaction => FfiError::IrreplaceableTransaction,
Error::FeeRateTooLow { .. } => FfiError::FeeRateTooLow, Error::FeeRateTooLow { .. } => FfiError::FeeRateTooLow,
Error::FeeTooLow { .. } => FfiError::FeeTooLow, Error::FeeTooLow { .. } => FfiError::FeeTooLow,
Error::FeeRateUnavailable => FfiError::FeeRateUnavailable,
Error::MissingKeyOrigin(_) => FfiError::MissingKeyOrigin, Error::MissingKeyOrigin(_) => FfiError::MissingKeyOrigin,
Error::Key(_) => FfiError::Key, Error::Key(_) => FfiError::Key,
Error::ChecksumMismatch => FfiError::ChecksumMismatch, Error::ChecksumMismatch => FfiError::ChecksumMismatch,
Error::SpendingPolicyRequired(_) => FfiError::SpendingPolicyRequired, Error::SpendingPolicyRequired(_) => FfiError::SpendingPolicyRequired,
Error::InvalidPolicyPathError(_) => FfiError::InvalidPolicyPathError, Error::InvalidPolicyPathError(_) => FfiError::InvalidPolicyPathError,
Error::Signer(_) => FfiError::Signer, Error::Signer(_) => FfiError::Signer,
Error::InvalidNetwork { .. } => FfiError::InvalidNetwork,
Error::InvalidProgressValue(_) => FfiError::InvalidProgressValue, Error::InvalidProgressValue(_) => FfiError::InvalidProgressValue,
Error::ProgressUpdateError => FfiError::ProgressUpdateError, Error::ProgressUpdateError => FfiError::ProgressUpdateError,
Error::InvalidOutpoint(_) => FfiError::InvalidOutpoint, Error::InvalidOutpoint(_) => FfiError::InvalidOutpoint,
@ -85,9 +86,11 @@ impl From<&bdk::Error> for FfiError {
Error::Json(_) => FfiError::Json, Error::Json(_) => FfiError::Json,
Error::Hex(_) => FfiError::Hex, Error::Hex(_) => FfiError::Hex,
Error::Psbt(_) => FfiError::Psbt, Error::Psbt(_) => FfiError::Psbt,
Error::PsbtParse(_) => FfiError::PsbtParse,
Error::Electrum(_) => FfiError::Electrum, Error::Electrum(_) => FfiError::Electrum,
// Error::Esplora(_) => JniError::Esplora, // Error::Esplora(_) => JniError::Esplora,
// Error::CompactFilters(_) => JniError::CompactFilters, // Error::CompactFilters(_) => JniError::CompactFilters,
// Error::Rpc(_) => JniError::Rpc,
Error::Sled(_) => FfiError::Sled, Error::Sled(_) => FfiError::Sled,
} }
} }

View File

@ -16,6 +16,7 @@ fn new_electrum_config(
socks5: Option<char_p_ref>, socks5: Option<char_p_ref>,
retry: i16, retry: i16,
timeout: i16, timeout: i16,
stop_gap: usize,
) -> Box<BlockchainConfig> { ) -> Box<BlockchainConfig> {
let url = url.to_string(); let url = url.to_string();
let socks5 = socks5.map(|s| s.to_string()); let socks5 = socks5.map(|s| s.to_string());
@ -27,6 +28,7 @@ fn new_electrum_config(
socks5, socks5,
retry, retry,
timeout, timeout,
stop_gap,
}); });
Box::new(BlockchainConfig { Box::new(BlockchainConfig {
raw: electrum_config, raw: electrum_config,

View File

@ -2,7 +2,6 @@ use std::convert::TryFrom;
use std::ffi::CString; use std::ffi::CString;
use ::safer_ffi::prelude::*; use ::safer_ffi::prelude::*;
use bdk::bitcoin::network::constants::Network::Testnet;
use bdk::blockchain::{log_progress, AnyBlockchain, AnyBlockchainConfig, ConfigurableBlockchain}; use bdk::blockchain::{log_progress, AnyBlockchain, AnyBlockchainConfig, ConfigurableBlockchain};
use bdk::database::{AnyDatabase, AnyDatabaseConfig, ConfigurableDatabase}; use bdk::database::{AnyDatabase, AnyDatabaseConfig, ConfigurableDatabase};
use bdk::wallet::AddressIndex::New; use bdk::wallet::AddressIndex::New;
@ -16,6 +15,8 @@ use database::DatabaseConfig;
use crate::error::FfiError; use crate::error::FfiError;
use crate::types::{FfiResult, FfiResultVoid}; use crate::types::{FfiResult, FfiResultVoid};
use crate::wallet::transaction::{LocalUtxo, TransactionDetails}; use crate::wallet::transaction::{LocalUtxo, TransactionDetails};
use bdk::bitcoin::Network;
use std::str::FromStr;
mod blockchain; mod blockchain;
mod database; mod database;
@ -33,14 +34,16 @@ pub struct OpaqueWallet {
fn new_wallet_result( fn new_wallet_result(
descriptor: char_p_ref, descriptor: char_p_ref,
change_descriptor: Option<char_p_ref>, change_descriptor: Option<char_p_ref>,
network: char_p_ref,
blockchain_config: &BlockchainConfig, blockchain_config: &BlockchainConfig,
database_config: &DatabaseConfig, database_config: &DatabaseConfig,
) -> FfiResult<Option<Box<OpaqueWallet>>> { ) -> FfiResult<Option<Box<OpaqueWallet>>> {
let descriptor = descriptor.to_string(); let descriptor = descriptor.to_string();
let change_descriptor = change_descriptor.map(|s| s.to_string()); let change_descriptor = change_descriptor.map(|s| s.to_string());
let net = Network::from_str(network.to_str()).expect("Network name");
let bc_config = &blockchain_config.raw; let bc_config = &blockchain_config.raw;
let db_config = &database_config.raw; let db_config = &database_config.raw;
let wallet_result = new_wallet(descriptor, change_descriptor, bc_config, db_config); let wallet_result = new_wallet(descriptor, change_descriptor, net, bc_config, db_config);
match wallet_result { match wallet_result {
Ok(w) => FfiResult { Ok(w) => FfiResult {
@ -57,11 +60,10 @@ fn new_wallet_result(
fn new_wallet( fn new_wallet(
descriptor: String, descriptor: String,
change_descriptor: Option<String>, change_descriptor: Option<String>,
network: Network,
blockchain_config: &AnyBlockchainConfig, blockchain_config: &AnyBlockchainConfig,
database_config: &AnyDatabaseConfig, database_config: &AnyDatabaseConfig,
) -> Result<Wallet<AnyBlockchain, AnyDatabase>, Error> { ) -> Result<Wallet<AnyBlockchain, AnyDatabase>, Error> {
let network = Testnet;
let client = AnyBlockchain::from_config(blockchain_config)?; let client = AnyBlockchain::from_config(blockchain_config)?;
let database = AnyDatabase::from_config(database_config)?; let database = AnyDatabase::from_config(database_config)?;

View File

@ -13,27 +13,52 @@ pub struct TransactionDetails {
// pub transaction: Option<Transaction>, // pub transaction: Option<Transaction>,
/// Transaction id /// Transaction id
pub txid: char_p_boxed, pub txid: char_p_boxed,
/// Timestamp
pub timestamp: u64,
/// Received value (sats) /// Received value (sats)
pub received: u64, pub received: u64,
/// Sent value (sats) /// Sent value (sats)
pub sent: u64, pub sent: u64,
/// Fee value (sats) /// Fee value (sats) if known, -1 if unknown, based on backend
pub fees: u64, pub fee: i64,
/// Confirmed in block height, `None` means unconfirmed /// true if confirmed
pub height: i32, pub is_confirmed: bool,
/// Confirmed in block height
pub confirmation_time: ConfirmationTime,
/// Whether the tx has been verified against the consensus rules
pub verified: bool,
}
#[derive_ReprC]
#[repr(C)]
#[derive(Debug, Clone)]
pub struct ConfirmationTime {
/// confirmation block height, 0 if is_confirmed is false
pub height: u32,
/// confirmation block timestamp, 0 if is_confirmed is false
pub timestamp: u64,
} }
impl From<&bdk::TransactionDetails> for TransactionDetails { impl From<&bdk::TransactionDetails> for TransactionDetails {
fn from(op: &bdk::TransactionDetails) -> Self { fn from(op: &bdk::TransactionDetails) -> Self {
let fee = op.fee.map(|f| i64::try_from(f).unwrap()).unwrap_or(-1);
let confirmation_time = op
.confirmation_time
.as_ref()
.map(|c| ConfirmationTime {
height: c.height,
timestamp: c.timestamp,
})
.unwrap_or(ConfirmationTime {
height: 0,
timestamp: 0,
});
TransactionDetails { TransactionDetails {
txid: char_p_boxed::try_from(op.txid.to_string()).unwrap(), txid: char_p_boxed::try_from(op.txid.to_string()).unwrap(),
timestamp: op.timestamp,
received: op.received, received: op.received,
sent: op.sent, sent: op.sent,
fees: op.fees, fee,
height: op.height.map(|h| h as i32).unwrap_or(-1), is_confirmed: op.confirmation_time.is_some(),
confirmation_time,
verified: op.verified,
} }
} }
} }

58
test.sh
View File

@ -1,14 +1,62 @@
#!/usr/bin/env bash #!/usr/bin/env bash
set -eo pipefail -o xtrace set -eo pipefail
# functions
## help
help()
{
# Display Help
echo "Test bdk-ffi and related libraries."
echo
echo "Syntax: build [-a|h|k|v]"
echo "options:"
echo "-a Android aar tests."
echo "-h Print this Help."
echo "-k JVM jar tests."
echo "-v Valgrind tests."
echo
}
# rust # rust
c_headers() {
cargo test --features c-headers -- generate_headers cargo test --features c-headers -- generate_headers
}
# cc # cc
test_c() {
export LD_LIBRARY_PATH=`pwd`/target/debug export LD_LIBRARY_PATH=`pwd`/target/debug
#valgrind --leak-check=full --show-leak-kinds=all cc/bdk_ffi_test
cc/bdk_ffi_test cc/bdk_ffi_test
}
# bdk-kotlin test_valgrind() {
(cd bdk-kotlin && gradle test) valgrind --leak-check=full --show-leak-kinds=all cc/bdk_ffi_test
(cd bdk-kotlin && gradle :android:connectedDebugAndroidTest) }
test_kotlin() {
(cd bdk-kotlin && ./gradlew test)
}
test_android() {
(cd bdk-kotlin && ./gradlew :android:connectedDebugAndroidTest)
}
if [ $1 = "-h" ]
then
help
else
c_headers
test_c
# optional tests
while [ -n "$1" ]; do # while loop starts
case "$1" in
-a) test_android ;;
-h) help ;;
-k) test_kotlin ;;
-v) test_valgrind ;;
*) echo "Option $1 not recognized" ;;
esac
shift
done
fi