Point documentation links to monorepo (#1741)

This commit is contained in:
Sebastian Kunert
2023-09-29 22:33:26 +02:00
committed by GitHub
parent f820dc0a1f
commit 9485b0b492
44 changed files with 83 additions and 82 deletions
+5 -5
View File
@@ -9,15 +9,15 @@ to verify storage proofs, generated at the bridged relay chain.
## A Brief Introduction into Parachains Finality
You can find detailed information on parachains finality in the [Polkadot](https://github.com/paritytech/polkadot)
and [Cumulus](https://github.com/paritytech/cumulus) repositories. This section gives a brief overview of how
the parachain finality works and how to build a light client for a parachain.
You can find detailed information on parachains finality in the
[Polkadot-SDK](https://github.com/paritytech/polkadot-sdk) repository. This section gives a brief overview of how the
parachain finality works and how to build a light client for a parachain.
The main thing there is that the parachain generates blocks on its own, but it can't achieve finality without
help of its relay chain. Instead, the parachain collators create a block and hand it over to the relay chain
validators. Validators validate the block and register the new parachain head in the
[`Heads` map](https://github.com/paritytech/polkadot/blob/88013730166ba90745ae7c9eb3e0c1be1513c7cc/runtime/parachains/src/paras/mod.rs#L645)
of the [`paras`](https://github.com/paritytech/polkadot/tree/master/runtime/parachains/src/paras) pallet,
[`Heads` map](https://github.com/paritytech/polkadot-sdk/blob/bc5005217a8c2e7c95b9011c96d7e619879b1200/polkadot/runtime/parachains/src/paras/mod.rs#L683-L686)
of the [`paras`](https://github.com/paritytech/polkadot-sdk/tree/master/polkadot/runtime/parachains/src/paras) pallet,
deployed at the relay chain. Keep in mind that this pallet, deployed at a relay chain, is **NOT** a bridge pallet,
even though the names are similar.
+1 -1
View File
@@ -6,7 +6,7 @@ cd "$(cd "$(dirname "$0")" && git rev-parse --show-toplevel)"
dockerfile="$1"
if [ -z "$dockerfile" ]; then
dockerfile="./docker/test-parachain-collator.dockerfile"
dockerfile="./docker/test-parachain-collator.Dockerfile"
else
shift 1
fi
+3 -3
View File
@@ -79,9 +79,9 @@ Offline signing libraries depend on a consistent ordering of call indices and fu
current and new runtimes and ensure that the `module index, call index` tuples map to the same set of functions. It also
checks if there have been any changes in `storage`. In case of a breaking change, increase `transaction_version`.
To verify the order has not changed, manually start the following [Github
Action](https://github.com/paritytech/cumulus/actions/workflows/extrinsic-ordering-check-from-bin.yml). It takes around
a minute to run and will produce the report as artifact you need to manually check.
To verify the order has not changed, manually start the following
[Github Action](https://github.com/paritytech/polkadot-sdk/cumulus/.github/workflows/release-20_extrinsic-ordering-check-from-bin.yml).
It takes around a minute to run and will produce the report as artifact you need to manually check.
To run it, in the _Run Workflow_ dropdown:
1. **Use workflow from**: to ignore, leave `master` as default
+2 -2
View File
@@ -1,6 +1,6 @@
# Substrate Cumulus Parachain Template
A new [Cumulus](https://github.com/paritytech/cumulus/)-based Substrate node, ready for hacking ☁️..
A new [Cumulus](https://github.com/paritytech/polkadot-sdk/tree/master/cumulus)-based Substrate node, ready for hacking ☁️..
This project is originally a fork of the
[Substrate Node Template](https://github.com/substrate-developer-hub/substrate-node-template)
@@ -10,7 +10,7 @@ modified to include dependencies required for registering this node as a **parat
The stand-alone version of this template is hosted on the
[Substrate Devhub Parachain Template](https://github.com/substrate-developer-hub/substrate-parachain-template/)
for each release of Polkadot. It is generated directly to the upstream
[Parachain Template in Cumulus](https://github.com/paritytech/cumulus/tree/master/parachain-template)
[Parachain Template in Cumulus](https://github.com/paritytech/polkadot-sdk/tree/master/cumulus/parachain-template)
at each release branch using the
[Substrate Template Generator](https://github.com/paritytech/substrate-template-generator/).
@@ -50,7 +50,7 @@ impl SubstrateCli for Cli {
}
fn support_url() -> String {
"https://github.com/paritytech/cumulus/issues/new".into()
"https://github.com/paritytech/polkadot-sdk/issues/new".into()
}
fn copyright_start_year() -> i32 {
@@ -86,7 +86,7 @@ impl SubstrateCli for RelayChainCli {
}
fn support_url() -> String {
"https://github.com/paritytech/cumulus/issues/new".into()
"https://github.com/paritytech/polkadot-sdk/issues/new".into()
}
fn copyright_start_year() -> i32 {
@@ -80,7 +80,7 @@ impl From<u32> for LaneIdWrapper {
type BridgeHubRococoRuntime = <BridgeHubRococo as Chain>::Runtime;
type BridgeHubWococoRuntime = <BridgeHubWococo as Chain>::Runtime;
// TODO: uncomment when https://github.com/paritytech/cumulus/pull/2528 is merged
// TODO: uncomment when https://github.com/paritytech/polkadot-sdk/pull/1352 is merged
// type BridgeHubPolkadotRuntime = <BridgeHubPolkadot as Chain>::Runtime;
// type BridgeHubKusamaRuntime = <BridgeHubKusama as Chain>::Runtime;
@@ -89,7 +89,7 @@ pub type RococoWococoMessageHandler =
pub type WococoRococoMessageHandler =
BridgeHubMessageHandler<BridgeHubWococoRuntime, BridgeHubRococoRuntime, Instance2>;
// TODO: uncomment when https://github.com/paritytech/cumulus/pull/2528 is merged
// TODO: uncomment when https://github.com/paritytech/polkadot-sdk/pull/1352 is merged
// pub type PolkadotKusamaMessageHandler
// = BridgeHubMessageHandler<BridgeHubPolkadotRuntime, BridgeHubKusamaRuntime, Instance1>;
// pub type KusamaPolkadotMessageHandler
@@ -248,7 +248,7 @@ decl_test_bridges! {
target = BridgeHubRococo,
handler = WococoRococoMessageHandler
}
// TODO: uncomment when https://github.com/paritytech/cumulus/pull/2528 is merged
// TODO: uncomment when https://github.com/paritytech/polkadot-sdk/pull/1352 is merged
// pub struct PolkadotKusamaMockBridge {
// source = BridgeHubPolkadot,
// target = BridgeHubKusama,
@@ -1,7 +1,7 @@
# Contracts 📝
This is a parachain node for smart contracts; it contains a default configuration of
Substrate's module for smart contracts the [`pallet-contracts`](https://github.com/paritytech/substrate/tree/master/frame/contracts).
Substrate's module for smart contracts the [`pallet-contracts`](https://github.com/paritytech/polkadot-sdk/tree/master/substrate/frame/contracts).
The node is only available on Rococo, a testnet for Polkadot and Kusama parachains.
It has been configured as a common good parachain, as such it uses the Rococo relay
@@ -16,7 +16,7 @@ If you have any questions, it's best to ask in the
![Contracts Overview](./contracts-overview.svg)
This node contains Substrate's smart contracts module the
[`pallet-contracts`](https://github.com/paritytech/substrate/tree/master/frame/contracts).
[`pallet-contracts`](https://github.com/paritytech/polkadot-sdk/tree/master/substrate/frame/contracts).
This pallet takes smart contracts as WebAssembly blobs and defines an API
for everything a smart contract needs (storage access, …).
As long as a programming language compiles to WebAssembly and there exists an implementation
@@ -54,7 +54,8 @@ Once the executable is built, launch the parachain node via:
./target/release/polkadot-parachain --chain contracts-rococo
```
Refer to the [setup instructions](https://github.com/paritytech/cumulus#manual-setup) to run a local network for development.
Refer to the [setup instructions](https://github.com/paritytech/polkadot-sdk/tree/master/cumulus#manual-setup) to run a
local network for development.
### Rococo Deployment
+2 -2
View File
@@ -332,7 +332,7 @@ impl SubstrateCli for Cli {
}
fn support_url() -> String {
"https://github.com/paritytech/cumulus/issues/new".into()
"https://github.com/paritytech/polkadot-sdk/issues/new".into()
}
fn copyright_start_year() -> i32 {
@@ -368,7 +368,7 @@ impl SubstrateCli for RelayChainCli {
}
fn support_url() -> String {
"https://github.com/paritytech/cumulus/issues/new".into()
"https://github.com/paritytech/polkadot-sdk/issues/new".into()
}
fn copyright_start_year() -> i32 {
+2 -2
View File
@@ -278,7 +278,7 @@ impl SubstrateCli for TestCollatorCli {
}
fn support_url() -> String {
"https://github.com/paritytech/cumulus/issues/new".into()
"https://github.com/paritytech/polkadot-sdk/issues/new".into()
}
fn copyright_start_year() -> i32 {
@@ -322,7 +322,7 @@ impl SubstrateCli for RelayChainCli {
}
fn support_url() -> String {
"https://github.com/paritytech/cumulus/issues/new".into()
"https://github.com/paritytech/polkadot-sdk/issues/new".into()
}
fn copyright_start_year() -> i32 {
@@ -10,10 +10,10 @@ LABEL io.parity.image.authors="devops-team@parity.io" \
io.parity.image.vendor="Parity Technologies" \
io.parity.image.title="${IMAGE_NAME}" \
io.parity.image.description="Injected adder-collator Docker image" \
io.parity.image.source="https://github.com/paritytech/polkadot/blob/${VCS_REF}/docker/dockerfiles/collator_injected.Dockerfile" \
io.parity.image.source="https://github.com/paritytech/polkadot-sdk/blob/${VCS_REF}/docker/dockerfiles/collator_injected.Dockerfile" \
io.parity.image.revision="${VCS_REF}" \
io.parity.image.created="${BUILD_DATE}" \
io.parity.image.documentation="https://github.com/paritytech/polkadot/"
io.parity.image.documentation="https://github.com/paritytech/polkadot-sdk/"
# show backtraces
ENV RUST_BACKTRACE 1
+4 -4
View File
@@ -61,7 +61,7 @@ services:
genesis_state:
build:
context: .
dockerfile: ./docker/dockerfiles/test-parachain-collator.dockerfile
dockerfile: ./docker/dockerfiles/test-parachain-collator.Dockerfile
image: "ctpc:latest"
volumes:
- "genesis-state:/data"
@@ -73,7 +73,7 @@ services:
collator:
build:
context: .
dockerfile: ./docker/dockerfiles/test-parachain-collator.dockerfile
dockerfile: ./docker/dockerfiles/test-parachain-collator.Dockerfile
target: collator
image: "ctpc:collator"
volumes:
@@ -90,7 +90,7 @@ services:
runtime:
build:
context: .
dockerfile: ./docker/dockerfiles/test-parachain-collator.dockerfile
dockerfile: ./docker/dockerfiles/test-parachain-collator.Dockerfile
target: runtime
image: "ctpc:runtime"
volumes:
@@ -100,7 +100,7 @@ services:
registrar:
build:
context: .
dockerfile: ./docker/dockerfiles/parachain-registrar.dockerfile
dockerfile: ./docker/dockerfiles/parachain-registrar.Dockerfile
image: para-reg:latest
volumes:
- "genesis-state:/genesis"
+2 -2
View File
@@ -9,10 +9,10 @@ LABEL io.parity.image.authors="devops-team@parity.io" \
io.parity.image.vendor="Parity Technologies" \
io.parity.image.title="${IMAGE_NAME}" \
io.parity.image.description="Malus - the nemesis of polkadot" \
io.parity.image.source="https://github.com/paritytech/polkadot/blob/${VCS_REF}/scripts/ci/dockerfiles/malus.Dockerfile" \
io.parity.image.source="https://github.com/paritytech/polkadot-sdk/blob/${VCS_REF}/docker/dockerfiles/malus_injected.Dockerfile" \
io.parity.image.revision="${VCS_REF}" \
io.parity.image.created="${BUILD_DATE}" \
io.parity.image.documentation="https://github.com/paritytech/polkadot/"
io.parity.image.documentation="https://github.com/paritytech/polkadot-sdk/"
# show backtraces
ENV RUST_BACKTRACE 1
@@ -9,7 +9,7 @@ CMD [ "--version" ]
# To use the pjs build stage to access the blockchain from the host machine:
#
# docker build -f docker/dockerfiles/parachain-registrar.dockerfile --target pjs -t parachain-registrar:pjs .
# docker build -f docker/dockerfiles/parachain-registrar.Dockerfile --target pjs -t parachain-registrar:pjs .
# alias pjs='docker run --rm --net cumulus_testing_net parachain-registrar:pjs --ws ws://172.28.1.1:9944'
#
# Then, as long as the chain is running, you can use the polkadot-js-api CLI like:
@@ -9,10 +9,10 @@ LABEL io.parity.image.authors="devops-team@parity.io" \
io.parity.image.vendor="Parity Technologies" \
io.parity.image.title="${IMAGE_NAME}" \
io.parity.image.description="Cumulus, the Polkadot collator." \
io.parity.image.source="https://github.com/paritytech/cumulus/blob/${VCS_REF}/docker/dockerfiles/polkadot-parachain/polkadot-parachain-debug_unsigned_injected.Dockerfile" \
io.parity.image.source="https://github.com/paritytech/polkadot-sdk/blob/${VCS_REF}/docker/dockerfiles/polkadot-parachain/polkadot-parachain-debug_unsigned_injected.Dockerfile" \
io.parity.image.revision="${VCS_REF}" \
io.parity.image.created="${BUILD_DATE}" \
io.parity.image.documentation="https://github.com/paritytech/cumulus/"
io.parity.image.documentation="https://github.com/paritytech/polkadot-sdk/tree/master/cumulus"
# show backtraces
ENV RUST_BACKTRACE 1
@@ -1,4 +1,4 @@
# This file is sourced from https://github.com/paritytech/polkadot/blob/master/docker/dockerfiles/polkadot/polkadot_builder.Dockerfile
# This file is sourced from https://github.com/paritytech/polkadot-sdk/blob/master/docker/dockerfiles/polkadot-parachain/polkadot-parachain_builder.Dockerfile
# This is the build stage for polkadot-parachain. Here we create the binary in a temporary image.
FROM docker.io/paritytech/ci-linux:production as builder
@@ -14,8 +14,8 @@ LABEL io.parity.image.type="builder" \
io.parity.image.authors="devops-team@parity.io" \
io.parity.image.vendor="Parity Technologies" \
io.parity.image.description="Multistage Docker image for polkadot-parachain" \
io.parity.image.source="https://github.com/paritytech/polkadot/blob/${VCS_REF}/docker/dockerfiles/polkadot-parachain/polkadot-parachain_builder.Dockerfile" \
io.parity.image.documentation="https://github.com/paritytech/cumulus"
io.parity.image.source="https://github.com/paritytech/polkadot-sdk/blob/${VCS_REF}/docker/dockerfiles/polkadot-parachain/polkadot-parachain_builder.Dockerfile" \
io.parity.image.documentation="https://github.com/paritytech/polkadot-sdk/tree/master/cumulus"
COPY --from=builder /cumulus/target/release/polkadot-parachain /usr/local/bin
@@ -14,8 +14,8 @@ LABEL description="Multistage Docker image for Polkadot: a platform for web3" \
io.parity.image.authors="chevdor@gmail.com, devops-team@parity.io" \
io.parity.image.vendor="Parity Technologies" \
io.parity.image.description="Polkadot: a platform for web3" \
io.parity.image.source="https://github.com/paritytech/polkadot/blob/${VCS_REF}/docker/dockerfiles/polkadot/polkadot_builder.Dockerfile" \
io.parity.image.documentation="https://github.com/paritytech/polkadot/"
io.parity.image.source="https://github.com/paritytech/polkadot-sdk/blob/${VCS_REF}/docker/dockerfiles/polkadot/polkadot_builder.Dockerfile" \
io.parity.image.documentation="https://github.com/paritytech/polkadot-sdk/"
COPY --from=builder /polkadot/target/release/polkadot /usr/local/bin
@@ -11,10 +11,10 @@ LABEL io.parity.image.authors="devops-team@parity.io" \
io.parity.image.vendor="Parity Technologies" \
io.parity.image.title="parity/polkadot" \
io.parity.image.description="Polkadot: a platform for web3. This is the official Parity image with an injected binary." \
io.parity.image.source="https://github.com/paritytech/polkadot/blob/${VCS_REF}/scripts/ci/dockerfiles/polkadot/polkadot_injected_debian.Dockerfile" \
io.parity.image.source="https://github.com/paritytech/polkadot-sdk/blob/${VCS_REF}/scripts/ci/dockerfiles/polkadot/polkadot_injected_debian.Dockerfile" \
io.parity.image.revision="${VCS_REF}" \
io.parity.image.created="${BUILD_DATE}" \
io.parity.image.documentation="https://github.com/paritytech/polkadot/"
io.parity.image.documentation="https://github.com/paritytech/polkadot-sdk/"
USER root
@@ -9,10 +9,10 @@ LABEL io.parity.image.authors="devops-team@parity.io" \
io.parity.image.vendor="Parity Technologies" \
io.parity.image.title="${IMAGE_NAME}" \
io.parity.image.description="Polkadot: a platform for web3" \
io.parity.image.source="https://github.com/paritytech/polkadot/blob/${VCS_REF}/docker/dockerfiles/polkadot/polkadot_injected_debug.Dockerfile" \
io.parity.image.source="https://github.com/paritytech/polkadot-sdk/blob/${VCS_REF}/docker/dockerfiles/polkadot/polkadot_injected_debug.Dockerfile" \
io.parity.image.revision="${VCS_REF}" \
io.parity.image.created="${BUILD_DATE}" \
io.parity.image.documentation="https://github.com/paritytech/polkadot/"
io.parity.image.documentation="https://github.com/paritytech/polkadot-sdk"
# show backtraces
ENV RUST_BACKTRACE 1
@@ -11,10 +11,10 @@ LABEL io.parity.image.authors="devops-team@parity.io" \
io.parity.image.vendor="Parity Technologies" \
io.parity.image.title="parity/polkadot" \
io.parity.image.description="Polkadot: a platform for web3. This is the official Parity image with an injected binary." \
io.parity.image.source="https://github.com/paritytech/polkadot/blob/${VCS_REF}/docker/dockerfiles/polkadot/polkadot_injected_release.Dockerfile" \
io.parity.image.source="https://github.com/paritytech/polkadot-sdk/blob/${VCS_REF}/docker/dockerfiles/polkadot/polkadot_injected_release.Dockerfile" \
io.parity.image.revision="${VCS_REF}" \
io.parity.image.created="${BUILD_DATE}" \
io.parity.image.documentation="https://github.com/paritytech/polkadot/"
io.parity.image.documentation="https://github.com/paritytech/polkadot-sdk/"
# show backtraces
ENV RUST_BACKTRACE 1
@@ -9,7 +9,7 @@ LABEL io.parity.image.authors="devops-team@parity.io" \
io.parity.image.vendor="Parity Technologies" \
io.parity.image.title="${IMAGE_NAME}" \
io.parity.image.description="Substrate: The platform for blockchain innovators." \
io.parity.image.source="https://github.com/paritytech/substrate/blob/${VCS_REF}/scripts/ci/docker/Dockerfile" \
io.parity.image.source="https://github.com/paritytech/polkadot-sdk/blob/${VCS_REF}/docker/dockerfiles/substrate_injected.Dockerfile" \
io.parity.image.revision="${VCS_REF}" \
io.parity.image.created="${BUILD_DATE}" \
io.parity.image.documentation="https://wiki.parity.io/Parity-Substrate"
@@ -1,4 +1,4 @@
# This file is sourced from https://github.com/paritytech/polkadot/blob/master/docker/dockerfiles/polkadot/polkadot_builder.Dockerfile
# This file is sourced from https://github.com/paritytech/polkadot-sdk/blob/master/docker/dockerfiles/test-parachain-collator.Dockerfile
FROM docker.io/paritytech/ci-linux:production as builder
WORKDIR /cumulus
@@ -9,10 +9,10 @@ LABEL io.parity.image.authors="devops-team@parity.io" \
io.parity.image.vendor="Parity Technologies" \
io.parity.image.title="${IMAGE_NAME}" \
io.parity.image.description="Test parachain for Zombienet" \
io.parity.image.source="https://github.com/paritytech/cumulus/blob/${VCS_REF}/docker/dockerfiles/test-parachain_injected.Dockerfile" \
io.parity.image.source="https://github.com/paritytech/polkadot-sdk/blob/${VCS_REF}/docker/dockerfiles/test-parachain_injected.Dockerfile" \
io.parity.image.revision="${VCS_REF}" \
io.parity.image.created="${BUILD_DATE}" \
io.parity.image.documentation="https://github.com/paritytech/cumulus/"
io.parity.image.documentation="https://github.com/paritytech/polkadot-sdk/tree/master/cumulus"
# show backtraces
ENV RUST_BACKTRACE 1
+1 -1
View File
@@ -291,7 +291,7 @@ Optionally, in order to demonstrate the relation between the two, you can start
```
//! > Made with *Substrate*, for *Polkadot*.
//!
//! [![github]](https://github.com/paritytech/substrate/frame/fast-unstake) -
//! [![github]](https://github.com/paritytech/polkadot-sdk/tree/master/substrate/frame/fast-unstake) -
//! [![polkadot]](https://polkadot.network)
//!
//! [polkadot]: https://img.shields.io/badge/polkadot-E6007A?style=for-the-badge&logo=polkadot&logoColor=white
+8 -8
View File
@@ -22,10 +22,10 @@ The command below allows building a Linux binary without having to even install
```bash
docker run --rm -it \
-w /shellhere/cumulus \
-v $(pwd):/shellhere/cumulus \
paritytech/ci-linux:production
cargo build --release --locked --bin polkadot-parachain
-w /polkadot-sdk \
-v $(pwd):/polkadot-sdk \
paritytech/ci-linux:production \
cargo build --release --locked -p polkadot-parachain-bin --bin polkadot-parachain
sudo chown -R $(id -u):$(id -g) target/
```
@@ -37,11 +37,11 @@ If you want to reproduce other steps of CI process you can use the following
Injecting a binary inside a base image is the quickest option to get a working container image. This only works if you
were able to build a Linux binary, either locally, or using a container as described above.
After building a Linux binary ()`polkadot-parachain`) with cargo or with Parity CI image as documented above, the
After building a Linux binary (`polkadot-parachain`) with cargo or with Parity CI image as documented above, the
following command allows producing a new container image where the compiled binary is injected:
```bash
./docker/scripts/build-injected-image.sh
ARTIFACTS_FOLDER=./target/release /docker/scripts/build-injected.sh
```
## Container build
@@ -52,7 +52,7 @@ anyone to get a working container image without requiring any of the Rust toolch
```bash
docker build \
--tag $OWNER/$IMAGE_NAME \
--file ./docker/dockerfiles/polkadot-parachain/polkadot-parachain_builder.Containerfile .
--file ./docker/dockerfiles/polkadot-parachain/polkadot-parachain_builder.Dockerfile .
```
You may then run your new container:
@@ -62,5 +62,5 @@ docker run --rm -it \
$OWNER/$IMAGE_NAME \
--collator --tmp \
--execution wasm \
--chain /specs/westmint.json
--chain /specs/asset-hub-westend.json
```
+1 -1
View File
@@ -62,7 +62,7 @@ impl SubstrateCli for Cli {
}
fn support_url() -> String {
"https://github.com/paritytech/polkadot/issues/new".into()
"https://github.com/paritytech/polkadot-sdk/issues/new".into()
}
fn copyright_start_year() -> i32 {
@@ -80,7 +80,7 @@ impl SubstrateCli for Cli {
}
fn support_url() -> String {
"https://github.com/paritytech/polkadot/issues/new".into()
"https://github.com/paritytech/polkadot-sdk/issues/new".into()
}
fn copyright_start_year() -> i32 {
@@ -102,7 +102,7 @@ impl SubstrateCli for Cli {
}
fn support_url() -> String {
"https://github.com/paritytech/polkadot/issues/new".into()
"https://github.com/paritytech/polkadot-sdk/issues/new".into()
}
fn copyright_start_year() -> i32 {
+1 -1
View File
@@ -178,7 +178,7 @@ It is the responsibility of the full nodes of the _sending_ para to maintain all
the link where `b` is less than the watermark of the _receiving_ para.
Full nodes of the para will be aware of the head of all MQCs for its channels because they are produced by execution of
the block. This will take collaboration with the Cumulus team (https://github.com/paritytech/cumulus) on APIs.
the block. This will take collaboration with the Cumulus team (https://github.com/paritytech/polkadot-sdk) on APIs.
We will need a network where collators of paras can discover and fetch the relevant portion of the MQC incoming from all
channels.
+4 -4
View File
@@ -7,12 +7,12 @@ in the [Substrate Developer Hub Parachain
Template](https://github.com/substrate-developer-hub/substrate-parachain-template/)
repository. The parachain template is generated directly at each Polkadot
release branch from the [Node Template in
Substrate](https://github.com/paritytech/substrate/tree/master/bin/node-template)
Substrate](https://github.com/paritytech/polkadot-sdk/tree/master/substrate/bin/node-template)
upstream
It is usually best to use the stand-alone version to start a new project. All
bugs, suggestions, and feature requests should be made upstream in the
[Substrate](https://github.com/paritytech/substrate/tree/master/bin/node-template)
[Substrate](https://github.com/paritytech/polkadot-sdk/tree/master/substrate)
repository.
## Getting Started
@@ -186,7 +186,7 @@ template and note the following:
The runtime in this project is constructed using many FRAME pallets that ship
with [the Substrate
repository](https://github.com/paritytech/substrate/tree/master/frame) and a
repository](https://github.com/paritytech/polkadot-sdk/tree/master/substrate/frame) and a
template pallet that is [defined in the
`pallets`](./pallets/template/src/lib.rs) directory.
@@ -221,5 +221,5 @@ the correct dependencies, activate direnv `direnv allow`.
### Docker
Please follow the [Substrate Docker instructions
here](https://github.com/paritytech/substrate/blob/master/docker/README.md) to
here](https://github.com/paritytech/polkadot-sdk/blob/master/substrate/docker/README.md) to
build the Docker container with the Substrate Node Template binary.
@@ -179,7 +179,7 @@ If you want to guarantee that your build works on your computer as you update Ru
use a specific Rust nightly version that is known to be compatible with the version of Substrate they are using; this
version will vary from project to project and different projects may use different mechanisms to communicate this
version to developers. For instance, the Polkadot client specifies this information in its [release
notes](https://github.com/paritytech/polkadot/releases).
notes](https://github.com/paritytech/polkadot-sdk/releases).
```bash
# Specify the specific nightly toolchain in the date below:
+1 -1
View File
@@ -50,7 +50,7 @@ impl SubstrateCli for Cli {
}
fn support_url() -> String {
"https://github.com/paritytech/substrate/issues/new".into()
"https://github.com/paritytech/polkadot-sdk/issues/new".into()
}
fn copyright_start_year() -> i32 {
+1 -1
View File
@@ -159,7 +159,7 @@ ambiguity despite using block number instead of a hash. A collection of **votes*
a Commitment and a collection of signatures is going to be called **Signed Commitment**. A valid
(see later for the rules) Signed Commitment is also called a **BEEFY Justification** or
**BEEFY Finality Proof**. For more details on the actual data structures please see
[BEEFY primitives definitions](https://github.com/paritytech/substrate/tree/master/primitives/beefy/src).
[BEEFY primitives definitions](https://github.com/paritytech/polkadot-sdk/tree/master/substrate/primitives/beefy/src).
A **round** is an attempt by BEEFY validators to produce a BEEFY Justification. **Round number**
is simply defined as a block number the validators are voting for, or to be more precise, the
@@ -12,8 +12,8 @@ LABEL description="Multistage Docker image for Substrate: a platform for web3" \
io.parity.image.authors="chevdor@gmail.com, devops-team@parity.io" \
io.parity.image.vendor="Parity Technologies" \
io.parity.image.description="Substrate is a next-generation framework for blockchain innovation 🚀" \
io.parity.image.source="https://github.com/paritytech/polkadot/blob/${VCS_REF}/docker/substrate_builder.Dockerfile" \
io.parity.image.documentation="https://github.com/paritytech/polkadot/"
io.parity.image.source="https://github.com/paritytech/polkadot-sdk/blob/${VCS_REF}/substrate/docker/substrate_builder.Dockerfile" \
io.parity.image.documentation="https://github.com/paritytech/polkadot-sdk"
COPY --from=builder /substrate/target/release/substrate /usr/local/bin
COPY --from=builder /substrate/target/release/subkey /usr/local/bin
+1 -1
View File
@@ -1,7 +1,7 @@
# Substrate Node Template Release Process
## This release process has to be run in a github checkout Substrate directory with your work committed into
`https://github.com/paritytech/substrate/`, because the build script will check the existence of your current git commit
`https://github.com/paritytech/polkadot-sdk/`, because the build script will check the existence of your current git commit
ID in the remote repository.
Assume you are in root directory of Substrate. Run:
+1 -1
View File
@@ -17,7 +17,7 @@
//! > Made with *Substrate*, for *Polkadot*.
//!
//! [![github]](https://github.com/paritytech/substrate/frame/fast-unstake) -
//! [![github]](https://github.com/paritytech/polkadot-sdk/tree/master/substrate/frame/bags-list) -
//! [![polkadot]](https://polkadot.network)
//!
//! [polkadot]:
@@ -608,7 +608,7 @@ fn expand_functions(def: &EnvDef, expand_blocks: bool, host_state: TokenStream2)
let not_deprecated = f.not_deprecated;
// wrapped host function body call with host function traces
// see https://github.com/paritytech/substrate/tree/master/frame/contracts#host-function-tracing
// see https://github.com/paritytech/polkadot-sdk/tree/master/substrate/frame/contracts#host-function-tracing
let wrapped_body_with_trace = {
let trace_fmt_args = params.clone().filter_map(|arg| match arg {
syn::FnArg::Receiver(_) => None,
+1 -1
View File
@@ -457,7 +457,7 @@ impl<T: Config> Pallet<T> {
// Note that a signed extension can also indicate that a particular data must be present in the
// _signing payload_ of a transaction by providing an implementation for the `additional_signed`
// method. This example will not cover this type of extension. See `CheckSpecVersion` in
// [FRAME System](https://github.com/paritytech/substrate/tree/master/frame/system#signed-extensions)
// [FRAME System](https://github.com/paritytech/polkadot-sdk/tree/master/substrate/frame/system#signed-extensions)
// for an example.
//
// Using the extension, you can add some hooks to the life cycle of each transaction. Note that by
+1 -1
View File
@@ -17,7 +17,7 @@
//! > Made with *Substrate*, for *Polkadot*.
//!
//! [![github]](https://github.com/paritytech/substrate/frame/fast-unstake) -
//! [![github]](https://github.com/paritytech/polkadot-sdk/tree/master/substrate/frame/fast-unstake) -
//! [![polkadot]](https://polkadot.network)
//!
//! [polkadot]: https://img.shields.io/badge/polkadot-E6007A?style=for-the-badge&logo=polkadot&logoColor=white
+1 -1
View File
@@ -17,7 +17,7 @@
//! > Made with *Substrate*, for *Polkadot*.
//!
//! [![github]](https://github.com/paritytech/substrate/frame/fast-unstake) -
//! [![github]](https://github.com/paritytech/polkadot-sdk/tree/master/substrate/frame/scheduler) -
//! [![polkadot]](https://polkadot.network)
//!
//! [polkadot]: https://img.shields.io/badge/polkadot-E6007A?style=for-the-badge&logo=polkadot&logoColor=white
+1 -1
View File
@@ -73,7 +73,7 @@ pub mod pallet {
### Example from the FRAME
The [Session module](https://github.com/paritytech/substrate/blob/master/frame/session/src/lib.rs) uses
The [Session module](https://github.com/paritytech/polkadot-sdk/blob/master/substrate/frame/session/src/lib.rs) uses
the Timestamp module for session management.
## Related Modules
@@ -6,7 +6,7 @@ description = "Primitives for Sassafras consensus"
edition = "2021"
license = "Apache-2.0"
homepage = "https://substrate.io"
repository = "https://github.com/paritytech/substrate/"
repository = "https://github.com/paritytech/polkadot-sdk/"
documentation = "https://docs.rs/sp-consensus-sassafras"
readme = "README.md"
publish = false
@@ -7,6 +7,6 @@ to significant changes.
Depends on upstream experimental feature: `bandersnatch-experimental`.
These structs were mostly extracted from the main SASSAFRAS protocol PR: https://github.com/paritytech/substrate/pull/11879.
These structs were mostly extracted from the main SASSAFRAS protocol PR: https://github.com/paritytech/polkadot-sdk/pull/1336.
Tracking issue: https://github.com/paritytech/polkadot-sdk/issues/41
+2 -2
View File
@@ -21,7 +21,7 @@
//! Substrate is a Rust framework for building blockchains in a modular and extensible way. While in
//! itself un-opinionated, it is the main engine behind the Polkadot ecosystem.
//!
//! [![github]](https://github.com/paritytech/substrate/) - [![polkadot]](https://polkadot.network)
//! [![github]](https://github.com/paritytech/polkadot-sdk/tree/master/substrate/) - [![polkadot]](https://polkadot.network)
//!
//! This crate in itself does not contain any code and is just meant ot be a documentation hub for
//! substrate-based crates.
@@ -157,7 +157,7 @@
//! through which Polkadot can be utilized is by building "parachains", blockchains that are
//! connected to Polkadot's shared security.
//!
//! To build a parachain, one could use [`Cumulus`](https://github.com/paritytech/cumulus/), the
//! To build a parachain, one could use [`Cumulus`](https://github.com/paritytech/polkadot-sdk/tree/master/cumulus), the
//! library on top of Substrate, empowering any substrate-based chain to be a Polkadot parachain.
//!
//! ## Where To Go Next?