networkHub

ALPHA Version Note

This repository is under alpha revision, beware when using it. Please wait for the first stable release for production use.

Introduction

networkHub is a versatile framework designed to streamline the process of launching custom Vechain networks across various environments. It is tailored specifically for protocol and dapp development teams, providing a robust toolset to configure, start, stop, and manage blockchain networks with ease.

Quick start

Launch Pre-configured Network via command line:

# Setup the preset network
> go run cmd/main.go cmd preset local threeMasterNodesNetwork /Users/pedro/go/src/github.com/vechain/thor/bin/thor
...
2024/06/07 17:31:43 INFO preset network config was successful... networkId=localthreeMaster

# Start preset network
> go run cmd/main.go cmd start localthreeMaster
2024/06/07 17:31:57 INFO Registered preset network networkId=threeMasterNodesNetwork
2024/06/07 17:31:57 INFO Registered preset network networkId=sixNodesNetwork
2024/06/07 17:31:57 INFO Starting network... ID=localthreeMaster
...

Launch Pre-configured Network via command line using Docker:

# Setup the preset network
> go run cmd/main.go cmd preset docker threeMasterNodesNetwork vechain/thor:latest
...
2024/06/13 17:15:18 INFO Configuring network...
2024/06/13 17:15:18 INFO Network saved to file filepath=/Users/pedro/go/src/github.com/vechain/networkhub/networks_db.json
2024/06/13 17:15:18 INFO preset network config was successful... networkId=dockerthreeMaster

# Start preset network
> go run cmd/main.go cmd start dockerthreeMaster
2024/06/13 17:16:05 INFO Network created networkName=dockerthreeMaster-network
2024/06/13 17:16:06 INFO network started successfully...
...

Launch Pre-configured Network via API server:

# Start the networkhub api
go run ./cmd/main.go api

# Response
api called
Server started on :8080

# Start a local pre-setup configured network 
# Must specify the path to thor locally
curl -X POST http://localhost:8080/preset/threeMasterNodesNetwork \
   -d '{"artifactPath":"/Users/pedro/go/src/github.com/vechain/thor/bin/thor", "environment":"local"}'

 # Response
{"networkId": "localthreeMasterNodes"}

# Start the network
curl -X GET http://localhost:8080/start/localthreeMasterNodes

# Response
Network Started

Purpose and Scope

networkHub enables teams to quickly deploy custom networks, facilitating development and testing in a controlled environment. This framework is especially beneficial for protocol and dapp teams looking to experiment with network configurations and behaviors without the overhead of setting up infrastructure from scratch.

Technical Requirements

• Git: For cloning the repository.
• Golang: Version 1.19 or higher.

Setup

To setup networkHub, follow these steps:

1. Clone the repository:

   git clone https://github.com/vechain/networkhub

2. Build the application:

   go build -o networkHub ./cmd/main.go

3. To run networkHub, execute:

   ./networkHub

   or

   go run ./cmd/main.go

   This will display the available command-line options.

Running the API

To launch the framework in API mode, use the following command:

./networkHub api

or

go run ./cmd/main.go api

Usage Examples

Below are some example curl requests to interact with the networkHub via its HTTP API. (Note: Replace <api-url> with the actual URL where networkHub API is hosted.)

• Configure Network:

  # Request
  curl -X POST <api-url>/config -d '{...}' # {...} is a network config json
  
  # Response
  {"networkId": "8b38927893d1fc841b7bedcbaebb03821000908cfa1ee07a09002bc0e0ed3caf"}

• Start Network:

  # Request
  curl -X POST <api-url>/start/8b38927893d1fc841b7bedcbaebb03821000908cfa1ee07a09002bc0e0ed3caf
  
  # Response
  Network Started

• Stop Network:

  # Request
  curl -X POST <api-url>/stop/8b38927893d1fc841b7bedcbaebb03821000908cfa1ee07a09002bc0e0ed3caf
  
   # Response
  Network Stopped

Project Structure

• Entrypoints: Interface to interact with the framework. Currently implemented as an HTTP API server.
• Actions: Domain-specific language (DSL) that allows users to configure, start, stop, and request information on networks.
• Environments: Interface for running networks in different environments, with the Local environment currently implemented.