2024-12-27 21:52:48 +03:00
2024-12-26 23:51:40 +03:00
2024-12-27 21:52:48 +03:00
2024-12-26 23:51:40 +03:00

๐Ÿš€ LaunchPaw - Token Launch Platform

LaunchPaw is a decentralized platform built on EduChain that enables users to create, launch, and trade tokens with an automated bonding curve mechanism.

โœจ Features

  • ๐Ÿ’ซ Bonding Curve Mechanism

    • Dynamic pricing based on supply and demand
    • Fair token distribution
    • Automated price discovery
  • ๐Ÿ’ง Liquidity Management

    • Automated liquidity pool creation
    • Built-in reward system for liquidity providers
    • Efficient token swapping
  • ๐Ÿ” Security Features

    • Verified smart contracts
    • Automated security checks
    • Transparent token mechanics
  • ๐Ÿ“Š User Dashboard

    • Portfolio tracking
    • Transaction history
    • Performance analytics

๐Ÿ› ๏ธ Technical Stack

  • Frontend

    • React + TypeScript
    • Tailwind CSS
    • Framer Motion
    • wagmi/viem
    • ethers.js
  • Smart Contracts

    • Solidity
    • Hardhat
    • OpenZeppelin

๐Ÿš€ Getting Started

Prerequisites

node.js >= 16.0.0
npm or yarn

Installation

  1. Clone the repository:
git clone https://github.com/arhansuba/launchpaw.git
cd launchpaw
  1. Install dependencies:
# Install frontend dependencies
cd src
npm install

# Install contract dependencies
cd contracts
npm install
  1. Set up environment variables:
cp .env.example .env
  1. Start local development:
# Start local hardhat node
npx hardhat node

# Deploy contracts
npx hardhat run scripts/deploy.js --network localhost

# Start frontend
npm run dev

๐Ÿ“ Project Structure

LaunchPaw/
โ”œโ”€โ”€ src/                    # Frontend application
โ”‚   โ”œโ”€โ”€ components/         # Reusable components
โ”‚   โ”œโ”€โ”€ pages/             # Page components
โ”‚   โ”œโ”€โ”€ hooks/             # Custom React hooks
โ”‚   โ”œโ”€โ”€ config/            # Configuration files
โ”‚   โ””โ”€โ”€ utils/             # Utility functions
โ”‚
โ”œโ”€โ”€ contracts/             # Smart contracts
โ”‚   โ”œโ”€โ”€ contracts/         # Contract source files
โ”‚   โ”œโ”€โ”€ scripts/           # Deployment scripts
โ”‚   โ””โ”€โ”€ test/             # Contract tests

๐Ÿ”ง Configuration

  1. Configure your network in src/config/chains.ts
  2. Update contract addresses in src/config/contracts.ts
  3. Configure hardhat settings in contracts/hardhat.config.js

๐Ÿงช Testing

# Run contract tests
cd contracts
npx hardhat test

# Run frontend tests
cd src
npm test

๐Ÿš€ Deployment

  1. Deploy contracts:
cd contracts
npx hardhat run scripts/deploy.js --network educhain
  1. Build frontend:
cd src
npm run build

๐Ÿ“ Smart Contract Documentation

Key contracts:

  • TokenFactory.sol: Main factory for token creation
  • NativeLiquidityPool.sol: Handles liquidity and swaps
  • BondingCurve.sol: Implements bonding curve mechanics

๐Ÿค Contributing

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

๐Ÿ“„ License

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

๐Ÿ™ Acknowledgments

  • Built for the EduChain Hackathon
  • Inspired by innovative DeFi platforms
  • Uses OpenZeppelin contracts for security

๐Ÿ“ž Support

For support and questions, please open an issue in the GitHub repository or contact the team at [your contact info].

๐Ÿ”ฎ Future Roadmap

  • Enhanced analytics dashboard
  • Additional token features
  • Advanced trading tools
  • Mobile app development
Description
1377
Readme 1.2 MiB
Languages
TypeScript 93.1%
JavaScript 5.1%
CSS 1.6%
HTML 0.2%