Command line interface used for generating local Lightning test environment
Project description
Aesir
Prerequisites
- python (3.8+)
- pip
- docker
Getting started
You can use aesir
simply by installing via pip
on your Terminal.
pip install aesir
And then you can begin deploying local cluster as such:
aesir deploy
The initial deployment may take some time at pulling required images from their respective repositories. Results may look as such:
$ pip install aesir
> ...
> Installing collected packages: aesir
> Successfully installed aesir-0.3.3
$ 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:
$ 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 one single aesir-bitcoind service. |
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:
$ 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:
$ 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:
aesir clean
🚧 This will resets the current test state, so use with care. Example below:
$ aesir clean
> Remove active containers: ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100% 0:00:01
Roadmap
- Add
aesir-lnd-krub
peripheral service using lnd-krub - Add
aesir-tesla-ball
peripheral service using tesla-ball - Write click tests.
- Use joblib to speed up deployment with parallelization.
- Make image versioning a little bit more intuitive.
- Add
aesir-ord
peripheral service using ord - Add
aesir-bitvm
peripheral service using BitVM - Create and add some type of
ordapi
peripheral service. - Implement dashboard walkthrough a la kylepollina/objexplore
Contributions
This project uses poetry package manager to keep track of dependencies. You can set up your local environment as such:
pip install --user poetry
And then you can install development dependencies like so:
$ 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.3.3)
Known issues
You may run into this setback when first running this project. This is a docker-py issue widely known as of October 2022.
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 Recommended fix is to run the following command:
sudo ln -s "$HOME/.docker/run/docker.sock" /var/run/docker.sock
License
This project is licensed under the terms of the MIT license.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.