Add erc base properties

janndriessen · janndriessen · commit 3999fb8cf329 · 2022-11-22T09:34:35.000+01:00
diff --git a/Sources/web3swift/Tokens/ERC1376/Web3+ERC1376.swift b/Sources/web3swift/Tokens/ERC1376/Web3+ERC1376.swift
@@ -66,20 +66,15 @@ protocol IERC1376: IERC20 {
 }
 
 // FIXME: Rewrite this to CodableTransaction
-public class ERC1376: IERC1376, ERC20BaseProperties {
-
-    internal var _name: String?
-    internal var _symbol: String?
-    internal var _decimals: UInt8?
-    internal var _hasReadProperties: Bool = false
-
+public class ERC1376: IERC1376, ERCBaseProperties {
+    public var basePropertiesProvder: ERCBasePropertiesProvider
     public var transaction: CodableTransaction
     public var web3: Web3
     public var provider: Web3Provider
     public var address: EthereumAddress
     public var abi: String
 
-    lazy var contract: Web3.Contract = {
+    public lazy var contract: Web3.Contract = {
         let contract = self.web3.contract(self.abi, at: self.address, abiVersion: 2)
         precondition(contract != nil)
         return contract!
@@ -92,6 +87,9 @@ public class ERC1376: IERC1376, ERC20BaseProperties {
         self.transaction = transaction
         self.transaction.to = address
         self.abi = abi
+        // Forced because this should fail if contract is wrongly configured
+        let contract = web3.contract(Web3.Utils.erc20ABI, at: address)!
+        self.basePropertiesProvder = ERCBasePropertiesProvider(contract: contract)
     }
 
     public func getBalance(account: EthereumAddress) async throws -> BigUInt {
diff --git a/Sources/web3swift/Tokens/ERC1400/Web3+ERC1400.swift b/Sources/web3swift/Tokens/ERC1400/Web3+ERC1400.swift
@@ -63,20 +63,15 @@ protocol IERC1400: IERC20 {
 // variables are lazyly evaluated or global token information (name, ticker, total supply)
 // can be imperatively read and saved
 // FIXME: Rewrite this to CodableTransaction
-public class ERC1400: IERC1400, ERC20BaseProperties {
-
-    internal var _name: String?
-    internal var _symbol: String?
-    internal var _decimals: UInt8?
-    internal var _hasReadProperties: Bool = false
-
+public class ERC1400: IERC1400, ERCBaseProperties {
+    public var basePropertiesProvder: ERCBasePropertiesProvider
     public var transaction: CodableTransaction
     public var web3: Web3
     public var provider: Web3Provider
     public var address: EthereumAddress
     public var abi: String
 
-    lazy var contract: Web3.Contract = {
+    public lazy var contract: Web3.Contract = {
         let contract = self.web3.contract(self.abi, at: self.address, abiVersion: 2)
         precondition(contract != nil)
         return contract!
@@ -89,6 +84,9 @@ public class ERC1400: IERC1400, ERC20BaseProperties {
         self.transaction = transaction
         self.transaction.to = address
         self.abi = abi
+        // Forced because this should fail if contract is wrongly configured
+        let contract = web3.contract(Web3.Utils.erc20ABI, at: address)!
+        self.basePropertiesProvder = ERCBasePropertiesProvider(contract: contract)
     }
 
     public func getBalance(account: EthereumAddress) async throws -> BigUInt {
diff --git a/Sources/web3swift/Tokens/ERC1410/Web3+ERC1410.swift b/Sources/web3swift/Tokens/ERC1410/Web3+ERC1410.swift
@@ -41,21 +41,15 @@ protocol IERC1410: IERC20 {
 }
 
 // FIXME: Rewrite this to CodableTransaction
-public class ERC1410: IERC1410, ERC20BaseProperties {
-
-    internal var _name: String?
-    internal var _symbol: String?
-    internal var _decimals: UInt8?
-    private var _totalSupply: BigUInt?
-    internal var _hasReadProperties: Bool = false
-
+public class ERC1410: IERC1410, ERCBaseProperties {
+    public var basePropertiesProvder: ERCBasePropertiesProvider
     public var transaction: CodableTransaction
     public var web3: Web3
     public var provider: Web3Provider
     public var address: EthereumAddress
     public var abi: String
 
-    lazy var contract: Web3.Contract = {
+    public lazy var contract: Web3.Contract = {
         let contract = self.web3.contract(self.abi, at: self.address, abiVersion: 2)
         precondition(contract != nil)
         return contract!
@@ -68,6 +62,9 @@ public class ERC1410: IERC1410, ERC20BaseProperties {
         self.abi = abi
         self.transaction = transaction
         self.transaction.to = address
+        // Forced because this should fail if contract is wrongly configured
+        let contract = web3.contract(Web3.Utils.erc20ABI, at: address)!
+        self.basePropertiesProvder = ERCBasePropertiesProvider(contract: contract)
     }
 
     public func getBalance(account: EthereumAddress) async throws -> BigUInt {
diff --git a/Sources/web3swift/Tokens/ERC1594/Web3+ERC1594.swift b/Sources/web3swift/Tokens/ERC1594/Web3+ERC1594.swift
@@ -31,20 +31,15 @@ protocol IERC1594: IERC20 {
 }
 
 // FIXME: Rewrite this to CodableTransaction
-public class ERC1594: IERC1594, ERC20BaseProperties {
-
-    internal var _name: String?
-    internal var _symbol: String?
-    internal var _decimals: UInt8?
-    internal var _hasReadProperties: Bool = false
-
+public class ERC1594: IERC1594, ERCBaseProperties {
+    public var basePropertiesProvder: ERCBasePropertiesProvider
     public var transaction: CodableTransaction
     public var web3: Web3
     public var provider: Web3Provider
     public var address: EthereumAddress
     public var abi: String
 
-    lazy var contract: Web3.Contract = {
+    public lazy var contract: Web3.Contract = {
         let contract = self.web3.contract(self.abi, at: self.address, abiVersion: 2)
         precondition(contract != nil)
         return contract!
@@ -57,6 +52,9 @@ public class ERC1594: IERC1594, ERC20BaseProperties {
         self.transaction = transaction
         self.transaction.to = address
         self.abi = abi
+        // Forced because this should fail if contract is wrongly configured
+        let contract = web3.contract(Web3.Utils.erc20ABI, at: address)!
+        self.basePropertiesProvder = ERCBasePropertiesProvider(contract: contract)
     }
 
     public func getBalance(account: EthereumAddress) async throws -> BigUInt {
diff --git a/Sources/web3swift/Tokens/ERC1633/Web3+ERC1633.swift b/Sources/web3swift/Tokens/ERC1633/Web3+ERC1633.swift
@@ -18,20 +18,15 @@ protocol IERC1633: IERC20, IERC165 {
 
 }
 
-public class ERC1633: IERC1633, ERC20BaseProperties {
-
-    internal var _name: String?
-    internal var _symbol: String?
-    internal var _decimals: UInt8?
-    internal var _hasReadProperties: Bool = false
-
+public class ERC1633: IERC1633, ERCBaseProperties {
+    public var basePropertiesProvder: ERCBasePropertiesProvider
     public var transaction: CodableTransaction
     public var web3: Web3
     public var provider: Web3Provider
     public var address: EthereumAddress
     public var abi: String
 
-    lazy var contract: Web3.Contract = {
+    public lazy var contract: Web3.Contract = {
         let contract = self.web3.contract(self.abi, at: self.address, abiVersion: 2)
         precondition(contract != nil)
         return contract!
@@ -44,6 +39,9 @@ public class ERC1633: IERC1633, ERC20BaseProperties {
         self.transaction = transaction
         self.transaction.to = address
         self.abi = abi
+        // Forced because this should fail if contract is wrongly configured
+        let contract = web3.contract(Web3.Utils.erc20ABI, at: address)!
+        self.basePropertiesProvder = ERCBasePropertiesProvider(contract: contract)
     }
 
     public func getBalance(account: EthereumAddress) async throws -> BigUInt {
diff --git a/Sources/web3swift/Tokens/ERC1643/Web3+ERC1643.swift b/Sources/web3swift/Tokens/ERC1643/Web3+ERC1643.swift
@@ -21,20 +21,15 @@ protocol IERC1643: IERC20 {
 }
 
 // FIXME: Rewrite this to CodableTransaction
-public class ERC1643: IERC1643, ERC20BaseProperties {
-
-    internal var _name: String?
-    internal var _symbol: String?
-    internal var _decimals: UInt8?
-    internal var _hasReadProperties: Bool = false
-
+public class ERC1643: IERC1643, ERCBaseProperties {
+    public var basePropertiesProvder: ERCBasePropertiesProvider
     public var transaction: CodableTransaction
     public var web3: Web3
     public var provider: Web3Provider
     public var address: EthereumAddress
     public var abi: String
 
-    lazy var contract: Web3.Contract = {
+    public lazy var contract: Web3.Contract = {
         let contract = self.web3.contract(self.abi, at: self.address, abiVersion: 2)
         precondition(contract != nil)
         return contract!
@@ -47,6 +42,9 @@ public class ERC1643: IERC1643, ERC20BaseProperties {
         self.transaction = transaction
         self.transaction.to = address
         self.abi = abi
+        // Forced because this should fail if contract is wrongly configured
+        let contract = web3.contract(Web3.Utils.erc20ABI, at: address)!
+        self.basePropertiesProvder = ERCBasePropertiesProvider(contract: contract)
     }
 
     public func getBalance(account: EthereumAddress) async throws -> BigUInt {
diff --git a/Sources/web3swift/Tokens/ERC1644/Web3+ERC1644.swift b/Sources/web3swift/Tokens/ERC1644/Web3+ERC1644.swift
@@ -20,20 +20,15 @@ protocol IERC1644: IERC20 {
 }
 
 // FIXME: Rewrite this to CodableTransaction
-public class ERC1644: IERC1644, ERC20BaseProperties {
-
-    internal var _name: String?
-    internal var _symbol: String?
-    internal var _decimals: UInt8?
-    internal var _hasReadProperties: Bool = false
-
+public class ERC1644: IERC1644, ERCBaseProperties {
+    public var basePropertiesProvder: ERCBasePropertiesProvider
     public var transaction: CodableTransaction
     public var web3: Web3
     public var provider: Web3Provider
     public var address: EthereumAddress
     public var abi: String
 
-    lazy var contract: Web3.Contract = {
+    public lazy var contract: Web3.Contract = {
         let contract = self.web3.contract(self.abi, at: self.address, abiVersion: 2)
         precondition(contract != nil)
         return contract!
@@ -46,6 +41,9 @@ public class ERC1644: IERC1644, ERC20BaseProperties {
         self.transaction = transaction
         self.transaction.to = address
         self.abi = abi
+        // Forced because this should fail if contract is wrongly configured
+        let contract = web3.contract(Web3.Utils.erc20ABI, at: address)!
+        self.basePropertiesProvder = ERCBasePropertiesProvider(contract: contract)
     }
 
     public func getBalance(account: EthereumAddress) async throws -> BigUInt {
diff --git a/Sources/web3swift/Tokens/ERC20/Web3+ERC20.swift b/Sources/web3swift/Tokens/ERC20/Web3+ERC20.swift
@@ -22,18 +22,14 @@ protocol IERC20 {
 // variables are lazyly evaluated or global token information (name, ticker, total supply)
 // can be imperatively read and saved
 // FIXME: Rewrite this to CodableTransaction
-public class ERC20: IERC20, ERC20BaseProperties {
-    var _name: String?
-    var _symbol: String?
-    var _decimals: UInt8?
-    var _hasReadProperties: Bool = false
-
+public class ERC20: IERC20, ERCBaseProperties {
+    public var basePropertiesProvder: ERCBasePropertiesProvider
     public var transaction: CodableTransaction
     public var web3: Web3
     public var provider: Web3Provider
     public var address: EthereumAddress
 
-    lazy var contract: Web3.Contract = {
+    public lazy var contract: Web3.Contract = {
         let contract = self.web3.contract(Web3.Utils.erc20ABI, at: self.address, abiVersion: 2)
         precondition(contract != nil)
         return contract!
@@ -44,6 +40,9 @@ public class ERC20: IERC20, ERC20BaseProperties {
         self.provider = provider
         self.address = address
         self.transaction = transaction
+        // Forced because this should fail if contract is wrongly configured
+        let contract = web3.contract(Web3.Utils.erc20ABI, at: address)!
+        self.basePropertiesProvder = ERCBasePropertiesProvider(contract: contract)
     }
 
     public func getBalance(account: EthereumAddress) async throws -> BigUInt {
@@ -172,47 +171,3 @@ public class ERC20: IERC20, ERC20BaseProperties {
     }
 
 }
-
-protocol ERC20BaseProperties: AnyObject {
-    var contract: Web3.Contract { get }
-    var _name: String? { get set }
-    var _symbol: String? { get set }
-    var _decimals: UInt8? { get set }
-    var _hasReadProperties: Bool { get set }
-    func readProperties() async throws
-    func name() -> String?
-    func symbol() -> String?
-    func decimals() -> UInt8?
-}
-
-extension ERC20BaseProperties {
-    public func name() -> String? {
-        _name
-    }
-
-    public func symbol() -> String? {
-        _symbol
-    }
-
-    public func decimals() -> UInt8? {
-        _decimals
-    }
-
-    public func readProperties() async throws {
-        guard !_hasReadProperties else { return }
-        guard contract.contract.address != nil else {return}
-        _name = try await contract
-            .createReadOperation("name")?
-            .callContractMethod()["0"] as? String
-
-        _symbol = try await contract
-            .createReadOperation("symbol")?
-            .callContractMethod()["0"] as? String
-
-        let decimals = try await contract
-            .createReadOperation("decimals")?
-            .callContractMethod()["0"] as? BigUInt
-        _decimals = decimals != nil ? UInt8(decimals!) : nil
-        _hasReadProperties = true
-    }
-}
diff --git a/Sources/web3swift/Tokens/ERC777/Web3+ERC777.swift b/Sources/web3swift/Tokens/ERC777/Web3+ERC777.swift
@@ -29,21 +29,15 @@ protocol IERC777: IERC20, IERC820 {
 // This namespace contains functions to work with ERC777 tokens.
 // can be imperatively read and saved
 // FIXME: Rewrite this to CodableTransaction
-public class ERC777: IERC777, ERC20BaseProperties {
-
-    internal var _name: String?
-    internal var _symbol: String?
-    internal var _decimals: UInt8?
-
-    internal var _hasReadProperties: Bool = false
-
+public class ERC777: IERC777, ERCBaseProperties {
+    public var basePropertiesProvder: ERCBasePropertiesProvider
     public var transaction: CodableTransaction
     public var web3: Web3
     public var provider: Web3Provider
     public var address: EthereumAddress
     public var abi: String
 
-    lazy var contract: Web3.Contract = {
+    public lazy var contract: Web3.Contract = {
         let contract = self.web3.contract(self.abi, at: self.address, abiVersion: 2)
         precondition(contract != nil)
         return contract!
@@ -56,13 +50,16 @@ public class ERC777: IERC777, ERC20BaseProperties {
         self.transaction = transaction
         self.transaction.to = address
         self.abi = abi
+        // Forced because this should fail if contract is wrongly configured
+        let contract = web3.contract(Web3.Utils.erc20ABI, at: address)!
+        self.basePropertiesProvder = ERCBasePropertiesProvider(contract: contract)
     }
 
     // Must be 18!
     public func decimals() async throws -> UInt8 {
         try await self.readProperties()
-        if self._decimals != nil {
-            return self._decimals!
+        if self.decimals != nil {
+            return self.decimals!
         }
         return 18
     }
diff --git a/Sources/web3swift/Tokens/ERC888/Web3+ERC888.swift b/Sources/web3swift/Tokens/ERC888/Web3+ERC888.swift
@@ -16,20 +16,15 @@ protocol IERC888 {
 }
 
 // FIXME: Rewrite this to CodableTransaction
-public class ERC888: IERC888, ERC20BaseProperties {
-
-    internal var _name: String?
-    internal var _symbol: String?
-    internal var _decimals: UInt8?
-    internal var _hasReadProperties: Bool = false
-
+public class ERC888: IERC888, ERCBaseProperties {
+    public var basePropertiesProvder: ERCBasePropertiesProvider
     public var transaction: CodableTransaction
     public var web3: Web3
     public var provider: Web3Provider
     public var address: EthereumAddress
     public var abi: String
 
-    lazy var contract: Web3.Contract = {
+    public lazy var contract: Web3.Contract = {
         let contract = self.web3.contract(self.abi, at: self.address, abiVersion: 2)
         precondition(contract != nil)
         return contract!
@@ -42,6 +37,9 @@ public class ERC888: IERC888, ERC20BaseProperties {
         self.transaction = transaction
         self.transaction.to = address
         self.abi = abi
+        // Forced because this should fail if contract is wrongly configured
+        let contract = web3.contract(Web3.Utils.erc20ABI, at: address)!
+        self.basePropertiesProvder = ERCBasePropertiesProvider(contract: contract)
     }
 
     public func getBalance(account: EthereumAddress) async throws -> BigUInt {
diff --git a/Sources/web3swift/Tokens/ST20/Web3+ST20.swift b/Sources/web3swift/Tokens/ST20/Web3+ST20.swift
diff --git a/Sources/web3swift/Tokens/ST20/Web3+SecurityToken.swift b/Sources/web3swift/Tokens/ST20/Web3+SecurityToken.swift
diff --git a/Sources/web3swift/Utils/ERC/ERCBaseProperties.swift b/Sources/web3swift/Utils/ERC/ERCBaseProperties.swift
diff --git a/Tests/web3swiftTests/localTests/ERC20ClassTests.swift b/Tests/web3swiftTests/localTests/ERC20ClassTests.swift
