add convenience methods for ERC20 token transfers

Author: Alex Vlasov

web3swift/Contract/Classes/ContractProtocol.swift

@@ -7,6 +7,7 @@
 //
 
 import Foundation
+import BigInt
 
 public protocol ContractProtocol {
     var address: EthereumAddress? {get set}
@@ -35,6 +36,18 @@ public protocol EventFilterable: EventFilterComparable, EventFilterEncodable {
 
 }
 
+extension BigUInt: EventFilterable {
+}
+extension BigInt: EventFilterable {
+}
+extension Data: EventFilterable {
+}
+extension String: EventFilterable {
+}
+extension EthereumAddress: EventFilterable {
+}
+
+
 public struct EventFilter {
     public enum Block {
         case latest

web3swift/Convenience/Classes/SynchronizedQueue.swift

@@ -101,7 +101,7 @@ public extension SynchronizedArray {
     /// - Returns: An array of the non-nil results of calling transform with each element of the sequence.
     func flatMap<ElementOfResult>(_ transform: (Element) -> ElementOfResult?) -> [ElementOfResult] {
         var result = [ElementOfResult]()
-        queue.sync { result = self.array.flatMap(transform) }
+        queue.sync { result = self.array.compactMap(transform) }
         return result
     }
 

web3swift/Web3/Classes/Web3+Contract.swift

@@ -54,7 +54,6 @@ extension web3 {
         }
 
         public func method(_ method:String = "fallback", parameters: [AnyObject] = [AnyObject](), extraData: Data = Data(), options: Web3Options?) -> TransactionIntermediate? {
-            
             let mergedOptions = Web3Options.merge(self.options, with: options)
             guard var tx = self.contract.method(method, parameters: parameters, extraData: extraData, options: mergedOptions) else {return nil}
             tx.chainID = self.web3.provider.network?.chainID

web3swift/Web3/Classes/Web3+Eth.swift

@@ -439,12 +439,36 @@ extension web3.Eth {
     }
 
     public func sendETH(to: EthereumAddress, amount: String, units: Web3.Utils.Units = .eth, extraData: Data = Data(), options: Web3Options? = nil) -> TransactionIntermediate? {
-        let contract = self.web3.contract(Web3.Utils.coldWalletABI, at: to, abiVersion: 2)
-        guard var mergedOptions = Web3Options.merge(self.options, with: options) else {return nil}
         guard let value = Web3.Utils.parseToBigUInt(amount, units: .eth) else {return nil}
-        mergedOptions.value = value
-        let intermediate = contract?.method("fallback", extraData: extraData, options: mergedOptions)
+        return sendETH(to: to, amount: value, extraData: extraData, options: options)
+    }
+    
+    public func sendERC20tokensWithKnownDecimals(tokenAddress: EthereumAddress, from: EthereumAddress, to: EthereumAddress, amount: BigUInt, options: Web3Options? = nil) -> TransactionIntermediate? {
+        let contract = self.web3.contract(Web3.Utils.erc20ABI, at: tokenAddress, abiVersion: 2)
+        guard var mergedOptions = Web3Options.merge(self.options, with: options) else {return nil}
+        mergedOptions.from = from
+        guard let intermediate = contract?.method("transfer", parameters: [to, amount] as [AnyObject], options: mergedOptions) else {return nil}
         return intermediate
     }
 
+    public func sendERC20tokensWithNaturalUnits(tokenAddress: EthereumAddress, from: EthereumAddress, to: EthereumAddress, amount: String, options: Web3Options? = nil) -> TransactionIntermediate? {
+        let contract = self.web3.contract(Web3.Utils.erc20ABI, at: tokenAddress, abiVersion: 2)
+        guard var mergedOptions = Web3Options.merge(self.options, with: options) else {return nil}
+        mergedOptions.from = from
+        guard let intermediate = contract?.method("decimals", options: mergedOptions) else {return nil}
+        let callResult = intermediate.call(options: mergedOptions, onBlock: "latest")
+        var decimals = BigUInt(0)
+        switch callResult {
+        case .success(let response):
+            guard let dec = response["0"], let decTyped = dec as? BigUInt else {return nil}
+            decimals = decTyped
+            break
+        case .failure(let error):
+            break
+        }
+        let intDecimals = Int(decimals)
+        guard let value = Web3.Utils.parseToBigUInt(amount, decimals: intDecimals) else {return nil}
+        return sendERC20tokensWithKnownDecimals(tokenAddress: tokenAddress, from: from, to: to, amount: value, options: options)
+    }
+    
 }

web3swift/Web3/Classes/Web3+EventParser.swift

@@ -113,7 +113,6 @@ extension web3.web3contract {
                 var allResults = [EventParserResultProtocol]()
                 if (self.filter != nil) {
                     let eventFilter = self.filter!
-                    // TODO NYI
                     let filteredLogs = decodedLogs.filter { (result) -> Bool in
                         if eventFilter.addresses == nil {
                             return true
@@ -134,7 +133,7 @@ extension web3.web3contract {
                                 }
                                 return false
                             })
-                            if keys.count != eventFilter.parameterFilters!.count {
+                            if keys.count < eventFilter.parameterFilters!.count {
                                 return false
                             }
                             for i in 0 ..< keys.count {
@@ -150,6 +149,7 @@ extension web3.web3contract {
                                 for value in allowedValues! {
                                     if value.isEqualTo(actualValue! as AnyObject) {
                                         inAllowed = true
+                                        break
                                     }
                                 }
                                 if !inAllowed {

web3swift/Web3/Classes/Web3+Utils.swift

@@ -121,10 +121,15 @@ extension Web3.Utils {
     }
 
     public static func parseToBigUInt(_ amount: String, units: Web3.Utils.Units = .eth) -> BigUInt? {
+        let unitDecimals = units.decimals
+        return parseToBigUInt(amount, decimals: unitDecimals)
+    }
+    
+    public static func parseToBigUInt(_ amount: String, decimals: Int = 18) -> BigUInt? {
         let separators = CharacterSet(charactersIn: ".,")
         let components = amount.trimmingCharacters(in: .whitespacesAndNewlines).components(separatedBy: separators)
         guard components.count == 1 || components.count == 2 else {return nil}
-        let unitDecimals = units.decimals
+        let unitDecimals = decimals
         guard let beforeDecPoint = BigUInt(components[0], radix: 10) else {return nil}
         var mainPart = beforeDecPoint*BigUInt(10).power(unitDecimals)
         if (components.count == 2) {

web3swiftTests/web3swiftTests.swift

@@ -2105,13 +2105,13 @@ class web3swiftTests: XCTestCase {
         // BKX TOKEN
         let web3 = Web3.InfuraMainnetWeb3()
         let coldWalletAddress = EthereumAddress("0x6394b37Cf80A7358b38068f0CA4760ad49983a1B")
-        let constractAddress = EthereumAddress("0x45245bc59219eeaaf6cd3f382e078a461ff9de7b")
+        let contractAddress = EthereumAddress("0x45245bc59219eeaaf6cd3f382e078a461ff9de7b")
         var options = Web3Options()
         options.from = coldWalletAddress
         let tempKeystore = try! EthereumKeystoreV3(password: "")
         let keystoreManager = KeystoreManager([tempKeystore!])
         web3.addKeystoreManager(keystoreManager)
-        let contract = web3.contract(Web3.Utils.erc20ABI, at: constractAddress, abiVersion: 2)!
+        let contract = web3.contract(Web3.Utils.erc20ABI, at: contractAddress, abiVersion: 2)!
         let bkxBalanceSend = contract.method("transfer", parameters: [coldWalletAddress, BigUInt(1)] as [AnyObject], options: options)!.call(options: nil)
         switch bkxBalanceSend {
         case .success(let result):
@@ -2122,6 +2122,25 @@ class web3swiftTests: XCTestCase {
         }
     }
 
+    func testTokenBalanceTransferOnMainNetUsingConvenience() {
+        // BKX TOKEN
+        let web3 = Web3.InfuraMainnetWeb3()
+        let coldWalletAddress = EthereumAddress("0x6394b37Cf80A7358b38068f0CA4760ad49983a1B")
+        let contractAddress = EthereumAddress("0x45245bc59219eeaaf6cd3f382e078a461ff9de7b")
+        let tempKeystore = try! EthereumKeystoreV3(password: "")
+        let keystoreManager = KeystoreManager([tempKeystore!])
+        web3.addKeystoreManager(keystoreManager)
+        let intermediate = web3.eth.sendERC20tokensWithNaturalUnits(tokenAddress:contractAddress, from: coldWalletAddress, to: coldWalletAddress, amount: "1.0")
+        let bkxBalanceSend = intermediate!.call(options: nil)
+        switch bkxBalanceSend {
+        case .success(let result):
+            print(result)
+        case .failure(let error):
+            print(error)
+            XCTFail()
+        }
+    }
+    
     func testPerformanceExample() {
         // This is an example of a performance test case.
         self.measure {

web3swiftTests/web3swift_remote_Tests.swift

@@ -145,15 +145,20 @@ class web3swift_remote_Tests: XCTestCase {
         }
     }
 
-    func testEventParsing2usingABIv4() {
+    func testEventParsing4usingABIv2() {
         let jsonString = "[{\"constant\":true,\"inputs\":[],\"name\":\"name\",\"outputs\":[{\"name\":\"\",\"type\":\"string\"}],\"payable\":false,\"type\":\"function\"},{\"constant\":false,\"inputs\":[{\"name\":\"_spender\",\"type\":\"address\"},{\"name\":\"_value\",\"type\":\"uint256\"}],\"name\":\"approve\",\"outputs\":[{\"name\":\"success\",\"type\":\"bool\"}],\"payable\":false,\"type\":\"function\"},{\"constant\":true,\"inputs\":[],\"name\":\"totalSupply\",\"outputs\":[{\"name\":\"\",\"type\":\"uint256\"}],\"payable\":false,\"type\":\"function\"},{\"constant\":false,\"inputs\":[{\"name\":\"_from\",\"type\":\"address\"},{\"name\":\"_to\",\"type\":\"address\"},{\"name\":\"_value\",\"type\":\"uint256\"}],\"name\":\"transferFrom\",\"outputs\":[{\"name\":\"success\",\"type\":\"bool\"}],\"payable\":false,\"type\":\"function\"},{\"constant\":true,\"inputs\":[],\"name\":\"decimals\",\"outputs\":[{\"name\":\"\",\"type\":\"uint8\"}],\"payable\":false,\"type\":\"function\"},{\"constant\":true,\"inputs\":[],\"name\":\"version\",\"outputs\":[{\"name\":\"\",\"type\":\"string\"}],\"payable\":false,\"type\":\"function\"},{\"constant\":true,\"inputs\":[{\"name\":\"_owner\",\"type\":\"address\"}],\"name\":\"balanceOf\",\"outputs\":[{\"name\":\"balance\",\"type\":\"uint256\"}],\"payable\":false,\"type\":\"function\"},{\"constant\":true,\"inputs\":[],\"name\":\"symbol\",\"outputs\":[{\"name\":\"\",\"type\":\"string\"}],\"payable\":false,\"type\":\"function\"},{\"constant\":false,\"inputs\":[{\"name\":\"_to\",\"type\":\"address\"},{\"name\":\"_value\",\"type\":\"uint256\"}],\"name\":\"transfer\",\"outputs\":[{\"name\":\"success\",\"type\":\"bool\"}],\"payable\":false,\"type\":\"function\"},{\"constant\":false,\"inputs\":[{\"name\":\"_spender\",\"type\":\"address\"},{\"name\":\"_value\",\"type\":\"uint256\"},{\"name\":\"_extraData\",\"type\":\"bytes\"}],\"name\":\"approveAndCall\",\"outputs\":[{\"name\":\"success\",\"type\":\"bool\"}],\"payable\":false,\"type\":\"function\"},{\"constant\":true,\"inputs\":[{\"name\":\"_owner\",\"type\":\"address\"},{\"name\":\"_spender\",\"type\":\"address\"}],\"name\":\"allowance\",\"outputs\":[{\"name\":\"remaining\",\"type\":\"uint256\"}],\"payable\":false,\"type\":\"function\"},{\"inputs\":[{\"name\":\"_initialAmount\",\"type\":\"uint256\"},{\"name\":\"_tokenName\",\"type\":\"string\"},{\"name\":\"_decimalUnits\",\"type\":\"uint8\"},{\"name\":\"_tokenSymbol\",\"type\":\"string\"}],\"type\":\"constructor\"},{\"payable\":false,\"type\":\"fallback\"},{\"anonymous\":false,\"inputs\":[{\"indexed\":true,\"name\":\"_from\",\"type\":\"address\"},{\"indexed\":true,\"name\":\"_to\",\"type\":\"address\"},{\"indexed\":false,\"name\":\"_value\",\"type\":\"uint256\"}],\"name\":\"Transfer\",\"type\":\"event\"},{\"anonymous\":false,\"inputs\":[{\"indexed\":true,\"name\":\"_owner\",\"type\":\"address\"},{\"indexed\":true,\"name\":\"_spender\",\"type\":\"address\"},{\"indexed\":false,\"name\":\"_value\",\"type\":\"uint256\"}],\"name\":\"Approval\",\"type\":\"event\"},]"
         let web3 = Web3.InfuraMainnetWeb3()
         let contract = web3.contract(jsonString, at: nil, abiVersion: 2)
-        guard let eventParser = contract?.createEventParser("Transfer", filter: nil) else {return XCTFail()}
+        var filter = EventFilter()
+        filter.addresses = [EthereumAddress("0x53066cddbc0099eb6c96785d9b3df2aaeede5da3")]
+        filter.parameterFilters = [([EthereumAddress("0xefdcf2c36f3756ce7247628afdb632fa4ee12ec5")] as [EventFilterable]), ([EthereumAddress("0xd5395c132c791a7f46fa8fc27f0ab6bacd824484")] as [EventFilterable])]
+        guard let eventParser = contract?.createEventParser("Transfer", filter: filter) else {return XCTFail()}
         let present = eventParser.parseBlockByNumber(UInt64(5200120))
         guard case .success(let pres) = present else {return XCTFail()}
         print(pres)
-        XCTAssert(pres.count == 81)
+        XCTAssert(pres.count == 1)
+//        with filter would be
+//            [web3swift_iOS.EventLog(address: web3swift_iOS.EthereumAddress(_address: "0x53066cddbc0099eb6c96785d9b3df2aaeede5da3", type: web3swift_iOS.EthereumAddress.AddressType.normal), data: 32 bytes, logIndex: 132, removed: false, topics: [32 bytes, 32 bytes, 32 bytes])], status: web3swift_iOS.TransactionReceipt.TXStatus.ok, logsBloom: Optional(web3swift_iOS.EthereumBloomFilter(bytes: 256 bytes))), contractAddress: web3swift_iOS.EthereumAddress(_address: "0x53066cddbc0099eb6c96785d9b3df2aaeede5da3", type: web3swift_iOS.EthereumAddress.AddressType.normal), decodedResult: ["name": "Transfer", "1": web3swift_iOS.EthereumAddress(_address: "0xd5395c132c791a7f46fa8fc27f0ab6bacd824484", type: web3swift_iOS.EthereumAddress.AddressType.normal), "_from": web3swift_iOS.EthereumAddress(_address: "0xefdcf2c36f3756ce7247628afdb632fa4ee12ec5", type: web3swift_iOS.EthereumAddress.AddressType.normal), "_to": web3swift_iOS.EthereumAddress(_address: "0xd5395c132c791a7f46fa8fc27f0ab6bacd824484", type: web3swift_iOS.EthereumAddress.AddressType.normal), "2": 5000000000000000000, "0": web3swift_iOS.EthereumAddress(_address: "0xefdcf2c36f3756ce7247628afdb632fa4ee12ec5", type: web3swift_iOS.EthereumAddress.AddressType.normal), "_value": 5000000000000000000])]
     }