Skip to content

Latest commit

 

History

History
128 lines (78 loc) · 5.17 KB

README.md

File metadata and controls

128 lines (78 loc) · 5.17 KB
Raw

Insolar MainNet

Insolar MainNet is the application that implements smart contracts logic for Insolar MainNet.

This application works on top of Insolar Platform 1.0 and allows you to:

  • Create Insolar Wallet

  • Migrate INS onto Insolar exchanging INS to XNS 1:10 where INS is Ethereum ERC-20 token and XNS is Insolar native coin

  • Deposit migrated tokens into the Wallet

  • Transfer XNS to Insolar MainNet users

  • Receive XNS from Insolar MainNet users

Quick start

Run Insolar MainNet locally:

  1. Install this application.
  2. Deploy this application locally.
  3. Test this application locally.

These steps are detailed below.

Install

  1. Install Golang programming tools v1.12. For example, from golang.org. Set the $GOPATH environment variable.

  2. Download the MainNet package:

    go get github.com/insolar/mainnet

  3. Go to the package directory:

    cd $GOPATH/src/github.com/insolar/mainnet

  4. Install dependencies and build binaries using the makefile that automates this process:

    make

Deploy locally

In the directory where you downloaded the MainNet package to, run the launcher:

insolar-scripts/insolard/launchnet.sh -g

The launcher generates the necessary bootstrap data, starts a pulse watcher, and launches a number of nodes. In a local setup, the "nodes" are simply services listening on different ports.

The default number of nodes is 5. You can vary this number by commenting/uncommenting nodes in the discovery_nodes section in scripts/insolard/bootstrap_template.yaml.

Test locally

Run either benchmark or functional tests.

Benchmark test

When the pulse watcher says INSOLAR STATE: READY, you can run a benchmark in another terminal tab/window:

bin/benchmark -c=4 -r=25 -k=.artifacts/launchnet/configs/

Options:

  • -k: Path to the root user's key pair.
  • -c: Number of concurrent threads in which requests are sent.
  • -r: Number of transfer requests to be sent in each thread.

Functional tests

These tests aim to assess operability of the app and include creating user accounts; migrating INS to MainNet using mockups; exchanging INS for XNS using mockups; transferring XNS between user accounts.

To run the tests, wait till the pulse watcher says INSOLAR STATE: READY and do the following in another terminal tab/window:

  1. Copy the bootstrap config from the launchnet folder to launchnet/config:

    cp .artifacts/launchnet/bootstrap.yaml .artifacts/launchnet/configs/bootstrap.yaml

  2. Run the tests:

    INSOLAR_FUNC_RPC_URL=http://localhost:19001/admin-api/rpc INSOLAR_FUNC_RPC_URL_PUBLIC=http://localhost:19101/api/rpc INSOLAR_FUNC_KEYS_PATH=../../.artifacts/launchnet/configs INSOLAR_ARTIFACTS_DIR=../../.artifacts go test -test.v -tags "functest" ./application/functest

Contribute!

Feel free to submit issues, fork the repository and send pull requests!

To make the process smooth for both reviewers and contributors, familiarize yourself with the following guidelines:

  1. Open source contributor guide.
  2. Style guide: Effective Go.
  3. List of shorthands for Go code review comments.

When submitting an issue, include a complete test function that reproduces it.

Thank you for your intention to contribute to the Insolar MainNet project. As a company developing open-source code, we highly appreciate external contributions to our project.

Contacts

If you have any additional questions, join our developers chat on Telegram.

Our social media:

License

This project is licensed under the terms of the MIT License.