diff --git a/README.md b/README.md index f868ba52ae..d26f8fe6d4 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,96 @@ -# Astar Network · [![GitHub license](https://img.shields.io/badge/license-GPLv3-blue)](#LICENSE) [![CI Status](https://github.com/PlasmNetwork/Astar/workflows/Integration/badge.svg)](https://github.com/PlasmNetwork/Astar/actions) +![astar-cover](https://user-images.githubusercontent.com/40356749/125183345-edbaa980-e226-11eb-92e2-7b666ed56515.png) -

- -

+
-Astar Network is a dApps hub on Polkadot with unique features like dApps Staking, supporting mulit-virtual machine (EVM & WAsM), and offers layer2 solutions from day 1. Shiden Network is our sister network on Kusama. +[![Integration Action](https://github.com/PlasmNetwork/Astar/workflows/Integration/badge.svg)](https://github.com/PlasmNetwork/Astar/actions) +[![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/PlasmNetwork/Astar)](https://github.com/PlasmNetwork/Astar/tags) +[![Substrate version](https://img.shields.io/badge/Substrate-3.0.0-brightgreen?logo=Parity%20Substrate)](https://substrate.dev/) +[![License](https://img.shields.io/github/license/PlasmNetwork/Astar?color=green)](https://github.com/PlasmNetwork/Astar/blob/production/shiden/LICENSE) +
+[![Twitter URL](https://img.shields.io/twitter/follow/AstarNetwork?style=social)](https://twitter.com/AstarNetwork) +[![Twitter URL](https://img.shields.io/twitter/follow/ShidenNetwork?style=social)](https://twitter.com/ShidenNetwork) +[![YouTube](https://img.shields.io/youtube/channel/subscribers/UC36JgEF6gqatVSK9xlzzrvQ?style=social)](https://www.youtube.com/channel/UC36JgEF6gqatVSK9xlzzrvQ) +[![Docker](https://img.shields.io/docker/pulls/staketechnologies/astar-collator?logo=docker)](https://hub.docker.com/r/staketechnologies/astar-collator) +[![Discord](https://img.shields.io/badge/Discord-gray?logo=discord)](https://discord.gg/Z3nC9U4) +[![Telegram](https://img.shields.io/badge/Telegram-gray?logo=telegram)](https://t.me/PlasmOfficial) +[![Medium](https://img.shields.io/badge/Medium-gray?logo=medium)](https://medium.com/astar-network) -## Trying it out +
-Simply go to [docs.astar.network](https://docs.astar.network) and follow the -[installation](https://docs.astar.network/build/smart-contracts) instructions. You can -also try out one of the [core features](https://docs.astar.network/learn/core-features). +Astar Network is an interoperable blockchain based the Substrate framework and the hub for dApps within the Polkadot Ecosystem. +With Astar Network and Shiden Network, people can stake their tokens to a Smart Contract for rewarding projects that provide value to the network. -## Contributing +For contributing to this project, please read our [Contribution Guideline](./CONTRIBUTING.md). -Currently, we have 2 production networks: +## Building From Source -- [Astar Network](https://astar.network/): formerly known as Plasm Network, and our future Parachain on Polkadot Network -- [Shiden Network](https://shiden.astar.network/): Parachain of Kusama Network and our canary release for Astar Network +> This section assumes that the developer is running on either macOS or Debian-variant operating system. For Windows, although there are ways to run it, we recommend using [WSL](https://docs.microsoft.com/en-us/windows/wsl/install-win10) or from a virtual machine for stability. -And 2 test networks: +Execute the following command from your terminal to set up the development environment and build the node runtime. -- [Dusty Network](https://github.com/PlasmNetwork/Astar/tree/development/dusty): an independent test network with the latest cutting edge features before it is introduced to Astar Network -- [Shibuya Network](https://github.com/PlasmNetwork/Astar/tree/development/shibuya): a Parachain test network with the latest cutting edge features related to XMCP, collators, and other cross chain operations that is planned to be rolled out to Shiden Network +```bash +# install Substrate development environment via the automatic script +$ curl https://getsubstrate.io -sSf | bash -s -- --fast -In the future we will gradually change this structure to have a single test network. -For details, please read the [Contribution Guidelines](./CONTRIBUTING.md). +# clone the Git repository +$ git clone --recurse-submodules https://github.com/PlasmNetwork/Astar.git -If you would like to be the validator, please check out [our tutorial](https://docs.astar.network/build/validator-guide) and join [Discord tech channel](https://discord.gg/wUcQt3R). +# change current working directory +$ cd Astar -## LICENSE +# compile the node +# note: you may encounter some errors if `wasm32-unknown-unknown` is not installed, or if the toolchain channel is outdated +$ cargo build --release -Astar is licensed under the GPLv3.0 by Stake Technologies Inc. +# show list of available commands +$ ./target/release/astar-collator --help +``` + +### Building with Nix + +```bash +# install Nix package manager: +$ curl https://nixos.org/nix/install | sh + +# run from root of the project folder (`Astar/` folder) +$ nix-shell -I nixpkgs=channel:nixos-21.05 third-party/nix/shell.nix --run "cargo build --release" +``` + +## Running a Collator Node + +To set up a collator node, you must have a fully synced node with the proper arguments, which can be done with the following command. + +```bash +# start the Shiden collator node with +$ ./target/release/astar-collator \ + --base-path \ + --name \ + --port 30333 \ + --ws-port 9944 \ + --rpc-port 9933 \ + --telemetry-url 'wss://telemetry.polkadot.io/submit/ 0' \ + --rpc-cors all \ + --validator +``` + +Now, you can obtain the node's session key by sending the following RPC payload. + +```bash +# send `rotate_keys` request +$ curl -H 'Content-Type: application/json' --data '{ "jsonrpc":"2.0", "method":"author_rotateKeys", "id":1 }' localhost:9933 + +# should return a long string of hex, which is your session key +{"jsonrpc":"2.0","result":"","id":1} +``` + +After this step, you should have a validator node online with a session key for your node. +For key management and validator rewards, consult our [validator guide online](https://docs.astar.network/build/validator-guide/configure-node). + +## Further Reading + +* [Official Documentation](https://docs.astar.network/) +* [Whitepaper](https://github.com/PlasmNetwork/plasmdocs/blob/master/wp/en.pdf) +* [Whitepaper(JP)](https://github.com/PlasmNetwork/plasmdocs/blob/master/wp/jp.pdf) +* [Subtrate Developer Hub](https://substrate.dev/docs/en/) +* [Substrate Glossary](https://substrate.dev/docs/en/knowledgebase/getting-started/glossary) +* [Substrate Client Library Documentation](https://polkadot.js.org/docs/)