PlanEth Hackathon

A planet consists of Mandalases in the EVM universe.

Guidline

Overview

This guide outlines the architecture for building a Web3 ecosystem that enables multiple communities to operate with their own currencies while allowing inter-community token swaps. The ecosystem supports businesses, users, and community governance.

System Components

Core Components

1. Communities: Self-contained units with their own currency and governance
2. Businesses: Service providers within communities
3. Users: Community members who can hold tokens and participate in activities
4. Token Swaps: Mechanism for exchanging tokens between communities

Smart Contract Architecture

Core Contracts

1. EcosystemRegistry

   • Central registry for all communities
   • Manages community registration/unregistration
   • Single source of truth for community information

   // Key functions
   function registerCommunity()
   function unregisterCommunity()
   function getCommunityInfo()
   function isRegisteredCommunity()

2. CommunityFactory

   • Deploys new communities
   • Creates community tokens
   • Sets up governance structures

   // Key functions
   function createCommunity()
   function deployCommunityToken()
   function setupCommunityGovernance()

Community-Specific Contracts

1. CommunityToken

   • ERC20 token implementation
   • Community-specific currency

   // Key functions
   function mint()
   function burn()
   function transfer()
   function approve()

2. CommunityGovernance

   • Handles community decision-making
   • Manages proposals and voting

   // Key functions
   function propose()
   function vote()
   function execute()
   function delegate()

Token Swap Contracts

1. TokenSwapFactory

   • Creates and manages swap pairs
   • Maintains pair registry

   // Key functions
   function createSwapPair()
   function getSwapPair()
   function getAllPairs()

2. TokenSwapPair

   • Handles token swaps between communities
   • Manages liquidity pools

   // Key functions
   function addLiquidity()
   function removeLiquidity()
   function swap()
   function getReserves()

Registry Contracts

1. BusinessRegistry

   • Manages business registrations
   • Stores business metadata

   // Key functions
   function registerBusiness()
   function unregisterBusiness()
   function updateBusinessInfo()

2. UserRegistry

   • Manages user profiles
   • Handles permissions

   // Key functions
   function registerUser()
   function updateUserProfile()
   function getUserInfo()

Deployment Flow

1. Deploy Core Contracts:

   • EcosystemRegistry
   • CommunityFactory
   • TokenSwapFactory

2. Deploy Registry Contracts:

   • BusinessRegistry
   • UserRegistry

3. For Each Community:

   • Deploy CommunityToken
   • Deploy CommunityGovernance
   • Register in EcosystemRegistry

4. For Token Swaps:

   • Deploy TokenSwapPair for each community pair
   • Initialize liquidity pools

Key Features

1. Community Management

   • Independent governance
   • Custom token economics
   • Business integration

2. Token Swaps

   • Cross-community trading
   • Automated market making
   • Liquidity provision

3. Business Integration

   • Registration system
   • Multi-token support
   • Service marketplace

4. User Features

   • Multi-community membership
   • Token swapping
   • Governance participation

Development Guidelines

1. Smart Contract Best Practices

   • Use OpenZeppelin contracts where possible
   • Implement comprehensive testing
   • Follow security best practices

2. Security Considerations

   • Implement access controls
   • Rate limiting for sensitive operations
   • Reentrancy protection
   • Integer overflow protection

Hackathon Track Suggestions

1. Community Builder Track

   • Implement community creation and management
   • Build governance mechanisms
   • Design token economics

2. DeFi Track

   • Implement token swap mechanisms
   • Build liquidity provision systems
   • Create yield farming opportunities

3. Business Integration Track

   • Build business onboarding system
   • Create service marketplace
   • Implement payment systems

4. User Experience Track

   • Design user interfaces
   • Build wallet integration
   • Create community interaction tools

Resources

1. Technical Stack

   • Solidity
   • Hardhat/Truffle
   • OpenZeppelin
   • Ethers.js

2. Testing Tools

   • Hardhat
   • Ethers.js

3. Frontend Frameworks

   • React
   • Tailwind
   • Ether JS