Merge branch 'develop' into experimental/EIP-1559-combined

* develop:
  Fix EthereumTransaction decoding bug. Fix appropriate test result for such Add test to check whether all transactions in block decodes well.
  Fix percentiles array extension out of range index bug.
  Fixin typos and revert unnecessary code changes.
  Add comments to GasOracle & common methods - Add `BlockNumber` enum to enable strong typing in block number management. - Full test coverage of GasOracle public methods. - Clean GasOracle class.
  Code cleaning & unnecessary changes revert.
  Move back decode([Any].Type) methods
  Fixups - Update percentile arrays method. - fix JSONRPCmethod validation bug -
  Rewrite GasOracle - Implement generic decodeHex methods for T: DecodableFromHex, [T], [[T]]. - Make RPC API `feeHistory` call internal. - Reimplement `tipFeePercentiles` to return array of percentiles of last tips. - Reimplement `baseFeePercentiles` to return array of percentiles of last baseFee. - Rename `bothFeesPercentiles` to return tuple of arrays of percentiles of last both tips and baseFee. - `JSONRPCresponse` now can decode `Web3.Oracle.FeeHistory` - `JSONRPCparams` now can encode `[Double]` - Add `OracleTests`    - `testPretictBaseFee`    - `testPredictTip`
  Rewrite GasOracle - Now it works with feeHistory JRON RPC Ethereum call - Now all method returns percentiles, which user set on object init.
  Move AnyCodingKeys to appropriate place
  Delete unused hexDecode methods for KeyedDecodingContainer.
  Add 2 dimension array decodeHex method. - Rename decodeHex method to swift name convention. - Add FeeHistory struct initializer.
  Implement feeHistory usage for Gas cost prediction - Add method `decodeHex` for `Arrays<T> where T: DecodableFromHex`. - Add feeHistory request. - Add public feeHistory API call - Move GasOracle from `Web3` scope to `web3.Eth` scope (watch out case of first "w") - Change Oracle struct to work with feeHistory API call. - Refactor `JSONRPCmethod` to make it more explicit. - Refactor `InfuraWebsockerMethod` with a styling.
  Add tests Gas Oracle
  Fixes by PR review
  Fixed by PR review.
  Fixes by PR review.
  Add legacy gas price prediction method (pre EIP-1559)
  Revert "Revert "Implement Oracle class""

# Conflicts:
#	Sources/web3swift/Convenience/Decodable+Extensions.swift
#	Sources/web3swift/Web3/Web3+Structures.swift

Author: mloit

Sources/web3swift/Convenience/Array+Extension.swift

@@ -5,6 +5,7 @@
 //
 
 import Foundation
+import BigInt
 
 extension Array {
     public func split(intoChunksOf chunkSize: Int) -> [[Element]] {
@@ -14,3 +15,41 @@ extension Array {
         }
     }
 }
+
+extension Array where Element: Comparable {
+    /// Sorts array and drops most and least values.
+    /// - Returns: Sorted array without most and least values, nil if `array.count` <= 2
+    func cropAnomalyValues() -> Self? {
+        var sortedArray = self.sorted()
+        // Array should at least counts two to pass that formations.
+        guard sortedArray.count > 1 else { return nil }
+        sortedArray.removeLast()
+        sortedArray.removeFirst()
+        return sortedArray
+    }
+}
+
+extension Array where Element: BinaryInteger {
+    // TODO: Make me generic
+    /// Calculates mean value of a dataset
+    /// - Returns: Mean value of a dataset, nil if dataset is empty
+    func mean() -> BigUInt? {
+        guard !self.isEmpty else { return nil }
+        return BigUInt(self.reduce(0, +)) / BigUInt(self.count)
+    }
+
+
+    /// Calculates percentile of dataset on which get called.
+    /// - Parameter value: Percentile value.
+    /// - Returns: Item from dataset that is belongs to given percentile, nil if dataset is empty.
+    func percentile(of value: Double) -> Element? {
+        guard !self.isEmpty else { return nil }
+
+        let normalizedValue = value / 100 * Double(self.count)
+        let index = Int(ceil(normalizedValue))
+
+        let sorted_data = self.sorted()
+        guard index < self.count else { return sorted_data[sorted_data.count - 1] }
+        return sorted_data[index]
+    }
+}

Sources/web3swift/Convenience/Decodable+Extensions.swift

