Merge branch 'master' into develop

Author: skywinder

README.md

@@ -124,32 +124,61 @@ $ pod install
 - [x] Manage user's private keys through encrypted keystore abstractions
 - [x] Batched requests in concurrent mode, checks balances of 580 tokens (from the latest MyEtherWallet repo) over 3 seconds
 
-## Usage
+## Getting started
 
-Here's a few use cases of our library:
+Here's a few use cases:
 
 ### Create Account
-Create keystore and account with password.
 
-```
+```swift
+    // Create keystore and account with password.
+    
 	let keystore = try! EthereumKeystoreV3(password: "changeme"); // generates a private key internally if node "privateKey" parameter supplied
         let account = keystore!.addresses![0]
         print(account)
+	
         let data = try! keystore!.serialize() // internally serializes to JSON
         print(try! JSONSerialization.jsonObject(with: data!, options: JSONSerialization.ReadingOptions(rawValue:0)))
-        let key = try! keystore!.UNSAFE_getPrivateKeyData(password: "changeme", account: account) // you should rarely use this and expose a key manually
+        let key = try! keystore!.UNSAFE_getPrivateKeyData(password: "changeme", account: account) // you should rarely use this and expose a key manually	
 ```
 
-### Initializing Ethereum address
+### Save keystore to the memory
+
+```swift
+//First you need a `KeystoreManager` instance:
+guard let userDirectory = NSSearchPathForDirectoriesInDomains(.documentDirectory, .userDomainMask, true).first,
+    let keystoreManager = KeystoreManager.managerForPath(userDirectory + "/keystore")
+else {
+    fatalError("Couldn't create a KeystoreManager.")
+}
+
+//Next you create the a new Keystore:
+
+let newKeystore = try? EthereumKeystoreV3(password: "YOUR_PASSWORD")
+
+// Then you save the created keystore to the file system:
+
+let newKeystoreJSON = try? JSONEncoder().encode(newKeystore.keystoreParams)
+FileManager.default.createFile(atPath: "\(keystoreManager.path)/keystore.json", contents: newKeystoreJSON, attributes: nil)
+
+// Later you can retreive it:
+
+if let address = keystoreManager.addresses?.first,
+let retrievedKeystore = keystoreManager.walletForAddress(address) as? EthereumKeystoreV3 {
+    return retrievedKeystore
+}
 ```
+
+### Initializing Ethereum address
+```swift
 let coldWalletAddress = EthereumAddress("0x6394b37Cf80A7358b38068f0CA4760ad49983a1B")
 let constractAddress = EthereumAddress("0x45245bc59219eeaaf6cd3f382e078a461ff9de7b", ignoreChecksum: true)
 ```
 Ethereum addresses are checksum checked if they are not lowercased or uppercased and always length checked
 
 ### Setting options
 
-```
+```swift
 var options = Web3Options.defaultOptions()
     // public var to: EthereumAddress? = nil - to what address transaction is aimed
     // public var from: EthereumAddress? = nil - form what address it should be sent (either signed locally or on the node)
@@ -173,21 +202,21 @@ options.from = EthereumAddress("0xE6877A4d8806e9A9F12eB2e8561EA6c1db19978d")
 //TODO
 ```
 ### Getting ETH balance
-```
+```swift
 let address = EthereumAddress("0xE6877A4d8806e9A9F12eB2e8561EA6c1db19978d")!
 let web3Main = Web3.InfuraMainnetWeb3()
 let balanceResult = web3Main.eth.getBalance(address)
 guard case .success(let balance) = balanceResult else {return}
 ```
 ### Getting gas price
-```
+```swift
 let web3Main = Web3.InfuraMainnetWeb3()
 let gasPriceResult = web3Main.eth.getGasPrice()
 guard case .success(let gasPrice) = gasPriceResult else {return}
 ```
 
 ### Sending ETH
-```
+```swift
 let web3Rinkeby = Web3.InfuraRinkebyWeb3()
 web3Rinkeby.addKeystoreManager(bip32keystoreManager) // attach a keystore if you want to sign locally. Otherwise unsigned request will be sent to remote node
 options.from = bip32ks?.addresses?.first! // specify from what address you want to send it
@@ -198,7 +227,7 @@ let sendResultBip32 = intermediateSend.send(password: "changeme")
 ### ERC20 Iteraction:
 
 #### Getting ERC20 token balance
