Elegant Web3js functionality in Swift. Native ABI parsing and smart contract interactions.
Clone or download
Latest commit 1aaa902 Nov 19, 2018

README.md

We just released web3swift 2.0 check it out

also check our Discord Channel

Support Stackoverflow Join Discord

bkx-foundation-github-swift

Swift 4.2 Platforms iOS | macOS Compatible Compatible

web3swift

  • Swift implementation of web3.js functionality ⚡️
  • Interaction with remote node via JSON RPC 💭
  • Smart-contract ABI parsing 📖
  • ABI deconding (V2 is supported with return of structures from public functions. Part of 0.4.22 Solidity compiler)
  • RLP encoding
  • Interactions (read/write to Smart contracts) 🔄
  • Local keystore management (geth compatible)
  • Literally following the standards:
  • BIP32 HD Wallets: Deterministic Wallet
  • BIP39 (Seed phrases)
  • BIP44 (Key generation prefixes)
  • EIP-155 (Replay attacks protection) enforced!

Requirements

Web3swift requires Swift 4.2 and deploys to macOS 10.10, iOS 9, watchOS 2 and tvOS 9 and linux.

Don't forget to set the iOS version in a Podfile, otherwise you get an error if the deployment target is less than the latest SDK.

Installation

  • Swift Package Manager: Although the Package Manager is still in its infancy, web3swift provides full support for it. Add this to the dependency section of your Package.swift manifest:

    .package(url: "https://github.com/BANKEX/web3swift.git", from: "2.0.0")
  • CocoaPods: Put this in your Podfile:

    pod 'web3swift', :git => 'https://github.com/bankex/web3swift.git'
  • Carthage: Put this in your Cartfile:

    github "BANKEX/web3swift" ~> 2.0
    

Documentation

Hi. We spend a lot of time working on documentation. If you have some questions after reading it just open an issue or ask in our discord channel. We would be happy to answer you.

Most of the classes are documented and have some examples on how to use it.

[Read documentation in using Xcode](Documentation/Read Documentation Using Xcode.md)

Github Pages

We would appreciate it if you translate our documentation into another language, and will be happy to provide you with all the necessary information on how to do this. We will compensate you for translations that will be included in the master branch.

Check this out

  • Private key and transaction were created directly on an iOS device and sent directly to Infura node
  • Native API
  • Security (as cool as a hard wallet! Right out-of-the-box! :box: )
  • No unnecessary dependencies
  • Possibility to work with all existing smart contracts
  • Referencing the newest features introduced in Solidity

Design decisions

  • Not every JSON RPC function is exposed yet, priority is given to the ones required for mobile devices
  • Functionality was focused on serializing and signing transactions locally on the device to send raw transactions to Ethereum network
  • Requirements for password input on every transaction are indeed a design decision. Interface designers can save user passwords with the user's consent
  • Public function for private key export is exposed for user convenience, but marked as UNSAFE_ :) Normal workflow takes care of EIP155 compatibility and proper clearing of private key data from memory

Here it is

https://rinkeby.etherscan.io/tx/0xc6eca60ecac004a1501a4323a10edb7fa4cd1a0896675f6b51704c84dedad056

Transaction
Nonce: 35
Gas price: 5000000000
Gas limit: 21000
To: 0x6394b37Cf80A7358b38068f0CA4760ad49983a1B
Value: 1000000000000000
Data: 0x
v: 43
r: 73059897783840535708732471549376620878882680550447969052675399628060606060727
s: 12280625377431973240236065453692843538037349746280474092545114784968542260859
Intrinsic chainID: Optional(4)
Infered chainID: Optional(4)
sender: Optional(web3swift.Address(_address: "0x855adf524273c14b7260a188af0ae30e82e91959"))


["id": 1514485925, "result": 0xc6eca60ecac004a1501a4323a10edb7fa4cd1a0896675f6b51704c84dedad056, "jsonrpc": 2.0]
On Rinkeby TXid = 0xc6eca60ecac004a1501a4323a10edb7fa4cd1a0896675f6b51704c84dedad056

Example

You can try it yourself by running the example project:

  • Clone the repo
  • cd Example/web3swiftExample
  • run pod install from the Example/web3swiftExample directory.
  • open ./web3swiftExample.xcworkspace

Communication

Features

  • Create Account
  • Import Account
  • Sign transactions
  • Send transactions, call functions of smart-contracts, estimate gas costs
  • Serialize and deserialize transactions and results to native Swift types
  • Convenience functions for chain state: block number, gas price
  • Check transaction results and get receipt
  • Parse event logs for transaction
  • Manage user's private keys through encrypted keystore abstractions
  • Batched requests in concurrent mode, checks balances of 580 tokens (from the latest MyEtherWallet repo) over 3 seconds

Global plans

  • Full reference web3js functionality
  • Light Ethereum subprotocol (LES) integration

Apps using this library

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 list.*

Special thanks to

  • Gnosis team and their library Bivrost-swift for inspiration for the ABI decoding approach
  • Trust iOS Wallet for the collaboration and discussion of the initial idea
  • Official Ethereum and Solidity docs, everything was written from ground truth standards

Contribution

For the latest version, please check develop branch.

Changes made to this branch will be merged into the master branch at some point.

Appreciation

When using this pod, references to this repo, BANKEX and BANKEX Foundation are appreciated.

License

web3swift is available under the Apache License 2.0 license. See the LICENSE file for more info.