chore: 'Web3Error's now have descriptions; (#841)

performed refactoring of APIRequests+Methods.swift, ENSBaseRegistrar, ENSRegistry, ENSResolver, ENSReverseRegistrar, ETHRegistrarController,

Author: JeneaVranceanu

Sources/Web3Core/Contract/ContractProtocol.swift

@@ -379,7 +379,7 @@ extension DefaultContractProtocol {
 
     public func decodeEthError(_ data: Data) -> [String: Any]? {
         guard data.count >= 4,
-              let err = errors.first(where: { $0.value.methodEncoding == data[0..<4] })?.value else {
+              let err = errors.first(where: { $0.value.selectorEncoded == data[0..<4] })?.value else {
             return nil
         }
         return err.decodeEthError(data[4...])
@@ -398,7 +398,7 @@ extension DefaultContractProtocol {
             throw Web3Error.inputError(desc: "RPC failed: contract is missing an address.")
         }
         guard let data = self.method(method, parameters: parameters, extraData: nil) else {
-            throw Web3Error.dataError
+            throw Web3Error.dataError(desc: "Failed to encode method \(method) with given parameters: \(String(describing: parameters))")
         }
         let transaction = CodableTransaction(to: address, data: data)
 

Sources/Web3Core/EthereumABI/ABIElements.swift

@@ -207,7 +207,7 @@ extension ABI.Element.Function {
     public func encodeParameters(_ parameters: [Any]) -> Data? {
         guard parameters.count == inputs.count,
               let data = ABIEncoder.encode(types: inputs, values: parameters) else { return nil }
-        return methodEncoding + data
+        return selectorEncoded + data
     }
 }
 
@@ -300,16 +300,18 @@ extension ABI.Element.EthError {
     ///  - data: bytes returned by a function call that stripped error signature hash.
     /// - Returns: a dictionary containing decoded data mappend to indices and names of returned values or nil if decoding failed.
     public func decodeEthError(_ data: Data) -> [String: Any]? {
-        guard inputs.count * 32 <= data.count,
+        guard data.count > 0,
+              data.count % 32 == 0,
+              inputs.count * 32 <= data.count,
               let decoded = ABIDecoder.decode(types: inputs, data: data) else {
             return nil
         }
 
         var result = [String: Any]()
-        for (index, out) in inputs.enumerated() {
+        for (index, input) in inputs.enumerated() {
             result["\(index)"] = decoded[index]
-            if !out.name.isEmpty {
-                result[out.name] = decoded[index]
+            if !input.name.isEmpty {
+                result[input.name] = decoded[index]
             }
         }
         return result
@@ -372,7 +374,7 @@ extension ABI.Element {
 
 extension ABI.Element.Function {
     public func decodeInputData(_ rawData: Data) -> [String: Any]? {
-        return ABIDecoder.decodeInputData(rawData, methodEncoding: methodEncoding, inputs: inputs)
+        return ABIDecoder.decodeInputData(rawData, methodEncoding: selectorEncoded, inputs: inputs)
     }
 
     /// Decodes data returned by a function call.
@@ -520,8 +522,8 @@ extension ABIDecoder {
     /// - Returns: decoded dictionary of input arguments mapped to their indices and arguments' names if these are not empty.
     /// If decoding of at least one argument fails, `rawData` size is invalid or `methodEncoding` doesn't match - `nil` is returned.
     static func decodeInputData(_ rawData: Data,
-                                     methodEncoding: Data? = nil,
-                                     inputs: [ABI.Element.InOut]) -> [String: Any]? {
+                                methodEncoding: Data? = nil,
+                                inputs: [ABI.Element.InOut]) -> [String: Any]? {
         let data: Data
         let sig: Data?
 

Sources/Web3Core/EthereumABI/Sequence+ABIExtension.swift

@@ -28,7 +28,7 @@ public extension Sequence where Element == ABI.Element {
         for case let .function(function) in self where function.name != nil {
             appendFunction(function.name!, function)
             appendFunction(function.signature, function)
-            appendFunction(function.methodString.addHexPrefix().lowercased(), function)
+            appendFunction(function.selector.addHexPrefix().lowercased(), function)
 
             /// ABI cannot have two functions with exactly the same name and input arguments
             if (functions[function.signature]?.count ?? 0) > 1 {

Sources/Web3Core/EthereumAddress/EthereumAddress.swift

@@ -45,7 +45,7 @@ public struct EthereumAddress: Equatable {
         }
     }
 
-    /// Checksummed address with `0x` HEX prefix.
+    /// Checksummed address with `0x` hex prefix.
     /// If the ``type`` is ``EthereumAddress/AddressType/contractDeployment`` only `0x` prefix is returned.
     public var address: String {
         switch self.type {

Sources/Web3Core/EthereumNetwork/Request/APIRequest+Methods.swift

@@ -97,24 +97,16 @@ extension APIRequest {
             data = try await send(uRLRequest: uRLRequest, with: provider.session)
         } catch Web3Error.rpcError(let error) {
             let responseAsString = try checkError(method: method, error: error)
+            // TODO: why do we try to cast error response to Result.self?
             guard let LiteralType = Result.self as? LiteralInitiableFromString.Type,
                   let literalValue = LiteralType.init(from: responseAsString),
                   let result = literalValue as? Result else {
-                throw Web3Error.dataError
+                throw Web3Error.rpcError(error)
             }
             return APIResponse(id: 2, result: result)
         }
 
-        /// Checks if `Result` type can be initialized from HEX-encoded bytes.
-        /// If it can - we attempt initializing a value of `Result` type.
-        if let LiteralType = Result.self as? LiteralInitiableFromString.Type {
-            guard let responseAsString = try? JSONDecoder().decode(APIResponse<String>.self, from: data) else { throw Web3Error.dataError }
-            guard let literalValue = LiteralType.init(from: responseAsString.result) else { throw Web3Error.dataError }
-            /// `literalValue` conforms `LiteralInitiableFromString` (which conforms to an `APIResponseType` type) so it never fails.
-            guard let result = literalValue as? Result else { throw Web3Error.typeError }
-            return APIResponse(id: responseAsString.id, jsonrpc: responseAsString.jsonrpc, result: result)
-        }
-        return try JSONDecoder().decode(APIResponse<Result>.self, from: data)
+        return try initalizeLiteralTypeApiResponse(data) ?? JSONDecoder().decode(APIResponse<Result>.self, from: data)
     }
 
     public static func send(uRLRequest: URLRequest, with session: URLSession) async throws -> Data {
@@ -145,6 +137,26 @@ extension APIRequest {
 
         return data
     }
+
+    /// Attempts decoding and parsing of a response into literal types as `Data`, `(U)Int`, `Big(U)Int`.
+    /// - Parameter data: response to parse.
+    /// - Returns: parsed response or `nil`. Throws ``Web3Error``.
+    internal static func initalizeLiteralTypeApiResponse<Result>(_ data: Data) throws -> APIResponse<Result>? {
+        guard let LiteralType = Result.self as? LiteralInitiableFromString.Type else {
+            return nil
+        }
+        guard let responseAsString = try? JSONDecoder().decode(APIResponse<String>.self, from: data) else {
+            throw Web3Error.dataError(desc: "Failed to decode received data as `APIResponse<String>`. Given data: \(data.toHexString().addHexPrefix()).")
+        }
+        guard let literalValue = LiteralType.init(from: responseAsString.result) else {
+            throw Web3Error.dataError(desc: "Failed to initialize \(LiteralType.self) from String `\(responseAsString.result)`.")
+        }
+        /// `literalValue` conforms `LiteralInitiableFromString`, that conforming to an `APIResultType` type, so it's never fails.
+        guard let result = literalValue as? Result else {
+            throw Web3Error.typeError(desc: "Initialized value of type \(LiteralType.self) cannot be cast as \(Result.self).")
+        }
+        return APIResponse(id: responseAsString.id, jsonrpc: responseAsString.jsonrpc, result: result)
+    }
 }
 
 /// JSON RPC Error object. See official specification https://www.jsonrpc.org/specification#error_object

Sources/Web3Core/KeystoreManager/EtherscanTransactionChecker.swift

@@ -12,17 +12,17 @@ public struct EtherscanTransactionChecker: TransactionChecker {
 
     public init(urlSession: URLSession, apiKey: String) {
         self.urlSession = URLSessionProxyImplementation(urlSession: urlSession)
-        self.apiKey = apiKey
+        self.apiKey = apiKey.trim()
     }
 
     internal init(urlSession: URLSessionProxy, apiKey: String) {
         self.urlSession = urlSession
-        self.apiKey = apiKey
+        self.apiKey = apiKey.trim()
     }
 
     public func hasTransactions(ethereumAddress: EthereumAddress) async throws -> Bool {
         let urlString = "https://api.etherscan.io/api?module=account&action=txlist&address=\(ethereumAddress.address)&startblock=0&page=1&offset=1&sort=asc&apikey=\(apiKey)"
-        guard let url = URL(string: urlString) else {
+        guard let url = URL(string: urlString), !apiKey.isEmpty else {
             throw EtherscanTransactionCheckerError.invalidUrl(url: urlString)
         }
         let request = URLRequest(url: url)

Sources/Web3Core/Structure/Block/Block.swift

@@ -98,7 +98,9 @@ extension Block: Decodable {
 
         let unclesStrings = try container.decode([String].self, forKey: .uncles)
         self.uncles = try unclesStrings.map {
-            guard let data = Data.fromHex($0) else { throw Web3Error.dataError }
+            guard let data = Data.fromHex($0) else {
+                throw Web3Error.dataError(desc: "Failed to parse uncle block from hex string to Data. Given string is not valid hex: \($0).")
+            }
             return data
         }
     }

Sources/Web3Core/Structure/EventLog/EventLog.swift

@@ -63,7 +63,9 @@ public struct EventLog: Decodable {
         let topicsStrings = try container.decode([String].self, forKey: .topics)
 
         self.topics = try topicsStrings.map {
-            guard let topic = Data.fromHex($0) else { throw Web3Error.dataError }
+            guard let topic = Data.fromHex($0) else {
+                throw Web3Error.dataError(desc: "Failed to parse event's topic from hex string to Data. Given string is not valid hex: \($0).")
+            }
             return topic
         }
     }

Sources/Web3Core/Structure/Transaction/TransactionInBlock.swift

@@ -15,7 +15,9 @@ public enum TransactionInBlock: Decodable {
     public init(from decoder: Decoder) throws {
         let value = try decoder.singleValueContainer()
         if let string = try? value.decode(String.self) {
-            guard let d = Data.fromHex(string) else {throw Web3Error.dataError}
+            guard let d = Data.fromHex(string) else {
+                throw Web3Error.dataError(desc: "Failed to parse hex string to bytes. Given hex string: \(string)")
+            }
             self = .hash(d)
         } else if let transaction = try? value.decode(CodableTransaction.self) {
             self = .transaction(transaction)

Sources/Web3Core/Structure/TxPool/TxPoolContent.swift

@@ -23,14 +23,14 @@ public struct TxPoolContent: Decodable {
         for addressKey in raw.allKeys {
             let addressString = addressKey.stringValue
             guard let address = EthereumAddress(addressString, type: .normal, ignoreChecksum: true) else {
-                throw Web3Error.dataError
+                throw Web3Error.dataError(desc: "Failed to initialize EthereumAddress from value \(addressString). Is it 20 bytes hex string?")
             }
             let nestedContainer = try raw.nestedContainer(keyedBy: AdditionalDataCodingKeys.self, forKey: addressKey)
             var perNonceInformation = [TxPoolContentForNonce]()
             perNonceInformation.reserveCapacity(nestedContainer.allKeys.count)
             for nonceKey in nestedContainer.allKeys {
                 guard let nonce = BigUInt(nonceKey.stringValue) else {
-                    throw Web3Error.dataError
+                    throw Web3Error.dataError(desc: "Failed to parse \(nonceKey.stringValue) as BigUInt nonce value for address \(addressString).")
                 }
                 let n = try? nestedContainer.nestedUnkeyedContainer(forKey: nonceKey)
                 if n != nil {