Swift Bitcoin is a cross-platform fully-featured Bitcoin development framework for Swift projects. It includes a standalone network client daemon as well as a command line utility for on-chain and off-chain operations. Swift Bitcoin is written entirely in modern data-race safe Swift with minimal third-party dependencies.
To integrate Swift Bitcoin into your own project first add an entry to your Package.swift dependencies:
let package = Package( …
dependencies: [ …
.package(url: "https://github.com/swift-bitcoin/swift-bitcoin", branch: "develop") …Make sure to also include a Bitcoin product reference in the specific target's dependencies:
… targets: [
.target( …
dependencies: [ …
.product(name: "Bitcoin", package: "swift-bitcoin") …On your Swift sources import the Bitcoin module:
import BitcoinAdditional products/modules exist for specific areas of functionality:
BitcoinCrypto- Cryptography, key management and encodings.BitcoinBase- Transactions and script interpretation.BitcoinWallet- Wallet, addresses, mnemonics and key derivation.BitcoinBlockchain- Blockchain services and memory pool.BitcoinTransport- Peer-to-peer protocol implementation.BitcoinRPC- Support for RPC (Remote Procedure Call).
All functionalities are included in the umbrella Bitcoin module.
Check out our Getting Started guide to begin leveraging Swift Bitcoin's capabilities.
From the project's root use swift run bcnode to start a Bitcoin Node instance with default settings.
Launch the Bitcoin Utility to perform off-chain operations or to control a running node instance. To query the node's status use swift run bcutil status.
See Running for additional information on how to invoke the CLI tools.
If you have Mint on your system you can install Swift Bitcoin tools with:
mint install swift-bitcoin/swift-bitcoin@develop
This repository contains a single Swift Package which exposes a series of library and executable products: crypto, base, wallet, blockchain, transport, RPC, node and utility.
Refer to each module's documentation to understand the exact functionality covered.
There's test targets defined for each of the modules which can all be run with swift test.
To build the project and run the command line tools use the swift command.
First make sure all tests are passing:
swift build --build-tests
swift testSee Building to learn how to generate a release build on multiple platforms.
Many of the latest features from the extended Swift Language ecosystem are leveraged by Swift Bitcoin to keep usability, performance and reliability at the highest possible level.
- Swift Package Manager
- C / C++ interoperability
- Async/await APIs
- Actors for mutable state isolation
- Non-Blocking I/O and service lifecycle
- Structured concurrency
- Data race safety
- Argument parser
- Swift Testing
- DocC documentation plugin
- Logging
- Typed throws
- Value semantics (virtually no
classdefinitions) - Swift Plugins
Going forward we would like to experiment with Swift Macros, Embedded Swift and ~Copyable to bring the solution even closer to the cutting edge.
Swift Bitcoin itself depends on Bitcoin Core's libsecp256k1 as well as a reduced set of official Swift Language packages such as Swift Algorithms and Collections.
The transport and RPC modules depend on the open source SwiftNIO library by Apple which is also use for non-blocking file system access. For persistence Apple's fork of LMDB is used.
Fully implemented: scripts, transactions, blocks, key generation, key derivation, mnemonics, signing, verifying, segwit, taproot, absolute/relative time locks, transaction/block validation, block persistence, initial block download, transaction/block relay, chain state, mempool, regtest consensus, address parsing and output generation.
Mostly implemented: wire protocol, RPC commands, mempool policy.
Make sure to check the project's blog for the latest news and updates.
The medium term focus is set on completing the wire protocol implementation for regtest ad well as relevant RPC commands from Bitcoin Core.
Following that the remaining BIPs associated to blocks and transport layer should be implemented. Standard-ness rules will need to be enforced and tested.
Medium-long term we'd like to be able to sync testnet4 and with that launch our first beta.