mx-chain-go

README

mx-chain-go

The go implementation for the MultiversX protocol

Installation and running

In order to join the network as an observer or as a validator, the required steps to build from source and setup explicitly are explained below.

Step 1: install & configure go:

The installation of go should proceed as shown in official golang installation guide https://golang.org/doc/install . In order to run the node, minimum golang version should be 1.17.6.

Step 2: clone the repository and build the binaries:

The main branch that will be used is the master branch. Alternatively, an older release tag can be used.

# set $GOPATH if not set and export to ~/.profile along with Go binary path
$ if [[ $GOPATH=="" ]]; then GOPATH="$HOME/go" fi
$ mkdir -p $GOPATH/src/github.com/multiversx
$ cd $GOPATH/src/github.com/multiversx
$ git clone https://github.com/multiversx/mx-chain-go
$ cd mx-chain-go && git checkout master
$ cd cmd/node && go build

The node depends on the Wasm Virtual Machine, which is automatically managed by the node.

Step 3: creating the node’s identity:

In order to be registered in the MultiversX Network, a node must possess 2 types of (secret key, public key) pairs. One is used to identify the node’s credential used to generate transactions (having the sender field its account address) and the other is used in the process of the block signing. Please note that this is a preliminary mechanism, in the next releases the first (private, public key) pair will be dropped when the staking mechanism will be fully implemented. To build and run the keygenerator, the following commands will need to be run:

$ cd $GOPATH/src/github.com/multiversx/mx-chain-go/cmd/keygenerator
$ go build
$ ./keygenerator

Start the node

Step 4a: Join MultiversX testnet:

Follow the steps outlined here. This is because in order to join the testnet you need a specific node configuration.

---

OR

---

Step 4b: copying credentials and starting a node in a separate network:

The previous generated .pem file needs to be copied in the same directory where the node binary resides in order to start the node.

$  cp validatorKey.pem ./../node/config/
$  cd ../node && ./node

The node binary has some flags defined (for a brief description, the user can use --help flag). Those flags can be used to directly alter the configuration values defined in .toml/.json files and can be used when launching more than one instance of the binary.

Running the tests

$ go test ./...	

Compiling new fields in .proto files (should be updated when required PR will be merged in gogo protobuf master branch):

1. Download protoc compiler: https://github.com/protocolbuffers/protobuf/releases (if you are running under linux on a x64 you might want to download protoc-3.11.4-linux-x86_64.zip)
2. Expand archive, copy the /include/google folder in /usr/include using
   sudo cp -r google /usr/include
3. Copy bin/protoc using
   sudo cp protoc /usr/bin
4. Fetch the repo github.com/multiversx/protobuf
5. Compile gogo slick & copy binary using

cd protoc-gen-gogoslick
go build
sudo cp protoc-gen-gogoslick /usr/bin/

Done

Running p2p Prometheus dashboards

1. Start the node with --p2p-prometheus-metrics flag. This exposes a metrics collection at http://localhost:8080/debug/metrics/prometheus (port defined by -rest-api-interface flag, default 8080)
2. Clone libp2p repository: git clone https://github.com/libp2p/go-libp2p
3. cd go-libp2p/dasboards/swarm and under the

"templating": {
   "list": [

section, add the following lines:

{
  "hide": 0,
  "label": "datasource",
  "name": "DS_PROMETHEUS",
  "options": [],
  "query": "prometheus",
  "refresh": 1,
  "regex": "",
  "type": "datasource"
},

(this step will be removed once it will be fixed on libp2p) 4. cd .. to dashboards directory and update the port of host.docker.internal from prometheus.yml to node's Rest API port(default 8080) 5. From this directory, run the following docker compose command:

sudo docker compose -f docker-compose.base.yml -f docker-compose-linux.yml up --force-recreate

Note: If you choose to install the new Docker version manually, please make sure that installation is done for all users of the system. Otherwise, the docker command will fail because it needs the super-user privileges. 6. The preconfigured dashboards should be now available on Grafana at http://localhost:3000/dashboards

Progress

Done

• Cryptography
  • Schnorr Signature
  • Belare-Neven Signature
  • BLS Signature
  • Modified BLS Multi-signature
• Datastructures
  • Transaction
  • Block
  • Account
  • Trie
• Execution
  • Transaction
  • Block
  • State update
  • Synchronization
  • Shard Fork choice
• Peer2Peer - libp2p
• Consensus - SPoS
• Sharding - fixed number
  • Transaction dispatcher
  • Transaction
  • State
  • Network - Message dispatching
• MetaChain
  • Data Structures
  • Block Processor
  • Interceptors/Resolvers
  • Consensus
• Block K finality scheme
• VM - K-Framework
  • K Framework go backend
  • IELE Core
  • IELE Core tests
  • IELE Adapter
• Smart Contracts on a Sharded Architecture
  • Concept reviewed
  • VM integration
  • SC Deployment
• Governance
  • Concept reviewed
• Economics
  • Concept reviewed
• Optimizations
  • Randomness
  • Consensus
• Bootstrap from storage
• Testing
  • Unit tests
  • Integration tests
  • TeamCity continuous integration
  • Manual testing
• Epochs
  • Nodes dispatcher (shuffling)
• Network sharding
  • Optimized wiring protocol
• VM
  • EVM Core
  • EVM Core tests
  • EVM Adapter
• Fee structure
• Smart Contracts on a Sharded Architecture
  • Async callbacks
• Testing
  • Automate tests with AWS
  • Nodes Monitoring
• DEX integration

In progress

• Smart Contracts on a Sharded Architecture
  • Dependency checker + SC migration
  • Storage rent + SC backup & restore
• Adaptive State Sharding
  • Splitting
  • Merging
  • Redundancy
• Privacy
• Interoperability
• Optimizations
  • Smart Contract
• Governance
  • SC for ERD IP
  • Enforced Upgrade mechanism for voted ERD IP
• Bugfixing

Contribution

Thank you for considering to help out with the source code! We welcome contributions from anyone on the internet, and are grateful for even the smallest of fixes to MultiversX!

If you'd like to contribute to MultiversX, please fork, fix, commit and send a pull request for the maintainers to review and merge into the main code base. If you wish to submit more complex changes though, please check up with the core developers first here on GitHub, to ensure those changes are in line with the general philosophy of the project and/or get some early feedback which can make both your efforts much lighter as well as our review and merge procedures quick and simple.

Please make sure your contributions adhere to our coding guidelines:

• Code must adhere to the official Go formatting guidelines.
• Code must be documented adhering to the official Go commentary guidelines.
• Pull requests need to be based on and opened against the master branch.
• Commit messages should be prefixed with the package(s) they modify.
  • E.g. "outport/process: fixed a typo"

Please see the documentation for more details on the MultiversX protocol.