Skip to main content

BitShares delegate tools

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 digitalgaia.io. Thanks!

Documentation

The main documentation for the tools, as well as a tutorial, can be found on ReadTheDocs.

Command-line client

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

$ bts -h
usage: bts [-h] [-r]
           {version,clean_homedir,clean,build,build_gui,run,run_gui,list,monitor,publish_slate}
           [environment] [args [args ...]]

following commands are available:
  - version          : show version of the tools
  - 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 bts client binaries
  - monitor          : run the monitoring web app
  - publish_slate    : publish the slate as described in the given file

Examples:
  $ bts build          # build the latest bts client by default
  $ bts build v0.4.27  # build specific version
  $ bts run
  $ bts run debug  # run the client inside gdb

  $ bts build pts-dev v2.0.1  # build a specific client/version
  $ bts run seed-test         # run environments are defined in the config.yaml file

  $ bts build_gui
  $ bts run_gui

  $ bts publish_slate                      # will show a sample slate
  $ bts publish_slate /path/to/slate.yaml  # publish the given slate


positional arguments:
  {version,clean_homedir,clean,build,build_gui,run,run_gui,list,monitor,publish_slate}
                        the command to run
  environment           the build/run environment (bts, pts, ...)
  args                  additional arguments to be passed to the given command

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.

Screenshots

Monitoring the status of your running bts client binary

Status screenshot

You can host multiple delegates accounts in the same wallet, and check feed info

Info screenshot

Monitoring multiple instances (ie: running on different hosts) at the same time, to have an overview while running backup nodes and re-compiling your main node.

Info screenshot

Metadata

Release files for bts_tools 0.2.9

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for bts_tools 0.2.9
File Size Uploaded Provenance Actions
bts_tools-0.2.9.tar.gz 355.9 kB Without provenance Details for bts_tools-0.2.9.tar.gz

Release files / bts_tools-0.2.9.tar.gz

Download URL bts_tools-0.2.9.tar.gz
Size 355.9 kB
Tags Source
SHA-256 checksum
How to use checksums
096f0edfa605bf426b68ac4a9df72a863c413a6bc3845428296d7c8b7ab763bb
BLAKE2b-256 checksum
How to use checksums
782e0d92ea45dbc49290fef98d2c050f8f1437df4bae479d9b5229a1873dfb81
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for bts_tools 0.2.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

0.4.2

This release

0.2.9 This release

1 release file No provenance

0.2.5

0.1.2

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page