ElectrumSV SDK
Project description
ElectrumSV Software Development Kit
This project provides a consolidated set of resources that together can allow a developer, whether working on ElectrumSV directly or on an application based on ElectrumSV, to develop, run and test while offline (and is especially aimed at facilitating rigourous CI/CD functional testing).
Licence: The Open BSV License
Maintainers: Roger Taylor, AustEcon
Project Lead: Roger Taylor
Language: Python (>=3.7)
Homepage: https://electrumsv.io/
Documentation
Detailed documentation is hosted here
Basic Instructions
To install from pypi:
> pip install --upgrade electrumsv-sdk
Now you have global access to a script called 'electrumsv-sdk.exe' from any console window.
For help:
> electrumsv-sdk --help
Note: You must run electrumsv-sdk install <component type>
first for each component type. This may require system dependencies
you also need - please read the documentation.
If you want help for one of the subcommands (e.g. 'start') do:
> electrumsv-sdk start --help
Which will show:
usage: electrumsv-sdk start [-h] [--new] [--gui] [--background] [--inline] [--new-terminal] [--id ID] [--repo REPO] [--branch BRANCH] {electrumsv,electrumx,merchant_api,node,status_monitor,whatsonchain,whatsonchain_api} ...
positional arguments:
{electrumsv,electrumx,merchant_api,node,status_monitor,whatsonchain,whatsonchain_api}
subcommand
electrumsv start electrumsv
electrumx start electrumx
merchant_api start merchant_api
node start node
status_monitor start status_monitor
whatsonchain start whatsonchain
whatsonchain_api start whatsonchain_api
optional arguments:
-h, --help show this help message and exit
--new run a new instance with unique 'id'
--gui run in gui mode (electrumsv only)
--background spawn in background
--inline spawn in current shell
--new-terminal spawn in a new terminal window
--id ID human-readable identifier for component (e.g. 'worker1_esv')
--repo REPO git repo as either an https://github.com url or a local git repo path e.g. G:/electrumsv (optional)
--branch BRANCH git repo branch (optional)
Note: The "optional arguments" come before specifying the component_type
e.g.:
> electrumsv-sdk start --new --id=myspecialnode node
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distributions
Hashes for electrumsv_sdk-0.0.33-py3-none-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8c56bd720b840dd154d2d7c95fcbd104e05fa2d64d5f46f6c006fb1ee265e729 |
|
MD5 | bddd879eb24c2ed5705046c57d30d046 |
|
BLAKE2b-256 | 2176b9304caf96317586a47c0cddc9bac7f43585291630807efb620f1cfd62c8 |
Hashes for electrumsv_sdk-0.0.33-py3-none-win32.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c0f301ea5a414ae03284e538bcabc46575c3300a2b2722cd90b8f48a461b810b |
|
MD5 | c7e522d5becb45e9fcf7d9de81e2bade |
|
BLAKE2b-256 | e9899c6bcabaa07b841d8dcbf2926e34cdc5b708d00479ec6380ebc8b7ca3791 |
Hashes for electrumsv_sdk-0.0.33-py3-none-manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fd3361ecae88098036310397029605205817f2ab44cbdd7672a74f05413fee5c |
|
MD5 | cae49fe2598fffaa02d4de04a77a299d |
|
BLAKE2b-256 | cb9dffbcfd3861e8aaa25f42dcb31e6f1a11620c0e3a2b6977065e4771bcd715 |
Hashes for electrumsv_sdk-0.0.33-py3-none-macosx_10_5_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 893d6fb3241a238e5508b932dcf4791a78467a29aee0f25767a8f87b306115a5 |
|
MD5 | 061f84509c9cb88c4407aa4d55ece7e1 |
|
BLAKE2b-256 | 054b80e21bd8ae68d331bd77066fe47f8ae4c3256db2109e5c1b51fdffc96a3d |