Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/parazyd/obelisk
Electrum server using zeromq libbitcoin as backend
https://github.com/parazyd/obelisk
agpl async asyncio bitcoin electrum electrum-server libbitcoin python zeromq zmq
Last synced: 2 months ago
JSON representation
Electrum server using zeromq libbitcoin as backend
- Host: GitHub
- URL: https://github.com/parazyd/obelisk
- Owner: parazyd
- License: agpl-3.0
- Created: 2021-04-06T16:36:42.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-05-12T04:55:42.000Z (over 3 years ago)
- Last Synced: 2024-05-01T16:57:30.240Z (8 months ago)
- Topics: agpl, async, asyncio, bitcoin, electrum, electrum-server, libbitcoin, python, zeromq, zmq
- Language: Python
- Homepage:
- Size: 612 KB
- Stars: 14
- Watchers: 3
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
obelisk
=======
Python implementation of an [Electrum](https://electrum.org) server
using [libbitcoin](https://libbitcoin.info) as a backend.
[](https://github.com/parazyd/obelisk/actions/workflows/py.yaml)
[](https://github.com/parazyd/obelisk/actions/workflows/codeql-analysis.yml)
[](LICENSE)
[](https://codecov.io/gh/parazyd/obelisk)
Please consider donating to support development:
```
bc1q7an9p5pz6pjwjk4r48zke2yfaevafzpglg26mz
```
TODO
----
* git grep -nE "TODO:|BUG:"
Dependencies
------------
* Python 3.7 or later
* [pyzmq](https://pypi.org/project/pyzmq/) (python3-zmq or dev-python/pyzmq)
* [libbitcoin-server](https://github.com/libbitcoin/libbitcoin-server) (optional)
Usage
-----
Set up [obelisk.cfg](res/obelisk.cfg), and run
```
./run_obelisk ./res/obelisk.cfg
```
Obelisk can use either public libbitcoin v4 servers, or your local
libbitcoin-server if you have a running installation. Currently,
**only testnet v4 public servers are available**, and they're set up
as default in the configuration file.
Obelisk can also be installed with setuptools:
```
python3 setup.py install --user
```
Development
-----------
The code is written to be short and concise. `run_obelisk` is the
entry point to start the server, but most of the actual logic is
in `obelisk/protocol.py` and `obelisk/zeromq.py`. `protocol.py`
implements the ElectrumX protocol, and `zeromq.py` implements the
libbitcoin side of things.
Before committing code, please run `make format` to format
the codebase to a certain code style. This script depends on
[yapf](https://github.com/google/yapf).
It is also recommended to run the test suite and see if anything
fails:
```
make test
```
You can chat about Obelisk on Freenode IRC, either `#electrum` or
`#libbitcoin`.