Stimulant (STIM) - ERC-20 Token

A comprehensive, production-ready ERC-20 token smart contract built on Ethereum with advanced features including minting, burning, and pause functionality.

📋 Table of Contents

• Features
• Prerequisites
• Installation
• Configuration
• Deployment
• Testing
• Contract Details
• Security
• License

✨ Features

• ERC-20 Compliant: Full ERC-20 token standard implementation
• Minting: Owner can mint new tokens
• Burning: Tokens can be burned by owner or user
• Pausable: Owner can pause/unpause all transfers
• Ownership: Ownable pattern for access control
• Event Logging: Comprehensive event emissions for all operations
• Gas Optimized: Optimized smart contract for minimal gas consumption
• Well Tested: Complete test coverage with 20+ test cases
• Verified: Ready for Etherscan verification

📦 Prerequisites

• Node.js >= 16.x
• npm or yarn
• An Ethereum wallet with testnet ETH (for deployment)
• API keys for:
  • Infura - For RPC endpoints
  • Etherscan - For contract verification

🚀 Installation

1. Clone the repository

   git clone https://github.com/shooksphere/stimulant.git
   cd stimulant

2. Install dependencies

   npm install

3. Verify installation

   npx hardhat --version

⚙️ Configuration

1. Create environment file

   cp .env.example .env

2. Update .env with your credentials

   PRIVATE_KEY=...

INFURA_API_KEY=... ETHERSCAN_API_KEY=... REPORT_GAS=true

⚠️ **IMPORTANT**: Never commit `.env` file or expose your private key!

## 🔨 Compilation

Compile the smart contract:

```bash
npm run compile

🧪 Testing

Run the comprehensive test suite:

npm run test

Generate coverage report:

npm run test:coverage

📤 Deployment

Local Network (Hardhat)

npx hardhat node

Then in another terminal:

npm run deploy

Sepolia Testnet

npm run deploy:sepolia

Mainnet

npm run deploy:mainnet

📄 Contract Details

Token Information:

• Name: Stimulant
• Symbol: STIM
• Decimals: 18
• Initial Supply: 1,000,000 STIM

🔒 Security

The contract uses audited OpenZeppelin contracts and follows Ethereum security best practices. See SECURITY.md for detailed security information.

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

---

Made with ❤️ for the Ethereum community