LitecoinKit.swift 0.15.4

LitecoinKit.swift 0.15.4

×

由 Horizontal Systems 维护。

 
依赖
BitcoinCore.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
 

LitecoinKit.swift 0.15.4

BitcoinKit-iOS

Swift 的 Bitcoin、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 现金地址

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 协议，它将继续根据 SPV 协议同步。有 3 种模式可供选择

  • .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

最后一块信息

最后一块信息包含 头部哈希、高度 和 时间戳，这些信息可用来向用户展示同步信息

bitcoinKit.lastBlockInfo 

// ▿ Optional<BlockInfo>
//  ▿ some : BlockInfo
//    - headerHash : //"00000000000041ae2164b486398415cca902a41214cad72291ee04b212bed4c4"
//    - height : 1446751
//    ▿ timestamp : Optional<Int>
//      - some : 1544097931

接收地址

获取一个可用于接收币的地址。每次您在本地址接收币后，接收地址将自动更改

bitcoinKit.receiveAddress

// "mgv1KTzGZby57K5EngZVaPdPtphPmEWjiS"

交易

工具包 有 transactions(fromHash: nil, limit: nil) 方法，它返回 Single（对于 BitcoinKit 和 BitcoinCashKit，和 Single（对于 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 : 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数据

工具包提供有关交易、区块、余额、工具包状态等数据的实时信息。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许可证。