Reducing Policies types and cases to bare minimum.

Author: yaroslavyaroslav

Sources/Core/Transaction/Policies.swift

@@ -10,42 +10,31 @@ import BigInt
 
 public typealias NoncePolicy = BlockNumber
 
-public enum GasLimitPolicy {
-    case automatic
-    case manual(BigUInt)
-    case limited(BigUInt)
-    case withMargin(Double)
-}
-
-public enum GasPricePolicy {
-    case automatic
-    case manual(BigUInt)
-    case withMargin(Double)
-}
-
-public enum FeePerGasPolicy {
-    case automatic
-    case manual(BigUInt)
-}
-
-public enum PriorityFeePerGasPolicy {
+/// Policies for resolving values like:
+/// - gas required for transaction execution
+/// - gas price
+/// - maximum fee per gas
+/// - maximum priority fee per gas
+public enum ValueResolutionPolicy {
+    /// What ever value will be resolved is the one to be applied
     case automatic
+    /// Specific value to be applied
     case manual(BigUInt)
 }
 
 public struct Policies {
     public let noncePolicy: NoncePolicy
-    public let gasLimitPolicy: GasLimitPolicy
-    public let gasPricePolicy: GasPricePolicy
-    public let maxFeePerGasPolicy: FeePerGasPolicy
-    public let maxPriorityFeePerGasPolicy: PriorityFeePerGasPolicy
+    public let gasLimitPolicy: ValueResolutionPolicy
+    public let gasPricePolicy: ValueResolutionPolicy
+    public let maxFeePerGasPolicy: ValueResolutionPolicy
+    public let maxPriorityFeePerGasPolicy: ValueResolutionPolicy
 
     public init(
         noncePolicy: NoncePolicy = .latest,
-        gasLimitPolicy: GasLimitPolicy = .automatic,
-        gasPricePolicy: GasPricePolicy = .automatic,
-        maxFeePerGasPolicy: FeePerGasPolicy = .automatic,
-        maxPriorityFeePerGasPolicy: PriorityFeePerGasPolicy = .automatic) {
+        gasLimitPolicy: ValueResolutionPolicy = .automatic,
+        gasPricePolicy: ValueResolutionPolicy = .automatic,
+        maxFeePerGasPolicy: ValueResolutionPolicy = .automatic,
+        maxPriorityFeePerGasPolicy: ValueResolutionPolicy = .automatic) {
             self.noncePolicy = noncePolicy
             self.gasLimitPolicy = gasLimitPolicy
             self.gasPricePolicy = gasPricePolicy

Sources/web3swift/Web3/Web3+Resolver.swift

@@ -35,7 +35,7 @@ public class PolicyResolver {
         }
     }
 
-    public func resolveGasBaseFee(for policy: FeePerGasPolicy) async -> BigUInt {
+    public func resolveGasBaseFee(for policy: ValueResolutionPolicy) async -> BigUInt {
         switch policy {
         case .automatic:
             return await Oracle(provider).baseFeePercentiles().max() ?? 0
@@ -44,32 +44,25 @@ public class PolicyResolver {
         }
     }
 
-    public func resolveGasEstimate(for transaction: CodableTransaction, with policy: GasLimitPolicy) async throws -> BigUInt {
+    public func resolveGasEstimate(for transaction: CodableTransaction, with policy: ValueResolutionPolicy) async throws -> BigUInt {
         switch policy {
-        case .automatic, .withMargin:
+        case .automatic:
             return try await estimateGas(for: transaction)
         case .manual(let value):
             return value
-        case .limited(let limit):
-            let result = try await estimateGas(for: transaction)
-            if limit <= result {
-                return result
-            } else {
-                return limit
-            }
         }
     }
 
-    public func resolveGasPrice(for policy: GasPricePolicy) async -> BigUInt {
+    public func resolveGasPrice(for policy: ValueResolutionPolicy) async -> BigUInt {
         switch policy {
-        case .automatic, .withMargin:
+        case .automatic:
             return await Oracle(provider).gasPriceLegacyPercentiles().max() ?? 0
         case .manual(let value):
             return value
         }
     }
 
-    public func resolveGasPriorityFee(for policy: PriorityFeePerGasPolicy) async -> BigUInt {
+    public func resolveGasPriorityFee(for policy: ValueResolutionPolicy) async -> BigUInt {
         switch policy {
         case .automatic:
             return await Oracle(provider).tipFeePercentiles().max() ?? 0