Skip to content

Commit 1fe57c3

Browse files
committed
📖 update documentation
1 parent b581535 commit 1fe57c3

File tree

1 file changed

+41
-49
lines changed

1 file changed

+41
-49
lines changed

README.md

Lines changed: 41 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,12 @@
1717
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
1818

1919

20+
- [Core features](#core-features)
2021
- [Installation](#installation)
22+
- [Example usage](#example-usage)
2123
- [Requirements](#requirements)
2224
- [Migration Guides](#migration-guides)
2325
- [Documentation](#documentation)
24-
- [Examples](#examples)
25-
- [Web3View example](#web3view-example)
26-
- [FAQ](#faq)
27-
- [Core features:](#core-features)
2826
- [Projects that are using web3swift](#projects-that-are-using-web3swift)
2927
- [Support](#support)
3028
- [Contribute](#contribute)
@@ -35,6 +33,32 @@
3533

3634
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
3735

36+
## Core features
37+
38+
- [x] :zap: Swift implementation of [web3.js](https://github.com/ethereum/web3.js/) functionality
39+
- [x] :thought_balloon: Interaction with remote node via **JSON RPC**
40+
- [x] 🔐 Local **keystore management** (`geth` compatible)
41+
- [x] 🤖 Smart-contract **ABI parsing**
42+
- [x] 🔓**ABI deconding** (V2 is supported with return of structures from public functions. Part of 0.4.22 Solidity compiler)
43+
- [x] 🕸Ethereum Name Service **(ENS) support** - a secure & decentralised way to address resources both on and off the blockchain using simple, human-readable names
44+
- [x] :arrows_counterclockwise: **Smart contracts interactions** (read/write)
45+
- [x]**Infura support**, patial Websockets API support
46+
- [x]**Parsing TxPool** content into native values (ethereum addresses and transactions) - easy to get pending transactions
47+
- [x] 🖇 **Event loops** functionality
48+
- [x] 📱Supports Web3View functionality (WKWebView with **injected "web3" provider**)
49+
- [x] 🕵️‍♂️ Possibility to **add or remove "middleware" that intercepts**, modifies and even **cancel transaction** workflow on stages "before assembly", "after assembly"and "before submission"
50+
- [x]**Literally following the standards** (BIP, EIP, etc):
51+
52+
- [x] **[BIP32](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki) (HD Wallets), [BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki) (Seed phrases), [BIP44](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki) (Key generation prefixes)**
53+
- [x] **[EIP-20](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-20.md)** (Standart interface for tokens - ERC-20), **[EIP-67](https://github.com/ethereum/EIPs/issues/67)** (Standard URI scheme), **[EIP-155](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-155.md)** (Replay attacks protection)
54+
- [x] **And many others ** *(For more details about this EIP's look at [Documentation page](https://github.com/matter-labs/web3swift/blob/master/Documentation/))*: 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
55+
56+
- [x] 🗜 **Batched requests** in concurrent mode
57+
- [x] **RLP encoding**
58+
- [x] Base58 encoding scheme
59+
- [x] Formatting to and from Ethereum Units
60+
- [x] Comprehensive Unit and Integration Test Coverage
61+
3862
## Installation
3963

4064
- CocoaPods
@@ -92,7 +116,18 @@ github "matter-labs/web3swift" "master"
92116

93117
Run `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.
94118

119+
### Example usage
95120

121+
**Web3View example:**
122+
123+
You can see how to our demo project: **WKWebView with injected "web3" provider**:
124+
125+
``` bash
126+
git clone https://github.com/matter-labs/web3swift.git
127+
cd web3swift/Example/web3swiftBrowser
128+
pod install
129+
open ./web3swiftBrowser.xcworkspace
130+
```
96131
### Requirements
97132

98133
- iOS 9.0+ / macOS 10.11+
@@ -103,14 +138,14 @@ Run `carthage update` to build the framework. By default, Carthage performs chec
103138

104139
- [web3swift 2.0 Migration Guide](https://github.com/matterinc/web3swift/blob/master/Documentation/web3swift%202.0%20Migration%20Guide.md)
105140

106-
107-
---
108141
## Documentation
109142

110143
For full documentation details and FAQ, please look at [Documentation](https://github.com/matter-labs/web3swift/blob/master/Documentation/)
111144

112145
*If you need to find or understand an API, check [Usage.md](https://github.com/matter-labs/web3swift/blob/master/Documentation/Usage.md).*
113146

147+
**FAQ moved [Documentation Page](https://github.com/matter-labs/web3swift/blob/master/Documentation/)**
148+
114149
Here are quick references for essential features:
115150

116151
- [Preffered models](https://github.com/matter-labs/web3swift/blob/master/Documentation/Usage.md#preffered-models)
@@ -119,49 +154,6 @@ Here are quick references for essential features:
119154
- [Websockets](https://github.com/matter-labs/web3swift/blob/master/Documentation/Usage.md#websockets)
120155
- [ENS](https://github.com/matter-labs/web3swift/blob/master/Documentation/Usage.md#ens)
121156

122-
### Examples
123-
124-
#### Web3View example
125-
126-
You can see how to our demo project: **WKWebView with injected "web3" provider**:
127-
128-
- Clone: `git clone https://github.com/matter-labs/web3swift.git`
129-
- `cd web3swift/Example/web3swiftBrowser`
130-
- Install Dependencies: `pod install`
131-
- Open: `open ./web3swiftBrowser.xcworkspace`
132-
133-
## FAQ
134-
(Moved [Documentation Page](https://github.com/matter-labs/web3swift/blob/master/Documentation/))
135-
136-
137-
### Core features:
138-
139-
- [x] Swift implementation of [web3.js](https://github.com/ethereum/web3.js/) functionality :zap:
140-
- [x] Interaction with remote node via **JSON RPC** :thought_balloon:
141-
- [x] Local **keystore management** (`geth` compatible)
142-
- [x] Smart-contract **ABI parsing** :book:
143-
- [x] **ABI deconding** (V2 is supported with return of structures from public functions. Part of 0.4.22 Solidity compiler)
144-
- [x] Ethereum Name Service **(ENS) support** - a secure & decentralised way to address resources both on and off the blockchain using simple, human-readable names
145-
- [x] **Smart contracts interactions** (read/write) :arrows_counterclockwise:
146-
- [x] Complete **Infura support**, patial Websockets API support
147-
- [x] **Parsing TxPool** content into native values (ethereum addresses and transactions) - easy to get pending transactions
148-
- [x] **Event loops** functionality
149-
- [x] Supports Web3View functionality (WKWebView with **injected "web3" provider**)
150-
- [x] Possibility to **add or remove "middleware" that intercepts**, modifies and even **cancel transaction** workflow on stages "before assembly", "after assembly"and "before submission"
151-
- [x] **Literally following the standards** (BIP, EIP, etc):
152-
153-
- [x] **[BIP32](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki) (HD Wallets), [BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki) (Seed phrases), [BIP44](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki) (Key generation prefixes)**
154-
- [x] **[EIP-20](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-20.md)** (Standart interface for tokens - ERC-20), **[EIP-67](https://github.com/ethereum/EIPs/issues/67)** (Standard URI scheme), **[EIP-155](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-155.md)** (Replay attacks protection)
155-
- [x] **And many others ** *(For more details about this EIP's look at [Documentation page](https://github.com/matter-labs/web3swift/blob/master/Documentation/))*: 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
156-
157-
158-
- [x] **Batched requests** in concurrent mode
159-
- [x] **RLP encoding**
160-
- [x] Base58 encoding scheme
161-
- [x] Formatting to and from Ethereum Units
162-
- [x] Comprehensive Unit and Integration Test Coverage
163-
164-
165157
## Projects that are using web3swift
166158

167159
If you are using this library in your project, please [add a link](https://github.com/matter-labs/web3swift/edit/develop/README.md) to this repo.

0 commit comments

Comments
 (0)