Merge pull request #510 from yaroslavyaroslav/feature/EIP-1559

Author: yaroslavyaroslav

Sources/web3swift/Convenience/Decodable+Extensions.swift

@@ -5,6 +5,7 @@
 //  Created by levantAJ on 1/18/19.
 //  Copyright © 2019 levantAJ. All rights reserved.
 //
+import BigInt
 import Foundation
 
 struct AnyCodingKey: CodingKey {
@@ -93,6 +94,50 @@ extension KeyedDecodingContainer {
             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
+    ///
+    /// 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(from: string) else { throw Web3Error.dataError }
+        return number
+    }
+}
+
+public protocol DecodableFromHex: Decodable {
+    init?(from hexString: String)
+}
+
+extension Data: DecodableFromHex {
+    public init?(from hexString: String) {
+        self.init()
+        guard let tmp = Self.fromHex(hexString) else { return nil }
+        self = tmp
+    }
+}
+
+extension BigUInt: DecodableFromHex {
+    public init?(from hexString: String) {
+        self.init()
+        guard let tmp = BigUInt(hexString.stripHexPrefix(), radix: 16) else { return nil }
+        self = tmp
+    }
+}
+
+extension Date: DecodableFromHex {
+    public init?(from hexString: String) {
+        self.init()
+        let stripedHexString = hexString.stripHexPrefix()
+        guard let timestampInt = UInt64(stripedHexString, radix: 16) else { return nil }
+        self = Date(timeIntervalSince1970: TimeInterval(timestampInt))
+    }
 }
 
 private extension KeyedDecodingContainer {

Sources/web3swift/EthereumAddress/EthereumAddress.swift

@@ -72,7 +72,15 @@ public struct EthereumAddress: Equatable {
         return ret
     }
 
-    public init?(_ addressString: String, type: AddressType = .normal, ignoreChecksum: Bool = false) {
+    public static func contractDeploymentAddress() -> EthereumAddress {
+        return EthereumAddress("0x", type: .contractDeployment)!
+    }
+}
+
+/// In swift structs it's better to implement initializers in extension
+/// Since it's make available syntetized initializer then for free.
+extension EthereumAddress {
+    public init?(_ addressString:String, type: AddressType = .normal, ignoreChecksum: Bool = false) {
         switch type {
         case .normal:
             guard let data = Data.fromHex(addressString) else {return nil}
@@ -108,16 +116,12 @@ public struct EthereumAddress: Equatable {
         }
     }
 
-    public init?(_ addressData: Data, type: AddressType = .normal) {
+    public init?(_ addressData:Data, type: AddressType = .normal) {
         guard addressData.count == 20 else {return nil}
         self._address = addressData.toHexString().addHexPrefix()
         self.type = type
     }
 
-    public static func contractDeploymentAddress() -> EthereumAddress {
-        return EthereumAddress("0x", type: .contractDeployment)!
-    }
-
 }
 
 extension EthereumAddress: Hashable { }

Sources/web3swift/Transaction/EthereumTransaction.swift

@@ -8,18 +8,40 @@ import Foundation
 import BigInt
 
 public struct EthereumTransaction: CustomStringConvertible {
+    // FIXME: Add Type value https://blog.mycrypto.com/new-transaction-types-on-ethereum
     public var nonce: BigUInt
-    public var gasPrice: BigUInt = BigUInt(0)
-    public var gasLimit: BigUInt = BigUInt(0)
+    public var gasPrice: BigUInt = 0
+    public var gasLimit: BigUInt = 0
+    
+    // MARK: - EIP-1559
+    /// Value of the tip to the miner for transaction processing.
+    ///
+    /// Full amount of this variable goes to a miner.
+    public var maxPriorityFeePerGas: BigUInt = 0
+
+    /// Value of the fee for one gas unit
+    ///
+    /// This value should be greather than sum of:
+    /// - `Block.nextBlockBaseFeePerGas` - baseFee which will burnt during the transaction processing
+    /// - `self.maxPriorityFeePerGas` - explicit amount of a tip to the miner of the given block which will include this transaction
+    ///
+    /// If amount of this will be **greather** than sum of `Block.baseFeePerGas` and `maxPriorityFeePerGas`
+    /// all exceed funds will be returned to the sender.
+    ///
+    /// If amount of this will be **lower** than sum of `Block.baseFeePerGas` and `maxPriorityFeePerGas`
+    /// miner will recieve amount of the follow equation: `maxFeePerGas - Block.baseFeePerGas` if any, 
+    /// where Block is a block to which transaction will be included.
+    public var maxFeePerGas: BigUInt = 0
+    
     // The destination address of the message, left undefined for a contract-creation transaction.
     public var to: EthereumAddress
     // (optional) The value transferred for the transaction in wei, also the endowment if it’s a contract-creation transaction.
     // TODO - split EthereumTransaction to two classes: with optional and required value property, depends on type of transaction
     public var value: BigUInt?
     public var data: Data
-    public var v: BigUInt = BigUInt(1)
-    public var r: BigUInt = BigUInt(0)
-    public var s: BigUInt = BigUInt(0)
+    public var v: BigUInt = 1
+    public var r: BigUInt = 0
+    public var s: BigUInt = 0
     var chainID: BigUInt? = nil
 
     public var inferedChainID: BigUInt? {
@@ -33,93 +55,69 @@ public struct EthereumTransaction: CustomStringConvertible {
             }
         }
     }
-
-    public var intrinsicChainID: BigUInt? {
-        get {
-            return self.chainID
-        }
-    }
-
+    
+    public var intrinsicChainID: BigUInt? { chainID }
+    
     public mutating func UNSAFE_setChainID(_ chainID: BigUInt?) {
         self.chainID = chainID
     }
 
     public var hash: Data? {
         var encoded: Data
         let inferedChainID = self.inferedChainID
-        if inferedChainID != nil {
-            guard let enc = self.self.encode(forSignature: false, chainID: inferedChainID) else {return nil}
+        if let inferedChainID = inferedChainID {
+            guard let enc = self.self.encode(forSignature: false, chainID: inferedChainID) else { return nil }
             encoded = enc
         } else {
-            guard let enc = self.self.encode(forSignature: false, chainID: self.chainID) else {return nil}
+            guard let enc = self.self.encode(forSignature: false, chainID: chainID) else { return nil }
             encoded = enc
         }
         let hash = encoded.sha3(.keccak256)
         return hash
     }
-
-    public init(gasPrice: BigUInt, gasLimit: BigUInt, to: EthereumAddress, value: BigUInt, data: Data) {
-        self.nonce = BigUInt(0)
-        self.gasPrice = gasPrice
-        self.gasLimit = gasLimit
-        self.value = value
-        self.data = data
-        self.to = to
-    }
-
-    public init (nonce: BigUInt, gasPrice: BigUInt, gasLimit: BigUInt, to: EthereumAddress, value: BigUInt, data: Data, v: BigUInt, r: BigUInt, s: BigUInt) {
-        self.nonce = nonce
-        self.gasPrice = gasPrice
-        self.gasLimit = gasLimit
-        self.to = to
-        self.value = value
-        self.data = data
-        self.v = v
-        self.r = r
-        self.s = s
-    }
-
+    
     public var description: String {
-        get {
-            var toReturn = ""
-            toReturn = toReturn + "Transaction" + "\n"
-            toReturn = toReturn + "Nonce: " + String(self.nonce) + "\n"
-            toReturn = toReturn + "Gas price: " + String(self.gasPrice) + "\n"
-            toReturn = toReturn + "Gas limit: " + String(describing: self.gasLimit) + "\n"
-            toReturn = toReturn + "To: " + self.to.address + "\n"
-            toReturn = toReturn + "Value: " + String(self.value ?? "nil") + "\n"
-            toReturn = toReturn + "Data: " + self.data.toHexString().addHexPrefix().lowercased() + "\n"
-            toReturn = toReturn + "v: " + String(self.v) + "\n"
-            toReturn = toReturn + "r: " + String(self.r) + "\n"
-            toReturn = toReturn + "s: " + String(self.s) + "\n"
-            toReturn = toReturn + "Intrinsic chainID: " + String(describing: self.chainID) + "\n"
-            toReturn = toReturn + "Infered chainID: " + String(describing: self.inferedChainID) + "\n"
-            toReturn = toReturn + "sender: " + String(describing: self.sender?.address)  + "\n"
-            toReturn = toReturn + "hash: " + String(describing: self.hash?.toHexString().addHexPrefix()) + "\n"
-            return toReturn
-        }
-
+        var toReturn = ""
+        toReturn += "Transaction" + "\n"
+        toReturn += "Nonce: " + String(self.nonce) + "\n"
+        toReturn += "Gas price: " + String(self.gasPrice) + "\n"
+        toReturn += "Gas limit: " + String(describing: self.gasLimit) + "\n"
+        toReturn += "Max priority fee per gas: " + String(describing: self.maxPriorityFeePerGas)
+        toReturn += "Max fee per gas: " + String(describing: maxFeePerGas)
+        toReturn += "To: " + self.to.address + "\n"
+        toReturn += "Value: " + String(self.value ?? "nil") + "\n"
+        toReturn += "Data: " + self.data.toHexString().addHexPrefix().lowercased() + "\n"
+        toReturn += "v: " + String(self.v) + "\n"
+        toReturn += "r: " + String(self.r) + "\n"
+        toReturn += "s: " + String(self.s) + "\n"
+        toReturn += "Intrinsic chainID: " + String(describing:self.chainID) + "\n"
+        toReturn += "Infered chainID: " + String(describing:self.inferedChainID) + "\n"
+        toReturn += "sender: " + String(describing: self.sender?.address)  + "\n"
+        toReturn += "hash: " + String(describing: self.hash?.toHexString().addHexPrefix()) + "\n"
+        return toReturn
     }
+
     public var sender: EthereumAddress? {
-        get {
-            guard let publicKey = self.recoverPublicKey() else {return nil}
-            return Web3.Utils.publicToAddress(publicKey)
-        }
+        guard let publicKey = self.recoverPublicKey() else { return nil }
+        return Web3.Utils.publicToAddress(publicKey)
     }
 
     public func recoverPublicKey() -> Data? {
-        if (self.r == BigUInt(0) && self.s == BigUInt(0)) {
-            return nil
-        }
-        var normalizedV: BigUInt = BigUInt(27)
+        // FIXME: AND not OR condition
+        guard r != 0, s != 0 else { return nil }
+        // if (self.r == 0 && self.s == 0) {
+        //     return nil
+        // }
+        var normalizedV: BigUInt = 27
         let inferedChainID = self.inferedChainID
-        var d = BigUInt(0)
+        var d: BigUInt = 0
+
         if self.v >= 35 && self.v <= 38 {
-            d = BigUInt(35)
+            d = 35
         } else if self.v >= 31 && self.v <= 34 {
-            d = BigUInt(31)
+            d = 31
         } else if self.v >= 27 && self.v <= 30 {
-            d = BigUInt(27)
+            d = 27
         }
         if let testID = self.chainID, testID != BigUInt(0) && self.v >= (d + testID + testID) {
             normalizedV = self.v - d - testID - testID
@@ -146,22 +144,16 @@ public struct EthereumTransaction: CustomStringConvertible {
     }
 
     public var txhash: String? {
-        get {
-            guard self.sender != nil else {return nil}
-            guard let hash = self.hash else {return nil}
-            let txid = hash.toHexString().addHexPrefix().lowercased()
-            return txid
-        }
-    }
-
-    public var txid: String? {
-        get {
-            return self.txhash
-        }
+        guard sender != nil else { return nil }
+        guard let hash = hash else { return nil }
+        let txid = hash.toHexString().addHexPrefix().lowercased()
+        return txid
     }
-
+    
+    public var txid: String? { txhash }
+    
     public func encode(forSignature: Bool = false, chainID: BigUInt? = nil) -> Data? {
-        if (forSignature) {
+        if forSignature {
             if chainID != nil  {
                 let fields = [self.nonce, self.gasPrice, self.gasLimit, self.to.addressData, self.value!, self.data, chainID!, BigUInt(0), BigUInt(0)] as [AnyObject]
                 return RLP.encode(fields)
@@ -286,12 +278,12 @@ public struct EthereumTransaction: CustomStringConvertible {
     }
 }
 
-public extension EthereumTransaction {
+extension EthereumTransaction {
     init(to: EthereumAddress, data: Data, options: TransactionOptions) {
         let defaults = TransactionOptions.defaultOptions
         let merged = defaults.merge(options)
-        self.nonce = BigUInt(0)
-
+        nonce = 0
+        
         if let gP = merged.gasPrice {
             switch gP {
             case .manual(let value):
@@ -318,6 +310,18 @@ public extension EthereumTransaction {
         self.data = data
     }
 
+}
+
+public extension EthereumTransaction {
+    init(gasPrice: BigUInt, gasLimit: BigUInt, to: EthereumAddress, value: BigUInt, data: Data) {
+        self.nonce = BigUInt(0)
+        self.gasPrice = gasPrice
+        self.gasLimit = gasLimit
+        self.value = value
+        self.data = data
+        self.to = to
+    }
+    
     func mergedWithOptions(_ options: TransactionOptions) -> EthereumTransaction {
         var tx = self
 

Sources/web3swift/Web3/Web3+Constants.swift

@@ -7,9 +7,21 @@
 //
 
 import Foundation
+import BigInt
 
 struct Constants {
     static let infuraHttpScheme = ".infura.io/v3/"
     static let infuraWsScheme = ".infura.io/ws/v3/"
     static let infuraToken = "4406c3acf862426c83991f1752c46dd8"
 }
+
+extension Web3 {
+    static let GasLimitBoundDivisor: BigUInt = 1024               // The bound divisor of the gas limit, used in update calculations.
+    static let MinGasLimit: BigUInt          = 5000               // Minimum the gas limit may ever be.
+    static let MaxGasLimit: BigUInt          = 0x7fffffffffffffff // Maximum the gas limit (2^63-1).
+    static let GenesisGasLimit: BigUInt      = 4712388            // Gas limit of the Genesis block.
+
+    static let BaseFeeChangeDenominator: BigUInt = 8           // Bounds the amount the base fee can change between blocks.
+    static let ElasticityMultiplier: BigUInt     = 2           // Bounds the maximum gas limit an EIP-1559 block may have.
+    static let InitialBaseFee: BigUInt           = 1000000000  // Initial base fee for EIP-1559 blocks.
+}