Running Bitcoin and peripherals via Terminal User Interface
Project description
Arise
Prerequisites
- python (3.8+)
- pip
- docker
Getting started
You can use arise
simply by installing via pip
on your Terminal.
pip install arise
Sample output when running install command
$ pip install arise
❯ ...
❯ Installing collected packages: arise
❯ Successfully installed arise-0.1.6
And build required images with build
command. The following shows you how to build a Testnet4
Bitcoin-Core node as well as electrs,
mempool and mutiny-web
arise build --testnet4 --electrs --mempool --mutiny-web
Sample output when running build command
$ arise build --testnet4 --electrs --mempool --mutiny-web
❯
❯ ---> c7c857e7f240
❯ Step 13/13 : ENTRYPOINT ["/usr/app/electrs"]
❯
❯ ---> [Warning] The requested image's platform (linux/amd64) does not match the detected host
❯ ---> Running in 6b6bb5257753
❯ Removing intermediate container 6b6bb5257753
❯ ---> 7c067a938f79
❯ Successfully built 7c067a938f79
❯ Successfully tagged arise-electrs:latest
❯
❯ Build specified images: ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
❯ Built <Image 'arise-testnet4'> successfully
❯ Built <Image 'arise-electrs'> successfully
❯ Built <Image 'arise-mempool'> successfully
❯ Built <Image 'arise-mutiny-web'> successfully
The initial build may take some time as it is downloading source codes from different repositories
and interfacing with Docker Daemon
to build according to flagged requirements. Once the build process
completes, you can begin deploying local network with peripherals as such:
arise deploy --testnet4 --with-electrs --with-mempool --with-mutiny-web
Sample output when running deploy command
$ arise deploy --signet --with-electrs --with-mempool --with-mutiny-web
❯ Deploy arise-signet ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100% 0:00:00
❯ Deploy middleware services ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100% 0:00:00
❯ Deploy peripheral services ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100% 0:00:16
You will have docker containers running in the backend, ready to be interfaced by your local environment applications you are developing.
Contributions
To be determined
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.