Skip to content

Latest commit

 

History

History
135 lines (98 loc) · 5.83 KB

README.md

File metadata and controls

135 lines (98 loc) · 5.83 KB
Raw

IntegriTEE Parachain:

This is the repository to run integritee as a parachain in the rococo-v1 testnet. It is forked from the Cumulus repository and only adds the SubstraTEE pallet and configuration.

Launch a local setup including a Relay Chain and a Parachain

Quick: see polkadot-launch

node ../polkadot-launch/dist/cli.js launch-kusama-local-with-shell.json

Manually Launch Local Rococo Testnet

# Compile Polkadot with the real overseer feature
git clone https://github.com/paritytech/polkadot
git checkout <release tag>  // release tag that matches the branch id in the polkadot-deps
cargo build --release

# Generate a raw chain spec
./target/release/polkadot build-spec --chain rococo-local --disable-default-bootnode --raw > rococo-local-cfde.json

# Alice
./target/release/polkadot --chain rococo-local-cfde.json --alice --tmp

# Bob (In a separate terminal)
./target/release/polkadot --chain rococo-local-cfde.json --bob --tmp --port 30334

Launch the Parachain

# Compile
git clone https://github.com/scs/integritee-parachain.git
git checkout master
cargo build --release

# Export genesis state
# --parachain-id 2015 as an example that can be chosen freely. Make sure to everywhere use the same parachain id
./target/release/integritee-collator export-genesis-state --chain integritee-local-dev --parachain-id 2015 > integritee-local-dev.state

# Export genesis wasm
./target/release/integritee-collator export-genesis-wasm --chain integritee-local-dev > integritee-local.wasm

# Collator
./target/release/integritee-collator --collator --tmp --parachain-id 2015 --chain integritee-local-dev --port 40335 --ws-port 9946 -- --execution wasm --chain ../polkadot/rococo-local-cfde.json --port 30337 --ws-port 9981

Register the Parachain

Go to Polkadot Apps connect to the default local port (Alice) and register the parachain via the paraSudoWrapper pallet. After registering, the collator should start producing blocks when the next era starts.

Note: Change the ParaId to 2015 when registering the parachain.

image

You may need to add custom type overwrites in Settings -> Developer:

{
  "Address": "MultiAddress",
  "LookupSource": "MultiAddress",
  "ShardIdentifier": "Hash"
}

Deploy on rococo

Prepare genesis state and wasm as follows:

# Export genesis state
# --parachain-id 2015 as an example that can be chosen freely. Make sure to everywhere use the same parachain id
./target/release/integritee-collator export-genesis-state --chain integritee-rococo-local-dev --parachain-id 2015 > integritee-rococo-local-dev.state

# Export genesis wasm
./target/release/integritee-collator export-genesis-wasm --chain integritee-rococo-local-dev > integritee-rococo-local-dev.wasm

then propose the parachain on rococo relay-chain

run collator

integritee-collator \
        --collator \
        --chain integritee-rococo-local-dev \
        --parachain-id 2015 \
        --rpc-cors all \
        --name integritee-rococo-collator-1 \
        -- --execution wasm --chain rococo

Runtime upgrade

Two runtimes are contained in this repository. First, the shell-runtime, which has been extended compared to the upstream shell-runtime. It has some additional modules including sudo to facilitate a runtime upgrade with the sudo upgrade method. Second, it runs with the same executor instance as the integritee-runtime, such that an eventual upgrade is simpler to perform, i.e., only the runtime needs to be upgraded whereas the client can remain the same. Hence, all modules revolving around aura have been included, which provide data the client needs.

Upgrade procedure

Prepare a local shell network and generate the integritee-runtime wasm blob, which contains the upgraded runtime to be executed after the runtime upgrade.

// launch local setup
node ../polkadot-launch/dist/index.js shell-local-config.json

// generate wasm blob
 ./target/release/integritee-collator export-genesis-wasm --chain integritee-rococo-local-dev > integritee-rococo-local-dev.wasm

After the parachain starts producing blocks, a runtime upgrade can be initiated via the polkadot-js/apps interface.

image

If successful, a parachainSystem.validationFunctionStored event is thrown followed by a parachainSystem.validationFunctionApplied event some blocks later. After this procedure, the substrateeRegistry module should be available in the extrinsics tab in polkadot-js/apps.

Caveats

  • Don't forget to enable file upload if you perform drag and drop for the genesisHead and validationCode. If it is not enabled, Polkadot-js will interpret the path as a string and won't complain but the registration will fail.
  • Don't forget to add the argument --chain integritee-rococo-local-dev for the custom chain config. This argument is omitted in the Cumulus Workshop.
  • The relay chain and the collator need to be about equally recent. This might require frequent rebasing of this repository on the corresponding release branch.

Benchmark

The current weights have been benchmarked with the following reference hardware:

  • Core(TM) i7-10875H
  • 32GB of RAM
  • NVMe SSD

The benchmarks are run with the following script:

./scripts/benchmark_all_pallets.sh

More Resources

  • Thorough Readme about Rococo and Collators in general in the original repository of this fork.
  • Parachains on Rococo in the Polkadot Wiki