EosioTransaction.swift

//
//  EosioTransaction.swift
//  EosioSwift
//
//  Created by Todd Bowden on 2/5/19.
//  Copyright (c) 2017-2019 block.one and its contributors. All rights reserved.
//

// swiftlint:disable line_length
import Foundation
import PromiseKit

/// Class for creating, preparing, signing, and (optionally) broadcasting transactions on EOSIO-based blockchains.
public class EosioTransaction: Codable {

    /// Chain ID in `String` format.
    public var chainId = ""
    /// Remote Procedure Call (RPC) provider for facilitating communication with blockchain nodes. Conforms to `EosioRpcProviderProtocol`.
    public var rpcProvider: EosioRpcProviderProtocol?
    /// Application Binary Interface (ABI) provider for facilitating the fetching and caching of ABIs from blockchain nodes. A default is provided. Conforms to `EosioAbiProviderProtocol`.
    public var abiProvider: EosioAbiProviderProtocol?
    /// Signature provider for facilitating the retrieval of available public keys and the signing of transactions. Conforms to `EosioSignatureProviderProtocol`.
    public var signatureProvider: EosioSignatureProviderProtocol?
    /// Serialization provider for facilitating ABI-driven transaction and action (de)serialization between JSON and binary data representations. Conforms to `EosioSerializationProviderProtocol`.
    public var serializationProvider: EosioSerializationProviderProtocol? {
        didSet {
            abis.serializationProvider = serializationProvider
        }
    }

    /// Transaction configuration.
    public var config = EosioTransaction.Config()
    /// Struct defining relative transaction configuration options and defaults.
    public struct Config {
        /// Number of blocks behind the head block for calculating transaction `ref_block_` properties.
        public var blocksBehind: UInt = 3
        /// Number of seconds behind the head block time for calculating transaction `expiration`.
        public var expireSeconds: UInt = 60 * 5
        /// Use the last irreversible block instead of `blocksBehind` from the current head block to calculate TAPOS.
        public var useLastIrreversible: Bool = true
    }
    /// Should signature providers be permitted to modify the transaction prior to signing? Defaults to `true`.
    public var allowSignatureProviderToModifyTransaction = true
    /// Manager of ABIs for actions in the transaction.
    public let abis = Abis()
    /// Transaction property: Time at which the transaction expires and can no longer be included in a block.
    public var expiration = Date(timeIntervalSince1970: 0)
    /// Transaction property: Reference block number. Helps prevent replay attacks.
    public var refBlockNum: UInt16 = 0
    /// Transaction property: Reference block prefix. Helps prevent replay attacks.
    public var refBlockPrefix: UInt64 = 0
    /// Transaction property: Network bandwidth billing limit.
    public var maxNetUsageWords: UInt = 0
    /// Transaction property: CPU time billing limit, in milliseconds.
    public var maxCpuUsageMs: UInt = 0
    /// Transaction property: Causes the transaction to be executed a specified number of seconds after being included in a block. It may be canceled during this delay.
    public var delaySec: UInt = 0
    /// Transaction property: Array of actions to be executed.
    public private(set) var actions = [Action]()
    /// Transaction property: Context Free Actions.
    public private(set) var contextFreeActions = [Action]()
    /// Context free data
    public var contextFreeData = [Data]()
    /// Serialized Context free data
    public private(set) var serializedContextFreeData = Data()
    /// Transaction property: Transaction Extensions.
    public var transactionExtensions = [String]()
    /// Transaction data serialized into a binary representation in preparation for broadcast.
    public private(set) var serializedTransaction: Data?
    /// Array of signatures.
    public private(set) var signatures: [String]?
    /// Transaction ID.
    public private(set) var transactionId: String?

    /// Combined array of actions and contextFreeActions.
    private var allActions: [Action] {
        return actions + contextFreeActions
    }

    /// Add an Action.
    ///
    /// - Parameters:
    ///   - action: The Action to add.
    ///   - at: An optional index at which to insert the Action. If not provided, the Action will be appended to the end of the actions array.
    public func add(action: Action, at: Int? = nil) {
        if let at = at {
            actions.insert(action, at: at)
        } else {
            actions.append(action)
        }
    }

