diff --git a/README.md b/README.md index 6fdfaf271e..6859a9b60b 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ # Cumulus :cloud: -A set of tools for writing [Substrate](https://substrate.dev/)-based +A set of tools for writing [Substrate](https://substrate.io/)-based [Polkadot](https://wiki.polkadot.network/en/) [parachains](https://wiki.polkadot.network/docs/en/learn-parachains). Refer to the included [overview](docs/overview.md) for architectural details, and the -[Cumulus workshop](https://substrate.dev/cumulus-workshop) for a hand-holding walkthrough -of using these tools. +[Cumulus tutorial](https://docs.substrate.io/tutorials/v3/cumulus/start-relay) for a +guided walk-through of using these tools. It's easy to write blockchains using Substrate, and the overhead of writing parachains' distribution, p2p, database, and synchronization layers should be just as low. This project aims to @@ -17,11 +17,11 @@ beautiful and functional. ## Consensus [`cumulus-consensus`](consensus) is a -[consensus engine](https://substrate.dev/docs/en/knowledgebase/advanced/consensus) for Substrate +[consensus engine](https://docs.substrate.io/v3/advanced/consensus) for Substrate that follows a Polkadot -[relay chain](https://wiki.polkadot.network/docs/en/learn-architecture#relay-chain). This will run a -Polkadot node internally, and dictate to the client and synchronization algorithms which chain to -follow, +[relay chain](https://wiki.polkadot.network/docs/en/learn-architecture#relay-chain). This will run +a Polkadot node internally, and dictate to the client and synchronization algorithms which chain +to follow, [finalize](https://wiki.polkadot.network/docs/en/learn-consensus#probabilistic-vs-provable-finality), and treat as best. @@ -53,7 +53,7 @@ To run a Rococo collator you will need to compile the following binary: cargo build --release --locked -p polkadot-collator ``` -Otherwise you can compile it with +Otherwise you can compile it with [Parity CI docker image](https://github.com/paritytech/scripts/tree/master/dockerfiles/ci-linux): ```bash @@ -63,7 +63,7 @@ docker run --rm -it -w /shellhere/cumulus \ sudo chown -R $(id -u):$(id -g) target/ ``` -If you want to reproduce other steps of CI process you can use the following +If you want to reproduce other steps of CI process you can use the following [guide](https://github.com/paritytech/scripts#gitlab-ci-for-building-docker-images). Once the executable is built, launch collators for each parachain (repeat once each for chain diff --git a/pallets/asset-tx-payment/Cargo.toml b/pallets/asset-tx-payment/Cargo.toml index 78deddbea0..8ed40c85ef 100644 --- a/pallets/asset-tx-payment/Cargo.toml +++ b/pallets/asset-tx-payment/Cargo.toml @@ -4,7 +4,7 @@ version = "0.1.0" authors = ["Parity Technologies "] edition = "2018" license = "Apache-2.0" -homepage = "https://substrate.dev" +homepage = "https://substrate.io" repository = "https://github.com/paritytech/cumulus/" description = "pallet to manage transaction payments in assets" readme = "README.md" diff --git a/pallets/collator-selection/Cargo.toml b/pallets/collator-selection/Cargo.toml index 97d0c6bcf5..d486ee85df 100644 --- a/pallets/collator-selection/Cargo.toml +++ b/pallets/collator-selection/Cargo.toml @@ -2,7 +2,7 @@ authors = ['Anonymous'] description = 'Simple staking pallet with a fixed stake.' edition = '2018' -homepage = 'https://substrate.dev' +homepage = 'https://substrate.io' license = 'Apache-2.0' name = 'pallet-collator-selection' readme = 'README.md' diff --git a/pallets/session-benchmarking/Cargo.toml b/pallets/session-benchmarking/Cargo.toml index d4ace2c74a..2591325282 100644 --- a/pallets/session-benchmarking/Cargo.toml +++ b/pallets/session-benchmarking/Cargo.toml @@ -4,7 +4,7 @@ version = "3.0.0" authors = ["Parity Technologies "] edition = "2018" license = "Apache-2.0" -homepage = "https://substrate.dev" +homepage = "https://substrate.io" repository = "https://github.com/paritytech/cumulus/" description = "FRAME sessions pallet benchmarking for statemint" readme = "README.md" diff --git a/parachain-template/node/Cargo.toml b/parachain-template/node/Cargo.toml index 605f7a912f..58e10bae35 100644 --- a/parachain-template/node/Cargo.toml +++ b/parachain-template/node/Cargo.toml @@ -4,7 +4,7 @@ version = "0.1.0" authors = ["Anonymous"] description = "A new Cumulus FRAME-based Substrate Node, ready for hacking together a parachain." license = "Unlicense" -homepage = "https://substrate.dev" +homepage = "https://substrate.io" repository = "https://github.com/paritytech/cumulus/" edition = "2018" build = "build.rs" diff --git a/parachain-template/pallets/template/Cargo.toml b/parachain-template/pallets/template/Cargo.toml index 934fc43468..ccde37831a 100644 --- a/parachain-template/pallets/template/Cargo.toml +++ b/parachain-template/pallets/template/Cargo.toml @@ -4,7 +4,7 @@ authors = ["Anonymous"] description = "FRAME pallet template for defining custom runtime logic." version = "0.1.0" license = "Unlicense" -homepage = "https://substrate.dev" +homepage = "https://substrate.io" repository = "https://github.com/paritytech/substrate/" edition = "2018" diff --git a/parachain-template/pallets/template/src/lib.rs b/parachain-template/pallets/template/src/lib.rs index e744ec7a44..0afd7c6d72 100644 --- a/parachain-template/pallets/template/src/lib.rs +++ b/parachain-template/pallets/template/src/lib.rs @@ -2,7 +2,7 @@ /// Edit this file to define custom logic or remove it if it is not needed. /// Learn more about FRAME and the core library of Substrate FRAME pallets: -/// +/// pub use pallet::*; #[cfg(test)] @@ -31,15 +31,15 @@ pub mod pallet { pub struct Pallet(_); // The pallet's runtime storage items. - // https://substrate.dev/docs/en/knowledgebase/runtime/storage + // https://docs.substrate.io/v3/runtime/storage #[pallet::storage] #[pallet::getter(fn something)] // Learn more about declaring storage items: - // https://substrate.dev/docs/en/knowledgebase/runtime/storage#declaring-storage-items + // https://docs.substrate.io/v3/runtime/storage#declaring-storage-items pub type Something = StorageValue<_, u32>; // Pallets use events to inform users when important changes are made. - // https://substrate.dev/docs/en/knowledgebase/runtime/events + // https://docs.substrate.io/v3/runtime/events-and-errors #[pallet::event] #[pallet::generate_deposit(pub(super) fn deposit_event)] pub enum Event { @@ -71,7 +71,7 @@ pub mod pallet { pub fn do_something(origin: OriginFor, something: u32) -> DispatchResultWithPostInfo { // Check that the extrinsic was signed and get the signer. // This function will return an error if the extrinsic is not signed. - // https://substrate.dev/docs/en/knowledgebase/runtime/origin + // https://docs.substrate.io/v3/runtime/origins let who = ensure_signed(origin)?; // Update storage. diff --git a/parachain-template/runtime/Cargo.toml b/parachain-template/runtime/Cargo.toml index c4edd43d64..e3da6f807b 100644 --- a/parachain-template/runtime/Cargo.toml +++ b/parachain-template/runtime/Cargo.toml @@ -4,7 +4,7 @@ version = "0.1.0" authors = ["Anonymous"] description = "A new Cumulus FRAME-based Substrate Runtime, ready for hacking together a parachain." license = "Unlicense" -homepage = "https://substrate.dev" +homepage = "https://substrate.io" repository = "https://github.com/paritytech/cumulus/" edition = "2018"