web3swift is an iOS toolbelt for interaction with the Ethereum network.
- Core features
- Projects that are using web3swift
- Security Disclosure
⚡Swift implementation of web3.js functionality
💭Interaction with remote node via JSON RPC
🔐Local keystore management (
🤖Smart-contract ABI parsing
🔓ABI deconding (V2 is supported with return of structures from public functions. Part of 0.4.22 Solidity compiler)
🕸Ethereum Name Service (ENS) support - a secure & decentralised way to address resources both on and off the blockchain using simple, human-readable names
🔄Smart contracts interactions (read/write)
⛩Infura support, patial Websockets API support
⚒Parsing TxPool content into native values (ethereum addresses and transactions) - easy to get pending transactions
🖇Event loops functionality
📱Supports Web3View functionality (WKWebView with injected "web3" provider)
🕵️♂️Possibility to add or remove "middleware" that intercepts, modifies and even cancel transaction workflow on stages "before assembly", "after assembly"and "before submission"
✅Literally following the standards (BIP, EIP, etc):
- And many others (For details about this EIP's look at Documentation page): EIP-681, EIP-721, EIP-165, EIP-777, EIP-820, EIP-888, EIP-1400, EIP-1410, EIP-1594, EIP-1643, EIP-1644, EIP-1633, EIP-721, EIP-1155, EIP-1376, ST-20
🗜Batched requests in concurrent mode
Base58 encoding scheme
Formatting to and from Ethereum Units
Comprehensive Unit and Integration Test Coverage
CocoaPods is a dependency manager for Cocoa projects. You can install it with the following command:
$ sudo gem install cocoapods
To integrate web3swift into your Xcode project using CocoaPods, specify it in your
source 'https://github.com/CocoaPods/Specs.git' platform :ios, '9.0' target '<Your Target Name>' do use_frameworks! pod 'web3swift' end
Then, run the following command:
$ pod install
Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.
You can install Carthage with Homebrew using the following command:
$ brew update $ brew install carthage
To integrate web3swift into your Xcode project using Carthage, specify it in your
Create an empty Cartfile with the touch command and open it:
$ touch Cartfile $ open -a Xcode Cartfile
Add the following line to the Cartfile and save it:
github "matter-labs/web3swift" "master"
carthage update to build the framework. By default, Carthage performs checkouts and creates a new directory 'Carthage' in the same location as your Cartfile. Open this directory, go to 'Build' directory, choose iOS or macOS directory, and use the selected directory framework in your Xcode project.
- Swift Package Open xcode setting and add this repo as a source
let value: String = "1.0" // In Ether let walletAddress = EthereumAddress(wallet.address)! // Your wallet address let toAddress = EthereumAddress(toAddressString)! let contract = web3.contract(Web3.Utils.coldWalletABI, at: toAddress, abiVersion: 2)! let amount = Web3.Utils.parseToBigUInt(value, units: .eth) var options = TransactionOptions.defaultOptions options.value = amount options.from = walletAddress options.gasPrice = .automatic options.gasLimit = .automatic let tx = contract.write( "fallback", parameters: [AnyObject](), extraData: Data(), transactionOptions: options)!
Send ERC-20 Token
let web3 = Web3.InfuraMainnetWeb3() let value: String = "1.0" // In Tokens let walletAddress = EthereumAddress(wallet.address)! // Your wallet address let toAddress = EthereumAddress(toAddressString)! let erc20ContractAddress = EthereumAddress(token.address)! let contract = web3.contract(Web3.Utils.erc20ABI, at: erc20ContractAddress, abiVersion: 2)! let amount = Web3.Utils.parseToBigUInt(value, units: .eth) var options = TransactionOptions.defaultOptions options.value = amount options.from = walletAddress options.gasPrice = .automatic options.gasLimit = .automatic let method = "transfer" let tx = contract.write( method, parameters: [toAddress, amount] as [AnyObject], extraData: Data(), transactionOptions: options)!
Get account balance
let web3 = Web3.InfuraMainnetWeb3() let address = EthereumAddress("<Address>")! let balance = try web3.eth.getBalance(address: address) let balanceString = Web3.Utils.formatToEthereumUnits(balance, toUnits: .eth, decimals: 3)
Write Transaction and call smart contract method
let web3 = Web3.InfuraMainnetWeb3() let value: String = "0.0" // Any amount of Ether you need to send let walletAddress = EthereumAddress(wallet.address)! // Your wallet address let contractMethod = "SOMECONTRACTMETHOD" // Contract method you want to write let contractABI = "..." // Contract ABI let contractAddress = EthereumAddress(contractAddressString)! let abiVersion = 2 // Contract ABI version let parameters: [AnyObject] = [...]() // Parameters for contract method let extraData: Data = Data() // Extra data for contract method let contract = web3.contract(contractABI, at: contractAddress, abiVersion: abiVersion)! let amount = Web3.Utils.parseToBigUInt(value, units: .eth) var options = TransactionOptions.defaultOptions options.value = amount options.from = walletAddress options.gasPrice = .automatic options.gasLimit = .automatic let tx = contract.write( contractMethod, parameters: parameters, extraData: extraData, transactionOptions: options)!
You can see how to our demo project: WKWebView with injected "web3" provider:
git clone https://github.com/matter-labs/web3swift.git cd web3swift/Example/web3swiftBrowser pod install open ./web3swiftBrowser.xcworkspace
Build from source
- Clone repo
- Instal dependencies via
./carthage-build.sh --platform iOS(temp workaround, foe of Carthage bug. For details please look at
- iOS 9.0+ / macOS 10.11+
- Xcode 10.2+
- Swift 5.0+
For full documentation details and FAQ, please look at Documentation
If you need to find or understand an API, check Usage.md.
FAQ moved Documentation Page
Here are quick references for essential features:
- Preffered models
- Account Management (create, import, private keys managments, etc.)
- Ethereum Endpoints interaction (web3, balance, tx's operations, chain state)
Projects that are using web3swift
If you are using this library in your project, please add a link to this repo.
- Peepeth iOS client
- Ethereum & ERC20Tokens Wallet
- UP Wallet/loopr-ios
- MyENS Wallet
- Biomedical Data Sharing dApp - Geolocation
- Alice Wallet
- YOUR APP CAN BE THERE (click me)
Nothing makes developers happier than seeing someone else use our work and go wild with it.
- If you need help, open an issue.
- If you'd like to see web3swift best practices, check Projects that using web3swift.
- If you found a bug, open an issue.
Want to improve? It's awesome:
Then good news for you: We are ready to pay for your contribution via @gitcoin bot!
If you have a feature request, open an issue.
If you use any of our libraries for work, see if your employers would be interested in donating. Any amount you can donate today to help us reach our goal would be much appreciated.
Matter Labs are charged with open-sourсe and do not require money for using their web3swift lib. We want to continue to do everything we can to move the needle forward.
- Support us via @gitcoin Grant program
- Ether wallet address:
You are more than welcome to participate! Your contribution will be paid via @gitcoin Grant program.
L2 support (such as ZkSync)
Modularity with the basic Web3 subspec/SPM (the most basic functions like transaction signing and interacting with an http rpc server) and other modules with additional functionality
Complete Documentation (https://web3swift.github.io/web3swift)
Convenient methods for namespaces
If you believe you have identified a security vulnerability with web3swift, you should report it as soon as possible via email to [email protected]. Please do not post it to a public issue tracker.
web3swift is available under the Apache License 2.0 license. See the LICENSE for details.