cryptoassets.core
  • Community and resources
  • Installation
    • Installing cryptoassets.core package
      • Requirements
      • Create a virtualenv
        • OSX
        • Ubuntu / Debian
      • Installing cryptoassets package
        • Installing the release version
        • Installing the development version
  • Getting started
    • Introduction
    • Benefits
    • Basics
      • Interacting with cryptoassets.core
    • Example command-line application
      • Install cryptoassets.core
      • Application code
      • Example configuration
      • Creating the database structure
      • Running the example
      • Obtaining testnet Bitcoins and sending them
    • After completing the example
      • Django integration
      • More about SQLAlchemy
      • Questions?
  • Service and commands
    • Introduction
    • cryptoassets-helper-service
      • Running the service with Python project
      • Running the service with Django
      • Status server
      • System service integration
    • cryptoassets-initialize-database
    • cryptoassets-scan-received
  • Configuration
    • Introduction
    • Creating application object and configuring it
      • Configuring using YAML configuration file
      • Configuring using Python dict
    • Configuration sections
      • database
        • url
        • echo
      • coins
        • models
        • testnet
        • max_confirmation_count
        • backend
        • walletnotify
      • events
      • status_server
        • ip
        • port
      • service
        • broadcast_period
        • logging
  • Application and API service support
    • Introduction
      • Running your cryptocurrency daemon (bitcoind)
      • Using API service
    • Configuration
    • Backends
      • bitcoind
        • Wallet notifications
        • HTTP webhook for bitcoind
        • Named UNIX pipe for bitcoind
        • Redis pubsub for bitcoind
      • block.io
        • Wallet notifications over websockets
        • Wallet notifications over web hooks (HTTP)
      • blockchain.info
      • null
  • Cryptocurrency and asset support
    • Introduction
    • Bitcoin
    • Dogecoin
    • AppleByte
  • API documentation
    • Base models
      • Cryptoasset registry
      • Default models
      • Model API conventions
        • Model discovery
        • Session lifecycle
      • Model classes
        • Account
        • Address
        • Transaction
        • NetworkTransaction
        • Wallet
      • Validation
    • Configuration and setup
      • Introduction
      • Config coding conventions
      • Cryptoassets Application
      • Configuration API
    • Events
      • Introduction
      • Events types
      • Event handlers
        • HTTP webhook
        • In-process Python
        • Shell script
      • Incoming transaction confirmation updates
    • Tools and asset management
      • Transaction confirmation count updates
      • Broadcasting outgoing transactions
      • Rescan receiving addresses
      • Importing existing wallet
    • Cryptoassets helper service
      • Service main
    • Backends
      • Introduction
      • Backend base class
      • Transaction updater
    • Utilities
      • Introduction
      • Transaction conflict resolver
        • Preface
        • Benefits and design goals
        • Transaction retries
        • Example
        • Rules and limitations
        • Compatibility
        • API documentation
      • Automatic enumeration classes
      • Python dictionary deep merge
      • HTTP event listener decorator
      • Ngrok automatic HTTP endpoint tunneling
        • Installation
        • Ngrok tunnel code
        • Example code
        • Other
    • Cryptocurrency models
      • Introduction
      • Bitcoin
      • Dogecoin
      • Litecoin
      • AppleByte
    • Unit tests
      • Introduction
      • Backend tests
  • Extending
    • Introduction
    • Adding new cryptocurrency model
    • Adding new cryptocurrecy backend
    • Overriding parts of the framework
  • Security and data integrity
    • Introduction
    • Eliminating race conditions
      • Transaction conflict handling
    • Data separation
    • Data integrity on failed broadcasts
    • Missed incoming transactions
    • Missed transactions confirmations
    • Choosing your database
  • Developing cryptoassets.core
    • Running tests
      • Testing prerequisites
      • Examples for running tests
    • Bitcoind testnet
      • Setting up TESTNET bitcoind on OSX
      • Building bitcoind on Ubuntu
      • Topping up bitcoind
      • Testnet faucet
      • Dumping your TESTNET private address for importing in tests
      • Using bitcoind with multiple backends
      • Conflicted transactions
    • Continuous integration
      • Full CI test suite
    • Releases
 
cryptoassets.core
  • Docs »
  • API documentation
  • Edit on Bitbucket

API documentationΒΆ

Warning

readthedocs.org has issues building Python API documentation at the moment. This issue is being investigated. Meanwhile you can checkout cryptoassets.core source, install Sphinx package and run “make html” to build docs yourself.

Contents:

  • Base models
    • Cryptoasset registry
    • Default models
    • Model API conventions
    • Model classes
    • Validation
  • Configuration and setup
    • Introduction
    • Config coding conventions
    • Cryptoassets Application
    • Configuration API
  • Events
    • Introduction
    • Events types
    • Event handlers
    • Incoming transaction confirmation updates
  • Tools and asset management
    • Transaction confirmation count updates
    • Broadcasting outgoing transactions
    • Rescan receiving addresses
    • Importing existing wallet
  • Cryptoassets helper service
    • Service main
  • Backends
    • Introduction
    • Backend base class
    • Transaction updater
  • Utilities
    • Introduction
    • Transaction conflict resolver
    • Automatic enumeration classes
    • Python dictionary deep merge
    • HTTP event listener decorator
    • Ngrok automatic HTTP endpoint tunneling
  • Cryptocurrency models
    • Introduction
    • Bitcoin
    • Dogecoin
    • Litecoin
    • AppleByte
  • Unit tests
    • Introduction
    • Backend tests
Next Previous

© Copyright 2015 Mikko Ohtamaa.

Built with Sphinx using a theme provided by Read the Docs.