gmfcastro / simplechain

This is a simple private blockchain implementation

Simple Chain

This is a start implementation of a simple chain blockchain being cosumed by restful apis using Hapi.js framework.

Getting Started

Prerequisites

You need the LTS verion of node installed in your machine. You can get it here : https://nodejs.org/en/

Installing

After having the node installed you can fork this project into your account and clone it. In the root folder of the project execute:

npm install

And to start the project you need to run:

npm start

Running tests

After having all node dependencies installed you can run:

npm test

Configuration

Inside of the project you have a .env folder that contains a config folder inside with a json that you can add your enviroments configurations of host and port:

{
    "<YOUR_ENV>" : {
        "host" : "<YOUR_HOST>",
        "port" : "<YOUR_PORT>"
    }
}

By default if you don't specify any environment the project will use the dev configured already. If you want to use your configuration you can execute the project like this:

ENV=<YOUR_ENV> npm start

Endpoints

GET /block/{block_height}

In this endpoint you can get the block height disared by passing at the end of path param;

GET /stars/address:{address}

In this endpoint you can get the block by the wallet address disared by passing at the end of path param;

GET /stars/hash:{hash}

In this endpoint you can get the block by the hash disared by passing at the end of path param;

POST /block

In this enpoint you can add a new block (Star Registry) to the chain the body should contain some data following this:

{
	"address": <WALLET_ADDRESS>, (REQUIRED)
	"star":  {
		"ra": "<RIGHT_ASCESION>", (REQUIRED)
		"dec": "<DECLINATION>", (REQUIRED)
		"story": "<STORY>" (REQUIRED, max of 250 words / 500 bytes ),
        "mag": "<MAGNITUDE>" (OPTIONAL),
        "cons": "<CONSTELATION>" (OPTIONAL)
	}
}

POST /requestValidation

In this endpoint is where you start asking for a star registration in the block. You should pass:

{
	"address": <WALLET_ADDRESS>, (REQUIRED)
}

POST /message-signature/validate

After asking for a validation you shoul sign the message returned /requestValidation endpoint and call this endpoint with:

{
	"address": <WALLET_ADDRESS>, (REQUIRED)
    "signature": <SIGNED_MESSAGE> (REQUIRED)
}

Built With

• Node.js
• Hapi.js - The web framework used
• NPM - Dependency Management

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Guilherme NMDfc - Initial work