Update [Read|Write]Transaction API

- No method accepts any parameters to merge with (it handles the CodableTransaction in its property).
- Delete its gasEstimate method, since such method should be in CodableTransaction scope.
- No default password as argument.
- Code which calls such types are changed appropriate, to let project builds, but no logic have been changed yet.

Author: yaroslavyaroslav

Documentation/web3swift 2.0 Migration Guide.md

@@ -109,8 +109,8 @@ web3.addKeystoreManager(KeysService().keystoreManager())
 guard let ethAddressFrom = EthereumAddress(selectedKey) else {return}
 guard let contract = web3.contract(Web3.Utils.coldWalletABI, at: destinationEthAddress, abiVersion: 2) else {return}
 guard let writeTX = contract.write("fallback") else {return}
-writeTX.transactionOptions.from = ethAddressFrom
-writeTX.transactionOptions.value = value
+writeTX.transaction.from = ethAddressFrom
+writeTX.transaction.value = value
 return writeTX
 ```
 
@@ -152,8 +152,8 @@ web3.addKeystoreManager(KeysService().keystoreManager())
 guard let ethAddressFrom = EthereumAddress(selectedKey) else {return}
 guard let contract = web3.contract(Web3.Utils.erc20ABI, at: contractAddress, abiVersion: 2) else {return}
 guard let writeTX = contract.write("transfer") else {return}
-writeTX.transactionOptions.from = ethAddressFrom
-writeTX.transactionOptions.value = value
+writeTX.transaction.from = ethAddressFrom
+writeTX.transaction.value = value
 return writeTX
 ```
 
@@ -195,8 +195,8 @@ guard let writeTX = contract.write(method,
                                    parameters: parameters,
                                    extraData: data,
                                    transactionOptions: predefinedOptions) else {return}
-writeTX.transactionOptions.from = ethAddressFrom
-writeTX.transactionOptions.value = value
+writeTX.transaction.from = ethAddressFrom
+writeTX.transaction.value = value
 return writeTX
 ```
 
@@ -273,7 +273,7 @@ let contractAddress = EthereumAddress("<Contract address>")! // w3s token on Eth
 let contract = web3.contract(Web3.Utils.erc20ABI, at: contractAddress, abiVersion: 2) // utilize precompiled ERC20 ABI for your concenience
 let userAddress = EthereumAddress("<address>")!
 guard let readTX = contract?.read("balanceOf", parameters: [addressOfUser] as [AnyObject]) else {return}
-readTX.transactionOptions.from = EthereumAddress("<address>")!
+readTX.transaction.from = EthereumAddress("<address>")!
 let tokenBalance = try readTX.callPromise()
 guard let balance = tokenBalance["0"] as? BigUInt else {return}
 ```

Sources/Core/Transaction/CodableTransaction.swift

@@ -7,6 +7,11 @@
 import Foundation
 import BigInt
 
+
+public protocol CodableTransactionInheritable {
+    var transactionOptions: CodableTransaction { get }
+}
+
 ///  Structure capable of carying the parameters for any transaction type.
 ///  while all fields in this struct are optional, they are not necessarily
 ///  optional for the type of transaction they apply to.
@@ -432,6 +437,7 @@ extension CodableTransaction {
         self.gasPricePolicy = .automatic
         self.maxFeePerGasPolicy = .automatic
         self.maxPriorityFeePerGasPolicy = .automatic
+        self.callOnBlock = .latest
 
         self.envelope = EnvelopeFactory.createEnvelope(type: type, to: to, nonce: nonce, chainID: chainID, value: value, data: data, gasLimit: gasLimit, maxFeePerGas: maxFeePerGas, maxPriorityFeePerGas: maxPriorityFeePerGas, gasPrice: gasPrice, accessList: accessList, v: v, r: r, s: s)
     }

Sources/web3swift/EthereumAPICalls/Ethereum/Eth+Call.swift

