Promis renaming

pharms-eth · pharms-eth · commit a09ed126fa61 · 2022-04-16T20:22:20.000-07:00
diff --git a/Sources/web3swift/Promises/Promise+Web3+Eth+GetAccounts.swift b/Sources/web3swift/Promises/Promise+Web3+Eth+GetAccounts.swift
@@ -9,7 +9,7 @@ import BigInt
 
 
 extension web3.Eth {
-    public func getAccountsPromise() async throws -> [EthereumAddress] {
+    public func ownedAccounts() async throws -> [EthereumAddress] {
 
         guard self.web3.provider.attachedKeystoreManager == nil else {
             return try self.web3.wallet.getAccounts()
diff --git a/Sources/web3swift/Promises/Promise+Web3+Eth+GetBalance.swift b/Sources/web3swift/Promises/Promise+Web3+Eth+GetBalance.swift
@@ -9,11 +9,11 @@ import Foundation
 import BigInt
 
 extension web3.Eth {
-    public func getBalancePromise(address: EthereumAddress, onBlock: String = "latest") async throws -> BigUInt {
+    public func getBalance(for address: EthereumAddress, onBlock: String = "latest") async throws -> BigUInt {
         let addr = address.address
-        return try await getBalancePromise(address: addr, onBlock: onBlock)
+        return try await getBalance(address: addr, onBlock: onBlock)
     }
-    public func getBalancePromise(address: String, onBlock: String = "latest") async throws -> BigUInt {
+    public func getBalance(address: String, onBlock: String = "latest") async throws -> BigUInt {
         let request = JSONRPCRequestFabric.prepareRequest(.getBalance, parameters: [address.lowercased(), onBlock])
         let response = try await web3.dispatch(request)
 
diff --git a/Sources/web3swift/Promises/Promise+Web3+Eth+GetBlockByHash.swift b/Sources/web3swift/Promises/Promise+Web3+Eth+GetBlockByHash.swift
@@ -9,12 +9,12 @@ import BigInt
 
 
 extension web3.Eth {
-    public func getBlockByHashPromise(_ hash: Data, fullTransactions: Bool = false) async throws -> Block {
+    public func block(for hash: Data, fullTransactions: Bool = false) async throws -> Block {
         let hashString = hash.toHexString().addHexPrefix()
-        return try await getBlockByHashPromise(hashString, fullTransactions: fullTransactions)
+        return try await block(for: hashString, fullTransactions: fullTransactions)
     }
 
-    public func getBlockByHashPromise(_ hash: String, fullTransactions: Bool = false) async throws -> Block {
+    public func block(for hash: String, fullTransactions: Bool = false) async throws -> Block {
         let request = JSONRPCRequestFabric.prepareRequest(.getBlockByHash, parameters: [hash, fullTransactions])
         let response = try await web3.dispatch(request)
 
diff --git a/Sources/web3swift/Promises/Promise+Web3+Eth+GetBlockByNumber.swift b/Sources/web3swift/Promises/Promise+Web3+Eth+GetBlockByNumber.swift
@@ -9,17 +9,17 @@ import BigInt
 
 
 extension web3.Eth {
-    public func getBlockByNumberPromise(_ number: UInt64, fullTransactions: Bool = false) async throws -> Block {
+    public func blockBy(number: UInt64, fullTransactions: Bool = false) async throws -> Block {
         let block = String(number, radix: 16).addHexPrefix()
-        return try await getBlockByNumberPromise(block, fullTransactions: fullTransactions)
+        return try await blockBy(number: block, fullTransactions: fullTransactions)
     }
 
-    public func getBlockByNumberPromise(_ number: BigUInt, fullTransactions: Bool = false) async throws -> Block {
+    public func blockBy(number: BigUInt, fullTransactions: Bool = false) async throws -> Block {
         let block = String(number, radix: 16).addHexPrefix()
-        return try await getBlockByNumberPromise(block, fullTransactions: fullTransactions)
+        return try await blockBy(number: block, fullTransactions: fullTransactions)
     }
 
-    public func getBlockByNumberPromise(_ number: String, fullTransactions: Bool = false) async throws -> Block {
+    public func blockBy(number: String, fullTransactions: Bool = false) async throws -> Block {
         let request = JSONRPCRequestFabric.prepareRequest(.getBlockByNumber, parameters: [number, fullTransactions])
         let response = try await web3.dispatch(request)
 
diff --git a/Sources/web3swift/Promises/Promise+Web3+Eth+GetCode.swift b/Sources/web3swift/Promises/Promise+Web3+Eth+GetCode.swift
@@ -10,11 +10,11 @@ import Foundation
 import BigInt
 
 extension web3.Eth {
-    public func getCodePromise(address: EthereumAddress, onBlock: String = "latest") async throws -> String {
+    public func code(for address: EthereumAddress, onBlock: String = "latest") async throws -> String {
         let addr = address.address
-        return try await getCodePromise(address: addr, onBlock: onBlock)
+        return try await code(for : addr, onBlock: onBlock)
     }
-    public func getCodePromise(address: String, onBlock: String = "latest") async throws -> String {
+    public func code(for address: String, onBlock: String = "latest") async throws -> String {
         let request = JSONRPCRequestFabric.prepareRequest(.getCode, parameters: [address.lowercased(), onBlock])
         let response = try await web3.dispatch(request)
 
diff --git a/Sources/web3swift/Promises/Promise+Web3+Eth+GetTransactionDetails.swift b/Sources/web3swift/Promises/Promise+Web3+Eth+GetTransactionDetails.swift
@@ -9,12 +9,12 @@ import BigInt
 
 
 extension web3.Eth {
-    public func getTransactionDetailsPromise(_ txhash: Data) async throws -> TransactionDetails {
+    public func transactionDetails(_ txhash: Data) async throws -> TransactionDetails {
         let hashString = txhash.toHexString().addHexPrefix()
-        return try await self.getTransactionDetailsPromise(hashString)
+        return try await self.transactionDetails(hashString)
     }
 
-    public func getTransactionDetailsPromise(_ txhash: String) async throws -> TransactionDetails {
+    public func transactionDetails(_ txhash: String) async throws -> TransactionDetails {
         let request = JSONRPCRequestFabric.prepareRequest(.getTransactionByHash, parameters: [txhash])
         let response = try await web3.dispatch(request)
 
diff --git a/Sources/web3swift/Promises/Promise+Web3+Eth+GetTransactionReceipt.swift b/Sources/web3swift/Promises/Promise+Web3+Eth+GetTransactionReceipt.swift
@@ -9,12 +9,12 @@ import BigInt
 
 
 extension web3.Eth {
-    public func getTransactionReceiptPromise(_ txhash: Data) async throws -> TransactionReceipt {
+    public func transactionReceipt(_ txhash: Data) async throws -> TransactionReceipt {
         let hashString = txhash.toHexString().addHexPrefix()
-        return try await self.getTransactionReceiptPromise(hashString)
+        return try await self.transactionReceipt(hashString)
     }
 
-    public func getTransactionReceiptPromise(_ txhash: String) async throws -> TransactionReceipt {
+    public func transactionReceipt(_ txhash: String) async throws -> TransactionReceipt {
         let request = JSONRPCRequestFabric.prepareRequest(.getTransactionReceipt, parameters: [txhash])
         let response = try await web3.dispatch(request)
 
diff --git a/Sources/web3swift/Promises/Promise+Web3+Eth+SendRawTransaction.swift b/Sources/web3swift/Promises/Promise+Web3+Eth+SendRawTransaction.swift
@@ -8,14 +8,14 @@ import Foundation
 
 
 extension web3.Eth {
-    public func sendRawTransactionPromise(_ transaction: Data) async throws -> TransactionSendingResult {
+    public func send(raw transaction: Data) async throws -> TransactionSendingResult {
         guard let deserializedTX = EthereumTransaction(rawValue: transaction) else {
             throw Web3Error.processingError(desc: "Serialized TX is invalid")
         }
-        return try await sendRawTransactionPromise(deserializedTX)
+        return try await send(raw: deserializedTX)
     }
 
-    public func sendRawTransactionPromise(_ transaction: EthereumTransaction) async throws -> TransactionSendingResult {
+    public func send(raw transaction: EthereumTransaction) async throws -> TransactionSendingResult {
 
         guard let request = EthereumTransaction.createRawTransaction(transaction: transaction) else {
             throw Web3Error.processingError(desc: "Transaction is invalid")
diff --git a/Sources/web3swift/Promises/Promise+Web3+Eth+SendTransaction.swift b/Sources/web3swift/Promises/Promise+Web3+Eth+SendTransaction.swift
@@ -63,7 +63,7 @@ extension web3.Eth {
         } catch {
             throw Web3Error.inputError(desc: "Failed to locally sign a transaction")
         }
-        return try await self.web3.eth.sendRawTransactionPromise(assembledTransaction)
+        return try await self.web3.eth.send(raw: assembledTransaction)
 
     }
 }
diff --git a/Sources/web3swift/Promises/Promise+Web3+TxPool.swift b/Sources/web3swift/Promises/Promise+Web3+TxPool.swift
@@ -9,7 +9,7 @@ import BigInt
 
 
 extension web3.TxPool {
-    public func getInspectPromise() async throws -> [String: [String: [String: String]]] {
+    public func txPoolInspect() async throws -> [String: [String: [String: String]]] {
         let request = JSONRPCRequestFabric.prepareRequest(.getTxPoolInspect, parameters: [])
         let response = try await web3.dispatch(request)
 
@@ -23,7 +23,7 @@ extension web3.TxPool {
 
     }
 
-    public func getStatusPromise() async throws -> TxPoolStatus {
+    public func txPoolStatus() async throws -> TxPoolStatus {
         let request = JSONRPCRequestFabric.prepareRequest(.getTxPoolStatus, parameters: [])
         let response = try await web3.dispatch(request)
 
@@ -37,7 +37,7 @@ extension web3.TxPool {
 
     }
 
-    public func getContentPromise() async throws -> TxPoolContent {
+    public func txPoolContent() async throws -> TxPoolContent {
         let request = JSONRPCRequestFabric.prepareRequest(.getTxPoolContent, parameters: [])
         let response = try await web3.dispatch(request)
 
diff --git a/Sources/web3swift/Web3/Web3+Eth.swift b/Sources/web3swift/Web3/Web3+Eth.swift
@@ -45,7 +45,7 @@ extension web3.Eth {
     ///
     /// Returns the Result object that indicates either success of failure.
     public func sendRawTransaction(_ transaction: Data) async throws -> TransactionSendingResult {
-        let result = try await self.sendRawTransactionPromise(transaction)
+        let result = try await self.send(raw: transaction)
         return result
     }
 
@@ -55,7 +55,7 @@ extension web3.Eth {
     ///
     /// Returns the Result object that indicates either success of failure.
     public func sendRawTransaction(_ transaction: EthereumTransaction) async throws -> TransactionSendingResult {
-        let result = try await self.sendRawTransactionPromise(transaction)
+        let result = try await self.send(raw: transaction)
         return result
     }
 
@@ -81,7 +81,7 @@ extension web3.Eth {
     ///
     /// Returns the Result object that indicates either success of failure.
     public func getBalance(address: EthereumAddress, onBlock: String = "latest") async throws -> BigUInt {
-        let result = try await self.getBalancePromise(address: address, onBlock: onBlock)
+        let result = try await self.getBalance(for: address, onBlock: onBlock)
         return result
     }
 
@@ -112,7 +112,7 @@ extension web3.Eth {
     ///
     /// Returns the Result object that indicates either success of failure.
     public func getTransactionDetails(_ txhash: Data) async throws -> TransactionDetails {
-        let result = try await self.getTransactionDetailsPromise(txhash)
+        let result = try await self.transactionDetails(txhash)
        return result
     }
 
@@ -123,7 +123,7 @@ extension web3.Eth {
     ///
     /// Returns the Result object that indicates either success of failure.
     public func getTransactionDetails(_ txhash: String) async throws -> TransactionDetails {
-        let result = try await self.getTransactionDetailsPromise(txhash)
+        let result = try await self.transactionDetails(txhash)
         return result
     }
 
@@ -134,7 +134,7 @@ extension web3.Eth {
     ///
     /// Returns the Result object that indicates either success of failure.
     public func getTransactionReceipt(_ txhash: Data) async throws -> TransactionReceipt {
-        let result = try await self.getTransactionReceiptPromise(txhash)
+        let result = try await self.transactionReceipt(txhash)
         return result
     }
 
@@ -145,7 +145,7 @@ extension web3.Eth {
     ///
     /// Returns the Result object that indicates either success of failure.
     public func getTransactionReceipt(_ txhash: String) async throws -> TransactionReceipt {
-        let result = try await self.getTransactionReceiptPromise(txhash)
+        let result = try await self.transactionReceipt(txhash)
         return result
     }
 
@@ -173,7 +173,7 @@ extension web3.Eth {
     ///
     /// Returns the Result object that indicates either success of failure.
     public func getAccounts() async throws -> [EthereumAddress] {
-        let result = try await self.getAccountsPromise()
+        let result = try await self.ownedAccounts()
         return result
     }
 
@@ -185,7 +185,7 @@ extension web3.Eth {
     ///
     /// Returns the Result object that indicates either success of failure.
     public func getBlockByHash(_ hash: String, fullTransactions: Bool = false) async throws -> Block {
-        let result = try await self.getBlockByHashPromise(hash, fullTransactions: fullTransactions)
+        let result = try await self.block(for: hash, fullTransactions: fullTransactions)
         return result
     }
 
@@ -197,7 +197,7 @@ extension web3.Eth {
     ///
     /// Returns the Result object that indicates either success of failure.
     public func getBlockByHash(_ hash: Data, fullTransactions: Bool = false) async throws -> Block {
-        let result = try await self.getBlockByHashPromise(hash, fullTransactions: fullTransactions)
+        let result = try await self.block(for: hash, fullTransactions: fullTransactions)
         return result
     }
 
@@ -209,7 +209,7 @@ extension web3.Eth {
     ///
     /// Returns the Result object that indicates either success of failure.
     public func getBlockByNumber(_ number: UInt64, fullTransactions: Bool = false) async throws -> Block {
-        let result = try await self.getBlockByNumberPromise(number, fullTransactions: fullTransactions)
+        let result = try await self.blockBy(number: number, fullTransactions: fullTransactions)
         return result
     }
 
@@ -221,7 +221,7 @@ extension web3.Eth {
     ///
     /// Returns the Result object that indicates either success of failure.
     public func getBlockByNumber(_ number: BigUInt, fullTransactions: Bool = false) async throws -> Block {
-        let result = try await self.getBlockByNumberPromise(number, fullTransactions: fullTransactions)
+        let result = try await self.blockBy(number: number, fullTransactions: fullTransactions)
         return result
     }
 
@@ -233,7 +233,7 @@ extension web3.Eth {
     ///
     ///
     public func getBlockByNumber(_ block: String, fullTransactions: Bool = false) async throws -> Block {
-        let result = try await self.getBlockByNumberPromise(block, fullTransactions: fullTransactions)
+        let result = try await self.blockBy(number: block, fullTransactions: fullTransactions)
         return result
     }
 
diff --git a/Sources/web3swift/Web3/Web3+EventParser.swift b/Sources/web3swift/Web3/Web3+EventParser.swift
@@ -103,7 +103,7 @@ extension web3.web3contract.EventParser {
     }
 
     public func parseTransactionByHashPromise(_ hash: Data) async throws -> [EventParserResultProtocol] {
-        let receipt = try await self.web3.eth.getTransactionReceiptPromise(hash)
+        let receipt = try await self.web3.eth.transactionReceipt(hash)
 
         guard let results = parseReceiptForLogs(receipt: receipt, contract: contract, eventName: eventName, filter: filter) else {
             throw Web3Error.processingError(desc: "Failed to parse receipt for events")
@@ -118,7 +118,7 @@ extension web3.web3contract.EventParser {
             throw Web3Error.inputError(desc: "Can not mix parsing specific block and using block range filter")
         }
 
-        let res = try await self.web3.eth.getBlockByNumberPromise(blockNumber)
+        let res = try await self.web3.eth.blockBy(number: blockNumber)
 
         return try await self.parseBlockPromise(res)
     }
@@ -239,7 +239,7 @@ extension web3.web3contract {
             decodedLogs.forEach { singleEvent in
                 group.addTask {
                     var joinedEvent = singleEvent
-                    let receipt = try? await self.web3.eth.getTransactionReceiptPromise(singleEvent.eventLog!.transactionHash)
+                    let receipt = try? await self.web3.eth.transactionReceipt(singleEvent.eventLog!.transactionHash)
                     joinedEvent.transactionReceipt = receipt
                     return joinedEvent as EventParserResultProtocol
                 }
diff --git a/Sources/web3swift/Web3/Web3+MutatingTransaction.swift b/Sources/web3swift/Web3/Web3+MutatingTransaction.swift
@@ -9,7 +9,7 @@ import BigInt
 
 public class WriteTransaction: ReadTransaction {
 
-    public func assemblePromise(transactionOptions: TransactionOptions? = nil) async throws -> EthereumTransaction {
+    public func assembleTransaction(transactionOptions: TransactionOptions? = nil) async throws -> EthereumTransaction {
         var assembledTransaction: EthereumTransaction = self.transaction
 
         if self.method != "fallback" {
@@ -125,21 +125,17 @@ public class WriteTransaction: ReadTransaction {
 
     }
 
-    public func sendPromise(password: String = "web3swift", transactionOptions: TransactionOptions? = nil) async throws -> TransactionSendingResult{
-        let transaction = try await self.assemblePromise(transactionOptions: transactionOptions)
+    public func send(password: String = "web3swift", transactionOptions: TransactionOptions? = nil) async throws -> TransactionSendingResult {
+        let transaction = try await self.assembleTransaction(transactionOptions: transactionOptions)
         let mergedOptions = self.transactionOptions.merge(transactionOptions)
         var cleanedOptions = TransactionOptions()
         cleanedOptions.from = mergedOptions.from
         cleanedOptions.to = mergedOptions.to
         return try await self.web3.eth.send(transaction, transactionOptions: cleanedOptions, password: password)
     }
 
-    public func send(password: String = "web3swift", transactionOptions: TransactionOptions? = nil) async throws -> TransactionSendingResult {
-        return try await self.sendPromise(password: password, transactionOptions: transactionOptions)
-    }
-
     public func assemble(transactionOptions: TransactionOptions? = nil) async throws -> EthereumTransaction {
-        return try await self.assemblePromise(transactionOptions: transactionOptions)
+        return try await self.assembleTransaction(transactionOptions: transactionOptions)
     }
 
     func gasEstimate(for policy:  TransactionOptions.GasLimitPolicy
diff --git a/Sources/web3swift/Web3/Web3+ReadingTransaction.swift b/Sources/web3swift/Web3/Web3+ReadingTransaction.swift
@@ -50,7 +50,7 @@ public class ReadTransaction {
         return decodedData
     }
 
-    public func estimateGasPromise(transactionOptions: TransactionOptions? = nil) async throws -> BigUInt {
+    public func estimateGas(with transactionOptions: TransactionOptions? = nil) async throws -> BigUInt {
         var assembledTransaction: EthereumTransaction = self.transaction
 
         let mergedOptions = self.transactionOptions.merge(transactionOptions)
@@ -79,7 +79,7 @@ public class ReadTransaction {
     }
 
     public func estimateGas(transactionOptions: TransactionOptions? = nil) async throws -> BigUInt {
-        return try await self.estimateGasPromise(transactionOptions: transactionOptions)
+        return try await self.estimateGas(with: transactionOptions)
     }
 
     public func call(transactionOptions: TransactionOptions? = nil) async throws -> [String: Any] {
diff --git a/Sources/web3swift/Web3/Web3+TxPool.swift b/Sources/web3swift/Web3/Web3+TxPool.swift
@@ -9,17 +9,17 @@ import BigInt
 
 extension web3.TxPool {
     public func getInspect() async throws -> [String: [String: [String: String]]] {
-        let result = try await self.getInspectPromise()
+        let result = try await self.txPoolInspect()
         return result
     }
 
     public func getStatus() async throws -> TxPoolStatus {
-        let result = try await self.getStatusPromise()
+        let result = try await self.txPoolStatus()
         return result
     }
 
     public func getContent() async throws -> TxPoolContent {
-        let result = try await self.getContentPromise()
+        let result = try await self.txPoolContent()
         return result
     }
 }
diff --git a/Tests/web3swiftTests/localTests/web3swiftAdvancedABIv2Tests.swift b/Tests/web3swiftTests/localTests/web3swiftAdvancedABIv2Tests.swift
diff --git a/Tests/web3swiftTests/localTests/web3swiftBasicLocalNodeTests.swift b/Tests/web3swiftTests/localTests/web3swiftBasicLocalNodeTests.swift
diff --git a/Tests/web3swiftTests/localTests/web3swiftHelpers.swift b/Tests/web3swiftTests/localTests/web3swiftHelpers.swift
diff --git a/Tests/web3swiftTests/localTests/web3swiftPersonalSignatureTests.swift b/Tests/web3swiftTests/localTests/web3swiftPersonalSignatureTests.swift
diff --git a/Tests/web3swiftTests/localTests/web3swiftPromisesTests.swift b/Tests/web3swiftTests/localTests/web3swiftPromisesTests.swift
diff --git a/Tests/web3swiftTests/localTests/web3swiftTransactionsTests.swift b/Tests/web3swiftTests/localTests/web3swiftTransactionsTests.swift
diff --git a/Tests/web3swiftTests/localTests/web3swiftUserCases.swift b/Tests/web3swiftTests/localTests/web3swiftUserCases.swift

Original file line number	Diff line number	Diff line change
`@@ -8,14 +8,14 @@ import Foundation`
`8`	`8`
`9`	`9`
`10`	`10`	`extension web3.Eth {`
`11`		`- public func sendRawTransactionPromise(_ transaction: Data) async throws -> TransactionSendingResult {`
	`11`	`+ public func send(raw transaction: Data) async throws -> TransactionSendingResult {`
`12`	`12`	`guard let deserializedTX = EthereumTransaction(rawValue: transaction) else {`
`13`	`13`	`throw Web3Error.processingError(desc: "Serialized TX is invalid")`
`14`	`14`	`}`
`15`		`- return try await sendRawTransactionPromise(deserializedTX)`
	`15`	`+ return try await send(raw: deserializedTX)`
`16`	`16`	`}`
`17`	`17`
`18`		`- public func sendRawTransactionPromise(_ transaction: EthereumTransaction) async throws -> TransactionSendingResult {`
	`18`	`+ public func send(raw transaction: EthereumTransaction) async throws -> TransactionSendingResult {`
`19`	`19`
`20`	`20`	`guard let request = EthereumTransaction.createRawTransaction(transaction: transaction) else {`
`21`	`21`	`throw Web3Error.processingError(desc: "Transaction is invalid")`
Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@ extension web3.Eth {`
`63`	`63`	`} catch {`
`64`	`64`	`throw Web3Error.inputError(desc: "Failed to locally sign a transaction")`
`65`	`65`	`}`
`66`		`- return try await self.web3.eth.sendRawTransactionPromise(assembledTransaction)`
	`66`	`+ return try await self.web3.eth.send(raw: assembledTransaction)`
`67`	`67`
`68`	`68`	`}`
`69`	`69`	`}`