A parachain is an application-specific data structure that is globally coherent and validatable by the validators of the relaychain. They take their name from the concept of parallelized chains that run parallel to the relaychain. Most commonly, a parachain will take the form of a blockchain, but there is no specific need for them to be actual blockchains.
Basically, parachains are layer-1 blockchains that connect to the relaychains (Polkadot or Kusama), which validates the state transition of connected parachains, providing a shared state across the entire ecosystem. Since the validator set on the relaychain is expected to be secure with a large amount of stake put up to back it, it is desirable for parachains to benefit from this shared security.
To achieve identity aggregation, Litentry has a requirement to store sensitive user data, like web3 addresses, computed credit scores, and VCs in the trusted execution environment (TEE). Litentry builds a TEE side chain for this purpose and it is composed of multiple TEE-equipped nodes, to guarantee the security of data storage and data processing without exposing users' private data. A core component of this is the Litentry TEE worker which is based on Integritee's worker. It executes functions with specified inputs and resource limits in response to TEE calls and operations to ensure a sufficient level of scaling.
Overall, our architecture is made of up Relaychains ( Polkadot and Kusama), Parachains (Litentry and Litmus), and the TEE sidechain which is supported by and enables the runtime to execute in an SGX secure run environment.
To serve as the backbone platform for various Litentry products and achieve a transparent and decentralized user experience, we have different chain-specs/runtimes compiled into one single binary. They are:
- litentry-parachain-runtime (on polkadot)
- litmus-parachain-runtime (on kusama)
- rococo-parachain-runtime (on rococo testnet)
Therefore, when building node binary or docker image, no distinction is required. But when building runtime/starting binary/running tests, the chain type must be explicitly given. See the examples below.
Simply run
make help
to see the full lists of market targets and their short descriptions.
To build the litentry-parachain raw binary manually:
make build-node
To build the litentry/litentry-parachain docker image locally:
make build-docker-release
or
make build-docker-production
they will use release or production cargo profile, respectively.
To build the litentry-parachain runtime wasm manually:
make build-runtime-litentry
The wasms should be located under target/release/wbuild/litentry-parachain-runtime/
Similarly, use make build-runtime-litmus and make build-runtime-rococo to build the litmus-parachain-runtime and rococo-parachain-runtime, respectively.
Take rococo-parachain for example, but generally speaking, launching a local network works with either of the three chain-settings.
To start a local network with 2 relaychain nodes and 1 parachain node, there're two ways:
make launch-docker-rococo
parachain-launch will be installed and used to generate chain-specs and docker-compose files.
The generated files will be under docker/generated-rococo/.
When finished with the network, run
make clean-docker-rococo
to stop the processes and tidy things up.
Only when option 1 doesn't work and you suspect the docker-image went wrong.
In this case, try to launch the network with raw binaries.
On Linux host:
- you should have the locally compiled
./target/release/litentry-collatorbinary. - run
make launch-binary-rococo
On Non-Linux host:
- you should have locally compiled binaries, for both
polkadotandlitentry-collator - run
./scripts/launch-local-binary.sh rococo path-to-polkadot-bin path-to-litentry-parachain-bin
After launching, the parachain node is reachable via ws 9944 port and the relaychain nodes are reachable via ws 9946/9947 ports.
When finished with the network, run
make clean-binary
to stop the processes and tidy things up. Note this command should work for all parachain types (you don't have to differentiate them).
The standalone mode is only possible with the binary mode for now.
No relay chain will be launched, parachain will author blocks by itself with instant block finalisation, please refer to this PR.
make launch-standalone
To run the ts tests locally, similar to launching the networks, it's possible to run them in either docker or binary mode.
make test-ts-docker-rococo
Please refer to (tee-worker/ts-tests/README.md) for instructions on setting up your Node environment first.
# if on Linux
make test-ts-binary-rococo
# otherwise
./scripts/launch-local-binary.sh rococo path-to-polkadot-bin path-to-litentry-parachain-bin
./scripts/run-ts-test.sh rococo
Remember to run the clean-up afterward.
cd /tee-worker
source /opt/intel/sgxsdk/environment
SGX_MODE=SW make
Before executing launch.py, the following Python libraries need to be installed
pip install python-dotenv pycurl docker toml
In order to create a local docker setup, you can run the following command
./local-setup/launch.py
This will run node in local-binary-standalone mode. However, it will use the default ports as present in .env.dev. If you want to run the system by offsetting the default ports, you can run this command instead:
./local-setup/launch.py --offset 100
This will run the same containers and use the offset value of 100.
In order to create a local binary setup, using default ports, you can run the following command:
./local-setup/launch.py --parachain local-binary
If you want to launch the same system by offsetting the port values, you can use this command:
./local-setup/launch.py --parachain local-binary --offset 100
In case you receive the following error:
ModuleNotFoundError: No module named 'pycurl'
Fix it manually by installing pycurl using pip3.
Similar to 2, but it launches a standalone parachain node, see Launch a standalone parachain node:
./local-setup/launch.py --parachain local-binary-standalone
It will dramatically reduce the waiting time and the tee-worker should be ready to use very soon.
Refer to tee-worker ts-tests
In the worker launch terminal, Ctrl + C should interrupt and clean everything up automatically.
Additionally, if you launch the parentchain with binaries (integritee-node or parachain), you have to stop the parentchain by Ctrl + C too, or using kill
If you want to still call the scripts responsible for cleaning up the process, If launched via docker
make clean-docker-rococo
Docker can sometimes still leave behind remnants of an old build, run:
docker system prune
docker builder prune
If launched via binary
make clean-binary
Waiting for block production to start
Block produced
Parachain up; waiting for the worker to start
Worker started!
In logs, you’ll see the sidechain starts to produce blocks
- Change the RUST_LOG level:
litentry-parachain/local-setup/py/worker.py - Check existing ts-tests:
litentry-parachain/tee-worker/ts-tests/package.json - JSON config parameters:
litentry-parachain/tee-worker/service/src/cli.yml
GPLv3