chore: update libraries to official release versions

1da01b4a0b ci: change rust stable version to 0.71.0 (Steve Myers)
f1ba03bf50 ci: fix to work with bdk 0.28.1 and msrv 1.61.0 (Steve Myers)

Pull request description:

  ### Description

  Fixes CI to work with BDK 0.28.x and MSRV 1.61.0. For MSRV had to pin two dependencies.

  ### Notes to the reviewers

  I also updated in CI our 'stable" version of rust to be current stable which is `1.71.0`.

  ### Changelog notice

  None, only CI changes.

  ### Checklists

  #### All Submissions:

  * [x] I've signed all my commits
  * [x] I followed the [contribution guidelines](https://github.com/bitcoindevkit/bdk/blob/master/CONTRIBUTING.md)
  * [x] I ran `cargo fmt` and `cargo clippy` before committing

ACKs for top commit:
  thunderbiscuit:
    ACK 1da01b4a0b.

Tree-SHA512: 72f7d8dbef791daebf3f4d9d92722f1f3780d173501673ca6f47af39dd2102c85944ba603e4e9213d44a294ab1cec43dff82213fe53c5dea663279473be64a15

.github/ISSUE_TEMPLATE/enhancement_request.md

@@ -0,0 +1,17 @@
+---
+name: Enhancement request
+about: Request a new feature or change to an existing feature
+title: ''
+labels: 'enhancement'
+assignees: ''
+
+---
+
+**Describe the enhancement**  
+<!-- A clear and concise description of what you would like added or changed. -->
+
+**Use case**  
+<!-- Tell us how you or others will use this new feature or change to an existing feature. --> 
+
+**Additional context**
+<!-- Add any other context about the enhancement here. --> 

.github/ISSUE_TEMPLATE/minor_release.md

@@ -7,77 +7,81 @@ assignees: ''
 ---
 
 ## Create a new minor release
-### _Main Workflow_
+## Bumping BDK Rust Version
 1. - [ ] Open a PR with an update to `Cargo.toml` to the new bdk release candidate and ensure all CI workflows run correctly. Fix errors if necessary.
 2. - [ ] Once the new bdk release is out, update the PR to replace the release candidate with the full release and merge.
-3. - [ ] Update the Android, JVM, Python, and Swift libraries as per the ["**_Sub-Workflows_**" section below](#Sub-Workflows). Open a single PR on master for all of these changes called `Prepare language bindings libraries for 0.X release`
-18. - [ ] Create a new branch off of `master` called `release/version`
-19. - [ ] Checkout that branch and open a PR to update the Android, JVM, and Python libraries' versions
-  - [ ] Update bdk-android version from `SNAPSHOT` version to release version
-  - [ ] Update bdk-jvm version from `SNAPSHOT` version to release version
-  - [ ] Update bdk-python version from `.dev` version to release version
-20. - [ ] Merge the PR updating all of the languages to their release versions
-21. - [ ] Create the tag and make sure to add the changelog info to the tag (works better if you prepare the tag message on the side in a text editor) and push it to GitHub.
-```sh
-git tag v0.6.0 --sign --edit
-git push upstream v0.6.0
-```
-22. - [ ] Make release on GitHub (set as pre-release and generate auto release notes between the previous tag and the new one)
-23. - [ ] Trigger manual releases for all 4 libraries (for Swift, simply add the version number in the text field when running the workflow manually. Note that the version number must not contain the `v`, i.e. `0.26.0`)
-24. - [ ] Bump the versions on master from `0.9.0-SNAPSHOT` to `0.10.0-SNAPSHOT`, `0.6.0.dev0` to `0.7.0.dev0`
-25. - [ ] Build and publish API docs for JVM, Android, and Java on the website
-```bash!
-./gradlew dokkaHtml    # bdk-jvm (Dokka)
-./gradlew dokkaJavadoc # bdk-jvm (java-style documentation)
-./gradlew dokkaHtml    # bdk-android (Dokka)
-```
-26. - [ ] Tweet about the library
-27. - [ ] Post in the announcement channel
 
-### _Sub Workflows_
+### Specific Libraries' Workflows
 #### _Android_
-4. - [ ] Update the API docs to reflect the changes in the API
+3. - [ ] Update the API docs to reflect the changes in the API
-5. - [ ] Delete the `target` directory in bdk-ffi and all previous artifacts to make sure you're building the library from scratch
+4. - [ ] Delete the `target` directory in bdk-ffi and all previous artifacts to make sure you're building the library from scratch.
-6. - [ ] Build the library and run the tests, and adjust if necessary.
+5. - [ ] Build the library and run the tests, and adjust if necessary.
-```sh
+```shell
 # start an emulator prior to running the tests
-cd bdk-android
+cd ./bdk-android/
 ./gradlew buildAndroidLib
 ./gradlew connectedAndroidTest
 ```
-7. - [ ] Update the readme if necessary
+6. - [ ] Update the readme if necessary
-
 #### _JVM_
-8. - [ ] Update the API docs to reflect the changes in the API
+7. - [ ] Update the API docs to reflect the changes in the API
-9. - [ ] Delete the `target` directory in bdk-ffi and all previous artifacts to make sure you're building the library from scratch
+8. - [ ] Delete the `target` directory in bdk-ffi and all previous artifacts to make sure you're building the library from scratch
-10. - [ ] Build the library and run the tests, and adjust if necessary
+9. - [ ] Build the library and run the tests, and adjust if necessary
-```sh
+```shell
-cd bdk-jvm
+cd ./bdk-jvm/
 ./gradlew buildJvmLib
 ./gradlew test
 ```
-11. - [ ] Update the readme if necessary
+10. - [ ] Update the readme if necessary
-
 #### _Swift_
-12. - [ ] Run the tests and adjust if necessary
+11. - [ ] Run the tests and adjust if necessary
-```sh
+```shell
 ./bdk-swift/build-local-swift.sh
-cd bdk-swift
+cd ./bdk-swift/
 swift test
 ```
-13. - [ ] Update the readme if necessary
+12. - [ ] Update the readme if necessary
-
 #### _Python_
-14. - [ ] Delete the `.tox`, `dist`, `build`, and `bdkpython.egg-info` and rust `target` directories to make sure you are building the library from scratch without any caches
+13. - [ ] Delete the `.tox`, `dist`, `build`, and `bdkpython.egg-info` and rust `target` directories to make sure you are building the library from scratch without any caches
-15. - [ ] Build the library
+14. - [ ] Build the library
 ```shell
+cd ./bdk-python/
 pip3 install --requirement requirements.txt
 bash ./generate.sh
 python3 setup.py --verbose bdist_wheel
 ```
-16. - [ ] Run the tests and adjust if necessary
+15. - [ ] Run the tests and adjust if necessary
 ```shell
-pip3 install ./dist/bdkpython-<yourversion>-py3-none-any.whl
+pip3 install ./dist/bdkpython-<yourversion>-py3-none-any.whl --force-reinstall
 python -m unittest --verbose tests/test_bdk.py
 ```
-17. - [ ] Update the readme and `setup.py` if necessary
+16. - [ ] Update the readme and `setup.py` if necessary
+
+### Release Workflow
+17. - [ ] Update the Android, JVM, Python, and Swift libraries as per the _Specific Libraries' Workflows_ section above. Open a single PR on master for all of these changes called `Prepare language bindings libraries for 0.X release`. See [example PR here](https://github.com/bitcoindevkit/bdk-ffi/pull/315).
+18. - [ ] Create a new branch off of `master` called `release/version`
+19. - [ ] Update bdk-android version from `SNAPSHOT` version to release version
+20. - [ ] Update bdk-jvm version from `SNAPSHOT` version to release version
+21. - [ ] Update bdk-python version from `.dev` version to release version
+22. - [ ] Open a PR to that release branch that updates the Android, JVM, and Python libraries' versions in step 19, 20, and 21. See [example PR here](https://github.com/bitcoindevkit/bdk-ffi/pull/316).
+23. - [ ] Get a review and ACK and merge the PR updating all the languages to their release versions
+24. - [ ] Create the tag for the release and make sure to add the changelog info to the tag (works better if you prepare the tag message on the side in a text editor). Push the tag to GitHub.
+```shell
+git tag v0.6.0 --sign --edit
+git push upstream v0.6.0
+```
+25. - [ ] Trigger manual releases for all 4 libraries (for Swift, trigger the release on `master` and simply add the version number in the text field when running the workflow manually. Note that the version number must not contain the `v`, i.e. `0.26.0`)
+26. - [ ] Make sure the released libraries work and contain the artifacts you would expect 
+27. - [ ] Aggregate all the changelog notices from the PRs and add them to the changelog file
+28. - [ ] Bump the versions on master from `0.9.0-SNAPSHOT` to `0.10.0-SNAPSHOT`, `0.6.0.dev0` to `0.7.0.dev0`
+29. - [ ] Apply changes to the minor_release and patch_release issue templates if they need any
+30. - [ ] Open a PR on master with the changes in steps 29, 30, and 31. See [example PR here](https://github.com/bitcoindevkit/bdk-ffi/pull/317). Get a review and merge the PR.
+31. - [ ] Make release on GitHub (set as pre-release and generate auto release notes between the previous tag and the new one)
+32. - [ ] Build and publish API docs for JVM, Android, and Java on the website
+```shell
+./gradlew dokkaHtml    # bdk-jvm (Dokka)
+./gradlew dokkaJavadoc # bdk-jvm (java-style documentation)
+./gradlew dokkaHtml    # bdk-android (Dokka)
+```
+33. - [ ] Post in the announcement channel
+34. - [ ] Tweet about the library

.github/ISSUE_TEMPLATE/patch_release.md

@@ -1,83 +0,0 @@
----
-name: Patch Release
-about: Create a new patch release [for release managers only]
-title: 'Release MAJOR.MINOR.PATCH+1'
-labels: 'release'
-assignees: ''
----
-
-## Create a new patch release
-### _Main Workflow_
-1. - [ ] Open a PR with an update to `Cargo.toml` to the new bdk release candidate and ensure all CI workflows run correctly. Fix errors if necessary.
-2. - [ ] Once the new bdk release is out, update the PR to replace the release candidate with the full release and merge.
-3. - [ ] Update the Android, JVM, Python, and Swift libraries as per the ["**_Sub-Workflows_**" section below](#Sub-Workflows). Open a single PR on master for all of these changes called `Prepare language bindings libraries for 0.X release`
-18. - [ ] Create a new branch off of `master` called `release/version`
-19. - [ ] Checkout that branch and open a PR to update the Android, JVM, and Python libraries' versions
-- [ ] Update bdk-android version from `SNAPSHOT` version to release version
-- [ ] Update bdk-jvm version from `SNAPSHOT` version to release version
-- [ ] Update bdk-python version from `.dev` version to release version
-20. - [ ] Merge the PR updating all of the languages to their release versions
-21. - [ ] Create the tag and make sure to add the changelog info to the tag (works better if you prepare the tag message on the side in a text editor) and push it to GitHub.
-```sh
-git tag v0.6.0 --sign --edit
-git push upstream v0.6.0
-```
-22. - [ ] Make release on GitHub (set as pre-release and generate auto release notes between the previous tag and the new one)
-23. - [ ] Trigger manual releases for all 4 libraries (for Swift, simply add the version number in the text field when running the workflow manually. Note that the version number must not contain the `v`, i.e. `0.26.0`)
-24. - [ ] Bump the versions on master from `0.9.0-SNAPSHOT` to `0.10.0-SNAPSHOT`, `0.6.0.dev0` to `0.7.0.dev0`
-25. - [ ] Build and publish API docs for JVM, Android, and Java on the website
-```bash!
-./gradlew dokkaHtml    # bdk-jvm (Dokka)
-./gradlew dokkaJavadoc # bdk-jvm (java-style documentation)
-./gradlew dokkaHtml    # bdk-android (Dokka)
-```
-26. - [ ] Tweet about the library
-27. - [ ] Post in the announcement channel
-
-### _Sub Workflows_
-#### _Android_
-4. - [ ] Update the API docs to reflect the changes in the API
-5. - [ ] Delete the `target` directory in bdk-ffi and all previous artifacts to make sure you're building the library from scratch
-6. - [ ] Build the library and run the tests, and adjust if necessary.
-```sh
-# start an emulator prior to running the tests
-cd bdk-android
-./gradlew buildAndroidLib
-./gradlew connectedAndroidTest
-```
-7. - [ ] Update the readme if necessary
-
-#### _JVM_
-8. - [ ] Update the API docs to reflect the changes in the API
-9. - [ ] Delete the `target` directory in bdk-ffi and all previous artifacts to make sure you're building the library from scratch
-10. - [ ] Build the library and run the tests, and adjust if necessary
-```sh
-cd bdk-jvm
-./gradlew buildJvmLib
-./gradlew test
-```
-11. - [ ] Update the readme if necessary
-
-#### _Swift_
-12. - [ ] Run the tests and adjust if necessary
-```sh
-./bdk-swift/build-local-swift.sh
-cd bdk-swift
-swift test
-```
-13. - [ ] Update the readme if necessary
-
-#### _Python_
-14. - [ ] Delete the `.tox`, `dist`, `build`, and `bdkpython.egg-info` and rust `target` directories to make sure you are building the library from scratch without any caches
-15. - [ ] Build the library
-```shell
-pip3 install --requirement requirements.txt
-bash ./generate.sh
-python3 setup.py --verbose bdist_wheel
-```
-16. - [ ] Run the tests and adjust if necessary
-```shell
-pip3 install ./dist/bdkpython-<yourversion>-py3-none-any.whl
-python -m unittest --verbose tests/test_bdk.py
-```
-17. - [ ] Update the readme and `setup.py` if necessary

.github/workflows/audit.yml

@@ -13,7 +13,7 @@ jobs:
     name: Security audit
     runs-on: ubuntu-20.04
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: actions-rs/audit-check@v1
         with:
           token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/cont_integration.yml

@@ -14,18 +14,18 @@ jobs:
     strategy:
       matrix:
         rust:
-          - version: 1.63.0 # STABLE
+          - version: 1.71.0 # STABLE
             clippy: true
           - version: 1.61.0 # MSRV
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Generate cache key
         run: echo "${{ matrix.rust.version }} ${{ matrix.features }}" | tee .cache_key
 
       - name: Cache
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         with:
           path: |
             ~/.cargo/registry
@@ -46,6 +46,12 @@ jobs:
       - name: Update toolchain
         run: rustup update
 
+      - name: Pin dependencies for MSRV
+        if: matrix.rust.version == '1.61.0'
+        run: |
+          cargo update -p hashlink --precise "0.8.1"
+          cargo update -p tokio --precise "1.29.1"
+          cargo update -p flate2 --precise "1.0.26"
       - name: Build
         run: cargo build
 
@@ -61,7 +67,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Set default toolchain
         run: rustup default nightly

.github/workflows/publish-android.yaml

@@ -1,15 +1,29 @@
 name: Publish bdk-android to Maven Central
 on: [workflow_dispatch]
 
+# The default Android NDK on the ubuntu-22.04 image is 25.2.9519653
+# We replace the default environment variable ANDROID_NDK_ROOT: /usr/local/lib/android/sdk/ndk/25.2.9519653
+# with an older version of the NDK (21.4.7075529) using the fix proposed here: https://github.com/actions/runner-images/issues/5930
+# For information on why this is needed at the moment see issues #242 and #243, and PR #282
+env:
+  ANDROID_NDK_ROOT: /usr/local/lib/android/sdk/ndk/21.4.7075529
+
 jobs:
   build:
     runs-on: ubuntu-20.04
     steps:
+      - name: "Install Android NDK 21.4.7075529"
+        run: |
+          ANDROID_ROOT=/usr/local/lib/android
+          ANDROID_SDK_ROOT=${ANDROID_ROOT}/sdk
+          SDKMANAGER=${ANDROID_SDK_ROOT}/cmdline-tools/latest/bin/sdkmanager
+          echo "y" | $SDKMANAGER "ndk;21.4.7075529"
+
       - name: "Check out PR branch"
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: "Cache"
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         with:
           path: |
             ~/.cargo/registry
@@ -18,11 +32,14 @@ jobs:
           key: ${{ runner.os }}-${{ hashFiles('**/Cargo.toml','**/Cargo.lock') }}
 
       - name: "Set up JDK"
-        uses: actions/setup-java@v2
+        uses: actions/setup-java@v3
         with:
           distribution: temurin
           java-version: 11
 
+      - name: "Set default Rust version to 1.67.0"
+        run: rustup default 1.67.0
+
       - name: "Install Rust Android targets"
         run: rustup target add x86_64-linux-android aarch64-linux-android armv7-linux-androideabi
 

.github/workflows/publish-jvm.yaml

@@ -2,14 +2,14 @@ name: Publish bdk-jvm to Maven Central
 on: [workflow_dispatch]
 
 jobs:
-  build-jvm-macOS-M1-native-lib:
+  build-macOS-native-libs:
-    name: "Create M1 and x86_64 JVM native binaries"
+    name: "Create M1 and x86_64 native binaries"
     runs-on: macos-12
     steps:
       - name: "Checkout publishing branch"
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
-      - name: Cache
+      - name: "Cache"
         uses: actions/cache@v3
         with:
           path: |
@@ -18,42 +18,68 @@ jobs:
             ./target
           key: ${{ runner.os }}-${{ hashFiles('**/Cargo.toml','**/Cargo.lock') }}
 
-      - name: Set up JDK
+      - name: "Set up JDK"
-        uses: actions/setup-java@v2
+        uses: actions/setup-java@v3
         with:
           distribution: temurin
           java-version: 11
 
-      - name: Install aarch64 Rust target
+      - name: "Set default Rust version to 1.67.0"
+        run: rustup default 1.67.0
+
+      - name: "Install aarch64 Rust target"
         run: rustup target add aarch64-apple-darwin
 
-      - name: Build bdk-jvm library
+      - name: "Build bdk-jvm library"
         run: |
           cd bdk-jvm
           ./gradlew buildJvmLib
 
-      # build aarch64 + x86_64 native libraries and upload
+      - name: "Upload macOS native libraries for reuse in publishing job"
-      - name: Upload macOS native libraries for reuse in publishing job
         uses: actions/upload-artifact@v3
         with:
-          # name: no name is required because we upload the entire directory
+          name: artifact-macos
-          # the default name "artifact" will be used
           path: /Users/runner/work/bdk-ffi/bdk-ffi/bdk-jvm/lib/src/main/resources/
 
-  build-jvm-full-library:
+  build-windows-native-lib:
-    name: Create full bdk-jvm library
+    name: "Create Windows native binaries"
-    needs: [build-jvm-macOS-M1-native-lib]
+    runs-on: windows-2022
-    runs-on: ubuntu-22.04
     steps:
-      - name: Checkout publishing branch
+      - name: "Checkout publishing branch"
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
-      - name: Update bdk-ffi git submodule
+      - name: "Set up JDK"
+        uses: actions/setup-java@v3
+        with:
+          distribution: temurin
+          java-version: 11
+
+      - name: "Set default Rust version to 1.67.0"
+        run: rustup default 1.67.0
+
+      - name: "Install x86_64-pc-windows-msvc Rust target"
+        run: rustup target add x86_64-pc-windows-msvc
+
+      - name: "Build bdk-jvm library"
         run: |
-          git submodule set-url bdk-ffi https://github.com/bitcoindevkit/bdk-ffi.git
+          cd bdk-jvm
-          git submodule update --init bdk-ffi
+          ./gradlew buildJvmLib
 
-      - name: Cache
+      - name: "Upload Windows native libraries for reuse in publishing job"
+        uses: actions/upload-artifact@v3
+        with:
+          name: artifact-windows
+          path: D:\a\bdk-ffi\bdk-ffi\bdk-jvm\lib\src\main\resources\
+
+  build-full-library:
+    name: Create full bdk-jvm library
+    needs: [build-macOS-native-libs, build-windows-native-lib]
+    runs-on: ubuntu-20.04
+    steps:
+      - name: "Checkout publishing branch"
+        uses: actions/checkout@v3
+
+      - name: "Cache"
         uses: actions/cache@v3
         with:
           path: |
@@ -62,26 +88,39 @@ jobs:
             ./target
           key: ${{ runner.os }}-${{ hashFiles('**/Cargo.toml','**/Cargo.lock') }}
 
-      - name: Set up JDK
+      - name: "Set up JDK"
-        uses: actions/setup-java@v2
+        uses: actions/setup-java@v3
         with:
           distribution: temurin
           java-version: 11
 
-      - name: Build bdk-jvm library
+      - name: "Set default Rust version to 1.67.0"
+        run: rustup default 1.67.0
+
+      - name: "Build bdk-jvm library"
         run: |
           cd bdk-jvm
           ./gradlew buildJvmLib
 
-      - name: Download macOS native libraries from previous job
+      - name: "Download macOS native binaries from previous job"
         uses: actions/download-artifact@v3
-        id: download
         with:
-          # download the artifact created in the prior job (named "artifact")
+          name: artifact-macos
-          name: artifact
           path: ./bdk-jvm/lib/src/main/resources/
 
-      - name: Publish to Maven Central
+      - name: "Download Windows native libraries from previous job"
+        uses: actions/download-artifact@v3
+        with:
+          name: artifact-windows
+          path: ./bdk-jvm/lib/src/main/resources/
+
+      - name: "Upload library code and binaries"
+        uses: actions/upload-artifact@v3
+        with:
+          name: artifact-full
+          path: ./bdk-jvm/lib/
+
+      - name: "Publish to Maven Central"
         env:
           ORG_GRADLE_PROJECT_signingKeyId: ${{ secrets.PGP_KEY_ID }}
           ORG_GRADLE_PROJECT_signingKey: ${{ secrets.PGP_SECRET_KEY }}

.github/workflows/publish-python.yaml

@@ -1,4 +1,4 @@
-name: Build and publish Python wheels
+name: Publish bdkpython to PyPI
 on: [workflow_dispatch]
 
 # We use manylinux2014 because older CentOS versions used by 2010 and 1 have a very old glibc version, which
@@ -7,9 +7,9 @@ on: [workflow_dispatch]
 # tries to load glibc and fails because it requires a more recent version.
 
 jobs:
-  build-manylinux2014-x86_64-wheel:
+  build-manylinux2014-x86_64-wheels:
     name: "Build Manylinux 2014 x86_64 wheel"
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-20.04
     defaults:
       run:
         working-directory: bdk-python
@@ -21,77 +21,106 @@ jobs:
     strategy:
       matrix:
         python: # Update this list whenever the docker image is updated (check /opt/python/)
-          - cp36-cp36m
-          - cp37-cp37m
           - cp38-cp38
           - cp39-cp39
           - cp310-cp310
-          - pp37-pypy37_pp73
-          - pp38-pypy38_pp73
     steps:
       - name: "Checkout"
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           submodules: true
       - uses: actions-rs/toolchain@v1
         with:
           toolchain: stable
 
-      - name: "Install requirements"
+      - name: "Generate bdk.py and binaries"
-        run: ${PYBIN}/pip install -r requirements.txt
+        run: bash ./scripts/generate-linux.sh
-
-      - name: "Generate bdk.py"
-        run: bash generate.sh
 
       - name: "Build wheel"
-        run: ${PYBIN}/python setup.py bdist_wheel --verbose
+        # Specifying the plat-name argument is necessary to build a wheel with the correct name,
+        # see issue #350 for more information
+        run: ${PYBIN}/python setup.py bdist_wheel --plat-name manylinux_2_17_x86_64 --verbose
 
-      - uses: actions/upload-artifact@v2
+      - uses: actions/upload-artifact@v3
         with:
           name: bdkpython-manylinux2014-x86_64-${{ matrix.python }}
           path: /home/runner/work/bdk-ffi/bdk-ffi/bdk-python/dist/*.whl
 
-  build-macos-universal-wheel:
+  build-macos-arm64-wheels:
-    name: "Build macOS universal wheel"
+    name: "Build macOS arm64 wheel"
-    runs-on: macos-12
+    runs-on: macos-13
     defaults:
       run:
         working-directory: bdk-python
     strategy:
       matrix:
         python:
-          - '3.7'
+          - "3.8"
-          - '3.8'
+          - "3.9"
-          - '3.9'
+          - "3.10"
-          - '3.10'
     steps:
       - name: "Checkout"
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           submodules: true
-      - uses: actions/setup-python@v2
+
+      - name: "Install Python"
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python }}
 
-      - name: "Generate bdk.py"
+      - name: "Generate bdk.py and binaries"
-        run: |
+        run: bash ./scripts/generate-macos-arm64.sh
-          python3 --version
-          rustup target add aarch64-apple-darwin
-          pip3 install --user -r requirements.txt
-          bash generate.sh
 
       - name: "Build wheel"
-        env:
+        # Specifying the plat-name argument is necessary to build a wheel with the correct name,
-          ARCHFLAGS: "-arch x86_64 -arch arm64"
+        # see issue #350 for more information
-        run: python3 setup.py bdist_wheel --verbose
+        run: python3 setup.py bdist_wheel --plat-name macosx_11_0_arm64 --verbose
 
-      - uses: actions/upload-artifact@v2
+      - name: "Upload artifacts"
+        uses: actions/upload-artifact@v3
         with:
-          name: bdkpython-macos-${{ matrix.python }}
+          name: bdkpython-macos-arm64-${{ matrix.python }}
           path: /Users/runner/work/bdk-ffi/bdk-ffi/bdk-python/dist/*.whl
 
-  build-windows-wheel:
+  build-macos-x86_64-wheels:
-    name: "Build windows wheel"
+    name: "Build macOS x86_64 wheel"
+    runs-on: macos-13
+    defaults:
+      run:
+        working-directory: bdk-python
+    strategy:
+      matrix:
+        python:
+          - "3.8"
+          - "3.9"
+          - "3.10"
+    steps:
+      - name: "Checkout"
+        uses: actions/checkout@v3
+        with:
+          submodules: true
+
+      - name: "Install Python"
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python }}
+
+      - name: "Generate bdk.py and binaries"
+        run: bash ./scripts/generate-macos-x86_64.sh
+
+      - name: "Build wheel"
+        # Specifying the plat-name argument is necessary to build a wheel with the correct name,
+        # see issue #350 for more information
+        run: python3 setup.py bdist_wheel --plat-name macosx_11_0_x86_64 --verbose
+
+      - uses: actions/upload-artifact@v3
+        with:
+          name: bdkpython-macos-x86_64-${{ matrix.python }}
+          path: /Users/runner/work/bdk-ffi/bdk-ffi/bdk-python/dist/*.whl
+
+  build-windows-wheels:
+    name: "Build Windows wheel"
     runs-on: windows-2022
     defaults:
       run:
@@ -99,46 +128,43 @@ jobs:
     strategy:
       matrix:
         python:
-          - '3.7'
+          - "3.8"
-          - '3.8'
+          - "3.9"
-          - '3.9'
+          - "3.10"
-          - '3.10'
     steps:
       - name: "Checkout"
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           submodules: true
-      - uses: actions/setup-python@v2
+      - uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python }}
 
-      - name: "Generate bdk.py"
+      - name: "Generate bdk.py and binaries"
-        run: |
+        run: bash ./scripts/generate-windows.sh
-          python --version
-          pip install --user -r requirements.txt
-          bash generate.sh
 
       - name: "Build wheel"
         run: python setup.py bdist_wheel --verbose
 
-      - uses: actions/upload-artifact@v2
+      - name: "Upload artifacts"
+        uses: actions/upload-artifact@v3
         with:
           name: bdkpython-win-${{ matrix.python }}
           path: D:\a\bdk-ffi\bdk-ffi\bdk-python\dist\*.whl
 
   publish-pypi:
     name: "Publish on PyPI"
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-20.04
     defaults:
       run:
         working-directory: bdk-python
-    needs: [build-manylinux2014-x86_64-wheel, build-macos-universal-wheel, build-windows-wheel]
+    needs: [build-manylinux2014-x86_64-wheels, build-macos-arm64-wheels, build-macos-x86_64-wheels, build-windows-wheels]
     steps:
       - name: "Checkout"
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: "Download artifacts in dist/ directory"
-        uses: actions/download-artifact@v2
+        uses: actions/download-artifact@v3
         with:
           path: dist/
 

.github/workflows/test-android.yaml

@@ -1,5 +1,6 @@
 name: Test Android
 on:
+  workflow_dispatch:
   push:
     paths:
       - "bdk-ffi/**"
@@ -9,15 +10,29 @@ on:
       - "bdk-ffi/**"
       - "bdk-android/**"
 
+# The default Android NDK on the ubuntu-22.04 image is 25.2.9519653
+# We replace the default environment variable ANDROID_NDK_ROOT: /usr/local/lib/android/sdk/ndk/25.2.9519653
+# with an older version of the NDK (21.4.7075529) using the fix proposed here: https://github.com/actions/runner-images/issues/5930
+# For information on why this is needed at the moment see issues #242 and #243, and PR #282
+env:
+  ANDROID_NDK_ROOT: /usr/local/lib/android/sdk/ndk/21.4.7075529
+
 jobs:
   build:
     runs-on: ubuntu-20.04
     steps:
+      - name: "Install Android NDK 21.4.7075529"
+        run: |
+          ANDROID_ROOT=/usr/local/lib/android
+          ANDROID_SDK_ROOT=${ANDROID_ROOT}/sdk
+          SDKMANAGER=${ANDROID_SDK_ROOT}/cmdline-tools/latest/bin/sdkmanager
+          echo "y" | $SDKMANAGER "ndk;21.4.7075529"
+
       - name: "Check out PR branch"
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: "Cache"
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         with:
           path: |
             ~/.cargo/registry
@@ -26,15 +41,25 @@ jobs:
           key: ${{ runner.os }}-${{ hashFiles('**/Cargo.toml','**/Cargo.lock') }}
 
       - name: "Set up JDK"
-        uses: actions/setup-java@v2
+        uses: actions/setup-java@v3
         with:
           distribution: temurin
           java-version: 11
 
+      - name: "Set default Rust version to 1.67.0"
+        run: rustup default 1.67.0
+
       - name: "Install Rust Android targets"
         run: rustup target add x86_64-linux-android aarch64-linux-android armv7-linux-androideabi
 
-      - name: "Run Android tests"
+      - name: "Build Android library"
         run: |
           cd bdk-android
-          ./gradlew test --console=rich
+          ./gradlew buildAndroidLib
+
+# There are currently no unit tests for bdk-android and the integration tests require the macOS image
+# which is not working with the older NDK version we are using, so for now we just make sure that the library builds.
+#      - name: "Run Android unit tests"
+#        run: |
+#          cd bdk-android
+#          ./gradlew test --console=rich

.github/workflows/test-jvm.yaml

@@ -1,5 +1,6 @@
 name: Test Kotlin/JVM
 on:
+  workflow_dispatch:
   push:
     paths:
       - "bdk-ffi/**"
@@ -13,11 +14,11 @@ jobs:
   build:
     runs-on: ubuntu-20.04
     steps:
-      - name: Check out PR branch
+      - name: "Check out PR branch"
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
-      - name: Cache
+      - name: "Cache"
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         with:
           path: |
             ~/.cargo/registry
@@ -25,13 +26,16 @@ jobs:
             ./target
           key: ${{ runner.os }}-${{ hashFiles('**/Cargo.toml','**/Cargo.lock') }}
 
-      - name: Set up JDK
+      - name: "Set up JDK"
-        uses: actions/setup-java@v2
+        uses: actions/setup-java@v3
         with:
           distribution: temurin
           java-version: 11
 
-      - name: Run JVM tests
+      - name: "Set default Rust version to 1.67.0"
+        run: rustup default 1.67.0
+
+      - name: "Run JVM tests"
         run: |
           cd bdk-jvm
-          ./gradlew test --console=rich
+          ./gradlew test

.github/workflows/test-python.yaml

@@ -1,5 +1,6 @@
 name: Test Python
 on:
+  workflow_dispatch:
   push:
     paths:
       - "bdk-ffi/**"
@@ -15,9 +16,9 @@ on:
 # tries to load glibc and fails because it requires a more recent version.
 
 jobs:
-  build-manylinux2014-x86_64-wheel:
+  build-manylinux2014-x86_64-wheels:
     name: "Build and test Manylinux 2014 x86_64 wheels"
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-20.04
     defaults:
       run:
         working-directory: bdk-python
@@ -29,28 +30,25 @@ jobs:
     strategy:
       matrix:
         python:
-          # - cp36-cp36m
+          - cp38-cp38
-          # - cp37-cp37m
+          - cp39-cp39
-          # - cp38-cp38
-          # - cp39-cp39
           - cp310-cp310
     steps:
       - name: "Checkout"
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           submodules: true
       - uses: actions-rs/toolchain@v1
         with:
           toolchain: stable
 
-      - name: "Install requirements"
+      - name: "Generate bdk.py and binaries"
-        run: ${PYBIN}/pip install -r requirements.txt
+        run: bash ./scripts/generate-linux.sh
-
-      - name: "Generate bdk.py"
-        run: bash generate.sh
 
       - name: "Build wheel"
-        run: ${PYBIN}/python setup.py bdist_wheel --verbose
+        # Specifying the plat-name argument is necessary to build a wheel with the correct name,
+        # see issue #350 for more information
+        run: ${PYBIN}/python setup.py bdist_wheel --plat-name manylinux_2_17_x86_64 --verbose
 
       - name: "Install wheel"
         run: ${PYBIN}/pip install ./dist/*.whl
@@ -59,44 +57,82 @@ jobs:
         run: ${PYBIN}/python -m unittest tests/test_bdk.py --verbose
 
       - name: "Upload artifact test"
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: bdkpython-manylinux2014-x86_64-${{ matrix.python }}
           path: /home/runner/work/bdk-ffi/bdk-ffi/bdk-python/dist/*.whl
 
-  build-macos-universal-wheel:
+  build-macos-arm64-wheels:
-    name: "Build and test macOS wheels"
+    name: "Build and test macOS arm64 wheels"
-    runs-on: macos-12
+    runs-on: macos-13
     defaults:
       run:
         working-directory: bdk-python
     strategy:
       matrix:
         python:
-          # - '3.7'
+          - "3.8"
-          # - '3.8'
+          - "3.9"
-          # - '3.9'
+          - "3.10"
-          - '3.10'
     steps:
-      - name: Checkout
+      - name: "Checkout"
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           submodules: true
-      - uses: actions/setup-python@v2
+
+      - name: "Install Python"
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python }}
 
-      - name: "Generate bdk.py"
+      - name: "Generate bdk.py and binaries"
-        run: | 
+        run: bash ./scripts/generate-macos-arm64.sh
-          python3 --version
-          rustup target add aarch64-apple-darwin
-          pip3 install --user -r requirements.txt
-          bash generate.sh
 
       - name: "Build wheel"
-        env:
+        # Specifying the plat-name argument is necessary to build a wheel with the correct name,
-          ARCHFLAGS: "-arch x86_64 -arch arm64"
+        # see issue #350 for more information
-        run: python3 setup.py bdist_wheel --verbose
+        run: python3 setup.py bdist_wheel --plat-name macosx_11_0_arm64 --verbose
+
+      # You can't install the arm64 wheel on the CI, so we skip these steps and simply test that the wheel builds
+      # - name: "Install wheel and run tests"
+      #   run: |
+      #     pip3 install ./dist/*.whl
+      #     python3 -m unittest tests/test_bdk.py --verbose
+
+      - name: "Upload artifact test"
+        uses: actions/upload-artifact@v3
+        with:
+          name: bdkpython-macos-arm64-${{ matrix.python }}
+          path: /Users/runner/work/bdk-ffi/bdk-ffi/bdk-python/dist/*.whl
+
+  build-macos-x86_64-wheels:
+    name: "Build and test macOS x86_64 wheels"
+    runs-on: macos-13
+    defaults:
+      run:
+        working-directory: bdk-python
+    strategy:
+      matrix:
+        python:
+          - "3.8"
+          - "3.9"
+          - "3.10"
+    steps:
+      - name: "Checkout"
+        uses: actions/checkout@v3
+        with:
+          submodules: true
+      - uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python }}
+
+      - name: "Generate bdk.py and binaries"
+        run: bash ./scripts/generate-macos-x86_64.sh
+
+      - name: "Build wheel"
+        # Specifying the plat-name argument is necessary to build a wheel with the correct name,
+        # see issue #350 for more information
+        run: python3 setup.py bdist_wheel --plat-name macosx_11_0_x86_64 --verbose
 
       - name: "Install wheel"
         run: pip3 install ./dist/*.whl
@@ -104,7 +140,13 @@ jobs:
       - name: "Run tests"
         run: python3 -m unittest tests/test_bdk.py --verbose
 
-  build-windows-wheel:
+      - name: "Upload artifact test"
+        uses: actions/upload-artifact@v3
+        with:
+          name: bdkpython-macos-x86_64-${{ matrix.python }}
+          path: /Users/runner/work/bdk-ffi/bdk-ffi/bdk-python/dist/*.whl
+
+  build-windows-wheels:
     name: "Build and test Windows wheels"
     runs-on: windows-2022
     defaults:
@@ -113,35 +155,35 @@ jobs:
     strategy:
       matrix:
         python:
-          # - '3.7'
+          - "3.8"
-          # - '3.8'
+          - "3.9"
-          # - '3.9'
+          - "3.10"
-          - '3.10'
     steps:
       - name: "Checkout"
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           submodules: true
-      - uses: actions/setup-python@v2
+
+      - name: "Install Python"
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python }}
 
-      - name: "Generate bdk.py"
+      - name: "Generate bdk.py and binaries"
-        run: |
+        run: bash ./scripts/generate-windows.sh
-          python --version
-          pip install --user -r requirements.txt
-          bash generate.sh
 
       - name: "Build wheel"
         run: python setup.py bdist_wheel --verbose
 
-      # TODO: On Windows the pip install ./dist/*.whl step fails with the following error:
+      - name: "Upload artifact test"
-      # Run pip install ./dist/*.whl
+        uses: actions/upload-artifact@v3
-      # WARNING: Requirement './dist/*.whl' looks like a filename, but the file does not exist
+        with:
-      # ERROR: *.whl is not a valid wheel filename.*.whl is not a valid wheel name
+          name: bdkpython-windows-${{ matrix.python }}
-      # So we skip the installing and the tests and simply test that the wheel builds
+          path: D:\a\bdk-ffi\bdk-ffi\bdk-python\dist\*.whl
 
-      # - name: Install wheel
+      - name: "Install dependencies"
-      #   run: pip install ./dist/*.whl
+        run: Get-ChildItem 'D:\a\bdk-ffi\bdk-ffi\bdk-python\dist\*.whl' | ForEach-Object {pip install $_.FullName}
-      # - name: Run tests
+        shell: powershell
-      #   run: python -m unittest tests/test_bdk.py --verbose
+
+      - name: "Run tests"
+        run: python -m unittest tests/test_bdk.py --verbose

.github/workflows/test-swift.yaml

@@ -1,5 +1,6 @@
 name: Test Swift
 on:
+  workflow_dispatch:
   push:
     paths:
       - "bdk-ffi/**"
@@ -14,7 +15,10 @@ jobs:
     runs-on: macos-12
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
+
+      - name: "Set default Rust version to 1.67.0"
+        run: rustup default 1.67.0
 
       - name: Install Rust targets
         run: |
@@ -32,7 +36,7 @@ jobs:
       - name: Build bdk-ffi for aarch64-apple-darwin
         run: cargo build --package bdk-ffi --profile release-smaller --target aarch64-apple-darwin
 
-      - name: Create lipo-ios-sim and lipo-macos
+      - name: Create lipo-macos
         run: |
           mkdir -p target/lipo-macos/release-smaller
           lipo target/aarch64-apple-darwin/release-smaller/libbdkffi.a target/x86_64-apple-darwin/release-smaller/libbdkffi.a -create -output target/lipo-macos/release-smaller/libbdkffi.a

CHANGELOG.md

@@ -1,14 +1,46 @@
 # Changelog
-All notable changes to this project prior to release **0.9.0** are documented in this file. Future
+Changelog information can also be found in each release's git tag (which can be viewed with `git tag -ln100 "v*"`), as well as on the [GitHub releases](https://github.com/bitcoindevkit/bdk-ffi/releases) page. See [DEVELOPMENT_CYCLE.md](DEVELOPMENT_CYCLE.md) for more details.
-changelog information can be found in each release's git tag and can be viewed with `git tag -ln100 "v*"`.
-Changelog info is also documented on the [GitHub releases](https://github.com/bitcoindevkit/bdk-ffi/releases)
-page. See [DEVELOPMENT_CYCLE.md](DEVELOPMENT_CYCLE.md) for more details.
 
 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).
 
+## [0.29.0]
+This release has a number of new APIs, and adds support for Windows in bdk-jvm.
+
+Changelog
+- Add support for Windows in bdk-jvm [#336]
+- Add support for older version of Linux distros in bdk-jvm [#345]
+- APIs added
+  - Expose `is_mine()` method on the `Wallet` type [#355]
+  - Expose `to_bytes()` method on the `Script` type [#369]
+
+[#336]: https://github.com/bitcoindevkit/bdk-ffi/pull/336
+[#345]: https://github.com/bitcoindevkit/bdk-ffi/pull/345
+[#355]: https://github.com/bitcoindevkit/bdk-ffi/pull/355
+[#369]: https://github.com/bitcoindevkit/bdk-ffi/pull/369
+
+## [v0.28.0]
+- Update BDK to version 0.28.0 [#341]
+- Drop support of pypy releases of Python libraries [#351]
+- Drop support for Python 3.6 and 3.7 [#351]
+- Drop support for very old Linux versions that do not support the manylinux_2_17_x86_64 platform tag [#351]
+- APIs changed:
+  - Expose Address payload and network properties. [#325]
+  - Add SignOptions to Wallet.sign() params. [#326]
+  - address field on `AddressInfo` type is now of type `Address` [#333]
+  - new PartiallySignedTransaction.json_serialize() function to get JSON serialized value of all PSBT fields. [#334]
+  - Add from_script constructor to `Address` type [#337]
+
+[#325]: https://github.com/bitcoindevkit/bdk-ffi/pull/325
+[#326]: https://github.com/bitcoindevkit/bdk-ffi/pull/326
+[#333]: https://github.com/bitcoindevkit/bdk-ffi/pull/333
+[#334]: https://github.com/bitcoindevkit/bdk-ffi/pull/334
+[#337]: https://github.com/bitcoindevkit/bdk-ffi/pull/337
+[#341]: https://github.com/bitcoindevkit/bdk-ffi/pull/341
+[#351]: https://github.com/bitcoindevkit/bdk-ffi/pull/351
+
 ## [v0.27.1]
-- Update BDK to latest version 0.27.1 [#312]
+- Update BDK to version 0.27.1 [#312]
 - APIs changed
   - `PartiallySignedTransaction.extract_tx()` returns a `Transaction` instead of the transaction bytes. [#296]
   - `Blockchain.broadcast()` takes a `Transaction` instead of a `PartiallySignedTransaction`. [#296]
@@ -23,7 +55,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 [#312]: https://github.com/bitcoindevkit/bdk-ffi/pull/312
 
 ## [v0.26.0]
-- Update BDK to latest version 0.26.0 [#288]
+- Update BDK to version 0.26.0 [#288]
 - APIs changed
   - The descriptor and change_descriptor arguments on the wallet constructor now take a `Descriptor` instead of a `String`. [#260]
   - TxBuilder.drain_to() argument is now `Script` instead of address `String`. [#279]
@@ -46,7 +78,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 [#288]: https://github.com/bitcoindevkit/bdk-ffi/pull/288
 
 ## [v0.25.0]
-- Update BDK to latest version 0.25.0 [#272]
+- Update BDK to version 0.25.0 [#272]
 - APIs Added:
   - from_string() constructors now available on DescriptorSecretKey and DescriptorPublicKey [#247]
 
@@ -54,7 +86,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 [#272]: https://github.com/bitcoindevkit/bdk-ffi/pull/272
 
 ## [v0.11.0]
-- Update BDK to latest version 0.24.0 [#221]
+- Update BDK to version 0.24.0 [#221]
 - APIs changed
   - The constructor on the DescriptorSecretKey type now takes a Mnemonic instead of a String.
 - APIs added
@@ -70,7 +102,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 [#221]: https://github.com/bitcoindevkit/bdk-ffi/pull/221
 
 ## [v0.10.0]
-- Update BDK to latest version 0.23.0 [#204]
+- Update BDK to version 0.23.0 [#204]
 - Update uniffi-rs to latest version 0.21.0 [#216]
 - Breaking Changes
   - Changed `TxBuilder.finish()` to return new `TxBuilderResult` [#209]
@@ -103,7 +135,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - APIs Added [#154]
   - `generate_mnemonic()`, returns string mnemonic
   - `interface DescriptorSecretKey`
-    - `new(Network, string_mnenoinc, password)`, contructs DescriptorSecretKey
+    - `new(Network, string_mnenoinc, password)`, constructs DescriptorSecretKey
     - `derive(DerivationPath)`, derives and returns child DescriptorSecretKey
     - `extend(DerivationPath)`, extends and returns DescriptorSecretKey
     - `as_public()`, returns DescriptorSecretKey as DescriptorPublicKey
@@ -183,8 +215,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 [BIP 0174]:https://github.com/bitcoin/bips/blob/master/bip-0174.mediawiki#encoding
 
-## [v0.2.0]
+[v0.29.0]: https://github.com/bitcoindevkit/bdk-ffi/compare/v0.28.0...v0.29.0
-
+[v0.28.0]: https://github.com/bitcoindevkit/bdk-ffi/compare/v0.27.1...v0.28.0
 [v0.27.1]: https://github.com/bitcoindevkit/bdk-ffi/compare/v0.26.0...v0.27.1
 [v0.26.0]: https://github.com/bitcoindevkit/bdk-ffi/compare/v0.25.0...v0.26.0
 [v0.25.0]: https://github.com/bitcoindevkit/bdk-ffi/compare/v0.11.0...v0.25.0

Cargo.toml

@@ -9,4 +9,4 @@ opt-level = 'z'     # Optimize for size.
 lto = true          # Enable Link Time Optimization
 codegen-units = 1   # Reduce number of codegen units to increase optimizations.
 panic = 'abort'     # Abort on panic
-strip = true        # Strip symbols from binary*
+strip = true        # Strip symbols from binary

README.md

@@ -8,8 +8,7 @@
 </p>
 
 The workspace in this repository creates the `libbdkffi` multi-language library for the Rust-based 
-[bdk] library from the [Bitcoin Dev Kit] project. The `bdk-ffi-bindgen` package builds a tool for 
+[bdk] library from the [Bitcoin Dev Kit] project.
-generating the actual language binding code used to access the `libbdkffi` library.
 
 Each supported language and the platform(s) it's packaged for has its own directory. The Rust code in this project is in the bdk-ffi directory and is a wrapper around the [bdk] library to expose its APIs in a uniform way using the [mozilla/uniffi-rs] bindings generator for each supported target language.
 
@@ -23,11 +22,19 @@ The below directories (a separate repository in the case of bdk-swift) include i
 | Swift    | iOS, macOS            | [bdk-swift (GitHub)]          | [Readme bdk-swift]     |                       |
 | Python   | linux, macOS, Windows | [bdk-python (PyPI)]           | [Readme bdk-python]    |                       |
 
-## Language bindings generator tool
+## Minimum Supported Rust Version (MSRV)
-Use the `bdk-ffi-bindgen` tool to generate language binding code for the above supported languages. 
+
-To run `bdk-ffi-bindgen` and see the available options use the command:
+This library should compile with any combination of features with Rust 1.61.0.
+
+To build with the MSRV you will need to pin dependencies as follows:
+
 ```shell
-cargo run -p bdk-ffi-bindgen -- --help
+# required for sqlite feature, hashlink 0.8.2 has MSRV 1.61.0
+cargo update -p hashlink --precise "0.8.1"
+# tokio 1.30.0 has MSRV 1.63.0
+cargo update -p tokio --precise "1.29.1"
+# flate2 1.0.27 and up do not work with Rust 1.61.0, but 1.0.26 does
+cargo update -p flate2 --precise "1.0.26"
 ```
 
 ## Contributing
@@ -57,8 +64,8 @@ See the [UniFFI User Guide](https://mozilla.github.io/uniffi-rs/)
 repositories {
     mavenCentral()
 }
-dependencies {
+dependencies { 
-  implementation("org.bitcoindevkit:bdk-android:<version>")
+    implementation("org.bitcoindevkit:bdk-android:<version>")
 }
 ```
 
@@ -68,8 +75,8 @@ dependencies {
 repositories {
     mavenCentral()
 }
-dependencies {
+dependencies { 
-  implementation("org.bitcoindevkit:bdk-jvm:<version>")
+    implementation("org.bitcoindevkit:bdk-jvm:<version>")
 }
 ```
 

api-docs/kotlin/src/main/kotlin/org/bitcoindevkit/bdk.kt

@@ -24,12 +24,14 @@ enum class Network {
  *
  * @property index Child index of this address.
  * @property address Address.
+ * @property keychain Type of keychain.
  *
  * @sample org.bitcoindevkit.addressInfoSample
  */
 data class AddressInfo (
     var index: UInt,
-    var address: String
+    var address: Address,
+    var keychain: KeychainKind
 )
 
 /**
@@ -367,6 +369,9 @@ class PartiallySignedTransaction(psbtBase64: String) {
      * In accordance with BIP 174 this function is commutative i.e., `A.combine(B) == B.combine(A)`
      */
     fun combine(other: PartiallySignedTransaction): PartiallySignedTransaction
+
+    /** Serialize the PSBT data structure as a String of JSON. */
+    fun jsonSerialize(): String
 }
 
 /**
@@ -484,6 +489,9 @@ class Wallet(
      */
     fun getInternalAddress(addressIndex: AddressIndex): AddressInfo {}
 
+    /** Return whether or not a script is part of this wallet (either internal or external). */
+    fun isMine(script: Script): Boolean {}
+
     /** Return the wallet's balance, across different categories. See [Balance] for the categories. Note that this method only operates on the internal database, which first needs to be [Wallet.sync] manually. */
     fun getBalance(): Balance {}
 
@@ -777,6 +785,19 @@ class Descriptor(descriptor: String, network: Network) {
      */
     fun newBip84Public(publicKey: DescriptorPublicKey, fingerprint: String, keychain: KeychainKind, network: Network) {}
 
+    /**
+     * BIP86 template. Expands to wpkh(key/86'/{0,1}'/0'/{0,1}/\*)
+     * Since there are hardened derivation steps, this template requires a private derivable key (generally a xprv/tprv).
+     */
+    fun newBip86(secretKey: DescriptorSecretKey, keychain: KeychainKind, network: Network) {}
+
+    /**
+     * BIP86 public template. Expands to wpkh(key/{0,1}/\*)
+     * This assumes that the key used has already been derived with m/86'/0'/0' for Mainnet or m/86'/1'/0' for Testnet.
+     * This template requires the parent fingerprint to populate correctly the metadata of PSBTs.
+     */
+    fun newBip86Public(publicKey: DescriptorPublicKey, fingerprint: String, keychain: KeychainKind, network: Network) {}
+
     /** Return the public version of the output descriptor. */
     fun asString(): String {}
 
@@ -821,7 +842,10 @@ data class TxBuilderResult (
 /**
  * A bitcoin script.
  */
-class Script(rawOutputScript: List<UByte>)
+class Script(rawOutputScript: List<UByte>) {
+    /** Return the script as bytes. */
+    fun toBytes(): List<UByte> {}
+}
 
 /**
  * A bitcoin address.
@@ -829,6 +853,9 @@ class Script(rawOutputScript: List<UByte>)
  * @param address The address in string format.
  */
 class Address(address: String) {
+    /** Construct an [`Address`] from an output script. */
+    fun fromScript(script: Script, network: Network): Address {}
+
     /** Return the Payload */
     fun payload(): Payload
 
@@ -846,6 +873,9 @@ class Address(address: String) {
      * Quoting BIP 173 "inside QR codes uppercase SHOULD be used, as those permit the use of alphanumeric mode, which is 45% more compact than the normal byte mode."
      */
     fun toQrUri(): String
+
+    /** Return the address as a string. */
+    fun asString(): String
 }}
 
 /**

api-docs/kotlin/src/test/kotlin/org/bitcoindevkit/Samples.kt

@@ -87,7 +87,7 @@ fun addressInfoSample() {
 
     val newAddress: AddressInfo = wallet.getAddress(AddressIndex.New)
 
-    println("New address at index ${newAddress.index} is ${newAddress.address}")
+    println("New address at index ${newAddress.index} is ${newAddress.address.asString()}")
 }
 
 fun blockchainSample() {

bdk-android/README.md

@@ -8,8 +8,8 @@ repositories {
     mavenCentral()
 }
 
-dependencies {
+dependencies { 
-  implementation("org.bitcoindevkit:bdk-android:<version>")
+    implementation("org.bitcoindevkit:bdk-android:<version>")
 }
 ```
 
@@ -19,8 +19,8 @@ import org.bitcoindevkit.*
 
 // ...
 
-val externalDescriptor = "wpkh([c258d2e4/84h/1h/0h]tpubDDYkZojQFQjht8Tm4jsS3iuEmKjTiEGjG6KnuFNKKJb5A6ZUCUZKdvLdSDWofKi4ToRCwb9poe1XdqfUnP4jaJjCB2Zwv11ZLgSbnZSNecE/0/*)"
+val externalDescriptor = Descriptor("wpkh([c258d2e4/84h/1h/0h]tpubDDYkZojQFQjht8Tm4jsS3iuEmKjTiEGjG6KnuFNKKJb5A6ZUCUZKdvLdSDWofKi4ToRCwb9poe1XdqfUnP4jaJjCB2Zwv11ZLgSbnZSNecE/0/*)", Network.TESTNET)
-val internalDescriptor = "wpkh([c258d2e4/84h/1h/0h]tpubDDYkZojQFQjht8Tm4jsS3iuEmKjTiEGjG6KnuFNKKJb5A6ZUCUZKdvLdSDWofKi4ToRCwb9poe1XdqfUnP4jaJjCB2Zwv11ZLgSbnZSNecE/1/*)"
+val internalDescriptor = Descriptor("wpkh([c258d2e4/84h/1h/0h]tpubDDYkZojQFQjht8Tm4jsS3iuEmKjTiEGjG6KnuFNKKJb5A6ZUCUZKdvLdSDWofKi4ToRCwb9poe1XdqfUnP4jaJjCB2Zwv11ZLgSbnZSNecE/1/*)", Network.TESTNET)
 
 val databaseConfig = DatabaseConfig.Memory
 
@@ -38,8 +38,8 @@ repositories {
     maven("https://s01.oss.sonatype.org/content/repositories/snapshots/")
 }
 
-dependencies {
+dependencies { 
-  implementation("org.bitcoindevkit:bdk-android:<version-SNAPSHOT>")
+    implementation("org.bitcoindevkit:bdk-android:<version-SNAPSHOT>")
 }
 ```
 
@@ -54,19 +54,23 @@ _Note that Kotlin version `1.6.10` or later is required to build the library._
 ```shell
 git clone https://github.com/bitcoindevkit/bdk-ffi
 ```
-2. Follow the "General" bdk-ffi ["Getting Started (Developer)"] instructions.
+2. Follow the "General" bdk-ffi ["Getting Started (Developer)"] instructions. 
-3. If building on macOS install required intel and m1 jvm targets
+3. Install Rust (note that we are currently building using Rust 1.67.0):
+```shell
+curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
+rustup default 1.67.0
+```
 4. Install required targets
- ```sh
+```sh
- rustup target add x86_64-linux-android aarch64-linux-android armv7-linux-androideabi
+rustup target add x86_64-linux-android aarch64-linux-android armv7-linux-androideabi
- ```
+```
 5. Install Android SDK and Build-Tools for API level 30+
 6. Setup `$ANDROID_SDK_ROOT` and `$ANDROID_NDK_ROOT` path variables (which are required by the
-   build tool), for example (NDK major version 21 is required):
+   build tool), for example (note that currently, NDK version 21.4.7075529 is required):
- ```shell
+```shell
- export ANDROID_SDK_ROOT=~/Android/Sdk
+export ANDROID_SDK_ROOT=~/Android/Sdk
- export ANDROID_NDK_ROOT=$ANDROID_SDK_ROOT/ndk/21.<NDK_VERSION>
+export ANDROID_NDK_ROOT=$ANDROID_SDK_ROOT/ndk/21.4.7075529
- ```
+```
 7. Build kotlin bindings
  ```sh
  # build Android library

bdk-android/gradle.properties

@@ -2,4 +2,4 @@ org.gradle.jvmargs=-Xmx1536m
 android.useAndroidX=true
 android.enableJetifier=true
 kotlin.code.style=official
-libraryVersion=0.28.0-SNAPSHOT
+libraryVersion=0.30.0

bdk-android/lib/src/androidTest/kotlin/org/bitcoindevkit/AndroidLibTest.kt

@@ -54,7 +54,7 @@ class AndroidLibTest {
     @Test
     fun memoryWalletNewAddress() {
         val wallet = Wallet(descriptor, null, Network.TESTNET, databaseConfig)
-        val address = wallet.getAddress(AddressIndex.New).address
+        val address = wallet.getAddress(AddressIndex.New).address.asString()
         assertEquals("tb1qzg4mckdh50nwdm9hkzq06528rsu73hjxxzem3e", address)
     }
 

bdk-ffi/Cargo.toml

@@ -1,14 +1,12 @@
 [package]
 name = "bdk-ffi"
-version = "0.27.1"
+version = "0.30.0"
 authors = ["Steve Myers <steve@notmandatory.org>", "Sudarsan Balaji <sudarsan.balaji@artfuldev.com>"]
 edition = "2018"
 license = "MIT OR Apache-2.0"
 
 [lib]
 crate-type = ["lib", "staticlib", "cdylib"]
-#crate-type = ["staticlib", "cdylib"]
-#crate-type = ["cdylib"]
 name = "bdkffi"
 
 [[bin]]
@@ -19,7 +17,7 @@ path = "uniffi-bindgen.rs"
 default = ["uniffi/cli"]
 
 [dependencies]
-bdk = { version = "0.27.1", features = ["all-keys", "use-esplora-ureq", "sqlite-bundled", "rpc"] }
+bdk = { version = "0.28.2", features = ["all-keys", "use-esplora-ureq", "sqlite-bundled", "rpc"] }
 uniffi = { version = "0.23.0" }
 
 [build-dependencies]

bdk-ffi/src/bdk.udl

@@ -50,7 +50,8 @@ enum BdkError {
 
 dictionary AddressInfo {
   u32 index;
-  string address;
+  Address address;
+  KeychainKind keychain;
 };
 
 [Enum]
@@ -220,28 +221,31 @@ interface Wallet {
   [Throws=BdkError]
   constructor(Descriptor descriptor, Descriptor? change_descriptor, Network network, DatabaseConfig database_config);
 
+  Network network();
+
   [Throws=BdkError]
   AddressInfo get_address(AddressIndex address_index);
 
   [Throws=BdkError]
   AddressInfo get_internal_address(AddressIndex address_index);
 
+  [Throws=BdkError]
+  boolean is_mine(Script script);
+
+  [Throws=BdkError]
+  sequence<LocalUtxo> list_unspent();
+
+  [Throws=BdkError]
+  sequence<TransactionDetails> list_transactions(boolean include_raw);
+
   [Throws=BdkError]
   Balance get_balance();
 
   [Throws=BdkError]
   boolean sign([ByRef] PartiallySignedTransaction psbt, SignOptions? sign_options);
 
-  [Throws=BdkError]
-  sequence<TransactionDetails> list_transactions(boolean include_raw);
-
-  Network network();
-
   [Throws=BdkError]
   void sync([ByRef] Blockchain blockchain, Progress? progress);
-
-  [Throws=BdkError]
-  sequence<LocalUtxo> list_unspent();
 };
 
 interface FeeRate {
@@ -306,6 +310,8 @@ interface PartiallySignedTransaction {
   u64? fee_amount();
 
   FeeRate? fee_rate();
+
+  string json_serialize();
 };
 
 dictionary TxBuilderResult {
@@ -436,6 +442,12 @@ interface Descriptor {
   [Name=new_bip84_public]
   constructor(DescriptorPublicKey public_key, string fingerprint, KeychainKind keychain, Network network);
 
+  [Name=new_bip86]
+  constructor(DescriptorSecretKey secret_key, KeychainKind keychain, Network network);
+
+  [Name=new_bip86_public]
+  constructor(DescriptorPublicKey public_key, string fingerprint, KeychainKind keychain, Network network);
+
   string as_string();
 
   string as_string_private();
@@ -445,6 +457,9 @@ interface Address {
   [Throws=BdkError]
   constructor(string address);
 
+  [Name=from_script, Throws=BdkError]
+  constructor(Script script, Network network);
+
   Payload payload();
 
   Network network();
@@ -452,6 +467,8 @@ interface Address {
   Script script_pubkey();
 
   string to_qr_uri();
+
+  string as_string();
 };
 
 [Enum]
@@ -485,4 +502,6 @@ enum WitnessVersion {
 
 interface Script {
   constructor(sequence<u8> raw_output_script);
+
+  sequence<u8> to_bytes();
 };

bdk-ffi/src/blockchain.rs

@@ -17,7 +17,7 @@ use std::path::PathBuf;
 use std::sync::{Arc, Mutex, MutexGuard};
 
 pub(crate) struct Blockchain {
-    blockchain_mutex: Mutex<AnyBlockchain>,
+    inner_mutex: Mutex<AnyBlockchain>,
 }
 
 impl Blockchain {
@@ -52,16 +52,16 @@ impl Blockchain {
         };
         let blockchain = AnyBlockchain::from_config(&any_blockchain_config)?;
         Ok(Self {
-            blockchain_mutex: Mutex::new(blockchain),
+            inner_mutex: Mutex::new(blockchain),
         })
     }
 
     pub(crate) fn get_blockchain(&self) -> MutexGuard<AnyBlockchain> {
-        self.blockchain_mutex.lock().expect("blockchain")
+        self.inner_mutex.lock().expect("blockchain")
     }
 
     pub(crate) fn broadcast(&self, transaction: &Transaction) -> Result<(), BdkError> {
-        let tx = &transaction.internal;
+        let tx = &transaction.inner;
         self.get_blockchain().broadcast(tx)
     }
 

bdk-ffi/src/descriptor.rs

@@ -7,10 +7,10 @@ use bdk::keys::{
     DescriptorPublicKey as BdkDescriptorPublicKey, DescriptorSecretKey as BdkDescriptorSecretKey,
 };
 use bdk::template::{
-    Bip44, Bip44Public, Bip49, Bip49Public, Bip84, Bip84Public, DescriptorTemplate,
+    Bip44, Bip44Public, Bip49, Bip49Public, Bip84, Bip84Public, Bip86, Bip86Public,
+    DescriptorTemplate,
 };
 use bdk::KeychainKind;
-use std::ops::Deref;
 use std::str::FromStr;
 use std::sync::Arc;
 
@@ -35,9 +35,9 @@ impl Descriptor {
         keychain_kind: KeychainKind,
         network: Network,
     ) -> Self {
-        let derivable_key = secret_key.descriptor_secret_key_mutex.lock().unwrap();
+        let derivable_key = &secret_key.inner;
 
-        match derivable_key.deref() {
+        match derivable_key {
             BdkDescriptorSecretKey::XPrv(descriptor_x_key) => {
                 let derivable_key = descriptor_x_key.xkey;
                 let (extended_descriptor, key_map, _) =
@@ -60,9 +60,9 @@ impl Descriptor {
         network: Network,
     ) -> Self {
         let fingerprint = Fingerprint::from_str(fingerprint.as_str()).unwrap();
-        let derivable_key = public_key.descriptor_public_key_mutex.lock().unwrap();
+        let derivable_key = &public_key.inner;
 
-        match derivable_key.deref() {
+        match derivable_key {
             BdkDescriptorPublicKey::XPub(descriptor_x_key) => {
                 let derivable_key = descriptor_x_key.xkey;
                 let (extended_descriptor, key_map, _) =
@@ -86,9 +86,9 @@ impl Descriptor {
         keychain_kind: KeychainKind,
         network: Network,
     ) -> Self {
-        let derivable_key = secret_key.descriptor_secret_key_mutex.lock().unwrap();
+        let derivable_key = &secret_key.inner;
 
-        match derivable_key.deref() {
+        match derivable_key {
             BdkDescriptorSecretKey::XPrv(descriptor_x_key) => {
                 let derivable_key = descriptor_x_key.xkey;
                 let (extended_descriptor, key_map, _) =
@@ -111,9 +111,9 @@ impl Descriptor {
         network: Network,
     ) -> Self {
         let fingerprint = Fingerprint::from_str(fingerprint.as_str()).unwrap();
-        let derivable_key = public_key.descriptor_public_key_mutex.lock().unwrap();
+        let derivable_key = &public_key.inner;
 
-        match derivable_key.deref() {
+        match derivable_key {
             BdkDescriptorPublicKey::XPub(descriptor_x_key) => {
                 let derivable_key = descriptor_x_key.xkey;
                 let (extended_descriptor, key_map, _) =
@@ -137,9 +137,9 @@ impl Descriptor {
         keychain_kind: KeychainKind,
         network: Network,
     ) -> Self {
-        let derivable_key = secret_key.descriptor_secret_key_mutex.lock().unwrap();
+        let derivable_key = &secret_key.inner;
 
-        match derivable_key.deref() {
+        match derivable_key {
             BdkDescriptorSecretKey::XPrv(descriptor_x_key) => {
                 let derivable_key = descriptor_x_key.xkey;
                 let (extended_descriptor, key_map, _) =
@@ -162,9 +162,9 @@ impl Descriptor {
         network: Network,
     ) -> Self {
         let fingerprint = Fingerprint::from_str(fingerprint.as_str()).unwrap();
-        let derivable_key = public_key.descriptor_public_key_mutex.lock().unwrap();
+        let derivable_key = &public_key.inner;
 
-        match derivable_key.deref() {
+        match derivable_key {
             BdkDescriptorPublicKey::XPub(descriptor_x_key) => {
                 let derivable_key = descriptor_x_key.xkey;
                 let (extended_descriptor, key_map, _) =
@@ -183,6 +183,57 @@ impl Descriptor {
         }
     }
 
+    pub(crate) fn new_bip86(
+        secret_key: Arc<DescriptorSecretKey>,
+        keychain_kind: KeychainKind,
+        network: Network,
+    ) -> Self {
+        let derivable_key = &secret_key.inner;
+
+        match derivable_key {
+            BdkDescriptorSecretKey::XPrv(descriptor_x_key) => {
+                let derivable_key = descriptor_x_key.xkey;
+                let (extended_descriptor, key_map, _) =
+                    Bip86(derivable_key, keychain_kind).build(network).unwrap();
+                Self {
+                    extended_descriptor,
+                    key_map,
+                }
+            }
+            BdkDescriptorSecretKey::Single(_) => {
+                unreachable!()
+            }
+        }
+    }
+
+    pub(crate) fn new_bip86_public(
+        public_key: Arc<DescriptorPublicKey>,
+        fingerprint: String,
+        keychain_kind: KeychainKind,
+        network: Network,
+    ) -> Self {
+        let fingerprint = Fingerprint::from_str(fingerprint.as_str()).unwrap();
+        let derivable_key = &public_key.inner;
+
+        match derivable_key {
+            BdkDescriptorPublicKey::XPub(descriptor_x_key) => {
+                let derivable_key = descriptor_x_key.xkey;
+                let (extended_descriptor, key_map, _) =
+                    Bip86Public(derivable_key, fingerprint, keychain_kind)
+                        .build(network)
+                        .unwrap();
+
+                Self {
+                    extended_descriptor,
+                    key_map,
+                }
+            }
+            BdkDescriptorPublicKey::Single(_) => {
+                unreachable!()
+            }
+        }
+    }
+
     pub(crate) fn as_string_private(&self) -> String {
         let descriptor = &self.extended_descriptor;
         let key_map = &self.key_map;
@@ -239,17 +290,27 @@ mod test {
             .as_public();
         println!("Public 84: {}", handmade_public_84.as_string());
         // Public 84: [d1d04177/84'/1'/0']tpubDDNxbq17egjFk2edjv8oLnzxk52zny9aAYNv9CMqTzA4mQDiQq818sEkNe9Gzmd4QU8558zftqbfoVBDQorG3E4Wq26tB2JeE4KUoahLkx6/*
+        let handmade_public_86 = master
+            .derive(Arc::new(
+                DerivationPath::new("m/86h/1h/0h".to_string()).unwrap(),
+            ))
+            .unwrap()
+            .as_public();
+        println!("Public 86: {}", handmade_public_86.as_string());
+        // Public 86: [d1d04177/86'/1'/0']tpubDCJzjbcGbdEfXMWaL6QmgVmuSfXkrue7m2YNoacWwyc7a2XjXaKojRqNEbo41CFL3PyYmKdhwg2fkGpLX4SQCbQjCGxAkWHJTw9WEeenrJb/*
         let template_private_44 =
             Descriptor::new_bip44(master.clone(), KeychainKind::External, Network::Testnet);
         let template_private_49 =
             Descriptor::new_bip49(master.clone(), KeychainKind::External, Network::Testnet);
         let template_private_84 =
-            Descriptor::new_bip84(master, KeychainKind::External, Network::Testnet);
+            Descriptor::new_bip84(master.clone(), KeychainKind::External, Network::Testnet);
+        let template_private_86 =
+            Descriptor::new_bip86(master, KeychainKind::External, Network::Testnet);
         // the extended public keys are the same when creating them manually as they are with the templates
         println!("Template 49: {}", template_private_49.as_string());
         println!("Template 44: {}", template_private_44.as_string());
         println!("Template 84: {}", template_private_84.as_string());
-        // for the public versions of the templates these are incorrect, bug report and fix in bitcoindevkit/bdk#817 and bitcoindevkit/bdk#818
+        println!("Template 86: {}", template_private_86.as_string());
         let template_public_44 = Descriptor::new_bip44_public(
             handmade_public_44,
             "d1d04177".to_string(),
@@ -268,9 +329,16 @@ mod test {
             KeychainKind::External,
             Network::Testnet,
         );
+        let template_public_86 = Descriptor::new_bip86_public(
+            handmade_public_86,
+            "d1d04177".to_string(),
+            KeychainKind::External,
+            Network::Testnet,
+        );
         println!("Template public 49: {}", template_public_49.as_string());
         println!("Template public 44: {}", template_public_44.as_string());
         println!("Template public 84: {}", template_public_84.as_string());
+        println!("Template public 86: {}", template_public_86.as_string());
         // when using a public key, both as_string and as_string_private return the same string
         assert_eq!(
             template_public_44.as_string_private(),
@@ -284,6 +352,10 @@ mod test {
             template_public_84.as_string_private(),
             template_public_84.as_string()
         );
+        assert_eq!(
+            template_public_86.as_string_private(),
+            template_public_86.as_string()
+        );
         // when using as_string on a private key, we get the same result as when using it on a public key
         assert_eq!(
             template_private_44.as_string(),
@@ -297,6 +369,10 @@ mod test {
             template_private_84.as_string(),
             template_public_84.as_string()
         );
+        assert_eq!(
+            template_private_86.as_string(),
+            template_public_86.as_string()
+        );
     }
     #[test]
     fn test_descriptor_from_string() {

bdk-ffi/src/keys.rs

@@ -17,7 +17,7 @@ use std::sync::{Arc, Mutex};
 /// Mnemonic phrases are a human-readable version of the private keys.
 /// Supported number of words are 12, 15, 18, 21 and 24.
 pub(crate) struct Mnemonic {
-    internal: BdkMnemonic,
+    inner: BdkMnemonic,
 }
 
 impl Mnemonic {
@@ -26,13 +26,13 @@ impl Mnemonic {
         let generated_key: GeneratedKey<_, BareCtx> =
             BdkMnemonic::generate((word_count, Language::English)).unwrap();
         let mnemonic = BdkMnemonic::parse_in(Language::English, generated_key.to_string()).unwrap();
-        Mnemonic { internal: mnemonic }
+        Mnemonic { inner: mnemonic }
     }
 
     /// Parse a Mnemonic with given string
     pub(crate) fn from_string(mnemonic: String) -> Result<Self, BdkError> {
         BdkMnemonic::from_str(&mnemonic)
-            .map(|m| Mnemonic { internal: m })
+            .map(|m| Mnemonic { inner: m })
             .map_err(|e| BdkError::Generic(e.to_string()))
     }
 
@@ -40,25 +40,25 @@ impl Mnemonic {
     /// Entropy must be a multiple of 32 bits (4 bytes) and 128-256 bits in length.
     pub(crate) fn from_entropy(entropy: Vec<u8>) -> Result<Self, BdkError> {
         BdkMnemonic::from_entropy(entropy.as_slice())
-            .map(|m| Mnemonic { internal: m })
+            .map(|m| Mnemonic { inner: m })
             .map_err(|e| BdkError::Generic(e.to_string()))
     }
 
     /// Returns Mnemonic as string
     pub(crate) fn as_string(&self) -> String {
-        self.internal.to_string()
+        self.inner.to_string()
     }
 }
 
 pub(crate) struct DerivationPath {
-    derivation_path_mutex: Mutex<BdkDerivationPath>,
+    inner_mutex: Mutex<BdkDerivationPath>,
 }
 
 impl DerivationPath {
     pub(crate) fn new(path: String) -> Result<Self, BdkError> {
         BdkDerivationPath::from_str(&path)
             .map(|x| DerivationPath {
-                derivation_path_mutex: Mutex::new(x),
+                inner_mutex: Mutex::new(x),
             })
             .map_err(|e| BdkError::Generic(e.to_string()))
     }
@@ -66,12 +66,12 @@ impl DerivationPath {
 
 #[derive(Debug)]
 pub(crate) struct DescriptorSecretKey {
-    pub(crate) descriptor_secret_key_mutex: Mutex<BdkDescriptorSecretKey>,
+    pub(crate) inner: BdkDescriptorSecretKey,
 }
 
 impl DescriptorSecretKey {
     pub(crate) fn new(network: Network, mnemonic: Arc<Mnemonic>, password: Option<String>) -> Self {
-        let mnemonic = mnemonic.internal.clone();
+        let mnemonic = mnemonic.inner.clone();
         let xkey: ExtendedKey = (mnemonic, password).into_extended_key().unwrap();
         let descriptor_secret_key = BdkDescriptorSecretKey::XPrv(DescriptorXKey {
             origin: None,
@@ -80,7 +80,7 @@ impl DescriptorSecretKey {
             wildcard: bdk::descriptor::Wildcard::Unhardened,
         });
         Self {
-            descriptor_secret_key_mutex: Mutex::new(descriptor_secret_key),
+            inner: descriptor_secret_key,
         }
     }
 
@@ -88,15 +88,15 @@ impl DescriptorSecretKey {
         let descriptor_secret_key = BdkDescriptorSecretKey::from_str(private_key.as_str())
             .map_err(|e| BdkError::Generic(e.to_string()))?;
         Ok(Self {
-            descriptor_secret_key_mutex: Mutex::new(descriptor_secret_key),
+            inner: descriptor_secret_key,
         })
     }
 
     pub(crate) fn derive(&self, path: Arc<DerivationPath>) -> Result<Arc<Self>, BdkError> {
         let secp = Secp256k1::new();
-        let descriptor_secret_key = self.descriptor_secret_key_mutex.lock().unwrap();
+        let descriptor_secret_key = &self.inner;
-        let path = path.derivation_path_mutex.lock().unwrap().deref().clone();
+        let path = path.inner_mutex.lock().unwrap().deref().clone();
-        match descriptor_secret_key.deref() {
+        match descriptor_secret_key {
             BdkDescriptorSecretKey::XPrv(descriptor_x_key) => {
                 let derived_xprv = descriptor_x_key.xkey.derive_priv(&secp, &path)?;
                 let key_source = match descriptor_x_key.origin.clone() {
@@ -110,7 +110,7 @@ impl DescriptorSecretKey {
                     wildcard: descriptor_x_key.wildcard,
                 });
                 Ok(Arc::new(Self {
-                    descriptor_secret_key_mutex: Mutex::new(derived_descriptor_secret_key),
+                    inner: derived_descriptor_secret_key,
                 }))
             }
             BdkDescriptorSecretKey::Single(_) => Err(BdkError::Generic(
@@ -120,9 +120,9 @@ impl DescriptorSecretKey {
     }
 
     pub(crate) fn extend(&self, path: Arc<DerivationPath>) -> Result<Arc<Self>, BdkError> {
-        let descriptor_secret_key = self.descriptor_secret_key_mutex.lock().unwrap();
+        let descriptor_secret_key = &self.inner;
-        let path = path.derivation_path_mutex.lock().unwrap().deref().clone();
+        let path = path.inner_mutex.lock().unwrap().deref().clone();
-        match descriptor_secret_key.deref() {
+        match descriptor_secret_key {
             BdkDescriptorSecretKey::XPrv(descriptor_x_key) => {
                 let extended_path = descriptor_x_key.derivation_path.extend(path);
                 let extended_descriptor_secret_key = BdkDescriptorSecretKey::XPrv(DescriptorXKey {
@@ -132,7 +132,7 @@ impl DescriptorSecretKey {
                     wildcard: descriptor_x_key.wildcard,
                 });
                 Ok(Arc::new(Self {
-                    descriptor_secret_key_mutex: Mutex::new(extended_descriptor_secret_key),
+                    inner: extended_descriptor_secret_key,
                 }))
             }
             BdkDescriptorSecretKey::Single(_) => Err(BdkError::Generic(
@@ -143,21 +143,16 @@ impl DescriptorSecretKey {
 
     pub(crate) fn as_public(&self) -> Arc<DescriptorPublicKey> {
         let secp = Secp256k1::new();
-        let descriptor_public_key = self
+        let descriptor_public_key = self.inner.to_public(&secp).unwrap();
-            .descriptor_secret_key_mutex
-            .lock()
-            .unwrap()
-            .to_public(&secp)
-            .unwrap();
         Arc::new(DescriptorPublicKey {
-            descriptor_public_key_mutex: Mutex::new(descriptor_public_key),
+            inner: descriptor_public_key,
         })
     }
 
     /// Get the private key as bytes.
     pub(crate) fn secret_bytes(&self) -> Vec<u8> {
-        let descriptor_secret_key = self.descriptor_secret_key_mutex.lock().unwrap();
+        let inner = &self.inner;
-        let secret_bytes: Vec<u8> = match descriptor_secret_key.deref() {
+        let secret_bytes: Vec<u8> = match inner.deref() {
             BdkDescriptorSecretKey::XPrv(descriptor_x_key) => {
                 descriptor_x_key.xkey.private_key.secret_bytes().to_vec()
             }
@@ -170,13 +165,13 @@ impl DescriptorSecretKey {
     }
 
     pub(crate) fn as_string(&self) -> String {
-        self.descriptor_secret_key_mutex.lock().unwrap().to_string()
+        self.inner.to_string()
     }
 }
 
 #[derive(Debug)]
 pub(crate) struct DescriptorPublicKey {
-    pub(crate) descriptor_public_key_mutex: Mutex<BdkDescriptorPublicKey>,
+    pub(crate) inner: BdkDescriptorPublicKey,
 }
 
 impl DescriptorPublicKey {
@@ -184,14 +179,14 @@ impl DescriptorPublicKey {
         let descriptor_public_key = BdkDescriptorPublicKey::from_str(public_key.as_str())
             .map_err(|e| BdkError::Generic(e.to_string()))?;
         Ok(Self {
-            descriptor_public_key_mutex: Mutex::new(descriptor_public_key),
+            inner: descriptor_public_key,
         })
     }
 
     pub(crate) fn derive(&self, path: Arc<DerivationPath>) -> Result<Arc<Self>, BdkError> {
         let secp = Secp256k1::new();
-        let descriptor_public_key = self.descriptor_public_key_mutex.lock().unwrap();
+        let descriptor_public_key = &self.inner;
-        let path = path.derivation_path_mutex.lock().unwrap().deref().clone();
+        let path = path.inner_mutex.lock().unwrap().deref().clone();
 
         match descriptor_public_key.deref() {
             BdkDescriptorPublicKey::XPub(descriptor_x_key) => {
@@ -207,7 +202,7 @@ impl DescriptorPublicKey {
                     wildcard: descriptor_x_key.wildcard,
                 });
                 Ok(Arc::new(Self {
-                    descriptor_public_key_mutex: Mutex::new(derived_descriptor_public_key),
+                    inner: derived_descriptor_public_key,
                 }))
             }
             BdkDescriptorPublicKey::Single(_) => Err(BdkError::Generic(
@@ -217,8 +212,8 @@ impl DescriptorPublicKey {
     }
 
     pub(crate) fn extend(&self, path: Arc<DerivationPath>) -> Result<Arc<Self>, BdkError> {
-        let descriptor_public_key = self.descriptor_public_key_mutex.lock().unwrap();
+        let descriptor_public_key = &self.inner;
-        let path = path.derivation_path_mutex.lock().unwrap().deref().clone();
+        let path = path.inner_mutex.lock().unwrap().deref().clone();
         match descriptor_public_key.deref() {
             BdkDescriptorPublicKey::XPub(descriptor_x_key) => {
                 let extended_path = descriptor_x_key.derivation_path.extend(path);
@@ -229,7 +224,7 @@ impl DescriptorPublicKey {
                     wildcard: descriptor_x_key.wildcard,
                 });
                 Ok(Arc::new(Self {
-                    descriptor_public_key_mutex: Mutex::new(extended_descriptor_public_key),
+                    inner: extended_descriptor_public_key,
                 }))
             }
             BdkDescriptorPublicKey::Single(_) => Err(BdkError::Generic(
@@ -239,7 +234,7 @@ impl DescriptorPublicKey {
     }
 
     pub(crate) fn as_string(&self) -> String {
-        self.descriptor_public_key_mutex.lock().unwrap().to_string()
+        self.inner.to_string()
     }
 }
 
@@ -254,7 +249,7 @@ mod test {
     use bdk::bitcoin::Network;
     use std::sync::Arc;
 
-    fn get_descriptor_secret_key() -> DescriptorSecretKey {
+    fn get_inner() -> DescriptorSecretKey {
         let mnemonic = Mnemonic::from_string("chaos fabric time speed sponsor all flat solution wisdom trophy crack object robot pave observe combine where aware bench orient secret primary cable detect".to_string()).unwrap();
         DescriptorSecretKey::new(Network::Testnet, Arc::new(mnemonic), None)
     }
@@ -293,14 +288,14 @@ mod test {
 
     #[test]
     fn test_generate_descriptor_secret_key() {
-        let master_dsk = get_descriptor_secret_key();
+        let master_dsk = get_inner();
         assert_eq!(master_dsk.as_string(), "tprv8ZgxMBicQKsPdWuqM1t1CDRvQtQuBPyfL6GbhQwtxDKgUAVPbxmj71pRA8raTqLrec5LyTs5TqCxdABcZr77bt2KyWA5bizJHnC4g4ysm4h/*");
         assert_eq!(master_dsk.as_public().as_string(), "tpubD6NzVbkrYhZ4WywdEfYbbd62yuvqLjAZuPsNyvzCNV85JekAEMbKHWSHLF9h3j45SxewXDcLv328B1SEZrxg4iwGfmdt1pDFjZiTkGiFqGa/*");
     }
 
     #[test]
     fn test_derive_self() {
-        let master_dsk = get_descriptor_secret_key();
+        let master_dsk = get_inner();
         let derived_dsk: &DescriptorSecretKey = &derive_dsk(&master_dsk, "m").unwrap();
         assert_eq!(derived_dsk.as_string(), "[d1d04177]tprv8ZgxMBicQKsPdWuqM1t1CDRvQtQuBPyfL6GbhQwtxDKgUAVPbxmj71pRA8raTqLrec5LyTs5TqCxdABcZr77bt2KyWA5bizJHnC4g4ysm4h/*");
         let master_dpk: &DescriptorPublicKey = &master_dsk.as_public();
@@ -310,7 +305,7 @@ mod test {
 
     #[test]
     fn test_derive_descriptors_keys() {
-        let master_dsk = get_descriptor_secret_key();
+        let master_dsk = get_inner();
         let derived_dsk: &DescriptorSecretKey = &derive_dsk(&master_dsk, "m/0").unwrap();
         assert_eq!(derived_dsk.as_string(), "[d1d04177/0]tprv8d7Y4JLmD25jkKbyDZXcdoPHu1YtMHuH21qeN7mFpjfumtSU7eZimFYUCSa3MYzkEYfSNRBV34GEr2QXwZCMYRZ7M1g6PUtiLhbJhBZEGYJ/*");
         let master_dpk: &DescriptorPublicKey = &master_dsk.as_public();
@@ -320,7 +315,7 @@ mod test {
 
     #[test]
     fn test_extend_descriptor_keys() {
-        let master_dsk = get_descriptor_secret_key();
+        let master_dsk = get_inner();
         let extended_dsk: &DescriptorSecretKey = &extend_dsk(&master_dsk, "m/0").unwrap();
         assert_eq!(extended_dsk.as_string(), "tprv8ZgxMBicQKsPdWuqM1t1CDRvQtQuBPyfL6GbhQwtxDKgUAVPbxmj71pRA8raTqLrec5LyTs5TqCxdABcZr77bt2KyWA5bizJHnC4g4ysm4h/0/*");
         let master_dpk: &DescriptorPublicKey = &master_dsk.as_public();
@@ -334,7 +329,7 @@ mod test {
     }
 
     #[test]
-    fn test_from_str_descriptor_secret_key() {
+    fn test_from_str_inner() {
         let key1 = "L2wTu6hQrnDMiFNWA5na6jB12ErGQqtXwqpSL7aWquJaZG8Ai3ch";
         let key2 = "tprv8ZgxMBicQKsPcwcD4gSnMti126ZiETsuX7qwrtMypr6FBwAP65puFn4v6c3jrN9VwtMRMph6nyT63NrfUL4C3nBzPcduzVSuHD7zbX2JKVc/1/1/1/*";
         let private_descriptor_key1 = DescriptorSecretKey::from_string(key1.to_string()).unwrap();
@@ -347,8 +342,8 @@ mod test {
     }
 
     #[test]
-    fn test_derive_and_extend_descriptor_secret_key() {
+    fn test_derive_and_extend_inner() {
-        let master_dsk = get_descriptor_secret_key();
+        let master_dsk = get_inner();
         // derive DescriptorSecretKey with path "m/0" from master
         let derived_dsk: &DescriptorSecretKey = &derive_dsk(&master_dsk, "m/0").unwrap();
         assert_eq!(derived_dsk.as_string(), "[d1d04177/0]tprv8d7Y4JLmD25jkKbyDZXcdoPHu1YtMHuH21qeN7mFpjfumtSU7eZimFYUCSa3MYzkEYfSNRBV34GEr2QXwZCMYRZ7M1g6PUtiLhbJhBZEGYJ/*");
@@ -359,14 +354,14 @@ mod test {
 
     #[test]
     fn test_derive_hardened_path_using_public() {
-        let master_dpk = get_descriptor_secret_key().as_public();
+        let master_dpk = get_inner().as_public();
         let derived_dpk = &derive_dpk(&master_dpk, "m/84h/1h/0h");
         assert!(derived_dpk.is_err());
     }
 
     #[test]
     fn test_retrieve_master_secret_key() {
-        let master_dpk = get_descriptor_secret_key();
+        let master_dpk = get_inner();
         let master_private_key = master_dpk.secret_bytes().to_hex();
         assert_eq!(
             master_private_key,

bdk-ffi/src/lib.rs

@@ -30,9 +30,11 @@ use bdk::keys::bip39::WordCount;
 use bdk::wallet::AddressIndex as BdkAddressIndex;
 use bdk::wallet::AddressInfo as BdkAddressInfo;
 use bdk::LocalUtxo as BdkLocalUtxo;
+use bdk::TransactionDetails as BdkTransactionDetails;
 use bdk::{Balance as BdkBalance, BlockTime, Error as BdkError, FeeRate, KeychainKind};
 use std::convert::From;
 use std::fmt;
+use std::fmt::Debug;
 use std::io::Cursor;
 use std::str::FromStr;
 use std::sync::Arc;
@@ -47,17 +49,20 @@ pub struct ScriptAmount {
 
 /// A derived address and the index it was found at.
 pub struct AddressInfo {
-    /// Child index of this address
+    /// Child index of this address.
     pub index: u32,
-    /// Address
+    /// Address.
-    pub address: String,
+    pub address: Arc<Address>,
+    /// Type of keychain.
+    pub keychain: KeychainKind,
 }
 
 impl From<BdkAddressInfo> for AddressInfo {
-    fn from(x: bdk::wallet::AddressInfo) -> Self {
+    fn from(address_info: BdkAddressInfo) -> Self {
         AddressInfo {
-            index: x.index,
+            index: address_info.index,
-            address: x.address.to_string(),
+            address: Arc::new(Address::from(address_info.address)),
+            keychain: address_info.keychain,
         }
     }
 }
@@ -90,8 +95,8 @@ pub enum AddressIndex {
 }
 
 impl From<AddressIndex> for BdkAddressIndex {
-    fn from(x: AddressIndex) -> Self {
+    fn from(address_index: AddressIndex) -> Self {
-        match x {
+        match address_index {
             AddressIndex::New => BdkAddressIndex::New,
             AddressIndex::LastUnused => BdkAddressIndex::LastUnused,
             AddressIndex::Peek { index } => BdkAddressIndex::Peek(index),
@@ -122,8 +127,8 @@ pub struct TransactionDetails {
     pub confirmation_time: Option<BlockTime>,
 }
 
-impl From<bdk::TransactionDetails> for TransactionDetails {
+impl From<BdkTransactionDetails> for TransactionDetails {
-    fn from(tx_details: bdk::TransactionDetails) -> Self {
+    fn from(tx_details: BdkTransactionDetails) -> Self {
         let optional_tx: Option<Arc<Transaction>> =
             tx_details.transaction.map(|tx| Arc::new(tx.into()));
 
@@ -148,10 +153,10 @@ pub struct OutPoint {
 }
 
 impl From<&OutPoint> for BdkOutPoint {
-    fn from(x: &OutPoint) -> Self {
+    fn from(outpoint: &OutPoint) -> Self {
         BdkOutPoint {
-            txid: Txid::from_str(&x.txid).unwrap(),
+            txid: Txid::from_str(&outpoint.txid).unwrap(),
-            vout: x.vout,
+            vout: outpoint.vout,
         }
     }
 }
@@ -194,11 +199,11 @@ pub struct TxOut {
 }
 
 impl From<&BdkTxOut> for TxOut {
-    fn from(x: &BdkTxOut) -> Self {
+    fn from(tx_out: &BdkTxOut) -> Self {
         TxOut {
-            value: x.value,
+            value: tx_out.value,
             script_pubkey: Arc::new(Script {
-                script: x.script_pubkey.clone(),
+                inner: tx_out.script_pubkey.clone(),
             }),
         }
     }
@@ -221,7 +226,7 @@ impl From<BdkLocalUtxo> for LocalUtxo {
             txout: TxOut {
                 value: local_utxo.txout.value,
                 script_pubkey: Arc::new(Script {
-                    script: local_utxo.txout.script_pubkey,
+                    inner: local_utxo.txout.script_pubkey,
                 }),
             },
             keychain: local_utxo.keychain,
@@ -248,7 +253,7 @@ impl BdkProgress for ProgressHolder {
     }
 }
 
-impl fmt::Debug for ProgressHolder {
+impl Debug for ProgressHolder {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
         f.debug_struct("ProgressHolder").finish_non_exhaustive()
     }
@@ -263,17 +268,17 @@ pub struct TxIn {
 }
 
 impl From<&BdkTxIn> for TxIn {
-    fn from(x: &BdkTxIn) -> Self {
+    fn from(tx_in: &BdkTxIn) -> Self {
         TxIn {
             previous_output: OutPoint {
-                txid: x.previous_output.txid.to_string(),
+                txid: tx_in.previous_output.txid.to_string(),
-                vout: x.previous_output.vout,
+                vout: tx_in.previous_output.vout,
             },
             script_sig: Arc::new(Script {
-                script: x.script_sig.clone(),
+                inner: tx_in.script_sig.clone(),
             }),
-            sequence: x.sequence.0,
+            sequence: tx_in.sequence.0,
-            witness: x.witness.to_vec(),
+            witness: tx_in.witness.to_vec(),
         }
     }
 }
@@ -281,85 +286,93 @@ impl From<&BdkTxIn> for TxIn {
 /// A Bitcoin transaction.
 #[derive(Debug, Clone, PartialEq, Eq)]
 pub struct Transaction {
-    internal: BdkTransaction,
+    inner: BdkTransaction,
 }
 
 impl Transaction {
     fn new(transaction_bytes: Vec<u8>) -> Result<Self, BdkError> {
         let mut decoder = Cursor::new(transaction_bytes);
         let tx: BdkTransaction = BdkTransaction::consensus_decode(&mut decoder)?;
-        Ok(Transaction { internal: tx })
+        Ok(Transaction { inner: tx })
     }
 
     fn txid(&self) -> String {
-        self.internal.txid().to_string()
+        self.inner.txid().to_string()
     }
 
     fn weight(&self) -> u64 {
-        self.internal.weight() as u64
+        self.inner.weight() as u64
     }
 
     fn size(&self) -> u64 {
-        self.internal.size() as u64
+        self.inner.size() as u64
     }
 
     fn vsize(&self) -> u64 {
-        self.internal.vsize() as u64
+        self.inner.vsize() as u64
     }
 
     fn serialize(&self) -> Vec<u8> {
-        self.internal.serialize()
+        self.inner.serialize()
     }
 
     fn is_coin_base(&self) -> bool {
-        self.internal.is_coin_base()
+        self.inner.is_coin_base()
     }
 
     fn is_explicitly_rbf(&self) -> bool {
-        self.internal.is_explicitly_rbf()
+        self.inner.is_explicitly_rbf()
     }
 
     fn is_lock_time_enabled(&self) -> bool {
-        self.internal.is_lock_time_enabled()
+        self.inner.is_lock_time_enabled()
     }
 
     fn version(&self) -> i32 {
-        self.internal.version
+        self.inner.version
     }
 
     fn lock_time(&self) -> u32 {
-        self.internal.lock_time.0
+        self.inner.lock_time.0
     }
 
     fn input(&self) -> Vec<TxIn> {
-        self.internal.input.iter().map(|x| x.into()).collect()
+        self.inner.input.iter().map(|x| x.into()).collect()
     }
 
     fn output(&self) -> Vec<TxOut> {
-        self.internal.output.iter().map(|x| x.into()).collect()
+        self.inner.output.iter().map(|x| x.into()).collect()
     }
 }
 
-impl From<bdk::bitcoin::Transaction> for Transaction {
+impl From<BdkTransaction> for Transaction {
-    fn from(tx: bdk::bitcoin::Transaction) -> Self {
+    fn from(tx: BdkTransaction) -> Self {
-        Transaction { internal: tx }
+        Transaction { inner: tx }
     }
 }
 
 /// A Bitcoin address.
-struct Address {
+#[derive(Debug, PartialEq, Eq)]
-    address: BdkAddress,
+pub struct Address {
+    inner: BdkAddress,
 }
 
 impl Address {
     fn new(address: String) -> Result<Self, BdkError> {
         BdkAddress::from_str(address.as_str())
-            .map(|a| Address { address: a })
+            .map(|a| Address { inner: a })
+            .map_err(|e| BdkError::Generic(e.to_string()))
+    }
+
+    /// alternative constructor
+    fn from_script(script: Arc<Script>, network: Network) -> Result<Self, BdkError> {
+        BdkAddress::from_script(&script.inner, network)
+            .map(|a| Address { inner: a })
             .map_err(|e| BdkError::Generic(e.to_string()))
     }
 
     fn payload(&self) -> Payload {
-        match &self.address.payload.clone() {
+        match &self.inner.payload.clone() {
             BdkPayload::PubkeyHash(pubkey_hash) => Payload::PubkeyHash {
                 pubkey_hash: pubkey_hash.to_vec(),
             },
@@ -374,17 +387,27 @@ impl Address {
     }
 
     fn network(&self) -> Network {
-        self.address.network
+        self.inner.network
     }
 
     fn script_pubkey(&self) -> Arc<Script> {
         Arc::new(Script {
-            script: self.address.script_pubkey(),
+            inner: self.inner.script_pubkey(),
         })
     }
 
     fn to_qr_uri(&self) -> String {
-        self.address.to_qr_uri()
+        self.inner.to_qr_uri()
+    }
+
+    fn as_string(&self) -> String {
+        self.inner.to_string()
+    }
+}
+
+impl From<BdkAddress> for Address {
+    fn from(address: BdkAddress) -> Self {
+        Address { inner: address }
     }
 }
 
@@ -407,19 +430,23 @@ pub enum Payload {
 /// A Bitcoin script.
 #[derive(Clone, Debug, PartialEq, Eq)]
 pub struct Script {
-    script: BdkScript,
+    inner: BdkScript,
 }
 
 impl Script {
     fn new(raw_output_script: Vec<u8>) -> Self {
         let script: BdkScript = BdkScript::from(raw_output_script);
-        Script { script }
+        Script { inner: script }
+    }
+
+    fn to_bytes(&self) -> Vec<u8> {
+        self.inner.to_bytes()
     }
 }
 
 impl From<BdkScript> for Script {
     fn from(bdk_script: BdkScript) -> Self {
-        Script { script: bdk_script }
+        Script { inner: bdk_script }
     }
 }
 

bdk-ffi/src/psbt.rs

@@ -1,6 +1,8 @@
 use bdk::bitcoin::hashes::hex::ToHex;
 use bdk::bitcoin::util::psbt::PartiallySignedTransaction as BdkPartiallySignedTransaction;
+use bdk::bitcoincore_rpc::jsonrpc::serde_json;
 use bdk::psbt::PsbtUtils;
+use std::ops::Deref;
 use std::str::FromStr;
 use std::sync::{Arc, Mutex};
 
@@ -8,7 +10,7 @@ use crate::{BdkError, FeeRate, Transaction};
 
 #[derive(Debug)]
 pub(crate) struct PartiallySignedTransaction {
-    pub(crate) internal: Mutex<BdkPartiallySignedTransaction>,
+    pub(crate) inner: Mutex<BdkPartiallySignedTransaction>,
 }
 
 impl PartiallySignedTransaction {
@@ -16,24 +18,24 @@ impl PartiallySignedTransaction {
         let psbt: BdkPartiallySignedTransaction =
             BdkPartiallySignedTransaction::from_str(&psbt_base64)?;
         Ok(PartiallySignedTransaction {
-            internal: Mutex::new(psbt),
+            inner: Mutex::new(psbt),
         })
     }
 
     pub(crate) fn serialize(&self) -> String {
-        let psbt = self.internal.lock().unwrap().clone();
+        let psbt = self.inner.lock().unwrap().clone();
         psbt.to_string()
     }
 
     pub(crate) fn txid(&self) -> String {
-        let tx = self.internal.lock().unwrap().clone().extract_tx();
+        let tx = self.inner.lock().unwrap().clone().extract_tx();
         let txid = tx.txid();
         txid.to_hex()
     }
 
     /// Return the transaction.
     pub(crate) fn extract_tx(&self) -> Arc<Transaction> {
-        let tx = self.internal.lock().unwrap().clone().extract_tx();
+        let tx = self.inner.lock().unwrap().clone().extract_tx();
         Arc::new(tx.into())
     }
 
@@ -44,19 +46,19 @@ impl PartiallySignedTransaction {
         &self,
         other: Arc<PartiallySignedTransaction>,
     ) -> Result<Arc<PartiallySignedTransaction>, BdkError> {
-        let other_psbt = other.internal.lock().unwrap().clone();
+        let other_psbt = other.inner.lock().unwrap().clone();
-        let mut original_psbt = self.internal.lock().unwrap().clone();
+        let mut original_psbt = self.inner.lock().unwrap().clone();
 
         original_psbt.combine(other_psbt)?;
         Ok(Arc::new(PartiallySignedTransaction {
-            internal: Mutex::new(original_psbt),
+            inner: Mutex::new(original_psbt),
         }))
     }
 
     /// The total transaction fee amount, sum of input amounts minus sum of output amounts, in Sats.
     /// If the PSBT is missing a TxOut for an input returns None.
     pub(crate) fn fee_amount(&self) -> Option<u64> {
-        self.internal.lock().unwrap().fee_amount()
+        self.inner.lock().unwrap().fee_amount()
     }
 
     /// The transaction's fee rate. This value will only be accurate if calculated AFTER the
@@ -64,7 +66,13 @@ impl PartiallySignedTransaction {
     /// transaction.
     /// If the PSBT is missing a TxOut for an input returns None.
     pub(crate) fn fee_rate(&self) -> Option<Arc<FeeRate>> {
-        self.internal.lock().unwrap().fee_rate().map(Arc::new)
+        self.inner.lock().unwrap().fee_rate().map(Arc::new)
+    }
+
+    /// Serialize the PSBT data structure as a String of JSON.
+    pub(crate) fn json_serialize(&self) -> String {
+        let psbt = self.inner.lock().unwrap();
+        serde_json::to_string(psbt.deref()).unwrap()
     }
 }
 
@@ -82,7 +90,7 @@ mod test {
         let test_wpkh = "wpkh(cVpPVruEDdmutPzisEsYvtST1usBR3ntr8pXSyt6D2YYqXRyPcFW)";
         let (funded_wallet, _, _) = get_funded_wallet(test_wpkh);
         let test_wallet = Wallet {
-            wallet_mutex: Mutex::new(funded_wallet),
+            inner_mutex: Mutex::new(funded_wallet),
         };
         let drain_to_address = "tb1ql7w62elx9ucw4pj5lgw4l028hmuw80sndtntxt".to_string();
         let drain_to_script = crate::Address::new(drain_to_address)
@@ -95,7 +103,7 @@ mod test {
             .drain_to(drain_to_script.clone());
         //dbg!(&tx_builder);
         assert!(tx_builder.drain_wallet);
-        assert_eq!(tx_builder.drain_to, Some(drain_to_script.script.clone()));
+        assert_eq!(tx_builder.drain_to, Some(drain_to_script.inner.clone()));
 
         let tx_builder_result = tx_builder.finish(&test_wallet).unwrap();
 

bdk-ffi/src/wallet.rs

@@ -23,7 +23,7 @@ use crate::{
 
 #[derive(Debug)]
 pub(crate) struct Wallet {
-    pub(crate) wallet_mutex: Mutex<BdkWallet<AnyDatabase>>,
+    pub(crate) inner_mutex: Mutex<BdkWallet<AnyDatabase>>,
 }
 
 /// A Bitcoin wallet.
@@ -53,11 +53,13 @@ impl Wallet {
             network,
             database,
         )?);
-        Ok(Wallet { wallet_mutex })
+        Ok(Wallet {
+            inner_mutex: wallet_mutex,
+        })
     }
 
     pub(crate) fn get_wallet(&self) -> MutexGuard<BdkWallet<AnyDatabase>> {
-        self.wallet_mutex.lock().expect("wallet")
+        self.inner_mutex.lock().expect("wallet")
     }
 
     /// Get the Bitcoin network the wallet is using.
@@ -65,6 +67,11 @@ impl Wallet {
         self.get_wallet().network()
     }
 
+    /// Return whether or not a script is part of this wallet (either internal or external).
+    pub(crate) fn is_mine(&self, script: Arc<Script>) -> Result<bool, BdkError> {
+        self.get_wallet().is_mine(&script.inner)
+    }
+
     /// Sync the internal database with the blockchain.
     pub(crate) fn sync(
         &self,
@@ -126,7 +133,7 @@ impl Wallet {
         psbt: &PartiallySignedTransaction,
         sign_options: Option<SignOptions>,
     ) -> Result<bool, BdkError> {
-        let mut psbt = psbt.internal.lock().unwrap();
+        let mut psbt = psbt.inner.lock().unwrap();
         self.get_wallet().sign(
             &mut psbt,
             sign_options.map(SignOptions::into).unwrap_or_default(),
@@ -266,7 +273,7 @@ impl TxBuilder {
     /// Add a recipient to the internal list.
     pub(crate) fn add_recipient(&self, script: Arc<Script>, amount: u64) -> Arc<Self> {
         let mut recipients: Vec<(BdkScript, u64)> = self.recipients.clone();
-        recipients.append(&mut vec![(script.script.clone(), amount)]);
+        recipients.append(&mut vec![(script.inner.clone(), amount)]);
         Arc::new(TxBuilder {
             recipients,
             ..self.clone()
@@ -276,7 +283,7 @@ impl TxBuilder {
     pub(crate) fn set_recipients(&self, recipients: Vec<ScriptAmount>) -> Arc<Self> {
         let recipients = recipients
             .iter()
-            .map(|script_amount| (script_amount.script.script.clone(), script_amount.amount))
+            .map(|script_amount| (script_amount.script.inner.clone(), script_amount.amount))
             .collect();
         Arc::new(TxBuilder {
             recipients,
@@ -381,7 +388,7 @@ impl TxBuilder {
     /// to allow this output to be reduced to pay for the extra fees.
     pub(crate) fn drain_to(&self, script: Arc<Script>) -> Arc<Self> {
         Arc::new(TxBuilder {
-            drain_to: Some(script.script.clone()),
+            drain_to: Some(script.inner.clone()),
             ..self.clone()
         })
     }
@@ -463,7 +470,7 @@ impl TxBuilder {
             .finish()
             .map(|(psbt, tx_details)| TxBuilderResult {
                 psbt: Arc::new(PartiallySignedTransaction {
-                    internal: Mutex::new(psbt),
+                    inner: Mutex::new(psbt),
                 }),
                 transaction_details: TransactionDetails::from(tx_details),
             })
@@ -547,7 +554,7 @@ impl BumpFeeTxBuilder {
         tx_builder
             .finish()
             .map(|(psbt, _)| PartiallySignedTransaction {
-                internal: Mutex::new(psbt),
+                inner: Mutex::new(psbt),
             })
             .map(Arc::new)
     }
@@ -560,9 +567,13 @@ impl BumpFeeTxBuilder {
 mod test {
     use crate::database::DatabaseConfig;
     use crate::descriptor::Descriptor;
+    use crate::keys::{DescriptorSecretKey, Mnemonic};
     use crate::wallet::{AddressIndex, TxBuilder, Wallet};
+    use crate::Script;
+    use assert_matches::assert_matches;
     use bdk::bitcoin::{Address, Network};
     use bdk::wallet::get_funded_wallet;
+    use bdk::KeychainKind;
     use std::str::FromStr;
     use std::sync::{Arc, Mutex};
 
@@ -571,7 +582,7 @@ mod test {
         let test_wpkh = "wpkh(cVpPVruEDdmutPzisEsYvtST1usBR3ntr8pXSyt6D2YYqXRyPcFW)";
         let (funded_wallet, _, _) = get_funded_wallet(test_wpkh);
         let test_wallet = Wallet {
-            wallet_mutex: Mutex::new(funded_wallet),
+            inner_mutex: Mutex::new(funded_wallet),
         };
         let drain_to_address = "tb1ql7w62elx9ucw4pj5lgw4l028hmuw80sndtntxt".to_string();
         let drain_to_script = crate::Address::new(drain_to_address)
@@ -581,10 +592,10 @@ mod test {
             .drain_wallet()
             .drain_to(drain_to_script.clone());
         assert!(tx_builder.drain_wallet);
-        assert_eq!(tx_builder.drain_to, Some(drain_to_script.script.clone()));
+        assert_eq!(tx_builder.drain_to, Some(drain_to_script.inner.clone()));
 
         let tx_builder_result = tx_builder.finish(&test_wallet).unwrap();
-        let psbt = tx_builder_result.psbt.internal.lock().unwrap().clone();
+        let psbt = tx_builder_result.psbt.inner.lock().unwrap().clone();
         let tx_details = tx_builder_result.transaction_details;
 
         // confirm one input with 50,000 sats
@@ -655,7 +666,8 @@ mod test {
             wallet
                 .get_address(AddressIndex::Peek { index: 2 })
                 .unwrap()
-                .address,
+                .address
+                .as_string(),
             "bcrt1q5g0mq6dkmwzvxscqwgc932jhgcxuqqkjv09tkj"
         );
 
@@ -663,25 +675,38 @@ mod test {
             wallet
                 .get_address(AddressIndex::Peek { index: 1 })
                 .unwrap()
-                .address,
+                .address
+                .as_string(),
             "bcrt1q0xs7dau8af22rspp4klya4f7lhggcnqfun2y3a"
         );
 
         // new index still 0
         assert_eq!(
-            wallet.get_address(AddressIndex::New).unwrap().address,
+            wallet
+                .get_address(AddressIndex::New)
+                .unwrap()
+                .address
+                .as_string(),
             "bcrt1qqjn9gky9mkrm3c28e5e87t5akd3twg6xezp0tv"
         );
 
         // new index now 1
         assert_eq!(
-            wallet.get_address(AddressIndex::New).unwrap().address,
+            wallet
+                .get_address(AddressIndex::New)
+                .unwrap()
+                .address
+                .as_string(),
             "bcrt1q0xs7dau8af22rspp4klya4f7lhggcnqfun2y3a"
         );
 
         // new index now 2
         assert_eq!(
-            wallet.get_address(AddressIndex::New).unwrap().address,
+            wallet
+                .get_address(AddressIndex::New)
+                .unwrap()
+                .address
+                .as_string(),
             "bcrt1q5g0mq6dkmwzvxscqwgc932jhgcxuqqkjv09tkj"
         );
 
@@ -690,7 +715,8 @@ mod test {
             wallet
                 .get_address(AddressIndex::Peek { index: 1 })
                 .unwrap()
-                .address,
+                .address
+                .as_string(),
             "bcrt1q0xs7dau8af22rspp4klya4f7lhggcnqfun2y3a"
         );
 
@@ -699,13 +725,18 @@ mod test {
             wallet
                 .get_address(AddressIndex::Reset { index: 0 })
                 .unwrap()
-                .address,
+                .address
+                .as_string(),
             "bcrt1qqjn9gky9mkrm3c28e5e87t5akd3twg6xezp0tv"
         );
 
         // new index 1 again
         assert_eq!(
-            wallet.get_address(AddressIndex::New).unwrap().address,
+            wallet
+                .get_address(AddressIndex::New)
+                .unwrap()
+                .address
+                .as_string(),
             "bcrt1q0xs7dau8af22rspp4klya4f7lhggcnqfun2y3a"
         );
     }
@@ -729,12 +760,20 @@ mod test {
         .unwrap();
 
         assert_eq!(
-            wallet.get_address(AddressIndex::New).unwrap().address,
+            wallet
+                .get_address(AddressIndex::New)
+                .unwrap()
+                .address
+                .as_string(),
             "bcrt1qqjn9gky9mkrm3c28e5e87t5akd3twg6xezp0tv"
         );
 
         assert_eq!(
-            wallet.get_address(AddressIndex::New).unwrap().address,
+            wallet
+                .get_address(AddressIndex::New)
+                .unwrap()
+                .address
+                .as_string(),
             "bcrt1q0xs7dau8af22rspp4klya4f7lhggcnqfun2y3a"
         );
 
@@ -742,7 +781,8 @@ mod test {
             wallet
                 .get_address(AddressIndex::LastUnused)
                 .unwrap()
-                .address,
+                .address
+                .as_string(),
             "bcrt1q0xs7dau8af22rspp4klya4f7lhggcnqfun2y3a"
         );
 
@@ -750,7 +790,8 @@ mod test {
             wallet
                 .get_internal_address(AddressIndex::New)
                 .unwrap()
-                .address,
+                .address
+                .as_string(),
             "bcrt1qpmz73cyx00r4a5dea469j40ax6d6kqyd67nnpj"
         );
 
@@ -758,7 +799,8 @@ mod test {
             wallet
                 .get_internal_address(AddressIndex::New)
                 .unwrap()
-                .address,
+                .address
+                .as_string(),
             "bcrt1qaux734vuhykww9632v8cmdnk7z2mw5lsf74v6k"
         );
 
@@ -766,8 +808,52 @@ mod test {
             wallet
                 .get_internal_address(AddressIndex::LastUnused)
                 .unwrap()
-                .address,
+                .address
+                .as_string(),
             "bcrt1qaux734vuhykww9632v8cmdnk7z2mw5lsf74v6k"
         );
     }
+
+    #[test]
+    fn test_is_mine() {
+        // is_mine should return true for addresses generated by the wallet
+        let mnemonic: Mnemonic = Mnemonic::from_string("chaos fabric time speed sponsor all flat solution wisdom trophy crack object robot pave observe combine where aware bench orient secret primary cable detect".to_string()).unwrap();
+        let secret_key: DescriptorSecretKey =
+            DescriptorSecretKey::new(Network::Testnet, Arc::new(mnemonic), None);
+        let descriptor: Descriptor = Descriptor::new_bip84(
+            Arc::new(secret_key),
+            KeychainKind::External,
+            Network::Testnet,
+        );
+        let wallet: Wallet = Wallet::new(
+            Arc::new(descriptor),
+            None,
+            Network::Testnet,
+            DatabaseConfig::Memory,
+        )
+        .unwrap();
+
+        let address = wallet.get_address(AddressIndex::New).unwrap();
+        let script: Arc<Script> = address.address.script_pubkey();
+
+        let is_mine_1: bool = wallet.is_mine(script).unwrap();
+        assert!(is_mine_1);
+
+        // is_mine returns false when provided a script that is not in the wallet
+        let other_wpkh = "wpkh(tprv8hwWMmPE4BVNxGdVt3HhEERZhondQvodUY7Ajyseyhudr4WabJqWKWLr4Wi2r26CDaNCQhhxEftEaNzz7dPGhWuKFU4VULesmhEfZYyBXdE/0/*)";
+        let other_descriptor = Descriptor::new(other_wpkh.to_string(), Network::Testnet).unwrap();
+
+        let other_wallet = Wallet::new(
+            Arc::new(other_descriptor),
+            None,
+            Network::Testnet,
+            DatabaseConfig::Memory,
+        )
+        .unwrap();
+
+        let other_address = other_wallet.get_address(AddressIndex::New).unwrap();
+        let other_script: Arc<Script> = other_address.address.script_pubkey();
+        let is_mine_2: bool = wallet.is_mine(other_script).unwrap();
+        assert_matches!(is_mine_2, false);
+    }
 }

bdk-ffi/tests/bindings/test.py

@@ -6,10 +6,5 @@ class TestBdk(unittest.TestCase):
     def test_some_enum(self):
         network = Network.TESTNET
 
-    def test_some_dict(self):
-        a = AddressInfo(index=42, address="testaddress")
-        self.assertEqual(42, a.index)
-        self.assertEqual("testaddress", a.address)
-
 if __name__=='__main__':
     unittest.main()

bdk-jvm/README.md

@@ -1,4 +1,4 @@
-# bdk-android
+# bdk-jvm
 This project builds a .jar package for the JVM platform that provide Kotlin language bindings for the [`bdk`] library. The Kotlin language bindings are created by the `bdk-ffi` project which is included in the root of this repository.
 
 ## How to Use
@@ -19,14 +19,14 @@ import org.bitcoindevkit.*
 
 // ...
 
-val externalDescriptor = "wpkh([c258d2e4/84h/1h/0h]tpubDDYkZojQFQjht8Tm4jsS3iuEmKjTiEGjG6KnuFNKKJb5A6ZUCUZKdvLdSDWofKi4ToRCwb9poe1XdqfUnP4jaJjCB2Zwv11ZLgSbnZSNecE/0/*)"
+val externalDescriptor = Descriptor("wpkh([c258d2e4/84h/1h/0h]tpubDDYkZojQFQjht8Tm4jsS3iuEmKjTiEGjG6KnuFNKKJb5A6ZUCUZKdvLdSDWofKi4ToRCwb9poe1XdqfUnP4jaJjCB2Zwv11ZLgSbnZSNecE/0/*)", Network.TESTNET)
-val internalDescriptor = "wpkh([c258d2e4/84h/1h/0h]tpubDDYkZojQFQjht8Tm4jsS3iuEmKjTiEGjG6KnuFNKKJb5A6ZUCUZKdvLdSDWofKi4ToRCwb9poe1XdqfUnP4jaJjCB2Zwv11ZLgSbnZSNecE/1/*)"
+val internalDescriptor = Descriptor("wpkh([c258d2e4/84h/1h/0h]tpubDDYkZojQFQjht8Tm4jsS3iuEmKjTiEGjG6KnuFNKKJb5A6ZUCUZKdvLdSDWofKi4ToRCwb9poe1XdqfUnP4jaJjCB2Zwv11ZLgSbnZSNecE/1/*)", Network.TESTNET)
 
 val databaseConfig = DatabaseConfig.Memory
 
 val blockchainConfig = BlockchainConfig.Electrum(
-        ElectrumConfig("ssl://electrum.blockstream.info:60002", null, 5u, null, 10u, true)
+    ElectrumConfig("ssl://electrum.blockstream.info:60002", null, 5u, null, 10u, true)
-    )
+)
 val wallet = Wallet(externalDescriptor, internalDescriptor, Network.TESTNET, databaseConfig, blockchainConfig)
 val newAddress = wallet.getAddress(AddressIndex.LastUnused)
 ```
@@ -38,32 +38,39 @@ repositories {
     maven("https://s01.oss.sonatype.org/content/repositories/snapshots/")
 }
 
-dependencies {
+dependencies { 
-  implementation("org.bitcoindevkit:bdk-jvm:<version-SNAPSHOT>")
+    implementation("org.bitcoindevkit:bdk-jvm:<version-SNAPSHOT>")
 }
 ```
 
-
 ## Example Projects
 * [Tatooine Faucet](https://github.com/thunderbiscuit/tatooine)
 
 ## How to build
 _Note that Kotlin version `1.6.10` or later is required to build the library._
-
+1. Install JDK 11. It must be version 11 (not 17), otherwise it won't build. For example, with SDKMAN!:
-1. Clone this repository.
+```shell
+curl -s "https://get.sdkman.io" | bash
+source "$HOME/.sdkman/bin/sdkman-init.sh"
+sdk install java 11.0.19-tem
+```
+2. Install Rust (note that we are currently building using Rust 1.67.0):
+```shell
+curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
+rustup default 1.67.0
+```
+3. Clone this repository.
 ```shell
 git clone https://github.com/bitcoindevkit/bdk-ffi
 ```
-2. Follow the "General" bdk-ffi ["Getting Started (Developer)"] instructions.
+4. If building on macOS install required intel and m1 jvm targets
-3. If building on macOS install required intel and m1 jvm targets
 ```sh
 rustup target add x86_64-apple-darwin aarch64-apple-darwin
 ```
-4. Build kotlin bindings
+5. Build kotlin bindings
- ```sh
+```sh
- # build JVM library
+./gradlew buildJvmLib
- ./gradlew buildJvmLib
+```
- ```
 
 ## How to publish to your local Maven repo
 ```shell

bdk-jvm/gradle.properties

@@ -1,4 +1,4 @@
 org.gradle.jvmargs=-Xmx1536m
 android.enableJetifier=true
 kotlin.code.style=official
-libraryVersion=0.28.0-SNAPSHOT
+libraryVersion=0.30.0

bdk-jvm/lib/build.gradle.kts

@@ -20,8 +20,8 @@ repositories {
 }
 
 java {
-    sourceCompatibility = JavaVersion.VERSION_1_8
+    sourceCompatibility = JavaVersion.VERSION_11
-    targetCompatibility = JavaVersion.VERSION_1_8
+    targetCompatibility = JavaVersion.VERSION_11
     withSourcesJar()
     withJavadocJar()
 }
@@ -107,4 +107,8 @@ signing {
 // binaries before running the tests
 tasks.withType<KotlinCompile> {
     dependsOn("buildJvmLib")
+
+    kotlinOptions {
+        jvmTarget = "11"
+    }
 }

bdk-jvm/lib/src/test/kotlin/org/bitcoindevkit/JvmLibTest.kt

@@ -46,7 +46,7 @@ class JvmLibTest {
     @Test
     fun memoryWalletNewAddress() {
         val wallet = Wallet(descriptor, null, Network.TESTNET, databaseConfig)
-        val address = wallet.getAddress(AddressIndex.New).address
+        val address = wallet.getAddress(AddressIndex.New).address.asString()
         assertEquals("tb1qzg4mckdh50nwdm9hkzq06528rsu73hjxxzem3e", address)
     }
 

bdk-jvm/plugins/src/main/kotlin/org/bitcoindevkit/plugins/Enums.kt

@@ -4,11 +4,13 @@ package org.bitcoindevkit.plugins
 val operatingSystem: OS = when {
     System.getProperty("os.name").contains("mac", ignoreCase = true) -> OS.MAC
     System.getProperty("os.name").contains("linux", ignoreCase = true) -> OS.LINUX
+    System.getProperty("os.name").contains("windows", ignoreCase = true) -> OS.WINDOWS
     else -> OS.OTHER
 }
 
 enum class OS {
     MAC,
     LINUX,
+    WINDOWS,
     OTHER,
 }

bdk-jvm/plugins/src/main/kotlin/org/bitcoindevkit/plugins/UniFfiJvmPlugin.kt

@@ -27,13 +27,20 @@ internal class UniFfiJvmPlugin : Plugin<Project> {
                     val cargoArgs: List<String> = listOf("build", "--profile", "release-smaller", "--target", "aarch64-apple-darwin")
                     args(cargoArgs)
                 }
-            } else if(operatingSystem == OS.LINUX) {
+            } else if (operatingSystem == OS.LINUX) {
                 exec {
                     workingDir("${project.projectDir}/../../bdk-ffi")
                     executable("cargo")
                     val cargoArgs: List<String> = listOf("build", "--profile", "release-smaller", "--target", "x86_64-unknown-linux-gnu")
                     args(cargoArgs)
                 }
+            } else if (operatingSystem == OS.WINDOWS) {
+                exec {
+                    workingDir("${project.projectDir}/../../bdk-ffi")
+                    executable("cargo")
+                    val cargoArgs: List<String> = listOf("build", "--profile", "release-smaller", "--target", "x86_64-pc-windows-msvc")
+                    args(cargoArgs)
+                }
             }
         }
 
@@ -70,13 +77,25 @@ internal class UniFfiJvmPlugin : Plugin<Project> {
                         ext = "so"
                     )
                 )
+            } else if (operatingSystem == OS.WINDOWS) {
+                libsToCopy.add(
+                    CopyMetadata(
+                        targetDir = "x86_64-pc-windows-msvc",
+                        resDir = "win32-x86-64",
+                        ext = "dll"
+                    )
+                )
+            }
+            val libName = when (operatingSystem) {
+                OS.WINDOWS -> "bdkffi"
+                else       -> "libbdkffi"
             }
 
             libsToCopy.forEach {
                 doFirst {
                     copy {
                         with(it) {
-                            from("${project.projectDir}/../../target/${this.targetDir}/release-smaller/libbdkffi.${this.ext}")
+                            from("${project.projectDir}/../../target/${this.targetDir}/release-smaller/${libName}.${this.ext}")
                             into("${project.projectDir}/../../bdk-jvm/lib/src/main/resources/${this.resDir}/")
                         }
                     }

bdk-python/MANIFEST.in

@@ -1,2 +1,3 @@
 include ./src/bdkpython/libbdkffi.dylib
 include ./src/bdkpython/libbdkffi.so
+include ./src/bdkpython/bdkffi.dll

bdk-python/README.md

@@ -12,9 +12,9 @@ pip install bdkpython
 ## Run the tests
 ```shell
 pip install --requirement requirements.txt
-bash ./generate.sh
+bash ./scripts/generate-linux.sh # here you should run the script appropriate for your platform
 python setup.py bdist_wheel --verbose
-pip install ./dist/bdkpython-<yourversion>-py3-none-any.whl --force-reinstall
+pip install ./dist/bdkpython-<yourversion>.whl --force-reinstall
 python -m unittest --verbose tests/test_bdk.py
 ```
 
@@ -23,26 +23,14 @@ python -m unittest --verbose tests/test_bdk.py
 # Install dependencies
 pip install --requirement requirements.txt
 
-# Generate the bindings
+# Generate the bindings (use the script appropriate for your platform)
-bash generate.sh
+bash ./scripts/generate-linux.sh
 
 # Build the wheel
 python setup.py --verbose bdist_wheel
 ```
 
-## Run tox to build and test locally
-```shell
-# install dev requirements
-pip install --requirement requirements-dev.txt
-
-# build bindings glue code (located at ./src/bdkpython/bdk.py)
-source ./generate.sh
-
-# build and test
-tox -vv
-```
-
 ## Install locally
 ```shell
-pip install ./dist/bdkpython-<yourversion>-py3-none-any.whl
+pip install ./dist/bdkpython-<yourversion>.whl
 ```

bdk-python/generate.sh

@@ -1,24 +0,0 @@
-#!/usr/bin/env bash
-
-set -euo pipefail
-OS=$(uname -s)
-
-echo "Generating bdk.py..."
-cd ../bdk-ffi/
-cargo run --bin uniffi-bindgen generate src/bdk.udl --language python --out-dir ../bdk-python/src/bdkpython/ --no-format
-
-echo "Generating native binaries..."
-cargo build --profile release-smaller
-case $OS in
-  "Darwin")
-    echo "Copying macOS libbdkffi.dylib..."
-    cp ../target/release-smaller/libbdkffi.dylib ../bdk-python/src/bdkpython/libbdkffi.dylib
-    ;;
-  "Linux")
-    echo "Copying linux libbdkffi.so..."
-    cp ../target/release-smaller/libbdkffi.so ../bdk-python/src/bdkpython/libbdkffi.so
-    ;;
-esac
-cd ../bdk-python/
-
-echo "All done!"

bdk-python/scripts/generate-linux.sh

@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+${PYBIN}/python --version
+${PYBIN}/pip install -r requirements.txt
+
+echo "Generating bdk.py..."
+cd ../bdk-ffi/
+cargo run --bin uniffi-bindgen generate src/bdk.udl --language python --out-dir ../bdk-python/src/bdkpython/ --no-format
+
+echo "Generating native binaries..."
+rustup default 1.67.0
+cargo build --profile release-smaller
+
+echo "Copying linux libbdkffi.so..."
+cp ../target/release-smaller/libbdkffi.so ../bdk-python/src/bdkpython/libbdkffi.so
+
+echo "All done!"

bdk-python/scripts/generate-macos-arm64.sh

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+python3 --version
+pip install --user -r requirements.txt
+
+echo "Generating bdk.py..."
+cd ../bdk-ffi/
+cargo run --bin uniffi-bindgen generate src/bdk.udl --language python --out-dir ../bdk-python/src/bdkpython/ --no-format
+
+echo "Generating native binaries..."
+rustup default 1.67.0
+rustup target add aarch64-apple-darwin
+cargo build --profile release-smaller --target aarch64-apple-darwin
+
+echo "Copying libraries libbdkffi.dylib..."
+cp ../target/aarch64-apple-darwin/release-smaller/libbdkffi.dylib ../bdk-python/src/bdkpython/libbdkffi.dylib
+
+echo "All done!"

bdk-python/scripts/generate-macos-x86_64.sh

@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+python3 --version
+pip install --user -r requirements.txt
+
+echo "Generating bdk.py..."
+cd ../bdk-ffi/
+cargo run --bin uniffi-bindgen generate src/bdk.udl --language python --out-dir ../bdk-python/src/bdkpython/ --no-format
+
+echo "Generating native binaries..."
+rustup target add x86_64-apple-darwin
+cargo build --profile release-smaller --target x86_64-apple-darwin
+
+echo "Copying libraries libbdkffi.dylib..."
+cp ../target/x86_64-apple-darwin/release-smaller/libbdkffi.dylib ../bdk-python/src/bdkpython/libbdkffi.dylib
+
+echo "All done!"

bdk-python/scripts/generate-windows.sh

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+python3 --version
+pip install --user -r requirements.txt
+
+echo "Generating bdk.py..."
+cd ../bdk-ffi/
+cargo run --bin uniffi-bindgen generate src/bdk.udl --language python --out-dir ../bdk-python/src/bdkpython/ --no-format
+
+echo "Generating native binaries..."
+rustup default 1.67.0
+rustup target add x86_64-pc-windows-msvc
+cargo build --profile release-smaller --target x86_64-pc-windows-msvc
+
+echo "Copying libraries bdkffi.dll..."
+cp ../target/x86_64-pc-windows-msvc/release-smaller/bdkffi.dll ../bdk-python/src/bdkpython/bdkffi.dll
+
+echo "All done!"

bdk-python/setup.py

@@ -51,7 +51,7 @@ print(f"Wallet balance is: {balance.total}")
 
 setup(
     name="bdkpython",
-    version="0.28.0.dev0",
+    version="0.30.0",
     description="The Python language bindings for the Bitcoin Development Kit",
     long_description=LONG_DESCRIPTION,
     long_description_content_type="text/markdown",
@@ -62,4 +62,7 @@ setup(
     url="https://github.com/bitcoindevkit/bdk-ffi",
     author="Alekos Filini <alekos.filini@gmail.com>, Steve Myers <steve@notmandatory.org>",
     license="MIT or Apache 2.0",
+    # This is required to ensure the library name includes the python version, abi, and platform tags
+    # See issue #350 for more information
+    has_ext_modules=lambda: True,
 )

bdk-python/tests/test_bdk.py

@@ -27,7 +27,7 @@ class TestSimpleBip84Wallet(unittest.TestCase):
             database_config=db_config
         )
         address_info = wallet.get_address(bdk.AddressIndex.LAST_UNUSED())
-        address = address_info.address
+        address = address_info.address.as_string()
         # print(f"New address is {address}")
         assert address == "tb1qzg4mckdh50nwdm9hkzq06528rsu73hjxxzem3e", f"Wrong address {address}, should be tb1qzg4mckdh50nwdm9hkzq06528rsu73hjxxzem3e"
 
@@ -43,6 +43,21 @@ class TestSimpleBip84Wallet(unittest.TestCase):
         # print(f"Balance is {balance.total} sat")
         assert balance.total > 0, "Balance is 0, send testnet coins to tb1qzg4mckdh50nwdm9hkzq06528rsu73hjxxzem3e"
 
-
+    def test_output_address_from_script_pubkey(self):
+        wallet = bdk.Wallet(
+            descriptor=descriptor,
+            change_descriptor=None,
+            network=bdk.Network.TESTNET,
+            database_config=db_config,
+        )
+        wallet.sync(blockchain, None)
+        first_tx = list(wallet.list_transactions(True))[0]
+        assert first_tx.txid == '35d3de8dd429ec4c9684168c1fbb9a4fb6db6f2ce89be214a024657a73ef4908'
+        
+        output1, output2 = list(first_tx.transaction.output())
+        
+        assert bdk.Address.from_script(output1.script_pubkey, bdk.Network.TESTNET).as_string() == 'tb1qw6ly2te8k9vy2mwj3g6gx82hj7hc8f5q3vry8t'
+        assert bdk.Address.from_script(output2.script_pubkey, bdk.Network.TESTNET).as_string() == 'tb1qzsvpnmme78yl60j7ldh9aqvhvxr4mz7mjpmh22'
+        
 if __name__ == '__main__':
     unittest.main()

bdk-swift/Package.swift

@@ -29,7 +29,9 @@ let package = Package(
         .binaryTarget(name: "bdkFFI", path: "./bdkFFI.xcframework"),
         .target(
             name: "BitcoinDevKit",
-            dependencies: ["bdkFFI"]),
+            dependencies: ["bdkFFI"],
+            swiftSettings: [.unsafeFlags(["-suppress-warnings"])]
+        ),
         .testTarget(
             name: "BitcoinDevKitTests",
             dependencies: ["BitcoinDevKit"]),

bdk-swift/Tests/BitcoinDevKitTests/BitcoinDevKitTests.swift

@@ -10,6 +10,6 @@ final class BitcoinDevKitTests: XCTestCase {
         let databaseConfig = DatabaseConfig.memory
         let wallet = try Wallet.init(descriptor: desc, changeDescriptor: nil, network: Network.regtest, databaseConfig: databaseConfig)
         let addressInfo = try wallet.getAddress(addressIndex: AddressIndex.new)
-        XCTAssertEqual(addressInfo.address, "bcrt1qzg4mckdh50nwdm9hkzq06528rsu73hjxytqkxs")
+        XCTAssertEqual(addressInfo.address.asString(), "bcrt1qzg4mckdh50nwdm9hkzq06528rsu73hjxytqkxs")
     }
 }

bdk-swift/build-local-swift.sh

@@ -5,10 +5,10 @@
 #
 # Run the script from the repo root directory, ie: ./bdk-swift/build-local-swift.sh
 
-rustup install nightly-x86_64-apple-darwin
+rustup install nightly-2023-04-10
-rustup component add rust-src --toolchain nightly-x86_64-apple-darwin
+rustup component add rust-src --toolchain nightly-2023-04-10
 rustup target add aarch64-apple-ios x86_64-apple-ios
-rustup target add aarch64-apple-ios-sim --toolchain nightly
+rustup target add aarch64-apple-ios-sim --toolchain nightly-2023-04-10
 rustup target add aarch64-apple-darwin x86_64-apple-darwin
 
 pushd bdk-ffi
@@ -20,10 +20,10 @@ cargo build --package bdk-ffi --profile release-smaller --target x86_64-apple-da
 cargo build --package bdk-ffi --profile release-smaller --target aarch64-apple-darwin
 cargo build --package bdk-ffi --profile release-smaller --target x86_64-apple-ios
 cargo build --package bdk-ffi --profile release-smaller --target aarch64-apple-ios
-cargo +nightly build --package bdk-ffi --release -Z build-std --target aarch64-apple-ios-sim
+cargo +nightly-2023-04-10 build --package bdk-ffi --profile release-smaller --target aarch64-apple-ios-sim
 
 mkdir -p target/lipo-ios-sim/release-smaller
-lipo target/aarch64-apple-ios-sim/release/libbdkffi.a target/x86_64-apple-ios/release-smaller/libbdkffi.a -create -output target/lipo-ios-sim/release-smaller/libbdkffi.a
+lipo target/aarch64-apple-ios-sim/release-smaller/libbdkffi.a target/x86_64-apple-ios/release-smaller/libbdkffi.a -create -output target/lipo-ios-sim/release-smaller/libbdkffi.a
 mkdir -p target/lipo-macos/release-smaller
 lipo target/aarch64-apple-darwin/release-smaller/libbdkffi.a target/x86_64-apple-darwin/release-smaller/libbdkffi.a -create -output target/lipo-macos/release-smaller/libbdkffi.a