#local #local-node #management #setup #bootstrap #compose #electroneum

app etnsc-bootstrap

A tool for quick Electroneum local node setup and management

5 releases (2 stable)

new 1.1.0 Mar 9, 2025
1.0.0 Mar 9, 2025
0.1.3 Mar 7, 2025
0.1.2 Mar 7, 2025
0.1.1 Mar 7, 2025

#215 in Command line utilities

Download history 170/week @ 2025-03-02

170 downloads per month

MIT license

16KB
330 lines

etnsc-bootstrap is a tool for bootstrapping Electroneum local chain for development.

This is my submission to Electroneum hackathon 2025.

Prerequisites

This tool should work on Linux, MacOS and Windows. The only requirement is having docker with compose plugin installed. If you don't have them available yet, go through the installation guide. Docker binary should be available on your PATH.

Features

  • No more go build hassle and local filesystem management!
  • Start, stop and recreate the node in one command.
  • Pre-seed accounts when node is launched - no need to do it manually.
  • All your team members will run exactly the same reproducible setup.
  • Forget about long builds and setups: runs in your favorite CI tool as well!
  • In progress: install from npm or PyPI.

Quickstart

To begin, grab a binary for your architecture from the Releases page.

First, run init to create a docker-compose file. You can tweak it as needed and add other services. All configuration is done via environment variables documented in that file.

Now you can launch the node. By default it provides HTTP API (port 8545) and websocket API (port 8546), you can change that if necessary. You can reach it at the electroneum-node host (from other containers) and directly on localhost from your host system.

If you are already using compose, you can change the file name with -f flag (to be provided to every subcommand) or with ETNSC_COMPOSE_FILE environmental variable.

$ npx etnsc-bootstrap init
$ npx etnsc-bootstrap start

Read help for more:

$ npx etnsc-bootstrap help

Installation

The easiest way is to use npx if you have it installed:

$ npx etnsc-bootstrap init
$ npx etnsc-bootstrap start

You can just download a binary for your OS and arch from the Releases page, unpack and run it. cargo install also works, if you have the Rust toolchain available:

$ cargo install etnsc-bootstrap

Dependencies

~3–10MB
~96K SLoC