-```
+```swift
 let contractAddress = EthereumAddress("0x45245bc59219eeaaf6cd3f382e078a461ff9de7b")! // BKX token on Ethereum mainnet
 let contract = web3.contract(Web3.Utils.erc20ABI, at: contractAddress, abiVersion: 2)! // utilize precompiled ERC20 ABI for your concenience
 guard let bkxBalanceResult = contract.method("balanceOf", parameters: [coldWalletAddress] as [AnyObject], options: options)?.call(options: nil) else {return} // encode parameters for transaction
@@ -207,7 +236,7 @@ print("BKX token balance = " + String(bal))
 ```
 
 #### Sending ERC20
-```
+```swift
 var convenienceTransferOptions = Web3Options.defaultOptions()
 convenienceTransferOptions.gasPrice = gasPriceRinkeby
 let convenienceTokenTransfer = web3Rinkeby.eth.sendERC20tokensWithNaturalUnits(tokenAddress: EthereumAddress("0xa407dd0cbc9f9d20cdbd557686625e586c85b20a")!, from: (ks?.addresses?.first!)!, to: EthereumAddress("0x6394b37Cf80A7358b38068f0CA4760ad49983a1B")!, amount: "0.0001", options: convenienceTransferOptions) // there are also convenience functions to send ETH and ERC20 under the .eth structure

web3swift/ABIv2/Classes/ABIv2Elements.swift

@@ -9,7 +9,7 @@
 import Foundation
 import BigInt
 
-extension ABIv2 {
+public extension ABIv2 {
     // JSON Decoding
     public struct Input: Decodable {
         var name: String?
@@ -48,16 +48,16 @@ extension ABIv2 {
         case event(Event)
 
         public struct InOut {
-            let name: String
-            let type: ParameterType
+            public let name: String
+            public let type: ParameterType
         }
 
         public struct Function {
-            let name: String?
-            let inputs: [InOut]
-            let outputs: [InOut]
-            let constant: Bool
-            let payable: Bool
+            public let name: String?
+            public let inputs: [InOut]
+            public let outputs: [InOut]
+            public let constant: Bool
+            public let payable: Bool
         }
 
         public struct Constructor {

web3swift/Utils/Classes/EIP681.swift

@@ -116,6 +116,7 @@ extension Web3 {
 
             var code = EIP681Code(targetAddress)
             if chainIDString != nil {
+                chainIDString!.remove(at: chainIDString!.startIndex)
                 code.chainID = BigUInt(chainIDString!)
             }
             if tail == nil {
@@ -137,7 +138,13 @@ extension Web3 {
                     switch inputType {
                     case .address:
                         let val = EIP681Code.TargetAddress(value)
-                        nativeValue = val as AnyObject
+                        switch val {
+                        case .ethereumAddress(let ethereumAddress):
+                            nativeValue = ethereumAddress as AnyObject
+                        case .ensAddress(let ens):
+                            //TODO: - convert ens into ethereum
+                            nativeValue = ens as AnyObject
+                        }
                     case .uint(bits: _):
                         if let val = BigUInt(value, radix: 10) {
                             nativeValue = val as AnyObject
@@ -164,6 +171,15 @@ extension Web3 {
                         } else if let val = value.data(using: .utf8) {
                             nativeValue = val as AnyObject
                         }
+                    case .bool:
+                        switch value {
+                        case "true","True","1":
+                            nativeValue = true as AnyObject
+                        case "false", "False", "0":
+                            nativeValue = false as AnyObject
+                        default:
+                            nativeValue = true as AnyObject
+                        }
                     default:
                         continue
                     }

web3swift/Web3/Classes/Web3+Protocols.swift

@@ -40,7 +40,7 @@ public enum Networks {
     case Kovan
     case Custom(networkID: BigUInt)
 
-    var name: String {
+    public var name: String {
         switch self {
         case .Rinkeby: return "rinkeby"
         case .Ropsten: return "ropsten"
@@ -50,7 +50,7 @@ public enum Networks {
         }
     }
 
-    var chainID: BigUInt {
+    public var chainID: BigUInt {
         switch self {
         case .Custom(let networkID): return networkID
         case .Mainnet: return BigUInt(1)