{"id":24649573,"url":"https://github.com/electrumsv/electrumsv-sdk","last_synced_at":"2025-05-13T12:51:01.949Z","repository":{"id":38913825,"uuid":"277031500","full_name":"electrumsv/electrumsv-sdk","owner":"electrumsv","description":"Libraries to facilitate development and testing of ElectrumSV and applications based on it","archived":false,"fork":false,"pushed_at":"2023-07-05T02:46:18.000Z","size":18682,"stargazers_count":8,"open_issues_count":24,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-15T19:49:53.803Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/electrumsv.png","metadata":{"files":{"readme":"README.md","changelog":"HISTORY.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-07-04T03:30:56.000Z","updated_at":"2024-12-27T04:22:48.000Z","dependencies_parsed_at":"2023-02-06T00:46:39.632Z","dependency_job_id":null,"html_url":"https://github.com/electrumsv/electrumsv-sdk","commit_stats":null,"previous_names":[],"tags_count":32,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electrumsv%2Felectrumsv-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electrumsv%2Felectrumsv-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electrumsv%2Felectrumsv-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electrumsv%2Felectrumsv-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/electrumsv","download_url":"https://codeload.github.com/electrumsv/electrumsv-sdk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253947448,"owners_count":21988938,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-01-25T17:17:43.200Z","updated_at":"2025-05-13T12:51:01.930Z","avatar_url":"https://github.com/electrumsv.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"ElectrumSV Software Development Kit\n===================================\n\nThis project provides a consolidated set of resources that together can allow a developer, whether\nworking on ElectrumSV directly or on an application based on ElectrumSV, to develop, run and test\nwhile offline (and is especially aimed at facilitating rigourous CI/CD functional testing).\n\n    Licence: The Open BSV License\n    Maintainers: Roger Taylor, AustEcon\n    Project Lead: Roger Taylor\n    Language: Python (\u003e=3.9)\n    Homepage: https://electrumsv.io/\n\n[![PyPI version](https://badge.fury.io/py/electrumsv-sdk.svg)](https://badge.fury.io/py/electrumsv-sdk)\n[![Build Status](https://dev.azure.com/electrumsv/ElectrumSV/_apis/build/status/electrumsv.electrumsv-sdk?branchName=master)](https://dev.azure.com/electrumsv/ElectrumSV/_apis/build/status/electrumsv.electrumsv-sdk?branchName=master)\n[![Platforms](https://img.shields.io/badge/platforms-linux%20%7C%20windows%20%7C%20macos-blue)](https://img.shields.io/badge/platforms-linux%20%7C%20windows%20%7C%20macos-blue)\n[![Platforms](https://img.shields.io/pypi/pyversions/electrumsv-sdk.svg?style=flat-square)](https://pypi.org/project/electrumsv-sdk)\n\nDocumentation\n================\nDetailed documentation is hosted [here](https://electrumsv-sdk.readthedocs.io/en/latest/)\n\nBasic Instructions\n===================\nTo install from [pypi](https://pypi.org/project/electrumsv-sdk/):\n\n    \u003e pip install --upgrade electrumsv-sdk\n\nNow you have global access to a script called 'electrumsv-sdk.exe' from\nany console window.\n\nFor help:\n\n    \u003e electrumsv-sdk --help\n\n**Note: You must run ``electrumsv-sdk install \u003ccomponent type\u003e``\nfirst for each component type. This may require system dependencies\nyou also need - please read the documentation.**\n\nIf you want help for one of the subcommands (e.g. 'start') do:\n\n    \u003e electrumsv-sdk start --help\n\nWhich will show:\n\n    usage: electrumsv-sdk start [-h] [--new] [--gui] [--background] [--inline] [--new-terminal] [--id ID] [--repo REPO] [--branch BRANCH] {electrumsv,merchant_api,node,status_monitor,whatsonchain,whatsonchain_api} ...\n\n    positional arguments:\n      {electrumsv,merchant_api,node,status_monitor,whatsonchain,whatsonchain_api}\n                            subcommand\n        electrumsv          start electrumsv\n        merchant_api        start merchant_api\n        node                start node\n        status_monitor      start status_monitor\n        whatsonchain        start whatsonchain\n        whatsonchain_api    start whatsonchain_api\n\n    optional arguments:\n      -h, --help            show this help message and exit\n      --new                 run a new instance with unique 'id'\n      --gui                 run in gui mode (electrumsv only)\n      --background          spawn in background\n      --inline              spawn in current shell\n      --new-terminal        spawn in a new terminal window\n      --id ID               human-readable identifier for component (e.g. 'worker1_esv')\n      --repo REPO           git repo as either an https://github.com url or a local git repo path e.g. G:/electrumsv (optional)\n      --branch BRANCH       git repo branch (optional)\n\nNote: The \"optional arguments\" come **before** specifying the ``component_type`` e.g.:\n\n    \u003e electrumsv-sdk start --new --id=myspecialnode node\n\n\nDocker\n===================\nDocker support is here: https://github.com/electrumsv/electrumsv-sdk-docker. However,\ndo note that we cannot promise to keep the docker support up-to-date as we are stretched\ntoo thin and have other priorities. Nevertheless, help will be gladly accepted.\n\nYou might also find what you need here: https://github.com/jadwahab/regtest-stack.\nPlease check that one out too. Jad and co. are better placed to keep up with the bleeding\nedge versioning of the node, mAPI and LiteClient services as they are directly involved\nwith many of those projects. They also do not have the additional python layer of\nabstraction to sort out when it comes to docker.\n\nApp Versions\n============\nThe current versions of each component are maintained in \n`electrumsv_sdk/app_versions.py`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felectrumsv%2Felectrumsv-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Felectrumsv%2Felectrumsv-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felectrumsv%2Felectrumsv-sdk/lists"}