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.36-py3-none-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0a2e1225d644be15e2a03d3a16d45f02749be1ae843ddc698caaccb42a556fb6 |
|
MD5 | 8b54a50fdf52f8749b2fce86442a9320 |
|
BLAKE2b-256 | c5c3808c876f8456449f1b23b312d31084dbc23a192ea260e82cd1a43e18077d |
Hashes for electrumsv_sdk-0.0.36-py3-none-manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7a6ee303477c4de6b26af47b44db06b431346b5fee81c1e89b29bf2cb646bf95 |
|
MD5 | 9f1f865c82a4eabaf4aff8f1d1c7cc87 |
|
BLAKE2b-256 | 07911f3f65ae5401d24e776f9ce609185e4f9a009c2690f9f4c8ea50e0beff16 |
Hashes for electrumsv_sdk-0.0.36-py3-none-macosx_10_5_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d62094e0092cda2f6d82752abb308ccde660a849f8e2341c4567647042a709da |
|
MD5 | ccd9c8d29043bef4ac9b976e7b7238fa |
|
BLAKE2b-256 | d4f80f5c08bfb451dec8f770d497bfb5f86bff43414d7434899b87b58a95546e |