Skip to content

Commit dec31b2

Browse files
committed
Update changelog and readme
1 parent b772a0d commit dec31b2

2 files changed

Lines changed: 12 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ Custom changelog tag: `Dependencies`, `Documentation`, `Testing`
5555
- Changed
5656
- Bump `VersionModule.VERSION` and deployment test expectations to `0.4.0`.
5757
- Switch `SnapshotEngine` from OpenZeppelin `AccessControl` to `AccessControlEnumerable`.
58+
- Align `ISnapshotScheduler` license header and pragma with the local interface conventions used across the repository.
5859
- Remove `CMTATBaseSnapshot` support from local `CMTATUpgradeableInternalSnapshot` and `CMTATStandaloneInternalSnapshot` so these deployment variants only support internal snapshots.
5960
- Keep external `SnapshotEngine` support separate from the local CMTAT deployment variants because combining both paths exceeds the EVM contract size limit.
6061
- Rename the local shared CMTAT snapshot base from `CMTATSnapshotBase` to `CMTATInternalSnapshotBase` to avoid confusion with upstream CMTAT snapshot contracts.
@@ -75,11 +76,13 @@ Custom changelog tag: `Dependencies`, `Documentation`, `Testing`
7576
- Update README integration guidance to document the minimal token interface required by SnapshotEngine (`IERC20SnapshotCompatible`).
7677
- Clarify in `README.md` that local `CMTAT*InternalSnapshot` deployment contracts are internal-snapshot-only and that external snapshot-engine-enabled CMTAT deployments should come from the `CMTAT` repository snapshot variants.
7778
- Add a `SnapshotEngine` compatibility table and setup guidance for supported CMTAT target versions.
79+
- Add standalone `v0.4.0` Slither and Aderyn feedback files and document the audit-report summary table in `README.md`.
7880

7981
- Testing
8082
- Add tests for exact snapshot queries (scheduled vs non-scheduled timestamps and parity with legacy queries on scheduled timestamps).
8183
- Add tests for snapshot materialization event emission.
8284
- Add tests for `poke()` access control and idempotent behavior.
85+
- Add coverage for `CMTATInternalSnapshotBase` passthrough overrides: `approve`, `transferFrom`, `decimals`, `name`, and `symbol`.
8386
- Add test coverage for `SnapshotUnschedule(time)` emission in `unscheduleSnapshotNotOptimized`.
8487
- Add a dedicated `SnapshotEngineOwnable2Step` test suite and share common snapshot behavior tests across AccessControl and Ownable variants.
8588
- Add a dedicated `CMTATStandaloneInternalSnapshot` test suite reusing the same shared snapshot behavior suites.

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -869,6 +869,15 @@ Please see [SECURITY.md](https://github.com/CMTA/CMTAT/blob/master/SECURITY.md)
869869

870870
This project is not audited !
871871

872+
#### Audit report summary
873+
874+
| Version | Tool | Report | Feedback | Notes |
875+
| --- | --- | --- | --- | --- |
876+
| `v0.4.0` | Slither | [slither-report.md](./doc/audits/tools/v0.4.0/slither-report.md) | [slither-feedback.md](./doc/audits/tools/v0.4.0/slither-feedback.md) | Raw report plus separate project feedback. |
877+
| `v0.4.0` | Aderyn | [aderyn-report.md](./doc/audits/tools/v0.4.0/aderyn-report.md) | [aderyn-feedback.md](./doc/audits/tools/v0.4.0/aderyn-feedback.md) | Raw report plus separate project feedback. |
878+
| `v0.3.0` | Slither | [slither-report.md](./doc/audits/tools/v0.3.0/slither-report.md) | Integrated in report | Legacy format with inline feedback in the report file. |
879+
| `v0.3.0` | Aderyn | [aderyn-report.md](./doc/audits/tools/v0.3.0/aderyn-report.md) | Integrated in report | Legacy format with inline feedback in the report file. |
880+
872881
### Tools
873882

874883
#### [Slither](https://github.com/crytic/slither)

0 commit comments

Comments
 (0)