    /// Add an array of Actions.
    /// - Parameter actions: The array of Actions to append.
    public func add(actions: [Action]) {
        self.actions.append(contentsOf: actions)
    }

    /// Add a context free Action.
    ///
    /// - Parameters:
    ///   - contextFreeAction: The context free Action to add.
    ///   - at: An optional index at which to insert the context free Action. If not provided, the Action will be appended to the end of the contextFreeActions array.
    public func add(contextFreeAction: Action, at: Int? = nil) {
        if let at = at {
            contextFreeActions.insert(contextFreeAction, at: at)
        } else {
            contextFreeActions.append(contextFreeAction)
        }
    }

    /// Add an array of context free Actions.
    /// - Parameter contextFreeActions: The array of context free Actions to append.
    public func add(contextFreeActions: [Action]) {
        self.contextFreeActions.append(contentsOf: contextFreeActions)
    }

    /// For encoding/decoding EosioTransaction <> JSON.
    enum CodingKeys: String, CodingKey {
        case expiration
        case refBlockNum = "ref_block_num"
        case refBlockPrefix = "ref_block_prefix"
        case maxNetUsageWords = "max_net_usage_words"
        case maxCpuUsageMs = "max_cpu_usage_ms"
        case delaySec = "delay_sec"
        case contextFreeActions = "context_free_actions"
        case actions
        case transactionExtensions = "transaction_extensions"
    }

    /// Initializes the class.
    public init() {  }

    /// Deserialize a serialized transaction and return an `EosioTransaction` object.
    ///
    /// - Parameters:
    ///   - serializedTransaction: A serialized transaction as Data.
    ///   - serializationProvider: A serialization provider. Will be used for transaction deserialization and set as the `serializationProvider` on the returned `EosioTransaction`.
    /// - Returns: An `EosioTransaction`.
    /// - Throws: If the transaction cannot be deserialized.
    static public func deserialize(_ serializedTransaction: Data, serializationProvider: EosioSerializationProviderProtocol) throws -> EosioTransaction {
        let json = try serializationProvider.deserializeTransaction(hex: serializedTransaction.hex)
        guard let data = json.data(using: .utf8) else {
            throw EosioError(.deserializeError, reason: "Cannot create json from data")
        }
        let jsonDecoder = JSONDecoder()
        jsonDecoder.dateDecodingStrategy = .formatted(Date.asTransactionTimestamp)
        let transaction = try jsonDecoder.decode(EosioTransaction.self, from: data)
        transaction.serializationProvider = serializationProvider
        return transaction
    }

    /// Serialize context free data
    /// - Parameter contextFreeData: array of context free data
    /// - Returns: The serialized context free data
    static public func serialize(contextFreeData: [Data]) -> Data {
        guard contextFreeData.count > 0 else {
            return Data()
        }
        var cfData = Data()
        cfData.append(Data.varUInt(UInt32(contextFreeData.count)))
        for i in 0..<contextFreeData.count {
            let data = contextFreeData[i]
            cfData.append(Data.varUInt(UInt32(data.count)))
            cfData.append(data)
        }
        return cfData
    }

    /// Returns an array of action accounts that do not have an abi in `abis`.
    public var actionAccountsMissingAbis: [EosioName] {
        let accounts = allActions.compactMap { (action) -> EosioName in
            return action.account
        }
        return abis.missingAbis(names: accounts)
    }

    /// Returns an array of unserialized actions.
    public var actionsWithoutSerializedData: [Action] {
        return allActions.filter { (action) -> Bool in
            !action.isDataSerialized
        }
    }

    /// Return this transaction as a json string with unserialized action data
    public var transactionAsJsonWithUnserializedActionData: String? {
        return transactionAsDictionary.jsonString
    }

