Skip to content

Commit a691336

Browse files
committed
Updated ReadMe
1 parent 70a5d5b commit a691336

2 files changed

Lines changed: 50 additions & 1 deletion

File tree

README.md

Lines changed: 50 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ First, install [Docker](https://docs.docker.com/get-docker/) and
184184
Please use following command to run peaq-network-node parachian in the docker container connected with polkadot relaychain running in the PEAQ development environment.
185185

186186
```bash
187-
docker run kamranpeaq/peaq-node-parachain:2.0 --chain ./node/src/chain-specs/peaq-dev-parachain-raw.json \
187+
docker run peaq/parachain:v1.1.4 --chain ./node/src/chain-specs/peaq-dev-parachain-raw.json \
188188
--base-path /tmp/parachain/alice \
189189
--port 40333 \
190190
--ws-port 8844 \
@@ -197,6 +197,55 @@ Please use following command to run peaq-network-node parachian in the docker co
197197

198198
Once you run this command, wait for a few second. Now the peaq parachian should be running in the docker container that is connected to relaychain running in PEAQ dev environament.
199199

200+
### Run on your local machine with Docker commands
201+
202+
Please follow the steps given below to run peaq-network-node parachian on your local machine connected with polkadot
203+
relaychain running in the PEAQ development environment. It is assumed that you have already downloaded the source code
204+
for peaq-network-node from the git repository
205+
206+
1. CD into the peaq-network-node directory:
207+
```bash
208+
cd peaq-network-node
209+
```
210+
211+
2. Checkout the appropriate branch:
212+
```bash
213+
git checkout run_peaq_dev_parachain_with_docker_commands
214+
```
215+
3. Create the following folder:
216+
```bash
217+
mkdir ./.local
218+
```
219+
220+
The folder .local is needed because that is where data such as session keys are stored for validators. Also we bind mount from the container folder /root/.local to the host machine project root folder ./.local.
221+
222+
Now run the following script to start a peaq-network-node parachain that will connect to the polkadot relay chain running in peaq development environment:
223+
```bash
224+
./scripts/docker_run.sh
225+
./target/release/peaq-node \
226+
--chain ./node/src/chain-specs/peaq-dev-parachain-raw.json \
227+
--base-path /tmp/parachain/alice \
228+
--port 40333 \
229+
--ws-port 8844 \
230+
-- \
231+
--execution wasm \
232+
--chain ./node/src/chain-specs/rococo-local-relaychain-raw.json \
233+
--port 30343 \
234+
--ws-port 9977
235+
```
236+
This command will first compile your code (if it is not already compiled), and then start a peaq-network-node parachain. The node running on your local machine will take sometime to sync up. Make sure that the parachain blocks are generated.
237+
238+
You can also replace the default command by appending your own. A few useful ones are as follows:
239+
240+
```bash
241+
# Purge the local dev chain
242+
./scripts/docker_run.sh ./target/release/peaq-node purge-chain --dev
243+
```
244+
```bash
245+
# Check whether the code is compilable
246+
./scripts/docker_run.sh cargo check
247+
```
248+
200249
### Parachain Launch
201250

202251
1. Please use the [peaq-node-builder](https://github.com/peaqnetwork/peaq-node-builder) to build the project

plain-parachain-chainspec.json

Whitespace-only changes.

0 commit comments

Comments
 (0)