Merge pull request #3 from pharms-eth/test-1115629

merge remote develop update

Author: pharms-eth

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,67 @@
+name: Bug Report
+description: File a bug report.
+labels: ['bug']
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+  - type: textarea
+    id: bug-description
+    attributes:
+      label: What happened?
+      description: Please describe the bug.
+      placeholder: Description of the bug.
+    validations:
+      required: true
+  - type: textarea
+    id: steps-to-reproduce
+    attributes:
+      label: What are the steps to reproduce?
+      description: Please describe the steps to reproduce the bug.
+      placeholder: |
+        Step 1: ...
+        Step 2: ...
+        Step 3: ...
+    validations:
+      required: true
+  - type: textarea
+    id: expected-behavior
+    attributes:
+      label: What is the expected behavior?
+      description: Please describe the behavior you expect.
+      placeholder: I expect that...
+    validations:
+      required: true
+  - type: textarea
+    id: error-thrown
+    attributes:
+      label: What is the error thrown?
+      description: Please provide the exact error thrown.
+      placeholder: Web3Error.invalidData("Exact error message")
+    validations:
+      required: true
+  - type: textarea
+    id: source-path
+    attributes:
+      label: What's the stack trace said?
+      description: Please provide the exact source path.
+      placeholder: Sources/Core/Transaction/CodableTransaction.swift:129 func recoverPublicKey()
+    validations:
+      required: true
+  - type: textarea
+    id: os-version
+    attributes:
+      label: OS version
+      description: Please specify what platform and os version you are using?
+      placeholder: macOS 13.0.1 (22A400)
+    validations:
+      required: true
+  - type: textarea
+    id: lib-version
+    attributes:
+      label: Library version
+      description: Please specify what library version you are using?
+      placeholder: 3.0.6 or "ef06fbfc735ab687ebf89c937a9d1ffe6d81d37f" commit.
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/documentation-request.yml

@@ -0,0 +1,24 @@
+name: Documentation Request
+description: Suggest documentation you would like added
+labels: ['documentation']
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this documentation request!
+  - type: textarea
+    id: area
+    attributes:
+      label: What piece of the framework are having the lack of docs?
+      description: Bring the link, either type, either method name that is having the lack of docs
+      placeholder: "`Sources/Core/EthereumABI.swift:ABIElementPropertiesProtocol` or `ABIElementPropertiesProtocol`"
+    validations:
+      required: true
+  - type: textarea
+    id: reason
+    attributes:
+      label: What bit of docs would you like to have?
+      description: A clear and concise description of why this documentation needs to be improved.
+      placeholder: There's a lack of docs that covers both the intent of this type and the way how it should be used within client code.
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,30 @@
+name: Feature Request
+description: Suggest an idea for this project
+labels: ['enhancement']
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this feature request!
+  - type: textarea
+    id: problem
+    attributes:
+      label: What context is your feature request related to?
+      description: Short context name, please do not overcomplicate neither over fractionize it.
+      placeholder: Transaction pipeline enhancement, supported platform list extending, etc.
+    validations:
+      required: true
+  - type: textarea
+    id: solution
+    attributes:
+      label: What solution would you like?
+      description: A clear and concise description of what you want to happen.
+      placeholder: I would like that your lib has a magic "give me money" button, that provides me to just to build it, be uploaded to the AppStore and to get rich.
+    validations:
+      required: true
+  - type: textarea
+    id: context
+    attributes:
+      label: Any additional context?
+      description: If there's some specs either standard for such feature invented already here's the good place to provide those.
+      placeholder: Here's the pictures of house that i'd wanted to be able to bough after i've got rich and the my future cars list as well.

.github/workflows/macOS-11.yml

@@ -22,11 +22,11 @@ on:
       - unstable
 
 env:
-  DEVELOPER_DIR: /Applications/Xcode_13.3.1.app/Contents/Developer
+  DEVELOPER_DIR: /Applications/Xcode_14.1.app/Contents/Developer
 
 jobs:
   spm:
-    name: Swift Package Manager 5.5
+    name: Swift Package Manager 5.7
     runs-on: macOS-12
     concurrency: 
       group: spm-${{ github.run_id }}

.github/workflows/macOS-12.yml

@@ -3,14 +3,6 @@
 
 import PackageDescription
 
