{"id":16616508,"url":"https://github.com/parazyd/obelisk","last_synced_at":"2025-10-29T19:30:49.205Z","repository":{"id":51397479,"uuid":"355260314","full_name":"parazyd/obelisk","owner":"parazyd","description":"Electrum server using zeromq libbitcoin as backend","archived":false,"fork":false,"pushed_at":"2021-05-12T04:55:42.000Z","size":627,"stargazers_count":16,"open_issues_count":4,"forks_count":5,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-02T04:31:42.602Z","etag":null,"topics":["agpl","async","asyncio","bitcoin","electrum","electrum-server","libbitcoin","python","zeromq","zmq"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/parazyd.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-04-06T16:36:42.000Z","updated_at":"2024-10-30T03:08:14.000Z","dependencies_parsed_at":"2022-09-25T00:43:54.760Z","dependency_job_id":null,"html_url":"https://github.com/parazyd/obelisk","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/parazyd%2Fobelisk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/parazyd%2Fobelisk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/parazyd%2Fobelisk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/parazyd%2Fobelisk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/parazyd","download_url":"https://codeload.github.com/parazyd/obelisk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238874459,"owners_count":19545194,"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":["agpl","async","asyncio","bitcoin","electrum","electrum-server","libbitcoin","python","zeromq","zmq"],"created_at":"2024-10-12T02:13:17.932Z","updated_at":"2025-10-29T19:30:43.922Z","avatar_url":"https://github.com/parazyd.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"obelisk\n=======\n\n![obelisk](res/obelisk.png)\n\nPython implementation of an [Electrum](https://electrum.org) server\nusing [libbitcoin](https://libbitcoin.info) as a backend.\n\n[![Tests](https://github.com/parazyd/obelisk/actions/workflows/py.yaml/badge.svg)](https://github.com/parazyd/obelisk/actions/workflows/py.yaml)\n[![CodeQL](https://github.com/parazyd/obelisk/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/parazyd/obelisk/actions/workflows/codeql-analysis.yml)\n[![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](LICENSE)\n[![codecov](https://codecov.io/gh/parazyd/obelisk/branch/master/graph/badge.svg?token=JL5FKYM9IX)](https://codecov.io/gh/parazyd/obelisk)\n\nPlease consider donating to support development:\n\n```\nbc1q7an9p5pz6pjwjk4r48zke2yfaevafzpglg26mz\n```\n\n\nTODO\n----\n\n* git grep -nE \"TODO:|BUG:\"\n\n\nDependencies\n------------\n\n* Python 3.7 or later\n* [pyzmq](https://pypi.org/project/pyzmq/) (python3-zmq or dev-python/pyzmq)\n* [libbitcoin-server](https://github.com/libbitcoin/libbitcoin-server) (optional)\n\n\nUsage\n-----\n\nSet up [obelisk.cfg](res/obelisk.cfg), and run\n\n```\n./run_obelisk ./res/obelisk.cfg\n```\n\nObelisk can use either public libbitcoin v4 servers, or your local\nlibbitcoin-server if you have a running installation. Currently,\n**only testnet v4 public servers are available**, and they're set up\nas default in the configuration file.\n\nObelisk can also be installed with setuptools:\n\n```\npython3 setup.py install --user\n```\n\n\nDevelopment\n-----------\n\nThe code is written to be short and concise. `run_obelisk` is the\nentry point to start the server, but most of the actual logic is\nin `obelisk/protocol.py` and `obelisk/zeromq.py`. `protocol.py`\nimplements the ElectrumX protocol, and `zeromq.py` implements the\nlibbitcoin side of things.\n\nBefore committing code, please run `make format` to format\nthe codebase to a certain code style. This script depends on\n[yapf](https://github.com/google/yapf).\n\nIt is also recommended to run the test suite and see if anything\nfails:\n\n```\nmake test\n```\n\nYou can chat about Obelisk on Freenode IRC, either `#electrum` or\n`#libbitcoin`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fparazyd%2Fobelisk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fparazyd%2Fobelisk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fparazyd%2Fobelisk/lists"}