Skip to content

ErgoDocs

Desktop

Initializing search

Introduction
Ecosystem
Developers
Miners

ErgoDocs

Introduction
Introduction
- Why Ergo
- Key Features
  Key Features
  - Protocol
  - eUTxO
    
    eUTxO
    
    UTxO vs Account
    
    Atomic Swaps
  - NIPoPoWs
    
    NIPoPoWs
    
    Light Clients
    
    Light Miners
    
    Sidechains
  - Privacy
  - Storage Rent
  - Autolykos
- Research & Whitepapers
- Roadmap
  Roadmap
  - Scaling
    
    Scaling
    
    Layer 0
    
    Layer 0
    
    Sub Blocks
    
    Layer 1
    
    Layer 2
    
    Discussions
    Discussions
    
    Roadmaps
    
    Transactions Per Second
    
    Atomic Composability
- Entities
  Entities
  - Ergo Foundation
    
    Ergo Foundation
    
    Scope
    
    Treasury
    
    Future
  - DevDao
  - Sigmanauts
- Events
  Events
  - ERGOHACK
  - ErgoSummit
- Contribute
  Contribute
  - Developers
    
    Developers
    
    Bounties
    
    Grants
    
    Roles
  - Marketing
  - Sigmanauts
  - Contribute to the docs!
- Wallets
- Resources
  Resources
Ecosystem
Ecosystem
- Infrastructure
  Infrastructure
  - Rosen Bridge
    
    Rosen Bridge
    
    Watchers
    
    Watchers
    
    Prerequisites
    
    Ergo Watcher
    
    Bitcoin Watcher
    
    Guards
    
    Tokenomics
    
    Team
    
    Uses
    
    Uses
    
    rsERG-LP
    
    Token Integration Guides
  - Oracles
    
    Oracles
    
    Oracle Pools V2
    
    Mixicles
  - Sidechains
    
    Sidechains
    
    Sub Blocks
    
    Sigma Chains
    
    PoUW
- Financial
  Financial
  - Decentralized Exchanges
    
    Decentralized Exchanges
    
    Spectrum Finance
    
    Trade House
    
    Palmyra
    
    Crystal Pool
    
    Machina Finance
    
    Mew Finance
    
    P2P
    
    P2P
    
    Token Jay
    
    Analog Ergo
    
    Single Tx Swap
  - Monetary Systems
    Monetary Systems
    
    SigmaUSD
    
    ChainCash
    
    Gluon
    
    DexyGold
    
    Local Exchange Trading Systems
    
    Local Exchange Trading Systems
    
    Basic Implementation
    
    Trustless LETS
  - Decentralized Finance
    Decentralized Finance
    
    Lending
    
    Lending
    
    duckpools
    
    EXLE
    
    SigmaFi
    
    Derivatives and Synthetics
    
    Derivatives and Synthetics
    
    Hodlbox
    
    HodlCoin
    
    AuctionCoin
    
    OptionCoin
    
    OptionPools
    
    SigmaO
    
    Crowdfunding
    
    Crowdfunding
    
    ErgoRaffle
    
    Sigma Subscriptions
  - Degenerate Finance
    
    Degenerate Finance
    
    Hodlcoin
    
    Auction Coin
    
    Grand Gambit
    
    Hodlbox
    
    OptionCoin
    
    Obolflip
    
    Lotteries
    
    The Field
- NFTs
  NFTs
- Gaming
  Gaming
  - BlitzTCG
  - Cyberverse
- Tooling
  Tooling
- Applications
  Applications
  - Thz.FM
  - TabbyPOS
  - PandaV
  - ZenGate Global
    
    ZenGate Global
    
    Solaris Portal
    
    Cyberiad
- Privacy
  Privacy
  - Mixing
    
    Mixing
    
    ErgoMixer
    
    ErgoMixer
    
    Identifiability
    
    Best Practices
    
    FAQ
    
    Token
    
    Install on Android
    
    SigmaJoin
  - Stealth Addresses
- DAOs
  DAOs
  - Paideia
  - ErgoPad
  - The Field
  - Thz.FM
- Miners
  Miners
  - Lithos
  - GuapSwap
  - CYTI
- Further Ideas
  Further Ideas
  - Profit Sharing
  - Email Client for Blocked Internet
  - Flash Loans
  - Prediction Markets
  - Insurance
  - Micro Credit
  - Mutual Credit
  - Bonding Curve
  - Tokens
    Tokens
    
    ICOs
    
    Index Coins
    
    PoW Tokens
    
    Perpetual Tokens
    
    Buy Back Guarantees
- Standards
  Standards
Developers
Developers
- 📌 Getting Started
  📌 Getting Started
  - Students
