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.9)
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.34-py3-none-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e338566cbaed8735a0868bac5888d6eec1eece907d4dd65bd7b9e6b3a52cd84e |
|
MD5 | b88f1982876877488cd9128c8051c6b1 |
|
BLAKE2b-256 | 9368a925bf07f13a05cf261abb24340f66748b7ebd465425f6d1b82848ca6fef |
Hashes for electrumsv_sdk-0.0.34-py3-none-manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6df3dd5fa0ae007543fa1e51999f69862bb95168199f0f6b08f9ae82df0aa313 |
|
MD5 | 81adf43bcad61e9fb9bfc4529793e12c |
|
BLAKE2b-256 | 2c3992ce6ffa257bdca060cb32fce1d2bac386b6e9415211b4d0e5538b850130 |
Hashes for electrumsv_sdk-0.0.34-py3-none-macosx_10_5_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c32187e5b6d2626180f1a8a45fbd00226eae638e71b6b72024f101bd493fedcd |
|
MD5 | 3b523d0a4350f9f84fd75cb26c1d8dd4 |
|
BLAKE2b-256 | a7d49c427e322833748eb3bb1b4a6e63557331fdd0819541af21865c5357c33e |