feat: added array of errors in ContractProtocol filtered from ABI;

Author: JeneaVranceanu

Sources/web3swift/Contract/ContractProtocol.swift

@@ -32,6 +32,12 @@ public protocol ContractProtocol {
     /// All events from `events`.
     var allEvents: [ABI.Element.Event] {get}
 
+    /// Errors filtered from ``abi`` and mapped to their unchanged ``ABI/Element/EthError/name``.
+    var errors: [String: ABI.Element.EthError] {get}
+
+    /// All values from ``errors``.
+    var allErrors: [ABI.Element.EthError] {get}
+
     /// Parsed from ABI or a default constructor with no input arguments.
     var constructor: ABI.Element.Constructor {get}
 

Sources/web3swift/Contract/EthereumContract.swift

@@ -7,6 +7,8 @@ import Foundation
 import BigInt
 import Core
 
+/// Default representation of a smart contract. Created out of an array of ``ABI/Element`` which could be functions, events,
+/// constructor, errors and optional ``EthereumAddress`` that could be set later.
 public class EthereumContract: DefaultContractProtocol {
 
     public var address: EthereumAddress? = nil
@@ -16,6 +18,8 @@ public class EthereumContract: DefaultContractProtocol {
     public let allMethods: [ABI.Element.Function]
     public let events: [String: ABI.Element.Event]
     public let allEvents: [ABI.Element.Event]
+    public let errors: [String: ABI.Element.EthError]
+    public let allErrors: [ABI.Element.EthError]
     public let constructor: ABI.Element.Constructor
 
     public init(abi: [ABI.Element], at: EthereumAddress? = nil) throws {
@@ -30,6 +34,8 @@ public class EthereumContract: DefaultContractProtocol {
         events = abi.getEvents()
         allEvents = Array(events.values)
         constructor = abi.getConstructor()
+        errors = abi.getErrors()
+        allErrors = Array(errors.values)
     }
 
     public convenience required init(_ abiString: String, at: EthereumAddress? = nil) throws {

Sources/web3swift/EthereumABI/ABIElements.swift

@@ -8,7 +8,6 @@ import BigInt
 import Core
 
 public extension ABI {
-    // JSON Decoding
     struct Input: Decodable {
         public var name: String?
         public var type: String

Sources/web3swift/EthereumABI/Sequence+ABIExtension.swift

@@ -49,6 +49,17 @@ public extension Sequence where Element == ABI.Element {
         return events
     }
 
+    /// Filters out all ``ABI/Element/EthError`` types and maps them to their names
+    /// provided in ``ABI/Element/EthError/name`` variable.
+    /// - Returns: dictionary of all errors mapped to their names.
+    func getErrors() -> [String: ABI.Element.EthError] {
+        var errors = [String: ABI.Element.EthError]()
+        for case let .error(error) in self {
+            errors[error.name] = error
+        }
+        return errors
+    }
+
     /// Filters out ``ABI/Element/Constructor``.
     /// If there are multiple of them the first encountered will be returned and if there are none a default constructor will be returned
     /// that accepts no input parameters.