https://github.com/bitcoindevkit/bdk-swift

Swift package for bdk-ffi
https://github.com/bitcoindevkit/bdk-swift

Last synced: 3 days ago
JSON representation

Swift package for bdk-ffi

• Host: GitHub
• URL: https://github.com/bitcoindevkit/bdk-swift
• Owner: bitcoindevkit
• License: other
• Created: 2021-11-23T19:38:25.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2024-05-21T18:59:04.000Z (6 months ago)
• Last Synced: 2024-06-10T05:35:36.043Z (5 months ago)
• Language: Swift
• Size: 163 KB
• Stars: 29
• Watchers: 9
• Forks: 13
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-bdk - BitcoinDevkit Swift library on GitHub

README

        
# bdk-swift

This project is only used to publish a [Swift] package manager package called `bdk-swift` with language bindings and corresponding bdkFFI.xcframework for the 

`BitcoinDevKit` framework created by the [bdk-ffi] project. The Swift language bindings files are created by the [bdk-ffi] `./bdk-ffi` sub-project which are copied into, committed and tagged in this `bdk-swift` repo by the `publish-spm` github actions workflow.

Any changes to the `bdk-swift` Swift package must be made via the [bdk-ffi] repo.

## How to Use

To use the Swift language bindings for `BitcoinDevKit` in your [Xcode] iOS or MacOS project:

1. Add the "bdk-swift" package from the repo https://github.com/bitcoindevkit/bdk-swift and select one of the latest minor versions.

2. Add the `BitcoinDevKit` framework in your Target config.

3. Import and use the `BitcoinDevKit` library in your Swift code. For example:

   ```swift

   import BitcoinDevKit

   

   ...

   ```

[Swift]: https://developer.apple.com/swift/

[Xcode]: https://developer.apple.com/documentation/Xcode

[bdk-ffi]: https://github.com/bitcoindevkit/bdk-ffi