my-cloud / ruthenium

Golang implementation of the Ruthenium protocol

Ruthenium

Description

Golang implementation of the Ruthenium protocol.

You will find a detailed description of the project in the wiki. To understand the motivations behind the creation of this blockchain, you can peruse the comprehensive details outlined in the Ruthenium whitepaper.

Quickstart

There are two ways to run a Ruthenium node. 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.
  • If you are using Windows, you need to have tdm-gcc installed.
• Option B (using docker image):
  • You need to have installed.
• Your firewall port 10600 must be open (please read "Program arguments" section of the node and UI server documentation if you want to use another port than 10600).
• 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>
    

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

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

  • Run the UI server:

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

• 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 - [email protected]

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

While the main principles have been implemented, there is still a substantial amount of refactoring and test implementation remaining.

ruthenium's Issues

Block can have no reward recipient

Investigate if it can be an issue (i.e. to find the oldest reward recipient) and if so, solve it by adding a rule to always have a single reward recipient

Remove scheduled deployement

Implement Proof of Humanity

In GitLab by @Styks on Aug 22, 2022, 15:23

Use PoH instead of PoW.

Use broadcast messages

• Use broadcast messages to send to the client:
  • success or failure messages
  • message informing that the wallet amount has changed
  • message informing that the transactions pool has changed
• Do the appropriated treatment when receiving a message

💡see https://pkg.go.dev/context#Context.Done and use it here

Update readme

Create a blockchain following a course

In GitLab by @Styks on Jul 5, 2022, 14:23

adding DevOps mechanism

In GitLab by @gwenall on Aug 7, 2022, 18:01

• Create Dockerfile
• Create basic kuberenetes deployment manifests
• Create gitlab-ci

Set up Github CI

Fix error management

In GitLab by @Styks on Aug 5, 2022, 12:49

Transaction don't have fee

If there is no transaction fee, the blockchain network is vulnerable to transactions spam.

• Add transaction fee

Store and load the blockchain from a file

Context
Verifying the whole blockchain might take more time as it grows up.

Description
A lot of time can be saved if the blockchain can be stored into a file to be loaded the next time the node is started.

Tasks
Try to split the feature into small tasks.

• Make it possible to store the blockchain into a file
• Make it possible to load the blockchain from a file

Deploy docker image for release branches

Support environment variables as program argument

In GitLab by @Styks on Aug 8, 2022, 08:00

Allow external p2p connections

In GitLab by @Styks on Jul 26, 2022, 13:50

Incorrect conversion from string to uint32

https://github.com/my-cloud/ruthenium/security/code-scanning/1

Scan code with Github CI

Run unit tests using the ci pipeline

In GitLab by @Styks on Aug 8, 2022, 07:59

Limit block size

Context
A hudge transactions count might lead to a blockchain propagation time to out of the validation delay.

Description
The problem might be avoided by limiting the number of transactions to be included into the next block. Higher transactions fees might be applied to ensure a transaction to be in the next block.

Tasks

• Limit the block size or the number of transactions to be included into the next block.
• If needed, propose to pay more fees to increase the chance of a transaction to be in the next block.

Fix get amount error when address is empty

In GitLab by @Styks on Jul 27, 2022, 18:44

When the wallet address is empty in a request from wallet side, the blochain side logs error because of a nil pointer dereference.

• log it on wallet side only
• handle the case to not get a nil pointer dereference on blockchain side

Fix wrong default port

The default port is 8106 instead of 8080

• change the default port from 8106 to 8080

Improve contributing documentation

• Improve the CONTRIBUTING.md file
• Link the CONTRIBUTING.md in the README.md

Limit Outbounds

In GitLab by @Styks on Sep 7, 2022, 12:07

• Limit Outbound connections to 8
• Change the validation process:
  • Validate
  • Resolve conflicts every 10 seconds
  • Don't ask for consensus
• Remove consensus from the API

Improve blockchain reliability

In GitLab by @Styks on Jul 22, 2022, 08:21

1. Only clear the transaction pool if a new block is validated
2. Remove DeleteTransactions from the blockchain API
3. Disallow start mining more than once

Automatically release

