diff --git a/bdk-ffi/CHANGELOG.md b/CHANGELOG.md similarity index 100% rename from bdk-ffi/CHANGELOG.md rename to CHANGELOG.md diff --git a/bdk-ffi/DEVELOPMENT_CYCLE.md b/DEVELOPMENT_CYCLE.md similarity index 100% rename from bdk-ffi/DEVELOPMENT_CYCLE.md rename to DEVELOPMENT_CYCLE.md diff --git a/bdk-ffi/LICENSE b/LICENSE similarity index 100% rename from bdk-ffi/LICENSE rename to LICENSE diff --git a/bdk-ffi/LICENSE-APACHE b/LICENSE-APACHE similarity index 100% rename from bdk-ffi/LICENSE-APACHE rename to LICENSE-APACHE diff --git a/bdk-ffi/LICENSE-MIT b/LICENSE-MIT similarity index 100% rename from bdk-ffi/LICENSE-MIT rename to LICENSE-MIT diff --git a/bdk-kotlin/PGP-BDK-BINDINGS.asc b/PGP-BDK-BINDINGS.asc similarity index 100% rename from bdk-kotlin/PGP-BDK-BINDINGS.asc rename to PGP-BDK-BINDINGS.asc diff --git a/bdk-kotlin/README.md b/README.md similarity index 60% rename from bdk-kotlin/README.md rename to README.md index 297d48f..251cf67 100644 --- a/bdk-kotlin/README.md +++ b/README.md @@ -1,12 +1,82 @@ +# Native language bindings for BDK + +

+ MIT or Apache-2.0 Licensed + CI Status + Rustc Version 1.61.0+ + Chat on Discord +

+ +The workspace in this repository creates the `libbdkffi` multi-language library for the rust based +[bdk] library from the [Bitcoin Dev Kit] project. The `bdk-ffi-bindgen` package builds a tool for +generating the actual language binding code used to access the `libbdkffi` library. + +Each supported language has its own repository that includes this project as a [git submodule]. +The rust code in this project is a wrapper around the [bdk] library to expose it's APIs in a +uniform way using the [mozilla/uniffi-rs] bindings generator for each supported target language. + +## Supported target languages and platforms + +The below repositories include instructions for using, building, and publishing the native +language binding for [bdk] supported by this project. + +| Language | Platform | Repository | +| -------- | ------------ | ------------ | +| Kotlin | jvm | [bdk-kotlin] | +| Kotlin | android | [bdk-kotlin] | +| Swift | iOS, macOS | [bdk-swift] | +| Python | linux, macOS | [bdk-python] | + +## Language bindings generator tool + +Use the `bdk-ffi-bindgen` tool to generate language binding code for the above supported languages. +To run `bdk-ffi-bindgen` and see the available options use the command: +```shell +cargo run -p bdk-ffi-bindgen -- --help +``` + +[bdk]: https://github.com/bitcoindevkit/bdk +[Bitcoin Dev Kit]: https://github.com/bitcoindevkit +[git submodule]: https://git-scm.com/book/en/v2/Git-Tools-Submodules +[uniffi-rs]: https://github.com/mozilla/uniffi-rs + +[bdk-kotlin]: https://github.com/bitcoindevkit/bdk-kotlin +[bdk-swift]: https://github.com/bitcoindevkit/bdk-swift +[bdk-python]: https://github.com/bitcoindevkit/bdk-python + +## Contributing + +### 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 +1. 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` +1. update mapping `bdk.udl` file with new `interface` + +## Goals + +1. Language bindings should feel idiomatic in target languages/platforms +1. Adding new targets should be easy +1. Getting up and running should be easy +1. Contributing should be easy +1. Get it right, then automate + # bdk-kotlin -This project builds .jar and .aar packages for the `jvm` and `android` platforms that provide -[Kotlin] language bindings for the [`bdk`] library. The Kotlin language bindings are created by the +This project builds .jar and .aar packages for the `jvm` and `android` platforms that provide +[Kotlin] language bindings for the [`bdk`] library. The Kotlin language bindings are created by the [`bdk-ffi`] project which is included as a git submodule of this repository. ## How to Use -To use the Kotlin language bindings for [`bdk`] in your `jvm` or `android` project add the +To use the Kotlin language bindings for [`bdk`] in your `jvm` or `android` project add the following to your gradle dependencies: ```groovy repositories { @@ -46,7 +116,7 @@ val newAddress = wallet.getNewAddress() ### Example Projects #### `bdk-android` -* [Devkit Wallet](https://github.com/thunderbiscuit/devkit-wallet) +* [Devkit Wallet](https://github.com/thunderbiscuit/devkit-wallet) * [Padawan Wallet](https://github.com/thunderbiscuit/padawan-wallet) #### `bdk-jvm` @@ -70,7 +140,7 @@ rustup target add x86_64-apple-darwin aarch64-apple-darwin rustup target add x86_64-linux-android aarch64-linux-android armv7-linux-androideabi ``` 5. Install Android SDK and Build-Tools for API level 30+ -6. Setup `$ANDROID_SDK_ROOT` and `$ANDROID_NDK_ROOT` path variables (which are required by the +6. Setup `$ANDROID_SDK_ROOT` and `$ANDROID_NDK_ROOT` path variables (which are required by the build tool), for example (NDK major version 21 is required): ```shell export ANDROID_SDK_ROOT=~/Android/Sdk @@ -138,11 +208,11 @@ sub cv25519 2022-08-31 [E] 2. Download the binary artifacts and corresponding signature files. - from [bdk-jvm] - - `bdk-jvm-.jar` - - `bdk-jvm-.jar.asc` + - `bdk-jvm-.jar` + - `bdk-jvm-.jar.asc` - from [bdk-android] - - `bdk-android-.aar` - - `bdk-android-.aar.asc` + - `bdk-android-.aar` + - `bdk-android-.aar.asc` 3. Verify the signatures. ```shell @@ -157,7 +227,7 @@ gpg: Good signature from "bitcoindevkit-bindings " [ Full key ID: `88AD 93AC 4589 FD09 0FF3 B8D1 2768 C43E 8803 C6A3` Fingerprint: `2768C43E8803C6A3` Name: `bitcoindevkit-bindings` -Email: `bindings@bitcoindevkit.org` +Email: `bindings@bitcoindevkit.org` [Kotlin]: https://kotlinlang.org/ [Android Studio]: https://developer.android.com/studio/ @@ -167,3 +237,9 @@ Email: `bindings@bitcoindevkit.org` [Gradle Nexus Publish Plugin]: https://github.com/gradle-nexus/publish-plugin [bdk-jvm]: https://search.maven.org/artifact/org.bitcoindevkit/bdk-jvm/0.9.0/jar [bdk-android]: https://search.maven.org/artifact/org.bitcoindevkit/bdk-android/0.9.0/aar + +## Thanks + +This project is made possible thanks to the wonderful work by the [mozilla/uniffi-rs] team. + +[mozilla/uniffi-rs]: https://github.com/mozilla/uniffi-rs diff --git a/bdk-ffi/README.md b/bdk-ffi/README.md deleted file mode 100644 index c47fd5c..0000000 --- a/bdk-ffi/README.md +++ /dev/null @@ -1,75 +0,0 @@ -# Native language bindings for BDK - -

