{"id":24290166,"url":"https://github.com/electrumsv/electrumsv-node","last_synced_at":"2025-09-25T12:30:59.731Z","repository":{"id":41842301,"uuid":"276839263","full_name":"electrumsv/electrumsv-node","owner":"electrumsv","description":"A convenient way to install and run a Bitcoin node in RegTest mode on 64-bit Windows, MacOS or Linux.","archived":false,"fork":false,"pushed_at":"2023-01-31T22:33:42.000Z","size":17703,"stargazers_count":6,"open_issues_count":4,"forks_count":4,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-12-15T18:49:49.534Z","etag":null,"topics":["bitcoin","bsv","electrumsv","regtest"],"latest_commit_sha":null,"homepage":"","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":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-07-03T07:42:38.000Z","updated_at":"2024-01-22T03:11:22.000Z","dependencies_parsed_at":"2023-02-16T23:35:38.921Z","dependency_job_id":null,"html_url":"https://github.com/electrumsv/electrumsv-node","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electrumsv%2Felectrumsv-node","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electrumsv%2Felectrumsv-node/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electrumsv%2Felectrumsv-node/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electrumsv%2Felectrumsv-node/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/electrumsv","download_url":"https://codeload.github.com/electrumsv/electrumsv-node/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234167853,"owners_count":18790189,"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":["bitcoin","bsv","electrumsv","regtest"],"created_at":"2025-01-16T11:16:32.821Z","updated_at":"2025-09-25T12:30:59.327Z","avatar_url":"https://github.com/electrumsv.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![PyPI version](https://badge.fury.io/py/electrumsv-node.svg)](https://badge.fury.io/py/electrumsv-node)\n[![Build Status](https://dev.azure.com/electrumsv/ElectrumSV/_apis/build/status/electrumsv.electrumsv-node?branchName=master)](https://dev.azure.com/electrumsv/ElectrumSV/_build/latest?definitionId=5\u0026branchName=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[![Node Version](https://img.shields.io/badge/node_version-v1.0.13-brown)](https://img.shields.io/badge/platforms-linux%20%7C%20windows%20%7C%20macos-blue)\n\n# ElectrumSV-Node\n\nThe project is intended to provide Python packages for Linux, MacOS and Windows that include and\nhelp run pre-built Bitcoin SV executables. It should allow the consistently usable and available\nability to run a Bitcoin SV node on any 64-bit platform with the installation of the\n`electrumsv-node` package using the standard `pip` package manager for Python.\n\nThese packages and the executables within them, are only intended for running nodes for development\nas Regtest blockchains. If we had the ability to do so, we would prevent them from running as any\nother blockchain. Do not bother us with your questions or problems related to non-Regtest usage.\n\n* You must be using 64-bit Python 3.7, 3.8, 3.9 or 3.10.\n* You must be using Windows, MacOS or Linux.\n* You must have the latest version of the `pip` package.\n\nTo update `pip`:\n\n    \u003e python3 -m pip install --upgrade pip\n\nTo install `electrumsv-node`:\n\n    \u003e pip3 install electrumsv-node\n\nTo use it:\n\n    import logging\n    import electrumsv_node\n\n    # Set logging level to debug mode to see logging information (Optional)\n    logging.basicConfig(\n        format=\"%(asctime)s %(levelname)s %(message)s\",\n        level=logging.DEBUG,\n        datefmt=\"%Y-%m-%d %H-%M-%S\",\n    )\n    logger = logging.getLogger(\"testing\")\n\n    electrumsv_node.start()\n\n    # (Optional keyword arguments)\n    # electrumsv_node.start(\n    #     data_path=\u003c/your/custom/datadir/path\u003e,\n    #     rpcuser=\"rpcuser\",\n    #     rpcpassword=\"rpcpassword\",\n    #     rpcport=18332,\n    #     p2p_port=18444,\n    #     zmq_port=28332,\n    #     network='regtest',\n    #     print_to_console=True,  # feeds logging to stdout\n    #     extra_params=['-somearg1=var1', '-somearg2=var2']\n    # )\n\n    result = electrumsv_node.call_any('getinfo')\n    logger.debug(result.json())\n    electrumsv_node.stop()\n    electrumsv_node.reset()\n\n\nConsole output will look something like this (with custom data directory):\n\n    2021-01-03 11-50-29 INFO starting bitcoin node\n    2021-01-03 11-50-29 DEBUG polling bitcoin node...\n    2021-01-03 11-50-31 DEBUG polling bitcoin node...\n    2021-01-03 11-50-32 INFO bitcoin node online\n    2021-01-03 11-50-32 DEBUG {'result': {'version': 101000600, 'protocolversion': 70015, 'walletversion': 160300, 'balance': 0.0, 'blocks': 0, 'timeoffset': 0, 'connections': 0, 'proxy': '', 'difficulty': 4.656542373906925e-10, 'testnet': False, 'stn': False, 'keypoololdest': 1609627830, 'keypoolsize': 2000, 'paytxfee': 0.0, 'relayfee': 2.5e-06, 'errors': 'This is a pre-release or beta test build - use at your own risk - do not use for mining or merchant applications', 'maxblocksize': 10000000000, 'maxminedblocksize': 128000000, 'maxstackmemoryusagepolicy': 100000000, 'maxstackmemoryusageconsensus': 9223372036854775807}, 'error': None, 'id': 0}\n    2021-01-03 11-50-32 DEBUG stopping bitcoin node\n    2021-01-03 11-50-32 INFO bitcoin daemon stopped.\n    2021-01-03 11-50-32 DEBUG resetting state of RegTest bitcoin daemon...\n    2021-01-03 11-50-32 ERROR the bitcoin daemon must be shutdown to reset - retrying in 3 seconds\n    2021-01-03 11-50-35 DEBUG removed 'C:\\Users\\donha\\AppData\\Local\\ElectrumSV-Node' successfully\n\n## The node data directory\n\nBy default, the node will be started with a data directory in a standard location. On Windows this\nwill be within `ElectrumSV-Node` in the computer's `LOCALAPPDATA` directory, which will likely be\n`c:\\users\\\u003cuser-name\u003e\\AppData\\Local`. On MacOS and Linux this will be within `.electrumsv-node` in\nthe user's home directory, which will likely be something like `/home/\u003cuser-name\u003e` on Linux or\n`/Users/\u003cuser-name\u003e` on MacOS.\n\n## ElectrumSV and ElectrumSV-Node\n\nThis is part of a wider effort to provide a first class RegTest development environment\nexperience with the [ElectrumSV](https://github.com/electrumsv/electrumsv) stack (which includes\nElectrumX). It is expected that for these purposes, the\n[ElectrumSV-SDK](https://github.com/electrumsv/electrumsv-sdk) project will be the way that\ndevelopers will make use of ElectrumSV-Node.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felectrumsv%2Felectrumsv-node","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Felectrumsv%2Felectrumsv-node","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felectrumsv%2Felectrumsv-node/lists"}