Merge pull request #520 from skywinder/develop

Author: yaroslavyaroslav

.github/workflows/ci.yml

@@ -42,8 +42,8 @@ jobs:
         run: sleep 1
       - name: Run local tests
         run: swift test --skip-build -c debug --filter localTests
-      # - name: Run remote tests
-      #   run: swift test --skip-build -c debug --filter remoteTests
+      - name: Run remote tests
+        run: swift test --skip-build -c debug --filter remoteTests
   carthage:
     name: Carthage
     runs-on: macOS-11
@@ -64,7 +64,7 @@ jobs:
       - name: Building dependencies
         run: carthage build --no-use-binaries --platform iOS Simulator --use-xcframeworks
       - name: Building framework
-        run: xcodebuild build-for-testing -project "web3swift.xcodeproj" -scheme "web3swift" -destination "${{matrix.destination}}" -testPlan LocalTests
+        run: xcodebuild build-for-testing -project "web3swift.xcodeproj" -scheme "web3swift" -destination "${{matrix.destination}}"
       - name: Install ganache
         run: npm install ganache --global
       - name: Start ganache in background
@@ -73,5 +73,5 @@ jobs:
         run: sleep 1
       - name: Run local tests
         run: xcodebuild test-without-building -project "web3swift.xcodeproj" -scheme "web3swift" -destination "${{matrix.destination}}" -testPlan LocalTests
-      # - name: Run remote tests
-      #   run: xcodebuild test-without-building -project "web3swift.xcodeproj" -scheme "web3swift" -destination "${{matrix.destination}}" -testPlan RemoteTests
+      - name: Run remote tests
+        run: xcodebuild test-without-building -project "web3swift.xcodeproj" -scheme "web3swift" -destination "${{matrix.destination}}" -testPlan RemoteTests

.swiftlint.yml

@@ -0,0 +1,45 @@
+excluded:
+  - Carthage
+  - Pods
+  - .build
+  - Build
+  - DerivedData
+
+disabled_rules:
+  - type_name
+  - identifier_name
+  - line_length
+  - multiple_closures_with_trailing_closure
+  - todo
+
+opt_in_rules:
+ - weak_delegate
+ - unused_import
+ - unneeded_parentheses_in_closure_argument
+ - trailing_closure
+ - static_operator
+ - redundant_nil_coalescing
+ - override_in_extension
+ - legacy_objc_type
+ - implicitly_unwrapped_optional
+ - force_unwrapping
+ - empty_string
+ - closure_body_length
+ - fallthrough
+ - indentation_width
+
+# force warnings
+force_cast: error
+force_try: error 
+
+custom_rules:
+  commented_out_code: 
+    included: ".*\\.swift" # regex that defines paths to include during linting. optional.
+    excluded: ".*Test(s)?\\.swift" # regex that defines paths to exclude during linting. optional
+    name: "Commented out code" # rule name. optional.
+    regex: "^\\/\\/\\s*(@|\\.?([a-z]|(\\})))" # matching pattern
+    capture_group: 0 # number of regex capture group to highlight the rule violation at. optional.
+    match_kinds: # SyntaxKinds to match. optional.
+      - comment
+    message: "No commented code in devel branch allowed." # violation message. optional.
+    severity: warning # violation severity. optional.

CONTRIBUTION.md

