Integrate Chainlink ACE with CMTAT standard

.github/workflows/ci.yml

@@ -0,0 +1,36 @@
+name: Hardhat CI
+
+on:
+  push:
+    branches: [dev, master, main]
+  pull_request:
+    branches: [dev, master, main]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 #v4.2
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@de808b1eea699e761c404bda44ba8f21aba30b2c #v1.3.1
+        with:
+          version: nightly
+
+      - name: Setup NodeJS 20.5.0
+        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 #v4.4.0
+        with:
+          node-version: 20.5.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 Hardhat Test
+        run: npx hardhat test

.gitignore

@@ -9,6 +9,10 @@ lerna-debug.log*
 # Diagnostic reports (https://nodejs.org/api/report.html)
 report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
 
+# Slither reports (keep directory via .gitkeep)
+reports/*
+!reports/.gitkeep
+
 # Runtime data
 pids
 *.pid
@@ -18,10 +22,6 @@ pids
 # Directory for instrumented libs generated by jscoverage/JSCover
 lib-cov
 
-# Coverage directory used by tools like istanbul
-coverage
-*.lcov
-
 # nyc test coverage
 .nyc_output
 
@@ -41,6 +41,9 @@ build/Release
 node_modules/
 jspm_packages/
 
+# Python virtual environment
+cct/
+
 # Snowpack dependency directory (https://snowpack.dev/)
 web_modules/
 
@@ -137,3 +140,24 @@ dist
 # Vite logs files
 vite.config.js.timestamp-*
 vite.config.ts.timestamp-*
+
+node_modules
+.env
+
+# Hardhat files
+/cache
+/artifacts
+
+# TypeChain files
+/typechain
+/typechain-types
+
+# Hardhat Ignition default folder for deployments against a local node
+ignition/deployments/chain-31337
+
+# Foudry files
+/cache_hardhat
+
+# custom local directory
+history
+.codex

.gitmodules

@@ -1,3 +1,7 @@
-[submodule "CMTAT"]
-	path = CMTAT
+[submodule "submodules/CMTAT"]
+	path = submodules/CMTAT
 	url = https://github.com/CMTA/CMTAT
+	branch = master
+[submodule "submodules/RuleEngine"]
+	path = submodules/RuleEngine
+	url = https://github.com/CMTA/RuleEngine

.prettierignore

@@ -0,0 +1,6 @@
+node_modules/
+submodules/
+artifacts/
+cache_hardhat/
+typechain-types/
+doc/

.prettierrc

@@ -0,0 +1,22 @@
+{
+  "semi": true,
+  "singleQuote": true,
+  "trailingComma": "all",
+  "tabWidth": 2,
+  "printWidth": 100,
+  "plugins": ["prettier-plugin-solidity"],
+  "overrides": [
+    {
+      "files": "*.sol",
+      "options": {
+        "parser": "slang",
+        "printWidth": 120,
+        "tabWidth": 4,
+        "useTabs": false,
+        "singleQuote": false,
+        "bracketSpacing": false,
+        "compiler": "0.8.20"
+      }
+    }
+  ]
+}

.solcover.js

@@ -0,0 +1,13 @@
+const fs = require('fs');
+const path = require('path');
+
+module.exports = {
+  istanbulFolder: 'doc/coverage',
+  skipFiles: ['modules/chainlink-ace/mocks/PolicyProtectedUpgradeableMocks.sol'],
+  onIstanbulComplete: async function () {
+    const rootCoverageJson = path.join(process.cwd(), 'coverage.json');
+    if (fs.existsSync(rootCoverageJson)) {
+      fs.unlinkSync(rootCoverageJson);
+    }
+  },
+};

AGENTS.md

@@ -0,0 +1,30 @@
+# AGENTS Guidelines
+
+## Sync Policy (Mandatory)
+
+- `AGENTS.md` and `CLAUDE.md` must always contain exactly the same content.
+- Any edit to one file must be mirrored in the other file in the same change.
+
+## Testing Policy (Mandatory)
+
+- Always add or update automated tests for every new feature, behavior change, bug fix, or security hardening change.
+- A code change is not complete unless tests validating the change are included in the same PR/commit series.
+- At minimum, include:
+  - positive-path test(s),
+  - negative-path/revert test(s) when applicable,
+  - event assertion(s) when state changes emit events.
+- Run relevant tests locally before finalizing changes. If a full suite cannot be run, clearly state what was run and what was skipped.
+
+## Codebase Summary
+
+- This repository integrates **CMTA CMTAT** token modules with **Chainlink ACE PolicyEngine**.
+- There are two deployment variants:
+  - **Standard**: policy-authoritative access/compliance via ACE (`runPolicy`) with `OwnableUpgradeable`.
+  - **Lite**: keeps CMTAT role-based module access control and uses ACE mainly for transfer validation.
+- Core custom contracts are under:
+  - `contracts/modules/standard/`
+  - `contracts/modules/lite/`
+  - `contracts/modules/chainlink-ace/custom/`
+  - `contracts/modules/chainlink-ace/modified/`
+- Tests are primarily under `test/`, with transfer-policy coverage in `test/custom/transferValidationPolicy.test.js`.
+- External dependencies are vendored as git submodules in `submodules/` (notably `CMTAT`, `chainlink-ace`, and `RuleEngine`).

CHANGELOG.md

@@ -0,0 +1,46 @@
+# CHANGELOG
+
+All notable changes to this project will be documented in this file.
+
+Please follow [https://changelog.md](https://changelog.md) conventions and the other conventions below
+
+## Semantic Version 2.0.0
+
+Given a version number MAJOR.MINOR.PATCH, increment the:
+
+1. MAJOR version when the new version makes:
+   - Incompatible proxy **storage** change internally or through the upgrade of an external library (OpenZeppelin)
+   - A significant change in external APIs (public/external functions) or in the internal architecture
+2. MINOR version when the new version adds functionality in a backward compatible manner
+3. PATCH version when the new version makes backward compatible bug fixes
+
+See [https://semver.org](https://semver.org)
+
+## Type of changes
+
+- `Added` for new features.
+- `Changed` for changes in existing functionality.
+- `Deprecated` for soon-to-be removed features.
+- `Removed` for now removed features.
+- `Fixed` for any bug fixes.
+- `Security` in case of vulnerabilities.
+
+Reference: [keepachangelog.com/en/1.1.0/](https://keepachangelog.com/en/1.1.0/)
+
+Custom changelog tag: `Dependencies`, `Documentation`, `Testing`
+
+## [0.1.0] -
+
+### Added
+
+- Initial release of **CMTAT-ACE**, integrating CMTAT modules with Chainlink ACE PolicyEngine.
+- Two deployment variants:
+  - **Standard**: policy-authoritative access and compliance through ACE `runPolicy`.
+  - **Lite**: CMTAT role-based module access control with ACE-based transfer validation.
+- Core tokenization and compliance modules under:
+  - `contracts/modules/standard/`
+  - `contracts/modules/lite/`
+  - `contracts/modules/chainlink-ace/custom/`
+  - `contracts/modules/chainlink-ace/modified/`
+- Deployment flows for standalone, upgradeable, and UUPS variants.
+- Automated test suite covering deployment, policy integration, and transfer validation behavior.

CLAUDE.md

@@ -0,0 +1,30 @@
+# AGENTS Guidelines
+
+## Sync Policy (Mandatory)
+
+- `AGENTS.md` and `CLAUDE.md` must always contain exactly the same content.
+- Any edit to one file must be mirrored in the other file in the same change.
+
+## Testing Policy (Mandatory)
+
+- Always add or update automated tests for every new feature, behavior change, bug fix, or security hardening change.
+- A code change is not complete unless tests validating the change are included in the same PR/commit series.
+- At minimum, include:
+  - positive-path test(s),
+  - negative-path/revert test(s) when applicable,
+  - event assertion(s) when state changes emit events.
+- Run relevant tests locally before finalizing changes. If a full suite cannot be run, clearly state what was run and what was skipped.
+
+## Codebase Summary
+
+- This repository integrates **CMTA CMTAT** token modules with **Chainlink ACE PolicyEngine**.
+- There are two deployment variants:
+  - **Standard**: policy-authoritative access/compliance via ACE (`runPolicy`) with `OwnableUpgradeable`.
+  - **Lite**: keeps CMTAT role-based module access control and uses ACE mainly for transfer validation.
+- Core custom contracts are under:
+  - `contracts/modules/standard/`
+  - `contracts/modules/lite/`
+  - `contracts/modules/chainlink-ace/custom/`
+  - `contracts/modules/chainlink-ace/modified/`
+- Tests are primarily under `test/`, with transfer-policy coverage in `test/custom/transferValidationPolicy.test.js`.
+- External dependencies are vendored as git submodules in `submodules/` (notably `CMTAT`, `chainlink-ace`, and `RuleEngine`).