BitcoinKit-iOS
Swift 的比特币、BitcoinCash(ABC) 和 Dash 钱包工具包。这是一个包含钱包创建/恢复、与网络的同步、发送/接收交易等功能的完整 SPV 节点实现。这个存储库包括主要的 BitcoinCore.swift、BitcoinKit.swift、BitcoinCashKit.swift 和 DashKit.swift 独立的 pods。
功能
- 完整的 SPV 实现以实现快速移动性能
- 发送/接收旧交易（P2PKH、P2PK、P2SH）
- BIP32 分层确定性钱包实现。
- BIP39 生成确定性密钥的助记词。
- BIP44 确定性钱包的多账户层次结构。
- BIP21 URI 计划，包括支付地址、金额、标签和其他参数
BitcoinKit.swift
- 发送/接收 Segwit 交易（P2WPKH）
- 兼容旧钱包的 Segwit 交易（P2WPKH-SH）发送/接收
- base58, bech32
BitcoinCashKit.swift
- bech32 cashaddr 地址
DashKit.swift
- 即时发送
- LLMQ 锁定，主节点验证
用法
在本页中，我们将使用“套件”来指代以下套件之一：BitcoinKit.swift、BitcoinCashKit.swift和DashKit.swift
初始化
套件在初始化时需要您提供助记词短语
let words = ["word1", ... , "word12"]比特币
let bitcoinKit = BitcoinKit(withWords: words, walletId: "bitcoin-wallet-id", syncMode: .api, networkType: .mainNet)比特币现金
let bitcoinCashKit = BitcoinCashKit(withWords: words, walletId: "bitcoin-cash-wallet-id", syncMode: .api, networkType: .mainNet)仪表板
let dashKit = DashKit(withWords: words, walletId: "dash-wallet-id", syncMode: .api, networkType: .mainNet)所有3个工具包都可以配置为在.mainNet或.testNet中工作。
syncMode参数
工具包可以恢复现有的钱包或创建一个新的钱包。在恢复时，根据bip44协议为给定的钱包生成地址，然后为这些地址中的每个地址拉取所有历史交易。这仅在初始同步时进行一次。syncMode参数定义了从哪里拉取历史交易。当它们被拉取时，不管初始同步使用了哪种syncMode，都将继续按照SPV协议进行同步。目前有3种模式可用
.full：完全从引入bip44时的区块开始从点对点网络同步。本模式最私密（因为它完全符合SPV协议），但同步到目前（2019年6月10日）需要大约2个小时。.api：从API（目前为Insight API或Bcoin API）拉取检查点之前的交易。然后从点对点网络同步剩余部分。这是最快的，但攻击者可能了解到你拥有哪些地址。检查点会随着每个新版本进行更新并硬编码，因此不会破坏区块验证。.newWallet：无需拉取交易。
其他参数
confirmationsThreshold：未花费输出所需的最小确认次数（默认：6）minLogLevel：如有需要，可以配置为调试目的。
启动和停止
工具包需要使用start命令启动。只要可能，它将保持同步状态。您可以通过调用stop来停止它。
bitcoinKit.start()
bitcoinKit.stop()获取钱包数据
套件包含从区块链网络获取的所有数据以及进行此类操作所需的所有数据
当前余额
余额以 萨托什 提供
bitcoinKit.balance
// 2937096768最新区块信息
最新区块信息包含 headerHash、height 和 timestamp，可以用于向用户显示同步信息
bitcoinKit.lastBlockInfo
// ▿ Optional<BlockInfo>
// ▿ some : BlockInfo
// - headerHash : //"00000000000041ae2164b486398415cca902a41214cad72291ee04b212bed4c4"
// - height : 1446751
// ▿ timestamp : Optional<Int>
// - some : 1544097931接收地址
获取一个您可以接收硬币的地址。在您实际收到交易（发送硬币到该地址）后，接收地址将每次更改
bitcoinKit.receiveAddress
// "mgv1KTzGZby57K5EngZVaPdPtphPmEWjiS"交易
套件具有 transactions(fromHash: nil, limit: nil) 方法，该方法返回 Single<TransactionInfo>（对于 BitcoinKit 和 BitcoinCashKit）和 Single<DashTransactionInfo>（对于 DashKit）RX 单符观察者。
TransactionInfo:
// ▿ TransactionInfo
// - transactionHash : "0f83c9b330f936dc4a2458b7d3bb06dce6647a521bf6d98f9c9d3cdd5f6d2a73"
// - transactionIndex : 500000
// ▿ from : 2 elements
// ▿ 0 : TransactionAddressInfo
// - address : "mft8jpnf3XwwqhaYSYMSXePFN85mGU4oBd"
// - mine : true
// ▿ 1 : TransactionAddressInfo
// - address : "mnNS5LEQDnYC2xqT12MnQmcuSvhfpem8gt"
// - mine : true
// ▿ to : 2 elements
// ▿ 0 : TransactionAddressInfo
// - address : "n43efNftHQ1cXYMZK4Dc53wgR6XgzZHGjs"
// - mine : false
// ▿ 1 : TransactionAddressInfo
// - address : "mrjQyzbX9SiJxRC2mQhT4LvxFEmt9KEeRY"
// - mine : true
// - amount : -800378
// ▿ blockHeight : Optional<Int>
// - some : 1446602
// ▿ timestamp : Optional<Int>
// - some : 1543995972DashTransactionInfo:
// ▿ DashTransactionInfo
// - transactionHash : "0f83c9b330f936dc4a2458b7d3bb06dce6647a521bf6d98f9c9d3cdd5f6d2a73"
// - transactionIndex : 500000
// - instantTx : true
// ▿ from : 2 elements
// ▿ 0 : TransactionAddressInfo
// - address : "mft8jpnf3XwwqhaYSYMSXePFN85mGU4oBd"
// - mine : true
// ▿ 1 : TransactionAddressInfo
// - address : "mnNS5LEQDnYC2xqT12MnQmcuSvhfpem8gt"
// - mine : true
// ▿ to : 2 elements
// ▿ 0 : TransactionAddressInfo
// - address : "n43efNftHQ1cXYMZK4Dc53wgR6XgzZHGjs"
// - mine : false
// ▿ 1 : TransactionAddressInfo
// - address : "mrjQyzbX9SiJxRC2mQhT4LvxFEmt9KEeRY"
// - mine : true
// - amount : -800378
// ▿ blockHeight : Optional<Int>
// - some : 1446602
// ▿ timestamp : Optional<Int>
// - some : 1543995972创建新交易
为了创建新交易，请在Kits上调用send(to: String, value: Int, feeRate: Int)方法。
try bitcoinKit.send(to: "mrjQyzbX9SiJxRC2mQhT4LvxFEmt9KEeRY", value: 1000000, feeRate: 10000)这首先验证了指定的地址和金额，创建新交易，然后将其发送到对等网络。如果地址/金额或网络存在问题，将引发异常。
发送前的交易验证
可以使用以下方法验证地址和费用：
try bitcoinKit.validate(address: "mrjQyzbX9SiJxRC2mQhT4LvxFEmt9KEeRY")
try bitcoinKit.fee(for: 1000000, toAddress: "mrjQyzbX9SiJxRC2mQhT4LvxFEmt9KEeRY", senderPay: true, feeRate: 10000)senderPay参数定义谁支付费用。
解析BIP21 URI
可以使用parse方法来解析一个BIP21 URI。
bitcoinKit.parse(paymentAddress: "bitcoin:175tWpb8K1S7NmH4Zx6rewF9WQrcZv245W?amount=50&label=Luke-Jr&message=Donation%20for%20project%20xyz")
// ▿ BitcoinPaymentData
// - address : "175tWpb8K1S7NmH4Zx6rewF9WQrcZv245W"
// - version : nil
// ▿ amount : Optional<Double>
// - some : 50.0
// ▿ label : Optional<String>
// - some : "Luke-Jr"
// ▿ message : Optional<String>
// - some : "Donation for project xyz"
// - parameters : nil
订阅BitcoinKit数据
Kits提供交易、区块、余额以及实时状态等数据。必须在Kits实例上实现并设置BitcoinCoreDelegate协议以接收这些数据。
class Manager {
init(words: [String]) {
bitcoinKit = BitcoinKit(withWords: words, walletId: "bitcoin-wallet-id")
bitcoinKit.delegate = self
}
}
extension Manager: BitcoinCoreDelegate {
func transactionsUpdated(inserted: [TransactionInfo], updated: [TransactionInfo]) {
}
func transactionsDeleted(hashes: [String]) {
}
func balanceUpdated(balance: Int) {
}
func lastBlockInfoUpdated(lastBlockInfo: BlockInfo) {
}
public func kitStateUpdated(state: BitcoinCore.KitState) {
// BitcoinCore.KitState can be one of 3 following states:
// .synced
// .syncing(progress: Double)
// .notSynced
//
// These states can be used to implement progress bar, etc
}
}监听器事件将在专用后台线程中运行。可以通过将delegateQueue属性设置为DispatchQueue.main来切换到主线程。
bitcoinKit.delegateQueue = DispatchQueue.main先决条件
- Xcode 10.0+
- Swift 5+
- iOS 11+
安装
CocoaPods
CocoaPods是一个用于Cocoa项目的依赖管理器。您可以使用以下命令安装它
$ gem install cocoapods构建BitcoinKit需要CocoaPods 1.5.0+。
要使用CocoaPods将BitcoinKit集成到您的Xcode项目中，请在您的Podfile中指定它
source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '10.0'
use_frameworks!
target '<Your Target Name>' do
pod 'BitcoinCore.swift'
pod 'BitcoinKit.swift'
pod 'BitcoinCashKit.swift'
pod 'DashKit.swift'
end然后，运行以下命令
$ pod install示例项目
示例项目中使用了该库的所有功能。它可以作为使用此库的起点。
依赖项
- HSHDWalletKit - 承担HD钱包相关功能，产生助记词。
- OpenSslKit.swift - 处理区块链所需的加密函数。
- Secp256k1Kit.swift - 处理区块链所需的加密函数。
Dash 依赖项
许可
BitcoinKit-iOS 工具包是开源的，并符合MIT许可证的条款。