Skip to content

Enter-L2/docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

3 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Enter L2 Documentation

Comprehensive documentation for Enter L2 - the ZK Rollup-based stablecoin payment network with merchant-paid fees and consumer-friendly wallets.

πŸ“š Documentation Structure

This repository contains all public documentation for Enter L2, organized into the following sections:

πŸš€ Quick Start

For Users

For Developers

For Node Operators

πŸ—οΈ Architecture Overview

Enter L2 is a ZK Rollup-based Layer 2 solution designed specifically for stablecoin payments with the following key features:

Role-Based Wallets

  • Consumer Wallets: Receive-only wallets that can only accept payments from merchant wallets
  • Merchant Wallets: Full-featured wallets with payment capabilities and fee management

Merchant-Paid Fees

  • Merchants automatically pay transaction fees for consumer transactions
  • Enables gasless payments for end users
  • Supports USDC/USDT fee payments with automatic conversion

ZK Proof System

  • Halo2-based circuits for privacy and scalability
  • Batch proving for efficient transaction processing
  • Independent verification by public nodes

Naming System

  • ENS-like name registration and resolution
  • Phone number verification and linking
  • Primary name management for addresses

Staking & Rewards

  • Token staking with lock period multipliers
  • Profit-sharing from network transaction fees
  • Automated reward distribution

πŸ“– Key Concepts

Wallet Types

Consumer Wallet:
β”œβ”€β”€ Receive payments from merchants
β”œβ”€β”€ Cannot initiate transactions
β”œβ”€β”€ No gas fees required
└── Perfect for end users

Merchant Wallet:
β”œβ”€β”€ Full transaction capabilities
β”œβ”€β”€ Pays fees for consumer transactions
β”œβ”€β”€ Whitelist management
β”œβ”€β”€ Daily spending limits
└── Multi-operator support

Fee Structure

Transaction Fees:
β”œβ”€β”€ Paid by merchant wallets
β”œβ”€β”€ Automatic fee calculation
β”œβ”€β”€ USDC/USDT support
β”œβ”€β”€ Price oracle integration
└── Gas optimization

Network Architecture

Enter L2 Network:
β”œβ”€β”€ Sequencer (Private)
β”‚   β”œβ”€β”€ Transaction ordering
β”‚   β”œβ”€β”€ Batch creation
β”‚   └── State management
β”œβ”€β”€ Prover (Private)
β”‚   β”œβ”€β”€ ZK proof generation
β”‚   β”œβ”€β”€ Circuit optimization
β”‚   └── Verification keys
β”œβ”€β”€ Public Nodes
β”‚   β”œβ”€β”€ Independent verification
β”‚   β”œβ”€β”€ Data availability
β”‚   └── RPC services
└── Smart Contracts (L1)
    β”œβ”€β”€ State management
    β”œβ”€β”€ Bridge operations
    └── Proof verification

πŸ”§ Development Tools

SDKs

  • TypeScript/JavaScript: Full-featured SDK for web and Node.js
  • Go: High-performance SDK for backend services
  • Python: Comprehensive SDK with async support
  • Rust: Coming soon
  • Java: Coming soon

APIs

  • JSON-RPC: Ethereum-compatible RPC interface
  • REST API: RESTful API for aggregated data
  • WebSocket: Real-time event subscriptions
  • GraphQL: Flexible data querying (coming soon)

Tools

🌐 Network Information

Mainnet

Testnet

πŸ“‹ Documentation Standards

This documentation follows these standards:

  • Markdown: All documentation written in GitHub Flavored Markdown
  • Structure: Consistent heading hierarchy and navigation
  • Code Examples: Working code samples in multiple languages
  • Diagrams: Mermaid diagrams for architecture and flows
  • Versioning: Semantic versioning for API changes
  • Accessibility: Screen reader friendly formatting

🀝 Contributing

We welcome contributions to improve our documentation:

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Test all code examples
  5. Submit a pull request

Writing Guidelines

  • Use clear, concise language
  • Include working code examples
  • Add diagrams for complex concepts
  • Test all instructions thoroughly
  • Follow the existing structure

Review Process

All documentation changes go through:

  1. Technical review for accuracy
  2. Editorial review for clarity
  3. Community feedback period
  4. Final approval and merge

πŸ“ž Support

Community

Developer Support

Business Inquiries

πŸ“„ License

This documentation is licensed under Creative Commons Attribution 4.0 International License.

Code examples are licensed under MIT License.

πŸ”„ Updates

Documentation is continuously updated. Major changes are announced via:

  • GitHub Releases: Version tags and changelogs
  • Discord Announcements: Real-time updates
  • Newsletter: Monthly development updates
  • Blog: Technical deep-dives and tutorials

Last Updated: December 2024
Version: 1.0.0
Next Review: January 2025

About

Enter L2 Documentation

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published