Compare commits

..

2 Commits

Author SHA1 Message Date
thunderbiscuit
189a9c08aa chore: add developer information for jvm, android, and python libraries 2024-03-27 09:30:59 -04:00
thunderbiscuit
3d3dbef90b chore: update libraries to official alpha 7 release versions 2024-03-26 14:45:40 -04:00
68 changed files with 1692 additions and 2898 deletions

View File

@@ -6,90 +6,84 @@ labels: 'release'
assignees: '' assignees: ''
--- ---
# Part 1: Bump BDK Rust Version ## Create a new minor release
## 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. 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. 2. - [ ] Once the new bdk release is out, update the PR to replace the release candidate with the full release and merge.
# Part 2: Prepare Libraries for Release Branch ### Specific Libraries' Workflows
#### _Android_
### _Android_
3. - [ ] Update the API docs to reflect the changes in the API 3. - [ ] Update the API docs to reflect the changes in the API
4. - [ ] Delete the `target` directory in bdk-ffi and all `build` directories (in root, `lib`, and `plugins`) in the bdk-android directory 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.
5. - [ ] Build the library and run the offline and live tests, and adjust them if necessary (note that you'll need an Android emulator running). 5. - [ ] Build the library and run the tests, and adjust if necessary.
1. - [ ] Delete the `target` directory in bdk-ffi and all `build` directories (in root, `lib`, and `plugins`) in bdk-android directory to make sure you're building the library from scratch.
2. - [ ] Build the library and run the offline and live tests, and adjust them if necessary (note that you'll need an Android emulator running).
```shell ```shell
# start an emulator prior to running the tests # start an emulator prior to running the tests
cd ./bdk-android/ cd ./bdk-android/
just clean ./gradlew buildAndroidLib
just build ./gradlew connectedAndroidTest
just test
``` ```
6. - [ ] Update the readme if necessary 6. - [ ] Update the readme if necessary
1. - [ ] Update the readme if necessary
### _JVM_ #### _JVM_
7. - [ ] Update the API docs to reflect the changes in the API 7. - [ ] Update the API docs to reflect the changes in the API
8. - [ ] Delete the `target` directory in bdk-ffi and all `build` directories (in root, `lib`, and `plugins`) in bdk-jvm directory 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
9. - [ ] Build the library and run the tests, and adjust if necessary 9. - [ ] Build the library and run the tests, and adjust if necessary
2. - [ ] Delete the `target` directory in bdk-ffi and all `build` directories (in root, `lib`, and `plugins`) in bdk-android directory to make sure you're building the library from scratch.
3. - [ ] Build the library and run the tests, and adjust if necessary
```shell ```shell
cd ./bdk-jvm/ cd ./bdk-jvm/
just clean ./gradlew buildJvmLib
just build ./gradlew test
just test
``` ```
10. - [ ] Update the readme if necessary 10. - [ ] Update the readme if necessary
1. - [ ] Update the readme if necessary
### _Swift_ #### _Swift_
11. - [ ] Run the tests and adjust if necessary
11. - [ ] Delete the `target` directory in bdk-ffi 1. - [ ] Run the tests and adjust if necessary
12. - [ ] Run the tests and adjust if necessary
```shell ```shell
./bdk-swift/build-local-swift.sh
cd ./bdk-swift/ cd ./bdk-swift/
just clean swift test
just build
just test
``` ```
13. - [ ] Update the readme if necessary 12. - [ ] Update the readme if necessary
1. - [ ] Update the readme if necessary
### _Python_ #### _Python_
13. - [ ] Delete the `dist`, `build`, and `bdkpython.egg-info` and rust `target` directories to make sure you are building the library from scratch without any caches
14. - [ ] Delete the `dist`, `build`, and `bdkpython.egg-info` and rust `target` directories to make sure you are building the library from scratch without any caches 14. - [ ] Build the library
15. - [ ] Build the library
```shell ```shell
cd ./bdk-python/ cd ./bdk-python/
just clean
pip3 install --requirement requirements.txt pip3 install --requirement requirements.txt
bash ./scripts/generate-macos-arm64.sh # run the script for your particular platform bash ./scripts/generate-macos-arm64.sh # run the script for your particular platform
python3 setup.py --verbose bdist_wheel python3 setup.py --verbose bdist_wheel
``` ```
16. - [ ] Run the tests and adjust if necessary 1. - [ ] Run the tests and adjust if necessary
```shell ```shell
pip3 install ./dist/bdkpython-<yourversion>-py3-none-any.whl --force-reinstall pip3 install ./dist/bdkpython-<yourversion>-py3-none-any.whl --force-reinstall
python -m unittest --verbose python -m unittest --verbose
``` ```
17. - [ ] Update the readme and `setup.py` if necessary 1. - [ ] Update the readme and `setup.py` if necessary
18. - [ ] 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).
## Part 3: Release Workflow ### 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).
19. - [ ] Create a new branch off of `master` called `release/<feature version>`, e.g. `release/0.31` 18. - [ ] Create a new branch off of `master` called `release/version`
20. - [ ] Update bdk-android version from `SNAPSHOT` version to release version 19. - [ ] Update bdk-android version from `SNAPSHOT` version to release version
21. - [ ] Update bdk-jvm version from `SNAPSHOT` version to release version 20. - [ ] Update bdk-jvm version from `SNAPSHOT` version to release version
22. - [ ] Update bdk-python version from `.dev` version to release version 21. - [ ] Update bdk-python version from `.dev` version to release version
23. - [ ] Open a PR to that release branch that updates the Android, JVM, and Python libraries' versions in the three steps above. See [example PR here](https://github.com/bitcoindevkit/bdk-ffi/pull/316). 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).
24. - [ ] Get a review and ACK and merge the PR updating all the languages to their release versions 23. - [ ] Get a review and ACK and merge the PR updating all the languages to their release versions
25. - [ ] 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. 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 ```shell
git tag v0.6.0 --sign --edit git tag v0.6.0 --sign --edit
git push upstream v0.6.0 git push upstream v0.6.0
``` ```
26. - [ ] Trigger manual releases for all 4 libraries (for Swift, go on the [bdk-swift](https://github.com/bitcoindevkit/bdk-swift) trigger the release on `master` and simply add the version number and tag name in the text fields when running the workflow manually. Note that the version number must not contain the `v`, i.e. `0.26.0`, but the tag will have it, i.e. `v0.26.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`)
27. - [ ] Make sure the released libraries work and contain the artifacts you would expect 26. - [ ] Make sure the released libraries work and contain the artifacts you would expect
28. - [ ] Aggregate all the changelog notices from the PRs and add them to the changelog file 27. - [ ] Aggregate all the changelog notices from the PRs and add them to the changelog file
29. - [ ] Bump the versions on master from `0.9.0-SNAPSHOT` to `0.10.0-SNAPSHOT`, `0.6.0.dev0` to `0.7.0.dev0` 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`
30. - [ ] Apply changes to the minor_release and patch_release issue templates if they need any 29. - [ ] Apply changes to the minor_release and patch_release issue templates if they need any
31. - [ ] 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. 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.
32. - [ ] Make release on GitHub (set as pre-release and generate auto release notes between the previous tag and the new one) 31. - [ ] Make release on GitHub (set as pre-release and generate auto release notes between the previous tag and the new one)
33. - [ ] Post in the announcement channel 32. - [ ] Post in the announcement channel
34. - [ ] Tweet about the library 33. - [ ] Tweet about the library

View File

@@ -17,7 +17,7 @@ jobs:
strategy: strategy:
matrix: matrix:
rust: rust:
- version: 1.77.1 - version: 1.73.0
clippy: true clippy: true
steps: steps:
- name: "Checkout" - name: "Checkout"

View File

@@ -27,8 +27,8 @@ jobs:
distribution: temurin distribution: temurin
java-version: 11 java-version: 11
- name: "Set default Rust version to 1.77.1" - name: "Set default Rust version to 1.73.0"
run: rustup default 1.77.1 run: rustup default 1.73.0
- name: "Build bdk-jvm library" - name: "Build bdk-jvm library"
run: | run: |
@@ -48,8 +48,7 @@ jobs:
uses: actions/checkout@v3 uses: actions/checkout@v3
- name: "Build Swift package" - name: "Build Swift package"
working-directory: bdk-swift run: bash ./bdk-swift/build-local-swift.sh
run: bash ./build-local-swift.sh
- name: "Run live Swift tests" - name: "Run live Swift tests"
working-directory: bdk-swift working-directory: bdk-swift
@@ -75,11 +74,9 @@ jobs:
uses: actions/checkout@v3 uses: actions/checkout@v3
with: with:
submodules: true submodules: true
- uses: actions-rs/toolchain@v1
- name: "Install Rust 1.77.1"
uses: actions-rs/toolchain@v1
with: with:
toolchain: 1.77.1 toolchain: stable
- name: "Generate bdk.py and binaries" - name: "Generate bdk.py and binaries"
run: bash ./scripts/generate-linux.sh run: bash ./scripts/generate-linux.sh

View File

@@ -23,10 +23,10 @@ jobs:
uses: actions/setup-java@v3 uses: actions/setup-java@v3
with: with:
distribution: temurin distribution: temurin
java-version: 17 java-version: 11
- name: "Set default Rust version to 1.77.1" - name: "Set default Rust version to 1.73.0"
run: rustup default 1.77.1 run: rustup default 1.73.0
- name: "Install Rust Android targets" - name: "Install Rust Android targets"
run: rustup target add x86_64-linux-android aarch64-linux-android armv7-linux-androideabi run: rustup target add x86_64-linux-android aarch64-linux-android armv7-linux-androideabi
@@ -36,7 +36,7 @@ jobs:
cd bdk-android cd bdk-android
./gradlew buildAndroidLib ./gradlew buildAndroidLib
- name: "Publish to Maven Central" - name: "Publish to Maven Local and Maven Central"
env: env:
ORG_GRADLE_PROJECT_signingKeyId: ${{ secrets.PGP_KEY_ID }} ORG_GRADLE_PROJECT_signingKeyId: ${{ secrets.PGP_KEY_ID }}
ORG_GRADLE_PROJECT_signingKey: ${{ secrets.PGP_SECRET_KEY }} ORG_GRADLE_PROJECT_signingKey: ${{ secrets.PGP_SECRET_KEY }}

View File

@@ -22,10 +22,10 @@ jobs:
uses: actions/setup-java@v3 uses: actions/setup-java@v3
with: with:
distribution: temurin distribution: temurin
java-version: 17 java-version: 11
- name: "Set default Rust version to 1.77.1" - name: "Set default Rust version to 1.73.0"
run: rustup default 1.77.1 run: rustup default 1.73.0
- name: "Install aarch64 Rust target" - name: "Install aarch64 Rust target"
run: rustup target add aarch64-apple-darwin run: rustup target add aarch64-apple-darwin
@@ -52,10 +52,10 @@ jobs:
uses: actions/setup-java@v3 uses: actions/setup-java@v3
with: with:
distribution: temurin distribution: temurin
java-version: 17 java-version: 11
- name: "Set default Rust version to 1.77.1" - name: "Set default Rust version to 1.73.0"
run: rustup default 1.77.1 run: rustup default 1.73.0
- name: "Install x86_64-pc-windows-msvc Rust target" - name: "Install x86_64-pc-windows-msvc Rust target"
run: rustup target add x86_64-pc-windows-msvc run: rustup target add x86_64-pc-windows-msvc
@@ -92,10 +92,10 @@ jobs:
uses: actions/setup-java@v3 uses: actions/setup-java@v3
with: with:
distribution: temurin distribution: temurin
java-version: 17 java-version: 11
- name: "Set default Rust version to 1.77.1" - name: "Set default Rust version to 1.73.0"
run: rustup default 1.77.1 run: rustup default 1.73.0
- name: "Build bdk-jvm library" - name: "Build bdk-jvm library"
run: | run: |

View File

@@ -24,19 +24,16 @@ jobs:
- cp38-cp38 - cp38-cp38
- cp39-cp39 - cp39-cp39
- cp310-cp310 - cp310-cp310
- cp311-cp311
- cp312-cp312
steps: steps:
- name: "Checkout" - name: "Checkout"
uses: actions/checkout@v3 uses: actions/checkout@v3
with: with:
submodules: true submodules: true
# TODO 2: Other CI workflows use explicit Rust compiler versions, I think we should do the same here
- name: "Install Rust 1.77.1" - uses: actions-rs/toolchain@v1
uses: actions-rs/toolchain@v1
with: with:
toolchain: 1.77.1 toolchain: stable
- name: "Generate bdk.py and binaries" - name: "Generate bdk.py and binaries"
run: bash ./scripts/generate-linux.sh run: bash ./scripts/generate-linux.sh
@@ -62,8 +59,6 @@ jobs:
- "3.8" - "3.8"
- "3.9" - "3.9"
- "3.10" - "3.10"
- "3.11"
- "3.12"
steps: steps:
- name: "Checkout" - name: "Checkout"
uses: actions/checkout@v3 uses: actions/checkout@v3
@@ -101,8 +96,6 @@ jobs:
- "3.8" - "3.8"
- "3.9" - "3.9"
- "3.10" - "3.10"
- "3.11"
- "3.12"
steps: steps:
- name: "Checkout" - name: "Checkout"
uses: actions/checkout@v3 uses: actions/checkout@v3
@@ -139,8 +132,6 @@ jobs:
- "3.8" - "3.8"
- "3.9" - "3.9"
- "3.10" - "3.10"
- "3.11"
- "3.12"
steps: steps:
- name: "Checkout" - name: "Checkout"
uses: actions/checkout@v3 uses: actions/checkout@v3

View File

@@ -35,10 +35,10 @@ jobs:
uses: actions/setup-java@v3 uses: actions/setup-java@v3
with: with:
distribution: temurin distribution: temurin
java-version: 17 java-version: 11
- name: "Set default Rust version to 1.77.1" - name: "Set default Rust version to 1.73.0"
run: rustup default 1.77.1 run: rustup default 1.73.0
- name: "Install Rust Android targets" - name: "Install Rust Android targets"
run: rustup target add x86_64-linux-android aarch64-linux-android armv7-linux-androideabi run: rustup target add x86_64-linux-android aarch64-linux-android armv7-linux-androideabi

View File

@@ -30,10 +30,10 @@ jobs:
uses: actions/setup-java@v3 uses: actions/setup-java@v3
with: with:
distribution: temurin distribution: temurin
java-version: 17 java-version: 11
- name: "Set default Rust version to 1.77.1" - name: "Set default Rust version to 1.73.0"
run: rustup default 1.77.1 run: rustup default 1.73.0
- name: "Run JVM tests" - name: "Run JVM tests"
run: | run: |

View File

@@ -33,19 +33,15 @@ jobs:
- cp38-cp38 - cp38-cp38
- cp39-cp39 - cp39-cp39
- cp310-cp310 - cp310-cp310
- cp311-cp311
- cp312-cp312
steps: steps:
- name: "Checkout" - name: "Checkout"
uses: actions/checkout@v3 uses: actions/checkout@v3
with: with:
submodules: true submodules: true
- uses: actions-rs/toolchain@v1
- name: "Install Rust 1.77.1"
uses: actions-rs/toolchain@v1
with: with:
toolchain: 1.77.1 toolchain: stable
- name: "Generate bdk.py and binaries" - name: "Generate bdk.py and binaries"
run: bash ./scripts/generate-linux.sh run: bash ./scripts/generate-linux.sh
@@ -78,8 +74,6 @@ jobs:
- "3.8" - "3.8"
- "3.9" - "3.9"
- "3.10" - "3.10"
- "3.11"
- "3.12"
steps: steps:
- name: "Checkout" - name: "Checkout"
uses: actions/checkout@v3 uses: actions/checkout@v3
@@ -123,8 +117,6 @@ jobs:
- "3.8" - "3.8"
- "3.9" - "3.9"
- "3.10" - "3.10"
- "3.11"
- "3.12"
steps: steps:
- name: "Checkout" - name: "Checkout"
uses: actions/checkout@v3 uses: actions/checkout@v3
@@ -166,8 +158,6 @@ jobs:
- "3.8" - "3.8"
- "3.9" - "3.9"
- "3.10" - "3.10"
- "3.11"
- "3.12"
steps: steps:
- name: "Checkout" - name: "Checkout"
uses: actions/checkout@v3 uses: actions/checkout@v3

View File

@@ -19,8 +19,7 @@ jobs:
uses: actions/checkout@v3 uses: actions/checkout@v3
- name: "Build Swift package" - name: "Build Swift package"
working-directory: bdk-swift run: bash ./bdk-swift/build-local-swift.sh
run: bash ./build-local-swift.sh
- name: "Run Swift tests" - name: "Run Swift tests"
working-directory: bdk-swift working-directory: bdk-swift

View File

@@ -3,9 +3,6 @@ Changelog information can also be found in each release's git tag (which can be
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). 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).
## [1.0.0-alpha.7]
This release brings back into the 1.0 API a number of APIs from the 0.31 release, and adds the new flat file persistence feature, as well as more fine-grain errors.
## [1.0.0-alpha.2a] ## [1.0.0-alpha.2a]
This release is the first alpha release of the 1.0 API for the bindings libraries. Here is what is now available: This release is the first alpha release of the 1.0 API for the bindings libraries. Here is what is now available:
- Create and recover wallets using descriptors, including the four descriptor templates - Create and recover wallets using descriptors, including the four descriptor templates
@@ -245,8 +242,6 @@ Changelog
[BIP 0174]:https://github.com/bitcoin/bips/blob/master/bip-0174.mediawiki#encoding [BIP 0174]:https://github.com/bitcoin/bips/blob/master/bip-0174.mediawiki#encoding
[1.0.0-alpha.7]: https://github.com/bitcoindevkit/bdk-ffi/compare/v1.0.0-alpha.2a...v1.0.0-alpha.7
[1.0.0-alpha.2a]: https://github.com/bitcoindevkit/bdk-ffi/compare/v0.31.0...v1.0.0-alpha.2a
[v0.31.0]: https://github.com/bitcoindevkit/bdk-ffi/compare/v0.30.0...v0.31.0 [v0.31.0]: https://github.com/bitcoindevkit/bdk-ffi/compare/v0.30.0...v0.31.0
[v0.30.0]: https://github.com/bitcoindevkit/bdk-ffi/compare/v0.29.0...v0.30.0 [v0.30.0]: https://github.com/bitcoindevkit/bdk-ffi/compare/v0.29.0...v0.30.0
[v0.29.0]: https://github.com/bitcoindevkit/bdk-ffi/compare/v0.28.0...v0.29.0 [v0.29.0]: https://github.com/bitcoindevkit/bdk-ffi/compare/v0.28.0...v0.29.0

View File