- MIT or Apache-2.0 Licensed - CI Status - Rustc Version 1.61.0+ - Chat on Discord -

- -The workspace in this repository creates the `libbdkffi` multi-language library for the rust based -[bdk] library from the [Bitcoin Dev Kit] project. The `bdk-ffi-bindgen` package builds a tool for -generating the actual language binding code used to access the `libbdkffi` library. - -Each supported language has its own repository that includes this project as a [git submodule]. -The rust code in this project is a wrapper around the [bdk] library to expose it's APIs in a -uniform way using the [mozilla/uniffi-rs] bindings generator for each supported target language. - -## Supported target languages and platforms - -The below repositories include instructions for using, building, and publishing the native -language binding for [bdk] supported by this project. - -| Language | Platform | Repository | -| -------- | ------------ | ------------ | -| Kotlin | jvm | [bdk-kotlin] | -| Kotlin | android | [bdk-kotlin] | -| Swift | iOS, macOS | [bdk-swift] | -| Python | linux, macOS | [bdk-python] | - -## Language bindings generator tool - -Use the `bdk-ffi-bindgen` tool to generate language binding code for the above supported languages. -To run `bdk-ffi-bindgen` and see the available options use the command: -```shell -cargo run -p bdk-ffi-bindgen -- --help -``` - -[bdk]: https://github.com/bitcoindevkit/bdk -[Bitcoin Dev Kit]: https://github.com/bitcoindevkit -[git submodule]: https://git-scm.com/book/en/v2/Git-Tools-Submodules -[uniffi-rs]: https://github.com/mozilla/uniffi-rs - -[bdk-kotlin]: https://github.com/bitcoindevkit/bdk-kotlin -[bdk-swift]: https://github.com/bitcoindevkit/bdk-swift -[bdk-python]: https://github.com/bitcoindevkit/bdk-python - -## Contributing - -### 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 -1. 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` -1. update mapping `bdk.udl` file with new `interface` - -## Goals - -1. Language bindings should feel idiomatic in target languages/platforms -1. Adding new targets should be easy -1. Getting up and running should be easy -1. Contributing should be easy -1. Get it right, then automate - -## Thanks - -This project is made possible thanks to the wonderful work by the [mozilla/uniffi-rs] team. - -[mozilla/uniffi-rs]: https://github.com/mozilla/uniffi-rs diff --git a/bdk-kotlin/LICENSE b/bdk-kotlin/LICENSE deleted file mode 100644 index 9c61848..0000000 --- a/bdk-kotlin/LICENSE +++ /dev/null @@ -1,14 +0,0 @@ -This software is licensed under [Apache 2.0](LICENSE-APACHE) or -[MIT](LICENSE-MIT), at your option. - -Some files retain their own copyright notice, however, for full authorship -information, see version control history. - -Except as otherwise noted in individual files, all files in this repository are -licensed under the Apache License, Version 2.0 or the MIT license , at your option. - -You may not use, copy, modify, merge, publish, distribute, sublicense, and/or -sell copies of this software or any files in this repository except in -accordance with one or both of these licenses. \ No newline at end of file diff --git a/bdk-kotlin/LICENSE-APACHE b/bdk-kotlin/LICENSE-APACHE deleted file mode 100644 index 261eeb9..0000000 --- a/bdk-kotlin/LICENSE-APACHE +++ /dev/null @@ -1,201 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. diff --git a/bdk-kotlin/LICENSE-MIT b/bdk-kotlin/LICENSE-MIT deleted file mode 100644 index 9d982a4..0000000 --- a/bdk-kotlin/LICENSE-MIT +++ /dev/null @@ -1,16 +0,0 @@ -Permission is hereby granted, free of charge, to any person obtaining a copy of -this software and associated documentation files (the "Software"), to deal in -the Software without restriction, including without limitation the rights to -use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of -the Software, and to permit persons to whom the Software is furnished to do so, -subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS -FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR -COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER -IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN -CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.