Skip to content
This repository has been archived by the owner on Oct 22, 2024. It is now read-only.

Commit

Permalink
Update READMEs (paritytech#564)
Browse files Browse the repository at this point in the history
  • Loading branch information
vgeddes authored Jan 16, 2022
1 parent 1d98436 commit c287001
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 204 deletions.
9 changes: 3 additions & 6 deletions ethereum/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,9 @@ This directory contains smart contracts utilized by the Polkadot-Ethereum Bridge

## Development

Make sure you use a recent node version, e. g. with [nvm](https://github.com/nvm-sh/nvm#installing-and-updating):

```bash
nvm install 14.16.1
nvm use 14.16.1
```
Requirements:
* Node 14 LTS. See installation [instructions](https://www.digitalocean.com/community/tutorials/how-to-install-node-js-on-ubuntu-20-04#option-3-%E2%80%94-installing-node-using-the-node-version-manager).
* Yarn

Install dependencies with yarn:

Expand Down
15 changes: 2 additions & 13 deletions parachain/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ Refer to the instructions at the

To add context to the above instructions, the parachain is known to compile with the following versions of Rust:

- stable: 1.51.0
- nightly: 1.53.0-nightly
- stable: 1.58
- nightly: 1.60.0-nightly

### Build

Expand Down Expand Up @@ -57,17 +57,6 @@ cargo build --release
cd -
```

Launch Polkadot and the parachain:

```bash
cd -
polkadot-launch config.json
```

It will take about 1-2 minutes for the parachain to start producing blocks.

The parachain will output logs to `200.log`.

## Configuration

Note: This section is not necessary for local development, as there are scripts to auto-configure the parachain.
Expand Down
115 changes: 0 additions & 115 deletions parachain/config-xcmp.json

This file was deleted.

51 changes: 0 additions & 51 deletions parachain/config.json

This file was deleted.

1 change: 1 addition & 0 deletions relayer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Relayer service that streams transactions from blockchain networks, packages dat

This project requires the following tools for day to day development:

- [Golang](https://go.dev/)
- [Mage](https://magefile.org/): Used for build tasks
- [Revive](https://github.com/mgechev/revive): Used for linting instead of golint

Expand Down
31 changes: 12 additions & 19 deletions test/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,10 @@ The E2E tests run against local deployments of the parachain, relayer and ganach
(cd ../ethereum && yarn install)
```

* Development environment for the relay services. See relayer [requirements](../relayer/README.md#development).
* `timeout` - native package on Ubuntu, on macOS try ```brew install coreutils```
* Development environment for the relay services. See setup [instructions](../relayer/README.md#development).
* `jq` - https://stedolan.github.io/jq/download/
* geth - https://geth.ethereum.org/docs/install-and-build/installing-geth
* sponge - Is available in the moreutils package. On Mac see https://formulae.brew.sh/formula/moreutils. On Linux:
* sponge - Is available in the `moreutils` package.

```bash
apt install moreutils
Expand All @@ -31,11 +30,17 @@ The E2E tests run against local deployments of the parachain, relayer and ganach
* polkadot-launch

```bash
yarn global add polkadot-launch@1.9.0
yarn global add polkadot-launch@1.9.0
```

## Setup

### Install NPM dependencies

```bash
yarn install
```

### Polkadot

* Clone the polkadot repository somewhere on your machine
Expand All @@ -51,7 +56,7 @@ cargo build --release

### Configure testnet

Create an `.env` file with variables that point to the binary for polkadot
Create an `.env` file, and set the `POLKADOT_BIN` variable to the location of the polkadot binary built in the previous step.

Example:
```
Expand All @@ -65,7 +70,7 @@ Run the following script
scripts/start-services.sh
```

Wait until the "System has been initialized" message
Wait until the "Testnet has been initialized" message

Go to polkadot-js and wait until the parachain has started producing blocks:
https://polkadot.js.org/apps/?rpc=ws%3A%2F%2F127.0.0.1%3A11144#/explorer
Expand All @@ -84,19 +89,7 @@ The `start-services.sh` script writes the following logs:

## E2E tests

### Setup

Download dependencies:

```bash
yarn install
```

You should now be good to go!

## Run Tests

### Integration Tests
Run the tests using the following command:

```bash
yarn test
Expand Down

0 comments on commit c287001

Please sign in to comment.