nearcore: A Rust repository from alexshvid

NEAR Protocol - scalable and usable blockchain

NEAR Protocol is a new smart-contract platform that delivers scalability and usability.

Through sharding it aims to linearly scale with number of validation nodes on the network.

Leveraging WebAssembly, TypeScript, more sane contract management, ephemeral accounts and many other advancement, NEAR makes using blockchain protocol for developers and consumers way easier compared to competitors.

Status

Project is currently under heavy development. Please see Issues and Milestones to checkout the current progress and work items.

High level milestones:

DevNet: a tool with fully working State Transition + WebAssembly.
MVB: Minimum viable blockchain with smart contracts, supporting TxFlow and on chain governance.
Shard chains: support for fully scalable sharded blockchain.

Building

Setup rust

$ curl https://sh.rustup.rs -sSf | sh
$ rustup component add clippy-preview

You may need to activate the environment via . ~/.cargo/env to use cargo.

Build & Run from source code

# Download NEAR Core code.
git clone https://github.com/nearprotocol/nearcore
cd nearcore

It will build the first time and then run:

cargo run --release

Simple Install for Mac and Linux

Coming soon.

DevNet

DevNet is a development tool that runs WebAssembly and State transition without running blockchain/consensus functionality.

To build and run it:

cargo run --release --package=devnet

Try submitting transactions or views via JSON RPC:

# See usage of rpc helper script
$ ./scripts/rpc.py --help

# Get usage of sub command
$ ./scripts/rpc.py send_money --help

# Send money
$ ./scripts/rpc.py send_money -r bob -a 1

# Deploy a smart contract
./scripts/rpc.py deploy test_contract core/wasm/runtest/res/wasm_with_mem.wasm

# Call method 'run_test' for contract 'test_contract'
./scripts/rpc.py call_method test_contract run_test

# View state for Bob's account
./scripts/rpc.py view -a bob

Development

If you are planning to contribute, there are few more things to setup

Setup git hooks

./scripts/setup_hooks.sh

Setup rustfmt for your editor (optional)

Installation instructions here

Lints

We currently use clippy to enforce certain standards. This check is run automatically during CI builds, and in a pre-commit hook. You can run do a clippy check with ./scripts/run_clippy.sh.

Documentation

Check out documentation at http://docs.rs/nearcore

alexshvid/nearcore