From aa004201b2f51d94d2756d9ed5dc582133a62ecc Mon Sep 17 00:00:00 2001 From: thunderbiscuit Date: Thu, 18 Aug 2022 14:35:17 -0400 Subject: [PATCH] Fix method names to mirror Rust bdk API (#185) * Fix method names to mirror Rust bdk API * Fix method names to mirror Rust bdk API --- CHANGELOG.md | 12 +++++++----- src/bdk.udl | 4 ++-- src/lib.rs | 6 +++--- 3 files changed, 12 insertions(+), 10 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e34d6e3..3db97fd 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [Unreleased] +- Breaking Changes + - Rename `get_network()` method on `Wallet` interface to `network()` [#185] + - Rename `get_transactions()` method on `Wallet` interface to `list_transactions()` [#185] + - Remove `generate_extended_key`, returned ExtendedKeyInfo [#154] + - Remove `restore_extended_key`, returned ExtendedKeyInfo [#154] + - Remove dictionary `ExtendedKeyInfo {mnenonic, xprv, fingerprint}` [#154] - APIs Added [#154] - `generate_mnemonic()`, returns string mnemonic - `interface DescriptorSecretKey` @@ -22,14 +28,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - `DescriptorSecretKey` - `DescriptorPublicKey` - `DerivationPath` -- Dictionary Removed [#154] - - `ExtendedKeyInfo {mnenonic, xprv, fingerprint}` -- APIs Removed [#154] - - `generate_extended_key`, returned ExtendedKeyInfo - - `restore_extended_key`, returned ExtendedKeyInfo [#154]: https://github.com/bitcoindevkit/bdk-ffi/pull/154 [#184]: https://github.com/bitcoindevkit/bdk-ffi/pull/184 +[#185]: https://github.com/bitcoindevkit/bdk-ffi/pull/185 ## [v0.8.0] - Update BDK to version 0.20.0 [#169] diff --git a/src/bdk.udl b/src/bdk.udl index b8b7529..a62ce7f 100644 --- a/src/bdk.udl +++ b/src/bdk.udl @@ -182,9 +182,9 @@ interface Wallet { boolean sign([ByRef] PartiallySignedBitcoinTransaction psbt); [Throws=BdkError] - sequence get_transactions(); + sequence list_transactions(); - Network get_network(); + Network network(); [Throws=BdkError] void sync([ByRef] Blockchain blockchain, Progress? progress); diff --git a/src/lib.rs b/src/lib.rs index 181f537..d089ca2 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -319,7 +319,7 @@ impl Wallet { self.wallet_mutex.lock().expect("wallet") } - fn get_network(&self) -> Network { + fn network(&self) -> Network { self.get_wallet().network() } @@ -354,7 +354,7 @@ impl Wallet { self.get_wallet().sign(&mut psbt, SignOptions::default()) } - fn get_transactions(&self) -> Result, Error> { + fn list_transactions(&self) -> Result, Error> { let transactions = self.get_wallet().list_transactions(true)?; Ok(transactions.iter().map(Transaction::from).collect()) } @@ -363,7 +363,7 @@ impl Wallet { let unspents = self.get_wallet().list_unspent()?; Ok(unspents .iter() - .map(|u| LocalUtxo::from_utxo(u, self.get_network())) + .map(|u| LocalUtxo::from_utxo(u, self.network())) .collect()) } }