An end-to-end solution for the Aimond ecosystem token (AMD), including:

• ERC20 Token: AimondToken (AMD) — fixed supply token for the Aimond ecosystem.
• Vesting Contracts: investor, founder, and employee vesting schedules built on BaseVestingToken.
• Airdrop Mechanism: on-chain Merkle tree–based distributions via Airdrop.sol.
• Backend Distribution API: Merkle root management and token allocation backend (see ERD).
• Gnosis Safe Integration: secure multisig administration for vesting via Gnosis Safe.

• Aimond Token Project
  • Table of Contents
  • Architecture Overview
  • Smart Contracts
  • Database Schema (ERD)
  • Documentation
  • Prerequisites
    • Environment Variables
  • Installation
  • Testing
  • Deployment
  • Create key store file
  • Script Execution Order
    • 1. Initial Setup
    • 2. Token Distribution
    • 3. Verification and Monitoring
    • 4. Vesting Operations (if necessary)
    • 5. Troubleshooting
    • Key Points
  • Gnosis Safe Integration
  • References

This repository contains:

• Smart contracts for token issuance, vesting schedules, and airdrops.
• A backend schema for generating and tracking Merkle roots and token allocations.
• Helper scripts for deployment and contract interaction via Hardhat.

Note: The legacy contracts/Aimond.sol file has been removed; its functionality has been consolidated into AimondToken.sol.

The Merkle root and token allocation database schema is defined in ERD.md.

• Token Minting Schedule: Aimond AIM Token Minting_250703_V9.pdf
• Gnosis Safe Integration Guide: GNOSIS_SAFE_GUIDE.md

• Node.js (>= 20.x)
• Yarn or npm
• Hardhat
• A .env file (see below)

Create a .env file in the project root with the following variables:

BSC_URL=<your BSC mainnet RPC URL>
BSC_TESTNET_URL=<your BSC testnet RPC URL>
ADMIN_KEY=<deployer private key>
USER_KEY=<secondary key for tests/deployments>
ADMIN_ADDRESS=<deployer address>
USER_ADDRESS=<secondary address>
RECIPIENT_ADDRESS=<recipient address for transfers>
AIMOND_ADDRESS=<deployed AimondToken address>

yarn install

Run the full test suite:

yarn test

Or run a specific suite:

yarn test:inv   # InvestorVesting tests
yarn test:fnd   # FounderVesting tests
yarn test:emp   # EmployeeVesting tests

Compile contracts:

yarn build

Start a local Hardhat node:

yarn localnode

Deploy to local network:

yarn deploy:aim:localnet

Deploy to BSC mainnet or testnet:

yarn deploy:aim:bsc
yarn deploy:aim:bscTestnet

Other deployment and transfer scripts for Jaymond token are also available in package.json.

ts-node scripts/create-keystore.ts <private-key> <password>

To properly set up and manage the vesting system, follow this order when executing scripts:

# Deploy all contracts
yarn deploy:all:bsc
# or
npx hardhat run scripts/deploy-all.ts --network <network>


# Set global start time for all vesting contracts
yarn set:global-start-time:bsc
# or
npx hardhat run scripts/set-global-start-time.ts --network <network>

# Set the owner for vesting contracts
yarn set-owner:bsc
# or
npx hardhat run scripts/set-owner.ts --network <network>

# Fund all vesting contracts and loyalty point contract with Aimond tokens
yarn fund:all:bsc
# or
npx hardhat run scripts/fund-all.ts --network <network>

# Transfer BaseVestingToken tokens from initial owner to safe wallet
yarn transfer:safe:bsc
# or
npx hardhat run scripts/transfer-to-safe.ts --network <network>

# Check all contract information, balances, and vesting schedules
yarn info:all:bsc
# or
npx hardhat run scripts/get-all-info.ts --network <network>

# Create vesting schedules for beneficiaries
npx hardhat run scripts/set-mock-owner.ts --network <network>  # If using mock owner
npx hardhat run scripts/transfer-tokens.ts --network <network>  # Transfer tokens to beneficiaries

If you encounter "Simulation failed" errors when calling createVesting:

1. Check balances: Run get-all-info.ts to see BaseVestingToken balances
2. Transfer tokens: Use transfer-to-safe.ts to move tokens to the safe wallet
3. Verify ownership: Ensure the caller has sufficient BaseVestingToken tokens

• BaseVestingToken tokens are needed for createVesting operations
• Aimond tokens are needed for actual token releases to beneficiaries
• Safe wallet should hold BaseVestingToken tokens for vesting operations
• Owner should have BaseVestingToken tokens initially (then transfer to safe wallet)

For instructions on administering vesting contracts via Gnosis Safe multisig, see Gnosis Safe Guide.

• Deploying Smart Contract to BSC Testnet with Hardhat