141 lines
4.1 KiB
Swift
141 lines
4.1 KiB
Swift
//
|
|
// LightWalletService.swift
|
|
// ZcashLightClientKit
|
|
//
|
|
// Created by Francisco Gindre on 12/09/2019.
|
|
// Copyright © 2019 Electric Coin Company. All rights reserved.
|
|
//
|
|
|
|
import Foundation
|
|
import GRPC
|
|
import SwiftProtobuf
|
|
|
|
/**
|
|
Wrapper for errors received from a Lightwalletd endpoint
|
|
*/
|
|
public enum LightWalletServiceError: Error {
|
|
case generalError(message: String)
|
|
case failed(statusCode: Int, message: String)
|
|
case invalidBlock
|
|
case sentFailed(error: Error)
|
|
case genericError(error: Error)
|
|
case timeOut
|
|
case criticalError
|
|
case userCancelled
|
|
case unknown
|
|
}
|
|
|
|
extension LightWalletServiceError: Equatable {
|
|
// swiftlint:disable cyclomatic_complexity
|
|
public static func == (lhs: Self, rhs: Self) -> Bool {
|
|
switch lhs {
|
|
case .generalError(let message):
|
|
switch rhs {
|
|
case .generalError(let msg):
|
|
return message == msg
|
|
default:
|
|
return false
|
|
}
|
|
case .failed(let statusCode, _):
|
|
switch rhs {
|
|
case .failed(let anotherStatus, _):
|
|
return statusCode == anotherStatus
|
|
default:
|
|
return false
|
|
}
|
|
|
|
case .invalidBlock:
|
|
switch rhs {
|
|
case .invalidBlock:
|
|
return true
|
|
default:
|
|
return false
|
|
}
|
|
case .sentFailed:
|
|
switch rhs {
|
|
case .sentFailed:
|
|
return true
|
|
default:
|
|
return false
|
|
}
|
|
case .genericError:
|
|
return false
|
|
|
|
case .timeOut:
|
|
switch rhs {
|
|
case .timeOut:
|
|
return true
|
|
default:
|
|
return false
|
|
}
|
|
case .criticalError:
|
|
switch rhs {
|
|
case .criticalError:
|
|
return true
|
|
default:
|
|
return false
|
|
}
|
|
case .userCancelled:
|
|
switch rhs {
|
|
case .userCancelled:
|
|
return true
|
|
default:
|
|
return false
|
|
}
|
|
case .unknown:
|
|
switch rhs {
|
|
case .unknown:
|
|
return true
|
|
default:
|
|
return false
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
public protocol LightWalletServiceResponse {
|
|
var errorCode: Int32 { get }
|
|
var errorMessage: String { get }
|
|
var unknownFields: SwiftProtobuf.UnknownStorage { get }
|
|
}
|
|
|
|
extension SendResponse: LightWalletServiceResponse {}
|
|
|
|
public protocol LightWalletService {
|
|
/// Returns the info for this lightwalletd server
|
|
func getInfo() async throws -> LightWalletdInfo
|
|
|
|
/// Return the latest block height known to the service.
|
|
/// Blocking API
|
|
func latestBlockHeight() throws -> BlockHeight
|
|
|
|
/// Return the latest block height known to the service.
|
|
func latestBlockHeightAsync() async throws -> BlockHeight
|
|
|
|
/// Return the given range of blocks.
|
|
/// - Parameter range: the inclusive range to fetch.
|
|
/// For instance if 1..5 is given, then every block in that will be fetched, including 1 and 5.
|
|
func blockRange(_ range: CompactBlockRange) -> AsyncThrowingStream<ZcashCompactBlock, Error>
|
|
|
|
/// Submits a raw transaction over lightwalletd. Non-Blocking
|
|
/// - Parameter spendTransaction: data representing the transaction to be sent
|
|
func submit(spendTransaction: Data) async throws -> LightWalletServiceResponse
|
|
|
|
/// Gets a transaction by id
|
|
/// - Parameter txId: data representing the transaction ID
|
|
/// - Throws: LightWalletServiceError
|
|
/// - Returns: LightWalletServiceResponse
|
|
func fetchTransaction(txId: Data) async throws -> TransactionEntity
|
|
|
|
func fetchUTXOs(for tAddress: String, height: BlockHeight) -> AsyncThrowingStream<UnspentTransactionOutputEntity, Error>
|
|
|
|
func fetchUTXOs(for tAddresses: [String], height: BlockHeight) -> AsyncThrowingStream<UnspentTransactionOutputEntity, Error>
|
|
|
|
func blockStream(
|
|
startHeight: BlockHeight,
|
|
endHeight: BlockHeight
|
|
) -> AsyncThrowingStream<ZcashCompactBlock, Error>
|
|
|
|
func closeConnection()
|
|
}
|