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.37-py3-none-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8a08c5f159b6559323d99cf075a041c86b94d22750dc4cc905e2c1f14502424f |
|
MD5 | 1ef3a17e84c765601a1716e7ff0e953b |
|
BLAKE2b-256 | 9b5ddc8eef595fef6030c7469aeaa30271122a35786eee3aaac5e521dfb1e707 |
Hashes for electrumsv_sdk-0.0.37-py3-none-manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dba2811962364632a83848d661d18818be69e0f5784e41e5c6400f12558ddbac |
|
MD5 | 689b545cb0e68bcd7e3dbcf81ef85156 |
|
BLAKE2b-256 | 126f2e92698a69d2284916f55f92a2a1c8c6b58d2d892fa7ed4bef97f17e457a |
Hashes for electrumsv_sdk-0.0.37-py3-none-macosx_10_5_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 390df2c237305767e317847a99a0eb20e069378612d8dddda97ce4079442d772 |
|
MD5 | 8ae40c2c9e2f3a3cc0df1298e5a709a5 |
|
BLAKE2b-256 | 4b6f34107242d518ef41d93282c3ae41573eb0400936ca0ba5498081a55d4ffc |