14 |
15 | ## Key Features
16 |
17 | * Ergo node, a full blockchain node, the reference client implementation.
18 | * Ergo backends
19 | * Explorer API, provides a set of HTTP API methods for querying chain/off-chain data.
20 | * UTX watcher, dumps unconfirmed transactions from mempool to local database.
21 | * UTX broadcaster, broadcasts unconfirmed transactions to Ergo nodes.
22 | * Chain grabber, scans blockchain and dumps aggregated data to database.
23 | * Yoroi backend, a wrapper for the Ergo explorer API providing light wallets endpoints.
24 | * Ergo frontends
25 | * Ergo node panel, build-in
26 | * Ergo explorer, a browser for viewing activity on the underlying blockchain network.
27 |
28 | ## Installation
29 |
30 | The bootstrap cluster is supposed to be a development tool and we do not recommend using it as a production deployment.
31 |
32 | You need to have `docker` and `docker-compose` installed on your system. We recommend at least 8GB of memory.
33 |
34 | ```bash
35 | # Clone this repository
36 | $ git clone https://github.com/ergoplatform/ergo-bootstrap
37 |
38 | # Go into the repository
39 | $ cd ergo-bootstrap
40 |
41 | # Run the bootstrap script
42 | $ ./ergo-bootstrap
43 | Usage: ./ergo-bootstrap {init|start|stop|status|destroy}
44 |
45 | init Initialize a ergo bootstrap cluster
46 | start Start the cluster
47 | stop Stop the cluster
48 | status Get status of an initialized cluster
49 | destroy Destroy the current cluster
50 | ```
51 |
52 | ## Usage
53 |
54 | ### Initializing your cluster
55 |
56 | 
57 |
58 | ### Starting and stopping your cluster
59 |
60 | Use the `start` and `stop` commands.
61 |
62 | ```
63 | $ ./ergo-bootstrap stop
64 | Stopping ergo-bootstrap_ergo-explorer-api_1 ... done
65 | $
66 | ```
67 |
68 | ### Status of the cluster
69 |
70 | You can view the current status of your cluster using the `status` command.
71 |
72 | ```
73 | $ ./ergo-bootstrap status
74 | NAMES CONTAINER ID STATUS PORTS
75 | ergo-bootstrap_yoroi-backend_1 c5db1d6f2795 Up 35 minutes 0.0.0.0:3001->3001/tcp
76 | ergo-bootstrap_ergo-explorer-api_1 20d17f44e95a Up 35 minutes 0.0.0.0:8080->8080/tcp
77 | ergo-bootstrap_ergo-postgresql_1 c9ef2a3cdfa4 Up 35 minutes 5432/tcp
78 | ergo-bootstrap_ergo-redis_1 a7ea3d025cc5 Up 35 minutes 6379/tcp
79 | ...
80 |
81 | Ergo Node Panel http://localhost:9053/panel/
82 | Ergo Node API http://localhost:9053/
83 | Yoroi backed API http://localhost:3001/api/v2/bestblock
84 | Grafana metrics http://localhost:3000/ (user admin / password admin)
85 | ```
86 |
87 | ## Support
88 |
89 | If you find a bug or have a feature you would like to see, [please open an issue](https://github.com/ergoplatform/ergo-bootstrap/issues/new). For help, join the [Ergo Platform Discord server](https://discordapp.com/invite/gYrVrjS).
90 |
91 | ## Credits
92 |
93 | This project has [been sponsored by a grant from The Ergo Foundation](https://ergoplatform.org/en/blog/2020-11-18-ergo-foundation-makes-key-dapp-infrastructure-grant/). Ergo is a community-oriented project, with many contributors to various aspects of the ecosystem. If you have a great idea which you are looking to implement that would improve the Ergo ecosystem as a whole, please feel free to apply for an Ergo Foundation grant by emailing your proposal to: ergoplatform@protonmail.com.
94 |
--------------------------------------------------------------------------------
/.github/ergo-bootstrap.svg:
--------------------------------------------------------------------------------
1 |
2 |
4 |
89 |
--------------------------------------------------------------------------------
/ergo-bootstrap:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 |
3 | if ! command -v docker &> /dev/null
4 | then
5 | echo "ERROR: docker could not be found, please install it."
6 | echo "Visit https://docs.docker.com/get-docker/ for more information."
7 | exit 1
8 | fi
9 |
10 | if ! command -v docker-compose &> /dev/null
11 | then
12 | echo "ERROR: docker-compose could not be found, please install it."
13 | echo "Visit https://docs.docker.com/compose/install/ for more information."
14 | exit 1
15 | fi
16 |
17 | init () {
18 | if [ -f ./docker-compose.yml ]; then
19 | echo "ERROR: ☝ Your cluster is already initialized."
20 | echo "Run \"$0 status\" or \"$0 destroy\"."
21 | echo
22 | exit 1
23 | fi
24 |
25 | clear
26 | echo -e "\e[1m"
27 | echo " Welcome to Σrgo bootstrap!"
28 | echo -e "\e[0m"
29 | echo "We're going to initialize a new Ergo Bootstrap cluster for you."
30 | echo
31 | echo "The Ergo blockchain node is the core of this bootstrap cluster, but there are"
32 | echo "other components that you might find useful. Please refer to the documentation"
33 | echo -e "available at \e[33mhttp://github.com/ergoplatform/ergo-bootstrap\e[39m to find out more about"
34 | echo "each of these components."
35 | echo
36 | echo "❔ Do you wish to initialize the Ergo Explorer API?"
37 | select yn1 in "Yes" "No"; do
38 | case $yn1 in
39 | Yes ) export INIT_EXPLORER_API=true;break;;
40 | No ) export INIT_EXPLORER_API=false;break;;
41 | * ) echo "Invalid choice.";
42 | esac
43 | done
44 | echo
45 | echo "❔ Do you wish to initialize the Ergo Explorer Frontend?"
46 | select yn2 in "Yes" "No"; do
47 | case $yn2 in
48 | Yes ) export INIT_EXPLORER_FRONTEND=true;break;;
49 | No ) export INIT_EXPLORER_FRONTEND=false;break;;
50 | * ) echo "Invalid choice.";
51 | esac
52 | done
53 | echo
54 | echo "❔ Do you wish to initialize the Yoroi backend?"
55 | select yn3 in "Yes" "No"; do
56 | case $yn3 in
57 | Yes ) export INIT_YOROI_BACKEND=true;break;;
58 | No ) export INIT_YOROI_BACKEND=false;break;;
59 | * ) echo "Invalid choice.";
60 |
61 | esac
62 | done
63 | echo
64 | echo "❔ Would you like to spin up monitoring for your cluster?"
65 | select yn4 in "Yes" "No"; do
66 | case $yn4 in
67 | Yes ) export INIT_MONITORING=true;break;;
68 | No ) export INIT_MONITORING=false;break;;
69 | * ) echo "Invalid choice.";
70 | esac
71 | done
72 |
73 | cat compose/common.yml > docker-compose.yml
74 | if $INIT_EXPLORER_API; then cat compose/explorer-backend.yml >> docker-compose.yml; fi;
75 | if $INIT_EXPLORER_FRONTEND; then cat compose/explorer-frontend.yml >> docker-compose.yml; fi;
76 | if $INIT_YOROI_BACKEND; then cat compose/yoroi-backend.yml >> docker-compose.yml; fi;
77 | if $INIT_MONITORING; then cat compose/monitoring.yml >> docker-compose.yml; fi;
78 | echo >> docker-compose.yml
79 | echo "# Generated on $(date) by ergo-bootstrap" >> docker-compose.yml
80 | echo
81 |
82 | echo "Congratulations! Your cluster has been initialized. Pick up"
83 | echo "a good book, brew some coffee, this will take some time."
84 | echo
85 | echo "Press Enter to Continue."
86 | read -n 1
87 | docker-compose up -d --remove-orphans
88 | }
89 |
90 | start () {
91 | docker-compose start
92 | }
93 |
94 | stop () {
95 | docker-compose stop
96 | }
97 |
98 | status () {
99 |
100 | DOCKER_COMPOSE_PS=$(docker ps -a --format 'table {{.Names}}\t{{.ID}}\t{{.Status}}\t{{.Ports}}');
101 | echo "$DOCKER_COMPOSE_PS" | egrep 'ergo|NAME'
102 | echo
103 | # TODO: Extract the port numbers directly from containers and test with nc if they are up
104 | [[ "echo \"$DOCKER_COMPOSE_PS\" | grep Up" =~ "ergo-node" ]] && echo "Ergo Node Panel http://localhost:9053/panel/ (API key: hello)"
105 | [[ "echo \"$DOCKER_COMPOSE_PS\" | grep Up" =~ "ergo-node" ]] && echo "Ergo Node API http://localhost:9053/ (API key: hello)"
106 | [[ "echo \"$DOCKER_COMPOSE_PS\" | grep Up" =~ "ergo-explorer-api" ]] && echo "Ergo Explorer API http://localhost:8080/"
107 | [[ "echo \"$DOCKER_COMPOSE_PS\" | grep Up" =~ "ergo-explorer-frontend" ]] && echo "Ergo Explorer http://localhost:5000/"
108 | [[ "echo \"$DOCKER_COMPOSE_PS\" | grep Up" =~ "yoroi" ]] && echo "Yoroi backend API http://localhost:3001/api/v2/bestblock"
109 | [[ "echo \"$DOCKER_COMPOSE_PS\" | grep Up" =~ "grafana" ]] && echo "Grafana metrics http://localhost:3000/ (user: admin / password: admin)"
110 |
111 | }
112 |
113 | destroy () {
114 |
115 | if [ ! -f ./docker-compose.yml ]; then
116 | echo "Could not find an existing configuration."
117 | echo "Run \"$0 init\" to create a new cluster."
118 | echo
119 | exit 1
120 | fi
121 | echo "Here be dragons!"
122 | echo
123 | echo "Do you REALLY want to DESTROY your current cluster?"
124 | select yn1 in "Yes" "No"; do
125 | case $yn1 in
126 | Yes ) break;;
127 | No ) exit;;
128 | * ) echo "Invalid choice.";
129 | esac
130 | done
131 | echo
132 | docker-compose rm -s
133 | rm docker-compose.yml
134 | echo
135 | DANGLING_VOLUMES=$(docker volume ls --format '{{.Name}}'|grep ergo-bootstrap)
136 | echo
137 | echo "The following volumes have been left after the cluster:"
138 | echo
139 | echo "$DANGLING_VOLUMES"
140 | echo
141 | echo "Do you REALLY want to DESTROY your current cluster volumes? You will lose all data."
142 | select yn1 in "Yes" "No"; do
143 | case $yn1 in
144 | Yes ) break;;
145 | No ) exit;;
146 | * ) echo "Invalid choice.";
147 | esac
148 | done
149 | echo
150 | echo "$DANGLING_VOLUMES" | xargs -r docker volume rm
151 | echo "All gone."
152 | }
153 |
154 | case "$1" in
155 | init)
156 | init
157 | ;;
158 |
159 | start)
160 | start
161 | ;;
162 | stop)
163 | stop
164 | ;;
165 | status)
166 | status
167 | ;;
168 | destroy)
169 | destroy
170 | ;;
171 | *)
172 | echo "Usage: $0 {init|status|destroy}"
173 | echo
174 | echo " init Initialize an ergo bootstrap cluster"
175 | echo " start Start the cluster"
176 | echo " stop Stop the cluster"
177 | echo " status Get status of an initialized cluster"
178 | echo " destroy Destroy the current cluster"
179 | exit 1
180 | esac
181 |
--------------------------------------------------------------------------------
/.github/ergo-bootstrap-init.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
2 |
3 | # Ergo Bootstrap
4 |
5 | Ergo bootstrap tool, build on top of [ergo-nix](https://github.com/ergoplatform/ergo-nix), will help you to quickly deploy an Ergo blockchain cluster with a handful of useful tools you might need to start developing your dApps.
6 |
7 |