NEAR Protocol - scalable and usable blockchain

• ⚖️ NEAR Protocol is a new smart-contract platform that delivers scalability and usability.
• 🛠 Through sharding, it will linearly scale with the number of validation nodes on the network.
• 🗝 Leveraging WebAssembly, TypeScript, more sane contract management, ephemeral accounts and many other advancements, NEAR finally makes using a blockchain protocol easy for both developers and consumers.

Quick start

Check out quick start documentation, specifically:

• Working with Smart Contracts in NEAR Studio
• Running local DevNet
• Join TestNet

Develop and deploy contracts without any setup required using NEAR Studio:

Status

This 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.
• AlphaNet: Multi-node smart-contract platform.
• BetaNet: Added economics and enchanced security.
• TestNet: added governance module, ready to launch as MVB
• MainNet: Launched as Minimum Viable Blockchain.
• Shard chains: Support for scalable sharding.

Running

Checkout the Running Locally and Running Remotely sections.

Developing

Checkout the Developing NEAR Runtime and Building and Pushing Docker Image sections.

Logging

For runnable apps (devnet, nearcore, etc.), you can use the --log-level option to configure the log level across all internal crates. You can also use the RUST_LOG environment variable, with env_logger semantics to override the log level for specific targets. RUST_LOG can also be used in integration tests which spawn runnable apps.

Example:

$ RUST_LOG=runtime=debug cargo run -- --log-level warn

To add new target (e.g. info!(target: "my target", "hello")), add the desired target to the list in node/cli/src/service.rs in configure_logging function.

Contributions

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.