    /// Return this transaction as a Dictionary. Action data will be unserialized.
    public var transactionAsDictionary: [String: Any] {
        var dictionary = [String: Any]()
        dictionary["expiration"] = expiration.yyyyMMddTHHmmss
        dictionary["ref_block_num"] = refBlockNum
        dictionary["ref_block_prefix"] = refBlockPrefix
        dictionary["max_net_usage_words"] = maxNetUsageWords
        dictionary["max_cpu_usage_ms"] = maxCpuUsageMs
        dictionary["delay_sec"] = delaySec
        dictionary["context_free_actions"] = contextFreeActions.compactMap({ (action) -> [String: Any]? in
            return action.actionAsDictionary
        })
        dictionary["actions"] = actions.compactMap({ (action) -> [String: Any]? in
            return action.actionAsDictionary
        })
        dictionary["transaction_extensions"] = transactionExtensions
        return dictionary
    }

    /// Encode the transaction as a json string. Properties will be snake_case. Action data will be serialized.
    ///
    /// - Parameter prettyPrinted: Should the json be pretty printed? (default = false)
    /// - Returns: The transaction as a json string.
    /// - Throws: If the transaction cannot be encoded to json.
    public func toJson(prettyPrinted: Bool = false) throws -> String {
        return try self.toJsonString(convertToSnakeCase: true, prettyPrinted: prettyPrinted)
    }

    /// Serializes the transaction and returns a `Data` object. Serializing a transaction requires the `serializedData` property for all the actions to have a value and the TAPOS properties
    /// (`refBlockNum`, `refBlockPrefix`, `expiration`) to have valid values. If the necessary data is not known to be set, call the asynchronous version of this method, which will attempt to
    /// get the necessary data first.
    ///
    /// - Returns: A `Data` object representing the serialized transaction.
    /// - Throws: If any of the necessary data is missing or transaction cannot be serialized.
    public func serializeTransaction() throws -> Data {
        try serializeActionData()
        guard refBlockNum > 0 else {
            throw EosioError(.serializeError, reason: "refBlockNum is not set")
        }
        guard refBlockPrefix > 0 else {
            throw EosioError(.serializeError, reason: "refBlockPrefix is not set")
        }
        guard expiration > Date(timeIntervalSince1970: 0) else {
            throw EosioError(.serializeError, reason: "expiration is not set")
        }
        guard let serializer = self.serializationProvider else {
            preconditionFailure("A serializationProvider must be set!")
        }
        let json = try self.toJson()
        return try Data(hex: serializer.serializeTransaction(json: json))
    }

    /// Asynchronous version of serializeTransaction that calls `prepare(completion:)` before attemping to create a serialized transaction. If an error is encountered, this method will call the
    /// completion with that error. Otherwise, the completion will be called with a serialized transaction.
    ///
    /// - Parameter completion: Called with an `EosioResult` consisting of `Data` for success and an optional `EosioError`.
    public func serializeTransaction(completion: @escaping (EosioResult<Data, EosioError>) -> Void) {
        prepare { [weak self] (result) in
            guard let strongSelf = self else {
                return completion(.failure(EosioError(.unexpectedError, reason: "self does not exist")))
            }
            switch result {
            case .failure(let error):
                completion(.failure(error))
            case .success:
                do {
                    let serializedTransaction = try strongSelf.serializeTransaction()
                    return completion(.success(serializedTransaction))
                } catch {
                    return completion(.failure(error.eosioError))
                }
            }
        }
    }

    /// Prepares the transaction, fetching or calculating any needed values by calling `calculateExpiration()`, `getChainIdAndCalculateTapos(completion:)`, and `serializeActionData(completion:)`.
    /// If any of these methods returns an error, this method will call the completion with that error.
    ///
    /// - Parameter completion: Called with an `EosioResult` consisting of a `Bool` for success and an optional `EosioError`.
    public func prepare(completion: @escaping (EosioResult<Bool, EosioError>) -> Void) {

        getInfoAndSetValues { [weak self] (taposResult) in
            switch taposResult {
            case .failure(let error):
                completion(.failure(error))
            case .success:
                guard let strongSelf = self else {
                    return completion(.failure(EosioError(.unexpectedError, reason: "self does not exist")))
                }
                strongSelf.serializeActionData(completion: completion)
            }
        }
    }

