bet

Pangea-Bet Documentation

This directory contains comprehensive documentation for the Pangea-Bet platform. Documentation is organized into logical sections based on your needs.

Quick Navigation

Getting Started

• Installation & Setup - Building from source and installation
• Pre-compiled Binaries - Download and setup pre-built binaries
• Node Configuration - Configure dealer, player, and cashier nodes

Configuration Guides

• Dealer Configuration - Dealer node setup and settings
• Player Configuration - Player node setup and settings
• Cashier Configuration - Cashier node setup and settings

Architecture & Protocol

• System Architecture - Layered architecture and RPC abstraction
• Verus Migration Guide - Overview of Verus ID-based architecture
• ID Creation Process - Creating and managing Verus IDs
• Keys and Data Structure - VDXF key structure and data storage
• Node Communication - How nodes communicate via Verus IDs
• Transaction Flow - Transaction types and flow during gameplay
• GUI Message Formats - WebSocket API for GUI communication

Advanced Topics

• Game State Management - How game state is stored and retrieved
• Dispute Resolution - Handling disputes and transaction verification
• Player Rejoining - Player disconnection and reconnection
• Dealer Rejoining - Dealer disconnection scenarios

Reference

• Glossary - Terminology and abbreviations
• Transaction Types - Detailed transaction reference
• Upgrade Guide - API compatibility and upgrade notes

Documentation Structure

docs/
├── README.md (this file)
├── protocol/              # Protocol specifications and general documentation
│   ├── compile.md         # Build and installation instructions
│   ├── release.md         # Pre-compiled binaries and releases
│   ├── dealer_configuration.md
│   ├── player_configuration.md
│   ├── cashier_configuration.md
│   ├── node_communication.md
│   ├── tx_flow.md
│   ├── GUI_MESSAGE_FORMATS.md
│   └── ...
└── verus_migration/       # Verus ID architecture and migration
    ├── architecture.md    # System architecture and RPC abstraction
    ├── verus_migration.md # Migration overview
    ├── id_creation_process.md
    ├── ids_keys_data.md
    ├── game_state.md
    └── ...

Finding What You Need

New to Pangea-Bet?

1. Start with Installation & Setup

2. Configure your node type: Dealer

   Player

   Cashier

3. Understand the architecture: Verus Migration Guide

Setting up a node?

• Dealer Setup
• Player Setup
• Cashier Setup

Understanding how it works?

• Verus Migration Overview
• Node Communication
• Transaction Flow

Developing or integrating?

• System Architecture - Understand the layered design
• GUI Message Formats
• API Reference
• Transaction Types

Troubleshooting?

• Common Setup Errors
• Dispute Resolution
• Player Rejoining

---

For the main project README, see ../README.md.