Skip to main content
Join the official 2020 Python Developers SurveyStart the survey!

BitShares delegate tools

Project description

There are 2 tools currently provided:

  • command line util allowing to quickly build and run the bitshares client
  • web app allowing to monitor a running instance of the client and send an email or push notification on failure

If you like these tools, please vote for my delegate to support further development, and feel free to visit my page for other delegate proposals at Thanks!

Command-line client

just run the bts script with the command you want to execute:

$ bts -h
usage: bts [-h] [-r]
           [environment] [hash]

following commands are available:
  - clean_homedir    : clean home directory. WARNING: this will delete your wallet!
  - clean            : clean build directory
  - build            : update and build bts client
  - build_gui        : update and build bts gui client
  - run              : run latest compiled bts client, or the one with the given hash or tag
  - run_gui          : run latest compiled bts gui client
  - list             : list installed bitshares client binaries
  - monitor          : run the monitoring web app

  $ bts build      # build the latest bts client by default
  $ bts run
  $ bts run debug  # run the client inside gdb

  $ bts build dns v0.0.4  # build a specific version
  $ bts run seed-dns      # run environments are defined in the config.yaml file

  $ bts build_gui
  $ bts run_gui

positional arguments:
                        the command to run
  environment           the build/run environment (bts, dns, ...)
  hash                  the hash or tag of the desired commit

optional arguments:
  -h, --help            show this help message and exit
  -r, --norpc           run binary with RPC server deactivated

You should also look into ~/.bts_tools/config.yaml to tune it to your liking.

Monitoring web app

To run the debug/development monitoring web app, just do the following:

$ bts monitor

and it will launch on localhost:5000.

For production deployments, it is recommended to put it behind a WSGI server, in which case the entry point is bts_tools.wsgi:application.

Do not forget to edit the ~/.bts_tools/config.yaml file to configure it to suit your needs.


Monitoring the status of your running bts client binary

Status screenshot

Monitoring multiple instances at the same time, to have an overview while running backup nodes and re-compiling your main node.

Info screenshot

Things to know (best practices and “issues”) READ IT !!!

  • to properly build the bitshares client in MacOSX:
    • you can (and should) build the binary with only homebrew libraries (boost, etc.). Previous versions had trouble compiling and could require you to hand-compile some dependencies, but newer homebrew libs should compile properly
    • readline needs to be installed by brew and you need to run brew link --force readline to take precedence over the outdated version of the system
  • when running the web client in uWSGI, make sure to:
    • set enable-threads = true, otherwise you won’t get the monitoring thread properly launched
    • set lazy-apps = true, otherwise the stats object will not get properly shared between the master process and the workers, and you won’t get any monitoring data
    • set workers = 1, otherwise you will get multiple instances of the worker thread active at the same time

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for bts_tools, version 0.1.3
Filename, size File type Python version Upload date Hashes
Filename, size bts_tools-0.1.3.tar.gz (343.8 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page