dashkit.swift 0.15.2

dashkit.swift 0.15.2

×

由 Horizontal Systems 保持。

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

dashkit.swift 0.15.2

BitcoinKit-iOS

Bitcoin、BitcoinCash(ABC) 及 dash 钱包工具包，用 Swift 实现，包括钱包的创建/恢复、与网络的同步、发送/接收交易等功能。仓库包含了主要的 BitcoinCore.swift 和 BitcoinKit.swift，BitcoinCashKit.swift 和 dashkit.swift 独立的 pods。

特性

  • 完整的 SPV 实现以提供快速的移动性能
  • 发送/接收 Legacy 交易（P2PKH、P2PK、P2SH）
  • BIP32 层次确定性钱包实现。
  • BIP39 随机代码，用于生成确定性密钥。
  • BIP44 确定性钱包的多账户层次结构。
  • BIP21 URI 方案，包括付款地址、金额、标签和其他参数

BitcoinKit.swift

  • 发送/接收 Segwit 交易（P2WPKH）
  • 发送/接收与旧钱包兼容的 Segwit 交易（P2WPKH-SH）
  • base58, bech32

BitcoinCashKit.swift

  • bech32 现金地址

DashKit.swift

  • 即时发送
  • LLMQ 锁，主节点验证

使用方法

在本页中，我们将用 套件 来指代以下任何一个 BitcoinKit.swift、BitcoinCashKit.swift 和 DashKit.swift 套件。

初始化

套件 需要在初始化时提供助记词。

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)

所有3个套件都可以配置在.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()

获取钱包数据

套件包含与区块链网络交互所需的所有数据

当前余额

余额以 Satoshi 为单位提供

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 Observers。

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)

这首先验证了给定的地址和金额，创建了新交易，然后将其发送到对等网络。如果给定的地址/金额或网络有问题，它将引发异常。

发送前验证交易

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

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协议并将其设置到Kits实例，以便接收这些数据。

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

示例项目

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

依赖项

Dash 依赖

许可

BitcoinKit-iOS 工具箱是开源的，可在 MIT 许可证 的条款下使用。