@@ -26,21 +26,22 @@ The below directories (a separate repository in the case of bdk-swift) include i
| Swift | iOS, macOS | [bdk-swift (GitHub)] | [Readme bdk-swift] | | | Swift | iOS, macOS | [bdk-swift (GitHub)] | [Readme bdk-swift] | |
| Python | linux, macOS, Windows | [bdk-python (PyPI)] | [Readme bdk-python] | | | Python | linux, macOS, Windows | [bdk-python (PyPI)] | [Readme bdk-python] | |
## Building and Testing the Libraries
If you are familiar with the build tools for the specific languages you wish to build the libraries for, you can use their normal build/test workflows. We also include some [just](https://just.systems/) files to simplify the work across different languages. If you have the just tool installed on your system, you can simply call the commands defined in the `justfile`s, for example:
```sh
cd bdk-android
just build
just offlinetests
just publishlocal
```
## Minimum Supported Rust Version (MSRV) ## Minimum Supported Rust Version (MSRV)
This library should compile with any combination of features with Rust 1.77.1.
This library should compile with any combination of features with Rust 1.73.0.
## Contributing ## Contributing
To add new structs and functions, see the [UniFFI User Guide](https://mozilla.github.io/uniffi-rs/) and the [uniffi-examples](https://thunderbiscuit.github.io/uniffi-examples/) repository.
### Adding new structs and functions
See the [UniFFI User Guide](https://mozilla.github.io/uniffi-rs/)
#### For pass by value objects
1. Create new rust struct with only fields that are supported UniFFI types
2. Update mapping `bdk.udl` file with new `dictionary`
#### For pass by reference values
1. Create wrapper rust struct/impl with only fields that are `Sync + Send`
2. Update mapping `bdk.udl` file with new `interface`
## Goals ## Goals
1. Language bindings should feel idiomatic in target languages/platforms 1. Language bindings should feel idiomatic in target languages/platforms

View File

@@ -13,6 +13,33 @@ dependencies {
} }
``` ```
You may then import and use the `org.bitcoindevkit` library in your Kotlin code like so. Note that this example is for the `0.30.0` release. For examples of the 1.0 API in the alpha releases, take a look at the tests [here](https://github.com/bitcoindevkit/bdk-ffi/tree/master/bdk-android/lib/src/androidTest/kotlin/org/bitcoindevkit).
```kotlin
import org.bitcoindevkit.*
// ...
val externalDescriptor = Descriptor("wpkh([c258d2e4/84h/1h/0h]tpubDDYkZojQFQjht8Tm4jsS3iuEmKjTiEGjG6KnuFNKKJb5A6ZUCUZKdvLdSDWofKi4ToRCwb9poe1XdqfUnP4jaJjCB2Zwv11ZLgSbnZSNecE/0/*)", Network.TESTNET)
val internalDescriptor = Descriptor("wpkh([c258d2e4/84h/1h/0h]tpubDDYkZojQFQjht8Tm4jsS3iuEmKjTiEGjG6KnuFNKKJb5A6ZUCUZKdvLdSDWofKi4ToRCwb9poe1XdqfUnP4jaJjCB2Zwv11ZLgSbnZSNecE/1/*)", Network.TESTNET)
val esploraClient: EsploraClient = EsploraClient("https://esplora.testnet.kuutamo.cloud/")
val wallet: Wallet = Wallet(
descriptor = externalDescriptor,
changeDescriptor = internalDescriptor,
persistenceBackendPath = "./bdkwallet.db",
network = Network.TESTNET
)
val update = esploraClient.fullScan(
wallet = wallet,
stopGap = 10uL,
parallelRequests = 1uL
)
wallet.applyUpdate(update)
val newAddress = wallet.getAddress(AddressIndex.LastUnused)
```
### Snapshot releases ### Snapshot releases
To use a snapshot release, specify the snapshot repository url in the `repositories` block and use the snapshot version in the `dependencies` block: To use a snapshot release, specify the snapshot repository url in the `repositories` block and use the snapshot version in the `dependencies` block:
```kotlin ```kotlin
@@ -31,34 +58,29 @@ dependencies {
* [Padawan Wallet](https://github.com/thunderbiscuit/padawan-wallet) * [Padawan Wallet](https://github.com/thunderbiscuit/padawan-wallet)
### How to build ### How to build
_Note that Kotlin version `1.9.23` or later is required to build the library._ _Note that Kotlin version `1.6.10` or later is required to build the library._
1. Clone this repository. 1. Clone this repository.
```shell ```shell
git clone https://github.com/bitcoindevkit/bdk-ffi 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. Install Rust (note that we are currently building using Rust 1.77.1): 3. Install Rust (note that we are currently building using Rust 1.73.0):
```shell ```shell
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
rustup default 1.77.1 rustup default 1.73.0
``` ```
4. Install required targets 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+ 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. Note that currently, NDK version 25.2.9519653 or above is required. For example: 6. Setup `$ANDROID_SDK_ROOT` and `$ANDROID_NDK_ROOT` path variables (which are required by the
build tool), for example (note that currently, NDK version 25.2.9519653 or above is required):
```shell ```shell
# macOS export ANDROID_SDK_ROOT=~/Android/Sdk
export ANDROID_SDK_ROOT=~/Library/Android/sdk
export ANDROID_NDK_ROOT=$ANDROID_SDK_ROOT/ndk/25.2.9519653
# linux
export ANDROID_SDK_ROOT=/usr/local/lib/android/sdk
export ANDROID_NDK_ROOT=$ANDROID_SDK_ROOT/ndk/25.2.9519653 export ANDROID_NDK_ROOT=$ANDROID_SDK_ROOT/ndk/25.2.9519653
``` ```
7. Build kotlin bindings 7. Build kotlin bindings
```sh ```sh
# build Android library # build Android library
@@ -73,7 +95,7 @@ export ANDROID_NDK_ROOT=$ANDROID_SDK_ROOT/ndk/25.2.9519653
## How to publish to your local Maven repo ## How to publish to your local Maven repo
```shell ```shell
cd bdk-android cd bdk-android
./gradlew publishToMavenLocal -P localBuild ./gradlew publishToMavenLocal --exclude-task signMavenPublication
``` ```
Note that the commands assume you don't need the local libraries to be signed. If you do wish to sign them, simply set your `~/.gradle/gradle.properties` signing key values like so: Note that the commands assume you don't need the local libraries to be signed. If you do wish to sign them, simply set your `~/.gradle/gradle.properties` signing key values like so:
@@ -82,7 +104,7 @@ signing.gnupg.keyName=<YOUR_GNUPG_ID>
signing.gnupg.passphrase=<YOUR_GNUPG_PASSPHRASE> signing.gnupg.passphrase=<YOUR_GNUPG_PASSPHRASE>
``` ```
and use the `publishToMavenLocal` task without the `localBuild` flag: and use the `publishToMavenLocal` task without excluding the signing task:
```shell ```shell
./gradlew publishToMavenLocal ./gradlew publishToMavenLocal
``` ```

View File

@@ -1,10 +1,14 @@
buildscript {
repositories {
google()
}
dependencies {
classpath("com.android.tools.build:gradle:7.1.2")
}
}
plugins { plugins {
id("com.android.library").version("8.3.1").apply(false) id("io.github.gradle-nexus.publish-plugin") version "1.1.0"
id("org.jetbrains.kotlin.android").version("1.9.23").apply(false)
id("org.gradle.maven-publish")
id("org.gradle.signing")
id("org.bitcoindevkit.plugins.generate-android-bindings").apply(false)
id("io.github.gradle-nexus.publish-plugin").version("1.1.0").apply(true)
} }
// library version is defined in gradle.properties // library version is defined in gradle.properties

View File

@@ -2,4 +2,4 @@ org.gradle.jvmargs=-Xmx1536m
android.useAndroidX=true android.useAndroidX=true
android.enableJetifier=true android.enableJetifier=true
kotlin.code.style=official kotlin.code.style=official
libraryVersion=1.0.0-alpha.10-SNAPSHOT libraryVersion=1.0.0-alpha.7

Binary file not shown.

View File

@@ -1,7 +1,5 @@
distributionBase=GRADLE_USER_HOME distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-8.7-all.zip distributionUrl=https\://services.gradle.org/distributions/gradle-7.3.2-bin.zip
networkTimeout=10000
validateDistributionUrl=true
zipStoreBase=GRADLE_USER_HOME zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists zipStorePath=wrapper/dists

41
bdk-android/gradlew vendored
View File

@@ -55,7 +55,7 @@
# Darwin, MinGW, and NonStop. # Darwin, MinGW, and NonStop.
# #
# (3) This script is generated from the Groovy template # (3) This script is generated from the Groovy template
# https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt # https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
# within the Gradle project. # within the Gradle project.
# #
# You can find Gradle at https://github.com/gradle/gradle/. # You can find Gradle at https://github.com/gradle/gradle/.
@@ -80,11 +80,13 @@ do
esac esac
done done
# This is normally unused APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
# shellcheck disable=SC2034
APP_NAME="Gradle"
APP_BASE_NAME=${0##*/} APP_BASE_NAME=${0##*/}
# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
# Use the maximum available, or set MAX_FD != -1 to use that value. # Use the maximum available, or set MAX_FD != -1 to use that value.
MAX_FD=maximum MAX_FD=maximum
@@ -131,29 +133,22 @@ location of your Java installation."
fi fi
else else
JAVACMD=java JAVACMD=java
if ! command -v java >/dev/null 2>&1 which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
then
die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
Please set the JAVA_HOME variable in your environment to match the Please set the JAVA_HOME variable in your environment to match the
location of your Java installation." location of your Java installation."
fi
fi fi
# Increase the maximum file descriptors if we can. # Increase the maximum file descriptors if we can.
if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
case $MAX_FD in #( case $MAX_FD in #(
max*) max*)
# In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
# shellcheck disable=SC2039,SC3045
MAX_FD=$( ulimit -H -n ) || MAX_FD=$( ulimit -H -n ) ||
warn "Could not query maximum file descriptor limit" warn "Could not query maximum file descriptor limit"
esac esac
case $MAX_FD in #( case $MAX_FD in #(
'' | soft) :;; #( '' | soft) :;; #(
*) *)
# In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
# shellcheck disable=SC2039,SC3045
ulimit -n "$MAX_FD" || ulimit -n "$MAX_FD" ||
warn "Could not set maximum file descriptor limit to $MAX_FD" warn "Could not set maximum file descriptor limit to $MAX_FD"
esac esac
@@ -198,15 +193,11 @@ if "$cygwin" || "$msys" ; then
done done
fi fi
# Collect all arguments for the java command;
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. # * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' # shell script including quotes and variable substitutions, so put them in
# double quotes to make sure that they get re-expanded; and
# Collect all arguments for the java command: # * put everything else in single quotes, so that it's not re-expanded.
# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
# and any embedded shellness will be escaped.
# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
# treated as '${Hostname}' itself on the command line.
set -- \ set -- \
"-Dorg.gradle.appname=$APP_BASE_NAME" \ "-Dorg.gradle.appname=$APP_BASE_NAME" \
@@ -214,12 +205,6 @@ set -- \
org.gradle.wrapper.GradleWrapperMain \ org.gradle.wrapper.GradleWrapperMain \
"$@" "$@"
# Stop when "xargs" is not available.
if ! command -v xargs >/dev/null 2>&1
then
die "xargs is not available"
fi
# Use "xargs" to parse quoted args. # Use "xargs" to parse quoted args.
# #
# With -n1 it outputs one arg per line, with the quotes and backslashes removed. # With -n1 it outputs one arg per line, with the quotes and backslashes removed.

View File

@@ -14,7 +14,7 @@
@rem limitations under the License. @rem limitations under the License.
@rem @rem
@if "%DEBUG%"=="" @echo off @if "%DEBUG%" == "" @echo off
@rem ########################################################################## @rem ##########################################################################
@rem @rem
@rem Gradle startup script for Windows @rem Gradle startup script for Windows
@@ -25,8 +25,7 @@
if "%OS%"=="Windows_NT" setlocal if "%OS%"=="Windows_NT" setlocal
set DIRNAME=%~dp0 set DIRNAME=%~dp0
if "%DIRNAME%"=="" set DIRNAME=. if "%DIRNAME%" == "" set DIRNAME=.
@rem This is normally unused
set APP_BASE_NAME=%~n0 set APP_BASE_NAME=%~n0
set APP_HOME=%DIRNAME% set APP_HOME=%DIRNAME%
@@ -41,7 +40,7 @@ if defined JAVA_HOME goto findJavaFromJavaHome
set JAVA_EXE=java.exe set JAVA_EXE=java.exe
%JAVA_EXE% -version >NUL 2>&1 %JAVA_EXE% -version >NUL 2>&1
if %ERRORLEVEL% equ 0 goto execute if "%ERRORLEVEL%" == "0" goto execute
echo. echo.
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
@@ -76,15 +75,13 @@ set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
:end :end
@rem End local scope for the variables with windows NT shell @rem End local scope for the variables with windows NT shell
if %ERRORLEVEL% equ 0 goto mainEnd if "%ERRORLEVEL%"=="0" goto mainEnd
:fail :fail
rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
rem the _cmd.exe /c_ return code! rem the _cmd.exe /c_ return code!
set EXIT_CODE=%ERRORLEVEL% if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
if %EXIT_CODE% equ 0 set EXIT_CODE=1 exit /b 1
if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
exit /b %EXIT_CODE%
:mainEnd :mainEnd
if "%OS%"=="Windows_NT" endlocal if "%OS%"=="Windows_NT" endlocal

View File

@@ -1,20 +0,0 @@
default:
just --list
build:
./gradlew buildAndroidLib
clean:
rm -rf ../bdk-ffi/target/
rm -rf ./build/
rm -rf ./lib/build/
rm -rf ./plugins/build/
publish-local:
./gradlew publishToMavenLocal -P localBuild
test:
./gradlew connectedAndroidTest
test-specific TEST:
./gradlew test --tests {{TEST}}

View File

@@ -5,21 +5,25 @@ val libraryVersion: String by project
plugins { plugins {
id("com.android.library") id("com.android.library")
id("org.jetbrains.kotlin.android") id("org.jetbrains.kotlin.android") version "1.6.10"
id("org.gradle.maven-publish") id("maven-publish")
id("org.gradle.signing") id("signing")
// Custom plugin to generate the native libs and bindings file // Custom plugin to generate the native libs and bindings file
id("org.bitcoindevkit.plugins.generate-android-bindings") id("org.bitcoindevkit.plugins.generate-android-bindings")
} }
repositories {
mavenCentral()
google()
}
android { android {
namespace = "org.bitcoindevkit" compileSdk = 33
compileSdk = 34
defaultConfig { defaultConfig {
minSdk = 21 minSdk = 21
targetSdk = 34 targetSdk = 33
testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner" testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
consumerProguardFiles("consumer-rules.pro") consumerProguardFiles("consumer-rules.pro")
} }
@@ -39,20 +43,6 @@ android {
} }
} }
kotlin {
tasks.withType<KotlinCompile>().configureEach {
kotlinOptions {
jvmTarget = "17"
}
}
}
java {
toolchain {
languageVersion.set(JavaLanguageVersion.of(17))
}
}
dependencies { dependencies {
implementation("net.java.dev.jna:jna:5.14.0@aar") implementation("net.java.dev.jna:jna:5.14.0@aar")
implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk7") implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk7")
@@ -106,22 +96,9 @@ afterEvaluate {
} }
} }
} }
// This is required because we must ensure the moveNativeAndroidLibs task is executed after
// the mergeReleaseJniLibFolders (hard requirement introduced by our upgrade to Gradle 8.7)
tasks.named("mergeReleaseJniLibFolders") {
dependsOn(":lib:moveNativeAndroidLibs")
}
tasks.named("mergeDebugJniLibFolders") {
dependsOn(":lib:moveNativeAndroidLibs")
}
} }
signing { signing {
if (project.hasProperty("localBuild")) {
isRequired = false
}
val signingKeyId: String? by project val signingKeyId: String? by project
val signingKey: String? by project val signingKey: String? by project
val signingPassword: String? by project val signingPassword: String? by project
@@ -129,7 +106,8 @@ signing {
sign(publishing.publications) sign(publishing.publications)
} }
// This task dependency ensures that we build the bindings binaries before running the tests // This task dependency ensures that we build the bindings
// binaries before running the tests
tasks.withType<KotlinCompile> { tasks.withType<KotlinCompile> {
dependsOn("buildAndroidLib") dependsOn("buildAndroidLib")
} }

View File

@@ -8,9 +8,6 @@ import java.io.File
import kotlin.test.AfterTest import kotlin.test.AfterTest
import kotlin.test.assertTrue import kotlin.test.assertTrue
private const val SIGNET_ESPLORA_URL = "http://signet.bitcoindevkit.net"
private const val TESTNET_ESPLORA_URL = "https://esplora.testnet.kuutamo.cloud"
@RunWith(AndroidJUnit4::class) @RunWith(AndroidJUnit4::class)
class LiveTxBuilderTest { class LiveTxBuilderTest {
private val persistenceFilePath = InstrumentationRegistry private val persistenceFilePath = InstrumentationRegistry
@@ -26,21 +23,19 @@ class LiveTxBuilderTest {
@Test @Test
fun testTxBuilder() { fun testTxBuilder() {
val descriptor = Descriptor("wpkh(tprv8ZgxMBicQKsPf2qfrEygW6fdYseJDDrVnDv26PH5BHdvSuG6ecCbHqLVof9yZcMoM31z9ur3tTYbSnr1WBqbGX97CbXcmp5H6qeMpyvx35B/84h/1h/0h/0/*)", Network.SIGNET) val descriptor = Descriptor("wpkh(tprv8ZgxMBicQKsPf2qfrEygW6fdYseJDDrVnDv26PH5BHdvSuG6ecCbHqLVof9yZcMoM31z9ur3tTYbSnr1WBqbGX97CbXcmp5H6qeMpyvx35B/84h/1h/0h/0/*)", Network.TESTNET)
val wallet = Wallet(descriptor, null, persistenceFilePath, Network.SIGNET) val wallet = Wallet(descriptor, null, persistenceFilePath, Network.TESTNET)
val esploraClient = EsploraClient(SIGNET_ESPLORA_URL) val esploraClient = EsploraClient("https://esplora.testnet.kuutamo.cloud/")
val fullScanRequest: FullScanRequest = wallet.startFullScan() val update = esploraClient.fullScan(wallet, 10uL, 1uL)
val update = esploraClient.fullScan(fullScanRequest, 10uL, 1uL)
wallet.applyUpdate(update) wallet.applyUpdate(update)
wallet.commit()
println("Balance: ${wallet.getBalance().total}") println("Balance: ${wallet.getBalance().total}")
assert(wallet.getBalance().total > 0uL) assert(wallet.getBalance().total > 0uL)
val recipient: Address = Address("tb1qrnfslnrve9uncz9pzpvf83k3ukz22ljgees989", Network.SIGNET) val recipient: Address = Address("tb1qrnfslnrve9uncz9pzpvf83k3ukz22ljgees989", Network.TESTNET)
val psbt: Psbt = TxBuilder() val psbt: PartiallySignedTransaction = TxBuilder()
.addRecipient(recipient.scriptPubkey(), 4200uL) .addRecipient(recipient.scriptPubkey(), 4200uL)
.feeRate(FeeRate.fromSatPerVb(2uL)) .feeRate(FeeRate.fromSatPerVb(2.0f))
.finish(wallet) .finish(wallet)
println(psbt.serialize()) println(psbt.serialize())
@@ -49,28 +44,26 @@ class LiveTxBuilderTest {
@Test @Test
fun complexTxBuilder() { fun complexTxBuilder() {
val externalDescriptor = Descriptor("wpkh(tprv8ZgxMBicQKsPf2qfrEygW6fdYseJDDrVnDv26PH5BHdvSuG6ecCbHqLVof9yZcMoM31z9ur3tTYbSnr1WBqbGX97CbXcmp5H6qeMpyvx35B/84h/1h/0h/0/*)", Network.SIGNET) val externalDescriptor = Descriptor("wpkh(tprv8ZgxMBicQKsPf2qfrEygW6fdYseJDDrVnDv26PH5BHdvSuG6ecCbHqLVof9yZcMoM31z9ur3tTYbSnr1WBqbGX97CbXcmp5H6qeMpyvx35B/84h/1h/0h/0/*)", Network.TESTNET)
val changeDescriptor = Descriptor("wpkh(tprv8ZgxMBicQKsPf2qfrEygW6fdYseJDDrVnDv26PH5BHdvSuG6ecCbHqLVof9yZcMoM31z9ur3tTYbSnr1WBqbGX97CbXcmp5H6qeMpyvx35B/84h/1h/0h/1/*)", Network.SIGNET) val changeDescriptor = Descriptor("wpkh(tprv8ZgxMBicQKsPf2qfrEygW6fdYseJDDrVnDv26PH5BHdvSuG6ecCbHqLVof9yZcMoM31z9ur3tTYbSnr1WBqbGX97CbXcmp5H6qeMpyvx35B/84h/1h/0h/1/*)", Network.TESTNET)
val wallet = Wallet(externalDescriptor, changeDescriptor, persistenceFilePath, Network.TESTNET) val wallet = Wallet(externalDescriptor, changeDescriptor, persistenceFilePath, Network.TESTNET)
val esploraClient = EsploraClient(SIGNET_ESPLORA_URL) val esploraClient = EsploraClient("https://esplora.testnet.kuutamo.cloud/")
val fullScanRequest: FullScanRequest = wallet.startFullScan() val update = esploraClient.fullScan(wallet, 10uL, 1uL)
val update = esploraClient.fullScan(fullScanRequest, 10uL, 1uL)
wallet.applyUpdate(update) wallet.applyUpdate(update)
wallet.commit()
println("Balance: ${wallet.getBalance().total}") println("Balance: ${wallet.getBalance().total}")
assert(wallet.getBalance().total > 0uL) assert(wallet.getBalance().total > 0uL)
val recipient1: Address = Address("tb1qrnfslnrve9uncz9pzpvf83k3ukz22ljgees989", Network.SIGNET) val recipient1: Address = Address("tb1qrnfslnrve9uncz9pzpvf83k3ukz22ljgees989", Network.TESTNET)
val recipient2: Address = Address("tb1qw2c3lxufxqe2x9s4rdzh65tpf4d7fssjgh8nv6", Network.SIGNET) val recipient2: Address = Address("tb1qw2c3lxufxqe2x9s4rdzh65tpf4d7fssjgh8nv6", Network.TESTNET)
val allRecipients: List<ScriptAmount> = listOf( val allRecipients: List<ScriptAmount> = listOf(
ScriptAmount(recipient1.scriptPubkey(), 4200uL), ScriptAmount(recipient1.scriptPubkey(), 4200uL),
ScriptAmount(recipient2.scriptPubkey(), 4200uL), ScriptAmount(recipient2.scriptPubkey(), 4200uL),
) )
val psbt: Psbt = TxBuilder() val psbt: PartiallySignedTransaction = TxBuilder()
.setRecipients(allRecipients) .setRecipients(allRecipients)
.feeRate(FeeRate.fromSatPerVb(4uL)) .feeRate(FeeRate.fromSatPerVb(4.0f))
.changePolicy(ChangeSpendPolicy.CHANGE_FORBIDDEN) .changePolicy(ChangeSpendPolicy.CHANGE_FORBIDDEN)
.enableRbf() .enableRbf()
.finish(wallet) .finish(wallet)

View File

@@ -8,9 +8,6 @@ import java.io.File
import kotlin.test.AfterTest import kotlin.test.AfterTest
import kotlin.test.assertTrue import kotlin.test.assertTrue
private const val SIGNET_ESPLORA_URL = "http://signet.bitcoindevkit.net"
private const val TESTNET_ESPLORA_URL = "https://esplora.testnet.kuutamo.cloud"
@RunWith(AndroidJUnit4::class) @RunWith(AndroidJUnit4::class)
class LiveWalletTest { class LiveWalletTest {
private val persistenceFilePath = InstrumentationRegistry private val persistenceFilePath = InstrumentationRegistry
@@ -26,13 +23,11 @@ class LiveWalletTest {
@Test @Test
fun testSyncedBalance() { fun testSyncedBalance() {
val descriptor: Descriptor = Descriptor("wpkh(tprv8ZgxMBicQKsPf2qfrEygW6fdYseJDDrVnDv26PH5BHdvSuG6ecCbHqLVof9yZcMoM31z9ur3tTYbSnr1WBqbGX97CbXcmp5H6qeMpyvx35B/84h/1h/0h/0/*)", Network.SIGNET) val descriptor: Descriptor = Descriptor("wpkh(tprv8ZgxMBicQKsPf2qfrEygW6fdYseJDDrVnDv26PH5BHdvSuG6ecCbHqLVof9yZcMoM31z9ur3tTYbSnr1WBqbGX97CbXcmp5H6qeMpyvx35B/84h/1h/0h/0/*)", Network.TESTNET)
val wallet: Wallet = Wallet(descriptor, null, persistenceFilePath, Network.SIGNET) val wallet: Wallet = Wallet(descriptor, null, persistenceFilePath, Network.TESTNET)
val esploraClient: EsploraClient = EsploraClient(SIGNET_ESPLORA_URL) val esploraClient: EsploraClient = EsploraClient("https://esplora.testnet.kuutamo.cloud/")
val fullScanRequest: FullScanRequest = wallet.startFullScan() val update = esploraClient.fullScan(wallet, 10uL, 1uL)
val update = esploraClient.fullScan(fullScanRequest, 10uL, 1uL)
wallet.applyUpdate(update) wallet.applyUpdate(update)
wallet.commit()
println("Balance: ${wallet.getBalance().total}") println("Balance: ${wallet.getBalance().total}")
val balance: Balance = wallet.getBalance() val balance: Balance = wallet.getBalance()
println("Balance: $balance") println("Balance: $balance")
@@ -42,8 +37,8 @@ class LiveWalletTest {
println("Transactions count: ${wallet.transactions().count()}") println("Transactions count: ${wallet.transactions().count()}")
val transactions = wallet.transactions().take(3) val transactions = wallet.transactions().take(3)
for (tx in transactions) { for (tx in transactions) {
val sentAndReceived = wallet.sentAndReceived(tx.transaction) val sentAndReceived = wallet.sentAndReceived(tx)
println("Transaction: ${tx.transaction.txid()}") println("Transaction: ${tx.txid()}")
println("Sent ${sentAndReceived.sent}") println("Sent ${sentAndReceived.sent}")
println("Received ${sentAndReceived.received}") println("Received ${sentAndReceived.received}")
} }
@@ -51,25 +46,24 @@ class LiveWalletTest {
@Test @Test
fun testBroadcastTransaction() { fun testBroadcastTransaction() {
val descriptor = Descriptor("wpkh(tprv8ZgxMBicQKsPf2qfrEygW6fdYseJDDrVnDv26PH5BHdvSuG6ecCbHqLVof9yZcMoM31z9ur3tTYbSnr1WBqbGX97CbXcmp5H6qeMpyvx35B/84h/1h/0h/0/*)", Network.SIGNET) val descriptor = Descriptor("wpkh(tprv8ZgxMBicQKsPf2qfrEygW6fdYseJDDrVnDv26PH5BHdvSuG6ecCbHqLVof9yZcMoM31z9ur3tTYbSnr1WBqbGX97CbXcmp5H6qeMpyvx35B/84h/1h/0h/0/*)", Network.TESTNET)
val wallet = Wallet(descriptor, null, persistenceFilePath, Network.SIGNET) val wallet = Wallet(descriptor, null, persistenceFilePath, Network.TESTNET)
val esploraClient = EsploraClient(SIGNET_ESPLORA_URL) val esploraClient = EsploraClient("https://esplora.testnet.kuutamo.cloud/")
val fullScanRequest: FullScanRequest = wallet.startFullScan() val update = esploraClient.fullScan(wallet, 10uL, 1uL)
val update = esploraClient.fullScan(fullScanRequest, 10uL, 1uL)
wallet.applyUpdate(update) wallet.applyUpdate(update)
wallet.commit()
println("Balance: ${wallet.getBalance().total}") println("Balance: ${wallet.getBalance().total}")
println("New address: ${wallet.revealNextAddress(KeychainKind.EXTERNAL).address}") println("New address: ${wallet.getAddress(AddressIndex.New).address}")
assert(wallet.getBalance().total > 0uL) { assert(wallet.getBalance().total > 0uL) {
"Wallet balance must be greater than 0! Please send funds to ${wallet.revealNextAddress(KeychainKind.EXTERNAL).address} and try again." "Wallet balance must be greater than 0! Please send funds to ${wallet.getAddress(AddressIndex.New).address} and try again."
} }
val recipient: Address = Address("tb1qrnfslnrve9uncz9pzpvf83k3ukz22ljgees989", Network.SIGNET) val recipient: Address = Address("tb1qrnfslnrve9uncz9pzpvf83k3ukz22ljgees989", Network.TESTNET)
val psbt: Psbt = TxBuilder() val psbt: PartiallySignedTransaction = TxBuilder()
.addRecipient(recipient.scriptPubkey(), 4200uL) .addRecipient(recipient.scriptPubkey(), 4200uL)
.feeRate(FeeRate.fromSatPerVb(4uL)) .feeRate(FeeRate.fromSatPerVb(4.0f))
.finish(wallet) .finish(wallet)
println(psbt.serialize()) println(psbt.serialize())
@@ -85,7 +79,7 @@ class LiveWalletTest {
println("Tx fee is: ${txFee}") println("Tx fee is: ${txFee}")
val feeRate: FeeRate = wallet.calculateFeeRate(tx) val feeRate: FeeRate = wallet.calculateFeeRate(tx)
println("Tx fee rate is: ${feeRate.toSatPerVbCeil()} sat/vB") println("Tx fee rate is: ${feeRate.asSatPerVb()} sat/vB")
esploraClient.broadcast(tx) esploraClient.broadcast(tx)
} }

View File

@@ -44,7 +44,7 @@ class OfflineWalletTest {
persistenceFilePath, persistenceFilePath,
Network.TESTNET Network.TESTNET
) )
val addressInfo: AddressInfo = wallet.revealNextAddress(KeychainKind.EXTERNAL) val addressInfo: AddressInfo = wallet.getAddress(AddressIndex.New)
assertTrue(addressInfo.address.isValidForNetwork(Network.TESTNET), "Address is not valid for testnet network") assertTrue(addressInfo.address.isValidForNetwork(Network.TESTNET), "Address is not valid for testnet network")
assertTrue(addressInfo.address.isValidForNetwork(Network.SIGNET), "Address is not valid for signet network") assertTrue(addressInfo.address.isValidForNetwork(Network.SIGNET), "Address is not valid for signet network")

View File

@@ -1,3 +1,6 @@
<manifest xmlns:android="http://schemas.android.com/apk/res/android"> <manifest xmlns:android="http://schemas.android.com/apk/res/android"
package="org.bitcoindevkit">
<uses-permission android:name="android.permission.INTERNET" /> <uses-permission android:name="android.permission.INTERNET" />
</manifest> </manifest>

View File

@@ -1,5 +1,6 @@
package org.bitcoindevkit.plugins package org.bitcoindevkit.plugins
val operatingSystem: OS = when { val operatingSystem: OS = when {
System.getProperty("os.name").contains("mac", ignoreCase = true) -> OS.MAC 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("linux", ignoreCase = true) -> OS.LINUX

View File

@@ -17,11 +17,6 @@ internal class UniFfiAndroidPlugin : Plugin<Project> {
OS.OTHER -> throw Error("Cannot build Android library from current architecture") OS.OTHER -> throw Error("Cannot build Android library from current architecture")
} }
// if ANDROID_NDK_ROOT is not set, stop build
if (System.getenv("ANDROID_NDK_ROOT") == null) {
throw IllegalStateException("ANDROID_NDK_ROOT environment variable is not set; cannot build library")
}
// arm64-v8a is the most popular hardware architecture for Android // arm64-v8a is the most popular hardware architecture for Android
val buildAndroidAarch64Binary by tasks.register<Exec>("buildAndroidAarch64Binary") { val buildAndroidAarch64Binary by tasks.register<Exec>("buildAndroidAarch64Binary") {
@@ -31,6 +26,13 @@ internal class UniFfiAndroidPlugin : Plugin<Project> {
executable("cargo") executable("cargo")
args(cargoArgs) args(cargoArgs)
// if ANDROID_NDK_ROOT is not set then set it to github actions default
if (System.getenv("ANDROID_NDK_ROOT") == null) {
environment(
Pair("ANDROID_NDK_ROOT", "${System.getenv("ANDROID_SDK_ROOT")}/ndk-bundle")
)
}
environment( environment(
// add build toolchain to PATH // add build toolchain to PATH
Pair("PATH", "${System.getenv("PATH")}:${System.getenv("ANDROID_NDK_ROOT")}/toolchains/llvm/prebuilt/$llvmArchPath/bin"), Pair("PATH", "${System.getenv("PATH")}:${System.getenv("ANDROID_NDK_ROOT")}/toolchains/llvm/prebuilt/$llvmArchPath/bin"),
@@ -54,6 +56,13 @@ internal class UniFfiAndroidPlugin : Plugin<Project> {
executable("cargo") executable("cargo")
args(cargoArgs) args(cargoArgs)
// if ANDROID_NDK_ROOT is not set then set it to github actions default
if (System.getenv("ANDROID_NDK_ROOT") == null) {
environment(
Pair("ANDROID_NDK_ROOT", "${System.getenv("ANDROID_SDK_ROOT")}/ndk-bundle")
)
}
environment( environment(
// add build toolchain to PATH // add build toolchain to PATH
Pair("PATH", "${System.getenv("PATH")}:${System.getenv("ANDROID_NDK_ROOT")}/toolchains/llvm/prebuilt/$llvmArchPath/bin"), Pair("PATH", "${System.getenv("PATH")}:${System.getenv("ANDROID_NDK_ROOT")}/toolchains/llvm/prebuilt/$llvmArchPath/bin"),
@@ -77,6 +86,13 @@ internal class UniFfiAndroidPlugin : Plugin<Project> {
executable("cargo") executable("cargo")
args(cargoArgs) args(cargoArgs)
// if ANDROID_NDK_ROOT is not set then set it to github actions default
if (System.getenv("ANDROID_NDK_ROOT") == null) {
environment(
Pair("ANDROID_NDK_ROOT", "${System.getenv("ANDROID_SDK_ROOT")}/ndk-bundle")
)
}
environment( environment(
// add build toolchain to PATH // add build toolchain to PATH
Pair("PATH", "${System.getenv("PATH")}:${System.getenv("ANDROID_NDK_ROOT")}/toolchains/llvm/prebuilt/$llvmArchPath/bin"), Pair("PATH", "${System.getenv("PATH")}:${System.getenv("ANDROID_NDK_ROOT")}/toolchains/llvm/prebuilt/$llvmArchPath/bin"),
@@ -97,8 +113,6 @@ internal class UniFfiAndroidPlugin : Plugin<Project> {
val moveNativeAndroidLibs by tasks.register<Copy>("moveNativeAndroidLibs") { val moveNativeAndroidLibs by tasks.register<Copy>("moveNativeAndroidLibs") {
dependsOn(buildAndroidAarch64Binary) dependsOn(buildAndroidAarch64Binary)
dependsOn(buildAndroidArmv7Binary)
dependsOn(buildAndroidX86_64Binary)
into("${project.projectDir}/../lib/src/main/jniLibs/") into("${project.projectDir}/../lib/src/main/jniLibs/")
@@ -123,14 +137,14 @@ internal class UniFfiAndroidPlugin : Plugin<Project> {
val generateAndroidBindings by tasks.register<Exec>("generateAndroidBindings") { val generateAndroidBindings by tasks.register<Exec>("generateAndroidBindings") {
dependsOn(moveNativeAndroidLibs) dependsOn(moveNativeAndroidLibs)
val libraryPath = "${project.projectDir}/../../bdk-ffi/target/aarch64-linux-android/release-smaller/libbdkffi.so" // val libraryPath = "${project.projectDir}/../../bdk-ffi/target/aarch64-linux-android/release-smaller/libbdkffi.so"
workingDir("${project.projectDir}/../../bdk-ffi") // workingDir("${project.projectDir}/../../bdk-ffi")
val cargoArgs: List<String> = listOf("run", "--bin", "uniffi-bindgen", "generate", "--library", libraryPath, "--language", "kotlin", "--out-dir", "../bdk-android/lib/src/main/kotlin", "--no-format") // val cargoArgs: List<String> = listOf("run", "--bin", "uniffi-bindgen", "generate", "--library", libraryPath, "--language", "kotlin", "--out-dir", "../bdk-android/lib/src/main/kotlin", "--no-format")
// The code above worked for uniffi 0.24.3 using the --library flag // The code above worked for uniffi 0.24.3 using the --library flag
// The code below works for uniffi 0.23.0 // The code below works for uniffi 0.23.0
// workingDir("${project.projectDir}/../../bdk-ffi") workingDir("${project.projectDir}/../../bdk-ffi")
// val cargoArgs: List<String> = listOf("run", "--bin", "uniffi-bindgen", "generate", "src/bdk.udl", "--language", "kotlin", "--config", "uniffi-android.toml", "--out-dir", "../bdk-android/lib/src/main/kotlin", "--no-format") val cargoArgs: List<String> = listOf("run", "--bin", "uniffi-bindgen", "generate", "src/bdk.udl", "--language", "kotlin", "--config", "uniffi-android.toml", "--out-dir", "../bdk-android/lib/src/main/kotlin", "--no-format")
executable("cargo") executable("cargo")
args(cargoArgs) args(cargoArgs)

View File

@@ -2,17 +2,3 @@ rootProject.name = "bdk-android"
include(":lib") include(":lib")
includeBuild("plugins") includeBuild("plugins")
pluginManagement {
repositories {
gradlePluginPortal()
google()
}
}
dependencyResolutionManagement {
repositories {
mavenCentral()
google()
}
}

626
bdk-ffi/Cargo.lock generated

File diff suppressed because it is too large Load Diff

View File

@@ -1,6 +1,6 @@
[package] [package]
name = "bdk-ffi" name = "bdk-ffi"
version = "1.0.0-alpha.10" version = "1.0.0-alpha.7"
homepage = "https://bitcoindevkit.org" homepage = "https://bitcoindevkit.org"
repository = "https://github.com/bitcoindevkit/bdk" repository = "https://github.com/bitcoindevkit/bdk"
edition = "2018" edition = "2018"
@@ -18,12 +18,12 @@ path = "uniffi-bindgen.rs"
default = ["uniffi/cli"] default = ["uniffi/cli"]
[dependencies] [dependencies]
bdk = { version = "1.0.0-alpha.10", features = ["all-keys", "keys-bip39"] } bdk = { version = "1.0.0-alpha.7", features = ["all-keys", "keys-bip39"] }
bdk_esplora = { version = "0.12.0", default-features = false, features = ["std", "blocking", "blocking-https-rustls"] } bdk_esplora = { version = "0.9.0", default-features = false, features = ["std", "blocking"] }
bdk_file_store = { version = "0.10.0" } # bdk_esplora = { version = "0.9.0", default-features = false, features = ["std", "blocking", "async-https-rustls"] }
bdk_file_store = { version = "0.7.0" }
uniffi = { version = "=0.26.1" } uniffi = { version = "=0.26.1" }
bitcoin-internals = { version = "0.2.0", features = ["alloc"] }
thiserror = "1.0.58" thiserror = "1.0.58"
[build-dependencies] [build-dependencies]

View File

@@ -1,12 +0,0 @@
default:
just --list
build:
cargo build
check:
cargo fmt
cargo clippy
test:
cargo test --lib

View File

@@ -5,40 +5,8 @@ namespace bdk {};
// ------------------------------------------------------------------------ // ------------------------------------------------------------------------
[Error] [Error]
interface AddressError { enum Alpha3Error {
Base58(); "Generic"
Bech32();
WitnessVersion(string error_message);
WitnessProgram(string error_message);
UncompressedPubkey();
ExcessiveScriptSize();
UnrecognizedScript();
NetworkValidation(Network required, Network found, string address);
OtherAddressErr();
};
[Error]
interface Bip32Error {
CannotDeriveFromHardenedKey();
Secp256k1(string error_message);
InvalidChildNumber(u32 child_number);
InvalidChildNumberFormat();
InvalidDerivationPathFormat();
UnknownVersion(string version);
WrongExtendedKeyLength(u32 length);
Base58(string error_message);
Hex(string error_message);
InvalidPublicKeyHexLength(u32 length);
UnknownError(string error_message);
};
[Error]
interface Bip39Error {
BadWordCount(u64 word_count);
UnknownWord(u64 index);
BadEntropyBitCount(u64 bit_count);
InvalidChecksum();
AmbiguousLanguages(string languages);
}; };
[Error] [Error]
@@ -48,143 +16,30 @@ interface CalculateFeeError {
}; };
[Error] [Error]
interface CannotConnectError { interface WalletCreationError {
Include(u32 height); Io(string e);
}; InvalidMagicBytes(sequence<u8> got, sequence<u8> expected);
Descriptor();
[Error] Write();
interface CreateTxError { Load();
Descriptor(string error_message); NotInitialized();
Persist(string error_message); LoadedGenesisDoesNotMatch();
Policy(string error_message); LoadedNetworkDoesNotMatch(Network expected, Network? got);
SpendingPolicyRequired(string kind);
Version0();
Version1Csv();
LockTime(string requested, string required);
RbfSequence();
RbfSequenceCsv(string rbf, string csv);
FeeTooLow(u64 required);
FeeRateTooLow(string required);
NoUtxosSelected();
OutputBelowDustLimit(u64 index);
ChangePolicyDescriptor();
CoinSelection(string error_message);
InsufficientFunds(u64 needed, u64 available);
NoRecipients();
Psbt(string error_message);
MissingKeyOrigin(string key);
UnknownUtxo(string outpoint);
MissingNonWitnessUtxo(string outpoint);
MiniscriptPsbt(string error_message);
};
[Error]
interface DescriptorError {
InvalidHdKeyPath();
InvalidDescriptorChecksum();
HardenedDerivationXpub();
MultiPath();
Key(string error_message);
Policy(string error_message);
InvalidDescriptorCharacter(string char);
Bip32(string error_message);
Base58(string error_message);
Pk(string error_message);
Miniscript(string error_message);
Hex(string error_message);
};
[Error]
interface DescriptorKeyError {
Parse(string error_message);
InvalidKeyType();
Bip32(string error_message);
}; };
[Error] [Error]
interface EsploraError { interface EsploraError {
Minreq(string error_message); Ureq(string error_message);
HttpResponse(u16 status, string error_message); UreqTransport(string error_message);
Http(u16 status_code);
Io(string error_message);
NoHeader();
Parsing(string error_message); Parsing(string error_message);
StatusCode(string error_message);
BitcoinEncoding(string error_message); BitcoinEncoding(string error_message);
HexToArray(string error_message); Hex(string error_message);
HexToBytes(string error_message);
TransactionNotFound(); TransactionNotFound();
HeaderHeightNotFound(u32 height); HeaderHeightNotFound(u32 height);
HeaderHashNotFound(); HeaderHashNotFound();
InvalidHttpHeaderName(string name);
InvalidHttpHeaderValue(string value);
RequestAlreadyConsumed();
};
[Error]
interface ExtractTxError {
AbsurdFeeRate(u64 fee_rate);
MissingInputValue();
SendingTooMuch();
OtherExtractTxErr();
};
[Error]
enum FeeRateError {
"ArithmeticOverflow"
};
[Error]
interface PersistenceError {
Write(string error_message);
};
[Error]
interface PsbtParseError {
PsbtEncoding(string error_message);
Base64Encoding(string error_message);
};
[Error]
interface SignerError {
MissingKey();
InvalidKey();
UserCanceled();
InputIndexOutOfRange();
MissingNonWitnessUtxo();
InvalidNonWitnessUtxo();
MissingWitnessUtxo();
MissingWitnessScript();
MissingHdKeypath();
NonStandardSighash();
InvalidSighash();
SighashError(string error_message);
MiniscriptPsbt(string error_message);
External(string error_message);
};
[Error]
interface TransactionError {
Io();
OversizedVectorAllocation();
InvalidChecksum(string expected, string actual);
NonMinimalVarInt();
ParseFailed();
UnsupportedSegwitFlag(u8 flag);
OtherTransactionErr();
};
[Error]
interface TxidParseError {
InvalidTxid(string txid);
};
[Error]
interface WalletCreationError {
Io(string error_message);
InvalidMagicBytes(sequence<u8> got, sequence<u8> expected);
Descriptor();
Persist(string error_message);
NotInitialized();
LoadedGenesisDoesNotMatch(string expected, string got);
LoadedNetworkDoesNotMatch(Network expected, Network? got);
}; };
// ------------------------------------------------------------------------ // ------------------------------------------------------------------------
@@ -202,6 +57,13 @@ dictionary AddressInfo {
KeychainKind keychain; KeychainKind keychain;
}; };
[Enum]
interface AddressIndex {
New();
LastUnused();
Peek(u32 index);
};
dictionary Balance { dictionary Balance {
u64 immature; u64 immature;
@@ -228,25 +90,22 @@ dictionary TxOut {
Script script_pubkey; Script script_pubkey;
}; };
[Enum]
interface ChainPosition {
Confirmed(u32 height, u64 timestamp);
Unconfirmed(u64 timestamp);
};
dictionary CanonicalTx {
Transaction transaction;
ChainPosition chain_position;
};
interface FullScanRequest {};
interface SyncRequest {};
// ------------------------------------------------------------------------ // ------------------------------------------------------------------------
// bdk crate - wallet module // bdk crate - wallet module
// ------------------------------------------------------------------------ // ------------------------------------------------------------------------
interface FeeRate {
[Name=from_sat_per_vb]
constructor(f32 sat_per_vb);
[Name=from_sat_per_kwu]
constructor(f32 sat_per_kwu);
f32 as_sat_per_vb();
f32 sat_per_kwu();
};
enum ChangeSpendPolicy { enum ChangeSpendPolicy {
"ChangeAllowed", "ChangeAllowed",
"OnlyChange", "OnlyChange",
@@ -257,44 +116,32 @@ interface Wallet {
[Throws=WalletCreationError] [Throws=WalletCreationError]
constructor(Descriptor descriptor, Descriptor? change_descriptor, string persistence_backend_path, Network network); constructor(Descriptor descriptor, Descriptor? change_descriptor, string persistence_backend_path, Network network);
[Throws=PersistenceError] AddressInfo get_address(AddressIndex address_index);
AddressInfo reveal_next_address(KeychainKind keychain);
[Throws=Alpha3Error]
AddressInfo try_get_internal_address(AddressIndex address_index);
Network network(); Network network();
Balance get_balance(); Balance get_balance();
[Throws=CannotConnectError] [Throws=Alpha3Error]
void apply_update(Update update); void apply_update(Update update);
[Throws=PersistenceError]
boolean commit();
boolean is_mine([ByRef] Script script); boolean is_mine([ByRef] Script script);
[Throws=SignerError] [Throws=Alpha3Error]
boolean sign(Psbt psbt); boolean sign(PartiallySignedTransaction psbt);
SentAndReceivedValues sent_and_received([ByRef] Transaction tx); SentAndReceivedValues sent_and_received([ByRef] Transaction tx);
sequence<CanonicalTx> transactions(); sequence<Transaction> transactions();
[Throws=TxidParseError]
CanonicalTx? get_tx(string txid);
[Throws=CalculateFeeError] [Throws=CalculateFeeError]
u64 calculate_fee([ByRef] Transaction tx); u64 calculate_fee([ByRef] Transaction tx);
[Throws=CalculateFeeError] [Throws=CalculateFeeError]
FeeRate calculate_fee_rate([ByRef] Transaction tx); FeeRate calculate_fee_rate([ByRef] Transaction tx);
sequence<LocalOutput> list_unspent();
sequence<LocalOutput> list_output();
FullScanRequest start_full_scan();
SyncRequest start_sync_with_revealed_spks();
}; };
interface Update {}; interface Update {};
@@ -332,19 +179,21 @@ interface TxBuilder {
TxBuilder enable_rbf_with_sequence(u32 nsequence); TxBuilder enable_rbf_with_sequence(u32 nsequence);
[Throws=CreateTxError] [Throws=Alpha3Error]
Psbt finish([ByRef] Wallet wallet); PartiallySignedTransaction finish([ByRef] Wallet wallet);
}; };
interface BumpFeeTxBuilder { interface BumpFeeTxBuilder {
constructor(string txid, FeeRate fee_rate); constructor(string txid, f32 fee_rate);
BumpFeeTxBuilder allow_shrinking(Script script_pubkey);
BumpFeeTxBuilder enable_rbf(); BumpFeeTxBuilder enable_rbf();
BumpFeeTxBuilder enable_rbf_with_sequence(u32 nsequence); BumpFeeTxBuilder enable_rbf_with_sequence(u32 nsequence);
[Throws=CreateTxError] [Throws=Alpha3Error]
Psbt finish([ByRef] Wallet wallet); PartiallySignedTransaction finish([ByRef] Wallet wallet);
}; };
// ------------------------------------------------------------------------ // ------------------------------------------------------------------------
@@ -354,30 +203,30 @@ interface BumpFeeTxBuilder {
interface Mnemonic { interface Mnemonic {
constructor(WordCount word_count); constructor(WordCount word_count);
[Name=from_string, Throws=Bip39Error] [Name=from_string, Throws=Alpha3Error]
constructor(string mnemonic); constructor(string mnemonic);
[Name=from_entropy, Throws=Bip39Error] [Name=from_entropy, Throws=Alpha3Error]
constructor(sequence<u8> entropy); constructor(sequence<u8> entropy);
string as_string(); string as_string();
}; };
interface DerivationPath { interface DerivationPath {
[Throws=Bip32Error] [Throws=Alpha3Error]
constructor(string path); constructor(string path);
}; };
interface DescriptorSecretKey { interface DescriptorSecretKey {
constructor(Network network, [ByRef] Mnemonic mnemonic, string? password); constructor(Network network, [ByRef] Mnemonic mnemonic, string? password);
[Name=from_string, Throws=DescriptorKeyError] [Name=from_string, Throws=Alpha3Error]
constructor(string secret_key); constructor(string secret_key);
[Throws=DescriptorKeyError] [Throws=Alpha3Error]
DescriptorSecretKey derive([ByRef] DerivationPath path); DescriptorSecretKey derive([ByRef] DerivationPath path);
[Throws=DescriptorKeyError] [Throws=Alpha3Error]
DescriptorSecretKey extend([ByRef] DerivationPath path); DescriptorSecretKey extend([ByRef] DerivationPath path);
DescriptorPublicKey as_public(); DescriptorPublicKey as_public();
@@ -388,20 +237,20 @@ interface DescriptorSecretKey {
}; };
interface DescriptorPublicKey { interface DescriptorPublicKey {
[Name=from_string, Throws=DescriptorKeyError] [Name=from_string, Throws=Alpha3Error]
constructor(string public_key); constructor(string public_key);
[Throws=DescriptorKeyError] [Throws=Alpha3Error]
DescriptorPublicKey derive([ByRef] DerivationPath path); DescriptorPublicKey derive([ByRef] DerivationPath path);
[Throws=DescriptorKeyError] [Throws=Alpha3Error]
DescriptorPublicKey extend([ByRef] DerivationPath path); DescriptorPublicKey extend([ByRef] DerivationPath path);
string as_string(); string as_string();
}; };
interface Descriptor { interface Descriptor {
[Throws=DescriptorError] [Throws=Alpha3Error]
constructor(string descriptor, Network network); constructor(string descriptor, Network network);
[Name=new_bip44] [Name=new_bip44]
@@ -441,12 +290,9 @@ interface EsploraClient {
constructor(string url); constructor(string url);
[Throws=EsploraError] [Throws=EsploraError]
Update full_scan(FullScanRequest full_scan_request, u64 stop_gap, u64 parallel_requests); Update full_scan(Wallet wallet, u64 stop_gap, u64 parallel_requests);
[Throws=EsploraError] [Throws=Alpha3Error]
Update sync(SyncRequest sync_request, u64 parallel_requests);
[Throws=EsploraError]
void broadcast([ByRef] Transaction transaction); void broadcast([ByRef] Transaction transaction);
}; };
@@ -491,7 +337,7 @@ enum WordCount {
}; };
interface Address { interface Address {
[Throws=AddressError] [Throws=Alpha3Error]
constructor(string address, Network network); constructor(string address, Network network);
Network network(); Network network();
@@ -506,35 +352,30 @@ interface Address {
}; };
interface Transaction { interface Transaction {
[Throws=TransactionError] [Throws=Alpha3Error]
constructor(sequence<u8> transaction_bytes); constructor(sequence<u8> transaction_bytes);
string txid(); string txid();
u64 total_size(); u64 size();
u64 vsize(); u64 vsize();
boolean is_coinbase(); boolean is_coin_base();
boolean is_explicitly_rbf(); boolean is_explicitly_rbf();
boolean is_lock_time_enabled(); boolean is_lock_time_enabled();
i32 version(); i32 version();
sequence<u8> serialize();
u64 weight();
}; };
interface Psbt { interface PartiallySignedTransaction {
[Throws=PsbtParseError] [Throws=Alpha3Error]
constructor(string psbt_base64); constructor(string psbt_base64);
string serialize(); string serialize();
[Throws=ExtractTxError]
Transaction extract_tx(); Transaction extract_tx();
}; };
@@ -542,17 +383,3 @@ dictionary OutPoint {
string txid; string txid;
u32 vout; u32 vout;
}; };
interface FeeRate {
[Name=from_sat_per_vb, Throws=FeeRateError]
constructor(u64 sat_per_vb);
[Name=from_sat_per_kwu]
constructor(u64 sat_per_kwu);
u64 to_sat_per_vb_ceil();
u64 to_sat_per_vb_floor();
u64 to_sat_per_kwu();
};

View File

@@ -1,19 +1,15 @@
use crate::error::{AddressError, FeeRateError, PsbtParseError, TransactionError};
use bdk::bitcoin::address::{NetworkChecked, NetworkUnchecked}; use bdk::bitcoin::address::{NetworkChecked, NetworkUnchecked};
use bdk::bitcoin::blockdata::script::ScriptBuf as BdkScriptBuf; use bdk::bitcoin::blockdata::script::ScriptBuf as BdkScriptBuf;
use bdk::bitcoin::blockdata::transaction::TxOut as BdkTxOut; use bdk::bitcoin::blockdata::transaction::TxOut as BdkTxOut;
use bdk::bitcoin::consensus::encode::serialize;
use bdk::bitcoin::consensus::Decodable; use bdk::bitcoin::consensus::Decodable;
use bdk::bitcoin::psbt::ExtractTxError; use bdk::bitcoin::psbt::PartiallySignedTransaction as BdkPartiallySignedTransaction;
use bdk::bitcoin::Address as BdkAddress; use bdk::bitcoin::Address as BdkAddress;
use bdk::bitcoin::FeeRate as BdkFeeRate;
use bdk::bitcoin::Network; use bdk::bitcoin::Network;
use bdk::bitcoin::OutPoint as BdkOutPoint; use bdk::bitcoin::OutPoint as BdkOutPoint;
use bdk::bitcoin::Psbt as BdkPsbt;
use bdk::bitcoin::Transaction as BdkTransaction; use bdk::bitcoin::Transaction as BdkTransaction;
use bdk::bitcoin::Txid; use bdk::bitcoin::Txid;
use crate::error::Alpha3Error;
use std::io::Cursor; use std::io::Cursor;
use std::str::FromStr; use std::str::FromStr;
use std::sync::{Arc, Mutex}; use std::sync::{Arc, Mutex};
@@ -39,34 +35,65 @@ impl From<BdkScriptBuf> for Script {
} }
#[derive(Debug, PartialEq, Eq)] #[derive(Debug, PartialEq, Eq)]
pub struct Address(BdkAddress<NetworkChecked>); pub struct Address {
inner: BdkAddress<NetworkChecked>,
}
impl Address { impl Address {
pub fn new(address: String, network: Network) -> Result<Self, AddressError> { pub fn new(address: String, network: Network) -> Result<Self, Alpha3Error> {
let parsed_address = address.parse::<bdk::bitcoin::Address<NetworkUnchecked>>()?; let parsed_address = address
let network_checked_address = parsed_address.require_network(network)?; .parse::<bdk::bitcoin::Address<NetworkUnchecked>>()
.map_err(|_| Alpha3Error::Generic)?;
Ok(Address(network_checked_address)) let network_checked_address = parsed_address
.require_network(network)
.map_err(|_| Alpha3Error::Generic)?;
Ok(Address {
inner: network_checked_address,
})
} }
/// 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.inner.payload.clone() {
// BdkPayload::PubkeyHash(pubkey_hash) => Payload::PubkeyHash {
// pubkey_hash: pubkey_hash.to_vec(),
// },
// BdkPayload::ScriptHash(script_hash) => Payload::ScriptHash {
// script_hash: script_hash.to_vec(),
// },
// BdkPayload::WitnessProgram { version, program } => Payload::WitnessProgram {
// version: *version,
// program: program.clone(),
// },
// }
// }
pub fn network(&self) -> Network { pub fn network(&self) -> Network {
*self.0.network() self.inner.network
} }
pub fn script_pubkey(&self) -> Arc<Script> { pub fn script_pubkey(&self) -> Arc<Script> {
Arc::new(Script(self.0.script_pubkey())) Arc::new(Script(self.inner.script_pubkey()))
} }
pub fn to_qr_uri(&self) -> String { pub fn to_qr_uri(&self) -> String {
self.0.to_qr_uri() self.inner.to_qr_uri()
} }
pub fn as_string(&self) -> String { pub fn as_string(&self) -> String {
self.0.to_string() self.inner.to_string()
} }
pub fn is_valid_for_network(&self, network: Network) -> bool { pub fn is_valid_for_network(&self, network: Network) -> bool {
let address_str = self.0.to_string(); let address_str = self.inner.to_string();
if let Ok(unchecked_address) = address_str.parse::<BdkAddress<NetworkUnchecked>>() { if let Ok(unchecked_address) = address_str.parse::<BdkAddress<NetworkUnchecked>>() {
unchecked_address.is_valid_for_network(network) unchecked_address.is_valid_for_network(network)
} else { } else {
@@ -77,104 +104,169 @@ impl Address {
impl From<Address> for BdkAddress { impl From<Address> for BdkAddress {
fn from(address: Address) -> Self { fn from(address: Address) -> Self {
address.0 address.inner
} }
} }
impl From<BdkAddress> for Address { impl From<BdkAddress> for Address {
fn from(address: BdkAddress) -> Self { fn from(address: BdkAddress) -> Self {
Address(address) Address { inner: address }
} }
} }
#[derive(Debug, Clone, PartialEq, Eq)] #[derive(Debug, Clone, PartialEq, Eq)]
pub struct Transaction(BdkTransaction); pub struct Transaction {
inner: BdkTransaction,
}
impl Transaction { impl Transaction {
pub fn new(transaction_bytes: Vec<u8>) -> Result<Self, TransactionError> { pub fn new(transaction_bytes: Vec<u8>) -> Result<Self, Alpha3Error> {
let mut decoder = Cursor::new(transaction_bytes); let mut decoder = Cursor::new(transaction_bytes);
let tx: BdkTransaction = BdkTransaction::consensus_decode(&mut decoder)?; let tx: BdkTransaction =
Ok(Transaction(tx)) BdkTransaction::consensus_decode(&mut decoder).map_err(|_| Alpha3Error::Generic)?;
Ok(Transaction { inner: tx })
} }
pub fn txid(&self) -> String { pub fn txid(&self) -> String {
self.0.txid().to_string() self.inner.txid().to_string()
} }
pub fn weight(&self) -> u64 { // fn weight(&self) -> u64 {
self.0.weight().to_wu() // self.inner.weight() as u64
} // }
pub fn total_size(&self) -> u64 { pub fn size(&self) -> u64 {
self.0.total_size() as u64 self.inner.size() as u64
} }
pub fn vsize(&self) -> u64 { pub fn vsize(&self) -> u64 {
self.0.vsize() as u64 self.inner.vsize() as u64
} }
pub fn is_coinbase(&self) -> bool { // fn serialize(&self) -> Vec<u8> {
self.0.is_coinbase() // self.inner.serialize()
// }
pub fn is_coin_base(&self) -> bool {
self.inner.is_coin_base()
} }
pub fn is_explicitly_rbf(&self) -> bool { pub fn is_explicitly_rbf(&self) -> bool {
self.0.is_explicitly_rbf() self.inner.is_explicitly_rbf()
} }
pub fn is_lock_time_enabled(&self) -> bool { pub fn is_lock_time_enabled(&self) -> bool {
self.0.is_lock_time_enabled() self.inner.is_lock_time_enabled()
} }
pub fn version(&self) -> i32 { pub fn version(&self) -> i32 {
self.0.version.0 self.inner.version
} }
pub fn serialize(&self) -> Vec<u8> { // fn lock_time(&self) -> u32 {
serialize(&self.0) // self.inner.lock_time.0
} // }
// fn input(&self) -> Vec<TxIn> {
// self.inner.input.iter().map(|x| x.into()).collect()
// }
//
// fn output(&self) -> Vec<TxOut> {
// self.inner.output.iter().map(|x| x.into()).collect()
// }
} }
impl From<BdkTransaction> for Transaction { impl From<BdkTransaction> for Transaction {
fn from(tx: BdkTransaction) -> Self { fn from(tx: BdkTransaction) -> Self {
Transaction(tx) Transaction { inner: tx }
} }
} }
impl From<&BdkTransaction> for Transaction { impl From<&BdkTransaction> for Transaction {
fn from(tx: &BdkTransaction) -> Self { fn from(tx: &BdkTransaction) -> Self {
Transaction(tx.clone()) Transaction { inner: tx.clone() }
} }
} }
impl From<&Transaction> for BdkTransaction { impl From<&Transaction> for BdkTransaction {
fn from(tx: &Transaction) -> Self { fn from(tx: &Transaction) -> Self {
tx.0.clone() tx.inner.clone()
} }
} }
pub struct Psbt(pub(crate) Mutex<BdkPsbt>); pub struct PartiallySignedTransaction {
pub(crate) inner: Mutex<BdkPartiallySignedTransaction>,
}
impl Psbt { impl PartiallySignedTransaction {
pub(crate) fn new(psbt_base64: String) -> Result<Self, PsbtParseError> { pub(crate) fn new(psbt_base64: String) -> Result<Self, Alpha3Error> {
let psbt: BdkPsbt = BdkPsbt::from_str(&psbt_base64)?; let psbt: BdkPartiallySignedTransaction =
Ok(Psbt(Mutex::new(psbt))) BdkPartiallySignedTransaction::from_str(&psbt_base64)
.map_err(|_| Alpha3Error::Generic)?;
Ok(PartiallySignedTransaction {
inner: Mutex::new(psbt),
})
} }
pub(crate) fn serialize(&self) -> String { pub(crate) fn serialize(&self) -> String {
let psbt = self.0.lock().unwrap().clone(); let psbt = self.inner.lock().unwrap().clone();
psbt.to_string() psbt.to_string()
} }
pub(crate) fn extract_tx(&self) -> Result<Arc<Transaction>, ExtractTxError> { // pub(crate) fn txid(&self) -> String {
let tx: BdkTransaction = self.0.lock().unwrap().clone().extract_tx()?; // let tx = self.inner.lock().unwrap().clone().extract_tx();
let transaction: Transaction = tx.into(); // let txid = tx.txid();
Ok(Arc::new(transaction)) // txid.to_hex()
// }
pub(crate) fn extract_tx(&self) -> Arc<Transaction> {
let tx = self.inner.lock().unwrap().clone().extract_tx();
Arc::new(tx.into())
} }
// /// Combines this PartiallySignedTransaction with other PSBT as described by BIP 174.
// ///
// /// In accordance with BIP 174 this function is commutative i.e., `A.combine(B) == B.combine(A)`
// pub(crate) fn combine(
// &self,
// other: Arc<PartiallySignedTransaction>,
// ) -> Result<Arc<PartiallySignedTransaction>, BdkError> {
// let other_psbt = other.inner.lock().unwrap().clone();
// let mut original_psbt = self.inner.lock().unwrap().clone();
//
// original_psbt.combine(other_psbt)?;
// Ok(Arc::new(PartiallySignedTransaction {
// 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.inner.lock().unwrap().fee_amount()
// }
// /// The transaction's fee rate. This value will only be accurate if calculated AFTER the
// /// `PartiallySignedTransaction` is finalized and all witness/signature data is added to the
// /// transaction.
// /// If the PSBT is missing a TxOut for an input returns None.
// pub(crate) fn fee_rate(&self) -> Option<Arc<FeeRate>> {
// 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()
// }
} }
impl From<BdkPsbt> for Psbt { impl From<BdkPartiallySignedTransaction> for PartiallySignedTransaction {
fn from(psbt: BdkPsbt) -> Self { fn from(psbt: BdkPartiallySignedTransaction) -> Self {
Psbt(Mutex::new(psbt)) PartiallySignedTransaction {
inner: Mutex::new(psbt),
}
} }
} }
@@ -211,41 +303,12 @@ pub struct TxOut {
impl From<&BdkTxOut> for TxOut { impl From<&BdkTxOut> for TxOut {
fn from(tx_out: &BdkTxOut) -> Self { fn from(tx_out: &BdkTxOut) -> Self {
TxOut { TxOut {
value: tx_out.value.to_sat(), value: tx_out.value,
script_pubkey: Arc::new(Script(tx_out.script_pubkey.clone())), script_pubkey: Arc::new(Script(tx_out.script_pubkey.clone())),
} }
} }
} }
#[derive(Clone, Debug)]
pub struct FeeRate(pub BdkFeeRate);
impl FeeRate {
pub fn from_sat_per_vb(sat_per_vb: u64) -> Result<Self, FeeRateError> {
let fee_rate: Option<BdkFeeRate> = BdkFeeRate::from_sat_per_vb(sat_per_vb);
match fee_rate {
Some(fee_rate) => Ok(FeeRate(fee_rate)),
None => Err(FeeRateError::ArithmeticOverflow),
}
}
pub fn from_sat_per_kwu(sat_per_kwu: u64) -> Self {
FeeRate(BdkFeeRate::from_sat_per_kwu(sat_per_kwu))
}
pub fn to_sat_per_vb_ceil(&self) -> u64 {
self.0.to_sat_per_vb_ceil()
}
pub fn to_sat_per_vb_floor(&self) -> u64 {
self.0.to_sat_per_vb_floor()
}
pub fn to_sat_per_kwu(&self) -> u64 {
self.0.to_sat_per_kwu()
}
}
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {
use crate::bitcoin::Address; use crate::bitcoin::Address;

View File

@@ -1,4 +1,4 @@
use crate::error::DescriptorError; use crate::error::Alpha3Error;
use crate::keys::DescriptorPublicKey; use crate::keys::DescriptorPublicKey;
use crate::keys::DescriptorSecretKey; use crate::keys::DescriptorSecretKey;
@@ -23,7 +23,7 @@ pub struct Descriptor {
} }
impl Descriptor { impl Descriptor {
pub(crate) fn new(descriptor: String, network: Network) -> Result<Self, DescriptorError> { pub(crate) fn new(descriptor: String, network: Network) -> Result<Self, Alpha3Error> {
let secp = Secp256k1::new(); let secp = Secp256k1::new();
let (extended_descriptor, key_map) = descriptor.into_wallet_descriptor(&secp, network)?; let (extended_descriptor, key_map) = descriptor.into_wallet_descriptor(&secp, network)?;
Ok(Self { Ok(Self {
@@ -37,7 +37,7 @@ impl Descriptor {
keychain_kind: KeychainKind, keychain_kind: KeychainKind,
network: Network, network: Network,
) -> Self { ) -> Self {
let derivable_key = &secret_key.0; let derivable_key = &secret_key.inner;
match derivable_key { match derivable_key {
BdkDescriptorSecretKey::Single(_) => { BdkDescriptorSecretKey::Single(_) => {
@@ -65,7 +65,7 @@ impl Descriptor {
network: Network, network: Network,
) -> Self { ) -> Self {
let fingerprint = Fingerprint::from_str(fingerprint.as_str()).unwrap(); let fingerprint = Fingerprint::from_str(fingerprint.as_str()).unwrap();
let derivable_key = &public_key.0; let derivable_key = &public_key.inner;
match derivable_key { match derivable_key {
BdkDescriptorPublicKey::Single(_) => { BdkDescriptorPublicKey::Single(_) => {
@@ -94,7 +94,7 @@ impl Descriptor {
keychain_kind: KeychainKind, keychain_kind: KeychainKind,
network: Network, network: Network,
) -> Self { ) -> Self {
let derivable_key = &secret_key.0; let derivable_key = &secret_key.inner;
match derivable_key { match derivable_key {
BdkDescriptorSecretKey::Single(_) => { BdkDescriptorSecretKey::Single(_) => {
@@ -122,7 +122,7 @@ impl Descriptor {
network: Network, network: Network,
) -> Self { ) -> Self {
let fingerprint = Fingerprint::from_str(fingerprint.as_str()).unwrap(); let fingerprint = Fingerprint::from_str(fingerprint.as_str()).unwrap();
let derivable_key = &public_key.0; let derivable_key = &public_key.inner;
match derivable_key { match derivable_key {
BdkDescriptorPublicKey::Single(_) => { BdkDescriptorPublicKey::Single(_) => {
@@ -151,7 +151,7 @@ impl Descriptor {
keychain_kind: KeychainKind, keychain_kind: KeychainKind,
network: Network, network: Network,
) -> Self { ) -> Self {
let derivable_key = &secret_key.0; let derivable_key = &secret_key.inner;
match derivable_key { match derivable_key {
BdkDescriptorSecretKey::Single(_) => { BdkDescriptorSecretKey::Single(_) => {
@@ -179,7 +179,7 @@ impl Descriptor {
network: Network, network: Network,
) -> Self { ) -> Self {
let fingerprint = Fingerprint::from_str(fingerprint.as_str()).unwrap(); let fingerprint = Fingerprint::from_str(fingerprint.as_str()).unwrap();
let derivable_key = &public_key.0; let derivable_key = &public_key.inner;
match derivable_key { match derivable_key {
BdkDescriptorPublicKey::Single(_) => { BdkDescriptorPublicKey::Single(_) => {
@@ -208,7 +208,7 @@ impl Descriptor {
keychain_kind: KeychainKind, keychain_kind: KeychainKind,
network: Network, network: Network,
) -> Self { ) -> Self {
let derivable_key = &secret_key.0; let derivable_key = &secret_key.inner;
match derivable_key { match derivable_key {
BdkDescriptorSecretKey::Single(_) => { BdkDescriptorSecretKey::Single(_) => {
@@ -236,7 +236,7 @@ impl Descriptor {
network: Network, network: Network,
) -> Self { ) -> Self {
let fingerprint = Fingerprint::from_str(fingerprint.as_str()).unwrap(); let fingerprint = Fingerprint::from_str(fingerprint.as_str()).unwrap();
let derivable_key = &public_key.0; let derivable_key = &public_key.inner;
match derivable_key { match derivable_key {
BdkDescriptorPublicKey::Single(_) => { BdkDescriptorPublicKey::Single(_) => {
@@ -276,6 +276,8 @@ mod test {
use crate::*; use crate::*;
use assert_matches::assert_matches; use assert_matches::assert_matches;
use crate::Alpha3Error;
fn get_descriptor_secret_key() -> DescriptorSecretKey { fn get_descriptor_secret_key() -> 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(); 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, &mnemonic, None) DescriptorSecretKey::new(Network::Testnet, &mnemonic, None)
@@ -390,8 +392,8 @@ mod test {
fn test_descriptor_from_string() { fn test_descriptor_from_string() {
let descriptor1 = Descriptor::new("wpkh(tprv8hwWMmPE4BVNxGdVt3HhEERZhondQvodUY7Ajyseyhudr4WabJqWKWLr4Wi2r26CDaNCQhhxEftEaNzz7dPGhWuKFU4VULesmhEfZYyBXdE/0/*)".to_string(), Network::Testnet); let descriptor1 = Descriptor::new("wpkh(tprv8hwWMmPE4BVNxGdVt3HhEERZhondQvodUY7Ajyseyhudr4WabJqWKWLr4Wi2r26CDaNCQhhxEftEaNzz7dPGhWuKFU4VULesmhEfZYyBXdE/0/*)".to_string(), Network::Testnet);
let descriptor2 = Descriptor::new("wpkh(tprv8hwWMmPE4BVNxGdVt3HhEERZhondQvodUY7Ajyseyhudr4WabJqWKWLr4Wi2r26CDaNCQhhxEftEaNzz7dPGhWuKFU4VULesmhEfZYyBXdE/0/*)".to_string(), Network::Bitcoin); let descriptor2 = Descriptor::new("wpkh(tprv8hwWMmPE4BVNxGdVt3HhEERZhondQvodUY7Ajyseyhudr4WabJqWKWLr4Wi2r26CDaNCQhhxEftEaNzz7dPGhWuKFU4VULesmhEfZYyBXdE/0/*)".to_string(), Network::Bitcoin);
// Creating a Descriptor using an extended key that doesn't match the network provided will throw a DescriptorError::Key with inner InvalidNetwork error // Creating a Descriptor using an extended key that doesn't match the network provided will throw and InvalidNetwork Error
assert!(descriptor1.is_ok()); assert!(descriptor1.is_ok());
assert_matches!(descriptor2.unwrap_err(), DescriptorError::Key { .. }); assert_matches!(descriptor2.unwrap_err(), Alpha3Error::Generic)
} }
} }

File diff suppressed because it is too large Load Diff

View File

@@ -1,83 +1,63 @@
use crate::bitcoin::Transaction; use crate::error::{Alpha3Error, EsploraError};
use crate::error::EsploraError; use crate::wallet::{Update, Wallet};
use crate::types::{FullScanRequest, SyncRequest};
use crate::wallet::Update;
use std::collections::BTreeMap;
use bdk::bitcoin::Transaction as BdkTransaction; use bdk::bitcoin::Transaction as BdkTransaction;
use bdk::chain::spk_client::FullScanRequest as BdkFullScanRequest; use bdk::wallet::Update as BdkUpdate;
use bdk::chain::spk_client::FullScanResult as BdkFullScanResult;
use bdk::chain::spk_client::SyncRequest as BdkSyncRequest;
use bdk::chain::spk_client::SyncResult as BdkSyncResult;
use bdk::KeychainKind;
use bdk_esplora::esplora_client::{BlockingClient, Builder}; use bdk_esplora::esplora_client::{BlockingClient, Builder};
use bdk_esplora::EsploraExt; use bdk_esplora::EsploraExt;
use crate::bitcoin::Transaction;
use std::sync::Arc; use std::sync::Arc;
pub struct EsploraClient(BlockingClient); pub struct EsploraClient(BlockingClient);
impl EsploraClient { impl EsploraClient {
pub fn new(url: String) -> Self { pub fn new(url: String) -> Self {
let client = Builder::new(url.as_str()).build_blocking(); let client = Builder::new(url.as_str()).build_blocking().unwrap();
Self(client) Self(client)
} }
// This is a temporary solution for scanning. The long-term solution involves not passing
// the wallet to the client at all.
pub fn full_scan( pub fn full_scan(
&self, &self,
request: Arc<FullScanRequest>, wallet: Arc<Wallet>,
stop_gap: u64, stop_gap: u64,
parallel_requests: u64, parallel_requests: u64,
) -> Result<Arc<Update>, EsploraError> { ) -> Result<Arc<Update>, EsploraError> {
// using option and take is not ideal but the only way to take full ownership of the request let wallet = wallet.get_wallet();
let request: BdkFullScanRequest<KeychainKind> = request
let previous_tip = wallet.latest_checkpoint();
let keychain_spks = wallet.all_unbounded_spk_iters().into_iter().collect();
let (update_graph, last_active_indices) = self
.0 .0
.lock() .full_scan(keychain_spks, stop_gap as usize, parallel_requests as usize)
.unwrap() .map_err(|e| EsploraError::from(*e))?;
.take()
.ok_or(EsploraError::RequestAlreadyConsumed)?;
let result: BdkFullScanResult<KeychainKind> = let missing_heights = update_graph.missing_heights(wallet.local_chain());
self.0 let chain_update = self
.full_scan(request, stop_gap as usize, parallel_requests as usize)?; .0
.update_local_chain(previous_tip, missing_heights)
.map_err(|e| EsploraError::from(*e))?;
let update = bdk::wallet::Update { let update = BdkUpdate {
last_active_indices: result.last_active_indices, last_active_indices,
graph: result.graph_update, graph: update_graph,
chain: Some(result.chain_update), chain: Some(chain_update),
}; };
Ok(Arc::new(Update(update))) Ok(Arc::new(Update(update)))
} }
pub fn sync( // pub fn sync();
&self,
request: Arc<SyncRequest>,
parallel_requests: u64,
) -> Result<Arc<Update>, EsploraError> {
// using option and take is not ideal but the only way to take full ownership of the request
let request: BdkSyncRequest = request
.0
.lock()
.unwrap()
.take()
.ok_or(EsploraError::RequestAlreadyConsumed)?;
let result: BdkSyncResult = self.0.sync(request, parallel_requests as usize)?; pub fn broadcast(&self, transaction: &Transaction) -> Result<(), Alpha3Error> {
let update = bdk::wallet::Update {
last_active_indices: BTreeMap::default(),
graph: result.graph_update,
chain: Some(result.chain_update),
};
Ok(Arc::new(Update(update)))
}
pub fn broadcast(&self, transaction: &Transaction) -> Result<(), EsploraError> {
let bdk_transaction: BdkTransaction = transaction.into(); let bdk_transaction: BdkTransaction = transaction.into();
self.0 self.0
.broadcast(&bdk_transaction) .broadcast(&bdk_transaction)
.map_err(EsploraError::from) .map_err(|_| Alpha3Error::Generic)
} }
// pub fn estimate_fee();
} }

View File

@@ -1,4 +1,4 @@
use crate::error::{Bip32Error, Bip39Error, DescriptorKeyError}; use crate::error::Alpha3Error;
use bdk::bitcoin::bip32::DerivationPath as BdkDerivationPath; use bdk::bitcoin::bip32::DerivationPath as BdkDerivationPath;
use bdk::bitcoin::key::Secp256k1; use bdk::bitcoin::key::Secp256k1;
@@ -18,7 +18,9 @@ use std::ops::Deref;
use std::str::FromStr; use std::str::FromStr;
use std::sync::{Arc, Mutex}; use std::sync::{Arc, Mutex};
pub(crate) struct Mnemonic(pub(crate) BdkMnemonic); pub(crate) struct Mnemonic {
inner: BdkMnemonic,
}
impl Mnemonic { impl Mnemonic {
pub(crate) fn new(word_count: WordCount) -> Self { pub(crate) fn new(word_count: WordCount) -> Self {
@@ -30,23 +32,23 @@ impl Mnemonic {
let generated_key: GeneratedKey<_, BareCtx> = let generated_key: GeneratedKey<_, BareCtx> =
BdkMnemonic::generate_with_entropy((word_count, Language::English), entropy).unwrap(); BdkMnemonic::generate_with_entropy((word_count, Language::English), entropy).unwrap();
let mnemonic = BdkMnemonic::parse_in(Language::English, generated_key.to_string()).unwrap(); let mnemonic = BdkMnemonic::parse_in(Language::English, generated_key.to_string()).unwrap();
Mnemonic(mnemonic) Mnemonic { inner: mnemonic }
} }
pub(crate) fn from_string(mnemonic: String) -> Result<Self, Bip39Error> { pub(crate) fn from_string(mnemonic: String) -> Result<Self, Alpha3Error> {
BdkMnemonic::from_str(&mnemonic) BdkMnemonic::from_str(&mnemonic)
.map(Mnemonic) .map(|m| Mnemonic { inner: m })
.map_err(Bip39Error::from) .map_err(|_| Alpha3Error::Generic)
} }
pub(crate) fn from_entropy(entropy: Vec<u8>) -> Result<Self, Bip39Error> { pub(crate) fn from_entropy(entropy: Vec<u8>) -> Result<Self, Alpha3Error> {
BdkMnemonic::from_entropy(entropy.as_slice()) BdkMnemonic::from_entropy(entropy.as_slice())
.map(Mnemonic) .map(|m| Mnemonic { inner: m })
.map_err(Bip39Error::from) .map_err(|_| Alpha3Error::Generic)
} }
pub(crate) fn as_string(&self) -> String { pub(crate) fn as_string(&self) -> String {
self.0.to_string() self.inner.to_string()
} }
} }
@@ -55,21 +57,23 @@ pub(crate) struct DerivationPath {
} }
impl DerivationPath { impl DerivationPath {
pub(crate) fn new(path: String) -> Result<Self, Bip32Error> { pub(crate) fn new(path: String) -> Result<Self, Alpha3Error> {
BdkDerivationPath::from_str(&path) BdkDerivationPath::from_str(&path)
.map(|x| DerivationPath { .map(|x| DerivationPath {
inner_mutex: Mutex::new(x), inner_mutex: Mutex::new(x),
}) })
.map_err(Bip32Error::from) .map_err(|_| Alpha3Error::Generic)
} }
} }
#[derive(Debug)] #[derive(Debug)]
pub struct DescriptorSecretKey(pub(crate) BdkDescriptorSecretKey); pub struct DescriptorSecretKey {
pub(crate) inner: BdkDescriptorSecretKey,
}
impl DescriptorSecretKey { impl DescriptorSecretKey {
pub(crate) fn new(network: Network, mnemonic: &Mnemonic, password: Option<String>) -> Self { pub(crate) fn new(network: Network, mnemonic: &Mnemonic, password: Option<String>) -> Self {
let mnemonic = mnemonic.0.clone(); let mnemonic = mnemonic.inner.clone();
let xkey: ExtendedKey = (mnemonic, password).into_extended_key().unwrap(); let xkey: ExtendedKey = (mnemonic, password).into_extended_key().unwrap();
let descriptor_secret_key = BdkDescriptorSecretKey::XPrv(DescriptorXKey { let descriptor_secret_key = BdkDescriptorSecretKey::XPrv(DescriptorXKey {
origin: None, origin: None,
@@ -77,26 +81,27 @@ impl DescriptorSecretKey {
derivation_path: BdkDerivationPath::master(), derivation_path: BdkDerivationPath::master(),
wildcard: Wildcard::Unhardened, wildcard: Wildcard::Unhardened,
}); });
Self(descriptor_secret_key) Self {
inner: descriptor_secret_key,
}
} }
pub(crate) fn from_string(private_key: String) -> Result<Self, DescriptorKeyError> { pub(crate) fn from_string(private_key: String) -> Result<Self, Alpha3Error> {
let descriptor_secret_key = BdkDescriptorSecretKey::from_str(private_key.as_str()) let descriptor_secret_key = BdkDescriptorSecretKey::from_str(private_key.as_str())
.map_err(DescriptorKeyError::from)?; .map_err(|_| Alpha3Error::Generic)?;
Ok(Self(descriptor_secret_key)) Ok(Self {
inner: descriptor_secret_key,
})
} }
pub(crate) fn derive(&self, path: &DerivationPath) -> Result<Arc<Self>, DescriptorKeyError> { pub(crate) fn derive(&self, path: &DerivationPath) -> Result<Arc<Self>, Alpha3Error> {
let secp = Secp256k1::new(); let secp = Secp256k1::new();
let descriptor_secret_key = &self.0; let descriptor_secret_key = &self.inner;
let path = path.inner_mutex.lock().unwrap().deref().clone(); let path = path.inner_mutex.lock().unwrap().deref().clone();
match descriptor_secret_key { match descriptor_secret_key {
BdkDescriptorSecretKey::Single(_) => Err(DescriptorKeyError::InvalidKeyType), BdkDescriptorSecretKey::Single(_) => Err(Alpha3Error::Generic),
BdkDescriptorSecretKey::XPrv(descriptor_x_key) => { BdkDescriptorSecretKey::XPrv(descriptor_x_key) => {
let derived_xprv = descriptor_x_key let derived_xprv = descriptor_x_key.xkey.derive_priv(&secp, &path)?;
.xkey
.derive_priv(&secp, &path)
.map_err(DescriptorKeyError::from)?;
let key_source = match descriptor_x_key.origin.clone() { let key_source = match descriptor_x_key.origin.clone() {
Some((fingerprint, origin_path)) => (fingerprint, origin_path.extend(path)), Some((fingerprint, origin_path)) => (fingerprint, origin_path.extend(path)),
None => (descriptor_x_key.xkey.fingerprint(&secp), path), None => (descriptor_x_key.xkey.fingerprint(&secp), path),
@@ -107,17 +112,19 @@ impl DescriptorSecretKey {
derivation_path: BdkDerivationPath::default(), derivation_path: BdkDerivationPath::default(),
wildcard: descriptor_x_key.wildcard, wildcard: descriptor_x_key.wildcard,
}); });
Ok(Arc::new(Self(derived_descriptor_secret_key))) Ok(Arc::new(Self {
inner: derived_descriptor_secret_key,
}))
} }
BdkDescriptorSecretKey::MultiXPrv(_) => Err(DescriptorKeyError::InvalidKeyType), BdkDescriptorSecretKey::MultiXPrv(_) => Err(Alpha3Error::Generic),
} }
} }
pub(crate) fn extend(&self, path: &DerivationPath) -> Result<Arc<Self>, DescriptorKeyError> { pub(crate) fn extend(&self, path: &DerivationPath) -> Result<Arc<Self>, Alpha3Error> {
let descriptor_secret_key = &self.0; let descriptor_secret_key = &self.inner;
let path = path.inner_mutex.lock().unwrap().deref().clone(); let path = path.inner_mutex.lock().unwrap().deref().clone();
match descriptor_secret_key { match descriptor_secret_key {
BdkDescriptorSecretKey::Single(_) => Err(DescriptorKeyError::InvalidKeyType), BdkDescriptorSecretKey::Single(_) => Err(Alpha3Error::Generic),
BdkDescriptorSecretKey::XPrv(descriptor_x_key) => { BdkDescriptorSecretKey::XPrv(descriptor_x_key) => {
let extended_path = descriptor_x_key.derivation_path.extend(path); let extended_path = descriptor_x_key.derivation_path.extend(path);
let extended_descriptor_secret_key = BdkDescriptorSecretKey::XPrv(DescriptorXKey { let extended_descriptor_secret_key = BdkDescriptorSecretKey::XPrv(DescriptorXKey {
@@ -126,20 +133,24 @@ impl DescriptorSecretKey {
derivation_path: extended_path, derivation_path: extended_path,
wildcard: descriptor_x_key.wildcard, wildcard: descriptor_x_key.wildcard,
}); });
Ok(Arc::new(Self(extended_descriptor_secret_key))) Ok(Arc::new(Self {
inner: extended_descriptor_secret_key,
}))
} }
BdkDescriptorSecretKey::MultiXPrv(_) => Err(DescriptorKeyError::InvalidKeyType), BdkDescriptorSecretKey::MultiXPrv(_) => Err(Alpha3Error::Generic),
} }
} }
pub(crate) fn as_public(&self) -> Arc<DescriptorPublicKey> { pub(crate) fn as_public(&self) -> Arc<DescriptorPublicKey> {
let secp = Secp256k1::new(); let secp = Secp256k1::new();
let descriptor_public_key = self.0.to_public(&secp).unwrap(); let descriptor_public_key = self.inner.to_public(&secp).unwrap();
Arc::new(DescriptorPublicKey(descriptor_public_key)) Arc::new(DescriptorPublicKey {
inner: descriptor_public_key,
})
} }
pub(crate) fn secret_bytes(&self) -> Vec<u8> { pub(crate) fn secret_bytes(&self) -> Vec<u8> {
let inner = &self.0; let inner = &self.inner;
let secret_bytes: Vec<u8> = match inner { let secret_bytes: Vec<u8> = match inner {
BdkDescriptorSecretKey::Single(_) => { BdkDescriptorSecretKey::Single(_) => {
unreachable!() unreachable!()
@@ -156,32 +167,33 @@ impl DescriptorSecretKey {
} }
pub(crate) fn as_string(&self) -> String { pub(crate) fn as_string(&self) -> String {
self.0.to_string() self.inner.to_string()
} }
} }
#[derive(Debug)] #[derive(Debug)]
pub struct DescriptorPublicKey(pub(crate) BdkDescriptorPublicKey); pub struct DescriptorPublicKey {
pub(crate) inner: BdkDescriptorPublicKey,
}
impl DescriptorPublicKey { impl DescriptorPublicKey {
pub(crate) fn from_string(public_key: String) -> Result<Self, DescriptorKeyError> { pub(crate) fn from_string(public_key: String) -> Result<Self, Alpha3Error> {
let descriptor_public_key = BdkDescriptorPublicKey::from_str(public_key.as_str()) let descriptor_public_key = BdkDescriptorPublicKey::from_str(public_key.as_str())
.map_err(DescriptorKeyError::from)?; .map_err(|_| Alpha3Error::Generic)?;
Ok(Self(descriptor_public_key)) Ok(Self {
inner: descriptor_public_key,
})
} }
pub(crate) fn derive(&self, path: &DerivationPath) -> Result<Arc<Self>, DescriptorKeyError> { pub(crate) fn derive(&self, path: &DerivationPath) -> Result<Arc<Self>, Alpha3Error> {
let secp = Secp256k1::new(); let secp = Secp256k1::new();
let descriptor_public_key = &self.0; let descriptor_public_key = &self.inner;
let path = path.inner_mutex.lock().unwrap().deref().clone(); let path = path.inner_mutex.lock().unwrap().deref().clone();
match descriptor_public_key { match descriptor_public_key {
BdkDescriptorPublicKey::Single(_) => Err(DescriptorKeyError::InvalidKeyType), BdkDescriptorPublicKey::Single(_) => Err(Alpha3Error::Generic),
BdkDescriptorPublicKey::XPub(descriptor_x_key) => { BdkDescriptorPublicKey::XPub(descriptor_x_key) => {
let derived_xpub = descriptor_x_key let derived_xpub = descriptor_x_key.xkey.derive_pub(&secp, &path)?;
.xkey
.derive_pub(&secp, &path)
.map_err(DescriptorKeyError::from)?;
let key_source = match descriptor_x_key.origin.clone() { let key_source = match descriptor_x_key.origin.clone() {
Some((fingerprint, origin_path)) => (fingerprint, origin_path.extend(path)), Some((fingerprint, origin_path)) => (fingerprint, origin_path.extend(path)),
None => (descriptor_x_key.xkey.fingerprint(), path), None => (descriptor_x_key.xkey.fingerprint(), path),
@@ -192,17 +204,19 @@ impl DescriptorPublicKey {
derivation_path: BdkDerivationPath::default(), derivation_path: BdkDerivationPath::default(),
wildcard: descriptor_x_key.wildcard, wildcard: descriptor_x_key.wildcard,
}); });
Ok(Arc::new(Self(derived_descriptor_public_key))) Ok(Arc::new(Self {
inner: derived_descriptor_public_key,
}))
} }
BdkDescriptorPublicKey::MultiXPub(_) => Err(DescriptorKeyError::InvalidKeyType), BdkDescriptorPublicKey::MultiXPub(_) => Err(Alpha3Error::Generic),
} }
} }
pub(crate) fn extend(&self, path: &DerivationPath) -> Result<Arc<Self>, DescriptorKeyError> { pub(crate) fn extend(&self, path: &DerivationPath) -> Result<Arc<Self>, Alpha3Error> {
let descriptor_public_key = &self.0; let descriptor_public_key = &self.inner;
let path = path.inner_mutex.lock().unwrap().deref().clone(); let path = path.inner_mutex.lock().unwrap().deref().clone();
match descriptor_public_key { match descriptor_public_key {
BdkDescriptorPublicKey::Single(_) => Err(DescriptorKeyError::InvalidKeyType), BdkDescriptorPublicKey::Single(_) => Err(Alpha3Error::Generic),
BdkDescriptorPublicKey::XPub(descriptor_x_key) => { BdkDescriptorPublicKey::XPub(descriptor_x_key) => {
let extended_path = descriptor_x_key.derivation_path.extend(path); let extended_path = descriptor_x_key.derivation_path.extend(path);
let extended_descriptor_public_key = BdkDescriptorPublicKey::XPub(DescriptorXKey { let extended_descriptor_public_key = BdkDescriptorPublicKey::XPub(DescriptorXKey {
@@ -211,14 +225,16 @@ impl DescriptorPublicKey {
derivation_path: extended_path, derivation_path: extended_path,
wildcard: descriptor_x_key.wildcard, wildcard: descriptor_x_key.wildcard,
}); });
Ok(Arc::new(Self(extended_descriptor_public_key))) Ok(Arc::new(Self {
inner: extended_descriptor_public_key,
}))
} }
BdkDescriptorPublicKey::MultiXPub(_) => Err(DescriptorKeyError::InvalidKeyType), BdkDescriptorPublicKey::MultiXPub(_) => Err(Alpha3Error::Generic),
} }
} }
pub(crate) fn as_string(&self) -> String { pub(crate) fn as_string(&self) -> String {
self.0.to_string() self.inner.to_string()
} }
} }
@@ -226,7 +242,7 @@ impl DescriptorPublicKey {
mod test { mod test {
use crate::keys::{DerivationPath, DescriptorPublicKey, DescriptorSecretKey, Mnemonic}; use crate::keys::{DerivationPath, DescriptorPublicKey, DescriptorSecretKey, Mnemonic};
// use bdk::bitcoin::hashes::hex::ToHex; // use bdk::bitcoin::hashes::hex::ToHex;
use crate::error::DescriptorKeyError; use crate::error::Alpha3Error;
use bdk::bitcoin::Network; use bdk::bitcoin::Network;
use std::sync::Arc; use std::sync::Arc;
@@ -238,7 +254,7 @@ mod test {
fn derive_dsk( fn derive_dsk(
key: &DescriptorSecretKey, key: &DescriptorSecretKey,
path: &str, path: &str,
) -> Result<Arc<DescriptorSecretKey>, DescriptorKeyError> { ) -> Result<Arc<DescriptorSecretKey>, Alpha3Error> {
let path = DerivationPath::new(path.to_string()).unwrap(); let path = DerivationPath::new(path.to_string()).unwrap();
key.derive(&path) key.derive(&path)
} }
@@ -246,7 +262,7 @@ mod test {
fn extend_dsk( fn extend_dsk(
key: &DescriptorSecretKey, key: &DescriptorSecretKey,
path: &str, path: &str,
) -> Result<Arc<DescriptorSecretKey>, DescriptorKeyError> { ) -> Result<Arc<DescriptorSecretKey>, Alpha3Error> {
let path = DerivationPath::new(path.to_string()).unwrap(); let path = DerivationPath::new(path.to_string()).unwrap();
key.extend(&path) key.extend(&path)
} }
@@ -254,7 +270,7 @@ mod test {
fn derive_dpk( fn derive_dpk(
key: &DescriptorPublicKey, key: &DescriptorPublicKey,
path: &str, path: &str,
) -> Result<Arc<DescriptorPublicKey>, DescriptorKeyError> { ) -> Result<Arc<DescriptorPublicKey>, Alpha3Error> {
let path = DerivationPath::new(path.to_string()).unwrap(); let path = DerivationPath::new(path.to_string()).unwrap();
key.derive(&path) key.derive(&path)
} }
@@ -262,7 +278,7 @@ mod test {
fn extend_dpk( fn extend_dpk(
key: &DescriptorPublicKey, key: &DescriptorPublicKey,
path: &str, path: &str,
) -> Result<Arc<DescriptorPublicKey>, DescriptorKeyError> { ) -> Result<Arc<DescriptorPublicKey>, Alpha3Error> {
let path = DerivationPath::new(path.to_string()).unwrap(); let path = DerivationPath::new(path.to_string()).unwrap();
key.extend(&path) key.extend(&path)
} }

View File

@@ -7,52 +7,38 @@ mod types;
mod wallet; mod wallet;
use crate::bitcoin::Address; use crate::bitcoin::Address;
use crate::bitcoin::FeeRate;
use crate::bitcoin::OutPoint; use crate::bitcoin::OutPoint;
use crate::bitcoin::Psbt; use crate::bitcoin::PartiallySignedTransaction;
use crate::bitcoin::Script; use crate::bitcoin::Script;
use crate::bitcoin::Transaction; use crate::bitcoin::Transaction;
use crate::bitcoin::TxOut; use crate::bitcoin::TxOut;
use crate::descriptor::Descriptor; use crate::descriptor::Descriptor;
use crate::error::AddressError; use crate::error::Alpha3Error;
use crate::error::Bip32Error;
use crate::error::Bip39Error;
use crate::error::CalculateFeeError; use crate::error::CalculateFeeError;
use crate::error::CannotConnectError;
use crate::error::CreateTxError;
use crate::error::DescriptorError;
use crate::error::DescriptorKeyError;
use crate::error::EsploraError; use crate::error::EsploraError;
use crate::error::ExtractTxError;
use crate::error::FeeRateError;
use crate::error::PersistenceError;
use crate::error::PsbtParseError;
use crate::error::SignerError;
use crate::error::TransactionError;
use crate::error::TxidParseError;
use crate::error::WalletCreationError;
use crate::esplora::EsploraClient; use crate::esplora::EsploraClient;
use crate::keys::DerivationPath; use crate::keys::DerivationPath;
use crate::keys::DescriptorPublicKey; use crate::keys::DescriptorPublicKey;
use crate::keys::DescriptorSecretKey; use crate::keys::DescriptorSecretKey;
use crate::keys::Mnemonic; use crate::keys::Mnemonic;
use crate::types::AddressIndex;
use crate::types::AddressInfo; use crate::types::AddressInfo;
use crate::types::Balance; use crate::types::Balance;
use crate::types::CanonicalTx; use crate::types::FeeRate;
use crate::types::ChainPosition;
use crate::types::FullScanRequest;
use crate::types::LocalOutput; use crate::types::LocalOutput;
use crate::types::ScriptAmount; use crate::types::ScriptAmount;
use crate::types::SyncRequest;
use crate::wallet::BumpFeeTxBuilder; use crate::wallet::BumpFeeTxBuilder;
use crate::wallet::SentAndReceivedValues; use crate::wallet::SentAndReceivedValues;
use crate::wallet::TxBuilder; use crate::wallet::TxBuilder;
use crate::wallet::Update; use crate::wallet::Update;
use crate::wallet::Wallet; use crate::wallet::Wallet;
use crate::error::WalletCreationError;
use bdk::bitcoin::Network; use bdk::bitcoin::Network;
use bdk::keys::bip39::WordCount; use bdk::keys::bip39::WordCount;
use bdk::wallet::tx_builder::ChangeSpendPolicy; use bdk::wallet::tx_builder::ChangeSpendPolicy;
use bdk::KeychainKind; use bdk::KeychainKind;
uniffi::include_scaffolding!("bdk"); uniffi::include_scaffolding!("bdk");
// TODO: TxIn, Payload

View File

@@ -1,45 +1,34 @@
use crate::bitcoin::{Address, OutPoint, Script, Transaction, TxOut}; use crate::bitcoin::{Address, OutPoint, Script, TxOut};
use bdk::chain::spk_client::FullScanRequest as BdkFullScanRequest; use bdk::wallet::AddressIndex as BdkAddressIndex;
use bdk::chain::spk_client::SyncRequest as BdkSyncRequest;
use bdk::chain::tx_graph::CanonicalTx as BdkCanonicalTx;
use bdk::chain::{ChainPosition as BdkChainPosition, ConfirmationTimeHeightAnchor};
use bdk::wallet::AddressInfo as BdkAddressInfo; use bdk::wallet::AddressInfo as BdkAddressInfo;
use bdk::wallet::Balance as BdkBalance; use bdk::wallet::Balance as BdkBalance;
use bdk::KeychainKind; use bdk::KeychainKind;
use bdk::LocalOutput as BdkLocalOutput; use bdk::LocalOutput as BdkLocalOutput;
use std::sync::{Arc, Mutex}; use bdk::FeeRate as BdkFeeRate;
#[derive(Debug, Clone, PartialEq, Eq)] use std::sync::Arc;
pub enum ChainPosition {
Confirmed { height: u32, timestamp: u64 },
Unconfirmed { timestamp: u64 },
}
pub struct CanonicalTx { #[derive(Clone, Debug)]
pub transaction: Arc<Transaction>, pub struct FeeRate(pub BdkFeeRate);
pub chain_position: ChainPosition,
}
impl From<BdkCanonicalTx<'_, Arc<bdk::bitcoin::Transaction>, ConfirmationTimeHeightAnchor>> impl FeeRate {
for CanonicalTx pub fn from_sat_per_vb(sat_per_vb: f32) -> Self {
{ FeeRate(BdkFeeRate::from_sat_per_vb(sat_per_vb))
fn from( }
tx: BdkCanonicalTx<'_, Arc<bdk::bitcoin::Transaction>, ConfirmationTimeHeightAnchor>,
) -> Self {
let chain_position = match tx.chain_position {
BdkChainPosition::Confirmed(anchor) => ChainPosition::Confirmed {
height: anchor.confirmation_height,
timestamp: anchor.confirmation_time,
},
BdkChainPosition::Unconfirmed(timestamp) => ChainPosition::Unconfirmed { timestamp },
};
CanonicalTx { pub fn from_sat_per_kwu(sat_per_kwu: f32) -> Self {
transaction: Arc::new(Transaction::from(tx.tx_node.tx.as_ref().clone())), FeeRate(BdkFeeRate::from_sat_per_kwu(sat_per_kwu))
chain_position, }
}
pub fn as_sat_per_vb(&self) -> f32 {
self.0.as_sat_per_vb()
}
pub fn sat_per_kwu(&self) -> f32 {
self.0.sat_per_kwu()
} }
} }
@@ -64,6 +53,53 @@ impl From<BdkAddressInfo> for AddressInfo {
} }
} }
pub enum AddressIndex {
New,
LastUnused,
Peek { index: u32 },
}
impl From<AddressIndex> for BdkAddressIndex {
fn from(address_index: AddressIndex) -> Self {
match address_index {
AddressIndex::New => BdkAddressIndex::New,
AddressIndex::LastUnused => BdkAddressIndex::LastUnused,
AddressIndex::Peek { index } => BdkAddressIndex::Peek(index),
}
}
}
impl From<BdkAddressIndex> for AddressIndex {
fn from(address_index: BdkAddressIndex) -> Self {
match address_index {
BdkAddressIndex::New => AddressIndex::New,
BdkAddressIndex::LastUnused => AddressIndex::LastUnused,
_ => panic!("Mmmm not working"),
}
}
}
// TODO 9: Peek is not correctly implemented
impl From<&AddressIndex> for BdkAddressIndex {
fn from(address_index: &AddressIndex) -> Self {
match address_index {
AddressIndex::New => BdkAddressIndex::New,
AddressIndex::LastUnused => BdkAddressIndex::LastUnused,
AddressIndex::Peek { index } => BdkAddressIndex::Peek(*index),
}
}
}
impl From<&BdkAddressIndex> for AddressIndex {
fn from(address_index: &BdkAddressIndex) -> Self {
match address_index {
BdkAddressIndex::New => AddressIndex::New,
BdkAddressIndex::LastUnused => AddressIndex::LastUnused,
_ => panic!("Mmmm not working"),
}
}
}
pub struct Balance { pub struct Balance {
pub immature: u64, pub immature: u64,
pub trusted_pending: u64, pub trusted_pending: u64,
@@ -101,7 +137,7 @@ impl From<BdkLocalOutput> for LocalOutput {
vout: local_utxo.outpoint.vout, vout: local_utxo.outpoint.vout,
}, },
txout: TxOut { txout: TxOut {
value: local_utxo.txout.value.to_sat(), value: local_utxo.txout.value,
script_pubkey: Arc::new(Script(local_utxo.txout.script_pubkey)), script_pubkey: Arc::new(Script(local_utxo.txout.script_pubkey)),
}, },
keychain: local_utxo.keychain, keychain: local_utxo.keychain,
@@ -109,7 +145,3 @@ impl From<BdkLocalOutput> for LocalOutput {
} }
} }
} }
pub struct FullScanRequest(pub(crate) Mutex<Option<BdkFullScanRequest<KeychainKind>>>);
pub struct SyncRequest(pub(crate) Mutex<Option<BdkSyncRequest>>);

View File

@@ -1,21 +1,19 @@
use crate::bitcoin::{FeeRate, OutPoint, Psbt, Script, Transaction}; use crate::bitcoin::{OutPoint, PartiallySignedTransaction, Transaction};
use crate::descriptor::Descriptor; use crate::descriptor::Descriptor;
use crate::error::{ use crate::error::{Alpha3Error, CalculateFeeError, WalletCreationError};
CalculateFeeError, CannotConnectError, CreateTxError, PersistenceError, SignerError, use crate::types::ScriptAmount;
TxidParseError, WalletCreationError, use crate::types::{Balance, FeeRate};
}; use crate::Script;
use crate::types::{ use crate::{AddressIndex, AddressInfo};
AddressInfo, Balance, CanonicalTx, FullScanRequest, LocalOutput, ScriptAmount, SyncRequest,
};
use bdk::bitcoin::blockdata::script::ScriptBuf as BdkScriptBuf; use bdk::bitcoin::blockdata::script::ScriptBuf as BdkScriptBuf;
use bdk::bitcoin::psbt::PartiallySignedTransaction as BdkPartiallySignedTransaction;
use bdk::bitcoin::Network; use bdk::bitcoin::Network;
use bdk::bitcoin::Psbt as BdkPsbt;
use bdk::bitcoin::{OutPoint as BdkOutPoint, Sequence, Txid}; use bdk::bitcoin::{OutPoint as BdkOutPoint, Sequence, Txid};
use bdk::wallet::tx_builder::ChangeSpendPolicy; use bdk::wallet::tx_builder::ChangeSpendPolicy;
use bdk::wallet::{ChangeSet, Update as BdkUpdate}; use bdk::wallet::{ChangeSet, Update as BdkUpdate};
use bdk::Wallet as BdkWallet; use bdk::Wallet as BdkWallet;
use bdk::{KeychainKind, SignOptions}; use bdk::{FeeRate as BdkFeeRate, SignOptions};
use bdk_file_store::Store; use bdk_file_store::Store;
use std::collections::HashSet; use std::collections::HashSet;
@@ -25,7 +23,7 @@ use std::sync::{Arc, Mutex, MutexGuard};
const MAGIC_BYTES: &[u8] = "bdkffi".as_bytes(); const MAGIC_BYTES: &[u8] = "bdkffi".as_bytes();
pub struct Wallet { pub struct Wallet {
inner_mutex: Mutex<BdkWallet>, inner_mutex: Mutex<BdkWallet<Store<ChangeSet>>>,
} }
impl Wallet { impl Wallet {
@@ -39,7 +37,7 @@ impl Wallet {
let change_descriptor = change_descriptor.map(|d| d.as_string_private()); let change_descriptor = change_descriptor.map(|d| d.as_string_private());
let db = Store::<ChangeSet>::open_or_create_new(MAGIC_BYTES, persistence_backend_path)?; let db = Store::<ChangeSet>::open_or_create_new(MAGIC_BYTES, persistence_backend_path)?;
let wallet: BdkWallet = let wallet: bdk::wallet::Wallet<Store<ChangeSet>> =
BdkWallet::new_or_load(&descriptor, change_descriptor.as_ref(), db, network)?; BdkWallet::new_or_load(&descriptor, change_descriptor.as_ref(), db, network)?;
Ok(Wallet { Ok(Wallet {
@@ -47,34 +45,35 @@ impl Wallet {
}) })
} }
pub(crate) fn get_wallet(&self) -> MutexGuard<BdkWallet> { pub(crate) fn get_wallet(&self) -> MutexGuard<BdkWallet<Store<ChangeSet>>> {
self.inner_mutex.lock().expect("wallet") self.inner_mutex.lock().expect("wallet")
} }
pub fn reveal_next_address( pub fn get_address(&self, address_index: AddressIndex) -> AddressInfo {
&self,
keychain_kind: KeychainKind,
) -> Result<AddressInfo, PersistenceError> {
self.get_wallet() self.get_wallet()
.reveal_next_address(keychain_kind) .try_get_address(address_index.into())
.map(|address_info| address_info.into()) .unwrap()
.map_err(|e| PersistenceError::Write { .into()
error_message: e.to_string(),
})
} }
pub fn apply_update(&self, update: Arc<Update>) -> Result<(), CannotConnectError> { pub fn apply_update(&self, update: Arc<Update>) -> Result<(), Alpha3Error> {
self.get_wallet() self.get_wallet()
.apply_update(update.0.clone()) .apply_update(update.0.clone())
.map_err(CannotConnectError::from) .map_err(|_| Alpha3Error::Generic)
} }
pub fn commit(&self) -> Result<bool, PersistenceError> { // TODO: This is the fallible version of get_internal_address; should I rename it to get_internal_address?
// It's a slight change of the API, the other option is to rename the get_address to try_get_address
pub fn try_get_internal_address(
&self,
address_index: AddressIndex,
) -> Result<AddressInfo, Alpha3Error> {
self.get_wallet() self.get_wallet()
.commit() .try_get_internal_address(address_index.into())
.map_err(|e| PersistenceError::Write { .map_or_else(
error_message: e.to_string(), |_| Err(Alpha3Error::Generic),
}) |address_info| Ok(address_info.into()),
)
} }
pub fn network(&self) -> Network { pub fn network(&self) -> Network {
@@ -92,13 +91,13 @@ impl Wallet {
pub(crate) fn sign( pub(crate) fn sign(
&self, &self,
psbt: Arc<Psbt>, psbt: Arc<PartiallySignedTransaction>,
// sign_options: Option<SignOptions>, // sign_options: Option<SignOptions>,
) -> Result<bool, SignerError> { ) -> Result<bool, Alpha3Error> {
let mut psbt = psbt.0.lock().unwrap(); let mut psbt = psbt.inner.lock().unwrap();
self.get_wallet() self.get_wallet()
.sign(&mut psbt, SignOptions::default()) .sign(&mut psbt, SignOptions::default())
.map_err(SignerError::from) .map_err(|_| Alpha3Error::Generic)
} }
pub fn sent_and_received(&self, tx: &Transaction) -> SentAndReceivedValues { pub fn sent_and_received(&self, tx: &Transaction) -> SentAndReceivedValues {
@@ -106,19 +105,13 @@ impl Wallet {
SentAndReceivedValues { sent, received } SentAndReceivedValues { sent, received }
} }
pub fn transactions(&self) -> Vec<CanonicalTx> { pub fn transactions(&self) -> Vec<Arc<Transaction>> {
self.get_wallet() self.get_wallet()
.transactions() .transactions()
.map(|tx| tx.into()) .map(|tx| Arc::new(tx.tx_node.tx.into()))
.collect() .collect()
} }
pub fn get_tx(&self, txid: String) -> Result<Option<CanonicalTx>, TxidParseError> {
let txid =
Txid::from_str(txid.as_str()).map_err(|_| TxidParseError::InvalidTxid { txid })?;
Ok(self.get_wallet().get_tx(txid).map(|tx| tx.into()))
}
pub fn calculate_fee(&self, tx: &Transaction) -> Result<u64, CalculateFeeError> { pub fn calculate_fee(&self, tx: &Transaction) -> Result<u64, CalculateFeeError> {
self.get_wallet() self.get_wallet()
.calculate_fee(&tx.into()) .calculate_fee(&tx.into())
@@ -131,24 +124,6 @@ impl Wallet {
.map(|bdk_fee_rate| Arc::new(FeeRate(bdk_fee_rate))) .map(|bdk_fee_rate| Arc::new(FeeRate(bdk_fee_rate)))
.map_err(|e| e.into()) .map_err(|e| e.into())
} }
pub fn list_unspent(&self) -> Vec<LocalOutput> {
self.get_wallet().list_unspent().map(|o| o.into()).collect()
}
pub fn list_output(&self) -> Vec<LocalOutput> {
self.get_wallet().list_output().map(|o| o.into()).collect()
}
pub fn start_full_scan(&self) -> Arc<FullScanRequest> {
let request = self.get_wallet().start_full_scan();
Arc::new(FullScanRequest(Mutex::new(Some(request))))
}
pub fn start_sync_with_revealed_spks(&self) -> Arc<SyncRequest> {
let request = self.get_wallet().start_sync_with_revealed_spks();
Arc::new(SyncRequest(Mutex::new(Some(request))))
}
} }
pub struct SentAndReceivedValues { pub struct SentAndReceivedValues {
@@ -158,6 +133,187 @@ pub struct SentAndReceivedValues {
pub struct Update(pub(crate) BdkUpdate); pub struct Update(pub(crate) BdkUpdate);
// /// A Bitcoin wallet.
// /// The Wallet acts as a way of coherently interfacing with output descriptors and related transactions. Its main components are:
// /// 1. Output descriptors from which it can derive addresses.
// /// 2. A Database where it tracks transactions and utxos related to the descriptors.
// /// 3. Signers that can contribute signatures to addresses instantiated from the descriptors.
// impl Wallet {
// pub fn new(
// descriptor: Arc<Descriptor>,
// change_descriptor: Option<Arc<Descriptor>>,
// network: Network,
// ) -> Result<Self, BdkError> {
// let wallet = BdkWallet::new_no_persist()?;
// Ok(Wallet {
// inner: wallet,
// })
// }
// }
// /// Return whether or not a script is part of this wallet (either internal or external).
// pub(crate) fn is_mine(&self, script: Arc<Script>) -> bool {
// self.inner.is_mine(&script.inner)
// }
//
// /// Sync the internal database with the blockchain.
// // pub(crate) fn sync(
// // &self,
// // blockchain: &Blockchain,
// // progress: Option<Box<dyn Progress>>,
// // ) -> Result<(), BdkError> {
// // let bdk_sync_opts = BdkSyncOptions {
// // progress: progress.map(|p| {
// // Box::new(ProgressHolder { progress: p })
// // as Box<(dyn bdk::blockchain::Progress + 'static)>
// // }),
// // };
// //
// // let blockchain = blockchain.get_blockchain();
// // self.get_wallet().sync(blockchain.deref(), bdk_sync_opts)
// // }
//
// /// Return a derived address using the external descriptor, see AddressIndex for available address index selection
// /// strategies. If none of the keys in the descriptor are derivable (i.e. the descriptor does not end with a * character)
// /// then the same address will always be returned for any AddressIndex.
// /// MIGRATION 1.0: The wallet needs to be mutated for this method to work... does that mean I should bring back the Mutex?
// /// Is this thread-safe?
// pub(crate) fn get_address(&mut self, address_index: AddressIndex) -> AddressInfo {
// AddressInfo::from(self.inner.get_address(address_index.into()))
// }
//
// /// Return a derived address using the internal (change) descriptor.
// ///
// /// If the wallet doesn't have an internal descriptor it will use the external descriptor.
// ///
// /// see [`AddressIndex`] for available address index selection strategies. If none of the keys
// /// in the descriptor are derivable (i.e. does not end with /*) then the same address will always
// /// be returned for any [`AddressIndex`].
// pub(crate) fn get_internal_address(&mut self, address_index: AddressIndex, ) -> AddressInfo {
// AddressInfo::from(self.inner.get_internal_address(address_index.into()))
// }
//
// /// Return the balance, meaning the sum of this wallets unspent outputs values. Note that this method only operates
// /// on the internal database, which first needs to be Wallet.sync manually.
// pub(crate) fn get_balance(&self) -> Balance {
// Balance::from(self.inner.get_balance())
// }
//
// /// Sign a transaction with all the wallet's signers, in the order specified by every signer's
// /// [`SignerOrdering`]. This function returns the `Result` type with an encapsulated `bool` that
// /// has the value true if the PSBT was finalized, or false otherwise.
// ///
// /// The [`SignOptions`] can be used to tweak the behavior of the software signers, and the way
// /// the transaction is finalized at the end. Note that it can't be guaranteed that *every*
// /// signers will follow the options, but the "software signers" (WIF keys and `xprv`) defined
// /// in this library will.
// pub(crate) fn sign(
// &self,
// psbt: &PartiallySignedTransaction,
// sign_options: Option<SignOptions>,
// ) -> Result<bool, BdkError> {
// let mut psbt = psbt.inner.lock().unwrap();
// self.inner.sign(
// &mut psbt,
// sign_options.map(SignOptions::into).unwrap_or_default(),
// )
// }
//
// /// Return the list of transactions made and received by the wallet. Note that this method only operate on the internal database, which first needs to be [Wallet.sync] manually.
// pub(crate) fn list_transactions(
// &self,
// include_raw: bool,
// ) -> Result<Vec<TransactionDetails>, BdkError> {
// let transaction_details = self.inner.list_transactions(include_raw)?;
// Ok(transaction_details
// .into_iter()
// .map(TransactionDetails::from)
// .collect())
// }
//
// /// Return the list of unspent outputs of this wallet. Note that this method only operates on the internal database,
// /// which first needs to be Wallet.sync manually.
// pub(crate) fn list_unspent(&self) -> Result<Vec<LocalUtxo>, BdkError> {
// let unspents: Vec<BdkLocalUtxo> = self.inner.list_unspent()?;
// Ok(unspents.into_iter().map(LocalUtxo::from).collect())
// }
// }
//
// /// Options for a software signer
// ///
// /// Adjust the behavior of our software signers and the way a transaction is finalized
// #[derive(Debug, Clone, Default)]
// pub struct SignOptions {
// /// Whether the signer should trust the `witness_utxo`, if the `non_witness_utxo` hasn't been
// /// provided
// ///
// /// Defaults to `false` to mitigate the "SegWit bug" which should trick the wallet into
// /// paying a fee larger than expected.
// ///
// /// Some wallets, especially if relatively old, might not provide the `non_witness_utxo` for
// /// SegWit transactions in the PSBT they generate: in those cases setting this to `true`
// /// should correctly produce a signature, at the expense of an increased trust in the creator
// /// of the PSBT.
// ///
// /// For more details see: <https://blog.trezor.io/details-of-firmware-updates-for-trezor-one-version-1-9-1-and-trezor-model-t-version-2-3-1-1eba8f60f2dd>
// pub trust_witness_utxo: bool,
//
// /// Whether the wallet should assume a specific height has been reached when trying to finalize
// /// a transaction
// ///
// /// The wallet will only "use" a timelock to satisfy the spending policy of an input if the
// /// timelock height has already been reached. This option allows overriding the "current height" to let the
// /// wallet use timelocks in the future to spend a coin.
// pub assume_height: Option<u32>,
//
// /// Whether the signer should use the `sighash_type` set in the PSBT when signing, no matter
// /// what its value is
// ///
// /// Defaults to `false` which will only allow signing using `SIGHASH_ALL`.
// pub allow_all_sighashes: bool,
//
// /// Whether to remove partial signatures from the PSBT inputs while finalizing PSBT.
// ///
// /// Defaults to `true` which will remove partial signatures during finalization.
// pub remove_partial_sigs: bool,
//
// /// Whether to try finalizing the PSBT after the inputs are signed.
// ///
// /// Defaults to `true` which will try finalizing PSBT after inputs are signed.
// pub try_finalize: bool,
//
// // Specifies which Taproot script-spend leaves we should sign for. This option is
// // ignored if we're signing a non-taproot PSBT.
// //
// // Defaults to All, i.e., the wallet will sign all the leaves it has a key for.
// // TODO pub tap_leaves_options: TapLeavesOptions,
// /// Whether we should try to sign a taproot transaction with the taproot internal key
// /// or not. This option is ignored if we're signing a non-taproot PSBT.
// ///
// /// Defaults to `true`, i.e., we always try to sign with the taproot internal key.
// pub sign_with_tap_internal_key: bool,
//
// /// Whether we should grind ECDSA signature to ensure signing with low r
// /// or not.
// /// Defaults to `true`, i.e., we always grind ECDSA signature to sign with low r.
// pub allow_grinding: bool,
// }
//
// impl From<SignOptions> for BdkSignOptions {
// fn from(sign_options: SignOptions) -> Self {
// BdkSignOptions {
// trust_witness_utxo: sign_options.trust_witness_utxo,
// assume_height: sign_options.assume_height,
// allow_all_sighashes: sign_options.allow_all_sighashes,
// remove_partial_sigs: sign_options.remove_partial_sigs,
// try_finalize: sign_options.try_finalize,
// tap_leaves_options: Default::default(),
// sign_with_tap_internal_key: sign_options.sign_with_tap_internal_key,
// allow_grinding: sign_options.allow_grinding,
// }
// }
// }
#[derive(Clone, Debug)] #[derive(Clone, Debug)]
pub struct TxBuilder { pub struct TxBuilder {
pub(crate) recipients: Vec<(BdkScriptBuf, u64)>, pub(crate) recipients: Vec<(BdkScriptBuf, u64)>,
@@ -310,7 +466,18 @@ impl TxBuilder {
}) })
} }
pub(crate) fn finish(&self, wallet: &Arc<Wallet>) -> Result<Arc<Psbt>, CreateTxError> { /// Add data as an output using OP_RETURN.
// pub(crate) fn add_data(&self, data: Vec<u8>) -> Arc<Self> {
// Arc::new(TxBuilder {
// data,
// ..self.clone()
// })
// }
pub(crate) fn finish(
&self,
wallet: &Arc<Wallet>,
) -> Result<Arc<PartiallySignedTransaction>, Alpha3Error> {
// TODO: I had to change the wallet here to be mutable. Why is that now required with the 1.0 API? // TODO: I had to change the wallet here to be mutable. Why is that now required with the 1.0 API?
let mut wallet = wallet.get_wallet(); let mut wallet = wallet.get_wallet();
let mut tx_builder = wallet.build_tx(); let mut tx_builder = wallet.build_tx();
@@ -320,9 +487,8 @@ impl TxBuilder {
tx_builder.change_policy(self.change_policy); tx_builder.change_policy(self.change_policy);
if !self.utxos.is_empty() { if !self.utxos.is_empty() {
let bdk_utxos: Vec<BdkOutPoint> = self.utxos.iter().map(BdkOutPoint::from).collect(); let bdk_utxos: Vec<BdkOutPoint> = self.utxos.iter().map(BdkOutPoint::from).collect();
tx_builder let utxos: &[BdkOutPoint] = &bdk_utxos;
.add_utxos(&bdk_utxos) tx_builder.add_utxos(utxos)?;
.map_err(CreateTxError::from)?;
} }
if !self.unspendable.is_empty() { if !self.unspendable.is_empty() {
let bdk_unspendable: Vec<BdkOutPoint> = let bdk_unspendable: Vec<BdkOutPoint> =
@@ -354,8 +520,11 @@ impl TxBuilder {
} }
} }
} }
// if !&self.data.is_empty() {
// tx_builder.add_data(self.data.as_slice());
// }
let psbt = tx_builder.finish().map_err(CreateTxError::from)?; let psbt = tx_builder.finish()?;
Ok(Arc::new(psbt.into())) Ok(Arc::new(psbt.into()))
} }
@@ -364,19 +533,28 @@ impl TxBuilder {
#[derive(Clone)] #[derive(Clone)]
pub(crate) struct BumpFeeTxBuilder { pub(crate) struct BumpFeeTxBuilder {
pub(crate) txid: String, pub(crate) txid: String,
pub(crate) fee_rate: Arc<FeeRate>, pub(crate) fee_rate: f32,
pub(crate) allow_shrinking: Option<Arc<Script>>,
pub(crate) rbf: Option<RbfValue>, pub(crate) rbf: Option<RbfValue>,
} }
impl BumpFeeTxBuilder { impl BumpFeeTxBuilder {
pub(crate) fn new(txid: String, fee_rate: Arc<FeeRate>) -> Self { pub(crate) fn new(txid: String, fee_rate: f32) -> Self {
Self { Self {
txid, txid,
fee_rate, fee_rate,
allow_shrinking: None,
rbf: None, rbf: None,
} }
} }
pub(crate) fn allow_shrinking(&self, script_pubkey: Arc<Script>) -> Arc<Self> {
Arc::new(Self {
allow_shrinking: Some(script_pubkey),
..self.clone()
})
}
pub(crate) fn enable_rbf(&self) -> Arc<Self> { pub(crate) fn enable_rbf(&self) -> Arc<Self> {
Arc::new(Self { Arc::new(Self {
rbf: Some(RbfValue::Default), rbf: Some(RbfValue::Default),
@@ -391,13 +569,17 @@ impl BumpFeeTxBuilder {
}) })
} }
pub(crate) fn finish(&self, wallet: &Wallet) -> Result<Arc<Psbt>, CreateTxError> { pub(crate) fn finish(
let txid = Txid::from_str(self.txid.as_str()).map_err(|_| CreateTxError::UnknownUtxo { &self,
outpoint: self.txid.clone(), wallet: &Wallet,
})?; ) -> Result<Arc<PartiallySignedTransaction>, Alpha3Error> {
let txid = Txid::from_str(self.txid.as_str()).map_err(|_| Alpha3Error::Generic)?;
let mut wallet = wallet.get_wallet(); let mut wallet = wallet.get_wallet();
let mut tx_builder = wallet.build_fee_bump(txid).map_err(CreateTxError::from)?; let mut tx_builder = wallet.build_fee_bump(txid)?;
tx_builder.fee_rate(self.fee_rate.0); tx_builder.fee_rate(BdkFeeRate::from_sat_per_vb(self.fee_rate));
if let Some(allow_shrinking) = &self.allow_shrinking {
tx_builder.allow_shrinking(allow_shrinking.0.clone())?;
}
if let Some(rbf) = &self.rbf { if let Some(rbf) = &self.rbf {
match *rbf { match *rbf {
RbfValue::Default => { RbfValue::Default => {
@@ -408,7 +590,8 @@ impl BumpFeeTxBuilder {
} }
} }
} }
let psbt: BdkPsbt = tx_builder.finish()?; let psbt: BdkPartiallySignedTransaction =
tx_builder.finish().map_err(|_| Alpha3Error::Generic)?;
Ok(Arc::new(psbt.into())) Ok(Arc::new(psbt.into()))
} }

View File

@@ -1,5 +1,5 @@
# bdk-jvm # bdk-jvm
This project builds a .jar package for the JVM platform that provides 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. 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 ## How to Use
To use the Kotlin language bindings for [`bdk`] in your JVM project add the following to your gradle dependencies: To use the Kotlin language bindings for [`bdk`] in your JVM project add the following to your gradle dependencies:
@@ -13,6 +13,33 @@ dependencies {
} }
``` ```
You may then import and use the `org.bitcoindevkit` library in your Kotlin code like so. Note that this example is for the `0.30.0` release. For examples of the 1.0 API in the alpha releases, take a look at the tests [here](https://github.com/bitcoindevkit/bdk-ffi/tree/master/bdk-jvm/lib/src/test/kotlin/org/bitcoindevkit).
```kotlin
import org.bitcoindevkit.*
// ...
val externalDescriptor = Descriptor("wpkh([c258d2e4/84h/1h/0h]tpubDDYkZojQFQjht8Tm4jsS3iuEmKjTiEGjG6KnuFNKKJb5A6ZUCUZKdvLdSDWofKi4ToRCwb9poe1XdqfUnP4jaJjCB2Zwv11ZLgSbnZSNecE/0/*)", Network.TESTNET)
val internalDescriptor = Descriptor("wpkh([c258d2e4/84h/1h/0h]tpubDDYkZojQFQjht8Tm4jsS3iuEmKjTiEGjG6KnuFNKKJb5A6ZUCUZKdvLdSDWofKi4ToRCwb9poe1XdqfUnP4jaJjCB2Zwv11ZLgSbnZSNecE/1/*)", Network.TESTNET)
val esploraClient: EsploraClient = EsploraClient("https://esplora.testnet.kuutamo.cloud/")
val wallet: Wallet = Wallet(
descriptor = externalDescriptor,
changeDescriptor = internalDescriptor,
persistenceBackendPath = "./bdkwallet.db",
network = Network.TESTNET
)
val update = esploraClient.fullScan(
wallet = wallet,
stopGap = 10uL,
parallelRequests = 1uL
)
wallet.applyUpdate(update)
val newAddress = wallet.getAddress(AddressIndex.LastUnused)
```
### Snapshot releases ### Snapshot releases
To use a snapshot release, specify the snapshot repository url in the `repositories` block and use the snapshot version in the `dependencies` block: To use a snapshot release, specify the snapshot repository url in the `repositories` block and use the snapshot version in the `dependencies` block:
```kotlin ```kotlin
@@ -29,17 +56,17 @@ dependencies {
* [Tatooine Faucet](https://github.com/thunderbiscuit/tatooine) * [Tatooine Faucet](https://github.com/thunderbiscuit/tatooine)
## How to build ## How to build
_Note that Kotlin version `1.9.23` or later is required to build the library._ _Note that Kotlin version `1.6.10` or later is required to build the library._
1. Install JDK 17. For example, with SDKMAN!: 1. Install JDK 11. It must be version 11 (not 17), otherwise it won't build. For example, with SDKMAN!:
```shell ```shell
curl -s "https://get.sdkman.io" | bash curl -s "https://get.sdkman.io" | bash
source "$HOME/.sdkman/bin/sdkman-init.sh" source "$HOME/.sdkman/bin/sdkman-init.sh"
sdk install java 17.0.2-tem sdk install java 11.0.19-tem
``` ```
2. Install Rust (note that we are currently building using Rust 1.77.1): 2. Install Rust (note that we are currently building using Rust 1.73.0):
```shell ```shell
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
rustup default 1.77.1 rustup default 1.73.0
``` ```
3. Clone this repository. 3. Clone this repository.
```shell ```shell
@@ -57,7 +84,7 @@ rustup target add x86_64-apple-darwin aarch64-apple-darwin
## How to publish to your local Maven repo ## How to publish to your local Maven repo
```shell ```shell
cd bdk-jvm cd bdk-jvm
./gradlew publishToMavenLocal -P localBuild ./gradlew publishToMavenLocal --exclude-task signMavenPublication
``` ```
Note that the commands assume you don't need the local libraries to be signed. If you do wish to sign them, simply set your `~/.gradle/gradle.properties` signing key values like so: Note that the commands assume you don't need the local libraries to be signed. If you do wish to sign them, simply set your `~/.gradle/gradle.properties` signing key values like so:
@@ -66,7 +93,7 @@ signing.gnupg.keyName=<YOUR_GNUPG_ID>
signing.gnupg.passphrase=<YOUR_GNUPG_PASSPHRASE> signing.gnupg.passphrase=<YOUR_GNUPG_PASSPHRASE>
``` ```
and use the `publishToMavenLocal` task without the `localBuild` flag: and use the `publishToMavenLocal` task without excluding the signing task:
```shell ```shell
./gradlew publishToMavenLocal ./gradlew publishToMavenLocal
``` ```

View File

@@ -1,9 +1,4 @@
plugins { plugins {
id("org.jetbrains.kotlin.jvm").version("1.9.23").apply(false)
id("org.gradle.java-library")
id("org.gradle.maven-publish")
id("org.gradle.signing")
id("org.bitcoindevkit.plugins.generate-jvm-bindings").apply(false)
id("io.github.gradle-nexus.publish-plugin") version "1.1.0" id("io.github.gradle-nexus.publish-plugin") version "1.1.0"
} }

View File

@@ -1,4 +1,4 @@
org.gradle.jvmargs=-Xmx1536m org.gradle.jvmargs=-Xmx1536m
android.enableJetifier=true android.enableJetifier=true
kotlin.code.style=official kotlin.code.style=official
libraryVersion=1.0.0-alpha.10-SNAPSHOT libraryVersion=1.0.0-alpha.7

Binary file not shown.

View File

@@ -1,7 +1,5 @@
distributionBase=GRADLE_USER_HOME distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-8.7-all.zip distributionUrl=https\://services.gradle.org/distributions/gradle-7.3.2-bin.zip
networkTimeout=10000
validateDistributionUrl=true
zipStoreBase=GRADLE_USER_HOME zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists zipStorePath=wrapper/dists

31
bdk-jvm/gradlew vendored
View File

@@ -55,7 +55,7 @@
# Darwin, MinGW, and NonStop. # Darwin, MinGW, and NonStop.
# #
# (3) This script is generated from the Groovy template # (3) This script is generated from the Groovy template
# https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt # https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
# within the Gradle project. # within the Gradle project.
# #
# You can find Gradle at https://github.com/gradle/gradle/. # You can find Gradle at https://github.com/gradle/gradle/.
@@ -80,11 +80,13 @@ do
esac esac
done done
# This is normally unused APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
# shellcheck disable=SC2034
APP_NAME="Gradle"
APP_BASE_NAME=${0##*/} APP_BASE_NAME=${0##*/}
# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
# Use the maximum available, or set MAX_FD != -1 to use that value. # Use the maximum available, or set MAX_FD != -1 to use that value.
MAX_FD=maximum MAX_FD=maximum
@@ -131,29 +133,22 @@ location of your Java installation."
fi fi
else else
JAVACMD=java JAVACMD=java
if ! command -v java >/dev/null 2>&1 which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
then
die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
Please set the JAVA_HOME variable in your environment to match the Please set the JAVA_HOME variable in your environment to match the
location of your Java installation." location of your Java installation."
fi
fi fi
# Increase the maximum file descriptors if we can. # Increase the maximum file descriptors if we can.
if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
case $MAX_FD in #( case $MAX_FD in #(
max*) max*)
# In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
# shellcheck disable=SC3045
MAX_FD=$( ulimit -H -n ) || MAX_FD=$( ulimit -H -n ) ||
warn "Could not query maximum file descriptor limit" warn "Could not query maximum file descriptor limit"
esac esac
case $MAX_FD in #( case $MAX_FD in #(
'' | soft) :;; #( '' | soft) :;; #(
*) *)
# In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
# shellcheck disable=SC3045
ulimit -n "$MAX_FD" || ulimit -n "$MAX_FD" ||
warn "Could not set maximum file descriptor limit to $MAX_FD" warn "Could not set maximum file descriptor limit to $MAX_FD"
esac esac
@@ -198,10 +193,6 @@ if "$cygwin" || "$msys" ; then
done done
fi fi
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
# Collect all arguments for the java command; # Collect all arguments for the java command;
# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of # * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
# shell script including quotes and variable substitutions, so put them in # shell script including quotes and variable substitutions, so put them in
@@ -214,12 +205,6 @@ set -- \
org.gradle.wrapper.GradleWrapperMain \ org.gradle.wrapper.GradleWrapperMain \
"$@" "$@"
# Stop when "xargs" is not available.
if ! command -v xargs >/dev/null 2>&1
then
die "xargs is not available"
fi
# Use "xargs" to parse quoted args. # Use "xargs" to parse quoted args.
# #
# With -n1 it outputs one arg per line, with the quotes and backslashes removed. # With -n1 it outputs one arg per line, with the quotes and backslashes removed.

15
bdk-jvm/gradlew.bat vendored
View File

@@ -14,7 +14,7 @@
@rem limitations under the License. @rem limitations under the License.
@rem @rem
@if "%DEBUG%"=="" @echo off @if "%DEBUG%" == "" @echo off
@rem ########################################################################## @rem ##########################################################################
@rem @rem
@rem Gradle startup script for Windows @rem Gradle startup script for Windows
@@ -25,8 +25,7 @@
if "%OS%"=="Windows_NT" setlocal if "%OS%"=="Windows_NT" setlocal
set DIRNAME=%~dp0 set DIRNAME=%~dp0
if "%DIRNAME%"=="" set DIRNAME=. if "%DIRNAME%" == "" set DIRNAME=.
@rem This is normally unused
set APP_BASE_NAME=%~n0 set APP_BASE_NAME=%~n0
set APP_HOME=%DIRNAME% set APP_HOME=%DIRNAME%
@@ -41,7 +40,7 @@ if defined JAVA_HOME goto findJavaFromJavaHome
set JAVA_EXE=java.exe set JAVA_EXE=java.exe
%JAVA_EXE% -version >NUL 2>&1 %JAVA_EXE% -version >NUL 2>&1
if %ERRORLEVEL% equ 0 goto execute if "%ERRORLEVEL%" == "0" goto execute
echo. echo.
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
@@ -76,15 +75,13 @@ set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
:end :end
@rem End local scope for the variables with windows NT shell @rem End local scope for the variables with windows NT shell
if %ERRORLEVEL% equ 0 goto mainEnd if "%ERRORLEVEL%"=="0" goto mainEnd
:fail :fail
rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
rem the _cmd.exe /c_ return code! rem the _cmd.exe /c_ return code!
set EXIT_CODE=%ERRORLEVEL% if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
if %EXIT_CODE% equ 0 set EXIT_CODE=1 exit /b 1
if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
exit /b %EXIT_CODE%
:mainEnd :mainEnd
if "%OS%"=="Windows_NT" endlocal if "%OS%"=="Windows_NT" endlocal

View File

@@ -1,23 +0,0 @@
default:
just --list
build:
./gradlew buildJvmLib
clean:
rm -rf ../bdk-ffi/target/
rm -rf ./build/
rm -rf ./lib/build/
rm -rf ./plugins/build/
publish-local:
./gradlew publishToMavenLocal -P localBuild
test:
./gradlew test
test-offline:
./gradlew test -P excludeConnectedTests
test-specific TEST:
./gradlew test --tests {{TEST}}

View File

@@ -6,15 +6,19 @@ import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
val libraryVersion: String by project val libraryVersion: String by project
plugins { plugins {
id("org.jetbrains.kotlin.jvm") id("org.jetbrains.kotlin.jvm") version "1.6.10"
id("org.gradle.java-library") id("java-library")
id("org.gradle.maven-publish") id("maven-publish")
id("org.gradle.signing") id("signing")
// Custom plugin to generate the native libs and bindings file // Custom plugin to generate the native libs and bindings file
id("org.bitcoindevkit.plugins.generate-jvm-bindings") id("org.bitcoindevkit.plugins.generate-jvm-bindings")
} }
repositories {
mavenCentral()
}
java { java {
sourceCompatibility = JavaVersion.VERSION_11 sourceCompatibility = JavaVersion.VERSION_11
targetCompatibility = JavaVersion.VERSION_11 targetCompatibility = JavaVersion.VERSION_11
@@ -37,7 +41,7 @@ tasks.test {
testing { testing {
suites { suites {
val test by getting(JvmTestSuite::class) { val test by getting(JvmTestSuite::class) {
useKotlinTest("1.9.23") useKotlinTest("1.6.10")
} }
} }
} }
@@ -107,10 +111,6 @@ afterEvaluate {
} }
signing { signing {
if (project.hasProperty("localBuild")) {
isRequired = false
}
val signingKeyId: String? by project val signingKeyId: String? by project
val signingKey: String? by project val signingKey: String? by project
val signingPassword: String? by project val signingPassword: String? by project

View File

@@ -5,9 +5,6 @@ import kotlin.test.AfterTest
import kotlin.test.Test import kotlin.test.Test
import kotlin.test.assertTrue import kotlin.test.assertTrue
private const val SIGNET_ESPLORA_URL = "http://signet.bitcoindevkit.net"
private const val TESTNET_ESPLORA_URL = "https://esplora.testnet.kuutamo.cloud"
class LiveTxBuilderTest { class LiveTxBuilderTest {
private val persistenceFilePath = run { private val persistenceFilePath = run {
val currentDirectory = System.getProperty("user.dir") val currentDirectory = System.getProperty("user.dir")
@@ -25,20 +22,18 @@ class LiveTxBuilderTest {
@Test @Test
fun testTxBuilder() { fun testTxBuilder() {
val descriptor = Descriptor("wpkh(tprv8ZgxMBicQKsPf2qfrEygW6fdYseJDDrVnDv26PH5BHdvSuG6ecCbHqLVof9yZcMoM31z9ur3tTYbSnr1WBqbGX97CbXcmp5H6qeMpyvx35B/84h/1h/0h/0/*)", Network.TESTNET) val descriptor = Descriptor("wpkh(tprv8ZgxMBicQKsPf2qfrEygW6fdYseJDDrVnDv26PH5BHdvSuG6ecCbHqLVof9yZcMoM31z9ur3tTYbSnr1WBqbGX97CbXcmp5H6qeMpyvx35B/84h/1h/0h/0/*)", Network.TESTNET)
val wallet = Wallet(descriptor, null, persistenceFilePath, Network.SIGNET) val wallet = Wallet(descriptor, null, persistenceFilePath, Network.TESTNET)
val esploraClient = EsploraClient(SIGNET_ESPLORA_URL) val esploraClient = EsploraClient("https://esplora.testnet.kuutamo.cloud/")
val fullScanRequest: FullScanRequest = wallet.startFullScan() val update = esploraClient.fullScan(wallet, 10uL, 1uL)
val update = esploraClient.fullScan(fullScanRequest, 10uL, 1uL)
wallet.applyUpdate(update) wallet.applyUpdate(update)
wallet.commit()
println("Balance: ${wallet.getBalance().total}") println("Balance: ${wallet.getBalance().total}")
assert(wallet.getBalance().total > 0uL) assert(wallet.getBalance().total > 0uL)
val recipient: Address = Address("tb1qrnfslnrve9uncz9pzpvf83k3ukz22ljgees989", Network.SIGNET) val recipient: Address = Address("tb1qrnfslnrve9uncz9pzpvf83k3ukz22ljgees989", Network.TESTNET)
val psbt: Psbt = TxBuilder() val psbt: PartiallySignedTransaction = TxBuilder()
.addRecipient(recipient.scriptPubkey(), 4200uL) .addRecipient(recipient.scriptPubkey(), 4200uL)
.feeRate(FeeRate.fromSatPerVb(2uL)) .feeRate(FeeRate.fromSatPerVb(2.0f))
.finish(wallet) .finish(wallet)
println(psbt.serialize()) println(psbt.serialize())
@@ -50,26 +45,24 @@ class LiveTxBuilderTest {
fun complexTxBuilder() { fun complexTxBuilder() {
val externalDescriptor = Descriptor("wpkh(tprv8ZgxMBicQKsPf2qfrEygW6fdYseJDDrVnDv26PH5BHdvSuG6ecCbHqLVof9yZcMoM31z9ur3tTYbSnr1WBqbGX97CbXcmp5H6qeMpyvx35B/84h/1h/0h/0/*)", Network.TESTNET) val externalDescriptor = Descriptor("wpkh(tprv8ZgxMBicQKsPf2qfrEygW6fdYseJDDrVnDv26PH5BHdvSuG6ecCbHqLVof9yZcMoM31z9ur3tTYbSnr1WBqbGX97CbXcmp5H6qeMpyvx35B/84h/1h/0h/0/*)", Network.TESTNET)
val changeDescriptor = Descriptor("wpkh(tprv8ZgxMBicQKsPf2qfrEygW6fdYseJDDrVnDv26PH5BHdvSuG6ecCbHqLVof9yZcMoM31z9ur3tTYbSnr1WBqbGX97CbXcmp5H6qeMpyvx35B/84h/1h/0h/1/*)", Network.TESTNET) val changeDescriptor = Descriptor("wpkh(tprv8ZgxMBicQKsPf2qfrEygW6fdYseJDDrVnDv26PH5BHdvSuG6ecCbHqLVof9yZcMoM31z9ur3tTYbSnr1WBqbGX97CbXcmp5H6qeMpyvx35B/84h/1h/0h/1/*)", Network.TESTNET)
val wallet = Wallet(externalDescriptor, changeDescriptor, persistenceFilePath, Network.SIGNET) val wallet = Wallet(externalDescriptor, changeDescriptor, persistenceFilePath, Network.TESTNET)
val esploraClient = EsploraClient(SIGNET_ESPLORA_URL) val esploraClient = EsploraClient("https://esplora.testnet.kuutamo.cloud/")
val fullScanRequest: FullScanRequest = wallet.startFullScan() val update = esploraClient.fullScan(wallet, 10uL, 1uL)
val update = esploraClient.fullScan(fullScanRequest, 10uL, 1uL)
wallet.applyUpdate(update) wallet.applyUpdate(update)
wallet.commit()
println("Balance: ${wallet.getBalance().total}") println("Balance: ${wallet.getBalance().total}")
assert(wallet.getBalance().total > 0uL) assert(wallet.getBalance().total > 0uL)
val recipient1: Address = Address("tb1qrnfslnrve9uncz9pzpvf83k3ukz22ljgees989", Network.SIGNET) val recipient1: Address = Address("tb1qrnfslnrve9uncz9pzpvf83k3ukz22ljgees989", Network.TESTNET)
val recipient2: Address = Address("tb1qw2c3lxufxqe2x9s4rdzh65tpf4d7fssjgh8nv6", Network.SIGNET) val recipient2: Address = Address("tb1qw2c3lxufxqe2x9s4rdzh65tpf4d7fssjgh8nv6", Network.TESTNET)
val allRecipients: List<ScriptAmount> = listOf( val allRecipients: List<ScriptAmount> = listOf(
ScriptAmount(recipient1.scriptPubkey(), 4200uL), ScriptAmount(recipient1.scriptPubkey(), 4200uL),
ScriptAmount(recipient2.scriptPubkey(), 4200uL), ScriptAmount(recipient2.scriptPubkey(), 4200uL),
) )
val psbt: Psbt = TxBuilder() val psbt: PartiallySignedTransaction = TxBuilder()
.setRecipients(allRecipients) .setRecipients(allRecipients)
.feeRate(FeeRate.fromSatPerVb(4uL)) .feeRate(FeeRate.fromSatPerVb(4.0f))
.changePolicy(ChangeSpendPolicy.CHANGE_FORBIDDEN) .changePolicy(ChangeSpendPolicy.CHANGE_FORBIDDEN)
.enableRbf() .enableRbf()
.finish(wallet) .finish(wallet)

View File

@@ -5,9 +5,6 @@ import kotlin.test.AfterTest
import kotlin.test.Test import kotlin.test.Test
import kotlin.test.assertTrue import kotlin.test.assertTrue
private const val SIGNET_ESPLORA_URL = "http://signet.bitcoindevkit.net"
private const val TESTNET_ESPLORA_URL = "https://esplora.testnet.kuutamo.cloud"
class LiveWalletTest { class LiveWalletTest {
private val persistenceFilePath = run { private val persistenceFilePath = run {
val currentDirectory = System.getProperty("user.dir") val currentDirectory = System.getProperty("user.dir")
@@ -24,13 +21,13 @@ class LiveWalletTest {
@Test @Test
fun testSyncedBalance() { fun testSyncedBalance() {
val descriptor: Descriptor = Descriptor("wpkh(tprv8ZgxMBicQKsPf2qfrEygW6fdYseJDDrVnDv26PH5BHdvSuG6ecCbHqLVof9yZcMoM31z9ur3tTYbSnr1WBqbGX97CbXcmp5H6qeMpyvx35B/84h/1h/0h/0/*)", Network.SIGNET) val descriptor: Descriptor = Descriptor("wpkh(tprv8ZgxMBicQKsPf2qfrEygW6fdYseJDDrVnDv26PH5BHdvSuG6ecCbHqLVof9yZcMoM31z9ur3tTYbSnr1WBqbGX97CbXcmp5H6qeMpyvx35B/84h/1h/0h/0/*)", Network.TESTNET)
val wallet: Wallet = Wallet(descriptor, null, persistenceFilePath, Network.SIGNET) val wallet: Wallet = Wallet(descriptor, null, persistenceFilePath, Network.TESTNET)
val esploraClient: EsploraClient = EsploraClient(SIGNET_ESPLORA_URL) val esploraClient: EsploraClient = EsploraClient("https://esplora.testnet.kuutamo.cloud/")
val fullScanRequest: FullScanRequest = wallet.startFullScan() // val esploraClient: EsploraClient = EsploraClient("https://mempool.space/testnet/api")
val update = esploraClient.fullScan(fullScanRequest, 10uL, 1uL) // val esploraClient = EsploraClient("https://blockstream.info/testnet/api")
val update = esploraClient.fullScan(wallet, 10uL, 1uL)
wallet.applyUpdate(update) wallet.applyUpdate(update)
wallet.commit()
println("Balance: ${wallet.getBalance().total}") println("Balance: ${wallet.getBalance().total}")
assert(wallet.getBalance().total > 0uL) assert(wallet.getBalance().total > 0uL)
@@ -38,8 +35,8 @@ class LiveWalletTest {
println("Transactions count: ${wallet.transactions().count()}") println("Transactions count: ${wallet.transactions().count()}")
val transactions = wallet.transactions().take(3) val transactions = wallet.transactions().take(3)
for (tx in transactions) { for (tx in transactions) {
val sentAndReceived = wallet.sentAndReceived(tx.transaction) val sentAndReceived = wallet.sentAndReceived(tx)
println("Transaction: ${tx.transaction.txid()}") println("Transaction: ${tx.txid()}")
println("Sent ${sentAndReceived.sent}") println("Sent ${sentAndReceived.sent}")
println("Received ${sentAndReceived.received}") println("Received ${sentAndReceived.received}")
} }
@@ -47,25 +44,24 @@ class LiveWalletTest {
@Test @Test
fun testBroadcastTransaction() { fun testBroadcastTransaction() {
val descriptor = Descriptor("wpkh(tprv8ZgxMBicQKsPf2qfrEygW6fdYseJDDrVnDv26PH5BHdvSuG6ecCbHqLVof9yZcMoM31z9ur3tTYbSnr1WBqbGX97CbXcmp5H6qeMpyvx35B/84h/1h/0h/0/*)", Network.SIGNET) val descriptor = Descriptor("wpkh(tprv8ZgxMBicQKsPf2qfrEygW6fdYseJDDrVnDv26PH5BHdvSuG6ecCbHqLVof9yZcMoM31z9ur3tTYbSnr1WBqbGX97CbXcmp5H6qeMpyvx35B/84h/1h/0h/0/*)", Network.TESTNET)
val wallet: Wallet = Wallet(descriptor, null, persistenceFilePath, Network.SIGNET) val wallet: Wallet = Wallet(descriptor, null, persistenceFilePath, Network.TESTNET)
val esploraClient = EsploraClient(SIGNET_ESPLORA_URL) val esploraClient = EsploraClient("https://esplora.testnet.kuutamo.cloud/")
val fullScanRequest: FullScanRequest = wallet.startFullScan() val update = esploraClient.fullScan(wallet, 10uL, 1uL)
val update = esploraClient.fullScan(fullScanRequest, 10uL, 1uL)
wallet.applyUpdate(update) wallet.applyUpdate(update)
wallet.commit()
println("Balance: ${wallet.getBalance().total}") println("Balance: ${wallet.getBalance().total}")
println("New address: ${wallet.revealNextAddress(KeychainKind.EXTERNAL).address.asString()}") println("New address: ${wallet.getAddress(AddressIndex.New).address.asString()}")
assert(wallet.getBalance().total > 0uL) { assert(wallet.getBalance().total > 0uL) {
"Wallet balance must be greater than 0! Please send funds to ${wallet.revealNextAddress(KeychainKind.EXTERNAL).address.asString()} and try again." "Wallet balance must be greater than 0! Please send funds to ${wallet.getAddress(AddressIndex.New).address} and try again."
} }
val recipient: Address = Address("tb1qrnfslnrve9uncz9pzpvf83k3ukz22ljgees989", Network.SIGNET) val recipient: Address = Address("tb1qrnfslnrve9uncz9pzpvf83k3ukz22ljgees989", Network.TESTNET)
val psbt: Psbt = TxBuilder() val psbt: PartiallySignedTransaction = TxBuilder()
.addRecipient(recipient.scriptPubkey(), 4200uL) .addRecipient(recipient.scriptPubkey(), 4200uL)
.feeRate(FeeRate.fromSatPerVb(2uL)) .feeRate(FeeRate.fromSatPerVb(2.0f))
.finish(wallet) .finish(wallet)
println(psbt.serialize()) println(psbt.serialize())
@@ -81,7 +77,7 @@ class LiveWalletTest {
println("Tx fee is: ${txFee}") println("Tx fee is: ${txFee}")
val feeRate: FeeRate = wallet.calculateFeeRate(tx) val feeRate: FeeRate = wallet.calculateFeeRate(tx)
println("Tx fee rate is: ${feeRate.toSatPerVbCeil()} sat/vB") println("Tx fee rate is: ${feeRate.asSatPerVb()} sat/vB")
esploraClient.broadcast(tx) esploraClient.broadcast(tx)
} }

View File

@@ -42,7 +42,7 @@ class OfflineWalletTest {
persistenceFilePath, persistenceFilePath,
Network.TESTNET Network.TESTNET
) )
val addressInfo: AddressInfo = wallet.revealNextAddress(KeychainKind.EXTERNAL) val addressInfo: AddressInfo = wallet.getAddress(AddressIndex.New)
assertTrue(addressInfo.address.isValidForNetwork(Network.TESTNET), "Address is not valid for testnet network") assertTrue(addressInfo.address.isValidForNetwork(Network.TESTNET), "Address is not valid for testnet network")
assertTrue(addressInfo.address.isValidForNetwork(Network.SIGNET), "Address is not valid for signet network") assertTrue(addressInfo.address.isValidForNetwork(Network.SIGNET), "Address is not valid for signet network")

View File

@@ -112,20 +112,20 @@ internal class UniFfiJvmPlugin : Plugin<Project> {
// TODO 2: Is the Windows name the correct one? // TODO 2: Is the Windows name the correct one?
// TODO 3: This will not work on mac Intel (x86_64 architecture) // TODO 3: This will not work on mac Intel (x86_64 architecture)
val libraryPath = when (operatingSystem) { // val libraryPath = when (operatingSystem) {
OS.LINUX -> "./target/x86_64-unknown-linux-gnu/release-smaller/libbdkffi.so" // OS.LINUX -> "./target/x86_64-unknown-linux-gnu/release-smaller/libbdkffi.so"
OS.MAC -> "./target/aarch64-apple-darwin/release-smaller/libbdkffi.dylib" // OS.MAC -> "./target/aarch64-apple-darwin/release-smaller/libbdkffi.dylib"
OS.WINDOWS -> "./target/x86_64-pc-windows-msvc/release-smaller/bdkffi.dll" // OS.WINDOWS -> "./target/x86_64-pc-windows-msvc/release-smaller/bdkffi.dll"
else -> throw Exception("Unsupported OS") // else -> throw Exception("Unsupported OS")
} // }
workingDir("${project.projectDir}/../../bdk-ffi/") // workingDir("${project.projectDir}/../../bdk-ffi/")
val cargoArgs: List<String> = listOf("run", "--bin", "uniffi-bindgen", "generate", "--library", libraryPath, "--language", "kotlin", "--out-dir", "../bdk-jvm/lib/src/main/kotlin/", "--no-format") // val cargoArgs: List<String> = listOf("run", "--bin", "uniffi-bindgen", "generate", "--library", libraryPath, "--language", "kotlin", "--out-dir", "../bdk-jvm/lib/src/main/kotlin/", "--no-format")
// The code above was for the migration to uniffi 0.24.3 using the --library flag // The code above was for the migration to uniffi 0.24.3 using the --library flag
// The code below works with uniffi 0.23.0 // The code below works with uniffi 0.23.0
// workingDir("${project.projectDir}/../../bdk-ffi/") workingDir("${project.projectDir}/../../bdk-ffi/")
// val cargoArgs: List<String> = listOf("run", "--bin", "uniffi-bindgen", "generate", "src/bdk.udl", "--language", "kotlin", "--out-dir", "../bdk-jvm/lib/src/main/kotlin", "--no-format") val cargoArgs: List<String> = listOf("run", "--bin", "uniffi-bindgen", "generate", "src/bdk.udl", "--language", "kotlin", "--out-dir", "../bdk-jvm/lib/src/main/kotlin", "--no-format")
executable("cargo") executable("cargo")
args(cargoArgs) args(cargoArgs)

View File

@@ -2,15 +2,3 @@ rootProject.name = "bdk-jvm"
include(":lib") include(":lib")
includeBuild("plugins") includeBuild("plugins")
pluginManagement {
repositories {
gradlePluginPortal()
}
}
dependencyResolutionManagement {
repositories {
mavenCentral()
}
}

View File

@@ -1,14 +0,0 @@
default:
just --list
build-local-mac:
bash ./scripts/generate-macos-arm64.sh && python3 setup.py bdist_wheel --verbose
clean:
rm -rf ../bdk-ffi/target/
rm -rf ./bdkpython.egg-info/
rm -rf ./build/
rm -rf ./dist/
test:
python3 -m unittest --verbose

View File

@@ -4,15 +4,14 @@ set -euo pipefail
${PYBIN}/python --version ${PYBIN}/python --version
${PYBIN}/pip install -r requirements.txt ${PYBIN}/pip install -r requirements.txt
echo "Generating bdk.py..."
cd ../bdk-ffi/ cd ../bdk-ffi/
rustup default 1.77.1 cargo run --bin uniffi-bindgen generate src/bdk.udl --language python --out-dir ../bdk-python/src/bdkpython/ --no-format
echo "Generating native binaries..." echo "Generating native binaries..."
rustup default 1.73.0
cargo build --profile release-smaller cargo build --profile release-smaller
echo "Generating bdk.py..."
cargo run --bin uniffi-bindgen generate --library ./target/release-smaller/libbdkffi.so --language python --out-dir ../bdk-python/src/bdkpython/ --no-format
echo "Copying linux libbdkffi.so..." echo "Copying linux libbdkffi.so..."
cp ./target/release-smaller/libbdkffi.so ../bdk-python/src/bdkpython/libbdkffi.so cp ./target/release-smaller/libbdkffi.so ../bdk-python/src/bdkpython/libbdkffi.so

View File

@@ -2,17 +2,16 @@
set -euo pipefail set -euo pipefail
python3 --version python3 --version
pip install -r requirements.txt pip install --user -r requirements.txt
cd ../bdk-ffi/
rustup default 1.77.1
rustup target add aarch64-apple-darwin
echo "Generating native binaries..."
cargo build --profile release-smaller --target aarch64-apple-darwin
echo "Generating bdk.py..." echo "Generating bdk.py..."
cargo run --bin uniffi-bindgen generate --library ./target/aarch64-apple-darwin/release-smaller/libbdkffi.dylib --language python --out-dir ../bdk-python/src/bdkpython/ --no-format 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.73.0
rustup target add aarch64-apple-darwin
cargo build --profile release-smaller --target aarch64-apple-darwin
echo "Copying libraries libbdkffi.dylib..." echo "Copying libraries libbdkffi.dylib..."
cp ./target/aarch64-apple-darwin/release-smaller/libbdkffi.dylib ../bdk-python/src/bdkpython/libbdkffi.dylib cp ./target/aarch64-apple-darwin/release-smaller/libbdkffi.dylib ../bdk-python/src/bdkpython/libbdkffi.dylib

View File

@@ -2,17 +2,16 @@
set -euo pipefail set -euo pipefail
python3 --version python3 --version
pip install -r requirements.txt pip install --user -r requirements.txt
cd ../bdk-ffi/
rustup default 1.77.1
rustup target add x86_64-apple-darwin
echo "Generating native binaries..."
cargo build --profile release-smaller --target x86_64-apple-darwin
echo "Generating bdk.py..." echo "Generating bdk.py..."
cargo run --bin uniffi-bindgen generate --library ./target/x86_64-apple-darwin/release-smaller/libbdkffi.dylib --language python --out-dir ../bdk-python/src/bdkpython/ --no-format 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.73.0
rustup target add x86_64-apple-darwin
cargo build --profile release-smaller --target x86_64-apple-darwin
echo "Copying libraries libbdkffi.dylib..." echo "Copying libraries libbdkffi.dylib..."
cp ./target/x86_64-apple-darwin/release-smaller/libbdkffi.dylib ../bdk-python/src/bdkpython/libbdkffi.dylib cp ./target/x86_64-apple-darwin/release-smaller/libbdkffi.dylib ../bdk-python/src/bdkpython/libbdkffi.dylib

View File

@@ -2,17 +2,16 @@
set -euo pipefail set -euo pipefail
python3 --version python3 --version
pip install -r requirements.txt pip install --user -r requirements.txt
cd ../bdk-ffi/
rustup default 1.77.1
rustup target add x86_64-pc-windows-msvc
echo "Generating native binaries..."
cargo build --profile release-smaller --target x86_64-pc-windows-msvc
echo "Generating bdk.py..." echo "Generating bdk.py..."
cargo run --bin uniffi-bindgen generate --library ./target/x86_64-pc-windows-msvc/release-smaller/bdkffi.dll --language python --out-dir ../bdk-python/src/bdkpython/ --no-format 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.73.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..." echo "Copying libraries bdkffi.dll..."
cp ./target/x86_64-pc-windows-msvc/release-smaller/bdkffi.dll ../bdk-python/src/bdkpython/bdkffi.dll cp ./target/x86_64-pc-windows-msvc/release-smaller/bdkffi.dll ../bdk-python/src/bdkpython/bdkffi.dll

View File

@@ -18,7 +18,7 @@ import bdkpython as bdk
setup( setup(
name="bdkpython", name="bdkpython",
version="1.0.0a10.dev", version="1.0.0-alpha7",
description="The Python language bindings for the Bitcoin Development Kit", description="The Python language bindings for the Bitcoin Development Kit",
long_description=LONG_DESCRIPTION, long_description=LONG_DESCRIPTION,
long_description_content_type="text/markdown", long_description_content_type="text/markdown",

View File

@@ -2,9 +2,6 @@ import bdkpython as bdk
import unittest import unittest
import os import os
SIGNET_ESPLORA_URL = "http://signet.bitcoindevkit.net"
TESTNET_ESPLORA_URL = "https://esplora.testnet.kuutamo.cloud"
class LiveTxBuilderTest(unittest.TestCase): class LiveTxBuilderTest(unittest.TestCase):
def tearDown(self) -> None: def tearDown(self) -> None:
@@ -14,76 +11,72 @@ class LiveTxBuilderTest(unittest.TestCase):
def test_tx_builder(self): def test_tx_builder(self):
descriptor: bdk.Descriptor = bdk.Descriptor( descriptor: bdk.Descriptor = bdk.Descriptor(
"wpkh([c258d2e4/84h/1h/0h]tpubDDYkZojQFQjht8Tm4jsS3iuEmKjTiEGjG6KnuFNKKJb5A6ZUCUZKdvLdSDWofKi4ToRCwb9poe1XdqfUnP4jaJjCB2Zwv11ZLgSbnZSNecE/0/*)", "wpkh([c258d2e4/84h/1h/0h]tpubDDYkZojQFQjht8Tm4jsS3iuEmKjTiEGjG6KnuFNKKJb5A6ZUCUZKdvLdSDWofKi4ToRCwb9poe1XdqfUnP4jaJjCB2Zwv11ZLgSbnZSNecE/0/*)",
bdk.Network.SIGNET bdk.Network.TESTNET
) )
wallet: bdk.Wallet = bdk.Wallet( wallet: bdk.Wallet = bdk.Wallet(
descriptor, descriptor,
None, None,
"./bdk_persistence.db", "./bdk_persistence.db",
bdk.Network.SIGNET bdk.Network.TESTNET
) )
esplora_client: bdk.EsploraClient = bdk.EsploraClient(url = SIGNET_ESPLORA_URL) esploraClient: bdk.EsploraClient = bdk.EsploraClient(url = "https://esplora.testnet.kuutamo.cloud/")
full_scan_request: bdk.FullScanRequest = wallet.start_full_scan() update = esploraClient.full_scan(
update = esplora_client.full_scan( wallet = wallet,
full_scan_request=full_scan_request, stop_gap = 10,
stop_gap=10, parallel_requests = 1
parallel_requests=1
) )
wallet.apply_update(update) wallet.apply_update(update)
wallet.commit()
self.assertGreater(wallet.get_balance().total, 0) self.assertGreater(wallet.get_balance().total, 0)
recipient = bdk.Address( recipient = bdk.Address(
address="tb1qrnfslnrve9uncz9pzpvf83k3ukz22ljgees989", address = "tb1qrnfslnrve9uncz9pzpvf83k3ukz22ljgees989",
network=bdk.Network.SIGNET network = bdk.Network.TESTNET
) )
psbt = bdk.TxBuilder().add_recipient(script=recipient.script_pubkey(), amount=4200).fee_rate(fee_rate=bdk.FeeRate.from_sat_per_vb(2)).finish(wallet) psbt = bdk.TxBuilder().add_recipient(script=recipient.script_pubkey(), amount=4200).fee_rate(fee_rate=bdk.FeeRate.from_sat_per_vb(2.0)).finish(wallet)
self.assertTrue(psbt.serialize().startswith("cHNi"), "The PSBT should start with cHNi") self.assertTrue(psbt.serialize().startswith("cHNi"), "The PSBT should start with cHNi")
def complex_tx_builder(self): def complex_tx_builder(self):
descriptor: bdk.Descriptor = bdk.Descriptor( descriptor: bdk.Descriptor = bdk.Descriptor(
"wpkh([c258d2e4/84h/1h/0h]tpubDDYkZojQFQjht8Tm4jsS3iuEmKjTiEGjG6KnuFNKKJb5A6ZUCUZKdvLdSDWofKi4ToRCwb9poe1XdqfUnP4jaJjCB2Zwv11ZLgSbnZSNecE/0/*)", "wpkh([c258d2e4/84h/1h/0h]tpubDDYkZojQFQjht8Tm4jsS3iuEmKjTiEGjG6KnuFNKKJb5A6ZUCUZKdvLdSDWofKi4ToRCwb9poe1XdqfUnP4jaJjCB2Zwv11ZLgSbnZSNecE/0/*)",
bdk.Network.SIGNET bdk.Network.TESTNET
) )
change_descriptor: bdk.Descriptor = bdk.Descriptor( change_descriptor: bdk.Descriptor = bdk.Descriptor(
"wpkh([c258d2e4/84h/1h/0h]tpubDDYkZojQFQjht8Tm4jsS3iuEmKjTiEGjG6KnuFNKKJb5A6ZUCUZKdvLdSDWofKi4ToRCwb9poe1XdqfUnP4jaJjCB2Zwv11ZLgSbnZSNecE/1/*)", "wpkh([c258d2e4/84h/1h/0h]tpubDDYkZojQFQjht8Tm4jsS3iuEmKjTiEGjG6KnuFNKKJb5A6ZUCUZKdvLdSDWofKi4ToRCwb9poe1XdqfUnP4jaJjCB2Zwv11ZLgSbnZSNecE/1/*)",
bdk.Network.SIGNET bdk.Network.TESTNET
) )
wallet: bdk.Wallet = bdk.Wallet( wallet: bdk.Wallet = bdk.Wallet(
descriptor, descriptor,
change_descriptor, change_descriptor,
"./bdk_persistence.db", "./bdk_persistence.db",
bdk.Network.SIGNET bdk.Network.TESTNET
) )
esplora_client: bdk.EsploraClient = bdk.EsploraClient(url = SIGNET_ESPLORA_URL) esploraClient: bdk.EsploraClient = bdk.EsploraClient(url = "https://esplora.testnet.kuutamo.cloud/")
full_scan_request: bdk.FullScanRequest = wallet.start_full_scan() update = esploraClient.full_scan(
update = esplora_client.full_scan( wallet = wallet,
full_scan_request=full_scan_request, stop_gap = 10,
stop_gap=10, parallel_requests = 1
parallel_requests=1
) )
wallet.apply_update(update) wallet.apply_update(update)
wallet.commit()
self.assertGreater(wallet.get_balance().total, 0) self.assertGreater(wallet.get_balance().total, 0)
recipient1 = bdk.Address( recipient1 = bdk.Address(
address="tb1qrnfslnrve9uncz9pzpvf83k3ukz22ljgees989", address = "tb1qrnfslnrve9uncz9pzpvf83k3ukz22ljgees989",
network=bdk.Network.SIGNET network = bdk.Network.TESTNET
) )
recipient2 = bdk.Address( recipient2 = bdk.Address(
address="tb1qw2c3lxufxqe2x9s4rdzh65tpf4d7fssjgh8nv6", address = "tb1qw2c3lxufxqe2x9s4rdzh65tpf4d7fssjgh8nv6",
network=bdk.Network.SIGNET network = bdk.Network.TESTNET
) )
all_recipients = list( all_recipients = list(
bdk.ScriptAmount(recipient1.script_pubkey, 4200), bdk.ScriptAmount(recipient1.script_pubkey, 4200),
bdk.ScriptAmount(recipient2.script_pubkey, 4200) bdk.ScriptAmount(recipient2.script_pubkey, 4200)
) )
psbt: bdk.Psbt = bdk.TxBuilder().set_recipients(all_recipients).fee_rate(fee_rate=bdk.FeeRate.from_sat_per_vb(2)).enable_rbf().finish(wallet) psbt: bdk.PartiallySignedTransaction = bdk.TxBuilder().set_recipients(all_recipients).fee_rate(fee_rate=bdk.FeeRate.from_sat_per_vb(2.0)).enable_rbf().finish(wallet)
wallet.sign(psbt) wallet.sign(psbt)
self.assertTrue(psbt.serialize().startswith("cHNi"), "The PSBT should start with cHNi") self.assertTrue(psbt.serialize().startswith("cHNi"), "The PSBT should start with cHNi")

View File

@@ -2,9 +2,6 @@ import bdkpython as bdk
import unittest import unittest
import os import os
SIGNET_ESPLORA_URL = "http://signet.bitcoindevkit.net"
TESTNET_ESPLORA_URL = "https://esplora.testnet.kuutamo.cloud"
class LiveWalletTest(unittest.TestCase): class LiveWalletTest(unittest.TestCase):
def tearDown(self) -> None: def tearDown(self) -> None:
@@ -14,31 +11,29 @@ class LiveWalletTest(unittest.TestCase):
def test_synced_balance(self): def test_synced_balance(self):
descriptor: bdk.Descriptor = bdk.Descriptor( descriptor: bdk.Descriptor = bdk.Descriptor(
"wpkh(tprv8ZgxMBicQKsPf2qfrEygW6fdYseJDDrVnDv26PH5BHdvSuG6ecCbHqLVof9yZcMoM31z9ur3tTYbSnr1WBqbGX97CbXcmp5H6qeMpyvx35B/84h/1h/0h/0/*)", "wpkh(tprv8ZgxMBicQKsPf2qfrEygW6fdYseJDDrVnDv26PH5BHdvSuG6ecCbHqLVof9yZcMoM31z9ur3tTYbSnr1WBqbGX97CbXcmp5H6qeMpyvx35B/84h/1h/0h/0/*)",
bdk.Network.SIGNET bdk.Network.TESTNET
) )
wallet: bdk.Wallet = bdk.Wallet( wallet: bdk.Wallet = bdk.Wallet(
descriptor, descriptor,
None, None,
"./bdk_persistence.db", "./bdk_persistence.db",
bdk.Network.SIGNET bdk.Network.TESTNET
) )
esplora_client: bdk.EsploraClient = bdk.EsploraClient(url = SIGNET_ESPLORA_URL) esploraClient: bdk.EsploraClient = bdk.EsploraClient(url = "https://esplora.testnet.kuutamo.cloud/")
full_scan_request: bdk.FullScanRequest = wallet.start_full_scan() update = esploraClient.full_scan(
update = esplora_client.full_scan( wallet = wallet,
full_scan_request=full_scan_request, stop_gap = 10,
stop_gap=10, parallel_requests = 1
parallel_requests=1
) )
wallet.apply_update(update) wallet.apply_update(update)
wallet.commit()
self.assertGreater(wallet.get_balance().total, 0) self.assertGreater(wallet.get_balance().total, 0)
print(f"Transactions count: {len(wallet.transactions())}") print(f"Transactions count: {len(wallet.transactions())}")
transactions = wallet.transactions()[:3] transactions = wallet.transactions()[:3]
for tx in transactions: for tx in transactions:
sent_and_received = wallet.sent_and_received(tx.transaction) sent_and_received = wallet.sent_and_received(tx)
print(f"Transaction: {tx.transaction.txid()}") print(f"Transaction: {tx.txid()}")
print(f"Sent {sent_and_received.sent}") print(f"Sent {sent_and_received.sent}")
print(f"Received {sent_and_received.received}") print(f"Received {sent_and_received.received}")
@@ -46,32 +41,30 @@ class LiveWalletTest(unittest.TestCase):
def test_broadcast_transaction(self): def test_broadcast_transaction(self):
descriptor: bdk.Descriptor = bdk.Descriptor( descriptor: bdk.Descriptor = bdk.Descriptor(
"wpkh(tprv8ZgxMBicQKsPf2qfrEygW6fdYseJDDrVnDv26PH5BHdvSuG6ecCbHqLVof9yZcMoM31z9ur3tTYbSnr1WBqbGX97CbXcmp5H6qeMpyvx35B/84h/1h/0h/0/*)", "wpkh(tprv8ZgxMBicQKsPf2qfrEygW6fdYseJDDrVnDv26PH5BHdvSuG6ecCbHqLVof9yZcMoM31z9ur3tTYbSnr1WBqbGX97CbXcmp5H6qeMpyvx35B/84h/1h/0h/0/*)",
bdk.Network.SIGNET bdk.Network.TESTNET
) )
wallet: bdk.Wallet = bdk.Wallet( wallet: bdk.Wallet = bdk.Wallet(
descriptor, descriptor,
None, None,
"./bdk_persistence.db", "./bdk_persistence.db",
bdk.Network.SIGNET bdk.Network.TESTNET
) )
esplora_client: bdk.EsploraClient = bdk.EsploraClient(url = SIGNET_ESPLORA_URL) esploraClient: bdk.EsploraClient = bdk.EsploraClient(url = "https://esplora.testnet.kuutamo.cloud/")
full_scan_request: bdk.FullScanRequest = wallet.start_full_scan() update = esploraClient.full_scan(
update = esplora_client.full_scan( wallet = wallet,
full_scan_request=full_scan_request, stop_gap = 10,
stop_gap=10, parallel_requests = 1
parallel_requests=1
) )
wallet.apply_update(update) wallet.apply_update(update)
wallet.commit()
self.assertGreater(wallet.get_balance().total, 0) self.assertGreater(wallet.get_balance().total, 0)
recipient = bdk.Address( recipient = bdk.Address(
address="tb1qrnfslnrve9uncz9pzpvf83k3ukz22ljgees989", address = "tb1qrnfslnrve9uncz9pzpvf83k3ukz22ljgees989",
network=bdk.Network.SIGNET network = bdk.Network.TESTNET
) )
psbt: bdk.Psbt = bdk.TxBuilder().add_recipient(script=recipient.script_pubkey(), amount=4200).fee_rate(fee_rate=bdk.FeeRate.from_sat_per_vb(2)).finish(wallet) psbt = bdk.TxBuilder().add_recipient(script=recipient.script_pubkey(), amount=4200).fee_rate(fee_rate=bdk.FeeRate.from_sat_per_vb(2.0)).finish(wallet)
# print(psbt.serialize()) # print(psbt.serialize())
self.assertTrue(psbt.serialize().startswith("cHNi"), "The PSBT should start with cHNi") self.assertTrue(psbt.serialize().startswith("cHNi"), "The PSBT should start with cHNi")
@@ -82,9 +75,9 @@ class LiveWalletTest(unittest.TestCase):
fee = wallet.calculate_fee(tx) fee = wallet.calculate_fee(tx)
print(f"Transaction Fee: {fee}") print(f"Transaction Fee: {fee}")
fee_rate = wallet.calculate_fee_rate(tx) fee_rate = wallet.calculate_fee_rate(tx)
print(f"Transaction Fee Rate: {fee_rate.to_sat_per_vb_ceil()} sat/vB") print(f"Transaction Fee Rate: {fee_rate.as_sat_per_vb()} sat/vB")
esplora_client.broadcast(tx) esploraClient.broadcast(tx)
if __name__ == '__main__': if __name__ == '__main__':

View File

@@ -19,7 +19,7 @@ class OfflineWalletTest(unittest.TestCase):
"./bdk_persistence.db", "./bdk_persistence.db",
bdk.Network.TESTNET bdk.Network.TESTNET
) )
address_info: bdk.AddressInfo = wallet.reveal_next_address(bdk.KeychainKind.EXTERNAL) address_info: bdk.AddressInfo = wallet.get_address(bdk.AddressIndex.NEW())
self.assertTrue(address_info.address.is_valid_for_network(bdk.Network.TESTNET), "Address is not valid for testnet network") self.assertTrue(address_info.address.is_valid_for_network(bdk.Network.TESTNET), "Address is not valid for testnet network")
self.assertTrue(address_info.address.is_valid_for_network(bdk.Network.SIGNET), "Address is not valid for signet network") self.assertTrue(address_info.address.is_valid_for_network(bdk.Network.SIGNET), "Address is not valid for signet network")

View File

@@ -1,9 +1,6 @@
import XCTest import XCTest
@testable import BitcoinDevKit @testable import BitcoinDevKit
let SIGNET_ESPLORA_URL = "http://signet.bitcoindevkit.net"
let TESTNET_ESPLORA_URL = "https://esplora.testnet.kuutamo.cloud"
final class LiveTxBuilderTests: XCTestCase { final class LiveTxBuilderTests: XCTestCase {
var dbFilePath: URL! var dbFilePath: URL!
@@ -29,30 +26,28 @@ final class LiveTxBuilderTests: XCTestCase {
func testTxBuilder() throws { func testTxBuilder() throws {
let descriptor = try Descriptor( let descriptor = try Descriptor(
descriptor: "wpkh(tprv8ZgxMBicQKsPf2qfrEygW6fdYseJDDrVnDv26PH5BHdvSuG6ecCbHqLVof9yZcMoM31z9ur3tTYbSnr1WBqbGX97CbXcmp5H6qeMpyvx35B/84h/1h/0h/0/*)", descriptor: "wpkh(tprv8ZgxMBicQKsPf2qfrEygW6fdYseJDDrVnDv26PH5BHdvSuG6ecCbHqLVof9yZcMoM31z9ur3tTYbSnr1WBqbGX97CbXcmp5H6qeMpyvx35B/84h/1h/0h/0/*)",
network: Network.signet network: Network.testnet
) )
let wallet = try Wallet( let wallet = try Wallet(
descriptor: descriptor, descriptor: descriptor,
changeDescriptor: nil, changeDescriptor: nil,
persistenceBackendPath: dbFilePath.path, persistenceBackendPath: dbFilePath.path,
network: .signet network: .testnet
) )
let esploraClient = EsploraClient(url: SIGNET_ESPLORA_URL) let esploraClient = EsploraClient(url: "https://esplora.testnet.kuutamo.cloud/")
let fullScanRequest: FullScanRequest = wallet.startFullScan()
let update = try esploraClient.fullScan( let update = try esploraClient.fullScan(
fullScanRequest: fullScanRequest, wallet: wallet,
stopGap: 10, stopGap: 10,
parallelRequests: 1 parallelRequests: 1
) )
try wallet.applyUpdate(update: update) try wallet.applyUpdate(update: update)
try wallet.commit()
XCTAssertGreaterThan(wallet.getBalance().total, UInt64(0), "Wallet must have positive balance, please add funds") XCTAssertGreaterThan(wallet.getBalance().total, UInt64(0), "Wallet must have positive balance, please add funds")
let recipient: Address = try Address(address: "tb1qrnfslnrve9uncz9pzpvf83k3ukz22ljgees989", network: .signet) let recipient: Address = try Address(address: "tb1qrnfslnrve9uncz9pzpvf83k3ukz22ljgees989", network: .testnet)
let psbt: Psbt = try TxBuilder() let psbt: PartiallySignedTransaction = try TxBuilder()
.addRecipient(script: recipient.scriptPubkey(), amount: 4200) .addRecipient(script: recipient.scriptPubkey(), amount: 4200)
.feeRate(feeRate: FeeRate.fromSatPerVb(satPerVb: 2)) .feeRate(feeRate: FeeRate.fromSatPerVb(satPerVb: 2.0))
.finish(wallet: wallet) .finish(wallet: wallet)
print(psbt.serialize()) print(psbt.serialize())
@@ -62,40 +57,38 @@ final class LiveTxBuilderTests: XCTestCase {
func testComplexTxBuilder() throws { func testComplexTxBuilder() throws {
let descriptor = try Descriptor( let descriptor = try Descriptor(
descriptor: "wpkh(tprv8ZgxMBicQKsPf2qfrEygW6fdYseJDDrVnDv26PH5BHdvSuG6ecCbHqLVof9yZcMoM31z9ur3tTYbSnr1WBqbGX97CbXcmp5H6qeMpyvx35B/84h/1h/0h/0/*)", descriptor: "wpkh(tprv8ZgxMBicQKsPf2qfrEygW6fdYseJDDrVnDv26PH5BHdvSuG6ecCbHqLVof9yZcMoM31z9ur3tTYbSnr1WBqbGX97CbXcmp5H6qeMpyvx35B/84h/1h/0h/0/*)",
network: Network.signet network: Network.testnet
) )
let changeDescriptor = try Descriptor( let changeDescriptor = try Descriptor(
descriptor: "wpkh(tprv8ZgxMBicQKsPf2qfrEygW6fdYseJDDrVnDv26PH5BHdvSuG6ecCbHqLVof9yZcMoM31z9ur3tTYbSnr1WBqbGX97CbXcmp5H6qeMpyvx35B/84h/1h/0h/1/*)", descriptor: "wpkh(tprv8ZgxMBicQKsPf2qfrEygW6fdYseJDDrVnDv26PH5BHdvSuG6ecCbHqLVof9yZcMoM31z9ur3tTYbSnr1WBqbGX97CbXcmp5H6qeMpyvx35B/84h/1h/0h/1/*)",
network: Network.signet network: Network.testnet
) )
let wallet = try Wallet( let wallet = try Wallet(
descriptor: descriptor, descriptor: descriptor,
changeDescriptor: changeDescriptor, changeDescriptor: changeDescriptor,
persistenceBackendPath: dbFilePath.path, persistenceBackendPath: dbFilePath.path,
network: .signet network: .testnet
) )
let esploraClient = EsploraClient(url: SIGNET_ESPLORA_URL) let esploraClient = EsploraClient(url: "https://esplora.testnet.kuutamo.cloud/")
let fullScanRequest: FullScanRequest = wallet.startFullScan()
let update = try esploraClient.fullScan( let update = try esploraClient.fullScan(
fullScanRequest: fullScanRequest, wallet: wallet,
stopGap: 10, stopGap: 10,
parallelRequests: 1 parallelRequests: 1
) )
try wallet.applyUpdate(update: update) try wallet.applyUpdate(update: update)
try wallet.commit()
XCTAssertGreaterThan(wallet.getBalance().total, UInt64(0), "Wallet must have positive balance, please add funds") XCTAssertGreaterThan(wallet.getBalance().total, UInt64(0), "Wallet must have positive balance, please add funds")
let recipient1: Address = try Address(address: "tb1qrnfslnrve9uncz9pzpvf83k3ukz22ljgees989", network: .signet) let recipient1: Address = try Address(address: "tb1qrnfslnrve9uncz9pzpvf83k3ukz22ljgees989", network: .testnet)
let recipient2: Address = try Address(address: "tb1qw2c3lxufxqe2x9s4rdzh65tpf4d7fssjgh8nv6", network: .signet) let recipient2: Address = try Address(address: "tb1qw2c3lxufxqe2x9s4rdzh65tpf4d7fssjgh8nv6", network: .testnet)
let allRecipients: [ScriptAmount] = [ let allRecipients: [ScriptAmount] = [
ScriptAmount(script: recipient1.scriptPubkey(), amount: 4200), ScriptAmount(script: recipient1.scriptPubkey(), amount: 4200),
ScriptAmount(script: recipient2.scriptPubkey(), amount: 4200) ScriptAmount(script: recipient2.scriptPubkey(), amount: 4200)
] ]
let psbt: Psbt = try TxBuilder() let psbt: PartiallySignedTransaction = try TxBuilder()
.setRecipients(recipients: allRecipients) .setRecipients(recipients: allRecipients)
.feeRate(feeRate: FeeRate.fromSatPerVb(satPerVb: 4)) .feeRate(feeRate: FeeRate.fromSatPerVb(satPerVb: 4.0))
.changePolicy(changePolicy: ChangeSpendPolicy.changeForbidden) .changePolicy(changePolicy: ChangeSpendPolicy.changeForbidden)
.enableRbf() .enableRbf()
.finish(wallet: wallet) .finish(wallet: wallet)

View File

@@ -1,9 +1,6 @@
import XCTest import XCTest
@testable import BitcoinDevKit @testable import BitcoinDevKit
let SIGNET_ESPLORA_URL = "http://signet.bitcoindevkit.net"
let TESTNET_ESPLORA_URL = "https://esplora.testnet.kuutamo.cloud"
final class LiveWalletTests: XCTestCase { final class LiveWalletTests: XCTestCase {
var dbFilePath: URL! var dbFilePath: URL!
@@ -29,31 +26,29 @@ final class LiveWalletTests: XCTestCase {
func testSyncedBalance() throws { func testSyncedBalance() throws {
let descriptor = try Descriptor( let descriptor = try Descriptor(
descriptor: "wpkh(tprv8ZgxMBicQKsPf2qfrEygW6fdYseJDDrVnDv26PH5BHdvSuG6ecCbHqLVof9yZcMoM31z9ur3tTYbSnr1WBqbGX97CbXcmp5H6qeMpyvx35B/84h/1h/0h/0/*)", descriptor: "wpkh(tprv8ZgxMBicQKsPf2qfrEygW6fdYseJDDrVnDv26PH5BHdvSuG6ecCbHqLVof9yZcMoM31z9ur3tTYbSnr1WBqbGX97CbXcmp5H6qeMpyvx35B/84h/1h/0h/0/*)",
network: Network.signet network: Network.testnet
) )
let wallet = try Wallet( let wallet = try Wallet(
descriptor: descriptor, descriptor: descriptor,
changeDescriptor: nil, changeDescriptor: nil,
persistenceBackendPath: dbFilePath.path, persistenceBackendPath: dbFilePath.path,
network: .signet network: .testnet
) )
let esploraClient = EsploraClient(url: SIGNET_ESPLORA_URL) let esploraClient = EsploraClient(url: "https://esplora.testnet.kuutamo.cloud/")
let fullScanRequest: FullScanRequest = wallet.startFullScan()
let update = try esploraClient.fullScan( let update = try esploraClient.fullScan(
fullScanRequest: fullScanRequest, wallet: wallet,
stopGap: 10, stopGap: 10,
parallelRequests: 1 parallelRequests: 1
) )
try wallet.applyUpdate(update: update) try wallet.applyUpdate(update: update)
try wallet.commit()
XCTAssertGreaterThan(wallet.getBalance().total, UInt64(0)) XCTAssertGreaterThan(wallet.getBalance().total, UInt64(0))
print("Transactions count: \(wallet.transactions().count)") print("Transactions count: \(wallet.transactions().count)")
let transactions = wallet.transactions().prefix(3) let transactions = wallet.transactions().prefix(3)
for tx in transactions { for tx in transactions {
let sentAndReceived = wallet.sentAndReceived(tx: tx.transaction) let sentAndReceived = wallet.sentAndReceived(tx: tx)
print("Transaction: \(tx.transaction.txid())") print("Transaction: \(tx.txid())")
print("Sent \(sentAndReceived.sent)") print("Sent \(sentAndReceived.sent)")
print("Received \(sentAndReceived.received)") print("Received \(sentAndReceived.received)")
} }
@@ -62,33 +57,31 @@ final class LiveWalletTests: XCTestCase {
func testBroadcastTransaction() throws { func testBroadcastTransaction() throws {
let descriptor = try Descriptor( let descriptor = try Descriptor(
descriptor: "wpkh(tprv8ZgxMBicQKsPf2qfrEygW6fdYseJDDrVnDv26PH5BHdvSuG6ecCbHqLVof9yZcMoM31z9ur3tTYbSnr1WBqbGX97CbXcmp5H6qeMpyvx35B/84h/1h/0h/0/*)", descriptor: "wpkh(tprv8ZgxMBicQKsPf2qfrEygW6fdYseJDDrVnDv26PH5BHdvSuG6ecCbHqLVof9yZcMoM31z9ur3tTYbSnr1WBqbGX97CbXcmp5H6qeMpyvx35B/84h/1h/0h/0/*)",
network: Network.signet network: Network.testnet
) )
let wallet = try Wallet( let wallet = try Wallet(
descriptor: descriptor, descriptor: descriptor,
changeDescriptor: nil, changeDescriptor: nil,
persistenceBackendPath: dbFilePath.path, persistenceBackendPath: dbFilePath.path,
network: .signet network: .testnet
) )
let esploraClient = EsploraClient(url: SIGNET_ESPLORA_URL) let esploraClient = EsploraClient(url: "https://esplora.testnet.kuutamo.cloud/")
let fullScanRequest: FullScanRequest = wallet.startFullScan()
let update = try esploraClient.fullScan( let update = try esploraClient.fullScan(
fullScanRequest: fullScanRequest, wallet: wallet,
stopGap: 10, stopGap: 10,
parallelRequests: 1 parallelRequests: 1
) )
try wallet.applyUpdate(update: update) try wallet.applyUpdate(update: update)
try wallet.commit()
XCTAssertGreaterThan(wallet.getBalance().total, UInt64(0), "Wallet must have positive balance, please add funds") XCTAssertGreaterThan(wallet.getBalance().total, UInt64(0), "Wallet must have positive balance, please add funds")
print("Balance: \(wallet.getBalance().total)") print("Balance: \(wallet.getBalance().total)")
let recipient: Address = try Address(address: "tb1qrnfslnrve9uncz9pzpvf83k3ukz22ljgees989", network: .signet) let recipient: Address = try Address(address: "tb1qrnfslnrve9uncz9pzpvf83k3ukz22ljgees989", network: .testnet)
let psbt: Psbt = try let psbt: PartiallySignedTransaction = try
TxBuilder() TxBuilder()
.addRecipient(script: recipient.scriptPubkey(), amount: 4200) .addRecipient(script: recipient.scriptPubkey(), amount: 4200)
.feeRate(feeRate: FeeRate.fromSatPerVb(satPerVb: 2)) .feeRate(feeRate: FeeRate.fromSatPerVb(satPerVb: 2.0))
.finish(wallet: wallet) .finish(wallet: wallet)
print(psbt.serialize()) print(psbt.serialize())
@@ -97,12 +90,12 @@ final class LiveWalletTests: XCTestCase {
let walletDidSign: Bool = try wallet.sign(psbt: psbt) let walletDidSign: Bool = try wallet.sign(psbt: psbt)
XCTAssertTrue(walletDidSign, "Wallet did not sign transaction") XCTAssertTrue(walletDidSign, "Wallet did not sign transaction")
let tx: Transaction = try! psbt.extractTx() let tx: Transaction = psbt.extractTx()
print(tx.txid()) print(tx.txid())
let fee: UInt64 = try wallet.calculateFee(tx: tx) let fee: UInt64 = try wallet.calculateFee(tx: tx)
print("Transaction Fee: \(fee)") print("Transaction Fee: \(fee)")
let feeRate: FeeRate = try wallet.calculateFeeRate(tx: tx) let feeRate: FeeRate = try wallet.calculateFeeRate(tx: tx)
print("Transaction Fee Rate: \(feeRate.toSatPerVbCeil()) sat/vB") print("Transaction Fee Rate: \(feeRate.asSatPerVb()) sat/vB")
try esploraClient.broadcast(transaction: tx) try esploraClient.broadcast(transaction: tx)
} }

View File

@@ -34,7 +34,7 @@ final class OfflineWalletTests: XCTestCase {
persistenceBackendPath: dbFilePath.path, persistenceBackendPath: dbFilePath.path,
network: .testnet network: .testnet
) )
let addressInfo: AddressInfo = try wallet.revealNextAddress(keychain: KeychainKind.external) let addressInfo: AddressInfo = wallet.getAddress(addressIndex: AddressIndex.new)
XCTAssertTrue(addressInfo.address.isValidForNetwork(network: Network.testnet), XCTAssertTrue(addressInfo.address.isValidForNetwork(network: Network.testnet),
"Address is not valid for testnet network") "Address is not valid for testnet network")

View File

@@ -3,15 +3,19 @@
# The results of this script can be used for locally testing your SPM package adding a local package # The results of this script can be used for locally testing your SPM package adding a local package
# to your application pointing at the bdk-swift directory. # to your application pointing at the bdk-swift directory.
rustup default 1.77.1 # Run the script from the repo root directory, ie: ./bdk-swift/build-local-swift.sh
rustup install 1.73.0
rustup component add rust-src rustup component add rust-src
rustup target add aarch64-apple-ios # iOS arm64 rustup target add aarch64-apple-ios # iOS ARM64
rustup target add x86_64-apple-ios # iOS x86_64 rustup target add x86_64-apple-ios # iOS x86_64
rustup target add aarch64-apple-ios-sim # simulator mac M1 rustup target add aarch64-apple-ios-sim # simulator mac M1
rustup target add aarch64-apple-darwin # mac M1 rustup target add aarch64-apple-darwin # mac M1
rustup target add x86_64-apple-darwin # mac x86_64 rustup target add x86_64-apple-darwin # mac x86_64
cd ../bdk-ffi/ || exit pushd bdk-ffi
mkdir -p Sources/BitcoinDevKit
cargo run --bin uniffi-bindgen generate src/bdk.udl --language swift --out-dir ../bdk-swift/Sources/BitcoinDevKit --no-format
cargo build --package bdk-ffi --profile release-smaller --target x86_64-apple-darwin cargo build --package bdk-ffi --profile release-smaller --target x86_64-apple-darwin
cargo build --package bdk-ffi --profile release-smaller --target aarch64-apple-darwin cargo build --package bdk-ffi --profile release-smaller --target aarch64-apple-darwin
@@ -19,14 +23,13 @@ cargo build --package bdk-ffi --profile release-smaller --target x86_64-apple-io
cargo build --package bdk-ffi --profile release-smaller --target aarch64-apple-ios cargo build --package bdk-ffi --profile release-smaller --target aarch64-apple-ios
cargo build --package bdk-ffi --profile release-smaller --target aarch64-apple-ios-sim cargo build --package bdk-ffi --profile release-smaller --target aarch64-apple-ios-sim
cargo run --bin uniffi-bindgen generate --library ./target/aarch64-apple-ios/release-smaller/libbdkffi.dylib --language swift --out-dir ../bdk-swift/Sources/BitcoinDevKit --no-format
mkdir -p target/lipo-ios-sim/release-smaller mkdir -p target/lipo-ios-sim/release-smaller
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 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 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 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
cd ../bdk-swift/ || exit popd
pushd bdk-swift
mv Sources/BitcoinDevKit/bdk.swift Sources/BitcoinDevKit/BitcoinDevKit.swift mv Sources/BitcoinDevKit/bdk.swift Sources/BitcoinDevKit/BitcoinDevKit.swift
cp Sources/BitcoinDevKit/bdkFFI.h bdkFFI.xcframework/ios-arm64/bdkFFI.framework/Headers cp Sources/BitcoinDevKit/bdkFFI.h bdkFFI.xcframework/ios-arm64/bdkFFI.framework/Headers
cp Sources/BitcoinDevKit/bdkFFI.h bdkFFI.xcframework/ios-arm64_x86_64-simulator/bdkFFI.framework/Headers cp Sources/BitcoinDevKit/bdkFFI.h bdkFFI.xcframework/ios-arm64_x86_64-simulator/bdkFFI.framework/Headers
@@ -36,3 +39,5 @@ cp ../bdk-ffi/target/lipo-ios-sim/release-smaller/libbdkffi.a bdkFFI.xcframework
cp ../bdk-ffi/target/lipo-macos/release-smaller/libbdkffi.a bdkFFI.xcframework/macos-arm64_x86_64/bdkFFI.framework/bdkFFI cp ../bdk-ffi/target/lipo-macos/release-smaller/libbdkffi.a bdkFFI.xcframework/macos-arm64_x86_64/bdkFFI.framework/bdkFFI
rm Sources/BitcoinDevKit/bdkFFI.h rm Sources/BitcoinDevKit/bdkFFI.h
rm Sources/BitcoinDevKit/bdkFFI.modulemap rm Sources/BitcoinDevKit/bdkFFI.modulemap
#rm bdkFFI.xcframework.zip || true
#zip -9 -r bdkFFI.xcframework.zip bdkFFI.xcframework

View File

@@ -1,14 +0,0 @@
default:
just --list
build:
bash ./build-local-swift.sh
clean:
rm -rf ../bdk-ffi/target/
test:
swift test
test-offline:
swift test --skip LiveWalletTests --skip LiveTxBuilderTests