# Aesir
[](https://twentyone.world)
[](https://mempool.space/lightning)
[](https://hub.docker.com)
[](https://github.com/krutt/aesir/blob/master/LICENSE)
[](https://github.com/krutt/aesir)
[](https://github.com/krutt/aesir)
[](https://github.com/krutt/aesir)
[](https://github.com/krutt/aesir)
[](static/aesir-banner.svg)
## Prerequisites
* python (3.8+)
* pip
* docker
## Getting started
You can use `aesir` simply by installing via `pip` on your Terminal.
```sh
pip install aesir
```
And then you can begin deploying local cluster as such:
```sh
aesir deploy
```
The initial deployment may take some time at pulling required images from their respective
repositories. Results may look as such:
```sh
$ pip install aesir
> ...
> Installing collected packages: aesir
> Successfully installed aesir-0.3.5
$ aesir deploy
> Deploy specified local cluster: ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100% 0:00:01
> Generate addresses: ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100% 0:00:00
> Mine initial capital for parties: ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100% 0:00:00
```
You will have docker containers running in the backend, ready to be interfaced by your local
environment applications you are developing.
## Begin local mining
In order to properly test many functionalities, you will need to send mining commands to local
setup. You can achieve completely local and running environment with the following command:
```sh
$ aesir mine
> ╭───── containers ─────╮┏━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━━┓
> │ aesir-redis │┃ Name ┃ Nodekey ┃ Channels ┃ Peers ┃ Height ┃ Synced? ┃
> │ aesir-postgres │┡━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━━┩
> │ aesir-pong ││ aesir-pong │ 02fabeeaa9d │ 2 │ 1 │ 216 │ true │
> │ aesir-ping ││ │ 3da33d3eb12 │ │ │ │ │
> │ aesir-bitcoind ││ │ 262e039d9b2 │ │ │ │ │
> │ ││ │ 9d591f1b897 │ │ │ │ │
> │ ││ │ c0ae6b158d0 │ │ │ │ │
> │ ││ │ 5410d97efbc │ │ │ │ │
> │ │├───────────────┼──────────────┼───────────┼────────┼────────┼─────────┤
> │ ││ aesir-ping │ 02ac17a8d64 │ 2 │ 1 │ 216 │ true │
> │ ││ │ 4194459b8f3 │ │ │ │ │
> │ ││ │ deacf4e1a64 │ │ │ │ │
> │ ││ │ 0fcbcdf9fbf │ │ │ │ │
> │ ││ │ 39e8423dfdc │ │ │ │ │
> │ ││ │ 3ffa2f7367f │ │ │ │ │
> │ │└───────────────┴──────────────┴───────────┴────────┴────────┴─────────┘
> │ │╭──────────────────────────────────────────────────────────────────────╮
> │ ││ Chain: regtest Blocks: 216 Size: 65259 Time: 1701528030 │
> ╰──────────────────────╯╰──────────────────────────────────────────────────────────────────────╯
```
### Cluster types
Currently there are two supported cluster-types in this project. Specified by flags,
`--duo` (default), or `--uno` with the following set-up:
| Type | Description |
| ---- | -------------------------------------------------------------------------- |
| duo | Contains two LND nodes named `aesir-ping` and `aesir-pong` unified by <br> one single `aesir-bitcoind` service. |
| ohm | Only has `aesir-bitcoind` without any Lightning nodes. |
| uno | Only has one LND node named `aesir-lnd` connected to `aesir-bitcoind`. |
### Peripheral containers
This project also helps you setup peripheral services to make development process easier, too.
For example, if you want to deploy a duo-cluster with attached postgres database, run the following:
```sh
$ aesir deploy --with-postgres
> ...
$ aesir mine
> ╭───── containers ─────╮┏━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━━┓
> │ aesir-postgres │┃ Name ┃ Nodekey ┃ Channels ┃ Peers ┃ Height ┃ Synced? ┃
> │ aesir-pong │┡━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━━┩
> │ aesir-ping ││ aesir-pong │ 3da33d3eb12 │ 2 │ 1 │ 216 │ true │
> │ aesir-bitcoind ││ │ deacf4e1a64 │ │ │ │ │
> │ ... ││ ... │ ... │ ... │ ... │ ... │ ... │
```
Or run an uno-cluster with both attached postgres database and redis solid store cache like this:
```sh
$ aesir deploy --uno --with-postgres --with-redis
> ...
$ aesir mine
> ╭───── containers ─────╮┏━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━━┓
> │ aesir-postgres │┃ Name ┃ Nodekey ┃ Channels ┃ Peers ┃ Height ┃ Synced? ┃
> │ aesir-redis │┡━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━━┩
> │ aesir-lnd ││ aesir-lnd │ c0ae6b158d0 │ 0 │ 0 │ 202 │ true │
> │ aesir-bitcoind ││ │ 4194459b8f3 │ │ │ │ │
> │ ... ││ ... │ ... │ ... │ ... │ ... │ ... │
```
## Cleanup
Use the following command to clean up active `aesir-*` containers:
```sh
aesir clean
```
🚧 This will resets the current test state, so use with care. Example below:
```sh
$ aesir clean
> Remove active containers: ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100% 0:00:01
```
## Change-logs
* **0.3.1** Add `aesir-cashu-mint` & `aesir-lnd-krub` image setups and deployments w/ shared volumes
* **0.3.2** Define classifiers on `pyproject.toml` for PyPI metadata
* **0.3.3** Drop `black` and use [ruff](https://github.com/astral-sh/ruff) formatter and linter
* **0.3.4** Simplify deployment workflows and
* **0.3.5** Restructure project so that when installed, `src` folder will not be created
* **0.3.6** Breakdown "setup" command into "build" and "pull"
* **0.3.7** Lightning cluster now with [ord](https://github.com/ordinals/ord)
* **0.3.8** Rename "ord" to "ord-server" to avoid confusion with cli
* **0.3.9** Remove intermediate containers
* **0.4.0** Resist electricity with "ohm" mode
* **0.4.1** Remove Ordinals' spiked ball
* **0.4.2** Disable bitcoind prune mode
## Roadmap
* Make image versioning a little bit more intuitive.
* Add `aesir-tesla-ball` peripheral service using [tesla-ball](https://github.com/krutt/tesla-ball)
* Write [click](https://click.palletsprojects.com) tests.
* Use [joblib](https://github.com/joblib/joblib) to speed up deployment with parallelization.
* Add `aesir-bitvm` peripheral service using [BitVM](https://github.com/BitVM/BitVM)
* Create and add some type of `ordapi` peripheral service.
* Implement dashboard walkthrough a la [kylepollina/objexplore](https://github.com/kylepollina/objexplore)
## Contributions
This project uses [poetry](https://python-poetry.org) package manager to keep track of dependencies.
You can set up your local environment as such:
```sh
pip install --user poetry
```
And then you can install development dependencies like so:
```sh
$ pip install --user poetry
> ...
$ poetry install --with dev # install with development dependencies
> Installing dependencies from lock file
>
> Package operations: 33 installs, 0 updates, 0 removals
>
> • ...
> • ...
> • ...
> • ...
>
> Installing the current project: aesir (0.4.2)
```
### Known issues
You may run into this setback when first running this project. This is a
[docker-py](https://github.com/docker/docker-py/issues/3059) issue widely known as of October 2022.
```python
docker.errors.DockerException:
Error while fetching server API version: (
'Connection aborted.', FileNotFoundError(
2, 'No such file or directory'
)
)
```
See the following issue for Mac OSX troubleshooting.
[docker from_env and pull is broken on mac](https://github.com/docker/docker-py/issues/3059#issuecomment-1294369344)
Recommended fix is to run the following command:
```sh
sudo ln -s "$HOME/.docker/run/docker.sock" /var/run/docker.sock
```
## License
This project is licensed under the terms of the MIT license.
Raw data
{
"_id": null,
"home_page": "https://github.com/krutt/aesir",
"name": "aesir",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "anonymous, bitcoin, cashu, chaum, chaumian, cli, ecash, lightning",
"author": "Sitt Guruvanich",
"author_email": "aekasitt.g+github@siamintech.co.th",
"download_url": "https://files.pythonhosted.org/packages/e4/e5/d9eb01c59ac6c0a7d579eb6415a2054aaa8957d48671d930bdb40407132e/aesir-0.4.2.tar.gz",
"platform": null,
"description": "# Aesir\n\n[](https://twentyone.world)\n[](https://mempool.space/lightning)\n[](https://hub.docker.com)\n[](https://github.com/krutt/aesir/blob/master/LICENSE)\n[](https://github.com/krutt/aesir)\n[](https://github.com/krutt/aesir)\n[](https://github.com/krutt/aesir)\n[](https://github.com/krutt/aesir)\n\n[](static/aesir-banner.svg)\n\n## Prerequisites\n\n* python (3.8+)\n* pip\n* docker\n\n## Getting started\n\nYou can use `aesir` simply by installing via `pip` on your Terminal.\n\n```sh\npip install aesir\n```\n\nAnd then you can begin deploying local cluster as such:\n\n```sh\naesir deploy\n```\n\nThe initial deployment may take some time at pulling required images from their respective\nrepositories. Results may look as such:\n\n```sh\n$ pip install aesir\n> ...\n> Installing collected packages: aesir\n> Successfully installed aesir-0.3.5\n$ aesir deploy\n> Deploy specified local cluster: \u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501 100% 0:00:01\n> Generate addresses: \u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501 100% 0:00:00\n> Mine initial capital for parties: \u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501 100% 0:00:00\n```\n\nYou will have docker containers running in the backend, ready to be interfaced by your local\nenvironment applications you are developing.\n\n## Begin local mining\n\nIn order to properly test many functionalities, you will need to send mining commands to local\nsetup. You can achieve completely local and running environment with the following command:\n\n```sh\n$ aesir mine\n> \u256d\u2500\u2500\u2500\u2500\u2500 containers \u2500\u2500\u2500\u2500\u2500\u256e\u250f\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2513\n> \u2502 aesir-redis \u2502\u2503 Name \u2503 Nodekey \u2503 Channels \u2503 Peers \u2503 Height \u2503 Synced? \u2503\n> \u2502 aesir-postgres \u2502\u2521\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2529\n> \u2502 aesir-pong \u2502\u2502 aesir-pong \u2502 02fabeeaa9d \u2502 2 \u2502 1 \u2502 216 \u2502 true \u2502\n> \u2502 aesir-ping \u2502\u2502 \u2502 3da33d3eb12 \u2502 \u2502 \u2502 \u2502 \u2502\n> \u2502 aesir-bitcoind \u2502\u2502 \u2502 262e039d9b2 \u2502 \u2502 \u2502 \u2502 \u2502\n> \u2502 \u2502\u2502 \u2502 9d591f1b897 \u2502 \u2502 \u2502 \u2502 \u2502\n> \u2502 \u2502\u2502 \u2502 c0ae6b158d0 \u2502 \u2502 \u2502 \u2502 \u2502\n> \u2502 \u2502\u2502 \u2502 5410d97efbc \u2502 \u2502 \u2502 \u2502 \u2502\n> \u2502 \u2502\u251c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u253c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u253c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u253c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u253c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u253c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2524\n> \u2502 \u2502\u2502 aesir-ping \u2502 02ac17a8d64 \u2502 2 \u2502 1 \u2502 216 \u2502 true \u2502\n> \u2502 \u2502\u2502 \u2502 4194459b8f3 \u2502 \u2502 \u2502 \u2502 \u2502\n> \u2502 \u2502\u2502 \u2502 deacf4e1a64 \u2502 \u2502 \u2502 \u2502 \u2502\n> \u2502 \u2502\u2502 \u2502 0fcbcdf9fbf \u2502 \u2502 \u2502 \u2502 \u2502\n> \u2502 \u2502\u2502 \u2502 39e8423dfdc \u2502 \u2502 \u2502 \u2502 \u2502\n> \u2502 \u2502\u2502 \u2502 3ffa2f7367f \u2502 \u2502 \u2502 \u2502 \u2502\n> \u2502 \u2502\u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\n> \u2502 \u2502\u256d\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n> \u2502 \u2502\u2502 Chain: regtest Blocks: 216 Size: 65259 Time: 1701528030 \u2502\n> \u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n```\n\n### Cluster types\n\nCurrently there are two supported cluster-types in this project. Specified by flags,\n`--duo` (default), or `--uno` with the following set-up:\n\n| Type | Description |\n| ---- | -------------------------------------------------------------------------- |\n| duo | Contains two LND nodes named `aesir-ping` and `aesir-pong` unified by <br> one single `aesir-bitcoind` service. |\n| ohm | Only has `aesir-bitcoind` without any Lightning nodes. |\n| uno | Only has one LND node named `aesir-lnd` connected to `aesir-bitcoind`. |\n\n### Peripheral containers\n\nThis project also helps you setup peripheral services to make development process easier, too.\nFor example, if you want to deploy a duo-cluster with attached postgres database, run the following:\n\n```sh\n$ aesir deploy --with-postgres\n> ...\n$ aesir mine\n> \u256d\u2500\u2500\u2500\u2500\u2500 containers \u2500\u2500\u2500\u2500\u2500\u256e\u250f\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2513\n> \u2502 aesir-postgres \u2502\u2503 Name \u2503 Nodekey \u2503 Channels \u2503 Peers \u2503 Height \u2503 Synced? \u2503\n> \u2502 aesir-pong \u2502\u2521\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2529\n> \u2502 aesir-ping \u2502\u2502 aesir-pong \u2502 3da33d3eb12 \u2502 2 \u2502 1 \u2502 216 \u2502 true \u2502\n> \u2502 aesir-bitcoind \u2502\u2502 \u2502 deacf4e1a64 \u2502 \u2502 \u2502 \u2502 \u2502\n> \u2502 ... \u2502\u2502 ... \u2502 ... \u2502 ... \u2502 ... \u2502 ... \u2502 ... \u2502\n```\n\nOr run an uno-cluster with both attached postgres database and redis solid store cache like this:\n\n```sh\n$ aesir deploy --uno --with-postgres --with-redis\n> ...\n$ aesir mine\n> \u256d\u2500\u2500\u2500\u2500\u2500 containers \u2500\u2500\u2500\u2500\u2500\u256e\u250f\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2513\n> \u2502 aesir-postgres \u2502\u2503 Name \u2503 Nodekey \u2503 Channels \u2503 Peers \u2503 Height \u2503 Synced? \u2503\n> \u2502 aesir-redis \u2502\u2521\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2529\n> \u2502 aesir-lnd \u2502\u2502 aesir-lnd \u2502 c0ae6b158d0 \u2502 0 \u2502 0 \u2502 202 \u2502 true \u2502\n> \u2502 aesir-bitcoind \u2502\u2502 \u2502 4194459b8f3 \u2502 \u2502 \u2502 \u2502 \u2502\n> \u2502 ... \u2502\u2502 ... \u2502 ... \u2502 ... \u2502 ... \u2502 ... \u2502 ... \u2502\n```\n\n## Cleanup\n\nUse the following command to clean up active `aesir-*` containers:\n\n```sh\naesir clean\n```\n\n\ud83d\udea7 This will resets the current test state, so use with care. Example below:\n\n```sh\n$ aesir clean\n> Remove active containers: \u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501 100% 0:00:01\n```\n\n## Change-logs\n\n* **0.3.1** Add `aesir-cashu-mint` & `aesir-lnd-krub` image setups and deployments w/ shared volumes\n* **0.3.2** Define classifiers on `pyproject.toml` for PyPI metadata\n* **0.3.3** Drop `black` and use [ruff](https://github.com/astral-sh/ruff) formatter and linter\n* **0.3.4** Simplify deployment workflows and \n* **0.3.5** Restructure project so that when installed, `src` folder will not be created\n* **0.3.6** Breakdown \"setup\" command into \"build\" and \"pull\"\n* **0.3.7** Lightning cluster now with [ord](https://github.com/ordinals/ord)\n* **0.3.8** Rename \"ord\" to \"ord-server\" to avoid confusion with cli\n* **0.3.9** Remove intermediate containers\n* **0.4.0** Resist electricity with \"ohm\" mode\n* **0.4.1** Remove Ordinals' spiked ball\n* **0.4.2** Disable bitcoind prune mode\n\n## Roadmap\n\n* Make image versioning a little bit more intuitive.\n* Add `aesir-tesla-ball` peripheral service using [tesla-ball](https://github.com/krutt/tesla-ball)\n* Write [click](https://click.palletsprojects.com) tests.\n* Use [joblib](https://github.com/joblib/joblib) to speed up deployment with parallelization.\n* Add `aesir-bitvm` peripheral service using [BitVM](https://github.com/BitVM/BitVM)\n* Create and add some type of `ordapi` peripheral service.\n* Implement dashboard walkthrough a la [kylepollina/objexplore](https://github.com/kylepollina/objexplore)\n\n## Contributions\n\nThis project uses [poetry](https://python-poetry.org) package manager to keep track of dependencies.\nYou can set up your local environment as such:\n\n```sh\npip install --user poetry\n```\n\nAnd then you can install development dependencies like so:\n\n```sh\n$ pip install --user poetry\n> ...\n$ poetry install --with dev # install with development dependencies\n> Installing dependencies from lock file\n>\n> Package operations: 33 installs, 0 updates, 0 removals\n>\n> \u2022 ...\n> \u2022 ...\n> \u2022 ...\n> \u2022 ...\n>\n> Installing the current project: aesir (0.4.2)\n```\n\n### Known issues\n\nYou may run into this setback when first running this project. This is a\n[docker-py](https://github.com/docker/docker-py/issues/3059) issue widely known as of October 2022.\n\n```python\ndocker.errors.DockerException:\n Error while fetching server API version: (\n 'Connection aborted.', FileNotFoundError(\n 2, 'No such file or directory'\n )\n )\n```\n\nSee the following issue for Mac OSX troubleshooting.\n[docker from_env and pull is broken on mac](https://github.com/docker/docker-py/issues/3059#issuecomment-1294369344)\nRecommended fix is to run the following command:\n\n```sh\nsudo ln -s \"$HOME/.docker/run/docker.sock\" /var/run/docker.sock\n```\n\n## License\n\nThis project is licensed under the terms of the MIT license.",
"bugtrack_url": null,
"license": "MIT",
"summary": "Command line interface used for generating local Lightning test environment",
"version": "0.4.2",
"project_urls": {
"Homepage": "https://github.com/krutt/aesir",
"Repository": "https://github.com/krutt/aesir"
},
"split_keywords": [
"anonymous",
" bitcoin",
" cashu",
" chaum",
" chaumian",
" cli",
" ecash",
" lightning"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2d92ff01030759c6d5cee619225c0ff8e6b3170053874b2ec4f1f9798e93bdfa",
"md5": "895a5b5b7d30fee69c6f5505f89b8aa5",
"sha256": "2b77696c6d37db0657728e27745f69d5f34a6294c20ba0bff60ba7259922b929"
},
"downloads": -1,
"filename": "aesir-0.4.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "895a5b5b7d30fee69c6f5505f89b8aa5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 28979,
"upload_time": "2024-04-03T08:29:28",
"upload_time_iso_8601": "2024-04-03T08:29:28.259708Z",
"url": "https://files.pythonhosted.org/packages/2d/92/ff01030759c6d5cee619225c0ff8e6b3170053874b2ec4f1f9798e93bdfa/aesir-0.4.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e4e5d9eb01c59ac6c0a7d579eb6415a2054aaa8957d48671d930bdb40407132e",
"md5": "34cec286d1e5b8094995b89565903636",
"sha256": "d750292493ba517cd7086f8e515fb2a965fd731846fa71920b25e772da501836"
},
"downloads": -1,
"filename": "aesir-0.4.2.tar.gz",
"has_sig": false,
"md5_digest": "34cec286d1e5b8094995b89565903636",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 18724,
"upload_time": "2024-04-03T08:29:30",
"upload_time_iso_8601": "2024-04-03T08:29:30.195849Z",
"url": "https://files.pythonhosted.org/packages/e4/e5/d9eb01c59ac6c0a7d579eb6415a2054aaa8957d48671d930bdb40407132e/aesir-0.4.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-03 08:29:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "krutt",
"github_project": "aesir",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "aesir"
}
JSON
