Merge pull request #508 from mloit/feature/late-lint-fixups

Author: yaroslavyaroslav

Sources/web3swift/Contract/EthereumContract.swift

@@ -33,7 +33,7 @@ public struct EthereumContract: ContractProtocol {
         var toReturn = [String: ABI.Element]()
         for m in self._abi {
             switch m {
-            case .function(let function): 
+            case .function(let function):
                 guard let name = function.name else {continue}
                 toReturn[name] = m
             default:
@@ -50,7 +50,7 @@ public struct EthereumContract: ContractProtocol {
                 break
             }
             switch m {
-            case .constructor(_): 
+            case .constructor(_):
                 toReturn = m
                 break
             default:
@@ -68,10 +68,10 @@ public struct EthereumContract: ContractProtocol {
         var toReturn = [String: ABI.Element.Event]()
         for m in self._abi {
             switch m {
-            case .event(let event): 
+            case .event(let event):
                 let name = event.name
                 toReturn[name] = event
-            default: 
+            default:
                 continue
             }
         }

Sources/web3swift/EthereumABI/ABIElements.swift

@@ -1,7 +1,7 @@
-// 
+//
 //  Created by Alex Vlasov on 25/10/2018.
 //  Copyright © 2018 Alex Vlasov. All rights reserved.
-// 
+//
 
 import Foundation
 import BigInt

Sources/web3swift/EthereumABI/ABIEncoding.swift

@@ -1,7 +1,7 @@
-// 
+//
 //  Created by Alex Vlasov on 25/10/2018.
 //  Copyright © 2018 Alex Vlasov. All rights reserved.
-// 
+//
 
 import Foundation
 import BigInt

Sources/web3swift/Web3/Web3+Contract.swift

@@ -17,7 +17,7 @@ extension web3 {
     /// Web3 instance bound contract instance.
     public class web3contract {
         var contract: EthereumContract
-        var web3 : web3
+        var web3: web3
         public var transactionOptions: TransactionOptions? = nil
 
         /// Initialize the bound contract instance by supplying the Web3 provider bound object, ABI, Ethereum address and some default

Sources/web3swift/Web3/Web3+Eth.swift

@@ -1,8 +1,8 @@
 //  web3swift
-// 
+//
 //  Created by Alex Vlasov.
 //  Copyright © 2018 Alex Vlasov. All rights reserved.
-// 
+//
 
 import Foundation
 import BigInt
@@ -11,12 +11,12 @@ extension web3.Eth {
 
     /// Send an EthereumTransaction object to the network. Transaction is either signed locally if there is a KeystoreManager
     /// object bound to the web3 instance, or sent unsigned to the node. For local signing the password is required.
-    /// 
+    ///
     /// "options" object can override the "to", "gasPrice", "gasLimit" and "value" parameters is pre-formed transaction.
     /// "from" field in "options" is mandatory for both local and remote signing.
-    /// 
+    ///
     /// This function is synchronous!
-    /// 
+    ///
     /// Returns the Result object that indicates either success of failure.
     public func sendTransaction(_ transaction: EthereumTransaction, transactionOptions: TransactionOptions, password: String = "web3swift") throws -> TransactionSendingResult {
         let result = try self.sendTransactionPromise(transaction, transactionOptions: transactionOptions, password: password).wait()
@@ -27,78 +27,78 @@ extension web3.Eth {
     /// Does NOT decode the data returned from the smart-contract.
     /// "options" object can override the "to", "gasPrice", "gasLimit" and "value" parameters is pre-formed transaction.
     /// "from" field in "options" is mandatory for both local and remote signing.
-    /// 
+    ///
     /// "onString" field determines if value is returned based on the state of a blockchain on the latest mined block ("latest")
     /// or the expected state after all the transactions in memory pool are applied ("pending").
-    /// 
+    ///
     /// This function is synchronous!
-    /// 
+    ///
     /// Returns the Result object that indicates either success of failure.
     func call(_ transaction: EthereumTransaction, transactionOptions: TransactionOptions) throws -> Data {
         let result = try self.callPromise(transaction, transactionOptions: transactionOptions).wait()
         return result
     }
 
     /// Send raw Ethereum transaction data to the network.
-    /// 
+    ///
     /// This function is synchronous!
-    /// 
+    ///
     /// Returns the Result object that indicates either success of failure.
     public func sendRawTransaction(_ transaction: Data) throws -> TransactionSendingResult {
         let result = try self.sendRawTransactionPromise(transaction).wait()
         return result
     }
 
     /// Send raw Ethereum transaction data to the network by first serializing the EthereumTransaction object.
-    /// 
+    ///
     /// This function is synchronous!
-    /// 
+    ///
     /// Returns the Result object that indicates either success of failure.
     public func sendRawTransaction(_ transaction: EthereumTransaction) throws -> TransactionSendingResult {
         let result = try self.sendRawTransactionPromise(transaction).wait()
         return result
     }
 
     /// Returns a total number of transactions sent by the particular Ethereum address.
-    /// 
+    ///
     /// "onBlock" field determines if value is returned based on the state of a blockchain on the latest mined block ("latest")
     /// or the expected state after all the transactions in memory pool are applied ("pending").
-    /// 
+    ///
     /// This function is synchronous!
-    /// 
+    ///
     /// Returns the Result object that indicates either success of failure.
     public func getTransactionCount(address: EthereumAddress, onBlock: String = "latest") throws -> BigUInt {
         let result = try self.getTransactionCountPromise(address: address, onBlock: onBlock).wait()
         return result
     }
 
     /// Returns a balance of particular Ethereum address in Wei units (1 ETH = 10^18 Wei).
-    /// 
+    ///
     /// "onString" field determines if value is returned based on the state of a blockchain on the latest mined block ("latest")
     /// or the expected state after all the transactions in memory pool are applied ("pending").
-    /// 
+    ///
     /// This function is synchronous!
-    /// 
+    ///
     /// Returns the Result object that indicates either success of failure.
     public func getBalance(address: EthereumAddress, onBlock: String = "latest") throws -> BigUInt {
         let result = try self.getBalancePromise(address: address, onBlock: onBlock).wait()
         return result
     }
 
     /// Returns a block number of the last mined block that Ethereum node knows about.
-    /// 
+    ///
     /// This function is synchronous!
-    /// 
+    ///
     /// Returns the Result object that indicates either success of failure.
     public func getBlockNumber() throws -> BigUInt {
         let result = try self.getBlockNumberPromise().wait()
         return result
     }
 
     /// Returns a current gas price in the units of Wei. The node has internal algorithms for averaging over the last few blocks.
-    /// 
+    ///
     /// This function is synchronous!
-    /// 
+    ///
     /// Returns the Result object that indicates either success of failure.
     public func getGasPrice() throws -> BigUInt {
         let result = try self.getGasPricePromise().wait()
@@ -107,9 +107,9 @@ extension web3.Eth {
 
     /// Returns transaction details for particular transaction hash. Details indicate position of the transaction in a particular block,
     /// as well as original transaction details such as value, gas limit, gas price, etc.
-    /// 
+    ///
     /// This function is synchronous!
-    /// 
+    ///
     /// Returns the Result object that indicates either success of failure.
     public func getTransactionDetails(_ txhash: Data) throws -> TransactionDetails {
         let result = try self.getTransactionDetailsPromise(txhash).wait()
@@ -118,9 +118,9 @@ extension web3.Eth {
 
     /// Returns transaction details for particular transaction hash. Details indicate position of the transaction in a particular block,
     /// as well as original transaction details such as value, gas limit, gas price, etc.
-    /// 
+    ///
     /// This function is synchronous!
-    /// 
+    ///
     /// Returns the Result object that indicates either success of failure.
     public func getTransactionDetails(_ txhash: String) throws -> TransactionDetails {
         let result = try self.getTransactionDetailsPromise(txhash).wait()
@@ -129,9 +129,9 @@ extension web3.Eth {
 
     /// Returns transaction receipt for particular transaction hash. Receipt indicate what has happened when the transaction
     /// was included in block, so it contains logs and status, such as succesful or failed transaction.
-    /// 
+    ///
     /// This function is synchronous!
-    /// 
+    ///
     /// Returns the Result object that indicates either success of failure.
     public func getTransactionReceipt(_ txhash: Data) throws -> TransactionReceipt {
         let result = try self.getTransactionReceiptPromise(txhash).wait()
@@ -140,9 +140,9 @@ extension web3.Eth {
 
     /// Returns transaction receipt for particular transaction hash. Receipt indicate what has happened when the transaction
     /// was included in block, so it contains logs and status, such as succesful or failed transaction.
-    /// 
+    ///
     /// This function is synchronous!
-    /// 
+    ///
     /// Returns the Result object that indicates either success of failure.
     public func getTransactionReceipt(_ txhash: String) throws -> TransactionReceipt {
         let result = try self.getTransactionReceiptPromise(txhash).wait()
@@ -152,12 +152,12 @@ extension web3.Eth {
     /// Estimates a minimal amount of gas required to run a transaction. To do it the Ethereum node tries to run it and counts
     /// how much gas it consumes for computations. Setting the transaction gas limit lower than the estimate will most likely
     /// result in a failing transaction.
-    /// 
+    ///
     /// "onString" field determines if value is returned based on the state of a blockchain on the latest mined block ("latest")
     /// or the expected state after all the transactions in memory pool are applied ("pending").
-    /// 
+    ///
     /// This function is synchronous!
-    /// 
+    ///
     /// Returns the Result object that indicates either success of failure.
     /// Error can also indicate that transaction is invalid in the current state, so formally it's gas limit is infinite.
     /// An example of such transaction can be sending an amount of ETH that is larger than the current account balance.
@@ -168,9 +168,9 @@ extension web3.Eth {
 
     /// Get a list of Ethereum accounts that a node knows about.
     /// If one has attached a Keystore Manager to the web3 object it returns accounts known to the keystore.
-    /// 
+    ///
     /// This function is synchronous!
-    /// 
+    ///
     /// Returns the Result object that indicates either success of failure.
     public func getAccounts() throws -> [EthereumAddress] {
         let result = try self.getAccountsPromise().wait()
@@ -180,9 +180,9 @@ extension web3.Eth {
     /// Get information about the particular block in Ethereum network. If "fullTransactions" parameter is set to "true"
     /// this call fill do a virtual join and fetch not just transaction hashes from this block,
     /// but full decoded EthereumTransaction objects.
-    /// 
+    ///
     /// This function is synchronous!
-    /// 
+    ///
     /// Returns the Result object that indicates either success of failure.
     public func getBlockByHash(_ hash: String, fullTransactions: Bool = false) throws -> Block {
         let result = try self.getBlockByHashPromise(hash, fullTransactions: fullTransactions).wait()
@@ -192,9 +192,9 @@ extension web3.Eth {
     /// Get information about the particular block in Ethereum network. If "fullTransactions" parameter is set to "true"
     /// this call fill do a virtual join and fetch not just transaction hashes from this block,
     /// but full decoded EthereumTransaction objects.
-    /// 
+    ///
     /// This function is synchronous!
-    /// 
+    ///
     /// Returns the Result object that indicates either success of failure.
     public func getBlockByHash(_ hash: Data, fullTransactions: Bool = false) throws -> Block {
         let result = try self.getBlockByHashPromise(hash, fullTransactions: fullTransactions).wait()
@@ -204,9 +204,9 @@ extension web3.Eth {
     /// Get information about the particular block in Ethereum network. If "fullTransactions" parameter is set to "true"
     /// this call fill do a virtual join and fetch not just transaction hashes from this block,
     /// but full decoded EthereumTransaction objects.
-    /// 
+    ///
     /// This function is synchronous!
-    /// 
+    ///
     /// Returns the Result object that indicates either success of failure.
     public func getBlockByNumber(_ number: UInt64, fullTransactions: Bool = false) throws -> Block {
         let result = try self.getBlockByNumberPromise(number, fullTransactions: fullTransactions).wait()
@@ -216,9 +216,9 @@ extension web3.Eth {
     /// Get information about the particular block in Ethereum network. If "fullTransactions" parameter is set to "true"
     /// this call fill do a virtual join and fetch not just transaction hashes from this block,
     /// but full decoded EthereumTransaction objects.
-    /// 
+    ///
     /// This function is synchronous!
-    /// 
+    ///
     /// Returns the Result object that indicates either success of failure.
     public func getBlockByNumber(_ number: BigUInt, fullTransactions: Bool = false) throws -> Block {
         let result = try self.getBlockByNumberPromise(number, fullTransactions: fullTransactions).wait()
@@ -228,10 +228,10 @@ extension web3.Eth {
     /// Get information about the particular block in Ethereum network. If "fullTransactions" parameter is set to "true"
     /// this call fill do a virtual join and fetch not just transaction hashes from this block,
     /// but full decoded EthereumTransaction objects.
-    /// 
+    ///
     /// This function is synchronous!
-    /// 
-    /// 
+    ///
+    ///
     public func getBlockByNumber(_ block: String, fullTransactions: Bool = false) throws -> Block {
         let result = try self.getBlockByNumberPromise(block, fullTransactions: fullTransactions).wait()
         return result

Sources/web3swift/Web3/Web3+Options.swift

@@ -158,9 +158,9 @@ public struct TransactionOptions {
         return newOptions
     }
 //
-//    // merges two sets of options along with a gas estimate to try to guess the final gas limit value required by user.
-//    //
-//    // Please refer to the source code for a logic.
+//    /// merges two sets of options along with a gas estimate to try to guess the final gas limit value required by user.
+//    ///
+//    /// Please refer to the source code for a logic.
 //    public static func smartMergeGasLimit(originalOptions: Web3Options?, extraOptions: Web3Options?, gasEstimate: BigUInt) -> BigUInt? {
 //        guard let mergedOptions = Web3Options.merge(originalOptions, with: extraOptions) else {return nil} // just require any non-nils
 //        if mergedOptions.gasLimit == nil {

Sources/web3swift/Web3/Web3+Structures.swift

@@ -114,13 +114,13 @@ extension EthereumTransaction: Decodable {
     public init(from decoder: Decoder) throws {
         let options = try TransactionOptions(from: decoder)
         let container = try decoder.container(keyedBy: CodingKeys.self)
-        
+
         // test to see if it is a EIP-1559 wrapper
         if let envelope = try decodeHexToBigUInt(container, key: .type, allowOptional: true) {
             // if present and non-sero we are a new wrapper we can't decode
             if envelope != BigInt(0) { throw Web3Error.dataError }
         }
-        
+
         var data = try decodeHexToData(container, key: .data, allowOptional: true)
         if data != nil {
             self.data = data!