Merge pull request #31 from matterinc/update-readme

Add examples to readme, prettify formatting
web3swift-team · Sep 13, 2018 · 2aa2bf7 · 2aa2bf7
2 parents c849a3e + ee35150
commit 2aa2bf7
Show file tree

Hide file tree

Showing 23 changed files with 1,826 additions and 1,766 deletions.
diff --git a/Example/web3swiftExample/Pods/Headers/Public/Alamofire/Alamofire-umbrella.h b/Example/web3swiftExample/Pods/Headers/Public/Alamofire/Alamofire-umbrella.h
diff --git a/Example/web3swiftExample/Pods/Headers/Public/Alamofire/Alamofire.modulemap b/Example/web3swiftExample/Pods/Headers/Public/Alamofire/Alamofire.modulemap
diff --git a/...b3swiftExample/Pods/Headers/Public/Alamofire_Synchronous/Alamofire-Synchronous-umbrella.h b/...b3swiftExample/Pods/Headers/Public/Alamofire_Synchronous/Alamofire-Synchronous-umbrella.h
diff --git a/...eb3swiftExample/Pods/Headers/Public/Alamofire_Synchronous/Alamofire-Synchronous.modulemap b/...eb3swiftExample/Pods/Headers/Public/Alamofire_Synchronous/Alamofire-Synchronous.modulemap
diff --git a/Example/web3swiftExample/Pods/Headers/Public/BigInt/BigInt-umbrella.h b/Example/web3swiftExample/Pods/Headers/Public/BigInt/BigInt-umbrella.h
diff --git a/Example/web3swiftExample/Pods/Headers/Public/BigInt/BigInt.modulemap b/Example/web3swiftExample/Pods/Headers/Public/BigInt/BigInt.modulemap
diff --git a/Example/web3swiftExample/Pods/Headers/Public/CryptoSwift/CryptoSwift-umbrella.h b/Example/web3swiftExample/Pods/Headers/Public/CryptoSwift/CryptoSwift-umbrella.h
diff --git a/Example/web3swiftExample/Pods/Headers/Public/CryptoSwift/CryptoSwift.modulemap b/Example/web3swiftExample/Pods/Headers/Public/CryptoSwift/CryptoSwift.modulemap
diff --git a/Example/web3swiftExample/Pods/Headers/Public/PromiseKit/PromiseKit-umbrella.h b/Example/web3swiftExample/Pods/Headers/Public/PromiseKit/PromiseKit-umbrella.h
diff --git a/Example/web3swiftExample/Pods/Headers/Public/PromiseKit/PromiseKit.modulemap b/Example/web3swiftExample/Pods/Headers/Public/PromiseKit/PromiseKit.modulemap
diff --git a/Example/web3swiftExample/Pods/Headers/Public/Result/Result-umbrella.h b/Example/web3swiftExample/Pods/Headers/Public/Result/Result-umbrella.h
diff --git a/Example/web3swiftExample/Pods/Headers/Public/Result/Result.modulemap b/Example/web3swiftExample/Pods/Headers/Public/Result/Result.modulemap
diff --git a/Example/web3swiftExample/Pods/Headers/Public/SipHash/SipHash-umbrella.h b/Example/web3swiftExample/Pods/Headers/Public/SipHash/SipHash-umbrella.h
diff --git a/Example/web3swiftExample/Pods/Headers/Public/SipHash/SipHash.modulemap b/Example/web3swiftExample/Pods/Headers/Public/SipHash/SipHash.modulemap
diff --git a/Example/web3swiftExample/Pods/Headers/Public/libsodium/libsodium-umbrella.h b/Example/web3swiftExample/Pods/Headers/Public/libsodium/libsodium-umbrella.h
diff --git a/Example/web3swiftExample/Pods/Headers/Public/libsodium/libsodium.modulemap b/Example/web3swiftExample/Pods/Headers/Public/libsodium/libsodium.modulemap
diff --git a/Example/web3swiftExample/Pods/Headers/Public/secp256k1_ios/secp256k1_ios-umbrella.h b/Example/web3swiftExample/Pods/Headers/Public/secp256k1_ios/secp256k1_ios-umbrella.h
diff --git a/Example/web3swiftExample/Pods/Headers/Public/secp256k1_ios/secp256k1_ios.modulemap b/Example/web3swiftExample/Pods/Headers/Public/secp256k1_ios/secp256k1_ios.modulemap
diff --git a/Example/web3swiftExample/Pods/Headers/Public/web3swift/web3swift-umbrella.h b/Example/web3swiftExample/Pods/Headers/Public/web3swift/web3swift-umbrella.h
diff --git a/Example/web3swiftExample/Pods/Headers/Public/web3swift/web3swift.modulemap b/Example/web3swiftExample/Pods/Headers/Public/web3swift/web3swift.modulemap
diff --git a/Example/web3swiftExample/Pods/Pods.xcodeproj/project.pbxproj b/Example/web3swiftExample/Pods/Pods.xcodeproj/project.pbxproj
diff --git a/Example/web3swiftExample/web3swiftExample.xcodeproj/project.pbxproj b/Example/web3swiftExample/web3swiftExample.xcodeproj/project.pbxproj
@@ -326,7 +326,7 @@
 			buildSettings = {
 				ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
 				CODE_SIGN_STYLE = Automatic;
-				DEVELOPMENT_TEAM = 62V9CKQN89;
+				DEVELOPMENT_TEAM = "";
 				INFOPLIST_FILE = web3swiftExample/Info.plist;
 				IPHONEOS_DEPLOYMENT_TARGET = 9.0;
 				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks";
@@ -343,7 +343,7 @@
 			buildSettings = {
 				ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
 				CODE_SIGN_STYLE = Automatic;
-				DEVELOPMENT_TEAM = 62V9CKQN89;
+				DEVELOPMENT_TEAM = "";
 				INFOPLIST_FILE = web3swiftExample/Info.plist;
 				IPHONEOS_DEPLOYMENT_TARGET = 9.0;
 				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks";

diff --git a/README.md b/README.md
@@ -126,17 +126,26 @@ $ pod install
 
 ## Usage
 
-Here's a few use cases of our library
+Here's a few use cases of our library:
+
+### Create Account
+Create keystore and account with password.
+
+```
+//TODO
+```
+
 ### Initializing Ethereum address
-```bash
+```
 let coldWalletAddress = EthereumAddress("0x6394b37Cf80A7358b38068f0CA4760ad49983a1B")
 let constractAddress = EthereumAddress("0x45245bc59219eeaaf6cd3f382e078a461ff9de7b")
 ```
 Ethereum addresses are checksum checked if they are not lowercased and always length checked
 
 
 ### Setting options
-```bash
+
+```
 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)
@@ -147,46 +156,61 @@ options.gasPrice = gasPrice
 options.gasLimit = gasLimit
 options.from = EthereumAddress("0xE6877A4d8806e9A9F12eB2e8561EA6c1db19978d")
 ```
+
+### Encoding Transaction
+
+```
+//TODO
+```
+
+### Signing Transaction
+
+```
+//TODO
+```
 ### Getting ETH balance
-```bash
+```
 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
-```bash
+```
 let web3Main = Web3.InfuraMainnetWeb3()
 let gasPriceResult = web3Main.eth.getGasPrice()
 guard case .success(let gasPrice) = gasPriceResult else {return}
 ```
-### Getting ERC20 token balance
-```bash
-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
-guard case .success(let bkxBalance) = bkxBalanceResult, let bal = bkxBalance["0"] as? BigUInt else {return} // bkxBalance is [String: Any], and parameters are enumerated as "0", "1", etc in order of being returned. If returned parameter has a name in ABI, it is also duplicated
-print("BKX token balance = " + String(bal))
-```
 
 ### Sending ETH
-```bash
+```
 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
 intermediateSend = web3Rinkeby.contract(Web3.Utils.coldWalletABI, at: coldWalletAddress, abiVersion: 2)!.method(options: options)! // an address with a private key attached in not different from any other address, just has very simple ABI
-let sendResultBip32 = intermediateSend.send(password: "BANKEXFOUNDATION")
+let sendResultBip32 = intermediateSend.send(password: "changeme")
 ```
 
-### Sending ERC20
-```bash
+### ERC20 Iteraction:
+
+#### Getting ERC20 token balance
+```
+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
+guard case .success(let bkxBalance) = bkxBalanceResult, let bal = bkxBalance["0"] as? BigUInt else {return} // bkxBalance is [String: Any], and parameters are enumerated as "0", "1", etc in order of being returned. If returned parameter has a name in ABI, it is also duplicated
+print("BKX token balance = " + String(bal))
+```
+
+#### Sending ERC20
+```
 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
 let gasEstimateResult = convenienceTokenTransfer!.estimateGas(options: nil)
 guard case .success(let gasEstimate) = gasEstimateResult else {return}
 convenienceTransferOptions.gasLimit = gasEstimate
-let convenienceTransferResult = convenienceTokenTransfer!.send(password: "BANKEXFOUNDATION", options: convenienceTransferOptions)
+let convenienceTransferResult = convenienceTokenTransfer!.send(password: "changeme", options: convenienceTransferOptions)
 switch convenienceTransferResult {
     case .success(let res):
         print("Token transfer successful")
@@ -196,16 +220,29 @@ switch convenienceTransferResult {
 }
 ```
 
-## Global plans
-- Full reference `web3js` functionality
-- Light Ethereum subprotocol (LES) integration
+## [Apps using this library](https://github.com/matterinc/web3swift/wiki/Apps-using-web3swift)
+
+If you are using `web3swift` in your app or know of an app that uses it, please add it to this list. It would be much appreciated! 👍
 
-## [Apps using this library](https://github.com/matterinc/web3swift/wiki/Apps-using-web3swift) 
+* [MEWconnect-iOS](https://github.com/MyEtherWallet/MEWconnect-iOS)
+* [Peepeth iOS client](https://github.com/matterinc/PeepethClient)
+* [Ethereum & ERC20Tokens Wallet](https://itunes.apple.com/us/app/ethereum-erc20tokens-wallet/id1386738877?ls=1&mt=8)
+* [BankexWallet](https://github.com/BANKEX/Pay-iOS)
+* [GeoChain](https://github.com/awallish/GeoChain)
+* [YOUR APP CAN BE THERE (click me)](https://github.com/matterinc/web3swift/issues) :wink:
 
 If you've used this project in a live app, please let us know!
 
 *If you are using `web3swift` in your app or know of an app that uses it, please add it to [this](https://github.com/matterinc/web3swift/wiki/Apps-using-web3swift) list.*
 
+
+
+## Future plans
+
+- Full reference `web3js` functionality
+- Light Ethereum subprotocol (LES) integration
+
+
 ## Special thanks to
 
 - Gnosis team and their library [Bivrost-swift](https://github.com/gnosis/bivrost-swift) for inspiration for the ABI decoding approach