How azzurriii/azzurri-tokens works
Main Components
• Azzurri Token Contract (ERC20) – This is the core token contract incorporating fees, minting logic, and DEX integration.
• NFT Contract – Handles minting, burning, and level management of NFTs.
• NFT Staking Contract – Manages staking and unstaking of NFTs; depends on the NFT contract.
• Token Staking Contract – Manages token staking, rewards distribution, and treasury interactions; depends on the token (and possibly a reward token) contract.
• IDO (Initial DEX Offering) Contract – Governs token sale, vesting schedules, and associated parameters.
• INO (Initial NFT Offering) Contract – Manages the sale of NFTs with random rarity levels and associated configurations.
• Deployment & Testing Infrastructure – Although not a “runtime” component, include the deployment scripts and test framework (Hardhat, scripts, deployments JSON, etc.) to show how contracts are deployed and verified.
• External Dependencies – Include the DEX (router) integration for the token, Chainlink VRF (or similar) considerations for randomness in INO, and any IPFS links (as seen in deployments-ipfs.json).
Out the Relationships and Data Flow
• The Azzurri Token contract interacts with the DEX router to establish liquidity pairs upon deployment.
• The Token Staking contract should illustrate an interaction with both the token contract and the treasury management.
• The IDO contract interacts directly with the token for sales, imposing parameters such as purchase limits, vesting schedules, and release configuration.
Architectural Patterns & Design Principles
• Modular Design: Each feature (token, NFT, staking, offerings) is encapsulated in its own set of contracts.
• Separation of Concerns: The project cleanly separates business logic (contracts) from deployment logic (scripts) and from testing.
• Dependency Injection: Several contracts reference others (e.g., staking contracts depend on the NFT or token contracts), so make sure to indicate these dependencies.
• External Integrations: Mark external points such as DEX routers for token pairing and potential randomness providers for the INO.
Relevant Technologies, Frameworks, or Libraries
• Hardhat – Used for compiling, testing, and deploying the Solidity contracts.
• Solidity – The programming language behind the smart contracts.
• Node.js – The runtime environment for running scripts and tests.
• (Potential) Chainlink or similar for secure randomness, as suggested under security considerations in the README.