In this repo you will find:

• Polkadot Runtime Environment Spec
• Specification Conformance Tests for various implementation of Polkadot Runtime Enviornment
• Tests

Here your can find the latest version of Polkadot Runtime Environment Specification

Please refer to Change log to review the history of changes to the spec.

The test/ directory contains tests for the following components from different implementations such as Rust, C++ and Golang:

• SCALE Codec
• State Trie
• Polkadot Runtime Environment API (PDRE API)

The goal is to make sure that the different implementations behave the same and produce the identical output.

The easiest way to run those tests is by using docker via the local-ci tool. No API tokens are required for running the suite.

git clone https://github.com/w3f/polkadot-spec.git
cd polkadot-spec/
circleci local execute -c .circleci/config.yml --job runTests

Install the required software in order to run all the tests.

Note: The test suite requires CMake version 3.16 or higher and gcc/g++ version 8. It is not recommended to run those tests on the main workstation, since changing gcc/g++ versions can lead to issues.

apt update && apt install -y --no-install-recommends \
  build-essential \
  make \
  pkg-config \
  libssl-dev \
  clang \
  libclang-dev \
  wget \
  gcc-8 \
  g++-8 \
  golang \
  julia \
  python

# Install CMake 3.16.0
wget https://github.com/Kitware/CMake/releases/download/v3.16.0-rc4/cmake-3.16.0-rc4-Linux-x86_64.sh
chmod +x cmake-3.16.0-rc4-Linux-x86_64.sh
./cmake-3.16.0-rc4-Linux-x86_64.sh --skip-license --prefix=/usr/local

# Install Rust and toolchains required for Wasm
curl https://sh.rustup.rs -sSf | sh -s -- --default-toolchain nightly
rustup target add wasm32-unknown-unknown --toolchain nightly
cargo install --git https://github.com/alexcrichton/wasm-gc

# Set default gcc and g++ binaries to version 8
ln -sf /usr/bin/gcc-8 /usr/bin/gcc
ln -sf /usr/bin/g++-8 /usr/bin/g++

By running ./run_tests.sh the automated tests get executed. With ./run_tests.sh verbose the CLI parameters including the outputs can be displayed. Do note that this script must be run from this repos root directory, since it uses relative paths.

Inside the testing directory, the tests are executed in the following way:

runtests.jl
|-- scale_codec_tests.jl
|-- state_trie_tests.jl
|-- pdre_api_tests.jl

Each of those tests defines how the final executable tests are called and pass data to it. The function names, testing data and results can be found in the test/fixtures directory.

...

...

Those testers call functions that call the PDRE API. Currently, NOT all PDRE APIs are fully implemented. Some "expected results" will be adjusted.

+--------------------+
| pdre_api_tests.jl  |
|                    |
+----------+---------+
           |                  +----------------+
           +----------------->+Wasm Executor   |    *call runtime function*
           | rust_tester      |                +---------------------------+
           |                  |                |                           |
           |                  |                |                           v
           |                  |  +-------------+                 +---------+---------+
           |                  |  |Polkadot     |    *call API*   |Wasm Runtime blob  |
           |                  |  |Runtme       +<----------------+                   |
           |                  |  |Environment  |                 |                   |
           |                  |  |             |                 |                   |
           |                  +--+-------------+                 +-------------------+
           |
           |
           +-----------------> ...
           | go_tester
           |
           |
           +-----------------> ...
             cpp_tester

Each tester will use the custom Polkadot Runtime to call functions on the Wasm blob, which in return call the PDRE API. The return values are then returned to the tester which will optionally print those values and compare them against the expected results.

Relevant files:

The tests are executed in the following way:

<tester> pdre-api --function <function> --input <data>

Example:

rust_tester pdre-api --function test_blake2_128 --input "Horizontal"

Each function gets tested with multiple inputs and then goes on to the next function.

In the Julia scripts, the functions (module PdreApiTestFixtures) are grouped together depending on the format of the inputs (module PdreApiTestData). Their outputs are compared with the corresponding list (module PdreApiExpectedResults). The sequence of those entries must be paid attention to.

This table shows the relationship between the lists.

This repository contains genesis parameters for different networks in the genesis-state/ directory.

• The alexander test network
• The kusama test network