@@ -11,11 +11,9 @@ extension web3.Eth {
 
     // FIXME: Rewrite this to CodableTransaction
     // FIXME: Not working yet.
-    public func callTransaction(_ transaction: CodableTransaction, transactionOptions: CodableTransaction?) async throws -> Data {
-        // MARK: Read data from ABI flow
-        // guard let transactionParameters = transaction.encodeAsDictionary(from: transactionOptions?.from) else { throw Web3Error.dataError}
+    public func callTransaction(_ transaction: CodableTransaction) async throws -> Data {
         // FIXME: Make me CodableTransaction
-        let request: APIRequest = .call(transaction, transactionOptions?.callOnBlock ?? .latest)
+        let request: APIRequest = .call(transaction, transaction.callOnBlock ?? .latest)
         let response: APIResponse<Data> = try await APIRequest.sendRequest(with: self.provider, for: request)
         return response.result
     }

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

@@ -106,7 +106,7 @@ public class ERC1155: IERC1155 {
         let contract = self.contract
         var transactionOptions = CodableTransaction.emptyTransaction
         transactionOptions.callOnBlock = .latest
-        let result = try await contract.read("balanceOf", parameters: [account, id] as [AnyObject], extraData: Data(), transactionOptions: self.transactionOptions)!.decodedData(with: transactionOptions)
+        let result = try await contract.read("balanceOf", parameters: [account, id] as [AnyObject], extraData: Data(), transactionOptions: self.transactionOptions)!.decodedData()
         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
     }
@@ -125,7 +125,7 @@ public class ERC1155: IERC1155 {
         let contract = self.contract
         var basicOptions = CodableTransaction.emptyTransaction
         basicOptions.callOnBlock = .latest
-        let result = try await contract.read("isApprovedForAll", parameters: [owner, user, scope] as [AnyObject], extraData: Data(), transactionOptions: self.transactionOptions)!.decodedData(with: transactionOptions)
+        let result = try await contract.read("isApprovedForAll", parameters: [owner, user, scope] as [AnyObject], extraData: Data(), transactionOptions: self.transactionOptions)!.decodedData()
         guard let res = result["0"] as? Bool else {throw Web3Error.processingError(desc: "Failed to get result of expected type from the Ethereum node")}
         return res
     }
@@ -135,7 +135,7 @@ public class ERC1155: IERC1155 {
         var transactionOptions = CodableTransaction.emptyTransaction
         transactionOptions.callOnBlock = .latest
         transactionOptions.gasLimitPolicy = .manual(30000)
-        let result = try await contract.read("supportsInterface", parameters: [interfaceID] as [AnyObject], extraData: Data(), transactionOptions: self.transactionOptions)!.decodedData(with: transactionOptions)
+        let result = try await contract.read("supportsInterface", parameters: [interfaceID] as [AnyObject], extraData: Data(), transactionOptions: self.transactionOptions)!.decodedData()
         guard let res = result["0"] as? Bool else {throw Web3Error.processingError(desc: "Failed to get result of expected type from the Ethereum node")}
         return res
     }

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

@@ -99,7 +99,7 @@ public class ERC1376: IERC1376, ERC20BaseProperties {
         let contract = self.contract
         var transactionOptions = CodableTransaction.emptyTransaction
         transactionOptions.callOnBlock = .latest
-        let result = try await contract.read("balanceOf", parameters: [account] as [AnyObject], extraData: Data(), transactionOptions: self.transactionOptions)!.decodedData(with: transactionOptions)
+        let result = try await contract.read("balanceOf", parameters: [account] as [AnyObject], extraData: Data(), transactionOptions: self.transactionOptions)!.decodedData()
         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
     }
@@ -108,7 +108,7 @@ public class ERC1376: IERC1376, ERC20BaseProperties {
         let contract = self.contract
         var transactionOptions = CodableTransaction.emptyTransaction
         transactionOptions.callOnBlock = .latest
-        let result = try await contract.read("allowance", parameters: [originalOwner, delegate] as [AnyObject], extraData: Data(), transactionOptions: self.transactionOptions)!.decodedData(with: transactionOptions)
+        let result = try await contract.read("allowance", parameters: [originalOwner, delegate] as [AnyObject], extraData: Data(), transactionOptions: self.transactionOptions)!.decodedData()
         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
     }
@@ -208,7 +208,7 @@ public class ERC1376: IERC1376, ERC20BaseProperties {
         let contract = self.contract
         var transactionOptions = CodableTransaction.emptyTransaction
         transactionOptions.callOnBlock = .latest
-        let result = try await contract.read("totalSupply", parameters: [AnyObject](), extraData: Data(), transactionOptions: self.transactionOptions)!.decodedData(with: transactionOptions)
+        let result = try await contract.read("totalSupply", parameters: [AnyObject](), extraData: Data(), transactionOptions: self.transactionOptions)!.decodedData()
         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
     }
@@ -299,7 +299,7 @@ public class ERC1376: IERC1376, ERC20BaseProperties {
         let contract = self.contract
         var transactionOptions = CodableTransaction.emptyTransaction
         transactionOptions.callOnBlock = .latest
-        let result = try await contract.read("spendableAllowance", parameters: [owner, spender] as [AnyObject], extraData: Data(), transactionOptions: self.transactionOptions)!.decodedData(with: transactionOptions)
+        let result = try await contract.read("spendableAllowance", parameters: [owner, spender] as [AnyObject], extraData: Data(), transactionOptions: self.transactionOptions)!.decodedData()
         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
     }
@@ -352,7 +352,7 @@ public class ERC1376: IERC1376, ERC20BaseProperties {
         let contract = self.contract
         var transactionOptions = CodableTransaction.emptyTransaction
         transactionOptions.callOnBlock = .latest
-        let result = try await contract.read("nonceOf", parameters: [owner] as [AnyObject], extraData: Data(), transactionOptions: self.transactionOptions)!.decodedData(with: transactionOptions)
+        let result = try await contract.read("nonceOf", parameters: [owner] as [AnyObject], extraData: Data(), transactionOptions: self.transactionOptions)!.decodedData()
         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
     }
@@ -397,7 +397,7 @@ public class ERC1376: IERC1376, ERC20BaseProperties {
         let contract = self.contract
         var transactionOptions = CodableTransaction.emptyTransaction
         transactionOptions.callOnBlock = .latest
-        let result = try await contract.read("directDebit", parameters: [debtor, receiver] as [AnyObject], extraData: Data(), transactionOptions: self.transactionOptions)!.decodedData(with: transactionOptions)
+        let result = try await contract.read("directDebit", parameters: [debtor, receiver] as [AnyObject], extraData: Data(), transactionOptions: self.transactionOptions)!.decodedData()
         guard let res = result["0"] as? DirectDebit else {throw Web3Error.processingError(desc: "Failed to get result of expected type from the Ethereum node")}
         return res
     }