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.35-py3-none-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e1066e53c17ee79469e35b68db55a803bd523012ce51f672ed556e3a64e1269e |
|
MD5 | 441a679f1c1255e675862c1aa77af5f5 |
|
BLAKE2b-256 | d857ea479ecc8ec426faab3fdb5287934b21ccba0c251ec32950f0337abc71b2 |
Hashes for electrumsv_sdk-0.0.35-py3-none-manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 33bbb0df67ff75c8a81f134c60c9a9a50ea6d665487d8e263be01c6d98ac467b |
|
MD5 | 5e3e003816f70fa638351d1ff077f685 |
|
BLAKE2b-256 | a8e318bd1b6908d209b5dac739cd5ef6b33af11921f86431aa3dece0e706e746 |
Hashes for electrumsv_sdk-0.0.35-py3-none-macosx_10_5_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 937fb5b7687734eae735678fb8d6e0ec0b3761d9049ddbeafa1ef13226119cf5 |
|
MD5 | 21c73a867bf3f8b35f96604ba7bffa2d |
|
BLAKE2b-256 | 0fffc277a3d30e9bcd55456da94c32429554e2711263e3b869f4faa5e33a5ad8 |