Skip to content

Commit 8bf5950

Browse files
committed
update documentation headers
1 parent 90b55a6 commit 8bf5950

File tree

1 file changed

+25
-27
lines changed

1 file changed

+25
-27
lines changed

Documentation/Usage.md

Lines changed: 25 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ class ERC20Token {
9191

9292
### Create Account
9393

94-
#### Create Account With Private Key
94+
#### With Private Key
9595

9696
```swift
9797
let password = "web3swift" // We recommend here and everywhere to use the password set by the user.
@@ -102,7 +102,7 @@ let address = keystore.addresses!.first!.address
102102
let wallet = Wallet(address: address, data: keyData, name: name, isHD: false)
103103
```
104104

105-
#### Create Account With Mnemonics Phrase
105+
#### With Mnemonics Phrase
106106

107107
```swift
108108
let password = "web3swift"
@@ -121,7 +121,7 @@ let wallet = Wallet(address: address, data: keyData, name: name, isHD: true)
121121

122122
### Import Account
123123

124-
#### Import Account With Private Key
124+
#### With Private Key
125125

126126
```swift
127127
let password = "web3swift"
@@ -135,7 +135,7 @@ let address = keystore.addresses!.first!.address
135135
let wallet = Wallet(address: address, data: keyData, name: name, isHD: false)
136136
```
137137

138-
#### Import Account With Mnemonics Phrase
138+
#### With Mnemonics Phrase
139139

140140
```swift
141141
let password = "web3swift"
@@ -165,7 +165,7 @@ if wallet.isHD {
165165
}
166166
```
167167

168-
### Get wallet Private key
168+
### Get wallet private key
169169

170170
```swift
171171
let password = "web3swift"
@@ -195,7 +195,7 @@ web3.addKeystoreManager(keystoreManager)
195195

196196
### Ethereum Address
197197

198-
#### Initializing Ethereum Address
198+
#### Initializing
199199

200200
```swift
201201
let coldWalletAddress = EthereumAddress("0x6394b37Cf80A7358b38068f0CA4760ad49983a1B")!
@@ -205,15 +205,15 @@ Ethereum addresses are checksum checked if they are not lowercased or uppercased
205205

206206
### Get Balance
207207

208-
#### Getting ETH balance
208+
#### Get ETH balance
209209

210210
```swift
211211
let walletAddress = EthereumAddress(wallet.address)! // Address which balance we want to know
212212
let balanceResult = try! web3.eth.getBalance(address: walletAddress)
213213
let balanceString = Web3.Utils.formatToEthereumUnits(balanceResult, toUnits: .eth, decimals: 3)!
214214
```
215215

216-
#### Getting ERC20 token balance
216+
#### Get ERC20 token balance
217217

218218
```swift
219219
let walletAddress = EthereumAddress(wallet.address)! // Your wallet address
@@ -239,7 +239,7 @@ let balanceString = Web3.Utils.formatToEthereumUnits(balanceResult, toUnits: .et
239239

240240
#### Prepare Transaction
241241

242-
##### Preparing Transaction For Sending Ether
242+
##### Send Ether
243243

244244
```swift
245245
let value: String = "1.0" // In Ether
@@ -259,7 +259,7 @@ let tx = contract.write(
259259
transactionOptions: options)!
260260
```
261261

262-
##### Preparing Transaction For Sending ERC-20 Tokens
262+
##### Send ERC-20 Token
263263

264264
```swift
265265
let value: String = "1.0" // In Tokens
@@ -281,7 +281,7 @@ let tx = contract.write(
281281
transactionOptions: options)!
282282
```
283283

284-
##### Preparing Write Transaction for sending to some Contract and use its method
284+
##### Write Transaction and call smart contract method
285285

286286
```swift
287287
let value: String = "0.0" // Any amount of Ether you need to send
@@ -306,7 +306,7 @@ let tx = contract.write(
306306
transactionOptions: options)!
307307
```
308308

309-
##### Preparing Read Transaction to call some Contract method
309+
##### Read Transaction to call smart contract method
310310

311311
```swift
312312
let walletAddress = EthereumAddress(wallet.address)! // Your wallet address
@@ -328,17 +328,17 @@ let tx = contract.read(
328328
transactionOptions: options)!
329329
```
330330

331-
#### Send Transaction
331+
#### Send Transaction
332332

333-
##### Writing
333+
##### Write
334334

335335
```swift
336336
let password = "web3swift"
337337
let result = try! transaction.send(password: password)
338338
```
339339

340-
##### Reading
341-
340+
##### Read
341+
342342
```swift
343343
let result = try! transaction.call()
344344
```
@@ -361,13 +361,13 @@ Later, in order to open a connection to WebSocket server, you will use socket pr
361361
class DelegateClass: Web3SocketDelegate {
362362
var socketProvider: WebsocketProvider? = nil // WebSocket Provider
363363
var socketProvider: InfuraWebsocketProvider? = nil // Infura WebSocket Provider
364-
364+
365365
// Protocol method, here will be messages, received from WebSocket server
366366
func received(message: Any) {
367367
// Make something with message
368368
}
369369
}
370-
```
370+
```
371371

372372
### Custom Websocket Provider
373373

@@ -380,31 +380,31 @@ socketProvider.connectSocket()
380380
/// Some code
381381
/// ...
382382
socketProvider.disconnectSocket()
383-
```
383+
```
384384

385385
Or you can create already connected WebsocketProvider
386386
```swift
387387
socketProvider = WebsocketProvider.connectToSocket("ws://your.endpoint", delegate: delegate)
388388
```
389389

390-
#### Send message
390+
#### Send message
391391

392392
```swift
393393
// String message
394-
socketProvider.writeMessage(String())
394+
socketProvider.writeMessage(String())
395395
// Data message
396396
socketProvider.writeMessage(Data())
397397
```
398398

399-
### Infura Websocket Provider
399+
### Infura Websocket interactions
400400

401-
#### Connect to Infura endpoint
401+
#### Connect to Infura endpoint
402402

403403
```swift
404404
socketProvider = InfuraWebsocketProvider.connectToInfuraSocket(.Mainnet, delegate: delegate)
405405
```
406406

407-
#### Connect to custom endpoint with API similar to Infura WSS endpoint
407+
#### Connect to custom Infura-like endpoint
408408

409409
```swift
410410
socketProvider = InfuraWebsocketProvider.connectToSocket("ws://your.endpoint", delegate: delegate)
@@ -481,7 +481,7 @@ let doSomething = try! resolver. ...
481481
or set it as ENS instance property and use its methods from it:
482482
```swift
483483
try! ens.setENSResolver(withDomain: domain)
484-
let doSomething = try! ens.resolver!. ...
484+
let doSomething = try! ens.resolver!. ...
485485
```
486486

487487
### BaseRegistrar
@@ -504,5 +504,3 @@ You can set ReverseRegistrar as ENS instance property and use its methods from i
504504
ens.setReverseRegistrar(withAddresss: address)
505505
let doSomething = try! ens.reverseRegistrar!. ...
506506
```
507-
508-

0 commit comments

Comments
 (0)