@@ -35,6 +35,7 @@ extension KeyedDecodingContainer {
     ///   for the given key.
     /// - throws: `DecodingError.valueNotFound` if `self` has a null entry for
     ///   the given key.
+    @available(*, deprecated, message: "Use decodeHex insetad")
     public func decode(_ type: [Any].Type, forKey key: KeyedDecodingContainer<K>.Key) throws -> [Any] {
         var values = try nestedUnkeyedContainer(forKey: key)
         return try values.decode(type)
@@ -52,6 +53,7 @@ extension KeyedDecodingContainer {
     ///   for the given key.
     /// - throws: `DecodingError.valueNotFound` if `self` has a null entry for
     ///   the given key.
+    @available(*, deprecated, message: "Use decodeHex() insetad")
     public func decode(_ type: [String: Any].Type, forKey key: KeyedDecodingContainer<K>.Key) throws -> [String: Any] {
         let values = try nestedContainer(keyedBy: AnyCodingKey.self, forKey: key)
         return try values.decode(type)
@@ -70,6 +72,7 @@ extension KeyedDecodingContainer {
     ///   the value is a null value.
     /// - throws: `DecodingError.typeMismatch` if the encountered encoded value
     ///   is not convertible to the requested type.
+    @available(*, deprecated, message: "In next version Will be replaced by decodeHexIfPresent() insetad")
     public func decodeIfPresent(_ type: [Any].Type, forKey key: KeyedDecodingContainer<K>.Key) throws -> [Any]? {
         guard contains(key),
             try decodeNil(forKey: key) == false else { return nil }
@@ -89,39 +92,92 @@ extension KeyedDecodingContainer {
     ///   the value is a null value.
     /// - throws: `DecodingError.typeMismatch` if the encountered encoded value
     ///   is not convertible to the requested type.
+    @available(*, deprecated, message: "In next version Will be replaced by decodeHexIfPresent() insetad")
     public func decodeIfPresent(_ type: [String: Any].Type, forKey key: KeyedDecodingContainer<K>.Key) throws -> [String: Any]? {
         guard contains(key),
             try decodeNil(forKey: key) == false else { return nil }
         return try decode(type, forKey: key)
     }
 
-    /// Decodes a value of the given key from Hex to <Type>
+    /// Decodes a value of the given key from Hex to `DecodableFromHex`
     ///
-    /// Currently this method supports only `Data.Type`, `BigUInt.Type`, `UInt.Type`, `Date.Type`
+    /// Currently this method supports only `Data.Type`, `BigUInt.Type`, `Date.Type`
     ///
     /// - Parameter type: Generic type `T` wich conforms to `DecodableFromHex` protocol
     /// - Parameter key: The key that the decoded value is associated with.
-    /// - Returns: A decoded value of type `DecodableFromHex`
-    /// - throws: `Web3Error.dataError` if value associated with key are unable
-    ///   to be initialized as `DecodableFromHex`.
-    public func decodeHex<T: DecodableFromHex>(to type: T.Type, key: KeyedDecodingContainer<K>.Key) throws -> T {
-        let string = try self.decode(String.self, forKey: key)
-        guard let number = T(fromHex: string) else { throw Web3Error.dataError }
+    /// - Returns: A decoded value of type `BigUInt`
+    /// - throws: `Web3Error.dataError` if value associated with key are unable to be initialized as `DecodableFromHex`.
+    public func decodeHex<T: DecodableFromHex>(_ type: T.Type, forKey: KeyedDecodingContainer<K>.Key) throws -> T {
+        let hexString = try self.decode(String.self, forKey: forKey)
+        guard let number = T(fromHex: hexString) else { throw Web3Error.dataError }
         return number
     }
 
-    /// Decodes a value of the given key from Hex to <Type>
+    /// Decodes a value of the given key from Hex to `[DecodableFromHex]`
     ///
-    /// Currently this method supports only `Data.Type`, `BigUInt.Type`, `UInt.Type`, `Date.Type`
+    /// Currently this method supports only `Data.Type`, `BigUInt.Type`, `Date.Type`
+    ///
+    /// - Parameter type: Array of a generic type `T` wich conforms to `DecodableFromHex` protocol
+    /// - Parameter key: The key that the decoded value is associated with.
+    /// - Returns: A decoded value of type `BigUInt`
+    /// - throws: `Web3Error.dataError` if value associated with key are unable to be initialized as `[[DecodableFromHex]]`.
+    public func decodeHex<T: DecodableFromHex>(_ type: [T].Type, forKey: KeyedDecodingContainer<K>.Key) throws -> [T] {
+        var container = try nestedUnkeyedContainer(forKey: forKey)
+        guard let array = try? container.decodeHex(type) else { throw Web3Error.dataError }
+        return array
+    }
+
+    /// Decodes a value of the given key from Hex to `[DecodableFromHex]`
+    ///
+    /// Currently this method supports only `Data.Type`, `BigUInt.Type`, `Date.Type`, `EthereumAddress`
+    ///
+    /// - Parameter type: Array of a generic type `T` wich conforms to `DecodableFromHex` protocol
+    /// - Parameter key: The key that the decoded value is associated with.
+    /// - Returns: A decoded value of type `BigUInt`
+    /// - throws: `Web3Error.dataError` if value associated with key are unable to be initialized as `[[DecodableFromHex]]`.
+    public func decodeHex<T: DecodableFromHex>(_ type: [[T]].Type, forKey: KeyedDecodingContainer<K>.Key) throws -> [[T]] {
+        var container = try nestedUnkeyedContainer(forKey: forKey)
+        guard let array = try? container.decodeHex(type) else { throw Web3Error.dataError }
+        return array
+    }
+}
+
+public extension UnkeyedDecodingContainer {
+    /// Decodes a unkeyed value from hex to `[DecodableFromHex]`
+    ///
+    /// Currently this method supports only `Data.Type`, `BigUInt.Type`, `Date.Type`, `EthereumAddress`
+    ///
+    /// - Parameter type: Generic type `T` wich conforms to `DecodableFromHex` protocol
+    /// - Parameter key: The key that the decoded value is associated with.
+    /// - Returns: A decoded value of type `BigUInt`
+    /// - throws: `Web3Error.dataError` if value associated with key are unable to be initialized as `[DecodableFromHex]`.
+    mutating func decodeHex<T: DecodableFromHex>(_ type: [T].Type) throws -> [T] {
+        var array: [T] = []
+        while !isAtEnd {
+            let hexString = try decode(String.self)
+            guard let item = T(fromHex: hexString) else { continue }
+            array.append(item)
+        }
+        return array
+    }
+
+
+    /// Decodes a unkeyed value from Hex to `DecodableFromHex`
+    ///
+    /// Currently this method supports only `Data.Type`, `BigUInt.Type`, `Date.Type`, `EthereumAddress`
     ///
     /// - Parameter type: Generic type `T` wich conforms to `DecodableFromHex` protocol
     /// - Parameter key: The key that the decoded value is associated with.
-    /// - Returns: A decoded value of type Optional `DecodableFromHex?`
-    /// - throws: `Web3Error.dataError` if value associated with key are unable
-    ///   to be initialized as `DecodableFromHex`.
-    public func decodeHexIfPresent<T: DecodableFromHex>(to type: T.Type, key: KeyedDecodingContainer<K>.Key) throws -> T? {
-        guard contains(key) else { return nil }
-        return try decodeHex(to: type, key: key)
+    /// - Returns: A decoded value of type `BigUInt`
+    /// - throws: `Web3Error.dataError` if value associated with key are unable to be initialized as `[[DecodableFromHex]]`.
+    mutating func decodeHex<T: DecodableFromHex>(_ type: [[T]].Type) throws -> [[T]] {
+        var array: [[T]] = []
+        while !isAtEnd {
+            var container = try nestedUnkeyedContainer()
+            let intArr = try container.decodeHex([T].self)
+            array.append(intArr)
+        }
+        return array
     }
 }
 
@@ -143,14 +199,6 @@ extension BigUInt: DecodableFromHex {
     }
 }
 
-extension UInt: DecodableFromHex {
-    public init?(fromHex hexString: String) {
-        self.init()
-        guard let tmp = UInt(hexString.stripHexPrefix(), radix: 16) else { return nil }
-        self = tmp
-    }
-}
-
 extension Date: DecodableFromHex {
     public init?(fromHex hexString: String) {
         self.init()
@@ -166,6 +214,7 @@ extension EthereumAddress: DecodableFromHex {
     }
 }
 
+// deprecated, should be removed in 3.0.0
 private extension KeyedDecodingContainer {
     func decode(_ type: [String: Any].Type) throws -> [String: Any] {
         var dictionary: [String: Any] = [:]
@@ -190,6 +239,7 @@ private extension KeyedDecodingContainer {
     }
 }
 
+// deprecated, should be removed in 3.0.0
 private extension UnkeyedDecodingContainer {
     mutating func decode(_ type: [Any].Type) throws -> [Any] {
         var elements: [Any] = []

Sources/web3swift/Promises/Promise+Web3+Eth+FeeHistory.swift

@@ -0,0 +1,28 @@
+//
+//  Promise+Web3+Eth+FeeHistory.swift
+//  web3swift
+//
+//  Created by Yaroslav on 11.04.2022.
+//  Copyright © 2022 web3swift. All rights reserved.
+//
+
+import Foundation
+import PromiseKit
+import BigInt
+
+extension web3.Eth {
+    func feeHistory(blockCount: BigUInt, block: String, percentiles:[Double]) throws -> Web3.Oracle.FeeHistory {
+        let request = JSONRPCRequestFabric.prepareRequest(.feeHistory, parameters: [blockCount.description.addHexPrefix(), block, percentiles])
+        let rp = web3.dispatch(request)
+        let queue = web3.requestDispatcher.queue
+        return try rp.map(on: queue) { response in
+            guard let value: Web3.Oracle.FeeHistory = response.getValue() else {
+                if response.error != nil {
+                    throw Web3Error.nodeError(desc: response.error!.message)
+                }
+                throw Web3Error.nodeError(desc: "Invalid value from Ethereum node")
+            }
+            return value
+        }.wait()
+    }
+}