Merge pull request #168 from ERC725Alliance/develop

chore: release 3.2.0

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

@@ -26,22 +26,19 @@ jobs:
           cache: "npm"
           cache-dependency-path: implementations/package-lock.json
 
-      - name: Install Truffle
-        run: npm install truffle -g
-
       - name: Install dependencies
-        run: npm install
+        run: npm ci
 
       - name: Run Solhint Linter
         run: npm run lint
 
       - name: Compile contracts
-        run: truffle compile --all
+        run: npm run build --if-present
 
-      - name: Run Tests (with Solidity coverage)
+      - name: Run Tests (with coverage)
         run: npm run test:coverage
 
-      - name: Coverall
+      - name: Upload to Coveralls
         uses: coverallsapp/github-action@master
         with:
           path-to-lcov: ./implementations/coverage/lcov.info

.github/workflows/npm-release.yml

@@ -61,16 +61,16 @@ jobs:
       # step 3: install npm dependencies
       - name: 🧰 Install dependencies
         if: env.SHOULD_RELEASE == 'true'
-        run: npm install -g truffle && npm ci
+        run: npm ci
 
       # Step 4: compile + test the contracts.
       - name: 🛠 Build
         if: env.SHOULD_RELEASE == 'true'
-        run: truffle compile --all
+        run: npm run build --if-present
 
       - name: 🧪 Test
         if: env.SHOULD_RELEASE == 'true'
-        run: npm test
+        run: npm run test
 
       # step 5: create a new release on Github
       # 5.1) create + push a git tag
@@ -110,10 +110,8 @@ jobs:
       # step 6: publish to NPM
       - name: 📦 Publish to NPM
         if: env.SHOULD_RELEASE == 'true'
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-        # minify the npm package with custom node.js minifier script
-        # before to publish on NPM
         run: |
           npm run package
           npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

README.md

@@ -1,4 +1,4 @@
-# ERC 725 · [![npm version](https://img.shields.io/npm/v/@erc725/smart-contracts.svg?style=flat)](https://www.npmjs.com/package/@erc725/smart-contracts) [![Coverage Status](https://coveralls.io/repos/github/ERC725Alliance/ERC725/badge.svg?branch=main)](https://coveralls.io/github/ERC725Alliance/ERC725?branch=main)
+# ERC 725 · [![npm version](https://img.shields.io/npm/v/@erc725/smart-contracts.svg?style=flat)](https://www.npmjs.com/package/@erc725/smart-contracts) [![Coverage Status](https://coveralls.io/repos/github/ERC725Alliance/ERC725/badge.svg?branch=develop)](https://coveralls.io/github/ERC725Alliance/ERC725?branch=develop)
 
 Repository for the code and standard documents around ERC725 and related standards
 

docs/ERC-725.md

@@ -35,7 +35,7 @@ Smart contact based accounts following this standard have the following advantag
 - can hold any asset (native token, e.g. ERC20 like tokens)
 - can execute any smart contract and deploy smart contracts
 - have upgradeable security (through owner change, e.g. to a gnosis safe)
-- are basic enough to work for for a long time
+- are basic enough to work for a long time
 - are extensible though additional standardisation of the key/value data.
 - can function as an owner/controller or proxy of other smart contracts
 

implementations/.gitignore

@@ -1,6 +1,16 @@
-build
-artifacts
 node_modules
+.env
+coverage
+coverage.json
+typechain
+typechain-types
+types
+
+#Hardhat files
+cache
+artifacts
+
+build
 solc
 coverage
 

implementations/.prettierrc

@@ -9,6 +9,14 @@
         "trailingComma": "all",
         "singleQuote": true
       }
+    },
+    {
+      "files": "*.sol",
+      "options": {
+        "tabWidth": 4,
+        "printWidth": 100,
+        "compiler": "0.8.10"
+      }
     }
   ]
 }

implementations/.solcover.js

@@ -0,0 +1,3 @@
+module.exports = {
+    skipFiles: ['helpers']
+  };

implementations/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 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.
 
