Skip to content

Commit

Permalink
fix: typo fixes and grammar (#1090)
Browse files Browse the repository at this point in the history
* Typo fixes and grammar.

* Additional fix.
  • Loading branch information
Amb1guousRaccoon authored Jan 2, 2024
1 parent 9d074b3 commit 9e08ec1
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions rpc-tests/README.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,44 @@
# RPC tests

This project aim to create tesing framework for astar rpc node. It achieve this by spawning a local network with zombienet a Simple CLI tool to launch a local Polkadot test network. [zombienet](https://github.com/paritytech/zombienet) take configuration for the test network in a `rpc-tests.toml` which describes the config of relaychains and parachains that needs to be started for test network to start.
This project aims to create a testing framework for the astar RPC node. It achieves this by spawning a local network with `zombienet`, a Simple CLI tool to launch a local Polkadot test network. [zombienet](https://github.com/paritytech/zombienet) takes configuration for the test network in a `rpc-tests.toml` file, which describes the config of relaychains and parachains that the test network needs in order to start.

After the test network is started tests can be performed by connecting to it using polkadot.js or web3.js.t
After the test network is started, tests can be performed by connecting to it using `polkadot.js` or `web3.js`.

The test suite has a global setup and teardown steps for the test network with zombienet. Then it runs the tests with `rpc-tests.zndsl` test suite runner.
The test suite has global setup and teardown steps for the test network with zombienet. It runs the tests with the `rpc-tests.zndsl` test suite runner.

## Requirements

- node.js 18+
Download from https://nodejs.org/en/
Download from `https://nodejs.org/en/`
- yarn
To install `npm install -g yarn`
To install, run: `npm install -g yarn`

## Usage

Build astar collator.
Build astar collator:

```sh
cargo build --release
```

Copy the binary in rpc-tests/bin folder.
Copy the binary in rpc-tests/bin folder:

```sh
mkdir -p rpc-tests/bin
cp target/release/astar-collator rpc-tests/bin/astar-collator
```

Download and copy latest polkadot binary from https://github.com/paritytech/polkadot/releases to rpc-tests/bin folder
Download and copy the latest polkadot binary from https://github.com/paritytech/polkadot/releases to the `rpc-tests/bin` folder.

Download and copy latest zombienet binary from https://github.com/paritytech/zombienet/releases to rpc-tests/bin folder
Download and copy the latest zombienet binary from https://github.com/paritytech/zombienet/releases to the `rpc-tests/bin` folder.

To start the test suite.
To start the test suite:

```sh
cd rpc-tests
```

For all runtime.
For all runtime:

```sh
yarn test
Expand Down

0 comments on commit 9e08ec1

Please sign in to comment.