Skip to content
This repository has been archived by the owner on Jul 28, 2023. It is now read-only.

Fix into readme #136

Merged
merged 3 commits into from
Nov 18, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 43 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,42 @@
# Substrate Move VM
# Pontem

Substrate node template with [Move VM pallet](/pallets/sp-mvm/) on board.

**Work in progress, so use it at your own risk.**

* [Documentation](https://docs.pontem.network).

## Installation

Read [official documentation](https://docs.pontem.network/02.-getting-started/local_node).
Pontem parachain node with [Move VM pallet](/pallets/sp-mvm/) on board.

* [Pontem docs](https://docs.pontem.network) - if you want to learn about Pontem network.
* [Validator docs](https://docs.pontem.network/03.-staking/collator) - if you want to launch a validator node.
* [Bootstrap](https://github.com/pontem-network/bootstrap) - if you want to up node quickly (not for development).

## Local Relaychain & Parachain Launch

Current version built with Nimbus consensus and Parachain Staking implementation.
Requires relay chain to work correctly.

### Running in dev-mode
### Requirements

There is a possibility to run a single node in development mode, without any consensus involved.
* [Rust](https://www.rust-lang.org/tools/install)
* [Dove](https://github.com/pontem-network/move-tools#installation)

Add `--dev-service` flag to `cargo run` command to run a single node with disabled consensus:
### Build

**IMPORTANT NOTE:** the node with enabled `--dev-service` flag generating blocks when needed (e.g. when a new transaction appears).
To build Pontem node run the following commands:

```sh
cargo run --release -- --dev --dev-service --tmp
cd pontem
make init
make build
```

Use `--sealing` argument to select sealing mode:
See built binary at:

1. `instant` (default). Blocks a produced automatically for each transaction
2. `<number>`. Blocks are produced once per `number` milliseconds
```sh
./target/release/pontem
```

There are several options to launch Pontem local parachain:

* [Using polkadot-launch with Relay Chain](#using-polkadot-launch)
* [Manually with Relay Chain](#manually)
* [In Dev Mode](#running-in-dev-mode)

### Using polkadot-launch

Expand All @@ -39,13 +45,6 @@ Install [polkadot-launch](https://github.com/paritytech/polkadot-launch).
**Note:** you must have polkadot node `v0.9.11` compiled and built placed in `../polkadot/target/release/`.
To use different localion you can modify `./launch-config.json`.

Build Pontem:

```sh
cd pontem
make build
```

Create keystore path for Pontem:

```sh
Expand Down Expand Up @@ -118,14 +117,7 @@ Launch Polkadot Relay Chain:
./target/release/polkadot --chain rococo-local-cfde.json --bob --tmp --port 30334 # In a separate terminal
```

Build Pontem:

```sh
cd pontem
make build
```

Create keystore path for Pontem:
[Build](#build) Pontem node and then create keystore path for Pontem:

```sh
mkdir -p ~/.pontem/keystore-1 # Base path
Expand Down Expand Up @@ -255,6 +247,24 @@ cat 9946.log | grep 40335 # Something like: /ip4/127.0.0.1/tcp/40335/p2p/12D3Koo

Good documentation also can be found in [Moonriver/Moonbeam Docs](https://docs.moonbeam.network/staking/stake/).

### Running in dev-mode

There is a possibility to run a single node in development mode, without any consensus involved.

Add `--dev-service` flag to `cargo run` command to run a single node with disabled consensus:

**IMPORTANT NOTE:** the node with enabled `--dev-service` flag generating blocks when needed (e.g. when a new transaction appears).

```sh
./target/release/pontem --dev --dev-service --tmp
```

Use `--sealing` argument to select sealing mode:

1. `instant` (default). Blocks a produced automatically for each transaction
2. `<number>`. Blocks are produced once per `number` milliseconds


## Documentation

See [Move VM Pallet documentation](https://docs.pontem.network/02.-getting-started/getting_started).
Expand Down