Gnosis Apollo is a collection of packages that allows you to roll your own Prediction Market Interface or Prediction Market Tournament based on the Gnosis Prediction Market Framework.

It consists of the pm-contracts, pm-js, pm-trading-db and pm-trading-ui.

Gnosis Apollo

Documents

• Introduction
• Getting Started
  • Requirements
  • Create the market
  • Run the Ethereum Indexer
  • Setup the interface
• Prediction markets as a modular framework
  • Trading UI
  • Ethereum Indexer
  • Javascript Library
  • Smart Contracts

Create Prediction Markets

• PM-SCRIPTS
  • Configuration
  • Deploy markets
    • Params
  • Resolve Markets

Javascript/Node.js library

• PM-JS
  • Install
  • Browser use
• PM-JS usage
  • Buy all outcomes
  • Automated market maker
• PM-JS Integrations
  • Integration with webpack projects (advanced)
  • Setting up an Ethereum JSON RPC
    • Ganache-cli and private chain providers
    • MetaMask
  • Note about Promises
  • Truffle contract abstractions
  • Note about async and await
  • Wrapping common operations
  • Web3 options
  • Gas estimations
  • (Advanced) Notes for developers who use web3
• LMSR Primer
  • Bounded Loss from the \(b\) Parameter
  • Marginal Price of Outcome Tokens
  • LMSR Calculation Functions

PM Trading DB (Ethereum Indexer)

• Trading DB
  • Docker-compose
  • Docker
  • Kubernetes
    • Database configuration
    • Queue and Cache
    • TradingdDB services
  • Bare metal
• Configuration Parameters
  • DJANGO_DEBUG
  • DATABASE_URL
  • CELERY_BROKER_URL
  • ETH_BACKUP_BLOCKS
  • ETH_PROCESS_BLOCKS
  • ETH_FILTER_MAX_BLOCKS
  • ETHEREUM_NODE_URL (mandatory in production)
  • ETHEREUM_MAX_WORKERS
  • ETHEREUM_MAX_BATCH_REQUESTS
  • IPFS_HOST
  • IPFS_PORT
  • ALLOWED_HOSTS
  • LMSR_MARKET_MAKER
  • CENTRALIZED_ORACLE_FACTORY
  • EVENT_FACTORY
  • MARKET_FACTORY
  • GENERIC_IDENTITY_MANAGER_ADDRESS (Olympia related)
  • TOURNAMENT_TOKEN (Olympia related)
  • ETHEREUM_DEFAULT_ACCOUNT_PRIVATE_KEY (Olympia related)
  • TOURNAMENT_TOKEN_ISSUANCE (Olympia related)
  • ISSUANCE_GAS (Olympia related)
  • ISSUANCE_GAS_PRICE (Olympia related)
• Extend TradingDB (ADVANCED)
  • Implement Python event receiver
  • Add contract ABI
    • Configure custom event receiver

PM Trading UI

• Setting Up the Interface
  • Setup
  • Configuration
  • Basic Configuration Documentation
    • Trading DB
    • Ethereum Node
    • Gas Price Calculation
    • Market Creator Whitelist
    • Logo and Favicon
    • Tournament Mode
    • Define a Collateral Token
    • Wallet Integrations
    • Legal Compliance
    • Page Footer
    • Reward Claiming
    • Badges and Levels
    • Thirdparty Services
    • WIP: KYC/AML Customer Verification
    • Misc Constants
• Tournament Reward Claiming
  • Deploying RewardClaimHandler using MyEtherWallet
  • Deploying RewardClaimHandler using Truffle and pm-apollo-contracts
    • If you want to use a private key
    • Or if you want to use a mnemonic phrase
  • Filling the contracts with winners and prize amounts
  • Configuring the interface

Tournament Operator Guide

• Tournament Operator Guide
• Set up contracts
  • Create Ethereum Accounts
  • Tournament Contracts
    • Deploy
    • Validate Contracts
    • Configure Contracts.
  • Deploy Markets with pm-scripts
  • TradingDB
  • Trading Interface
    • Configuration Template
  • Market Resolution
  • Reward Claiming
    • Configure Reward Claiming on the Interface
    • Enable Reward Claiming.

Related Github projects

• Smart contracts: https://github.com/gnosis/pm-contracts
• Javascript library: https://github.com/gnosis/pm-js
• Prediction Markets Interface: https://github.com/gnosis/pm-trading-ui
• Database Indexer: https://github.com/gnosis/pm-trading-db
• Tournament Smart Contracts: https://github.com/gnosis/pm-apollo-contracts