Merge pull request #514 from skywinder/feature/gas-prediction

Gas prediction implementation

Author: yaroslavyaroslav

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.endIndex] }
+        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,26 +92,93 @@ 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 BigUInt
+    /// Decodes a value of the given key from Hex to `DecodableFromHex`
     ///
     /// 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 `BigUInt`
-    /// - throws: `Web3Error.dataError` if value associated with key are unable
-    ///   to be initialized as `BigUInt`.
-    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 }
+    /// - 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 `[DecodableFromHex]`
+    ///
+    /// 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 `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
+    }
 }
 
 public protocol DecodableFromHex: Decodable {
@@ -144,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] = [:]
@@ -168,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()
+    }
+}