Merge pull request #664 from JeneaVranceanu/fix/web3-error-output

Author: yaroslavyaroslav

Sources/Core/Web3Error/Web3Error.swift

@@ -7,7 +7,7 @@
 
 import Foundation
 
-public enum Web3Error: Error {
+public enum Web3Error: LocalizedError {
     case transactionSerializationError
     case connectionError
 
@@ -25,7 +25,7 @@ public enum Web3Error: Error {
     case generalError(err: Error)
     case unknownError
 
-    public var errorDescription: String {
+    public var errorDescription: String? {
         switch self {
 
         case .transactionSerializationError:

Tests/web3swiftTests/localTests/Web3ErrorTests.swift

@@ -0,0 +1,25 @@
+//
+//  Web3ErrorTests.swift
+//
+//  Created by JeneaVranceanu on 11.11.2022.
+//
+
+import XCTest
+import Foundation
+@testable import Core
+
+class Web3ErrorTests: XCTestCase {
+
+    func testWeb3ErrorReturnsExpectedDescription() {
+        let emojis = ["🚀", "👋", "🥇", "☑️"]
+        let message = "This is a custom description for test case! web3swift \(emojis.randomElement()!)"
+
+        /// It's important that we represent `Web3Error` as a generic `Error`!
+        /// This is intentional as in `do-catch` block we do not receive `Web3Error`
+        /// but `Error` type instead that can be casted.
+        let error: Error = Web3Error.inputError(desc: message)
+        XCTAssertEqual(error.localizedDescription, message)
+    }
+
+}
+