- Data Model
  Data Model
  - Box
    
    Box
    
    Registers
    
    Assets
    Assets
    
    Tokens
    
    Tokens
    
    Creating a perpetual token
    
    Burning a token
    
    Non-Fungible Tokens
    
    Non-Fungible Tokens
    
    Minting a NFT
    
    Minting a NFT
    
    Design V1 v V2
    
    Simple Example
    
    On-chain NFTs
    
    Royalties
    
    Singletons
    
    Standards
    Standards
    
    Asset Standard
    
    Geniune Token Verification
    
    Auction Contract
    
    Artwork Contract
    
    Modelling
  - Addresses
    
    Addresses
    
    Types
    
    Validation
  - Transactions
    
    Transactions
    
    Composing Transactions
    
    Composing Transactions
    
    Sending A Chained Transaction
    
    Interacting with an Ergo Wallet
    Interacting with an Ergo Wallet
    
    Format
    
    Merkle Tree
    
    Signing
    
    Signing Backend
    
    Validation
    
    Data Inputs
    
    Fees
    
    Unified Transactions
    
    Resources
    Resources
    
    Standards
    Standards
    
    Babel Fees
    
    Proxy Contracts
    
    ErgoPay Protocol
    
    Payment Request URI
    
    Just-In-Time Costing
    
    ErgoTool
    
    Model Transaction
    
    Payments
  - Block
    
    Block
    
    Extension Section
- Infrastructure
  Infrastructure
  - Node
    
    Node
    
    Setup
    
    Setup
    
    Troubleshooting
    
    FAQ
    
    Pi
    
    Android
    
    Docker
    
    Testnet
    
    Testnet
    
    Full Sync
    
    CPU Mining
    
    Fork your own chain
    
    Resources
    
    Protocol
    
    Protocol
    
    P2P
    
    P2P
    
    Handshaking
    
    Network Messages
    
    Peer Management
    
    Modifiers
    
    Modifiers
    
    Modifiers Exchange
    
    Modifiers Processing
    
    Modifiers Validation
    
    Synchronisation
    
    EIPs
    
    Configuration
    Configuration
    
    Node Wallet
    
    Node Wallet
    
    Hierarchical keys
    
    Wallet Setup
    
    Swagger API
    
    Swagger API
    
    OpenAPI Spec
    
    Try it out!
    
    Indexed Node API
    
    Configuration Files
    Configuration Files
    
    application.conf
    
    application.conf
    
    ergo
    ergo
    
    node
    
    cache
    
    chain
    
    wallet
    
    voting
    
    bounded-mailbox
    
    akka
    
    scorex
    
    critical-dispatcher
    
    api-dispatcher
    
    testnet.conf
    
    testnet.conf
    
    devnet.conf
    
    Tor
    
    Modes of Operation
    
    Modes of Operation
    
    Archival Full Node
    
    Archival Full Node
    
    Technical Details
    
    Pruned Full Node
    
    Pruned Full Node
    
    Technical Details
    
    Light Full Node
    
    Light Full Node
    
    Digest State
    
    blocksToKeep
    
    Technical Details
    
    Light SPV
    
    Light SPV
    
    Simplified Payment Verification
    
    Technical Details
  - Explorer
    
    Explorer
    
    Local Setup
    
    Pi Blockchain Explorer
    
    GraphQL
  - APIs
  - Off-Chain
    
    Off-Chain
    
    Oracle-Core
    
    Oracle-Core
    
    Bootstrap an Oracle Pool
    
    Off-Chain Bots
    
    Rust Utilities
    
    Plasma
  - Wallets
    
    Wallets
    
    Types
    Types
    
    Satergo
    
    Nautilus
    
    Minotaur
    
    Minotaur
    
    Multi-Sig
    
    SAFEW
    
    Ledger
    
    Resources
    Resources
    
    Access Issues
    
    MultiSig
    
    Standards
    Standards
    
    UTXO-Set Scanning Wallet API
    
    Deterministic Wallet Standard
    
    Cold Wallet
  - Integration Guide
- Tooling
  Tooling
  - Pathways
    Pathways
    
    Development Stack
    
    Development Stack
    
    Starter Tutorial
    
    Server
    
    Browser
    
    Desktop Desktop
    Table of contents
    
    Platforms
    
    Examples
    
    Mobile
    
    Mobile
    
    iOS
    
    Android
    
    Programming Languages
    Programming Languages
    
    JVM
    
    JVM
    
    Scala
    
    Java
    
    Kotlin
    
    JavaScript
    
    Rust
    
    Others
    Others
    
    Python
    
    C#
    
    Go
  - Frameworks
    
    Frameworks
    
    AppKit
    
    AppKit
    
    Tutorial
    
    Interacting with a local Node
    
    Gradle
    
    Using Appkit from Python
    
    SigmaRust
    
    Fleet (JS)
    
    FleetSharp
    
    Others
    Others
    
    Ergpy
    
    RustKit
    
    Mosaik
    
    Mosaik
    
    Tutorial
    
    Tutorial
    
    A simple UI
    
    Processing data
    
    ErgoPay
    
    Web UI
    
    Deployment
    
    Example apps
    
    JSON dApp Environment
    
    Headless dApp Framework
    
    Headless dApp Framework
    
    Modules
  - Payments
    Payments
    
    ErgoPay
    ErgoPay
    
    ErgoPay
    
    Tutorial
    
    ErgoAuth
    
    dApp Connector
    
    Proxy Contracts
    
    Proxy Contracts
    
    Assembler
  - Libaries
    
    Libaries
    
    Plasma
    
    Scrypto
    
    EIP12-Types
    
    SigmaJS
