Merge pull request #618 from lukso-network/develop

* chore: create template

* chore: setup dodoc

* docs: improve some natspec with custom tags

* docs: Improve template for SC ABI generation

Co-authored-by: Jean Cvllr <CJ42@users.noreply.github.com>

docs: update template

docs: update template

* docs: use `@b00ste/hardhat-dodoc` npm package

* docs: check and improve LSP0 core natspec

* chore: format dodoc config

* build: add list of `contract` and `library` to generate docs for

* chore: optimize dodoc config

* chore: update pr template

* chore: add suggested changes

* docs: remove indentation

* chore: fix script in `package.json`

* chore: fix template

* chore: add NatSpec guidelines to `CONTRIBUTING.md`

* chore: update prettier

* docs: update dodoc config

* fix: variable shadowing with `transferOwnership(_pendingOwner)` and `_pendingOwner` state variable

* refactor: initialize local variables to `0` (iterators) and `false`

* chore: format code

* chore: improve readability using number instead of long hex string

* docs: fix duplicate Natspec param for LSP20 error

* chore: fix typescript prettier config

* chore: add sugested changes

* docs: add info block to dodoc template (#615)

* docs: add info block to dodoc template

* chore: update `@b00ste/hardhat-dodoc` package

* ci!: remove android + iOS artifacts from Github release (#617)

* ci!: remove android + iOS artifacts generation from CI

* docs: remove references to Android + iOS artifacts

* chore: remove `scripts/java` paths from gitignore

* chore(release): 0.10.2

* chore: set single quotes for strings in prettier configs  (#619)

* ci: use npm command to check prettier

* build: use `1.1.3` for `prettier-plugin-solidity` + use minor release `^` semver

* style: run prettier to format all string text with single quotes

* build: generate Markdown table with interface IDs (#620)

* refactor!: rename ILSP20 public interface to `ILSP20CallVerifier`

Co-authored-by: Andreas Richter <richtera@users.noreply.github.com>

* docs: document contract interfaces with `@title` tags

* build: add script to generate interfaceIDs table in markdown

* chore: format Markdown in table

* test: fix wrong interface name in tests

---------

Co-authored-by: Andreas Richter <richtera@users.noreply.github.com>

* ci: add ESLint in CI + Fix eslint errors in JS / TS files across repository (#621)

* ci: add ESLint in CI

* chore: fix eslint errors via `eslint . --fix`

* chore: fix eslint errors of unused vars and functions

* refactor!: remove `EIP191Signer.sol` library, replace by function `toDataWithIntendedValidatorHash` from latest OpenZeppelin library (#622)

* build: upgrade OZ package to 4.9.2

* refactor!: remove `EIP191Signer` library to use function from OZ library

* test: remove EIP191SignerTester contracts and tests

* ci: add `--if-present` tag

---------

Co-authored-by: YamenMerhi <yamennmerhi@gmail.com>

* ci: use `hardhat compile` command to generate build (#625)

* chore: apply prettier with new rules (#623)

* build!: uprade `@erc725/smart-contracts` version to 5.1.0 + remove LSP6 function selectors from `LSP6Constants.sol` (#624)

* build: upgrade `@erc725/smart-contracts` package version to `5.1.0`

* refactor!: remove LSP6 functions selector constants and from ERC725

* chore: put back comment for three contracts at the top

---------

Co-authored-by: YamenMerhi <yamennmerhi@gmail.com>

* docs: add additional details in CHANGELOG for 0.10.2 (#626)

---------

Co-authored-by: b00ste <daniel@lukso.io>
Co-authored-by: b00ste.lyx <62855857+b00ste@users.noreply.github.com>
Co-authored-by: Andreas Richter <richtera@users.noreply.github.com>
Co-authored-by: YamenMerhi <yamennmerhi@gmail.com>

.eslintrc.json

@@ -0,0 +1,12 @@
+{
+  "ignorePatterns": ["artifacts/", "cache/", "dist/", "types/", "contracts.ts"],
+  "extends": [
+    "plugin:@typescript-eslint/recommended",
+    "plugin:prettier/recommended"
+  ],
+  "plugins": ["@typescript-eslint/eslint-plugin", "prettier"],
+  "rules": {
+    "prettier/prettier": "error",
+    "@typescript-eslint/no-explicit-any": "off"
+  }
+}

.github/PULL_REQUEST_TEMPLATE.md

@@ -23,7 +23,9 @@
 ## 🤖 CI
 ---->
 
-Fixes #???? <!-- Fill in with issue number -->
+<!---
+Fixes #<Fill in with issue number>
+---->
 
 <!-- Describe the changes introduced in this pull request here. -->
 
@@ -36,8 +38,8 @@ Fixes #???? <!-- Fill in with issue number -->
 <!-- (Some of the items may not apply.) -->
 
 - [ ] Wrote Tests
-- [ ] Wrote Documentation
-- [ ] Ran `npm run linter` (solhint)
+- [ ] Wrote & Generated Documentation (readme/natspec/dodoc)
+- [ ] Ran `npm run lint` && `npm run lint:solidity` (solhint)
 - [ ] Ran `npm run format` (prettier)
 - [ ] Ran `npm run build`
 - [ ] Ran `npm run test`

.github/workflows/benchmark.yml

@@ -34,7 +34,7 @@ jobs:
         run: npm ci
 
       - name: 🏗️ Build contract artifacts
-        run: npm run build --if-present
+        run: npx hardhat compile
 
       - name: 🧪 Run Benchmark tests
         run: npm run test:benchmark

.github/workflows/build-artifacts.yml

@@ -1,4 +1,3 @@
-# This workflow builds Android and iOS SDK artifacts
 name: Build Artifacts
 
 on:
@@ -16,7 +15,7 @@ jobs:
           fetch-depth: 0
 
       - name: Check if version changed
-        uses: EndBug/version-check@v1
+        uses: EndBug/version-check@v2
         id: check
 
       - name: Use Node.js '16.15.0'
@@ -28,38 +27,6 @@ jobs:
       - name: Install Dependencies
         run: npm ci
 
-      # Android artifacts
-      - name: Set up our JDK environment
-        uses: actions/setup-java@v3
-        with:
-          java-version: "11"
-          distribution: "adopt"
-
-      - name: Install Web3j
-        run: curl -L get.web3j.io | sh
-
-      - name: Generate Android artifacts
-        run: npm run build:android
-
-      # iOS artifacts
-      - name: Generate iOS artifacts
-        run: npm run build:ios
-
-      # Upload Artifacts
-      - name: Upload iOS Artifact
-        uses: actions/upload-artifact@v2
-        if: github.event_name == 'push' && steps.check.outputs.changed == 'true'
-        with:
-          name: LSPSmartContracts.swift
-          path: ios/LSPSmartContracts.swift
-
-      - name: Upload Android Artifact
-        uses: actions/upload-artifact@v2
-        if: github.event_name == 'push' && steps.check.outputs.changed == 'true'
-        with:
-          name: lspsmartcontracts.jar
-          path: java/build/libs/lspsmartcontracts.jar
-
       # Trigger Release
       - name: Repository Dispatch
         if: github.event_name == 'push' && steps.check.outputs.changed == 'true'

.github/workflows/build-lint-test.yml

@@ -22,14 +22,14 @@ jobs:
         run: npm ci
 
       - name: 🔍 Run Solidity Linter
-        run: npm run linter
+        run: npm run lint:solidity
 
-      - name: 🎨 Check Prettier Style
-        run: npx prettier --check .
+      - name: 🎨 Run ESLint on JS/TS files
+        run: npm run lint
 
       # This will also generate the Typechain types used by the Chai tests
       - name: 🏗️ Build contract artifacts
-        run: npm run build --if-present
+        run: npx hardhat compile
 
       - name: 📤 cache dependencies + build
         uses: actions/cache@v2

.github/workflows/coverage.yml

@@ -27,7 +27,7 @@ jobs:
 
       # This will also generate the Typechain types used by the Chai tests
       - name: Build contract artifacts
-        run: npm run build --if-present
+        run: npx hardhat compile
 
       - name: Run tests with coverage
         run: npm run test:coverage

.github/workflows/create-github-release.yml

@@ -32,26 +32,6 @@ jobs:
           git tag -a ${{ env.APP_VERSION }} -m "Release Version ${{ env.APP_VERSION }}"
           git push --set-upstream origin develop tag ${{ env.APP_VERSION }}
 
-      - name: Download Android artifact
-        uses: dawidd6/action-download-artifact@v2
-        with:
-          workflow: build-artifacts.yml
-          workflow_conclusion: success
-          name: lspsmartcontracts.jar
-          path: java/build/libs
-          branch: main
-          event: push
-
-      - name: Download iOS artifact
-        uses: dawidd6/action-download-artifact@v2
-        with:
-          workflow: build-artifacts.yml
-          workflow_conclusion: success
-          name: LSPSmartContracts.swift
-          path: ios
-          branch: main
-          event: push
-
       # Create Github Release
       - name: Extract release notes from CHANGELOG
         id: extract-release-notes

.github/workflows/deploy-verify.yml

@@ -28,7 +28,7 @@ jobs:
 
       # This will also generate the Typechain types used by the Chai tests
       - name: Build contract artifacts
-        run: npm run build --if-present
+        run: npx hardhat compile
 
       - name: cache dependencies + build
         uses: actions/cache@v2

.github/workflows/foundry-tests.yml

@@ -24,7 +24,7 @@ jobs:
         run: npm ci
 
       - name: NPM build
-        run: npm run build
+        run: npx hardhat compile
 
       - name: Run Foundry tests
         run: npm run test:foundry

.github/workflows/publish-npm-artifact.yml

@@ -26,7 +26,7 @@ jobs:
       # This will also generate the Typechain types used by the Chai tests
       - name: Build and Test
         run: |
-          npm run build --if-present
+          npx hardhat compile
           npm run test
 
       - name: Publish

.gitignore

@@ -35,14 +35,6 @@ bower_components
 # node-waf configuration
 .lock-wscript
 
-# Generated jar files
-jar/
-src/
-java/
-
-# Generated swift files
-ios/
-
 # Compiled binary addons (https://nodejs.org/api/addons.html)
 build/Release
 
@@ -124,12 +116,6 @@ artifacts
 typechain
 deployments
 
-# JAVA
-scripts/java/github.properties
-scripts/java/.gradle
-scripts/java/.idea
-android/
-
 .idea
 
 # auto-generated docs

.prettierrc

@@ -2,19 +2,20 @@
   "plugins": ["prettier-plugin-solidity"],
   "overrides": [
     {
-      "files": ["*.js", "*.,ts"],
+      "files": ["*.js", "*.ts"],
       "options": {
         "tabWidth": 2,
         "printWidth": 100,
         "trailingComma": "all",
-        "singleQuote": true
+        "singleQuote": true,
+        "semi": true
       }
     },
     {
       "files": "*.sol",
       "options": {
         "tabWidth": 4,
-        "printWidth": 100,
+        "printWidth": 80,
         "compiler": "0.8.15"
       }
     }

CHANGELOG.md

@@ -2,6 +2,23 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [0.10.2](https://github.com/lukso-network/lsp-smart-contracts/compare/v0.10.1...v0.10.2) (2023-06-13)
+
+### Refactor
+
+- remove `EIP191Signer.sol` library, replace by function `toDataWithIntendedValidatorHash` from latest OpenZeppelin library ([#622](https://github.com/lukso-network/lsp-smart-contracts/issues/622)) ([235048d](https://github.com/lukso-network/lsp-smart-contracts/commit/235048d028d9a770cc5fe516ce5bdbeecf9072e2))
+- remove LSP6 function selectors from `LSP6Constants.sol` ([0c2e9c0](https://github.com/lukso-network/lsp-smart-contracts/commit/0c2e9c01cde59c6a76c731e8bf4271425964df6b))
+
+### Build
+
+- upgrade default solc compiler version to 0.8.17 ([#627])(https://github.com/lukso-network/lsp-smart-contracts/issues/627)
+- upgrade `@erc725/smart-contracts` version to 5.1.0 ([#624](https://github.com/lukso-network/lsp-smart-contracts/pull/624))
+- remove android + iOS artifacts from Github release ([#617](https://github.com/lukso-network/lsp-smart-contracts/pull/617))
+
+### Bug Fixes
+
+- variable shadowing with `transferOwnership(_pendingOwner)` and `_pendingOwner` state variable ([7d1b5b8](https://github.com/lukso-network/lsp-smart-contracts/commit/7d1b5b8891ce6dfb970635e420bbf2d6e259d0c1))
+
 ## [0.10.1](https://github.com/lukso-network/lsp-smart-contracts/compare/v0.10.0...v0.10.1) (2023-06-07)
 
 ### Bug Fixes