Implement the decay principle

In GitLab by @Styks on Aug 8, 2022, 17:47

Since the ruthenium (106) is a radioelement, it should decay.

Use ethereum encryption

In GitLab by @Styks on Aug 25, 2022, 22:01

Validate transaction

In GitLab by @Styks on Aug 2, 2022, 14:37

• Make the transaction be added to the pool only if the sender address correspond to the public key

Document the APIs

Since the semver is related to an API, it should be documented.

Extract configuration variables

Context
Some of the constants defined in the project might have to be changed later on. It is a shame to modify source code to just change a setting.

Description
Most of the constants might be extracted to a configuration file

Tasks

• Extract constants into a configuration file.

Update module name

the go.mod module name points to the gitlab repository. Update it to reflect the github repository.

Use P2P

In GitLab by @Styks on Jul 13, 2022, 09:12

Update release documentation

When merging with rebase onto main, each commit is added individually, and their revision identifiers seem to differ from those of dev. To avoid conflicts for the next release, the release branch must be merged locally to main.

Verify neighbors requests

In GitLab by @Styks on Aug 2, 2022, 08:43

• Don't add in a new block the transactions from a sender wallet which have insufficient amount
• Make ResolveConflict not accepting a blockchain with transactions which could not have been performed (verify signature and amount)
• Propagate transactions pool
• Make ResolveConflict not accepting a blockchain with mining rewards exceeding the consented one
• Verify mining delay

Display transactions pool in the UI

In GitLab by @Styks on Aug 5, 2022, 10:28

Manage neighbor disconnection

In GitLab by @Styks on Aug 4, 2022, 18:10

Add universal basic income

Context
Since the wallet amount is decreasing, people need a basic income to be interested in creating an account.
Since the validators need an incentive to add as much as transactions as possible into the next block, the reward must depend on transaction fees.

Description
The validator reward must be replaced by the transaction fees.
Every wallet must get a basic income.

Tasks

• Verify the Proof of Humanity for every wallet
• Give a basic income to every wallet that is registered
• Replace the actual reward calculation by the transaction fees

Deploy a package on release

Block transactions amounts are not verified

• Verify that block transactions amounts does not exceed wallet amount

Proof of Humanity is known using a REST API instead of directly reading smart contract

For a first implementation, we taken the easy way. To know if someone is registered in the Proof of Humanity registry, we are requesting this REST API. This is a vulnerability because the data is centralized. We need to gather the information in a decentralized manner. To do so, we can directly read the isRegistered value from the Proof of Humanity smart contract.

• Directly read the Proof of Humanity smart contract isRegistered value

💡 Here is where the REST API is called in our code

💡 This seems to be a good tutorial to know how to read a smart contract

Use uint64 for transaction value

In GitLab by @Styks on Aug 5, 2022, 17:58

There are calculus issues with floating points number find a way to only use unsigned integers.

Automatically deploy a docker image

Limit Inbounds

In GitLab by @Styks on Sep 11, 2022, 14:41

Improve project structure

In GitLab by @Styks on Jul 22, 2022, 08:34

Add a CI linter

• add the following job in the quality workflow:

jobs:
  lint:
    name: Lint
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-go@v3
        with:
          go-version: 1.18
      - uses: golangci/golangci-lint-action@v3

Improve neighbors finding

In GitLab by @Styks on Jul 22, 2022, 08:20

• Fix timeout error (read tcp 192.168.1.90:5000->192.168.1.90:62368: i/o timeout)
• Find neighbors only when needed
• Investigate about how is done the neighbor finding for famous blockchains and apply it

Same previous hash verification is wrong

Clean code

In GitLab by @Styks on Jul 27, 2022, 18:55

Change release process

We need to create a release branch

• edit the contributing file
• edit the docker-publish.yml
• add LABEL org.opencontainers.image.description DESCRIPTION in the Dockerfile

Simplify reward calculation

Wip packages are publicly visible

• In the ruthenium/.github/workflows/docker-publish.yml file, remove the dev branch.

Instead of:

on:
  push:
    branches: [ "main", "dev" ]

We want:

on:
  push:
    branches: [ "main" ]