-#if os(macOS)
-let excludeFiles = [
-    "./Browser/BrowserViewController.swift" // Because of inheriting iOS only class failed to build on macOS.
-]
-#elseif os(iOS)
-let excludeFiles: String = []
-#endif
-
 let package = Package(
     name: "Web3swift",
     platforms: [
@@ -32,7 +24,6 @@ let package = Package(
         .target(
             name: "web3swift",
             dependencies: ["Core", "BigInt", "secp256k1"],
-            exclude: excludeFiles,
             resources: [
                 .copy("./Browser/browser.js"),
                 .copy("./Browser/browser.min.js"),

Package.swift

@@ -2,7 +2,7 @@
 **web3swift** is an iOS toolbelt for interaction with the Ethereum network.
 
 ## Social medias
-[Join our discord](https://discord.gg/8bHCNmhS7x) or [Telegram](https://t.me/web3swift) if you need a support or want to contribute to web3swift development!
+[Join our discord](https://discord.gg/8bHCNmhS7x) or [Telegram](https://t.me/web3swift) if you need support or want to contribute to web3swift development!
 
 ![matter-github-swift](https://github.com/skywinder/web3swift/blob/develop/web3swift-logo.png)
 [![Web3swift CI](https://github.com/skywinder/web3swift/actions/workflows/ci.yml/badge.svg)](https://github.com/skywinder/web3swift/actions/workflows/ci.yml)
@@ -49,13 +49,13 @@
 - [x] :thought_balloon: Interaction with remote node via **JSON RPC** 
 - [x] 🔐 Local **keystore management** (`geth` compatible)
 - [x] 🤖 Smart-contract **ABI parsing** 
-- [x] 🔓**ABI deconding** (V2 is supported with return of structures from public functions. Part of 0.4.22 Solidity compiler)
+- [x] 🔓**ABI decoding** (V2 is supported with return of structures from public functions. Part of 0.4.22 Solidity compiler)
 - [x] 🕸Ethereum Name Service **(ENS) support** - a secure & decentralised way to address resources both on and off the blockchain using simple, human-readable names
 - [x] :arrows_counterclockwise: **Smart contracts interactions** (read/write) 
 - [x]  ⛩ **Infura support**
 - [x] ⚒  **Parsing TxPool** content into native values (ethereum addresses and transactions) - easy to get pending transactions
 - [x] 🖇 **Event loops** functionality
-- [x] 🕵️‍♂️ Possibility to **add or remove "middleware" that intercepts**, modifies and even **cancel transaction** workflow on stages "before assembly", "after assembly"and "before submission"
+- [x] 🕵️‍♂️ Possibility to **add or remove "middleware" that intercepts**, modifies and even **cancel transaction** workflow on stages "before assembly", "after assembly" and "before submission"
 - [x] ✅**Literally following the standards** (BIP, EIP, etc):
     - [x] **[BIP32](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki) (HD Wallets), [BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki) (Seed phrases), [BIP44](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki) (Key generation prefixes)**
 - [x] **[EIP-20](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-20.md)** (Standart interface for tokens - ERC-20), **[EIP-67](https://github.com/ethereum/EIPs/issues/67)** (Standard URI scheme), **[EIP-155](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-155.md)** (Replay attacks protection), **[EIP-2718](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-2718.md)** (Typed Transaction Envelope), **[EIP-1559](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1559.md)** (Gas Fee market change)
@@ -85,7 +85,6 @@ target '<Your Target Name>' do
     use_frameworks!
     pod 'web3swift'
 end
-
 ```
 
 Then, run the following command:
@@ -114,7 +113,7 @@ import Core
 ### Send Ether
 ```swift
 let transaction: CodableTransaction = .emptyTransaction
-transaction.from = from ?? transaction.sender // `sender` one is if you have private key of your wallet address, so public key e.g. your wallet address could be infereted
+transaction.from = from ?? transaction.sender // `sender` one is if you have private key of your wallet address, so public key e.g. your wallet address could be interpreted
 transaction.value = value
 transaction.gasLimitPolicy = .manual(78423)
 transaction.gasPricePolicy = .manual(20000000000)
@@ -166,16 +165,30 @@ swift build
 Documentation is under construction👷🏻👷🏼‍♀️. We’re trying our best to comment all public API as detailed as we can, but the end it still far to come. But in one of the nearest minor updates we’ll bring DocC support of already done amount of docs. And your PR in such are more than welcome.
 
 ## Projects that are using web3swift
-Please take a look at [Our costumers](https://github.com/skywinder/web3swift/wiki/Our-Customers) wiki page.
+Please take a look at [Our customers](https://github.com/skywinder/web3swift/wiki/Our-Customers) wiki page.
 
 ## Support
 
-**[Join our discord](https://discord.gg/8bHCNmhS7x) and [Telegram](https://t.me/web3swift) if you need a support or want to contribute to web3swift development!**
+**[Join our discord](https://discord.gg/8bHCNmhS7x) and [Telegram](https://t.me/web3swift) if you need support or want to contribute to web3swift development!**
 
 - If you **need help**, please take a look at our [FAQ](https://github.com/skywinder/web3swift/wiki/FAQ "") or [open an issue](https://github.com/skywinder/web3swift/issues).
 - If you'd like to **see web3swift best practices**, check [Projects that using web3swift](https://github.com/skywinder/web3swift/wiki/Our-Customers).
 - If you **found a bug**, [open an issue](https://github.com/skywinder/web3swift/issues).
 
+## Development
+To do local development and run the local tests, we recommend to use [ganache](https://github.com/trufflesuite/ganache) which is also used by CI when running github actions.
+
+```cli
+// To install
+$ npm install ganache --global
+
+// To run
+$ ganache
+```
+
+This will create a local blockchain and also some test accounts that are used throughout our tests.
+Make sure that `ganache` is running on its default port `8546`. To change the port in test cases locate `LocalTestCase.swift` and modify the static `url` variable.
+
 ## Contribute
 Want to improve? It's awesome:
 Then good news for you: **We are ready to pay for your contribution via [@gitcoin bot](https://gitcoin.co/grants/358/web3swift)!**
@@ -202,8 +215,8 @@ We want to continue to do everything we can to move the needle forward.
 ## Credits
 
 - Alex Vlasov, [@shamatar](https://github.com/shamatar) - for the initial implementation
-- Petr Korolev, [@skywinder](https://github.com/skywinder) - botstrap and continous support
-- Anton Grigorev, [@baldyash](https://github.com/BaldyAsh) - core contributor, who use it and making a lot of ipmprovments
+- Petr Korolev, [@skywinder](https://github.com/skywinder) - bootstrap and continuous support
+- Anton Grigorev, [@baldyash](https://github.com/BaldyAsh) - core contributor, who use it and making a lot of improvements
 - Yaroslav Yashin [@yaroslavyaroslav](https://github.com/yaroslavyaroslav) - core contributor of 3.0.0 and later releases.
 - Thanks to [web3swift's growing list of contributors](https://github.com/skywinder/web3swift/graphs/contributors).
 

README.md

@@ -69,7 +69,7 @@ import BigInt
 public protocol ContractProtocol {
     /// Address of the referenced smart contract. Can be set later, e.g. if the contract is deploying and address is not yet known.
     var address: EthereumAddress? {get set}
-    
+
     /// All ABI elements like: events, functions, constructors and errors.
     var abi: [ABI.Element] {get}
 
@@ -81,13 +81,13 @@ public protocol ContractProtocol {
     /// - and 4 bytes signature `0xffffffff` (expected to be lowercased).
     /// The mapping by name (e.g. `getData`) is the one most likely expected to return arrays with
     /// more than one entry due to the fact that solidity allows method overloading.
-    var methods: [String:[ABI.Element.Function]] {get}
+    var methods: [String: [ABI.Element.Function]] {get}
 
     /// All values from ``methods``.
     var allMethods: [ABI.Element.Function] {get}
 
     /// Events filtered from ``abi`` and mapped to their unchanged ``ABI/Element/Event/name``.
-    var events: [String:ABI.Element.Event] {get}
+    var events: [String: ABI.Element.Event] {get}
 
     /// All values from ``events``.
     var allEvents: [ABI.Element.Event] {get}
@@ -225,7 +225,6 @@ extension DefaultContractProtocol {
            let parameters = parameters,
            !parameters.isEmpty {
             guard constructor.inputs.count == parameters.count,
-                  // FIXME: This should be zipped, because Arrays don't guarantee it's elements order
                   let encodedData = constructor.encodeParameters(parameters) else {
                 NSLog("Constructor encoding will fail as the number of input arguments doesn't match the number of given arguments.")
                 return nil
@@ -264,7 +263,7 @@ extension DefaultContractProtocol {
         let method = Data.fromHex(method) == nil ? method : method.addHexPrefix().lowercased()
 
         // MARK: - Encoding ABI Data flow
-        guard let abiMethod = methods[method]?.first,
+        guard let abiMethod = methods[method]?.first(where: { $0.inputs.count == parameters.count }),
               var encodedData = abiMethod.encodeParameters(parameters) else { return nil }
 
         // Extra data just appends in the end of parameters data
@@ -278,11 +277,10 @@ extension DefaultContractProtocol {
 
     public func parseEvent(_ eventLog: EventLog) -> (eventName: String?, eventData: [String: Any]?) {
         for (eName, ev) in self.events {
-            if (!ev.anonymous) {
+            if !ev.anonymous {
                 if eventLog.topics[0] != ev.topic {
                     continue
-                }
-                else {
+                } else {
                     let logTopics = eventLog.topics
                     let logData = eventLog.data
                     let parsed = ev.decodeReturnedLogs(eventLogTopics: logTopics, eventLogData: logData)

Sources/Core/Contract/ContractProtocol.swift

@@ -10,7 +10,7 @@ import BigInt
 /// constructor, errors and optional ``EthereumAddress`` that could be set later.
 public class EthereumContract: DefaultContractProtocol {
 
-    public var address: EthereumAddress? = nil
+    public var address: EthereumAddress?
 
     public let abi: [ABI.Element]
     public let methods: [String: [ABI.Element.Function]]
@@ -40,7 +40,7 @@ public class EthereumContract: DefaultContractProtocol {
     public convenience required init(_ abiString: String, at: EthereumAddress? = nil) throws {
         let jsonData = abiString.data(using: .utf8)
         let abi = try JSONDecoder().decode([ABI.Record].self, from: jsonData!)
-        let abiNative = try abi.map({ (record) -> ABI.Element in
+        let abiNative = try abi.map({ record -> ABI.Element in
             return try record.parse()
         })
         try self.init(abi: abiNative, at: at)