{"id":31745483,"url":"https://github.com/ppopth/miniature-enigma","last_synced_at":"2025-10-09T12:57:39.369Z","repository":{"id":318475723,"uuid":"1034335466","full_name":"ppopth/miniature-enigma","owner":"ppopth","description":null,"archived":false,"fork":false,"pushed_at":"2025-10-07T11:04:27.000Z","size":268,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"shadow","last_synced_at":"2025-10-07T13:09:55.799Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ppopth.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-08-08T08:19:49.000Z","updated_at":"2025-08-08T08:27:14.000Z","dependencies_parsed_at":"2025-10-07T13:09:57.737Z","dependency_job_id":"d63327be-05f0-4bfc-86b4-e9b4a4372d87","html_url":"https://github.com/ppopth/miniature-enigma","commit_stats":null,"previous_names":["ppopth/miniature-enigma"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/ppopth/miniature-enigma","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ppopth%2Fminiature-enigma","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ppopth%2Fminiature-enigma/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ppopth%2Fminiature-enigma/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ppopth%2Fminiature-enigma/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ppopth","download_url":"https://codeload.github.com/ppopth/miniature-enigma/tar.gz/refs/heads/shadow","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ppopth%2Fminiature-enigma/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279001415,"owners_count":26083078,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-09T02:00:07.460Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-10-09T12:57:34.042Z","updated_at":"2025-10-09T12:57:39.362Z","avatar_url":"https://github.com/ppopth.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Ethereum Erasure Coding Broadcast\n\nA Go-based peer-to-peer (P2P) broadcast system implementing erasure coding protocols for efficient and resilient message distribution in Ethereum networks.\n\n## Features\n\n- **FloodSub**: Simple flooding protocol for baseline message propagation\n- **Erasure Coding Router**: Advanced erasure coding with pluggable encoder interface supporting:\n  - **RLNC (Random Linear Network Coding)**: Linear combinations over finite fields for efficient and resilient broadcast\n  - **Reed-Solomon**: Systematic MDS codes for efficient erasure coding with predictable chunk indices\n- **Finite Field Arithmetic**: Generic field operations supporting prime fields and binary fields for erasure coding\n- **Group Operations**: Cryptographic primitives including Ristretto255 for verification systems\n- **Chunk Verification**: Pluggable verification system with Pedersen commitment support\n- **QUIC Transport**: Modern, secure transport layer with TLS authentication\n- **Modular Design**: Clean separation between networking, pubsub, and erasure coding layers\n\n## Quick Start\n\n### Prerequisites\n\n- Go 1.21 or later\n- Protocol Buffers compiler (for development)\n\n### Building\n\n```bash\n# Download dependencies\ngo mod download\n\n# Build all packages\ngo build ./...\n\n# Build example application\ncd examples/simple\ngo build\n```\n\n### Running Tests\n\n```bash\n# Run all tests\ngo test ./...\n\n# Run tests with coverage\ngo test -coverprofile=coverage.out ./...\n```\n\n### Examples\n\nThe project includes comprehensive examples demonstrating different erasure coding approaches:\n\n#### Simple Network (Basic P2P)\n```bash\ncd examples/simple\ngo build\n./simple -l 8001               # Listening node\n./simple -c 127.0.0.1:8001     # Connecting node\n```\n\n#### RLNC Network (Random Linear Network Coding)\n```bash\ncd examples/rlnc-network\ngo build\n./rlnc-network -l 8001 -id alice\n./rlnc-network -l 8002 -c 127.0.0.1:8001 -id bob\n```\n\n#### Reed-Solomon Network (Systematic MDS Codes)\n```bash\ncd examples/rs-network\ngo build\n./rs-network -l 8001 -id alice\n./rs-network -l 8002 -c 127.0.0.1:8001 -id bob\n```\n\nSee `examples/README.md` for detailed usage instructions, performance comparisons, and advanced configurations.\n\n## Development\n\n### Make Commands\n\n```bash\nmake help           # Show all available commands\nmake deps           # Download and verify dependencies\nmake build          # Build all packages\nmake test           # Run tests with race detection\nmake test-short     # Run tests without race detection\nmake coverage       # Run tests with coverage\nmake bench          # Run benchmarks for all packages\nmake bench-rlnc     # Run RLNC encoder benchmarks\nmake bench-rs       # Run Reed-Solomon encoder benchmarks\nmake bench-field    # Run field arithmetic benchmarks\nmake test-examples  # Test example applications\nmake proto          # Generate protobuf files\nmake proto-clean    # Clean protobuf generated files\nmake example        # Build all example applications\nmake example-linux  # Cross compile examples for Linux\nmake install-tools  # Install development tools\nmake clean          # Clean build artifacts\n```\n\n### CI/CD\n\nThis project uses GitHub Actions for continuous integration:\n\n- **Testing**: Runs tests on Go 1.21, 1.22, and 1.23\n- **Building**: Ensures all packages build correctly\n- **Code Formatting**: Validates code formatting with `gofmt`\n- **Example Testing**: Tests both RLNC and Reed-Solomon network examples for network functionality\n\n## Architecture\n\n### Core Components\n\n- **host/**: Low-level QUIC networking with TLS authentication\n- **pubsub/**: Publish-subscribe system managing topics and peer communication\n- **floodsub/**: FloodSub router implementing message flooding with deduplication (baseline protocol)\n- **ec/**: Erasure coding router and implementations\n  - **ec/encode/**: Generic encoder interface and implementations for different erasure coding schemes\n    - **ec/encode/rlnc/**: Random Linear Network Coding encoder with linear combinations over finite fields\n    - **ec/encode/rlnc/verify/**: Pluggable chunk verification system including Pedersen commitments\n    - **ec/encode/rs/**: Reed-Solomon encoder with systematic MDS property for predictable erasure coding\n  - **ec/field/**: Finite field arithmetic library supporting prime and binary fields\n  - **ec/group/**: Group operations for cryptographic primitives (Ristretto255)\n- **pb/**: Protocol buffer definitions for RPC communication\n\n### Message Flow\n\n1. **Host Layer**: Establishes QUIC connections between peers\n2. **PubSub Layer**: Manages topic subscriptions and routes messages\n3. **Router Layer**: Implements specific broadcast algorithms (FloodSub or EC with pluggable encoders)\n4. **Encoder Layer**: Handles message chunking, encoding, and reconstruction (RLNC, Reed-Solomon, etc.)\n5. **Application**: Publishes/subscribes to topics through the router\n\n## License\n\nThis project is licensed under the GNU General Public License v3.0 - see the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fppopth%2Fminiature-enigma","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fppopth%2Fminiature-enigma","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fppopth%2Fminiature-enigma/lists"}