Skip to content

Commit d3fa6be

Browse files
authored
Update CHANGELOG.md with v1.1 release details and documentation additions
Added detailed changelog entries for AFRX Token v1.1, including snapshot-based dividends, lockup enforcement, buyback features, upgradeability, and the addition of the Dividend Distribution FAQ. Also noted README updates for better investor and developer guidance.
1 parent f1ff9ba commit d3fa6be

1 file changed

Lines changed: 23 additions & 89 deletions

File tree

CHANGELOG.md

Lines changed: 23 additions & 89 deletions
Original file line numberDiff line numberDiff line change
@@ -1,100 +1,34 @@
1-
afrx-security-token
1+
# AFRX Security Token – Changelog
22

3-
Smart contract implementation for the AFRX Security Token, built on the ERC-3643 standard (formerly ERC-1400), incorporating enhanced compliance, upgradeability, and snapshot-based dividend distribution.
3+
This document tracks all notable changes to the AFRX smart contract and related documentation.
44

5+
---
56

6-
## Project Links
7+
## [v1.1] – May 2025
78

8-
- [AFRXToken.sol (Production Contract)](https://github.com/afrail-inc/afrx-security-token/blob/main/AFRXToken.sol)
9-
- [AFRXToken_legacy.sol (Archived Legacy Contract)](https://github.com/afrail-inc/afrx-security-token/blob/main/AFRXToken_legacy.sol)
10-
- [Updated White Paper (PDF)](https://github.com/afrail-inc/afrx-security-token/blob/main/Updated_AFRX_White_Paper_v1_4_May2025.pdf)
11-
- [Repository](https://github.com/afrail-inc/afrx-security-token)
9+
**Production-ready release with enhanced compliance, dividend distribution, and upgradeability.**
1210

11+
### Added
12+
- Snapshot-based dividend distribution using `ERC20Snapshot`
13+
- Dividend claim and distribution functions with anti-double-claim protection
14+
- 365-day investor lockup enforcement
15+
- Token buyback and burn functionality
16+
- Role-based access control and UUPS proxy upgradeability
17+
- Emergency pause and unpause features
18+
- Dividend Distribution FAQ document added and linked in README
1319

14-
Overview
20+
### Documentation
21+
- Added detailed `AFRX_Dividend_FAQ.md` for investor clarity
22+
- Updated `README.md` with contract versions, usage examples, and FAQ link
1523

16-
AFRX is a fully compliant security token issued by Afrail Inc., designed for global investor participation under Regulation D Rule 506(c) and Regulation S. This smart contract incorporates:
24+
---
1725

18-
On-chain jurisdiction control
26+
## [v1.0] – Legacy
1927

20-
Whitelisting/KYC enforcement
28+
**Initial smart contract implementation.**
2129

22-
Dividend claims by snapshot
23-
24-
Buyback & burn mechanics
25-
26-
UUPS upgradeable proxy architecture
27-
28-
29-
Features
30-
31-
ERC-3643 Compliance (built on ERC-1400 base)
32-
33-
On-chain KYC/AML and jurisdiction whitelisting
34-
35-
365-day lockup enforcement per investor
36-
37-
Snapshot-based dividend distribution (ERC20Snapshot)
38-
39-
Dividend claim function with double-claim protection
40-
41-
Token buyback and burn mechanism
42-
43-
Role-based access control (OpenZeppelin AccessControl)
44-
45-
UUPS upgradeable architecture
46-
47-
Emergency pause/unpause functionality
48-
49-
50-
Smart Contract Architecture
51-
52-
The AFRX Security Token is designed to meet enterprise and regulatory requirements under SEC Regulation D Rule 506(c) and Regulation S.
53-
54-
Token Symbol: AFRX
55-
56-
Token Cap: 5,770,000,000
57-
58-
Standard: ERC-3643
59-
60-
Lockup Period: 365 days
61-
62-
Compliance: Jurisdiction + whitelist-based investor restrictions
63-
64-
Upgradeability: Yes (via UUPS Proxy)
65-
66-
Audit Status: Final audit pending (CertiK); Pre-reviewed by Okiki Omisande (CodeHawks, Immunefi)
67-
68-
69-
Contract Versions
70-
71-
AFRXToken.sol – Current production contract (v1.1) with enhanced compliance and dividend distribution.
72-
73-
AFRXToken_legacy.sol – Archived legacy contract retained for historical reference.
74-
75-
76-
Installation
77-
78-
Clone the repository:
79-
80-
git clone https://github.com/afrail-inc/afrx-security-token.git
81-
cd afrx-security-token
82-
83-
Usage Examples
84-
85-
// Claim dividends for a round
86-
AFRXToken.claimDividends(roundId);
87-
88-
// Admin distributes dividends (snapshot is auto-generated)
89-
AFRXToken.distributeDividends(totalAmount);
90-
91-
// Add investor to whitelist
92-
AFRXToken.whitelistInvestor(address, "United States");
93-
94-
// Issue tokens to KYC'd investor
95-
AFRXToken.issueTokens(address, 1000 ether, "United States");
96-
97-
License
98-
99-
MIT License
30+
- Basic ERC-1400 token implementation without dividend snapshot functionality
31+
- No buyback, lockup, or upgradeability features
32+
- Limited compliance enforcement
10033

34+
---

0 commit comments

Comments
 (0)