Skip to content

Commit 430588d

Browse files
Update README.md
1 parent 8bc9a89 commit 430588d

File tree

1 file changed

+45
-32
lines changed

1 file changed

+45
-32
lines changed

README.md

Lines changed: 45 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
![matter-github-swift](https://github.com/matterinc/web3swift/blob/develop/web3swift-logo.png)
1+
![matter-github-swift](https://github.com/matter-labs/web3swift/blob/develop/web3swift-logo.png)
22

33
# web3swift
44

@@ -31,18 +31,18 @@
3131
* [License](#license)
3232

3333
---
34-
- [Usage Doc](https://github.com/matterinc/web3swift/blob/develop/Documentation/Usage.md)
34+
- [Usage Doc](https://github.com/matter-labs/web3swift/blob/develop/Documentation/Usage.md)
3535
- **Account Management**
36-
- [Create Account](https://github.com/matterinc/web3swift/blob/develop/Documentation/Usage.md#create-account)
37-
- [Import Account](https://github.com/matterinc/web3swift/blob/develop/Documentation/Usage.md#import-account)
38-
- [Manage Keystore](https://github.com/matterinc/web3swift/blob/develop/Documentation/Usage.md#manage-keystore)
39-
- [Ethereum Address](https://github.com/matterinc/web3swift/blob/develop/Documentation/Usage.md#ethereum-address)
40-
- [Get Balance](https://github.com/matterinc/web3swift/blob/develop/Documentation/Usage.md#get-balance)
36+
- [Create Account](https://github.com/matter-labs/web3swift/blob/develop/Documentation/Usage.md#create-account)
37+
- [Import Account](https://github.com/matter-labs/web3swift/blob/develop/Documentation/Usage.md#import-account)
38+
- [Manage Keystore](https://github.com/matter-labs/web3swift/blob/develop/Documentation/Usage.md#manage-keystore)
39+
- [Ethereum Address](https://github.com/matter-labs/web3swift/blob/develop/Documentation/Usage.md#ethereum-address)
40+
- [Get Balance](https://github.com/matter-labs/web3swift/blob/develop/Documentation/Usage.md#get-balance)
4141
- **Transactions Operations**
42-
- [Prepare Transaction](https://github.com/matterinc/web3swift/blob/develop/Documentation/Usage.md#prepare-transaction)
43-
- [Send Transaction](https://github.com/matterinc/web3swift/blob/develop/Documentation/Usage.md#send-transaction)
42+
- [Prepare Transaction](https://github.com/matter-labs/web3swift/blob/develop/Documentation/Usage.md#prepare-transaction)
43+
- [Send Transaction](https://github.com/matter-labs/web3swift/blob/develop/Documentation/Usage.md#send-transaction)
4444
- **Chain State**
45-
- [Get Block Number](https://github.com/matterinc/web3swift/blob/develop/Documentation/Usage.md#get-block-number)
45+
- [Get Block Number](https://github.com/matter-labs/web3swift/blob/develop/Documentation/Usage.md#get-block-number)
4646

4747

4848
## Ready Features
@@ -54,6 +54,7 @@
5454
- [x] ABI deconding (V2 is supported with return of structures from public functions. Part of 0.4.22 Solidity compiler)
5555
- [x] Ethereum Name Service (ENS) support - a secure & decentralised way to address resources both on and off the blockchain using simple, human-readable names
5656
- [x] Interactions (read/write to Smart contracts) :arrows_counterclockwise:
57+
- [x] Complete Infura Ethereum API support, patial Websockets API support
5758
- [x] Parsing TxPool content into native values (ethereum addresses and transactions) - easy to get pending transactions
5859
- [x] Event loops functionality
5960
- [x] Supports Web3View functionality - WKWebView with injected "web3" provider
@@ -80,6 +81,7 @@
8081
- [x] [EIP-721x](https://github.com/loomnetwork/erc721x) (An extension of ERC721 that adds support for multi-fungible tokens and batch transfers, while being fully backward-compatible, also known as ERC-721x)
8182
- [x] [EIP-1155](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1155.md) (Multi Token Standard, also known as ERC-1155)
8283
- [x] [EIP-1376](https://github.com/ethereum/EIPs/issues/1376) (Service-Friendly Token, also known as ERC-1376)
84+
- [x] [ST-20](https://github.com/PolymathNetwork/polymath-core) - ST-20 token is an Ethereum-based token implemented on top of the ERC-20 protocol that adds the ability for tokens to control transfers based on specific rules
8385

8486
- [x] RLP encoding
8587
- [x] Batched requests in concurrent mode
@@ -97,8 +99,8 @@
9799
## Requirements
98100

99101
- iOS 9.0+ / macOS 10.11+
100-
- Xcode 9.0+
101-
- Swift 4.1+
102+
- Xcode 10.2+
103+
- Swift 5.0+
102104

103105
## Migration Guides
104106

@@ -109,14 +111,14 @@
109111
When using this lib, please make references to this repo and give your start! :)
110112
*Nothing makes developers happier than seeing someone else use our work and go wild with it.*
111113

112-
If you are using web3swift in your app or know of an app that uses it, please add it to [this list](https://github.com/matterinc/web3swift/wiki/Apps-using-web3swift).
114+
If you are using web3swift in your app or know of an app that uses it, please add it to [this list](https://github.com/matter-labs/web3swift/wiki/Apps-using-web3swift).
113115

114116
- If you **need help**, use [Stack Overflow](https://stackoverflow.com/questions/tagged/web3swift) and tag `web3swift`.
115117
- If you need to **find or understand an API**, check [our documentation](http://web3swift.github.io/web3swift/).
116-
- If you'd like to **see web3swift best practices**, check [Apps using this library](https://github.com/matterinc/web3swift/wiki/Apps-using-web3swift).
117-
- If you **found a bug**, [open an issue](https://github.com/matterinc/web3swift/issues).
118-
- If you **have a feature request**, [open an issue](https://github.com/matterinc/web3swift/issues).
119-
- If you **want to contribute**, [submit a pull request](https://github.com/matterinc/web3swift/pulls).
118+
- If you'd like to **see web3swift best practices**, check [Apps using this library](https://github.com/matter-labs/web3swift/wiki/Apps-using-web3swift).
119+
- If you **found a bug**, [open an issue](https://github.com/matter-labs/web3swift/issues).
120+
- If you **have a feature request**, [open an issue](https://github.com/matter-labs/web3swift/issues).
121+
- If you **want to contribute**, [submit a pull request](https://github.com/matter-labs/web3swift/pulls).
120122

121123
## Installation
122124

@@ -136,7 +138,7 @@ platform :ios, '9.0'
136138

137139
target '<Your Target Name>' do
138140
use_frameworks!
139-
pod 'web3swift'
141+
pod 'web3swift', '~> 2.1.3'
140142
end
141143
```
142144

@@ -157,19 +159,27 @@ $ brew update
157159
$ brew install carthage
158160
```
159161

160-
To integrate web3swift into your Xcode project using Carthage, specify it in your `Cartfile`:
162+
To integrate web3swift into your Xcode project using Carthage, specify it in your `Cartfile`.
163+
Create an empty Cartfile with the touch command and open it:
164+
165+
```bash
166+
$ touch Cartfile
167+
$ open -a Xcode Cartfile
168+
```
169+
170+
Add the following line to the Cartfile and save it:
161171

162172
```ogdl
163-
github "matterinc/web3swift" "carthage"
173+
github "matter-labs/web3swift" "carthage"
164174
```
165175

166-
Run `carthage update` to build the framework and drag the built `web3swift.framework` into your Xcode project.
176+
Run `carthage update` to build the framework. By default, Carthage performs checkouts and builds in 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 framework from chosen directory in your Xcode project.
167177

168178
## Example Project
169179

170180
You can try lib by running the example project:
171181

172-
- Clone the repo: `git clone https://github.com/matterinc/web3swift.git`
182+
- Clone the repo: `git clone https://github.com/matter-labs/web3swift.git`
173183
- Move to the repo: `cd web3swift/Example/web3swiftExample`
174184
- Install Dependencies: `pod install`
175185
- Open: `open ./web3swiftExample.xcworkspace`
@@ -193,7 +203,7 @@ You can get the ABI of your contract directly from [Remix IDE](https://remix.eth
193203
Then you should use contract address and ABI in creating contract object. In example we use Infura Mainnet:
194204
```swift
195205
let yourContractABI: String = <CONTRACT JSON ABI>
196-
let toEthereumAddress: EthereumAddress? = <DESTINATION ETHEREUM ADDRESS>
206+
let toEthereumAddress: EthereumAddress = <DESTINATION ETHEREUM ADDRESS>
197207
let abiVersion: Int = <ABI VERSION NUMBER>
198208

199209
let contract = Web3.InfuraMainnetWeb3().contract(yourContractABI, at: toEthereumAddress, abiVersion: abiVersion)
@@ -229,21 +239,24 @@ func setLocalNode(port: Int = 8545) -> Web3? {
229239

230240
## What's next
231241

232-
- [x] [R-Token](https://github.com/harborhq/r-token) (Smart Contracts for applying regulatory compliance to tokenized securities issuance and trading)
233-
- [x] [SRC-20](https://swarm.fund/swarm-basics/) (Swarm protocol that enables the tokenization of assets on the blockchain - Security Tokens)
234-
- [x] [ST-20](https://github.com/PolymathNetwork/polymath-core) (ST-20 token is an Ethereum-based token implemented on top of the ERC-20 protocol that adds the ability for tokens to control transfers based on specific rules)
235-
- [x] [Objective-C] - a proxy bridge to build your DApp on Objective-C using web3swift
236-
- [x] [Performance Improvements]
237-
- [x] [More convenient methods for basic namespaces]
238-
- [x] [Complete Documentation](https://web3swift.github.io/web3swift)
239-
242+
- [x] Objective-C - a proxy bridge to build your DApp on Objective-C using web3swift
243+
- [x] Complete Documentation (https://web3swift.github.io/web3swift)
244+
- [x] 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
245+
- [x] [R-Token](https://github.com/harborhq/r-token) - Smart Contracts for applying regulatory compliance to tokenized securities issuance and trading
246+
- [x] Complete support Infura Websockets API
247+
- [x] Support IPFS via Infura public IPFS gateway
248+
- [x] Support more blockchains - Ripple, Bitcoin, EOS, etc.
249+
- [x] Performance Improvements
250+
- [x] More convenient methods for basic namespaces
240251

241252
## Credits
242253

243254
Alex Vlasov, [@shamatar](https://github.com/shamatar), [email protected]
244255

245256
Petr Korolev, [@skywinder](https://github.com/skywinder)
246257

258+
Anton Grigorev [@baldyash](https://github.com/BaldyAsh), [email protected]
259+
247260
### Security Disclosure
248261

249262
If you believe you have identified a security vulnerability with web3swift, you should report it as soon as possible via email to [Alex Vlasov](https://github.com/shamatar) [email protected]. Please do not post it to a public issue tracker.
@@ -260,4 +273,4 @@ Our Ether wallet address: 0xe22b8979739d724343bd002f9f432f5990879901
260273

261274
## License
262275

263-
web3swift is available under the Apache License 2.0 license. See the [LICENSE](https://github.com/matterinc/web3swift/blob/documentation/LICENSE) for details.
276+
web3swift is available under the Apache License 2.0 license. See the [LICENSE](https://github.com/matter-labs/web3swift/blob/documentation/LICENSE) for details.

0 commit comments

Comments
 (0)