    /// Serializes the `data` property of each action in `actions` and sets the `serializedData` property for each action, if not already set. Serializing the action data requires ABIs to be available in
    /// the `abis` class for all the contracts in the actions. If the necessary ABIs are not known to be available, call the asynchronous version of this method, which will attempt to get the ABIs first.
    ///
    /// - Throws: If any required abis are not available, or the action `data` cannot be serialized.
    public func serializeActionData() throws {
        guard actionsWithoutSerializedData.count > 0 else { return }
        let missingAbis = actionAccountsMissingAbis
        guard missingAbis.count == 0 else {
            throw EosioError(.serializeError, reason: "Cannot serialize action data. Abis missing for \(missingAbis).")
        }
        guard let serializer = self.serializationProvider else {
            preconditionFailure("A serializationProvider must be set!")
        }
        for action in allActions {
            try action.serializeData(abi: abis.jsonAbi(name: action.account), serializationProvider: serializer)
        }
    }

    /// Calls `getABIs(completion:)` before attemping to serialize the actions data by calling `serializeActionData()`. If `getABIs(completion:)` returns an error, this method will call the completion with
    /// that error. If `serializeActionData()` throws an error, the completion will be called with that error. If all action data is successfully serialized, the completion will be called with `true`.
    ///
    /// - Parameter completion: Called with an `EosioResult` consisting of a `Bool` for success and an optional `EosioError`.
    public func serializeActionData(completion: @escaping (EosioResult<Bool, EosioError>) -> Void) {
        guard actionsWithoutSerializedData.count > 0 else {
            return completion(.success(true))
        }
        getAbis { [weak self] (abisResult) in
            guard let strongSelf = self else {
                return completion(.failure(EosioError(.unexpectedError, reason: "self does not exist")))
            }
            switch abisResult {
            case .failure(let error):
                completion(.failure(error))
            case .success:
                do {
                    try strongSelf.serializeActionData()
                    return completion(.success(true))
                } catch {
                    return completion(.failure(error.eosioError))
                }
            }
        }
    }

    /// Deserializes the `serializedData` property of each action in `actions` and sets the `data` property for each action, if not already set. Deserializing the action data requires an ABI to be available in
    /// the `abis` class for the action.
    ///
    /// - Parameter exclude: Don't deserialize these actions.
    /// - Throws: If any required abis are not available, or the action data cannot be deserialized.
    public func deserializeActionData(exclude: [EosioName] = []) throws {
        guard let serializer = self.serializationProvider else {
            preconditionFailure("A serializationProvider must be set!")
        }
        for action in allActions {
            if !exclude.contains(action.account) {
                try action.deserializeData(abi: abis.jsonAbi(name: action.account), serializationProvider: serializer)
            }
        }
    }

    /// Gets ABIs for every contract in the actions using the `abiProvider` and adds them to `abis`. If ABIs are already present for all contracts, this method will not need to use the `abiProvider` and will
    /// immediately call the completion with `true`. If the `abiProvider` is not set but the `rpcProvider` is, an `EosioAbiProvider` instance will be created using the `rpcProvider` and set as the `abiProvider`.
    /// If the ABIs are not present and the `abiProvider` is not set or `abiProvider` cannot get some of the requested ABIs, an error is returned. If all ABIs are successfully set, this method will call the
    /// completion with `true`.
    ///
    /// - Parameter completion: Called with an `EosioResult` consisting of a `Bool` for success and an optional `EosioError`.
    public func getAbis(completion: @escaping (EosioResult<Bool, EosioError>) -> Void) {
        let missingAbis = actionAccountsMissingAbis
        // if no missing ABIs, return now
        if missingAbis.count == 0 {
            return completion(.success(true))
        }
        // if abiProvider is not set but rpcProvider is, init the default abiProvider with the rpcProvider
        if let rpcProvider = self.rpcProvider, self.abiProvider == nil {
            self.abiProvider = EosioAbiProvider(rpcProvider: rpcProvider)
        }
        guard let abiProvider = self.abiProvider else {
            return completion(.failure(EosioError(.eosioTransactionError, reason: "No abi provider available but missing abis for \(missingAbis)")))
        }
        guard chainId != "" else {
            return completion(.failure(EosioError(.eosioTransactionError, reason: "Chain id is not set")))
        }
        abiProvider.getAbis(chainId: chainId, accounts: missingAbis) { [weak self] (response) in
            guard let strongSelf = self else {
                return completion(.failure(EosioError(.unexpectedError, reason: "self does not exist")))
            }
            switch response {
            case .failure(let error):
                completion(.failure(error))
            case .success(let abiDictionary):
                do {
                    for (account, abi) in abiDictionary {
                        try strongSelf.abis.addAbi(name: account, data: abi)
                    }
                    return completion(.success(true))
                } catch {
                    return completion(.failure(error.eosioError))
                }
            }
        }
    }

