clean up deprecated warnings created as a result of the updates to EthereumTransaction

Author: mloit

Sources/web3swift/Contract/EthereumContract.swift

@@ -114,15 +114,18 @@ public struct EthereumContract: ContractProtocol {
         } else if extraData != Data() {
             fullData.append(extraData)
         }
-        let transaction = EthereumTransaction(gasPrice: BigUInt(0), gasLimit: BigUInt(0), to: to, value: BigUInt(0), data: fullData)
+        let params = EthereumParameters(gasLimit: BigUInt(0), gasPrice: BigUInt(0))
+        let transaction = EthereumTransaction(to: to, value: BigUInt(0), data: fullData, parameters: params)
         return transaction
     }
 
     public func method(_ method: String = "fallback", parameters: [AnyObject] = [AnyObject](), extraData: Data = Data()) -> EthereumTransaction? {
         guard let to = self.address else {return nil}
 
         if (method == "fallback") {
-            let transaction = EthereumTransaction(gasPrice: BigUInt(0), gasLimit: BigUInt(0), to: to, value: BigUInt(0), data: extraData)
+            let params = EthereumParameters(gasLimit: BigUInt(0), gasPrice: BigUInt(0))
+            let transaction = EthereumTransaction(to: to, value: BigUInt(0), data: extraData, parameters: params)
+
             return transaction
         }
         let foundMethod = self.methods.filter { (key, value) -> Bool in
@@ -131,7 +134,8 @@ public struct EthereumContract: ContractProtocol {
         guard foundMethod.count == 1 else {return nil}
         let abiMethod = foundMethod[method]
         guard let encodedData = abiMethod?.encodeParameters(parameters) else {return nil}
-        let transaction = EthereumTransaction(gasPrice: BigUInt(0), gasLimit: BigUInt(0), to: to, value: BigUInt(0), data: encodedData)
+        let params = EthereumParameters(gasLimit: BigUInt(0), gasPrice: BigUInt(0))
+        let transaction = EthereumTransaction(to: to, value: BigUInt(0), data: encodedData, parameters: params)
         return transaction
     }
 

Sources/web3swift/HookedFunctions/Web3+BrowserFunctions.swift

@@ -134,10 +134,10 @@ extension web3.BrowserFunctions {
             var options = opts
             guard let _ = options.from else {return (nil, nil)}
             let gasPrice = try self.web3.eth.getGasPrice()
-            transaction.gasPrice = gasPrice
+            transaction.parameters.gasPrice = gasPrice
             options.gasPrice = .manual(gasPrice)
             guard let gasEstimate = self.estimateGas(transaction, transactionOptions: options) else {return (nil, nil)}
-            transaction.gasLimit = gasEstimate
+            transaction.parameters.gasLimit = gasEstimate
             options.gasLimit = .limited(gasEstimate)
             print(transaction)
             return (transaction, options)
@@ -176,18 +176,18 @@ extension web3.BrowserFunctions {
             guard let noncePolicy = transactionOptions.nonce else {return nil}
             switch gasPricePolicy {
             case .manual(let gasPrice):
-                transaction.gasPrice = gasPrice
+                transaction.parameters.gasPrice = gasPrice
             default:
                 let gasPrice = try self.web3.eth.getGasPrice()
-                transaction.gasPrice = gasPrice
+                transaction.parameters.gasPrice = gasPrice
             }
 
             switch gasLimitPolicy {
             case .manual(let gasLimit):
-                transaction.gasLimit = gasLimit
+                transaction.parameters.gasLimit = gasLimit
             default:
                 let gasLimit = try self.web3.eth.estimateGas(transaction, transactionOptions: transactionOptions)
-                transaction.gasLimit = gasLimit
+                transaction.parameters.gasLimit = gasLimit
             }
 
             switch noncePolicy {
@@ -205,7 +205,7 @@ extension web3.BrowserFunctions {
             guard let keystore = keystoreManager.walletForAddress(from) else {return nil}
             try Web3Signer.signTX(transaction: &transaction, keystore: keystore, account: from, password: password)
             print(transaction)
-            let signedData = transaction.encode(forSignature: false, chainID: nil)?.toHexString().addHexPrefix()
+            let signedData = transaction.encode()?.toHexString().addHexPrefix()
             return signedData
         } catch {
             return nil

Sources/web3swift/Transaction/EthereumTransaction.swift

@@ -48,7 +48,11 @@ public struct EthereumTransaction: CustomStringConvertible {
         set(newValue) { envelope.parameters.data = newValue }
     }
 
-    // transaction type specific parameters should be accessed with TransactionOptions via getOptions()
+    // transaction type specific parameters should be accessed with EthereumParameters
+    public var parameters: EthereumParameters {
+        get { return envelope.parameters }
+        set(val) { envelope.parameters = val }
+    }
 
     // signature data is read-only
     /// signature v component (read only)
@@ -239,15 +243,12 @@ extension EthereumTransaction {
     ///   - v: signature v parameter (default 1) - will get set properly once signed
     ///   - r: signature r parameter (default 0) - will get set properly once signed
     ///   - s: signature s parameter (default 0) - will get set properly once signed
-    ///   - options: TransactionObject containing additional parametrs for the transaction like gas
+    ///   - parameters: EthereumParameters object containing additional parametrs for the transaction like gas
     public init(type: TransactionType? = nil, to: EthereumAddress, nonce: BigUInt = 0,
                 chainID: BigUInt? = nil, value: BigUInt? = nil, data: Data,
-                v: BigUInt = 1, r: BigUInt = 0, s: BigUInt = 0, options: TransactionOptions? = nil) {
+                v: BigUInt = 1, r: BigUInt = 0, s: BigUInt = 0, parameters: EthereumParameters? = nil) {
 
-        var params: EthereumParameters
-        // swiftlint:disable force_unwrapping
-        if options != nil { params = EthereumParameters(from: options!) } else { params = EthereumParameters() }
-        // swiftlint:enable force_unwrapping
+        var params = parameters ?? EthereumParameters()
 
         params.chainID = chainID ?? params.chainID
         params.value = value ?? params.value

Tests/web3swiftTests/localTests/LocalTests.xctestplan

@@ -15,12 +15,13 @@
     {
       "skippedTests" : [
         "ENSTests",
-        "RemoteTests",
         "GasOracleTests",
         "InfuraTests",
+        "OracleTests",
         "RemoteParsingTests",
+        "RemoteTests",
         "ST20AndSecurityTokenTests",
-        "WebsocketTests",
+        "WebsocketTests"
       ],
       "target" : {
         "containerPath" : "container:web3swift.xcodeproj",

Tests/web3swiftTests/localTests/web3swiftBasicLocalNodeTests.swift

@@ -92,7 +92,8 @@ class web3swiftBasicLocalNodeTests: XCTestCase {
         print("Balance after from: " + balanceAfterFrom.description)
 
         XCTAssert(balanceAfterTo - balanceBeforeTo == valueToSend)
-        XCTAssert(balanceBeforeFrom - (balanceAfterFrom + receipt.gasUsed * details.transaction.gasPrice) == valueToSend)
+        let txnGasPrice = details.transaction.parameters.gasPrice ?? 0
+        XCTAssert(balanceBeforeFrom - (balanceAfterFrom + receipt.gasUsed * txnGasPrice) == valueToSend)
     }
 
     // FIXME: Crashes on CI/CD

Tests/web3swiftTests/localTests/web3swiftPromisesTests.swift

@@ -34,7 +34,7 @@ class web3swiftPromisesTests: XCTestCase {
         let txHash = writeResult.hash
         let result = try web3.eth.getTransactionDetailsPromise(txHash).wait()
         print(result)
-        XCTAssert(result.transaction.gasLimit == BigUInt(gasLimit))
+        XCTAssert(result.transaction.parameters.gasLimit == BigUInt(gasLimit))
     }
 
     func testEstimateGasPromise() throws {

Tests/web3swiftTests/localTests/web3swiftTransactionsTests.swift

@@ -598,13 +598,13 @@ class web3swiftTransactionsTests: XCTestCase {
 
     func testDirectTransaction() throws {
         do {
-            var options = TransactionOptions()
-            options.gasPrice = .manual(20000000000)
-            options.gasLimit = .manual(21000)
+            var params = EthereumParameters()
+            params.gasPrice = 20000000000
+            params.gasLimit = 21000
             var transaction = EthereumTransaction(
                 to: EthereumAddress("0x3535353535353535353535353535353535353535")!,
                 nonce: 9, value: 1000000000000000000, data: Data(),
-                v: 0, r: 0, s: 0, options: options)
+                v: 0, r: 0, s: 0, parameters: params)
             let privateKeyData = Data.fromHex("0x4646464646464646464646464646464646464646464646464646464646464646")!
             let publicKey = Web3.Utils.privateToPublic(privateKeyData, compressed: false)
             let sender = Web3.Utils.publicToAddress(publicKey!)
@@ -654,7 +654,7 @@ class web3swiftTransactionsTests: XCTestCase {
 
             let details = try web3.eth.getTransactionDetails(txHash)
             print(details)
-            let txnGasLimit = details.transaction.gasLimit
+            let txnGasLimit = details.transaction.parameters.gasLimit
             XCTAssert(txnGasLimit == BigUInt(78423))
         } catch Web3Error.nodeError(let descr) {
             guard descr == "insufficient funds for gas * price + value" else {return XCTFail()}

Tests/web3swiftTests/localTests/web3swiftUserCases.swift

@@ -47,7 +47,7 @@ class web3swiftUserCases: XCTestCase {
         let gasEstimate = try writeTX.estimateGasPromise().wait()
         writeTX.transactionOptions.gasLimit = .manual(gasEstimate + 1234)
         let assembled = try writeTX.assemblePromise().wait()
-        let txnGasLimit = assembled.gasLimit
+        let txnGasLimit = assembled.parameters.gasLimit
         XCTAssert(txnGasLimit == gasEstimate + 1234)
     }
 
@@ -62,8 +62,8 @@ class web3swiftUserCases: XCTestCase {
         let gasEstimate = try writeTX.estimateGasPromise().wait()
         writeTX.transactionOptions.gasLimit = .manual(gasEstimate + 1234)
         let assembled = try writeTX.assemblePromise().wait()
-        let txnGasLimit = assembled.gasLimit
-        let txnGasPrice = assembled.gasPrice
+        let txnGasLimit = assembled.parameters.gasLimit
+        let txnGasPrice = assembled.parameters.gasPrice
 
         XCTAssert(txnGasLimit == gasEstimate + 1234)
         XCTAssert(txnGasPrice == gasPrice * 2)