Merge master into dev

.github/workflows/ci.yml

@@ -0,0 +1,31 @@
+name: Truffle CI
+
+on:
+  push:
+    branches: [dev, master, main]
+  pull_request:
+    branches: [dev, master, main]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup NodeJS 16
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16.17.0
+
+      - name: Show NodeJS version
+        run: npm --version
+
+      - name: Checkout submodules
+        run: git submodule update --init --recursive
+
+      - name: Install Project Dependencies
+        run: npm install
+
+      - name: Run Truffle Test
+        run: npx truffle test

.nvmrc

@@ -0,0 +1 @@
+v16.17.0

CHANGELOG.md

@@ -2,9 +2,17 @@
 
 Please follow <https://changelog.md/> conventions.
 
-## 2.3
+## 2.3.0 - 20230609
 
-The release 2.3 contains mainly the different fixes and improvements related to the audit performed on the version 2.2.
+- Add Truffle CI workflow (Contributor: [diego-G](https://github.com/diego-G) / [21.co](https://github.com/amun))
+- Add Truffle plugin [eth-gas-reporter](https://github.com/cgewecke/eth-gas-reporter)
+- Add security policy
+
+## 2.3.0-rc.0 - 20230515
+
+> The release 2.3-rc.0 is a *release candidate* before performing an official release 2.3
+
+The release 2.3-rc.0 contains mainly the different fixes and improvements related to the audit performed on the version 2.2.
 
 **Documentation**
 

README.md

@@ -1,4 +1,5 @@
 # CMTA Token 
+> To use the CMTAT, we recommend the latest audited version, from the [Releases](https://github.com/CMTA/CMTAT/releases) page. Currently, it is the version [v2.3.0](https://github.com/CMTA/CMTAT/releases/tag/v2.3.0)
 
 ## Introduction
 
@@ -28,8 +29,6 @@ order to support:
 This reference implementation allows the issuance and management of tokens representing equity securities.
 It can however also be used for other forms of financial instruments such as debt securities.
 
-To use the CMTAT, we recommend that you use the latest audited version, from the [Releases](https://github.com/CMTA/CMTAT/releases) page.
-
 You may modify the token code by adding, removing, or modifying features. However, the mandatory modules must remain in place for compliance with Swiss law.
 
 ### Deployment model 
@@ -148,7 +147,7 @@ The second audit covered version [2.2](https://github.com/CMTA/CMTAT/releases/ta
 
 Version 2.3 contains the different fixes and improvements related to this audit.
 
-The list if findings is documented in [Taurus. Audit 3.1. Collected Issues.ods](doc/audits/Taurus.Audit3.1.CollectedIssues.ods). 
+The report is available in [ABDK_CMTA_CMTATRuleEngine_v_1_0.pdf](doc/audits/ABDK_CMTA_CMTATRuleEngine_v_1_0.pdf). 
 
 ### Tools
 

doc/USAGE.md

@@ -8,7 +8,7 @@ The toolchain includes the following components, where the versions
 are the latest ones that we tested: 
 
 - npm 8.19.2
-- Truffle 5.8.3
+- Truffle 5.9.3
 - Solidity 0.8.17 (via solc-js)
 - Node 16.17.0
 - Web3.js 1.9.0
@@ -18,12 +18,20 @@ Although present in the dependencies, Hardhat is not included in the toolchain s
 
 ## Installation
 
+- Clone the repository
+
 Clone the git repository, with the option `--recurse-submodules` to fetch the submodules:
 
 `git clone git@github.com:CMTA/CMTAT.git  --recurse-submodules`  
 
+- Node.js version
+
 We recommend to install the [Node Version Manager `nvm`](https://github.com/nvm-sh/nvm) to manage multiple versions of Node.js on your machine. You can then, for example, install the version 16.17.0 of Node.js with the following command: `nvm install 16.17.0`
 
+The file [.nvmrc](../.nvmrc) at the root of the project set the Node.js version. `nvm use`will automatically use this version if no version is supplied on the command line.
+
+- node modules
+
 To install the node modules required by CMTAT, run the following command at the root of the project:
 
 `npm install`

migrations/1_deploy_contracts.js

@@ -0,0 +1,30 @@
+require('dotenv').config()
+
+const CMTAT_PROXY = artifacts.require("CMTAT_PROXY")
+const { deployProxy } = require("@openzeppelin/truffle-upgrades")
+const { Address } = require("ethereumjs-util")
+
+module.exports = async function (deployer, _network, account) {
+	const admin = process.env.ADMIN_ADDRESS ? process.env.ADMIN_ADDRESS : account[0]
+	const flag = 0
+	const ZERO_ADDRESS = Address.zero().toString()
+	const proxyContract = await deployProxy(
+		CMTAT_PROXY,
+		[
+			admin,
+			"Test CMTA Token",
+			"TCMTAT",
+			"TCMTAT_ISIN",
+			"https://cmta.ch",
+			ZERO_ADDRESS,
+			"TCMTAT_info",
+			flag,
+		],
+		{
+			deployer,
+			constructorArgs: [ZERO_ADDRESS]
+		}
+	);
+	await CMTAT_PROXY.deployed()
+	console.log("Proxy deployed at: ", proxyContract.address)
+}