    /// Gets chain info and sets the `chainId` and `expiration`. Then calculates the reference block number using the using the `config` property and calls `getBlockAndSetTapos(blockNum:, completion:)`.
    /// If the `chainId` is already set, this method will validate against the `chainId` retreived from the `rpcProvider` and return an error if they do not match.
    ///
    /// - Parameter completion: Called with an `EosioResult` consisting of a `Bool` for success and an optional `EosioError`.
    private func getInfoAndSetValues(completion: @escaping (EosioResult<Bool, EosioError>) -> Void) {

        // if all the data is set, just return true
        if refBlockNum > 0 && refBlockPrefix > 0  && chainId != "" && expiration > Date(timeIntervalSince1970: 0) {
            return completion(.success(true))
        }

        // if no rpcProvider available, return error
        guard let rpcProvider = rpcProvider else {
            return completion(.failure(EosioError(.eosioTransactionError, reason: "No rpc provider available")))
        }

        // get chain info
        rpcProvider.getInfoBase { [weak self] (infoResponse) in
            guard let strongSelf = self else {
                return completion(.failure(EosioError(.getInfoError, reason: "self does not exist")))
            }
            switch infoResponse {
            case .failure(let error):
                completion(.failure(error))
            case .success(let info):
                if strongSelf.chainId == "" {
                    strongSelf.chainId = info.chainId
                }
                // return an error if provided chainId does not match info chainId
                guard strongSelf.chainId == info.chainId else {
                    return completion(.failure(EosioError(.eosioTransactionError, reason: "Provided chain id \(strongSelf.chainId) does not match chain id \(info.chainId)")))
                }

                // if expiration not set, set by adding config.expireSeconds to head block time
                if strongSelf.expiration <= Date(timeIntervalSince1970: 0) {
                    guard let headBlockTime = Date(yyyyMMddTHHmmss: info.headBlockTime) else {
                        return completion(.failure(EosioError(.eosioTransactionError, reason: "Invalid head block time \(info.headBlockTime)")))
                    }
                    strongSelf.expiration = headBlockTime.addingTimeInterval(TimeInterval(strongSelf.config.expireSeconds))
                }

                // Default to using last irreversiable block
                var blockNum = info.lastIrreversibleBlockNum.value
                
                if strongSelf.config.useLastIrreversible == false {
                    let blocksBehind = UInt64(strongSelf.config.blocksBehind)
                    blockNum = info.headBlockNum.value - blocksBehind
                    if blockNum <= 0 {
                        blockNum = 1
                    }
                }
                strongSelf.getBlockAndSetTapos(blockNum: blockNum, completion: completion)
            }
        }
    }

