Add ContractProtocol comment

- slightly refactor of ERC20 protocol (only style, to make it's logic more clear).

Author: yaroslavyaroslav

Sources/web3swift/Contract/ContractProtocol.swift

@@ -216,6 +216,7 @@ extension ContractProtocol {
 /// Contains default implementations of all functions of ``ContractProtocol``.
 public protocol DefaultContractProtocol: ContractProtocol {}
 extension DefaultContractProtocol {
+    // MARK: Writing Data flow
     public func deploy(bytecode: Data,
                        constructor: ABI.Element.Constructor?,
                        parameters: [AnyObject]?,
@@ -238,32 +239,51 @@ extension DefaultContractProtocol {
             fullData.append(extraData)
         }
 
+        // MARK: Writing Data flow
         return EthereumTransaction(to: .contractDeploymentAddress(),
                                    value: BigUInt(0),
                                    data: fullData,
                                    parameters: .init(gasLimit: BigUInt(0), gasPrice: BigUInt(0)))
     }
 
+    /// Call given contract method with given parameters
+    /// - Parameters:
+    ///   - method: Method to call
+    ///   - parameters: Parameters to pass to method call
+    ///   - extraData: Any additional data that needs to be encoded
+    /// - Returns: preset EthereumTransaction with filled date
+    ///
+    /// Returned transaction have filled following priperties:
+    ///   - to: contractAddress
+    ///   - value: 0
+    ///   - data: parameters + extraData
+    ///   - params: EthereumParameters with no contract method call encoded data.
     public func method(_ method: String,
                        parameters: [AnyObject],
                        extraData: Data?) -> EthereumTransaction? {
         guard let to = self.address else { return nil }
 
         let params = EthereumParameters(gasLimit: BigUInt(0), gasPrice: BigUInt(0))
 
+        // MARK: - Encoding ABI Data flow
         if method == "fallback" {
             return EthereumTransaction(to: to, value: BigUInt(0), data: extraData ?? Data(), parameters: params)
         }
 
         let method = Data.fromHex(method) == nil ? method : method.addHexPrefix().lowercased()
 
+        // MARK: - Encoding ABI Data flow
         guard let abiMethod = methods[method]?.first,
               var encodedData = abiMethod.encodeParameters(parameters) else { return nil }
 
+        // Extra data just appends in the end of parameters data
         if let extraData = extraData {
             encodedData.append(extraData)
         }
 
+        // MARK: - Encoding ABI Data flow
+        // return filled EthereumTransaction, which is could be sent iterate with a contract.
+        // But no gas related data here yet.
         return EthereumTransaction(to: to, value: BigUInt(0), data: encodedData, parameters: params)
     }
 

Sources/web3swift/Tokens/ERC20/Web3+ERC20.swift

@@ -53,7 +53,9 @@ public class ERC20: IERC20, ERC20BaseProperties {
         let contract = self.contract
         var transactionOptions = TransactionOptions()
         transactionOptions.callOnBlock = .latest
-        let result = try await contract.read("balanceOf", parameters: [account] as [AnyObject], extraData: Data(), transactionOptions: self.transactionOptions)!.call(transactionOptions: transactionOptions)
+        let result = try await contract
+            .read("balanceOf", parameters: [account] as [AnyObject], extraData: Data(), transactionOptions: self.transactionOptions)!
+            .call(transactionOptions: transactionOptions)
         guard let res = result["0"] as? BigUInt else {throw Web3Error.processingError(desc: "Failed to get result of expected type from the Ethereum node")}
         return res
     }
@@ -62,7 +64,9 @@ public class ERC20: IERC20, ERC20BaseProperties {
         let contract = self.contract
         var transactionOptions = TransactionOptions()
         transactionOptions.callOnBlock = .latest
-        let result = try await contract.read("allowance", parameters: [originalOwner, delegate] as [AnyObject], extraData: Data(), transactionOptions: self.transactionOptions)!.call(transactionOptions: transactionOptions)
+        let result = try await contract
+            .read("allowance", parameters: [originalOwner, delegate] as [AnyObject], extraData: Data(), transactionOptions: self.transactionOptions)!
+            .call(transactionOptions: transactionOptions)
         guard let res = result["0"] as? BigUInt else {throw Web3Error.processingError(desc: "Failed to get result of expected type from the Ethereum node")}
         return res
     }
@@ -75,7 +79,9 @@ public class ERC20: IERC20, ERC20BaseProperties {
         basicOptions.callOnBlock = .latest
 
         // get the decimals manually
-        let callResult = try await contract.read("decimals", transactionOptions: basicOptions)!.call()
+        let callResult = try await contract
+            .read("decimals", transactionOptions: basicOptions)!
+            .call()
         var decimals = BigUInt(0)
         guard let dec = callResult["0"], let decTyped = dec as? BigUInt else {
                 throw Web3Error.inputError(desc: "Contract may be not ERC20 compatible, can not get decimals")}
@@ -97,7 +103,9 @@ public class ERC20: IERC20, ERC20BaseProperties {
         basicOptions.callOnBlock = .latest
 
         // get the decimals manually
-        let callResult = try await contract.read("decimals", transactionOptions: basicOptions)!.call()
+        let callResult = try await contract
+            .read("decimals", transactionOptions: basicOptions)!
+            .call()
         var decimals = BigUInt(0)
         guard let dec = callResult["0"], let decTyped = dec as? BigUInt else {
             throw Web3Error.inputError(desc: "Contract may be not ERC20 compatible, can not get decimals")}
@@ -120,7 +128,9 @@ public class ERC20: IERC20, ERC20BaseProperties {
         basicOptions.callOnBlock = .latest
 
         // get the decimals manually
-        let callResult = try await contract.read("decimals", transactionOptions: basicOptions)!.call()
+        let callResult = try await contract
+            .read("decimals", transactionOptions: basicOptions)!
+            .call()
         var decimals = BigUInt(0)
         guard let dec = callResult["0"], let decTyped = dec as? BigUInt else {
             throw Web3Error.inputError(desc: "Contract may be not ERC20 compatible, can not get decimals")}
@@ -143,7 +153,9 @@ public class ERC20: IERC20, ERC20BaseProperties {
         basicOptions.callOnBlock = .latest
 
         // get the decimals manually
-        let callResult = try await contract.read("decimals", transactionOptions: basicOptions)!.call()
+        let callResult = try await contract
+            .read("decimals", transactionOptions: basicOptions)!
+            .call()
         var decimals = BigUInt(0)
         guard let dec = callResult["0"], let decTyped = dec as? BigUInt else {
             throw Web3Error.inputError(desc: "Contract may be not ERC20 compatible, can not get decimals")}
@@ -162,7 +174,9 @@ public class ERC20: IERC20, ERC20BaseProperties {
         let contract = self.contract
         var transactionOptions = TransactionOptions()
         transactionOptions.callOnBlock = .latest
-        let result = try await contract.read("totalSupply", parameters: [AnyObject](), extraData: Data(), transactionOptions: self.transactionOptions)!.call(transactionOptions: transactionOptions)
+        let result = try await contract
+            .read("totalSupply", parameters: [AnyObject](), extraData: Data(), transactionOptions: self.transactionOptions)!
+            .call(transactionOptions: transactionOptions)
         guard let res = result["0"] as? BigUInt else {throw Web3Error.processingError(desc: "Failed to get result of expected type from the Ethereum node")}
         return res
     }