Clean up tests + update doc

.gitignore

@@ -9,6 +9,7 @@ bin/*
 .vscode/
 #PlantUML
 out
+docOut
 #drawio
 *.bkp
 *.dtmp
@@ -17,4 +18,4 @@ cache
 #manticore
 mcore_*
 #secrets
-.env
+.env

CHANGELOG.md

@@ -2,6 +2,15 @@
 
 Please follow <https://changelog.md/> conventions.
 
+## 2.4.0
+
+The modifications between the version v2.3.0 and this version are not audited !!!
+
+- Improve tests & update the code
+- `ERC20SnapshotInternal` inherits from `ICMTATSnapshot`
+
+
+
 ## 2.4.0-rc.1 - 20240319
 
 The modifications between the version v2.3.0 and this version are not audited !!!

doc/schema/surya_report/surya_report_ERC20BaseModule.sol.md

@@ -20,6 +20,7 @@
 | └ | decimals | Public ❗️ |   |NO❗️ |
 | └ | transferBatch | Public ❗️ | 🛑  |NO❗️ |
 | └ | transferFrom | Public ❗️ | 🛑  |NO❗️ |
+| └ | balanceInfo | Public ❗️ |   |NO❗️ |
 
 
 ### Legend

doc/schema/surya_report/surya_report_ERC20SnapshotModuleInternal.sol.md

@@ -15,14 +15,16 @@
 |:----------:|:-------------------:|:----------------:|:----------------:|:---------------:|
 |     └      |  **Function Name**  |  **Visibility**  |  **Mutability**  |  **Modifiers**  |
 ||||||
-| **ERC20SnapshotModuleInternal** | Implementation | SnapshotModuleBase, ERC20Upgradeable |||
+| **ERC20SnapshotModuleInternal** | Implementation | ICMTATSnapshot, SnapshotModuleBase, ERC20Upgradeable |||
 | └ | __ERC20Snapshot_init_unchained | Internal 🔒 | 🛑  | onlyInitializing |
+| └ | snapshotInfo | Public ❗️ |   |NO❗️ |
+| └ | snapshotInfoBatch | Public ❗️ |   |NO❗️ |
+| └ | snapshotInfoBatch | Public ❗️ |   |NO❗️ |
+| └ | snapshotBalanceOf | Public ❗️ |   |NO❗️ |
+| └ | snapshotTotalSupply | Public ❗️ |   |NO❗️ |
 | └ | _snapshotUpdate | Internal 🔒 | 🛑  | |
 | └ | _updateAccountSnapshot | Private 🔐 | 🛑  | |
 | └ | _updateTotalSupplySnapshot | Private 🔐 | 🛑  | |
-| └ | getSnapshotInfoBatch | Public ❗️ |   |NO❗️ |
-| └ | snapshotBalanceOf | Public ❗️ |   |NO❗️ |
-| └ | snapshotTotalSupply | Public ❗️ |   |NO❗️ |
 
 
 ### Legend

doc/schema/surya_report/surya_report_FactoryErrors.sol.md

@@ -0,0 +1,26 @@
+## Sūrya's Description Report
+
+### Files Description Table
+
+
+|  File Name  |  SHA-1 Hash  |
+|-------------|--------------|
+| ./libraries/FactoryErrors.sol | [object Promise] |
+
+
+### Contracts Description Table
+
+
+|  Contract  |         Type        |       Bases      |                  |                 |
+|:----------:|:-------------------:|:----------------:|:----------------:|:---------------:|
+|     └      |  **Function Name**  |  **Visibility**  |  **Mutability**  |  **Modifiers**  |
+||||||
+| **FactoryErrors** | Library |  |||
+
+
+### Legend
+
+|  Symbol  |  Meaning  |
+|:--------:|-----------|
+|    🛑    | Function can modify state |
+|    💵    | Function is payable |

doc/schema/surya_report/surya_report_ICMTATSnapshot.sol.md

@@ -0,0 +1,31 @@
+## Sūrya's Description Report
+
+### Files Description Table
+
+
+|  File Name  |  SHA-1 Hash  |
+|-------------|--------------|
+| ./interfaces/ICMTATSnapshot.sol | [object Promise] |
+
+
+### Contracts Description Table
+
+
+|  Contract  |         Type        |       Bases      |                  |                 |
+|:----------:|:-------------------:|:----------------:|:----------------:|:---------------:|
+|     └      |  **Function Name**  |  **Visibility**  |  **Mutability**  |  **Modifiers**  |
+||||||
+| **ICMTATSnapshot** | Interface |  |||
+| └ | snapshotBalanceOf | External ❗️ |   |NO❗️ |
+| └ | snapshotTotalSupply | External ❗️ |   |NO❗️ |
+| └ | snapshotInfo | External ❗️ |   |NO❗️ |
+| └ | snapshotInfoBatch | External ❗️ |   |NO❗️ |
+| └ | snapshotInfoBatch | External ❗️ |   |NO❗️ |
+
+
+### Legend
+
+|  Symbol  |  Meaning  |
+|:--------:|-----------|
+|    🛑    | Function can modify state |
+|    💵    | Function is payable |

doc/schema/surya_report/surya_report_SnapshotModuleBase.sol.md

@@ -17,13 +17,13 @@
 ||||||
 | **SnapshotModuleBase** | Implementation | Initializable |||
 | └ | __SnapshotModuleBase_init_unchained | Internal 🔒 | 🛑  | onlyInitializing |
+| └ | getAllSnapshots | Public ❗️ |   |NO❗️ |
+| └ | getNextSnapshots | Public ❗️ |   |NO❗️ |
 | └ | _scheduleSnapshot | Internal 🔒 | 🛑  | |
 | └ | _scheduleSnapshotNotOptimized | Internal 🔒 | 🛑  | |
 | └ | _rescheduleSnapshot | Internal 🔒 | 🛑  | |
 | └ | _unscheduleLastSnapshot | Internal 🔒 | 🛑  | |
 | └ | _unscheduleSnapshotNotOptimized | Internal 🔒 | 🛑  | |
-| └ | getNextSnapshots | Public ❗️ |   |NO❗️ |
-| └ | getAllSnapshots | Public ❗️ |   |NO❗️ |
 | └ | _valueAt | Internal 🔒 |   | |
 | └ | _updateSnapshot | Internal 🔒 | 🛑  | |
 | └ | _setCurrentSnapshot | Internal 🔒 | 🛑  | |

doc/schema/surya_report/surya_report_ValidationModule.sol.md

@@ -18,10 +18,10 @@
 | **ValidationModule** | Implementation | ValidationModuleInternal, PauseModule, EnforcementModule, IERC1404Wrapper |||
 | └ | __ValidationModule_init_unchained | Internal 🔒 | 🛑  | onlyInitializing |
 | └ | setRuleEngine | External ❗️ | 🛑  | onlyRole |
-| └ | detectTransferRestriction | Public ❗️ |   |NO❗️ |
 | └ | messageForTransferRestriction | External ❗️ |   |NO❗️ |
-| └ | validateTransferByModule | Internal 🔒 |   | |
+| └ | detectTransferRestriction | Public ❗️ |   |NO❗️ |
 | └ | validateTransfer | Public ❗️ |   |NO❗️ |
+| └ | _validateTransferByModule | Internal 🔒 |   | |
 | └ | _operateOnTransfer | Internal 🔒 | 🛑  | |
 
 

doc/schema/surya_report/surya_report_draft-IERC1404EnumCode.sol.md

@@ -0,0 +1,26 @@
+## Sūrya's Description Report
+
+### Files Description Table
+
+
+|  File Name  |  SHA-1 Hash  |
+|-------------|--------------|
+| ./interfaces/draft-IERC1404/draft-IERC1404EnumCode.sol | [object Promise] |
+
+
+### Contracts Description Table
+
+
+|  Contract  |         Type        |       Bases      |                  |                 |
+|:----------:|:-------------------:|:----------------:|:----------------:|:---------------:|
+|     └      |  **Function Name**  |  **Visibility**  |  **Mutability**  |  **Modifiers**  |
+||||||
+| **IERC1404EnumCode** | Interface |  |||
+
+
+### Legend
+
+|  Symbol  |  Meaning  |
+|:--------:|-----------|
+|    🛑    | Function can modify state |
+|    💵    | Function is payable |

doc/schema/surya_report/surya_report_draft-IERC1404Wrapper.sol.md

@@ -15,7 +15,7 @@
 |:----------:|:-------------------:|:----------------:|:----------------:|:---------------:|
 |     └      |  **Function Name**  |  **Visibility**  |  **Mutability**  |  **Modifiers**  |
 ||||||
-| **IERC1404Wrapper** | Interface | IERC1404 |||
+| **IERC1404Wrapper** | Interface | IERC1404, IERC1404EnumCode |||
 | └ | validateTransfer | External ❗️ |   |NO❗️ |
 
 

doc/script/script_surya_graph.sh

@@ -1,9 +1,9 @@
 #/bin/bash
 cd '../../'
 DIR=$(pwd)
-DIR_OUT=${DIR}/out/surya_graph
+DIR_OUT=${DIR}/docOut/surya_graph
 if ! [ -d "$DIR_OUT" ]; then
-    mkdir -p ./out/surya_graph
+    mkdir -p ./docOut/surya_graph
 fi
 cd './contracts'
 DIR=$(pwd)
@@ -13,6 +13,6 @@ do
     filename=${i##*/}
     ext=${i##*.}
     if [[ $ext == 'sol' ]]; then
-        npx surya graph $i | dot -Tpng > ../out/surya_graph/surya_graph_$filename.png;
+        npx surya graph $i | dot -Tpng > ../docOut/surya_graph/surya_graph_$filename.png;
     fi
 done;

doc/script/script_surya_inheritance.sh

@@ -1,9 +1,9 @@
 #/bin/bash
 cd '../../'
 DIR=$(pwd)
-DIR_OUT=${DIR}/out/inheritance
+DIR_OUT=${DIR}/docOut/inheritance
 if ! [ -d "$DIR_OUT" ]; then
-    mkdir -p ./out/surya_inheritance
+    mkdir -p ./docOut/surya_inheritance
 fi
 cd './contracts'
 DIR=$(pwd)
@@ -12,6 +12,6 @@ do
     filename=${i##*/}
     ext=${i##*.}
     if [[ $ext == 'sol' ]]; then
-        npx surya inheritance $i | dot -Tpng > ../out/surya_inheritance/surya_inheritance_$filename.png;
+        npx surya inheritance $i | dot -Tpng > ../docOut/surya_inheritance/surya_inheritance_$filename.png;
     fi
 done;

doc/script/script_surya_report.sh

@@ -1,9 +1,9 @@
 #/bin/bash
 cd '../../'
 DIR=$(pwd)
-DIR_OUT=${DIR}/out/surya_report
+DIR_OUT=${DIR}/docOut/surya_report
 if ! [ -d "$DIR_OUT" ]; then
-    mkdir ./out/surya_report
+    mkdir ./docOut/surya_report
 fi
 cd './contracts'
 DIR=$(pwd)
@@ -12,6 +12,6 @@ do
     filename=${i##*/}
     ext=${i##*.}
     if [[ $ext == 'sol' ]]; then
-        npx surya mdreport ../out/surya_report/surya_report_$filename.md $i;
+        npx surya mdreport ../docOut/surya_report/surya_report_$filename.md $i;
     fi
 done;

test/proxy/general/UpgradeProxy.test.js

@@ -2,7 +2,6 @@ const { BN } = require('@openzeppelin/test-helpers')
 const { should } = require('chai').should()
 const { ZERO_ADDRESS } = require('../../utils')
 const {
-  deployCMTATProxy,
   DEPLOYMENT_FLAG,
   DEPLOYMENT_DECIMAL
 } = require('../../deploymentUtils')

test/proxy/general/Beacon.test.js → test/proxy/general/factory/Beacon.test.js

@@ -2,19 +2,18 @@ const CMTAT_BEACON_FACTORY = artifacts.require('CMTAT_BEACON_FACTORY')
 const { should } = require('chai').should()
 const {
   expectRevertCustomError
-} = require('../../../openzeppelin-contracts-upgradeable/test/helpers/customError.js')
+} = require('../../../../openzeppelin-contracts-upgradeable/test/helpers/customError.js')
 const CMTAT = artifacts.require('CMTAT_PROXY')
-const { DEFAULT_ADMIN_ROLE, CMTAT_DEPLOYER_ROLE } = require('../../utils')
-const { ZERO_ADDRESS } = require('../../utils')
+const { CMTAT_DEPLOYER_ROLE } = require('../../../utils.js')
+const { ZERO_ADDRESS } = require('../../../utils.js')
 const {
   DEPLOYMENT_FLAG,
   deployCMTATProxyImplementation
-} = require('../../deploymentUtils')
-const { upgrades } = require('hardhat')
+} = require('../../../deploymentUtils.js')
 const DEPLOYMENT_DECIMAL = 0
 const { BN, expectEvent } = require('@openzeppelin/test-helpers')
 contract(
-  'Proxy - Security Test',
+  'Deploy Beacon with Factory',
   function ([_, admin, attacker, deployerAddress]) {
     beforeEach(async function () {
       this.CMTAT_PROXY_IMPL = await deployCMTATProxyImplementation(

test/proxy/general/BeaconFactoryDeploy.test copy.js → test/proxy/general/factory/BeaconFactoryDeploy.test copy.js

@@ -2,17 +2,11 @@ const CMTAT_BEACON_FACTORY = artifacts.require('CMTAT_BEACON_FACTORY')
 const { should } = require('chai').should()
 const {
   expectRevertCustomError
-} = require('../../../openzeppelin-contracts-upgradeable/test/helpers/customError.js')
-const CMTAT = artifacts.require('CMTAT_PROXY')
-const { DEFAULT_ADMIN_ROLE, CMTAT_DEPLOYER_ROLE } = require('../../utils.js')
-const { ZERO_ADDRESS } = require('../../utils.js')
+} = require('../../../../openzeppelin-contracts-upgradeable/test/helpers/customError.js')
+const { ZERO_ADDRESS } = require('../../../utils.js')
 const {
-  DEPLOYMENT_FLAG,
   deployCMTATProxyImplementation
-} = require('../../deploymentUtils.js')
-const { upgrades } = require('hardhat')
-const DEPLOYMENT_DECIMAL = 0
-const { BN, expectEvent } = require('@openzeppelin/test-helpers')
+} = require('../../../deploymentUtils.js')
 contract(
   'Deploy Beacon with Factory',
   function ([_, admin, attacker, deployerAddress]) {

test/proxy/general/Transparent.test.js → test/proxy/general/factory/Transparent.test.js

@@ -2,20 +2,13 @@ const CMTAT_TP_FACTORY = artifacts.require('CMTAT_TP_FACTORY')
 const { should } = require('chai').should()
 const {
   expectRevertCustomError
-} = require('../../../openzeppelin-contracts-upgradeable/test/helpers/customError.js')
+} = require('../../../../openzeppelin-contracts-upgradeable/test/helpers/customError.js')
 const CMTAT = artifacts.require('CMTAT_PROXY')
+const { ZERO_ADDRESS, CMTAT_DEPLOYER_ROLE } = require('../../../utils.js')
 const {
-  DEFAULT_ADMIN_ROLE,
-  PAUSER_ROLE,
-  CMTAT_DEPLOYER_ROLE
-} = require('../../utils.js')
-const { ZERO_ADDRESS } = require('../../utils.js')
-const DECIMAL = 0
-const {
-  deployCMTATProxy,
   DEPLOYMENT_FLAG,
   deployCMTATProxyImplementation
-} = require('../../deploymentUtils.js')
+} = require('../../../deploymentUtils.js')
 const { upgrades } = require('hardhat')
 const DEPLOYMENT_DECIMAL = 0
 const { BN, expectEvent } = require('@openzeppelin/test-helpers')

test/proxy/general/TransparentFactoyDeploy.test.js → test/proxy/general/factory/TransparentFactoyDeploy.test.js

@@ -2,23 +2,11 @@ const CMTAT_TP_FACTORY = artifacts.require('CMTAT_TP_FACTORY')
 const { should } = require('chai').should()
 const {
   expectRevertCustomError
-} = require('../../../openzeppelin-contracts-upgradeable/test/helpers/customError.js')
-const CMTAT = artifacts.require('CMTAT_PROXY')
+} = require('../../../../openzeppelin-contracts-upgradeable/test/helpers/customError.js')
+const { ZERO_ADDRESS } = require('../../../utils.js')
 const {
-  DEFAULT_ADMIN_ROLE,
-  PAUSER_ROLE,
-  CMTAT_DEPLOYER_ROLE
-} = require('../../utils.js')
-const { ZERO_ADDRESS } = require('../../utils.js')
-const DECIMAL = 0
-const {
-  deployCMTATProxy,
-  DEPLOYMENT_FLAG,
   deployCMTATProxyImplementation
-} = require('../../deploymentUtils.js')
-const { upgrades } = require('hardhat')
-const DEPLOYMENT_DECIMAL = 0
-const { BN, expectEvent } = require('@openzeppelin/test-helpers')
+} = require('../../../deploymentUtils.js')
 contract(
   'Deploy TP with Factory',
   function ([_, admin, attacker, deployerAddress]) {

test/proxy/modules/ERC20BurnModule.test.js

@@ -2,7 +2,7 @@ const BurnModuleCommon = require('../../common/ERC20BurnModuleCommon')
 const { deployCMTATProxy } = require('../../deploymentUtils')
 
 contract(
-  'Proxy - BurnModule',
+  'Proxy - ERC20BurnModule',
   function ([_, admin, address1, address2, address3, deployerAddress]) {
     beforeEach(async function () {
       this.cmtat = await deployCMTATProxy(_, admin, deployerAddress)

test/proxy/modules/ERC20MintModule.test.js

@@ -2,7 +2,7 @@ const ERC20MintModuleCommon = require('../../common/ERC20MintModuleCommon')
 const { deployCMTATProxy } = require('../../deploymentUtils')
 
 contract(
-  'Proxy - MintModule',
+  'Proxy - ERC20MintModule',
   function ([_, admin, address1, address2, deployerAddress]) {
     beforeEach(async function () {
       this.cmtat = await deployCMTATProxy(_, admin, deployerAddress)

test/proxy/modules/ERC20SnapshotModule.test.js

@@ -8,7 +8,7 @@ const ERC20SnapshotModuleOnePlannedSnapshotTest = require('../../common/ERC20Sna
 const ERC20SnapshotModuleZeroPlannedSnapshotTest = require('../../common/ERC20SnapshotModuleCommon/global/ERC20SnapshotModuleZeroPlannedSnapshot')
 
 contract(
-  'Proxy - SnapshotModule',
+  'Proxy - ERC20SnapshotModule',
   function ([_, admin, address1, address2, address3, deployerAddress]) {
     beforeEach(async function () {
       this.cmtat = await deployCMTATProxyWithSnapshot(

test/standard/modules/ERC20BurnModule.test.js

@@ -1,7 +1,7 @@
 const ERC20BurnModuleCommon = require('../../common/ERC20BurnModuleCommon')
 const { deployCMTATStandalone } = require('../../deploymentUtils')
 contract(
-  'Standard - BurnModule',
+  'Standard - ERC20BurnModule',
   function ([_, admin, address1, address2, address3, deployerAddress]) {
     beforeEach(async function () {
       this.cmtat = await deployCMTATStandalone(_, admin, deployerAddress)

test/standard/modules/ERC20MintModule.test.js

@@ -1,7 +1,7 @@
 const ERC20MintModuleCommon = require('../../common/ERC20MintModuleCommon')
 const { deployCMTATStandalone } = require('../../deploymentUtils')
 contract(
-  'Standard - MintModule',
+  'Standard - ERC20MintModule',
   function ([_, admin, address1, address2, deployerAddress]) {
     beforeEach(async function () {
       this.cmtat = await deployCMTATStandalone(_, admin, deployerAddress)