    /// Gets the block specified by `blockNum` and sets `refBlockNum` and `refBlockPrefix`. If `refBlockNum` and `refBlockPrefix` already have valid values, this method will call the completion with `true`.
    /// If these properties do not have valid values, this method will require an `rpcProvider` to get the data for these values. If the `rpcProvider` is not set or another error is encountered, this method
    /// will call the completion with an error.
    ///
    /// - Parameters:
    ///   - blockNum: The block number serving as the basis for TAPOS calculations.
    ///   - completion: Called with an `EosioResult` consisting of a `Bool` for success and an optional `EosioError`.
    public func getBlockAndSetTapos(blockNum: UInt64, completion: @escaping (EosioResult<Bool, EosioError>) -> Void) {
        // if the only data needed was the chainId, return now
        if self.refBlockPrefix > 0 && self.refBlockNum > 0 {
            return completion(.success(true))
        }
        // if no rpcProvider available, return error
        guard let rpcProvider = rpcProvider else {
            return completion(.failure(EosioError(.eosioTransactionError, reason: "No rpc provider available")))
        }

        let requestParameters = EosioRpcBlockInfoRequest(blockNum: blockNum)

        rpcProvider.getBlockInfoBase(requestParameters: requestParameters, completion: { [weak self] (blockResponse) in
            guard let strongSelf = self else {
                return completion(.failure(EosioError(.getBlockError, reason: "self does not exist")))
            }
            switch blockResponse {
            case .failure(let error):
                completion(.failure(error))
            case .success(let block):
                // set tapos fields and return
                strongSelf.refBlockNum = UInt16(block.blockNum.value & 0xffff)
                strongSelf.refBlockPrefix = block.refBlockPrefix.value
                return completion(.success(true))
            }
        })
    }

    /// Signs a transaction by getting the available keys from the `signatureProvider` and calling `sign(availableKeys:, completion:)`.
    ///
    /// - Parameter:
    ///   - prompt: Prompt to present with biometrics authentication, if required.
    ///   - completion: Called with an `EosioResult` consisting of a `Bool` for success and an optional `EosioError`.
    public func sign(prompt: String = "Sign Transaction", completion: @escaping (EosioResult<Bool, EosioError>) -> Void) {
        guard let signatureProvider = signatureProvider else {
            return completion(.failure(EosioError(.signatureProviderError, reason: "No signature provider available")))
        }
        signatureProvider.getAvailableKeys { [weak self] (response) in
            guard let availableKeys = response.keys else {
                return completion(.failure(response.error ?? EosioError(.signatureProviderError, reason: "Unable to get available keys from signature provider")))
            }
            guard let strongSelf = self else {
                return completion(.failure(EosioError(.unexpectedError, reason: "self does not exist")))
            }
            strongSelf.sign(availableKeys: availableKeys, prompt: prompt, completion: completion)
        }
    }

    /// Signs a transaction by preparing the transaction and calling `signPreparedTransaction(availableKeys:, completion:)`.
    ///
    /// - Parameters:
    ///   - availableKeys: An array of public key strings that correspond to the private keys availble for signing.
    ///   - prompt: Prompt to present with biometrics authentication, if required.
    ///   - completion: Called with an `EosioResult` consisting of a `Bool` for success and an optional `EosioError`.
    public func sign(availableKeys: [String], prompt: String = "Sign Transaction", completion: @escaping (EosioResult<Bool, EosioError>) -> Void) {
        prepare { [weak self] (result) in
            guard let strongSelf = self else {
                return completion(.failure(EosioError(.unexpectedError, reason: "self does not exist")))
            }
            switch result {
            case .failure(let error):
                completion(.failure(error))
            case .success:
                strongSelf.signPreparedTransaction(availableKeys: availableKeys, prompt: prompt, completion: completion)
            }
        }
    }

    /// Signs a transaction by getting the required keys using the `rpcProvider` and calling `sign(publicKeys:, completion:)`.
    ///
    /// - Parameters:
    ///   - availableKeys: An array of public key strings that correspond to the private keys availble for signing.
    ///   - prompt: Prompt to present with biometrics authentication, if required.
    ///   - completion: Called with an `EosioResult` consisting of a `Bool` for success and an optional `EosioError`.
    private func signPreparedTransaction(availableKeys: [String], prompt: String, completion: @escaping (EosioResult<Bool, EosioError>) -> Void) {
        guard let rpcProvider = rpcProvider else {
            return completion(.failure(EosioError(.signatureProviderError, reason: "No rpc provider available")))
        }
        let requiredKeysRequest = EosioRpcRequiredKeysRequest(availableKeys: availableKeys, transaction: self)
        rpcProvider.getRequiredKeysBase(requestParameters: requiredKeysRequest) { (response) in
            switch response {
            case .failure(let error):
                completion(.failure(error))
            case .success(let requiredKeys):
                self.sign(publicKeys: requiredKeys.requiredKeys, prompt: prompt, completion: completion)
            }
        }
    }

