Skip to content

Commit 38e93b8

Browse files
authored
docs(changelog): add v1.18.3 entry for NOTICE.md and ERC-20 clarification in README
Added a new entry for version v1.18.3 to document the addition of NOTICE.md, clarifying that ERC‑3643 is based on ERC‑20, not ERC‑1400. Also recorded the update to README.md to reflect the correct token standard foundation.
1 parent d15b891 commit 38e93b8

File tree

1 file changed

+46
-65
lines changed

1 file changed

+46
-65
lines changed

CHANGELOG.md

Lines changed: 46 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -2,96 +2,77 @@
22

33
All notable changes to the AFRX Security Token smart contract repository will be documented in this file.
44

5+
----------
56

6-
---
7+
## [v1.18.3] – 2025-07-17
78

8-
[v1.18.2] – 2025-06-24
9+
### Added
910

10-
*Changed*
11+
- `NOTICE.md` with technical clarification that ERC‑3643 is built on ERC‑20, not ERC‑1400.
1112

12-
Replaced outdated README.md with updated full version including token design breakdown and corrected anchor links.
13+
### Updated
1314

14-
Linked the official AFRX token image (branding/afrx-token.jpg) in both image display and internal documentation.
15+
- `README.md`: Updated all references from ERC‑1400 to ERC‑20 to reflect accurate token standard architecture.
1516

16-
Verified internal markdown anchors to ensure all Project Links route correctly to their sections.
17+
----------
1718

19+
## [v1.18.2] – 2025-06-24
1820

21+
### Changed
1922

20-
---
23+
- Replaced outdated README.md with updated full version including token design breakdown and corrected anchor links.
24+
- Linked the official AFRX token image (`branding/afrx-token.jpg`) in both image display and internal documentation.
25+
- Verified internal markdown anchors to ensure all Project Links route correctly to their sections.
2126

22-
[v1.18.1] – 2025-06-22
27+
----------
2328

24-
*Changed*
29+
## [v1.18.1] – 2025-06-22
2530

26-
Updated token name in AFRXTokenV1_18.sol from "AfrailX Security Token" to "Afrail Security Token" (line 57).
31+
### Changed
2732

28-
No changes to contract logic or functionality.
33+
- Updated token name in `AFRXTokenV1_18.sol` from "AfrailX Security Token" to "Afrail Security Token" (line 57).
34+
- No changes to contract logic or functionality.
35+
- Aligned token metadata with official issuer name: Afrail Inc.
2936

30-
Aligned token metadata with official issuer name: Afrail Inc.
37+
----------
3138

39+
## [v1.18] – 2025-06-22
3240

41+
### Added
3342

34-
---
43+
- Full audit-style revision of smart contract using CertiK-style methodology.
44+
- `AFRXTokenV1_18.sol` introduced with final production-grade compliance features.
45+
- Improved error handling and input validations across all major functions.
46+
- `dividendInfo[roundId].reclaimedAmount` to track unclaimed dividend recoveries.
47+
- `snapshotTimestamps` mapping for reclaim timing logic enforcement.
48+
- Events for `DividendsReclaimed`, `TestModeToggled`, `Upgraded` added.
49+
- Role-guarded upgradeability with UUPS implementation and `UPGRADER_ROLE`.
3550

36-
[v1.18] – 2025-06-22
51+
### Changed
3752

38-
Added
53+
- Migrated prior production contract `AFRXToken.sol` to `contracts-archive` folder.
54+
- Updated jurisdiction enforcement to use normalized lowercase hashed keys.
55+
- Whitelisting logic now includes on-chain jurisdiction verification.
56+
- Token issuance now includes lockup timing enforcement (`LOCKUP_PERIOD`).
57+
- Enhanced double-claim protection in `claimDividends()` with snapshot balance validation.
3958

40-
Full audit-style revision of smart contract using CertiK-style methodology.
59+
### Fixed
4160

42-
AFRXTokenV1_18.sol introduced with final production-grade compliance features.
61+
- Redundant logic and poor modularization from previous versions.
62+
- Snapshot imbalance issue when treasury or contract address skewed supply.
63+
- Compatibility issues with OpenZeppelin `ERC20Capped` and `Snapshot`.
4364

44-
Improved error handling and input validations across all major functions.
65+
### Deprecated
4566

46-
dividendInfo[roundId].reclaimedAmount to track unclaimed dividend recoveries.
67+
- `AFRXToken.sol` (moved to archive)
68+
- `AFRXToken_legacy.sol` (retained for historical reference)
4769

48-
snapshotTimestamps mapping for reclaim timing logic enforcement.
70+
----------
4971

50-
Events for DividendsReclaimed, TestModeToggled, Upgraded added.
51-
52-
Role-guarded upgradeability with UUPS implementation and UPGRADER_ROLE.
53-
54-
55-
Changed
56-
57-
Migrated prior production contract AFRXToken.sol to contracts-archive folder.
58-
59-
Updated jurisdiction enforcement to use normalized lowercase hashed keys.
60-
61-
Whitelisting logic now includes on-chain jurisdiction verification.
62-
63-
Token issuance now includes lockup timing enforcement (LOCKUP_PERIOD).
64-
65-
Enhanced double-claim protection in claimDividends() with snapshot balance validation.
66-
67-
68-
Fixed
69-
70-
Redundant logic and poor modularization from previous versions.
71-
72-
Snapshot imbalance issue when treasury or contract address skewed supply.
73-
74-
Compatibility issues with OpenZeppelin ERC20Capped and Snapshot.
75-
76-
77-
Deprecated
78-
79-
AFRXToken.sol (moved to archive)
80-
81-
AFRXToken_legacy.sol (retained for historical reference)
82-
83-
84-
85-
---
86-
87-
[v1.17] – 2025-06-21
72+
## [v1.17] – 2025-06-21
8873

8974
Initial final-stage candidate before CertiK audit pass. Introduced:
9075

91-
Structured investor lockup and jurisdiction enforcement.
92-
93-
Basic dividend distribution via snapshots.
94-
95-
Full OpenZeppelin upgradeable framework.
96-
97-
76+
- Structured investor lockup and jurisdiction enforcement.
77+
- Basic dividend distribution via snapshots.
78+
- Full OpenZeppelin upgradeable framework.

0 commit comments

Comments
 (0)