- ErgoScript
  ErgoScript
  - Sigma Language
    
    Sigma Language
    
    Core Concepts
    
    Simple Syntax
    
    Language Description
    
    Sigma Propositions
    
    SigmaBoolean
    
    The Blockchain context
    
    Accessing boxes and registers
    
    Global Functions
    
    Language Operations
    
    Interacting with an Ergo Wallet
    Interacting with an Ergo Wallet
    
    Format
    
    Merkle Tree
    
    Signing
    
    Signing Backend
    
    Validation
    
    Data Inputs
    
    Fees
    
    Unified Transactions
    
    Examples
    Examples
    
    Public Contracts
    
    Anyone Can Spend
    
    No-one-Can Spend
    
    Context Variables
    
    Code-blocks
    
    Public-keys
    
    Functional Programming
    
    Box Structure
    
    Storing Data
    
    Creating a simple P2S app
  - Tooling
    
    Tooling
    
    Interpreters & Compilers
    
    Interpreters & Compilers
    
    Compiler Phases
    
    sigmastate-interpreter
    
    sigma-rust
    
    ErgoScala
    
    CLI Compiler
    
    Playgrounds
    Playgrounds
    
    Scastie
    
    P2S Playground
    
    Kiosk
    
    ErgoPuppet
    
    Debugging
    
    FlowCards
  - ErgoTree
    
    ErgoTree
    
    Introduction
    
    As a Language
    
    Typing
    
    Evaluation
    
    Serialization
    
    Predefined Types
    
    Predefined Functions
    
    Encoding
    
    Script Validation
    
    Script Optimisation
    
    Templates
  - Features
    Features
    
    Data Inputs
    
    Multi-Stage Protocols
    
    Multi-Stage Protocols
    
    Transaction Chains
    
    Transaction Trees
    
    Transaction Graphs
    
    Context Enrichment
    
    Examples
    Examples
    
    Reversible Address
    
    Rock/Paper/Scissors
    
    ICO
- Cryptographic
  Cryptographic
  - Sigma Protocols
    
    Sigma Protocols
    
    Schnorr
    
    Schnorr
    
    Verifying Schnorr Signatures
    
    Diffie
    
    Ring Signatures
    Ring Signatures
    
    3-out-of-5 Threshold Signature
    
    Distributed Signatures
    
    ZeroJoin
  - Data Structures
    
    Data Structures
    
    Merkle Tree
    
    Merkle Tree
    
    Format
    
    Validation
    
    Implementations
    Implementations
    
    Extension Block Merkle
    
    Transaction Merkle Trees
    
    Merkle Batch Proofs
    
    Merkle Batch Proofs
    
    Implementation
    
    Testing
    
    Lightweight Client Proofs
    
    AVL Trees
    
    AVL Trees
    
    Plasma
    
    Proof of Proof-of-Work
    
    Proof of Proof-of-Work
    
    Interlink Vectors
Miners
Miners
- Autolykos
  Autolykos
  - Algorithm
    
    Algorithm
    
    Emission
    
    Emission
    
    EFYT
    
    Difficulty Adjustment
    
    Solution Verification
    
    Technical Breakdown
  - Storage Rent
    
    Storage Rent
    
    Fees
    
    Tokens
    
    Spending
    
    State Growth
  - ASIC Resistance
  - Resources
    
    Resources
    
    CPU vs GPU
    
    EIPs
    EIPs
    
    Emission Retargeting Soft-Fork
    
    Tweaking Difficulty Adjustment Algorithm
- Start Mining
  Start Mining
  - Software
  - Operating Systems
  - Overclocking
  - Pools
  - Solo Mining
    
    Solo Mining
    
    Node Configuration
    
    Withdraw
    
    FAQ
  - Host a Pool
    
    Host a Pool
    
    Stratum
    
    MiningCore
- Governance
  Governance
  - Voting
  - Forking
    
    Forking
    
    Soft Forks
    
    Velvet Forks
    
    Hard Forks
- Revenue
- Tooling
  Tooling
  - GuapSwap
  - Lithos
    
    Lithos
    
    SNISPs
  - CYTI
  - Log-Space Mining
  - Smartpools
    
    Smartpools
    
    Subpooling

Table of contents

Platforms
Examples

Desktop#

Platforms#

JVM

JavaFX

Rust

JS/TS + Electron

Python

Examples#

🔗 Ergo Wallet

🔗 ErgoMixer

🔗 Satergo

Made with Material for MkDocs