Welcome to AdPay’s documentation!

What is AdPay?

AdPay is an element in the Adshares network. It calculates payments for individual events, based on:

• campaign budget,
• total events for this campaign in given period of time,

• individual event worth, which can be calculated based on:

  • event type,
  • user value,
  • human score.

User Guide

Goal of AdPay

Provide AdServer with payment calculations, ie. answer the question: how much to pay for those events?

Architecture

AdPay is a Twisted app, backed by MongoDB and communicating with AdServer using a JSON-RPC interface.

Python stack is as follows:

• Twisted for the core network communication and asynchronous event handling
• txmongo for asynchronous MongoDB communication
• fastjsonrpc for JSON-RPC protocol
• jsonobject for easy JSON-Python object mapping

Development

Extending functionality

All the payment calculations happen in the adpay.stats module, so if you want to change the algorithms, you’ll need to rewrite that part of the code.

The calculations are run periodically. The main function for each run is the adpay.stats.tasks._adpay_task(). Calculation functions can be found in adpay.stasts.utils.

Table of contents

• How it works
  • Payment calculation process
  • In detail
  • User share
• API description
  • JSONRPC basics
    • Simple example
    • Error responses
  • API methods
    • campaign_update
    • campaign_delete
    • add_events
    • get_payments
  • Protocol objects
• Reference
  • adpay package
    • Subpackages
      • adpay.db package
        • adpay.db.utils module
        • Module contents
      • adpay.iface package
        • adpay.iface.server module
        • adpay.iface.utils module
      • adpay.stats package
        • adpay.stats.cache module
        • adpay.stats.tasks module
        • adpay.stats.utils module
      • adpay.utils package
        • adpay.utils.utils module
    • Module contents
  • daemon.py
• Testing
• Configuration
  • Calculations (adpay.stats.consts)
  • Database (adpay.db.const)
  • Interface (adpay.iface.consts)
  • Utilities (adpay.utils.consts)
  • Logging
• Deployment
  • Getting the code
  • Requirements
    • Python
    • PIP (Python package manager)
    • Pipenv
    • Project Python dependencies
    • Additional requirements
  • Quick requirements install
  • Start the server
  • Other deployment configurations
    • Supervisord
    • Docker
• Contributing
  • Code and issues
  • Installation for development
  • Documentation
  • Tests

Indices and tables

• Index
• Module Index
• Search Page