@@ -0,0 +1,70 @@
+# Contribution guide
+## Version convention
+We’re conforming [default versions convention](https://semver.org/).
+So in the `1.0.0` version each position means follow:
+- 1.\*.* — **major release**, includes API groundbreaking changes (ie: your old code will not work).
+- \*.1.* — **minor release**, we’ve added some new feature to the lib, but we didn’t break something in anyway (ie: everything will work as expected without any moves after update).
+- \*.*.1 — **patch release**, we’re haven’t add any breaking changes or even new features for the user, but we’ve fixed some bugs or rewrote something internal (ie: you should not event mention that anything were changed in the lib).
+
+This library yet living within **three weeks minor release** schedule. Also please keep in mind that in sake of avoiding complex merge conflicts, we’re currently taking only **one big feature** in release, so if you want to take some, please drop us a message somewhere to avoiding reworking it after it’ll be broken by some massive merge.
+
+Critical bug fixes are should be marked with appropriate label in PR and should be proceed **within one week** till patch ’ll be released (at least we’ll try our best to made that).
+
+## What task to choose
+Please take it from the [roadmap](https://hackmd.io/G5znP3xAQY-BVc1X8Y1jSg) or from the [opened issues](https://github.com/skywinder/web3swift/issues?q=is:issue+is:open+sort:updated-desc "").
+
+> If you want to make something completely new and purely magical, please drop us a message somewhere before, since it could ends up that this is what we planning to do a lot later or that we not planning at all.
+
+## Codestyle guideline
+- `swiftlint` check should goes with no warnings.
+- Here’s some more detailed and human readable code style [guidelines](https://hackmd.io/8bACoAnTSsKc55Os596yCg "") (you can add there some suggestion if you’d like to). 
+- We use [swift](https://www.swift.org/documentation/api-design-guidelines/ "") name convention.
+## Tests guideline
+1. Cover each new public method with tests.
+2. If you’re implementing some big feature encapsulate it in Separate file.
+3. Choose one of the two directory to add test case:
+	* `localTests` — tests which could be ran without needing to connecting to real Ethereum network.
+	* `remoteTests` — tests which needing connection to real Ethereum network to be ran.
+4. Exclude added file from opposite `*.xctestplan` file (e.g. if you’re adding file to `localTests` please exclude it from `RemoteTests.xctestplan`.
+5. Add test file to `web3swift.xcodeproj` to make it working within Carthage building system.
+
+## Hacks & tricks & magic
+### TestPlans
+In ci/cd we’re using Xcode test plans feature to spread tests to local and remote one. So any time you’re adding any new test suit (file) please exclude it from `LocalTests.xctestplan` rather `RemoteTests.xctestplan` depends on what tests group it included.
+### Swift package manager
+Please add any files unused due build process to `excludeFiles` array in `Package.swift`.
+### Carthage
+Please do not forget to add & remove all new or dropped files and dependencies in carthage `.xcodeproj` file if you’re working with project anywhere but carthage project.
+### Cocoapods
+Please do not forget to add & remove all dependencies within `web3swift.podspec` file.
+### GitHub actions
+You’re able to use our github actions checks in your fork without needing to make PR to this repo. To get that just add your branch name to the branch list in file on path `.github/actions/ci.yml` to let the magic happening like follow:
+
+```yml
+on:
+  push:
+    branches:
+      - master
+      - develop
+      - hotfix
+      - #YOUR_REPO_NAME#
+```
+
+> Please remove your branch from this list before making PR.
+
+## Good PR checklist
+### Code
+- [ ] All new functionality covered by unit tests.
+- [ ] Ci/cd green.
+- [ ] No redundant files are added (build cache, Xcode breakpoints settings and so on).
+
+### Info
+- [ ] Relative and concrete PR title.
+- [ ] Issue or roadmap goal attached.
+- [ ] PR description filled with detail explanation of what it is and what’s its specific.
+
+### Codestyle
+- [ ] All public method have `///` styled comments.
+- [ ] All magic or nonintuitive internal code parts are clearly explained in inline comments.
+- [ ] `swiftlint` ran have no warnings.
+- [ ] No commented out code lefts in PR.

Package.swift

@@ -1,12 +1,11 @@
-// swift-tools-version:5.4
+// swift-tools-version: 5.4
 // The swift-tools-version declares the minimum version of Swift required to build this package.
 
 import PackageDescription
 
-
 #if os(macOS)
 let excludeFiles = [
-    "./Browser/BrowserViewController.swift", // Because of inheriting iOS only class failed to build on macOS.
+    "./Browser/BrowserViewController.swift" // Because of inheriting iOS only class failed to build on macOS.
 ]
 #elseif os(iOS)
 let excludeFiles: String = []
@@ -20,7 +19,7 @@ let package = Package(
     products: [
         .library(name: "web3swift", targets: ["web3swift"])
     ],
-    
+
     dependencies: [
         .package(url: "https://github.com/attaswift/BigInt.git", from: "5.3.0"),
         .package(url: "https://github.com/mxcl/PromiseKit.git", from: "6.16.2"),
@@ -60,6 +59,6 @@ let package = Package(
                 .copy("../../../TestToken/Helpers/TokenBasics/IERC20.sol"),
                 .copy("../../../TestToken/Token/Web3SwiftToken.sol")
             ]
-        ),
+        )
     ]
 )

Package@5.0.swift

@@ -1,23 +1,23 @@
-// swift-tools-version:5.0
+// swift-tools-version: 5.0
 // The swift-tools-version declares the minimum version of Swift required to build this package.
 
 import PackageDescription
 
 let package = Package(
     name: "Web3swift",
     platforms: [
-        .macOS(.v10_12), .iOS(.v11),
+        .macOS(.v10_12), .iOS(.v11)
     ],
     products: [
         // Products define the executables and libraries produced by a package, and make them visible to other packages.
         .library(name: "web3swift", targets: ["web3swift"]),
     ],
-    
+
     dependencies: [
         .package(url: "https://github.com/attaswift/BigInt.git", from: "5.3.0"),
         .package(url: "https://github.com/mxcl/PromiseKit.git", from: "6.15.4"),
         .package(url: "https://github.com/daltoniam/Starscream.git", from: "4.0.4"),
-        .package(url: "https://github.com/krzyzanowskim/CryptoSwift.git", from: "1.4.2"),
+        .package(url: "https://github.com/krzyzanowskim/CryptoSwift.git", from: "1.4.2")
     ],
     targets: [
         // Targets are the basic building blocks of a package. A target can define a module or a test suite.
@@ -30,6 +30,6 @@ let package = Package(
             ]),
         .testTarget(
             name: "web3swiftTests",
-            dependencies: ["web3swift"]),
+            dependencies: ["web3swift"])
     ]
 )