Adding Bridges code as git subtree. (#2515)

* Add instructions.

* Squashed 'bridges/' content from commit 345e84a21

git-subtree-dir: bridges
git-subtree-split: 345e84a2146b56628e9888c9f5e129cb40e868a9

* Remove bridges workspace file to avoid confusing Cargo.

* Add some bridges primitives to Polkadot workspace.

* Improve docs.

BRIDGES.md

+# Using Parity Bridges Common dependency (`git subtree`).
+
+In `./bridges` sub-directory you can find a `git subtree` imported version of:
+[parity-bridges-common](https://github.com/paritytech/parity-bridges-common/) repository.
+
+# How to fix broken Bridges code?
+
+To fix Bridges code simply create a commit in current (`polkadot`) repo. Best if
+the commit is isolated to changes in `./bridges` sub-directory, because it makes
+it easier to import that change back to upstream repo.
+
+# How to pull latest Bridges code or contribute back?
+
+Note that it's totally fine to ping the Bridges Team to do that for you. The point
+of adding the code as `git subtree` is to **reduce maintenance cost** for Polkadot
+developers.
+
+If you still would like to either update the code to match latest code from the repo
+or create an upstream PR read below. The following commands should be run in the 
+current (`polkadot`) repo.
+
+1. Add Bridges repo as a local remote:
+```
+$ git remote add -f bridges git@github.com:paritytech/parity-bridges-common.git
+```
+
+If you plan to contribute back, consider forking the repository on Github and adding
+your personal fork as a remote as well.
+```
+$ git remote add -f my-bridges git@github.com:tomusdrw/parity-bridges-common.git
+```
+
+2. To update Bridges:
+```
+$ git fetch bridges master
+$ git subtree pull --prefix=bridges bridges master --squash
+````
+
+We use `--squash` to avoid adding individual commits and rather squashing them
+all into one.
+
+3. Contributing back to Bridges (creating upstream PR)
+```
+$ git subtree push --prefix=bridges my-bridges master
+```
+This command will push changes to your personal fork of Bridges repo, from where
+you can simply create a PR to the main repo.

Cargo.lock

@@ -597,6 +597,58 @@ dependencies = [
  "once_cell",
 ]
 
+[[package]]
+name = "bp-kusama"
+version = "0.1.0"
+dependencies = [
+ "bp-message-lane",
+ "bp-runtime",
+ "frame-support",
+ "frame-system",
+ "sp-api",
+ "sp-core",
+ "sp-runtime",
+ "sp-std",
+]
+
+[[package]]
+name = "bp-message-lane"
+version = "0.1.0"
+dependencies = [
+ "bp-runtime",
+ "frame-support",
+ "frame-system",
+ "parity-scale-codec",
+ "sp-std",
+]
+
+[[package]]
+name = "bp-polkadot"
+version = "0.1.0"
+dependencies = [
+ "bp-message-lane",
+ "bp-runtime",
+ "frame-support",
+ "frame-system",
+ "sp-api",
+ "sp-core",
+ "sp-runtime",
+ "sp-std",
+]
+
+[[package]]
+name = "bp-runtime"
+version = "0.1.0"
+dependencies = [
+ "frame-support",
+ "num-traits",
+ "parity-scale-codec",
+ "sp-core",
+ "sp-io",
+ "sp-runtime",
+ "sp-std",
+]
+
 [[package]]
 name = "bs58"
 version = "0.4.0"

Cargo.toml

@@ -26,6 +26,9 @@ tempfile = "3.2.0"
 
 [workspace]
 members = [
+	"bridges/primitives/kusama",
+	"bridges/primitives/polkadot",
+	"bridges/primitives/runtime",
 	"cli",
 	"core-primitives",
 	"erasure-coding",

bridges/.dependabot/config.yml

+version: 1
+update_configs:
+  - package_manager: "rust:cargo"
+    directory: "/"
+    update_schedule: "weekly"
+    ignored_updates:
+      - match:
+          dependency_name: "sp-*"
+      - match:
+          dependency_name: "sc-*"
+      - match:
+          dependency_name: "substrate-*"
+      - match:
+          dependency_name: "frame-*"
+      - match:
+          dependency_name: "pallet-*"
+    automerged_updates:
+      - match:
+          update_type: "all"
+    version_requirement_updates: "auto"

bridges/.dockerignore

+**/target/

bridges/.editorconfig

+root = true
+[*]
+indent_style=tab
+indent_size=tab
+tab_width=4
+end_of_line=lf
+charset=utf-8
+trim_trailing_whitespace=true
+max_line_length=100
+insert_final_newline=true
+
+[*.{yml,md,yaml,sh}]
+indent_style=space
+indent_size=2
+tab_width=8
+end_of_line=lf

bridges/.github/workflows/deny.yml

+name:                   Cargo deny
+
+on:
+  pull_request:
+  schedule:
+    - cron:             '0 0 * * *'
+  push:
+    branches:
+      - master
+    tags:
+      - v*
+    paths-ignore:
+      - '**/README.md'
+      - diagrams/*
+      - docs/*
+jobs:
+  cargo-deny:
+    runs-on:            ubuntu-latest
+    steps:
+      - name:           Cancel Previous Runs
+        uses:           styfle/cancel-workflow-action@0.4.1
+        with:
+          access_token: ${{ github.token }}
+      - name:           Checkout sources & submodules
+        uses:           actions/checkout@master
+        with:
+          fetch-depth:  5
+          submodules:   recursive
+      - name:           Cargo deny
+        uses:           EmbarkStudios/cargo-deny-action@v1
+        with:
+          command:      "check --hide-inclusion-graph"

bridges/.github/workflows/lint.yml

+name:                   Check style
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+    tags:
+      - v*
+    paths-ignore:
+      - '**/README.md'
+      - diagrams/*
+      - docs/*
+  schedule:             # Weekly build
+    - cron:             '0 0 * * 0'
+jobs:
+## Check stage
+  check-fmt:
+    name:                          Check RustFmt
+    runs-on:                       ubuntu-latest
+    env:
+      RUST_BACKTRACE:   full
+    steps:
+      - name:           Cancel Previous Runs
+        uses:           styfle/cancel-workflow-action@0.4.1
+        with:
+          access_token: ${{ github.token }}
+      - name:           Checkout sources & submodules
+        uses:           actions/checkout@master
+        with:
+          fetch-depth:  5
+          submodules:   recursive
+      - name:           Add rustfmt
+        run:            rustup component add rustfmt
+      - name:           rust-fmt check
+        uses:           actions-rs/cargo@master
+        with:
+          command:      fmt
+          args:         --all -- --check

bridges/.github/workflows/publish-deps.yml

+name:                                               Publish Dependencies to Docker hub
+
+on:
+  push:
+    tags:
+      - v*
+    paths-ignore:
+      - '**/README.md'
+      - diagrams/*
+      - docs/*
+  schedule:                                         # Weekly build
+    - cron:                                         '0 0 * * 0'
+
+jobs:
+## Publish to Docker hub
+  publish:
+    name:                                           Publishing
+    runs-on:                                        ubuntu-latest
+    container:
+      image:                                        docker:git
+    steps:
+      - name:                                       Cancel Previous Runs
+        uses:                                       styfle/cancel-workflow-action@0.4.1
+        with:
+          access_token:                             ${{ github.token }}
+      - name:                                       Checkout sources & submodules
+        uses:                                       actions/checkout@master
+        with:
+          fetch-depth:                              5
+          submodules:                               recursive
+      - name:                                       Build and push dependencies
+        uses:                                       docker/build-push-action@v1
+        with:
+          username:                                 ${{ secrets.DOCKER_USER }}
+          password:                                 ${{ secrets.DOCKER_PASSWORD }}
+          repository:                               paritytech/bridge-dependencies
+          dockerfile:                               deployments/BridgeDeps.Dockerfile
+          tag_with_ref:                             true
+          tag_with_sha:                             true
+          labels:
+            org.opencontainers.image.source="https://github.com/paritytech/parity-bridges-common",
+            org.opencontainers.image.authors="devops-team@parity.io",
+            org.opencontainers.image.vendor="Parity Technologies",
+            org.opencontainers.image.url="https://github.com/paritytech/parity-bridges-common",
+            org.opencontainers.image.documentation="https://github.com/paritytech/parity-bridges-common/README.md",
+            org.opencontainers.image.title=${{ matrix.project }},
+            org.opencontainers.image.description="${{ matrix.project }} - component of Parity Bridges Common",
+            org.opencontainers.image.licenses="GPL-3.0 License"
+          add_git_labels:                           true

bridges/.github/workflows/publish-docker.yml

+name:                                               Publish images to Docker hub
+
+on:
+  push:
+    tags:
+      - v*
+    paths-ignore:
+      - '**/README.md'
+      - diagrams/*
+      - docs/*
+  schedule:                                         # Nightly build
+    - cron:                                         '0 1 * * *'
+
+jobs:
+## Publish to Docker hub
+  publish:
+    name:                                           Publishing
+    strategy:
+      matrix:
+        project:
+          - rialto-bridge-node
+          - millau-bridge-node
+          - ethereum-poa-relay
+          - substrate-relay
+        include:
+          - project: rialto-bridge-node
+            healthcheck: http://localhost:9933/health
+          - project: millau-bridge-node
+            healthcheck: http://localhost:9933/health
+          - project: ethereum-poa-relay
+            healthcheck: http://localhost:9616/metrics
+          - project: substrate-relay
+            healthcheck: http://localhost:9616/metrics
+    runs-on:                                        ubuntu-latest
+    container:
+      image:                                        docker:git
+    steps:
+      - name:                                       Cancel Previous Runs
+        uses:                                       styfle/cancel-workflow-action@0.4.1
+        with:
+          access_token:                             ${{ github.token }}
+      - name:                                       Checkout sources & submodules
+        uses:                                       actions/checkout@master
+        with:
+          fetch-depth:                              5
+          submodules:                               recursive
+      - name:                                       Set vars
+        id:                                         vars
+        run:                                        |
+          echo ::set-output name=DATE::$(date +%d-%m-%Y)
+          if [[ ${GITHUB_REF} = refs/tags/* ]]
+          then
+            echo ::set-output name=TAG::${GITHUB_REF#refs/tags/}
+          else
+            echo ::set-output name=TAG::nightly-$(date +%d-%m-%Y)
+          fi
+      - name:                                       Build and push ${{ matrix.project }}
+        uses:                                       docker/build-push-action@v1
+        with:
+          username:                                 ${{ secrets.DOCKER_USER }}
+          password:                                 ${{ secrets.DOCKER_PASSWORD }}
+          repository:                               paritytech/${{ matrix.project }}
+          build_args:                               PROJECT=${{ matrix.project }}, HEALTH=${{ matrix.healthcheck }}
+          tags:                                     ${{ steps.vars.outputs.TAG }}, latest
+          labels:
+            org.opencontainers.image.created=${{ steps.vars.outputs.DATE }},
+            org.opencontainers.image.source="https://github.com/paritytech/parity-bridges-common",
+            org.opencontainers.image.authors="devops-team@parity.io",
+            org.opencontainers.image.vendor="Parity Technologies",
+            org.opencontainers.image.url="https://github.com/paritytech/parity-bridges-common",
+            org.opencontainers.image.documentation="https://github.com/paritytech/parity-bridges-common/README.md",
+            org.opencontainers.image.version=${{ steps.vars.outputs.TAG }},
+            org.opencontainers.image.title=${{ matrix.project }},
+            org.opencontainers.image.description="${{ matrix.project }} - component of Parity Bridges Common",
+            org.opencontainers.image.licenses="GPL-3.0 License"
+          add_git_labels:                           true

bridges/.github/workflows/rust.yml

+name:                              Compilation and Testing Suite
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+    tags:
+      - v*
+    paths-ignore:
+      - '**/README.md'
+      - diagrams/*
+      - docs/*
+  schedule:                        # Weekly build
+    - cron:                        '0 0 * * 0'
+jobs:
+
+## Check Stage
+  check-test:
+    name:                          Check and test
+    strategy:
+      matrix:
+        toolchain:
+          - stable
+          #- beta
+          - nightly
+    runs-on:                       ubuntu-latest
+    env:
+      RUST_BACKTRACE:              full
+      NIGHTLY:                     nightly #if necessary, specify the version, nightly-2020-10-04, etc.
+    steps:
+      - name:                      Cancel Previous Runs
+        uses:                      styfle/cancel-workflow-action@0.4.1
+        with:
+          access_token:            ${{ github.token }}
+      - name:                      Checkout sources & submodules
+        uses:                      actions/checkout@master
+        with:
+          fetch-depth:             5
+          submodules:              recursive
+      - name:                      Install Toolchain
+        run:                       rustup toolchain add $NIGHTLY
+      - name:                      Add WASM Utilities
+        run:                       rustup target add wasm32-unknown-unknown --toolchain $NIGHTLY
+      - name:                      Rust Cache
+        uses:                      Swatinem/rust-cache@v1.2.0
+      - name:                      Checking rust-${{ matrix.toolchain }}
+        uses:                      actions-rs/cargo@master
+        with:
+          command:                 check
+          toolchain:               ${{ matrix.toolchain }}
+          args:                    --all  --verbose
+
+## Test Stage
+      - name:                      Testing rust-${{ matrix.toolchain }}
+        uses:                      actions-rs/cargo@master
+        if:                        matrix.toolchain == 'stable'
+        with:
+          command:                 test
+          toolchain:               ${{ matrix.toolchain }}
+          args:                    --all  --verbose
+
+## Check Node Benchmarks
+      - name:                      Check Rialto benchmarks runtime ${{ matrix.platform }} rust-${{ matrix.toolchain }}
+        uses:                      actions-rs/cargo@master
+        with:
+          command:                 check
+          toolchain:               ${{ matrix.toolchain }}
+          args:                    --manifest-path ./bin/rialto/node/Cargo.toml --no-default-features --features runtime-benchmarks --verbose
+      - name:                      Check Millau benchmarks runtime ${{ matrix.platform }} rust-${{ matrix.toolchain }}
+        uses:                      actions-rs/cargo@master
+        with:
+          command:                 check
+          toolchain:               ${{ matrix.toolchain }}
+          args:                    --manifest-path ./bin/millau/node/Cargo.toml --no-default-features --features runtime-benchmarks --verbose
+
+## Build Stage
+  build:
+    name:                          Build
+    strategy:
+      matrix:
+        toolchain:
+          - stable
+          #- beta
+          - nightly
+    runs-on:                       ubuntu-latest
+    env:
+      RUST_BACKTRACE:              full
+      NIGHTLY:                     nightly #if necessary, specify the version, nightly-2020-10-04, etc.
+    steps:
+      - name:                      Cancel Previous Runs
+        uses:                      styfle/cancel-workflow-action@0.4.1
+        with:
+          access_token:            ${{ github.token }}
+      - name:                      Checkout sources & submodules
+        uses:                      actions/checkout@master
+        with:
+          fetch-depth:             5
+          submodules:              recursive
+      - name:                      Install Toolchain
+        run:                       rustup toolchain add $NIGHTLY
+      - name:                      Add WASM Utilities
+        run:                       rustup target add wasm32-unknown-unknown --toolchain $NIGHTLY
+      - name:                      Rust Cache
+        uses:                      Swatinem/rust-cache@v1.2.0
+      - name:                      Building rust-${{ matrix.toolchain }}
+        uses:                      actions-rs/cargo@master
+        if:                        github.ref == 'refs/heads/master'
+        with:
+          command:                 build
+          toolchain:               ${{ matrix.toolchain }}
+          args:                    --all --verbose
+      - name:                      Prepare artifacts
+        if:                        github.ref == 'refs/heads/master'
+        run:                       |
+          mkdir -p ./artifacts;
+          mv -v target/debug/rialto-bridge-node ./artifacts/;
+          mv -v target/debug/millau-bridge-node ./artifacts/;
+          mv -v target/debug/ethereum-poa-relay ./artifacts/;
+          mv -v target/debug/substrate-relay ./artifacts/;
+        shell:                     bash
+      - name:                      Upload artifacts
+        if:                        github.ref == 'refs/heads/master'
+        uses:                      actions/upload-artifact@v1
+        with:
+          name:                    ${{ matrix.toolchain }}.zip
+          path:                    artifacts/
+
+ ## Linting Stage
+  clippy:
+    name:                          Clippy
+    runs-on:                       ubuntu-latest
+    env:
+      RUST_BACKTRACE:              full
+      NIGHTLY:                     nightly #if necessary, specify the version, nightly-2020-10-04, etc.
+    steps:
+      - name:                      Cancel Previous Runs
+        uses:                      styfle/cancel-workflow-action@0.4.1
+        with:
+          access_token:            ${{ github.token }}
+      - name:                      Checkout sources & submodules
+        uses:                      actions/checkout@master
+        with:
+          fetch-depth:             5
+          submodules:              recursive
+      - name:                      Install Toolchain
+        run:                       rustup toolchain add $NIGHTLY
+      - name:                      Add WASM Utilities
+        run:                       rustup target add wasm32-unknown-unknown --toolchain $NIGHTLY
+      - name:                      Add clippy
+        run:                       rustup component add clippy --toolchain $NIGHTLY
+      - name:                      Rust Cache
+        uses:                      Swatinem/rust-cache@v1.2.0
+      - name:                      Clippy
+        uses:                      actions-rs/cargo@master
+        with:
+          command:                 clippy
+          toolchain:               nightly #if necessary, specify the version, nightly-2020-10-04, etc.
+          args:                    --all-targets -- -D warnings

bridges/.gitignore

+**/target/
+**/.env
+**/.env2
+**/rust-toolchain
+
+**/*.rs.bk
+
+*.o
+*.so
+*.rlib
+*.dll
+.gdb_history
+
+*.exe
+
+.DS_Store
+
+.idea
+.vscode
+*.iml
+*.swp
+*.swo

bridges/.maintain/rialto-weight-template.hbs

+// Copyright 2019-2020 Parity Technologies (UK) Ltd.
+// This file is part of Parity Bridges Common.
+
+// Parity Bridges Common is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// Parity Bridges Common is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with Parity Bridges Common.  If not, see <http://www.gnu.org/licenses/>.
+
+//! Autogenerated weights for {{pallet}}
+//!
+//! THIS FILE WAS AUTO-GENERATED USING THE SUBSTRATE BENCHMARK CLI VERSION {{version}}
+//! DATE: {{date}}, STEPS: {{cmd.steps}}, REPEAT: {{cmd.repeat}}
+//! LOW RANGE: {{cmd.lowest_range_values}}, HIGH RANGE: {{cmd.highest_range_values}}
+//! EXECUTION: {{cmd.execution}}, WASM-EXECUTION: {{cmd.wasm_execution}}
+//! CHAIN: {{cmd.chain}}, DB CACHE: {{cmd.db_cache}}
+
+// Executed Command:
+{{#each args as |arg|~}}
+// {{arg}}
+{{/each}}
+
+#![allow(clippy::all)]
+#![allow(unused_parens)]
+#![allow(unused_imports)]
+
+use frame_support::{traits::Get, weights::{Weight, constants::RocksDbWeight}};
+use sp_std::marker::PhantomData;
+
+/// Weight functions needed for {{pallet}}.
+pub trait WeightInfo {
+	{{~#each benchmarks as |benchmark|}}
+	fn {{benchmark.name~}}
+	(
+		{{~#each benchmark.components as |c| ~}}
+		{{c.name}}: u32, {{/each~}}
+	) -> Weight;
+	{{~/each}}
+}
+
+/// Weights for {{pallet}} using the Rialto node and recommended hardware.
+pub struct RialtoWeight<T>(PhantomData<T>);
+impl<T: frame_system::Config> WeightInfo for RialtoWeight<T> {
+	{{~#each benchmarks as |benchmark|}}
+	fn {{benchmark.name~}}
+	(
+		{{~#each benchmark.components as |c| ~}}
+		{{~#if (not c.is_used)}}_{{/if}}{{c.name}}: u32, {{/each~}}
+	) -> Weight {
+		({{underscore benchmark.base_weight}} as Weight)
+			{{~#each benchmark.component_weight as |cw|}}
+			.saturating_add(({{underscore cw.slope}} as Weight).saturating_mul({{cw.name}} as Weight))
+			{{~/each}}
+			{{~#if (ne benchmark.base_reads "0")}}
+			.saturating_add(T::DbWeight::get().reads({{benchmark.base_reads}} as Weight))
+			{{~/if}}
+			{{~#each benchmark.component_reads as |cr|}}
+			.saturating_add(T::DbWeight::get().reads(({{cr.slope}} as Weight).saturating_mul({{cr.name}} as Weight)))
+			{{~/each}}
+			{{~#if (ne benchmark.base_writes "0")}}
+			.saturating_add(T::DbWeight::get().writes({{benchmark.base_writes}} as Weight))
+			{{~/if}}
+			{{~#each benchmark.component_writes as |cw|}}
+			.saturating_add(T::DbWeight::get().writes(({{cw.slope}} as Weight).saturating_mul({{cw.name}} as Weight)))
+			{{~/each}}