BitcoinKit.swift 0.15.4

BitcoinKit.swift 0.15.4

×

由 Horizontal Systems 维护。

 
依赖
BitcoinCore.swift~> 0.15
Hodler.swift~> 0.15
OpenSslKit.swift~> 1.0
Secp256k1Kit.swift~> 1.0
HdWalletKit.swift~> 1.5
ObjectMapper~> 3.0
RxSwift~> 5.0
BigInt~> 5.0
GRDB.swift~> 4.0
 

BitcoinKit.swift 0.15.4

BitcoinKit-iOS

Bitcoin, BitcoinCash(ABC) 和 Dash 钱包工具包，Swift 语言编写。这是一个包含钱包创建/恢复、与网络同步、发送/接收交易等功能的 SPV 节点的完整实现。仓库包含主 BitcoinCore.swift 和 BitcoinKit.swift，以及 BitcoinCashKit.swift 和 DashKit.swift 独立 Pod。

特性

  • 全 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 锁定，主节点验证

使用方法

在本页中，我们使用 套件（Kits） 来指代以下套件之一：BitcoinKit.swift、BitcoinCashKit.swift 和 DashKit.swift。

初始化

套件（Kits） 在初始化时需要您提供助记词短语。

let words = ["word1", ... , "word12"]

Bitcoin

let bitcoinKit = BitcoinKit(withWords: words, walletId: "bitcoin-wallet-id", syncMode: .api, networkType: .mainNet)

Bitcoin Cash

let bitcoinCashKit = BitcoinCashKit(withWords: words, walletId: "bitcoin-cash-wallet-id", syncMode: .api, networkType: .mainNet)

Dash

let dashKit = DashKit(withWords: words, walletId: "dash-wallet-id", syncMode: .api, networkType: .mainNet)

这三个 套件（Kits） 都可以配置为在 .mainNet 或 .testNet 上运行。

syncMode 参数

工具包可以恢复现有的钱包或创建一个新的钱包。在恢复时，它根据 bip44 协议为给定的钱包生成地址，然后它为这些地址中的每一个拉取所有历史交易。这仅在初始同步时进行一次。syncMode 参数定义了它从哪里拉取历史交易。拉取之后，它将继续根据SPV 协议进行同步，无论初始同步使用了哪种同步模式。有三种模式可用

  • .full：从 bip44 介绍时的区块开始，通过点对点网络完全同步。此模式最私有（因为它完全符合SPV 协议），但同步到目前（2019 年 6 月 10 日）大约需要 2 小时。
  • .api：从 API（目前是 Insight API 或 BcoinAPI）拉取检查点之前的交易。然后从点对点网络同步剩余部分。这是最快的一个，但攻击者可能会了解到你拥有的地址。检查点在每个新版本中都会更新，并且是硬编码的，所以不会打破区块验证。
  • .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 Single观察者。

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 : 1543995972

DashTransactionInfo:

//   ▿ 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

创建新交易

为了创建新交易，在套件上调用send(to: String, value: Int, feeRate: Int)方法

try bitcoinKit.send(to: "mrjQyzbX9SiJxRC2mQhT4LvxFEmt9KEeRY", value: 1000000, feeRate: 10000)

此方法首先验证给定的地址和金额，创建新交易，然后通过网络 peers 发送。如果给定的地址/金额或网络有问题，则抛出异常。

在发送前验证交易

可以通过以下方法验证地址和费用

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数据

套件提供实时数据，例如交易、区块、余额、套件状态。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+。

要将BitcoinKit集成到您的Xcode项目中，并使用CocoaPods指定它，请在您的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

示例项目

示例项目中使用了该库的所有功能。可作为使用库的起点参考。

依赖项

Dash依赖项

许可证

BitcoinKit-iOS工具包是开源的，根据MIT许可证条款提供。