ruthenium

README

Ruthenium

Description

The Ruthenium blockchain protocol.

This README contains essential information for a quick start. You will find a detailed description of the project in the wiki. If you want to know what reasons led to create this blockchain, you can directly dive into the Ruthenium whitepaper.

Quickstart

There are two ways to use the Ruthenium blockchain. You can either use your own build from sources (Option A) or use a docker image provided in the repository packages (Option B).

Prerequisites

• Option A (using sources):
  • You need to have installed.
• Option B (using docker image):
  • You need to have installed.
• Your DNS port 8106 must be open.
• To get an income or validate blocks ou need to be registered in the Proof of Humanity registry.

Installation

• Option A (using sources):
  • Download the sources archive:

    https://github.com/my-cloud/ruthenium/releases/latest
    

• Option B (using docker image):
  • Pull the image:

    sudo docker pull ghcr.io/my-cloud/ruthenium:latest
    

Launch

• Option A (using sources):
  • Extract files from the sources archive
  • At root level (ruthenium folder), run the node:

    go run src/node/main.go -private-key=<private key>
    

  • At root level (ruthenium folder), run the UI server:

    go run src/ui/main.go -host-ip=<your external IP address> -private-key=<private key>
    

• Option B (using docker image):
  • Run the node:

    sudo docker run -p 8106:8106 -ti ghcr.io/my-cloud/ruthenium:latest \app\node -host-ip=<your external IP address> -private-key=<private key>
    

  • Run the UI server:

    sudo docker run -p 8080:8080 -ti ghcr.io/my-cloud/ruthenium:latest \app\ui -private-key=<private key>
    

• Using a web browser, go to:
  • http://localhost:8080

APIs

• host node API
• UI server API

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please do not hesitate to report a new bug or request a new feature. Of course, you are welcome to fork the repository and create a pull request. In any case, please let's take a look at the contributing file.

⭐ Don't forget to give the project a star! Thanks again!

Contact

Founder: Jérémy Pansier - jpansier@my-cloud.me

Repository: https://github.com/my-cloud/ruthenium

Authors and Acknowledgments

Special thanks to Gwenall Pansier who contributed since the early developments.

For a tutorial to create a first blockchain in Go, thanks to Yuko Sakai & Jun Sakai.

License

Project status

The main principles have been implemented.

Now it needs a lot of refactoring and tests to improve maintainability and reliability.