renamed to remove Promise from syntax

pharms-eth · pharms-eth · commit b0b017922d64 · 2022-04-16T19:30:34.000-07:00
diff --git a/Documentation/web3swift 2.0 Migration Guide.md b/Documentation/web3swift 2.0 Migration Guide.md
@@ -274,7 +274,7 @@ let contract = web3.contract(Web3.Utils.erc20ABI, at: contractAddress, abiVersio
 let userAddress = EthereumAddress("<address>")!
 guard let readTX = contract?.read("balanceOf", parameters: [addressOfUser] as [AnyObject]) else {return}
 readTX.transactionOptions.from = EthereumAddress("<address>")!
-let tokenBalance = try readTX.callPromise().wait()
+let tokenBalance = try readTX.callPromise()
 guard let balance = tokenBalance["0"] as? BigUInt else {return}
 ```
 
diff --git a/Sources/web3swift/Promises/Promise+Web3+Eth+GetTransactionCount.swift b/Sources/web3swift/Promises/Promise+Web3+Eth+GetTransactionCount.swift
@@ -9,12 +9,12 @@ import BigInt
 
 
 extension web3.Eth {
-    public func getTransactionCountPromise(address: EthereumAddress, onBlock: String = "latest") async throws -> BigUInt {
+    public func getTransactionCount(for address: EthereumAddress, onBlock: String = "latest") async throws -> BigUInt {
         let addr = address.address
-        return try await getTransactionCountPromise(address: addr, onBlock: onBlock)
+        return try await getTransactionCount(address: addr, onBlock: onBlock)
     }
 
-    public func getTransactionCountPromise(address: String, onBlock: String = "latest") async throws -> BigUInt {
+    public func getTransactionCount(address: String, onBlock: String = "latest") async throws -> BigUInt {
         let request = JSONRPCRequestFabric.prepareRequest(.getTransactionCount, parameters: [address.lowercased(), onBlock])
         let response = try await web3.dispatch(request)
 
diff --git a/Sources/web3swift/Tokens/ERC1155/Web3+ERC1155.swift b/Sources/web3swift/Tokens/ERC1155/Web3+ERC1155.swift
@@ -73,7 +73,7 @@ public class ERC1155: IERC1155 {
         var transactionOptions = TransactionOptions.defaultOptions
         transactionOptions.callOnBlock = .latest
 
-        guard let tokenIdPromise = try await contract.read("id", parameters: [] as [AnyObject], extraData: Data(), transactionOptions: transactionOptions)?.callPromise() else {return}
+        guard let tokenIdPromise = try await contract.read("id", parameters: [] as [AnyObject], extraData: Data(), transactionOptions: transactionOptions)?.decodedData() else {return}
 
         guard let tokenId = tokenIdPromise["0"] as? BigUInt else {return}
         self._tokenId = tokenId
diff --git a/Sources/web3swift/Tokens/ERC20/Web3+ERC20.swift b/Sources/web3swift/Tokens/ERC20/Web3+ERC20.swift
@@ -204,11 +204,11 @@ extension ERC20BaseProperties {
         var transactionOptionsVAR = TransactionOptions.defaultOptions
         transactionOptionsVAR.callOnBlock = .latest
         let transactionOptions = transactionOptionsVAR
-        async let namePromise = contract.read("name", parameters: [AnyObject](), extraData: Data(), transactionOptions: transactionOptions)?.callPromise()
+        async let namePromise = contract.read("name", parameters: [AnyObject](), extraData: Data(), transactionOptions: transactionOptions)?.decodedData()
 
-        async let symbolPromise = try await contract.read("symbol", parameters: [AnyObject](), extraData: Data(), transactionOptions: transactionOptions)?.callPromise()
+        async let symbolPromise = try await contract.read("symbol", parameters: [AnyObject](), extraData: Data(), transactionOptions: transactionOptions)?.decodedData()
 
-        async let decimalPromise = try await contract.read("decimals", parameters: [AnyObject](), extraData: Data(), transactionOptions: transactionOptions)?.callPromise()
+        async let decimalPromise = try await contract.read("decimals", parameters: [AnyObject](), extraData: Data(), transactionOptions: transactionOptions)?.decodedData()
 
         let resolvedPromises = try await ["name":namePromise, "symbol":symbolPromise, "decimals":decimalPromise]
 
diff --git a/Sources/web3swift/Tokens/ERC721/Web3+ERC721.swift b/Sources/web3swift/Tokens/ERC721/Web3+ERC721.swift
@@ -97,7 +97,7 @@ public class ERC721: IERC721 {
         transactionOptionsVAR.callOnBlock = .latest
         let transactionOptions = transactionOptionsVAR
 
-        async let tokenIdPromise = contract.read("tokenId", parameters: [AnyObject](), extraData: Data(), transactionOptions: transactionOptions)?.callPromise()
+        async let tokenIdPromise = contract.read("tokenId", parameters: [AnyObject](), extraData: Data(), transactionOptions: transactionOptions)?.decodedData()
 
         guard let tokenIdResult = try await tokenIdPromise else {return}
         guard let tokenId = tokenIdResult["0"] as? BigUInt else {return}
diff --git a/Sources/web3swift/Tokens/ERC721x/Web3+ERC721x.swift b/Sources/web3swift/Tokens/ERC721x/Web3+ERC721x.swift
@@ -79,7 +79,7 @@ public class ERC721x: IERC721x {
         var transactionOptions = TransactionOptions.defaultOptions
         transactionOptions.callOnBlock = .latest
 
-        guard let tokenIdPromise = try await contract.read("tokenId", parameters: [] as [AnyObject], extraData: Data(), transactionOptions: transactionOptions)?.callPromise() else {return}
+        guard let tokenIdPromise = try await contract.read("tokenId", parameters: [] as [AnyObject], extraData: Data(), transactionOptions: transactionOptions)?.decodedData() else {return}
 
         guard let tokenId = tokenIdPromise["0"] as? BigUInt else {return}
         self._tokenId = tokenId
diff --git a/Sources/web3swift/Utils/Hooks/NonceMiddleware.swift b/Sources/web3swift/Utils/Hooks/NonceMiddleware.swift
@@ -30,7 +30,7 @@ extension Web3.Utils {
 
                 knownKeys.forEach { key in
                     group.addTask {
-                        try? await w3.eth.getTransactionCountPromise(address: key, onBlock: "latest")
+                        try? await w3.eth.getTransactionCount(address: key, onBlock: "latest")
                     }
                 }
 
diff --git a/Sources/web3swift/Web3/Web3+Eth.swift b/Sources/web3swift/Web3/Web3+Eth.swift
@@ -68,7 +68,7 @@ extension web3.Eth {
     ///
     /// Returns the Result object that indicates either success of failure.
     public func getTransactionCount(address: EthereumAddress, onBlock: String = "latest") async throws -> BigUInt {
-        let result = try await self.getTransactionCountPromise(address: address, onBlock: onBlock)
+        let result = try await self.getTransactionCount(for: address, onBlock: onBlock)
         return result
     }
 
@@ -343,7 +343,7 @@ extension web3.Eth {
         let contract = self.web3.contract(Web3.Utils.erc20ABI, at: tokenAddress, abiVersion: 2)
         var mergedOptions = self.web3.transactionOptions.merge(transactionOptions)
         mergedOptions.from = from
-        let resp = try await contract?.read("decimals", transactionOptions: mergedOptions)?.callPromise()
+        let resp = try await contract?.read("decimals", transactionOptions: mergedOptions)?.decodedData()
         var decimals = BigUInt(0)
         guard let response = resp, let dec = response["0"], let decTyped = dec as? BigUInt else {return nil}
         decimals = decTyped
diff --git a/Sources/web3swift/Web3/Web3+MutatingTransaction.swift b/Sources/web3swift/Web3/Web3+MutatingTransaction.swift
@@ -155,9 +155,9 @@ public class WriteTransaction: ReadTransaction {
     func nonce(for policy:  TransactionOptions.NoncePolicy,  from: EthereumAddress) async throws -> BigUInt {
         switch policy {
         case .latest:
-            return try await self.web3.eth.getTransactionCountPromise(address: from, onBlock: "latest")
+            return try await self.web3.eth.getTransactionCount(address: from, onBlock: "latest")
         case .pending:
-            return try await self.web3.eth.getTransactionCountPromise(address: from, onBlock: "pending")
+            return try await self.web3.eth.getTransactionCount(address: from, onBlock: "pending")
         case .manual(let nonce):
             return nonce
         }
diff --git a/Sources/web3swift/Web3/Web3+ReadingTransaction.swift b/Sources/web3swift/Web3/Web3+ReadingTransaction.swift
@@ -26,7 +26,7 @@ public class ReadTransaction {
         }
     }
 
-    public func callPromise(transactionOptions: TransactionOptions? = nil) async throws -> [String: Any] {
+    public func decodedData(with transactionOptions: TransactionOptions? = nil) async throws -> [String: Any] {
         var assembledTransaction: EthereumTransaction = self.transaction
         let mergedOptions = self.transactionOptions.merge(transactionOptions)
         var optionsForCall = TransactionOptions()
@@ -83,6 +83,6 @@ public class ReadTransaction {
     }
 
     public func call(transactionOptions: TransactionOptions? = nil) async throws -> [String: Any] {
-        return try await self.callPromise(transactionOptions: transactionOptions)
+        return try await self.decodedData(with: transactionOptions)
     }
 }
diff --git a/Tests/web3swiftTests/localTests/web3swiftAdvancedABIv2Tests.swift b/Tests/web3swiftTests/localTests/web3swiftAdvancedABIv2Tests.swift
@@ -42,7 +42,7 @@ class web3swiftAdvancedABIv2Tests: XCTestCase {
         
         contract = web3.contract(abiString, at: receipt.contractAddress, abiVersion: 2)!
         let tx = contract.read("testSingle")
-        let testSingle = try await tx!.callPromise()
+        let testSingle = try await tx!.decodedData()
         print(testSingle.description)
     }
     
@@ -76,7 +76,7 @@ class web3swiftAdvancedABIv2Tests: XCTestCase {
         
         contract = web3.contract(abiString, at: receipt.contractAddress, abiVersion: 2)!
         let tx = contract.read("testStaticArray")
-        let testStaticArray = try await tx!.callPromise()
+        let testStaticArray = try await tx!.decodedData()
         print(testStaticArray.description)
     }
     
@@ -110,7 +110,7 @@ class web3swiftAdvancedABIv2Tests: XCTestCase {
         
         contract = web3.contract(abiString, at: receipt.contractAddress, abiVersion: 2)!
         let tx = contract.read("testDynArray")
-        let testDynArray = try await tx!.callPromise()
+        let testDynArray = try await tx!.decodedData()
         print(testDynArray.description)
     }
     
@@ -144,7 +144,7 @@ class web3swiftAdvancedABIv2Tests: XCTestCase {
         
         contract = web3.contract(abiString, at: receipt.contractAddress, abiVersion: 2)!
         let tx = contract.read("testDynOfDyn")
-        let testDynOfDyn = try await tx!.callPromise()
+        let testDynOfDyn = try await tx!.decodedData()
         print(testDynOfDyn.description)
     }
     
@@ -178,7 +178,7 @@ class web3swiftAdvancedABIv2Tests: XCTestCase {
         
         contract = web3.contract(abiString, at: receipt.contractAddress, abiVersion: 2)!
         let tx = contract.read("testStOfDyn")
-        let testStOfDyn = try await tx!.callPromise()
+        let testStOfDyn = try await tx!.decodedData()
         print(testStOfDyn.description)
     }
     
@@ -190,7 +190,7 @@ class web3swiftAdvancedABIv2Tests: XCTestCase {
         XCTAssert(contract != nil)
         let tx = contract?.read("empty")
         XCTAssertNotNil(tx)
-        let _ = try await tx!.callPromise()
+        let _ = try await tx!.decodedData()
     }
     
     func testUserCase() async throws {
diff --git a/Tests/web3swiftTests/localTests/web3swiftERC20Tests.swift b/Tests/web3swiftTests/localTests/web3swiftERC20Tests.swift
@@ -18,7 +18,7 @@ class web3swiftERC20Tests: XCTestCase {
         let contract = web3.contract(Web3.Utils.erc20ABI, at: receipt.contractAddress!)!
         let readTX = contract.read("name", parameters:parameters)!
         readTX.transactionOptions.from = EthereumAddress("0xe22b8979739D724343bd002F9f432F5990879901")
-        let response = try await readTX.callPromise()
+        let response = try await readTX.decodedData()
         let name = response["0"] as? String
         XCTAssert(name == "web3swift", "Failed to create ERC20 name transaction")
     }
@@ -30,7 +30,7 @@ class web3swiftERC20Tests: XCTestCase {
         let contract = web3.contract(Web3.Utils.erc20ABI, at: receipt.contractAddress!, abiVersion: 2)!
         guard let readTX = contract.read("balanceOf", parameters: [addressOfUser] as [AnyObject]) else {return XCTFail()}
         readTX.transactionOptions.from = addressOfUser
-        let tokenBalance = try await readTX.callPromise()
+        let tokenBalance = try await readTX.decodedData()
         guard let bal = tokenBalance["0"] as? BigUInt else {return XCTFail()}
         print(String(bal))
     }
diff --git a/Tests/web3swiftTests/localTests/web3swiftPromisesTests.swift b/Tests/web3swiftTests/localTests/web3swiftPromisesTests.swift
@@ -136,7 +136,7 @@ class web3swiftPromisesTests: XCTestCase {
         let token = web3.contract(Web3.Utils.erc20ABI, at: receipt.contractAddress, abiVersion: 2)!
         
         let userAddress = EthereumAddress("0xe22b8979739D724343bd002F9f432F5990879901")!
-        let tokenBalance = try await token.read("balanceOf", parameters: [userAddress] as [AnyObject])!.callPromise()
+        let tokenBalance = try await token.read("balanceOf", parameters: [userAddress] as [AnyObject])!.decodedData()
         guard let bal = tokenBalance["0"] as? BigUInt else {return XCTFail()}
         print(String(bal))
     }
diff --git a/Tests/web3swiftTests/localTests/web3swiftTests.swift b/Tests/web3swiftTests/localTests/web3swiftTests.swift
@@ -117,11 +117,11 @@ class web3swiftTests: XCTestCase {
         let contract = web3.contract(jsonString, at: addr, abiVersion: 2)
         XCTAssert(contract != nil)
         let allMethods = contract!.contract.allMethods
-        let userDeviceCount = try await contract!.read("userDeviceCount", parameters: [addr as AnyObject])?.callPromise()
+        let userDeviceCount = try await contract!.read("userDeviceCount", parameters: [addr as AnyObject])?.decodedData()
         print(userDeviceCount!)
-        let totalUsers = try await contract!.read("totalUsers", parameters: [])?.callPromise()
+        let totalUsers = try await contract!.read("totalUsers", parameters: [])?.decodedData()
         print(totalUsers!)
-        let user = try await contract!.read("users", parameters: [0 as AnyObject])?.callPromise()
+        let user = try await contract!.read("users", parameters: [0 as AnyObject])?.decodedData()
         print(user!)
         print(allMethods)
     }
diff --git a/Tests/web3swiftTests/localTests/web3swiftUserCases.swift b/Tests/web3swiftTests/localTests/web3swiftUserCases.swift
@@ -25,7 +25,7 @@ class web3swiftUserCases: XCTestCase {
         let contract = web3.contract(abiString, at: receipt.contractAddress!)!
         let readTransaction = contract.read("balanceOf", parameters:[account] as [AnyObject])!
         readTransaction.transactionOptions.from = account
-        let response = try await readTransaction.callPromise()
+        let response = try await readTransaction.decodedData()
         let balance = response["0"] as? BigUInt
         print(balance!.description)
     }

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ extension Web3.Utils {`
`30`	`30`
`31`	`31`	`knownKeys.forEach { key in`
`32`	`32`	`group.addTask {`
`33`		`- try? await w3.eth.getTransactionCountPromise(address: key, onBlock: "latest")`
	`33`	`+ try? await w3.eth.getTransactionCount(address: key, onBlock: "latest")`
`34`	`34`	`}`
`35`	`35`	`}`
`36`	`36`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ public class ReadTransaction {`
`26`	`26`	`}`
`27`	`27`	`}`
`28`	`28`
`29`		`- public func callPromise(transactionOptions: TransactionOptions? = nil) async throws -> [String: Any] {`
	`29`	`+ public func decodedData(with transactionOptions: TransactionOptions? = nil) async throws -> [String: Any] {`
`30`	`30`	`var assembledTransaction: EthereumTransaction = self.transaction`
`31`	`31`	`let mergedOptions = self.transactionOptions.merge(transactionOptions)`
`32`	`32`	`var optionsForCall = TransactionOptions()`
`@@ -83,6 +83,6 @@ public class ReadTransaction {`
`83`	`83`	`}`
`84`	`84`
`85`	`85`	`public func call(transactionOptions: TransactionOptions? = nil) async throws -> [String: Any] {`
`86`		`- return try await self.callPromise(transactionOptions: transactionOptions)`
	`86`	`+ return try await self.decodedData(with: transactionOptions)`
`87`	`87`	`}`
`88`	`88`	`}`