You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+22-9
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
**web3swift** is an iOS toolbelt for interaction with the Ethereum network.
3
3
4
4
## Social medias
5
-
[Join our discord](https://discord.gg/8bHCNmhS7x) or [Telegram](https://t.me/web3swift) if you need a support or want to contribute to web3swift development!
5
+
[Join our discord](https://discord.gg/8bHCNmhS7x) or [Telegram](https://t.me/web3swift) if you need support or want to contribute to web3swift development!
-[x]:thought_balloon: Interaction with remote node via **JSON RPC**
50
50
-[x] 🔐 Local **keystore management** (`geth` compatible)
51
51
-[x] 🤖 Smart-contract **ABI parsing**
52
-
-[x] 🔓**ABI deconding** (V2 is supported with return of structures from public functions. Part of 0.4.22 Solidity compiler)
52
+
-[x] 🔓**ABI decoding** (V2 is supported with return of structures from public functions. Part of 0.4.22 Solidity compiler)
53
53
-[x] 🕸Ethereum Name Service **(ENS) support** - a secure & decentralised way to address resources both on and off the blockchain using simple, human-readable names
-[x] ⚒ **Parsing TxPool** content into native values (ethereum addresses and transactions) - easy to get pending transactions
57
57
-[x] 🖇 **Event loops** functionality
58
-
-[x] 🕵️♂️ Possibility to **add or remove "middleware" that intercepts**, modifies and even **cancel transaction** workflow on stages "before assembly", "after assembly"and "before submission"
58
+
-[x] 🕵️♂️ Possibility to **add or remove "middleware" that intercepts**, modifies and even **cancel transaction** workflow on stages "before assembly", "after assembly"and "before submission"
59
59
-[x] ✅**Literally following the standards** (BIP, EIP, etc):
let transaction: CodableTransaction = .emptyTransaction
117
-
transaction.from= from ?? transaction.sender// `sender` one is if you have private key of your wallet address, so public key e.g. your wallet address could be infereted
116
+
transaction.from= from ?? transaction.sender// `sender` one is if you have private key of your wallet address, so public key e.g. your wallet address could be interpreted
118
117
transaction.value= value
119
118
transaction.gasLimitPolicy= .manual(78423)
120
119
transaction.gasPricePolicy= .manual(20000000000)
@@ -166,16 +165,30 @@ swift build
166
165
Documentation is under construction👷🏻👷🏼♀️. We’re trying our best to comment all public API as detailed as we can, but the end it still far to come. But in one of the nearest minor updates we’ll bring DocC support of already done amount of docs. And your PR in such are more than welcome.
167
166
168
167
## Projects that are using web3swift
169
-
Please take a look at [Our costumers](https://github.com/skywinder/web3swift/wiki/Our-Customers) wiki page.
168
+
Please take a look at [Our customers](https://github.com/skywinder/web3swift/wiki/Our-Customers) wiki page.
170
169
171
170
## Support
172
171
173
-
**[Join our discord](https://discord.gg/8bHCNmhS7x) and [Telegram](https://t.me/web3swift) if you need a support or want to contribute to web3swift development!**
172
+
**[Join our discord](https://discord.gg/8bHCNmhS7x) and [Telegram](https://t.me/web3swift) if you need support or want to contribute to web3swift development!**
174
173
175
174
- If you **need help**, please take a look at our [FAQ](https://github.com/skywinder/web3swift/wiki/FAQ"") or [open an issue](https://github.com/skywinder/web3swift/issues).
176
175
- If you'd like to **see web3swift best practices**, check [Projects that using web3swift](https://github.com/skywinder/web3swift/wiki/Our-Customers).
177
176
- If you **found a bug**, [open an issue](https://github.com/skywinder/web3swift/issues).
178
177
178
+
## Development
179
+
To do local development and run the local tests, we recommend to use [ganache](https://github.com/trufflesuite/ganache) which is also used by CI when running github actions.
180
+
181
+
```cli
182
+
// To install
183
+
$ npm install ganache --global
184
+
185
+
// To run
186
+
$ ganache
187
+
```
188
+
189
+
This will create a local blockchain and also some test accounts that are used throughout our tests.
190
+
Make sure that `ganache` is running on its default port `8546`. To change the port in test cases locate `LocalTestCase.swift` and modify the static `url` variable.
191
+
179
192
## Contribute
180
193
Want to improve? It's awesome:
181
194
Then good news for you: **We are ready to pay for your contribution via [@gitcoin bot](https://gitcoin.co/grants/358/web3swift)!**
@@ -202,8 +215,8 @@ We want to continue to do everything we can to move the needle forward.
202
215
## Credits
203
216
204
217
- Alex Vlasov, [@shamatar](https://github.com/shamatar) - for the initial implementation
205
-
- Petr Korolev, [@skywinder](https://github.com/skywinder) - botstrap and continous support
206
-
- Anton Grigorev, [@baldyash](https://github.com/BaldyAsh) - core contributor, who use it and making a lot of ipmprovments
218
+
- Petr Korolev, [@skywinder](https://github.com/skywinder) - bootstrap and continuous support
219
+
- Anton Grigorev, [@baldyash](https://github.com/BaldyAsh) - core contributor, who use it and making a lot of improvements
207
220
- Yaroslav Yashin [@yaroslavyaroslav](https://github.com/yaroslavyaroslav) - core contributor of 3.0.0 and later releases.
208
221
- Thanks to [web3swift's growing list of contributors](https://github.com/skywinder/web3swift/graphs/contributors).
0 commit comments