    /// Serializes the transaction and then signs with the private keys corresponding to the passed-in public keys. If successful, sets the `signatures` and returns `true`. Otherwise returns an error.
    ///
    /// - Parameters:
    ///   - publicKeys: An array of public key strings that correspond to the private keys to sign the transaction with.
    ///   - prompt: Prompt to present with biometric authentication if required.
    ///   - completion: Called with an `EosioResult` consisting of a `Bool` for success and an optional `EosioError`.
    public func sign(publicKeys: [String], prompt: String = "Sign Transaction", completion: @escaping (EosioResult<Bool, EosioError>) -> Void) {
        self.serializeTransaction { [weak self] (result) in
            guard let strongSelf = self else {
                return completion(.failure(EosioError(.unexpectedError, reason: "self does not exist")))
            }
            switch result {
            case .failure(let error):
                completion(.failure(error))
            case .success(let serializedTransaction):
                strongSelf.sign(serializedTransaction: serializedTransaction, publicKeys: publicKeys, prompt: prompt, completion: completion)
            }
        }
    }

    /// Signs the passed-in `serializedTransaction` with the private keys corresponding to the provided public keys. If successful, sets the `signatures` and returns `true`. Otherwise returns an error.
    ///
    /// - Parameters:
    ///   - serializedTransaction: The serialized transaction as `Data`.
    ///   - publicKeys: An array of public key strings that correspond to the private keys to sign the transaction with.
    ///   - prompt: Prompt to present with biometric authentication if required.
    ///   - completion: Called with an `EosioResult` consisting of a `Bool` for success and an optional `EosioError`.
    private func sign(serializedTransaction: Data, publicKeys: [String], prompt: String, completion: @escaping (EosioResult<Bool, EosioError>) -> Void) {
        guard let signatureProvider = signatureProvider else {
            return completion(.failure(EosioError(.signatureProviderError, reason: "No signature provider available")))
        }
        serializedContextFreeData = EosioTransaction.serialize(contextFreeData: contextFreeData)
        var transactionSignatureRequest = EosioTransactionSignatureRequest()
        transactionSignatureRequest.serializedTransaction = serializedTransaction
        transactionSignatureRequest.serializedContextFreeData = serializedContextFreeData
        transactionSignatureRequest.publicKeys = publicKeys
        transactionSignatureRequest.chainId = self.chainId
        var binaryAbis = [EosioTransactionSignatureRequest.BinaryAbi]()
        for (name, hexAbi) in abis.hexAbis() {
            var binaryAbi = EosioTransactionSignatureRequest.BinaryAbi()
            binaryAbi.accountName = name.string
            binaryAbi.abi = hexAbi
            binaryAbis.append(binaryAbi)
        }
        transactionSignatureRequest.abis = binaryAbis

        signatureProvider.signTransaction(request: transactionSignatureRequest, prompt: prompt) { [weak self] (transactionSignatureResponse) in
            guard let strongSelf = self else {
                return completion(.failure(EosioError(.unexpectedError, reason: "self does not exist")))
            }
            guard let signedTransaction = transactionSignatureResponse.signedTransaction else {
                return completion(.failure(transactionSignatureResponse.error ?? EosioError(.signatureProviderError, reason: "Signature provider error")))
            }
            strongSelf.process(signedTransaction: signedTransaction, originalSerializedTransaction: serializedTransaction, completion: completion)
        }
    }