+## [3.2.0](https://github.com/ERC725Alliance/ERC725/compare/v3.1.0...v3.2.0) (2022-09-01)
+
+### ⚠ BREAKING CHANGES
+
+- add `bytes dataValue` parameter to `DataChanged` event in ERC725Y (#163)
+- removed custom `Initializable` contract (#150)
+- removed `GasLib` library in favour of `internal uncheckedIncrement(...)` function (#160)
+
+### Features
+
+- add `bytes dataValue` parameter to `DataChanged` event in ERC725Y ([#163](https://github.com/ERC725Alliance/ERC725/issues/163)) ([9f88ee0](https://github.com/ERC725Alliance/ERC725/commit/9f88ee0a40fe9eaa197ac946cf92e43b313e3c5f))
+
+### Bug Fixes
+
+- [QSP-4] prevent `address(0)` to be set as contract owner on deployment ([#159](https://github.com/ERC725Alliance/ERC725/issues/159)) ([5c47854](https://github.com/ERC725Alliance/ERC725/commit/5c4785426508b68623c3f217111822f7377076bd))
+
 ## [3.1.2](https://github.com/ERC725Alliance/ERC725/compare/v3.1.0...v3.1.2) (2022-07-08)
 
 This patch release introduces the important bug fixes, as well as some minor optimizations.

implementations/README.md

@@ -1,4 +1,4 @@
-# @erc725/smart-contracts · [![npm version](https://img.shields.io/npm/v/@erc725/smart-contracts.svg?style=flat)](https://www.npmjs.com/package/@erc725/smart-contracts)
+# @erc725/smart-contracts · [![npm version](https://img.shields.io/npm/v/@erc725/smart-contracts.svg?style=flat)](https://www.npmjs.com/package/@erc725/smart-contracts) [![Coverage Status](https://coveralls.io/repos/github/ERC725Alliance/ERC725/badge.svg?branch=develop)](https://coveralls.io/github/ERC725Alliance/ERC725?branch=develop)
 
 
 **This package is currently in BETA, use with caution!**

implementations/solc.sh → implementations/analyse.sh

@@ -1,8 +1,9 @@
-rm -R ./solc/**/*
-solc --asm @openzeppelin/="$(pwd)"/node_modules/@openzeppelin/ solidity-bytes-utils/="$(pwd)"/node_modules/solidity-bytes-utils/ ../Utils="$(pwd)/contracts/Utils" contracts/ERC725.sol -o ./solc/evm/
-solc --storage-layout @openzeppelin/="$(pwd)"/node_modules/@openzeppelin/ solidity-bytes-utils/="$(pwd)"/node_modules/solidity-bytes-utils/ ../Utils="$(pwd)/contracts/Utils" contracts/ERC725.sol -o ./solc/storage-layout/ --pretty-json
-solc --opcodes @openzeppelin/="$(pwd)"/node_modules/@openzeppelin/ solidity-bytes-utils/="$(pwd)"/node_modules/solidity-bytes-utils/ ../Utils="$(pwd)/contracts/Utils" contracts/ERC725.sol -o ./solc/opcodes/
-solc --hashes @openzeppelin/="$(pwd)"/node_modules/@openzeppelin/ solidity-bytes-utils/="$(pwd)"/node_modules/solidity-bytes-utils/ ../Utils="$(pwd)/contracts/Utils" contracts/ERC725.sol -o ./solc/selectors/
-solc --gas @openzeppelin/="$(pwd)"/node_modules/@openzeppelin/ solidity-bytes-utils/="$(pwd)"/node_modules/solidity-bytes-utils/ ../Utils="$(pwd)/contracts/Utils" contracts/ERC725.sol >> ./solc/gas-costs.md
-solc --bin @openzeppelin/="$(pwd)"/node_modules/@openzeppelin/ solidity-bytes-utils/="$(pwd)"/node_modules/solidity-bytes-utils/ ../Utils="$(pwd)/contracts/Utils" contracts/ERC725.sol -o ./solc/bytecode/
-solc --metadata @openzeppelin/="$(pwd)"/node_modules/@openzeppelin/ solidity-bytes-utils/="$(pwd)"/node_modules/solidity-bytes-utils/ ../Utils="$(pwd)/contracts/Utils" contracts/ERC725.sol -o ./solc/metadata/
+solc --storage-layout @openzeppelin/="$(pwd)"/node_modules/@openzeppelin/ solidity-bytes-utils/="$(pwd)"/node_modules/solidity-bytes-utils/ ../Utils="$(pwd)/contracts/Utils" contracts/ERC725.sol -o ./analyse/storage-layout/ --pretty-json --overwrite
+solc --hashes @openzeppelin/="$(pwd)"/node_modules/@openzeppelin/ solidity-bytes-utils/="$(pwd)"/node_modules/solidity-bytes-utils/ ../Utils="$(pwd)/contracts/Utils" contracts/ERC725.sol -o ./analyse/selectors/ --overwrite
+solc --gas @openzeppelin/="$(pwd)"/node_modules/@openzeppelin/ solidity-bytes-utils/="$(pwd)"/node_modules/solidity-bytes-utils/ ../Utils="$(pwd)/contracts/Utils" contracts/ERC725.sol >> ./analyse/gas-costs.md --overwrite
+solc --metadata @openzeppelin/="$(pwd)"/node_modules/@openzeppelin/ solidity-bytes-utils/="$(pwd)"/node_modules/solidity-bytes-utils/ ../Utils="$(pwd)/contracts/Utils" contracts/ERC725.sol -o ./analyse/metadata/ --overwrite
+solc --asm @openzeppelin/="$(pwd)"/node_modules/@openzeppelin/ solidity-bytes-utils/="$(pwd)"/node_modules/solidity-bytes-utils/ ../Utils="$(pwd)/contracts/Utils" contracts/ERC725.sol -o ./analyse/evm/ --overwrite
+solc --asm-json @openzeppelin/="$(pwd)"/node_modules/@openzeppelin/ solidity-bytes-utils/="$(pwd)"/node_modules/solidity-bytes-utils/ ../Utils="$(pwd)/contracts/Utils" contracts/ERC725.sol -o ./analyse/evm-json/ --pretty-json --overwrite
+solc --opcodes @openzeppelin/="$(pwd)"/node_modules/@openzeppelin/ solidity-bytes-utils/="$(pwd)"/node_modules/solidity-bytes-utils/ ../Utils="$(pwd)/contracts/Utils" contracts/ERC725.sol -o ./analyse/opcodes/ --overwrite
+solc --ir @openzeppelin/="$(pwd)"/node_modules/@openzeppelin/ solidity-bytes-utils/="$(pwd)"/node_modules/solidity-bytes-utils/ ../Utils="$(pwd)/contracts/Utils" contracts/ERC725.sol -o ./analyse/ir/ --overwrite
+solc --bin @openzeppelin/="$(pwd)"/node_modules/@openzeppelin/ solidity-bytes-utils/="$(pwd)"/node_modules/solidity-bytes-utils/ ../Utils="$(pwd)/contracts/Utils" contracts/ERC725.sol -o ./analyse/bytecode/ --overwrite