Welcome to BitcoinKit
The BitcoinKit library is a Swift implementation of the Bitcoin protocol which support both BCH and BTC. Improving the mobile ecosystem for Bitcoin developers is our mission.
BitcoinKit allows maintaining a wallet, sending or receiving transactions without a full blockchain node. Following is a wallet app that demonstrates the way to use it.
Release notes are here.
Features
- Encoding/decoding addresses: base58, Cashaddr, P2PKH, P2SH, WIF format.
- Transaction building blocks: inputs, outputs, scripts.
- EC keys and signatures.
- BIP32, BIP44 hierarchical deterministic wallets.
- BIP39 implementation.
- SPV features are under construction. The following functions cannot work well sometimes.
- Send/receive transactions.
- See current balance in a wallet.
Requirements
- iOS 9.0+ / Mac OS X 10.11+ / tvOS 9.0+ / watchOS 2.0+
- Xcode 10.0+
- Swift 5.0+
Installation
CocoaPods
$ gem install cocoapods
CocoaPods 1.5.0+ is required to build BitcoinKit.
To integrate BitcoinKit into your Xcode project using CocoaPods, specify it in your Podfile:
source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '13.0'
use_frameworks!
target '<Your Target Name>' do
pod 'BitcoinKit', '~> 1.1.0'
end
Then, run the following command:
$ pod install
Carthage
Add this to Cartfile
github "yenom/BitcoinKit" ~> 1.1.0
Run carthage update to build the framework and drag the built BitcoinKit.framework into your Xcode project.
Swift Package Manager
Simply add the following lines to dependencies of your Package.swift:
.package(url: "https://github.com/yenom/BitcoinKit.git", .upToNextMinor(from: "1.1.0"))
Note that following data types and features are currently not supported on Linux platform.
PeerandPeerGroup- SQLite based BlockStore
Contribute
Contributions to BitcoinKit are welcome and encouraged!
Feel free to open issues, drop us pull requests.
Authors & Maintainers
About
BitcoinKit is maintained and funded by Yenom.
Visit our website or say hi on twitter (@Yenom_wallet_en)
License
BitcoinKit is available under the MIT license. See the LICENSE file for more info.
Contributors
This project exists thanks to all the people who contribute.
Backers
Thank you to all our backers! ? [Become a backer]
Sponsors
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]