    /// Process a signed transaction. If the transaction has been modified by the signature provider, it deserializes the signed transaction and updates/sets the `EosioTransaction` properties. If the
    /// original transaction was set to disallow modifications by the signature provider, an error is returned instead.
    ///
    /// - Parameters:
    ///   - signedTransaction: A signed transaction.
    ///   - originalSerializedTransaction: The original serialized transaction, as `Data`.
    ///   - completion: Called with an `EosioResult` consisting of a `Bool` for success and an optional `EosioError`.
    private func process(signedTransaction: EosioTransactionSignatureResponse.SignedTransaction, originalSerializedTransaction: Data, completion: @escaping (EosioResult<Bool, EosioError>) -> Void) {
        if signedTransaction.serializedTransaction == originalSerializedTransaction && signedTransaction.serializedContextFreeData == self.serializedContextFreeData {
            self.serializedTransaction = signedTransaction.serializedTransaction
            self.signatures = signedTransaction.signatures
            return completion(.success(true))
        }

        guard allowSignatureProviderToModifyTransaction else {
            return completion(.failure(EosioError(.signatureProviderError, reason: "Signature provider is not allowed to modify transaction")))
        }

        // deserialize the signed transaction and set properties
        guard let serializer = self.serializationProvider else {
            preconditionFailure("A serializationProviderType must be set!")
        }
        do {
            let modifiedTransaction = try EosioTransaction.deserialize(signedTransaction.serializedTransaction, serializationProvider: serializer)
            // update properties to match deserialized modified transaction
            self.expiration = modifiedTransaction.expiration
            self.refBlockNum = modifiedTransaction.refBlockNum
            self.refBlockPrefix = modifiedTransaction.refBlockPrefix
            self.maxNetUsageWords = modifiedTransaction.maxNetUsageWords
            self.maxCpuUsageMs = modifiedTransaction.maxCpuUsageMs
            self.delaySec = modifiedTransaction.delaySec
            self.contextFreeActions = modifiedTransaction.contextFreeActions
            self.actions = modifiedTransaction.actions
            self.transactionExtensions = modifiedTransaction.transactionExtensions

            // set the serializedTransaction and signatures
            self.serializedTransaction = signedTransaction.serializedTransaction
            self.serializedContextFreeData = signedTransaction.serializedContextFreeData
            self.signatures = signedTransaction.signatures
            return completion(.success(true))
        } catch {
            return completion(.failure(error.eosioError))
        }

    }

    /// Broadcasts a signed transaction. If successful, sets the `transactionId` and returns `true`. Otherwise returns an error.
    ///
    /// - Parameter completion: Called with an `EosioResult` consisting of a `Bool` for success and an optional `EosioError`.
    public func broadcast(completion: @escaping (EosioResult<Bool, EosioError>) -> Void) {
        guard let serializedTransaction = serializedTransaction, let signatures = signatures, signatures.count > 0 else {
            return completion(.failure(EosioError(.eosioTransactionError, reason: "Transaction must be signed before broadcast")))
        }
        guard let rpcProvider = rpcProvider else {
            return completion(.failure(EosioError(.eosioTransactionError, reason: "No rpc provider available")))
        }
        var sendTransactionRequest = EosioRpcSendTransactionRequest()
        sendTransactionRequest.packedTrx = serializedTransaction.hex
        sendTransactionRequest.signatures = signatures
        sendTransactionRequest.packedContextFreeData = serializedContextFreeData.hex
        rpcProvider.sendTransactionBase(requestParameters: sendTransactionRequest) { [weak self] (response) in
            guard let strongSelf = self else {
                return completion(.failure(EosioError(.unexpectedError, reason: "self does not exist")))
            }
            switch response {
            case .failure(let error):
                completion(.failure(error))
            case .success(let pushTransactionResponse):
                strongSelf.transactionId = pushTransactionResponse.transactionId
                let returnActionValues = pushTransactionResponse.returnActionValues()
                print("Action Return Values: \(String(describing: returnActionValues))")
                strongSelf.actions.enumerated().forEach { (index, action) in
                    if returnActionValues.indices.contains(index) {
                        action.returnValue = returnActionValues[index]
                    }
                }
                return completion(.success(true))
            }
        }
    }

    /// Signs a transaction and then broadcasts it.
    ///
    /// - Parameter completion: Called with an `EosioResult` consisting of a `Bool` for success and an optional `EosioError`.
    public func signAndBroadcast(completion: @escaping (EosioResult<Bool, EosioError>) -> Void) {
        sign { [weak self] (result) in
            guard let strongSelf = self else {
                return completion(.failure(EosioError(.unexpectedError, reason: "self does not exist")))
            }
            switch result {
            case .failure(let error):
                completion(.failure(error))
            case .success:
                strongSelf.broadcast(completion: completion)
            }
        }
    }

}