diff --git a/.ai/categories/basics.md b/.ai/categories/basics.md index 95a840c58..94a6470bd 100644 --- a/.ai/categories/basics.md +++ b/.ai/categories/basics.md @@ -4146,7 +4146,7 @@ From here, follow the quick starts to get connected, iterate locally with your p --- -Page Title: Install Polkadot SDK Dependencies +Page Title: Install Polkadot SDK - Source (raw): https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/master/.ai/pages/parachains-install-polkadot-sdk.md - Canonical (HTML): https://docs.polkadot.com/parachains/install-polkadot-sdk/ diff --git a/.ai/categories/dapps.md b/.ai/categories/dapps.md index 9d2d80162..e0099e1d5 100644 --- a/.ai/categories/dapps.md +++ b/.ai/categories/dapps.md @@ -5430,7 +5430,7 @@ A blockchain indexer is a specialized infrastructure tool that processes, organi --- -Page Title: Install Polkadot SDK Dependencies +Page Title: Install Polkadot SDK - Source (raw): https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/master/.ai/pages/parachains-install-polkadot-sdk.md - Canonical (HTML): https://docs.polkadot.com/parachains/install-polkadot-sdk/ diff --git a/.ai/categories/infrastructure.md b/.ai/categories/infrastructure.md index 05dd80a97..fa9bb979b 100644 --- a/.ai/categories/infrastructure.md +++ b/.ai/categories/infrastructure.md @@ -5240,7 +5240,7 @@ Westend is a Parity-maintained, Polkadot SDK-based blockchain that serves as a t --- -Page Title: Install Polkadot SDK Dependencies +Page Title: Install Polkadot SDK - Source (raw): https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/master/.ai/pages/parachains-install-polkadot-sdk.md - Canonical (HTML): https://docs.polkadot.com/parachains/install-polkadot-sdk/ diff --git a/.ai/categories/networks.md b/.ai/categories/networks.md index 282068cfa..f9b300c14 100644 --- a/.ai/categories/networks.md +++ b/.ai/categories/networks.md @@ -4515,7 +4515,7 @@ Westend is a Parity-maintained, Polkadot SDK-based blockchain that serves as a t --- -Page Title: Install Polkadot SDK Dependencies +Page Title: Install Polkadot SDK - Source (raw): https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/master/.ai/pages/parachains-install-polkadot-sdk.md - Canonical (HTML): https://docs.polkadot.com/parachains/install-polkadot-sdk/ diff --git a/.ai/categories/parachains.md b/.ai/categories/parachains.md index a4efa3983..c73cd1543 100644 --- a/.ai/categories/parachains.md +++ b/.ai/categories/parachains.md @@ -9343,7 +9343,7 @@ Westend is a Parity-maintained, Polkadot SDK-based blockchain that serves as a t --- -Page Title: Install Polkadot SDK Dependencies +Page Title: Install Polkadot SDK - Source (raw): https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/master/.ai/pages/parachains-install-polkadot-sdk.md - Canonical (HTML): https://docs.polkadot.com/parachains/install-polkadot-sdk/ diff --git a/.ai/categories/polkadot-protocol.md b/.ai/categories/polkadot-protocol.md index b8ac4e161..e7fc598ed 100644 --- a/.ai/categories/polkadot-protocol.md +++ b/.ai/categories/polkadot-protocol.md @@ -5073,7 +5073,7 @@ Westend is a Parity-maintained, Polkadot SDK-based blockchain that serves as a t --- -Page Title: Install Polkadot SDK Dependencies +Page Title: Install Polkadot SDK - Source (raw): https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/master/.ai/pages/parachains-install-polkadot-sdk.md - Canonical (HTML): https://docs.polkadot.com/parachains/install-polkadot-sdk/ diff --git a/.ai/categories/tooling.md b/.ai/categories/tooling.md index 41ae91e34..fef3b4da3 100644 --- a/.ai/categories/tooling.md +++ b/.ai/categories/tooling.md @@ -13501,7 +13501,7 @@ A blockchain indexer is a specialized infrastructure tool that processes, organi --- -Page Title: Install Polkadot SDK Dependencies +Page Title: Install Polkadot SDK - Source (raw): https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/master/.ai/pages/parachains-install-polkadot-sdk.md - Canonical (HTML): https://docs.polkadot.com/parachains/install-polkadot-sdk/ diff --git a/.ai/pages/parachains-install-polkadot-sdk.md b/.ai/pages/parachains-install-polkadot-sdk.md index b847cbc22..020eb6a42 100644 --- a/.ai/pages/parachains-install-polkadot-sdk.md +++ b/.ai/pages/parachains-install-polkadot-sdk.md @@ -1,19 +1,26 @@ --- -title: Install Polkadot SDK Dependencies -description: Install everything you need to begin working with Substrated-based blockchains and the Polkadot SDK, the framework for building blockchains. +title: Install Polkadot SDK +description: Install everything you need to begin working with the Polkadot SDK, the framework for building blockchains. categories: Basics, Tooling url: https://docs.polkadot.com/parachains/install-polkadot-sdk/ --- -# Install Polkadot SDK Dependencies +# Install Polkadot SDK -This guide provides step-by-step instructions for installing the dependencies you need to work with the Polkadot SDK-based chains on macOS, Linux, and Windows. Follow the appropriate section for your operating system to ensure all necessary tools are installed and configured properly. +This guide provides step-by-step instructions for installing the Polkadot SDK on macOS, Linux, and Windows. The installation process consists of two main parts: -## macOS +1. **Installing Dependencies** - Setting up Rust, required system packages, and development tools +2. **Building the Polkadot SDK** - Cloning and compiling the Polkadot SDK repository + +Follow the appropriate section for your operating system to ensure all necessary tools are installed and configured properly. + +## Part 1: Install Dependencies + +### macOS You can install Rust and set up a Substrate development environment on Apple macOS computers with Intel or Apple M1 processors. -### Before You Begin +#### Before You Begin Before you install Rust and set up your development environment on macOS, verify that your computer meets the following basic requirements: @@ -57,7 +64,7 @@ Protobuf must be installed before the build process can begin. To install it, ru brew install protobuf ``` -### Install Required Packages and Rust +#### Install Required Packages and Rust Because the blockchain requires standard cryptography to support the generation of public/private key pairs and the validation of transaction signatures, you must also have a package that provides cryptography, such as `openssl`. @@ -98,18 +105,19 @@ To install `openssl` and the Rust toolchain on macOS: rustup component add rust-src ``` -8. [Verify your installation](#verifying-installation). -9. Install `cmake` using the following command: +8. Install `cmake` using the following command: ```bash brew install cmake ``` -## Linux +9. Proceed to [Part 2: Build the Polkadot SDK](#part-2-build-the-polkadot-sdk). + +### Linux Rust supports most Linux distributions. Depending on the specific distribution and version of the operating system you use, you might need to add some software dependencies to your environment. In general, your development environment should include a linker or C-compatible compiler, such as `clang` and an appropriate integrated development environment (IDE). -### Before You Begin {: #before-you-begin-linux } +#### Before You Begin Check the documentation for your operating system for information about the installed packages and how to download and install any additional packages you might need. For example, if you use Ubuntu, you can use the Ubuntu Advanced Packaging Tool (`apt`) to install the `build-essential` package: @@ -125,7 +133,7 @@ clang curl git make Because the blockchain requires standard cryptography to support the generation of public/private key pairs and the validation of transaction signatures, you must also have a package that provides cryptography, such as `libssl-dev` or `openssl-devel`. -### Install Required Packages and Rust {: #install-required-packages-and-rust-linux } +#### Install Required Packages and Rust To install the Rust toolchain on Linux: @@ -194,15 +202,15 @@ To install the Rust toolchain on Linux: rustup component add rust-src ``` -9. [Verify your installation](#verifying-installation). +9. Proceed to [Part 2: Build the Polkadot SDK](#part-2-build-the-polkadot-sdk). -## Windows (WSL) +### Windows (WSL) In general, UNIX-based operating systems—like macOS or Linux—provide a better development environment for building Substrate-based blockchains. However, suppose your local computer uses Microsoft Windows instead of a UNIX-based operating system. In that case, you can configure it with additional software to make it a suitable development environment for building Substrate-based blockchains. To prepare a development environment on a Microsoft Windows computer, you can use Windows Subsystem for Linux (WSL) to emulate a UNIX operating environment. -### Before You Begin {: #before-you-begin-windows } +#### Before You Begin Before installing on Microsoft Windows, verify the following basic requirements: @@ -211,7 +219,7 @@ Before installing on Microsoft Windows, verify the following basic requirements: - **For Windows server**: You must be running Microsoft Windows Server 2019, or later, to install WSL on a server operating system. - You have good internet connection and access to a shell terminal on your local computer. -### Set Up Windows Subsystem for Linux +#### Set Up Windows Subsystem for Linux WSL enables you to emulate a Linux environment on a computer that uses the Windows operating system. The primary advantage of this approach for Substrate development is that you can use all of the code and command-line examples as described in the Substrate documentation. For example, you can run common commands—such as `ls` and `ps`—unmodified. By using WSL, you can avoid configuring a virtual machine image or a dual-boot operating system. @@ -247,7 +255,7 @@ To prepare a development environment using WSL: For more information about setting up WSL as a development environment, see the [Set up a WSL development environment](https://learn.microsoft.com/en-us/windows/wsl/setup/environment){target=\_blank} docs. -### Install Required Packages and Rust {: #install-required-packages-and-rust-windows } +#### Install Required Packages and Rust To install the Rust toolchain on WSL: @@ -295,31 +303,103 @@ To install the Rust toolchain on WSL: rustup component add rust-src ``` -11. [Verify your installation](#verifying-installation). +11. Proceed to [Part 2: Build the Polkadot SDK](#part-2-build-the-polkadot-sdk). + +## Part 2: Build the Polkadot SDK + +After installing all dependencies, you can now clone and compile the Polkadot SDK repository to verify your setup. + +### Clone the Polkadot SDK + +1. Clone the Polkadot SDK repository: + + ```bash + git clone https://github.com/paritytech/polkadot-sdk.git + ``` + +2. Navigate into the project directory: -## Verifying Installation + ```bash + cd polkadot-sdk + ``` + +### Compile the Polkadot SDK + +Compile the entire Polkadot SDK repository to ensure your environment is properly configured: + +```bash +cargo build --release --locked +``` + +!!!warning + This initial compilation will take significant time (30-60 minutes or more) depending on your machine specifications. The `--release` flag optimizes for performance. This step compiles all components of the Polkadot SDK to verify your toolchain is correctly configured. + +### Verify the Build -Verify the configuration of your development environment by running the following command: +Once the build completes successfully, verify the installation by checking the compiled binaries: ```bash -rustup show +ls target/release ``` -The command displays output similar to the following: - -
- rustup show - ... -
- active toolchain - ---------------- - name: stable-aarch64-apple-darwin - active because: it's the default toolchain - installed targets: - aarch64-apple-darwin - wasm32-unknown-unknown -
+You should see several binaries including: + +- `polkadot` - The Polkadot relay chain node +- `polkadot-parachain` - The parachain collator node +- `polkadot-omni-node` - The omni node for running parachains +- `substrate-node` - The kitchensink node with many pre-configured pallets + +Verify the Polkadot binary works by checking its version: + +```bash +./target/release/polkadot --version +``` + +This should display version information similar to: + +```bash +polkadot 1.16.0-1234abcd567 +``` + +If you see the version output without errors, your development environment is correctly configured and ready for Polkadot SDK development! + +## Optional: Run the Kitchensink Node + +The Polkadot SDK includes a feature-rich node called "kitchensink" located at `substrate/bin/node`. This node comes pre-configured with many pallets and features from the Polkadot SDK, making it an excellent reference for exploring capabilities and understanding how different components work together. + +!!!note + If you've already compiled the Polkadot SDK in the previous step, the `substrate-node` binary is already built and ready to use. You can skip directly to running the node. + +### Run the Kitchensink Node in Development Mode + +From the `polkadot-sdk` root directory, start the kitchensink node in development mode: + +```bash +./target/release/substrate-node --dev +``` + +The `--dev` flag enables development mode, which: + +- Runs a single-node development chain +- Produces and finalizes blocks automatically +- Uses pre-configured development accounts (Alice, Bob, etc.) +- Deletes all data when stopped, ensuring a clean state on restart + +You should see log output indicating the node is running and producing blocks, with increasing block numbers after `finalized`. + +### Interact with the Kitchensink Node + +The kitchensink node is accessible at `ws://localhost:9944`. To explore its features using the Polkadot.js Apps interface: + +1. Open [Polkadot.js Apps](https://polkadot.js.org/apps/#/explorer){target=\_blank} in your web browser +2. Click the network icon in the top left corner +3. Scroll to **Development** and select **Local Node** +4. Click **Switch** to connect to your local node + +You can now explore the various pallets and features included in the kitchensink node, making it a valuable reference as you develop your own blockchain applications. + +To stop the node, press `Control-C` in the terminal. ## Where to Go Next -- **[Parachain Zero to Hero Tutorials](/tutorials/polkadot-sdk/parachains/zero-to-hero/){target=\_blank}**: A series of step-by-step guides to building, testing, and deploying custom pallets and runtimes using the Polkadot SDK. +- **[Get Started with Parachain Development](/parachains/get-started/){target=\_blank}**: Practical examples and tutorials for building and deploying Polkadot parachains, covering everything from launch to customization and cross-chain messaging. diff --git a/.ai/site-index.json b/.ai/site-index.json index 64e35be44..da34008a6 100644 --- a/.ai/site-index.json +++ b/.ai/site-index.json @@ -7442,7 +7442,7 @@ }, { "id": "parachains-install-polkadot-sdk", - "title": "Install Polkadot SDK Dependencies", + "title": "Install Polkadot SDK", "slug": "parachains-install-polkadot-sdk", "categories": [ "Basics", @@ -7450,62 +7450,62 @@ ], "raw_md_url": "https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/master/.ai/pages/parachains-install-polkadot-sdk.md", "html_url": "https://docs.polkadot.com/parachains/install-polkadot-sdk/", - "preview": "This guide provides step-by-step instructions for installing the dependencies you need to work with the Polkadot SDK-based chains on macOS, Linux, and Windows. Follow the appropriate section for your operating system to ensure all necessary tools are installed and configured properly.", + "preview": "This guide provides step-by-step instructions for installing the Polkadot SDK on macOS, Linux, and Windows. The installation process consists of two main parts:", "outline": [ { "depth": 2, + "title": "Part 1: Install Dependencies", + "anchor": "part-1-install-dependencies" + }, + { + "depth": 3, "title": "macOS", "anchor": "macos" }, { "depth": 3, - "title": "Before You Begin", - "anchor": "before-you-begin" + "title": "Linux", + "anchor": "linux" }, { "depth": 3, - "title": "Install Required Packages and Rust", - "anchor": "install-required-packages-and-rust" + "title": "Windows (WSL)", + "anchor": "windows-wsl" }, { "depth": 2, - "title": "Linux", - "anchor": "linux" + "title": "Part 2: Build the Polkadot SDK", + "anchor": "part-2-build-the-polkadot-sdk" }, { "depth": 3, - "title": "Before You Begin {: #before-you-begin-linux }", - "anchor": "before-you-begin-before-you-begin-linux" + "title": "Clone the Polkadot SDK", + "anchor": "clone-the-polkadot-sdk" }, { "depth": 3, - "title": "Install Required Packages and Rust {: #install-required-packages-and-rust-linux }", - "anchor": "install-required-packages-and-rust-install-required-packages-and-rust-linux" - }, - { - "depth": 2, - "title": "Windows (WSL)", - "anchor": "windows-wsl" + "title": "Compile the Polkadot SDK", + "anchor": "compile-the-polkadot-sdk" }, { "depth": 3, - "title": "Before You Begin {: #before-you-begin-windows }", - "anchor": "before-you-begin-before-you-begin-windows" + "title": "Verify the Build", + "anchor": "verify-the-build" }, { - "depth": 3, - "title": "Set Up Windows Subsystem for Linux", - "anchor": "set-up-windows-subsystem-for-linux" + "depth": 2, + "title": "Optional: Run the Kitchensink Node", + "anchor": "optional-run-the-kitchensink-node" }, { "depth": 3, - "title": "Install Required Packages and Rust {: #install-required-packages-and-rust-windows }", - "anchor": "install-required-packages-and-rust-install-required-packages-and-rust-windows" + "title": "Run the Kitchensink Node in Development Mode", + "anchor": "run-the-kitchensink-node-in-development-mode" }, { - "depth": 2, - "title": "Verifying Installation", - "anchor": "verifying-installation" + "depth": 3, + "title": "Interact with the Kitchensink Node", + "anchor": "interact-with-the-kitchensink-node" }, { "depth": 2, @@ -7514,10 +7514,10 @@ } ], "stats": { - "chars": 12756, - "words": 1840, + "chars": 15587, + "words": 2258, "headings": 12, - "estimated_token_count_total": 2709 + "estimated_token_count_total": 3216 }, "hash": "sha256:2ee5656f749b4bca445172f2bc66c7fc39af40ff173626662ae4c399f49cf909", "last_modified": "2025-10-28T14:42:14+00:00", diff --git a/.snippets/code/parachains/install-polkadot-sdk/termynal-2.html b/.snippets/code/parachains/install-polkadot-sdk/termynal-2.html deleted file mode 100644 index 81f62a0b6..000000000 --- a/.snippets/code/parachains/install-polkadot-sdk/termynal-2.html +++ /dev/null @@ -1,12 +0,0 @@ -
- rustup show - ... -
- active toolchain - ---------------- - name: stable-aarch64-apple-darwin - active because: it's the default toolchain - installed targets: - aarch64-apple-darwin - wasm32-unknown-unknown -
diff --git a/.snippets/code/parachains/install-polkadot-sdk/termynal-2html b/.snippets/code/parachains/install-polkadot-sdk/termynal-2html new file mode 100644 index 000000000..1c235b80c --- /dev/null +++ b/.snippets/code/parachains/install-polkadot-sdk/termynal-2html @@ -0,0 +1,48 @@ +
+ ./target/release/substrate-node --dev + 2025-10-25 09:08:53 Substrate Node + 2025-10-25 09:08:53 ✌️ version 3.0.0-dev-7304295748b + 2025-10-25 09:08:53 ❤️ by Parity Technologies <admin@parity.io>, 2017-2025 + 2025-10-25 09:08:53 📋 Chain specification: Development + 2025-10-25 09:08:53 🏷 Node name: squalid-shelf-0944 + 2025-10-25 09:08:53 👤 Role: AUTHORITY + 2025-10-25 09:08:53 💾 Database: RocksDb at /var/folders/6t/fw37yfvx14qgwv5sl5p0lcph0000gn/T/substrate0XFsh7/chains/dev/db/full + 2025-10-25 09:08:57 🔨 Initializing Genesis block/state (state: 0x9831…a36f, header-hash: 0x6eaf…0764) + 2025-10-25 09:08:57 Creating transaction pool txpool_type=ForkAware ready=Limit { count: 8192, total_bytes: 20971520 } future=Limit { count: 819, total_bytes: 2097152 } + 2025-10-25 09:08:57 👴 Loading GRANDPA authority set from genesis on what appears to be first startup. + 2025-10-25 09:08:57 👶 Creating empty BABE epoch changes on what appears to be first startup. + 2025-10-25 09:08:57 Using default protocol ID "sup" because none is configured in the chain specs + 2025-10-25 09:08:57 Local node identity is: 12D3KooWFug81ps95nGBDXidDv8K9zth3JBwVw3nm8KanZ3Rdi4J + 2025-10-25 09:08:57 Running litep2p network backend + 2025-10-25 09:08:57 💻 Operating system: macos + 2025-10-25 09:08:57 💻 CPU architecture: aarch64 + 2025-10-25 09:08:57 📦 Highest known block at #0 + 2025-10-25 09:08:57 〽️ Prometheus exporter started at 127.0.0.1:9615 + 2025-10-25 09:08:57 Running JSON-RPC server: addr=127.0.0.1:9944,[::1]:9944 + 2025-10-25 09:08:57 🏁 CPU single core score: 1.55 GiBs, parallelism score: 1.43 GiBs with expected cores: 8 + 2025-10-25 09:08:57 🏁 Memory score: 65.81 GiBs + 2025-10-25 09:08:57 🏁 Disk score (seq. writes): 3.20 GiBs + 2025-10-25 09:08:57 🏁 Disk score (rand. writes): 760.04 MiBs + 2025-10-25 09:08:57 👶 Starting BABE Authorship worker + 2025-10-25 09:08:57 Failed to load AddrCache from file, using empty instead: Failed to encode or decode AddrCache. + 2025-10-25 09:08:57 Loaded persisted AddrCache with 0 authority ids. + 2025-10-25 09:08:57 🥩 BEEFY gadget waiting for BEEFY pallet to become available... + 2025-10-25 09:08:57 Successfully persisted AddrCache on disk + 2025-10-25 09:09:00 🙌 Starting consensus session on top of parent 0x6eaf6f7689b01e21821690ce221c6f5a4eeab997242f60d232234b6c1da20764 (#0) + 2025-10-25 09:09:00 🎁 Prepared block for proposing at 1 (5 ms) hash: 0xf1937d6bec79950210463b701e187abe7d0d5e3eb6e089f1c15e5857966471ca; parent_hash: 0x6eaf…0764; end: NoMoreTransactions; extrinsics_count: 2 + 2025-10-25 09:09:00 🔖 Pre-sealed block for proposal at 1. Hash now 0xcf78ec71ff34797161bfeaa325d21f14745b74cbaa59122ed879af024c7a1400, previously 0xf1937d6bec79950210463b701e187abe7d0d5e3eb6e089f1c15e5857966471ca. + 2025-10-25 09:09:00 👶 New epoch 0 launching at block 0xcf78…1400 (block slot 587119380 >= start slot 587119380). + 2025-10-25 09:09:00 👶 Next epoch starts at slot 587119580 + 2025-10-25 09:09:00 🏆 Imported #1 (0x6eaf…0764 → 0xcf78…1400) + 2025-10-25 09:09:00 maintain txs=(0, 0) a=1 i=1 views=[(1, 0, 0)] event=NewBestBlock { hash: 0xcf78ec71ff34797161bfeaa325d21f14745b74cbaa59122ed879af024c7a1400, tree_route: None } duration=2.034958ms + 2025-10-25 09:09:02 💤 Idle (0 peers), best: #1 (0xcf78…1400), finalized #0 (0x6eaf…0764), ⬇ 0 ⬆ 0 + 2025-10-25 09:09:03 🙌 Starting consensus session on top of parent 0xcf78ec71ff34797161bfeaa325d21f14745b74cbaa59122ed879af024c7a1400 (#1) + 2025-10-25 09:09:03 🎁 Prepared block for proposing at 2 (4 ms) hash: 0xc5cc68c6f3dcda8bae3028f2e17a8dcd348c65750332f31af7972f25bf7a7d60; parent_hash: 0xcf78…1400; end: NoMoreTransactions; extrinsics_count: 2 + 2025-10-25 09:09:03 🔖 Pre-sealed block for proposal at 2. Hash now 0x67d0adc440feeb28c239da9650744d3dbda899b3ca3b8dc00050ce7269ea6aee, previously 0xc5cc68c6f3dcda8bae3028f2e17a8dcd348c65750332f31af7972f25bf7a7d60. + 2025-10-25 09:09:03 🏆 Imported #2 (0xcf78…1400 → 0x67d0…6aee) + 2025-10-25 09:09:03 maintain txs=(0, 0) a=1 i=2 views=[(2, 0, 0)] event=NewBestBlock { hash: 0x67d0adc440feeb28c239da9650744d3dbda899b3ca3b8dc00050ce7269ea6aee, tree_route: None } duration=301µs + 2025-10-25 09:09:06 🙌 Starting consensus session on top of parent 0x67d0adc440feeb28c239da9650744d3dbda899b3ca3b8dc00050ce7269ea6aee (#2) + 2025-10-25 09:09:06 🎁 Prepared block for proposing at 3 (5 ms) hash: 0x29eaa5f82783284b25e9c81e851ae5be63c54de28c94f438cbd733f680172ea2; parent_hash: 0x67d0…6aee; end: NoMoreTransactions; extrinsics_count: 2 + 2025-10-25 09:09:06 🔖 Pre-sealed block for proposal at 3. Hash now 0x8fb26c9192f8738b8971107072f9d106d364ee7f1ece94d8ae5acc9f69cc522f, previously 0x29eaa5f82783284b25e9c81e851ae5be63c54de28c94f438cbd733f680172ea2. + +
\ No newline at end of file diff --git a/images/parachains/install-polkadot-sdk/install-polkadot-sdk-1.webp b/images/parachains/install-polkadot-sdk/install-polkadot-sdk-1.webp new file mode 100644 index 000000000..afeb06235 Binary files /dev/null and b/images/parachains/install-polkadot-sdk/install-polkadot-sdk-1.webp differ diff --git a/images/parachains/install-polkadot-sdk/install-polkadot-sdk-2.webp b/images/parachains/install-polkadot-sdk/install-polkadot-sdk-2.webp new file mode 100644 index 000000000..0bd1cd6ba Binary files /dev/null and b/images/parachains/install-polkadot-sdk/install-polkadot-sdk-2.webp differ diff --git a/llms-full.jsonl b/llms-full.jsonl index e7b3d0dd6..3f0e48c6f 100644 --- a/llms-full.jsonl +++ b/llms-full.jsonl @@ -635,18 +635,18 @@ {"page_id": "parachains-get-started", "page_title": "Get Started with Parachain Development", "index": 6, "depth": 2, "title": "Interoperability", "anchor": "interoperability", "start_char": 6290, "end_char": 7079, "estimated_token_count": 251, "token_estimator": "heuristic-v1", "text": "## Interoperability\n\nConfigure your parachain for cross-chain communication using XCM (Cross-Consensus Messaging).\n\n| Tutorial | Description |\n| :--------------------------------------------------------------------------------------------------------: | :----------------------------------------------------: |\n| [Open HRMP Channels Between Parachains](/parachains/interoperability/channels-between-parachains/) | Establish communication channels with other parachains |\n| [Open HRMP Channels with System Parachains](/parachains/interoperability/channels-with-system-parachains/) | Connect with Asset Hub and other system parachains |"} {"page_id": "parachains-get-started", "page_title": "Get Started with Parachain Development", "index": 7, "depth": 2, "title": "Integrations", "anchor": "integrations", "start_char": 7079, "end_char": 7708, "estimated_token_count": 189, "token_estimator": "heuristic-v1", "text": "## Integrations\n\nIntegrate your parachain with essential ecosystem tools and services.\n\n| Tutorial | Description |\n| :--------------------------------------------: | :----------------------------------------------------: |\n| [Wallets](/parachains/integrations/wallets/) | Integrate wallet support for user interactions |\n| [Indexers](/parachains/integrations/indexers/) | Set up indexing solutions for querying blockchain data |\n| [Oracles](/parachains/integrations/oracles/) | Connect your parachain to off-chain data sources |"} {"page_id": "parachains-get-started", "page_title": "Get Started with Parachain Development", "index": 8, "depth": 2, "title": "Additional Resources", "anchor": "additional-resources", "start_char": 7708, "end_char": 7941, "estimated_token_count": 60, "token_estimator": "heuristic-v1", "text": "## Additional Resources\n\n- [Polkadot SDK Documentation](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/polkadot_sdk/index.html)\n- [Polkadot Wiki - Parachains](https://wiki.polkadot.network/docs/learn-parachains/)"} -{"page_id": "parachains-install-polkadot-sdk", "page_title": "Install Polkadot SDK Dependencies", "index": 0, "depth": 2, "title": "macOS", "anchor": "macos", "start_char": 324, "end_char": 463, "estimated_token_count": 25, "token_estimator": "heuristic-v1", "text": "## macOS\n\nYou can install Rust and set up a Substrate development environment on Apple macOS computers with Intel or Apple M1 processors."} -{"page_id": "parachains-install-polkadot-sdk", "page_title": "Install Polkadot SDK Dependencies", "index": 1, "depth": 3, "title": "Before You Begin", "anchor": "before-you-begin", "start_char": 463, "end_char": 1915, "estimated_token_count": 334, "token_estimator": "heuristic-v1", "text": "### Before You Begin\n\nBefore you install Rust and set up your development environment on macOS, verify that your computer meets the following basic requirements:\n\n- Operating system version is 10.7 Lion or later.\n- Processor speed of at least 2 GHz. Note that 3 GHz is recommended.\n- Memory of at least 8 GB RAM. Note that 16 GB is recommended.\n- Storage of at least 10 GB of available space.\n- Broadband Internet connection.\n\n#### Install Homebrew\n\nIn most cases, you should use Homebrew to install and manage packages on macOS computers. If you don't already have Homebrew installed on your local computer, you should download and install it before continuing.\n\nTo install Homebrew:\n\n1. Open the Terminal application.\n2. Download and install Homebrew by running the following command:\n\n ```bash\n /bin/bash -c \"$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)\"\n ```\n\n3. Verify Homebrew has been successfully installed by running the following command:\n\n ```bash\n brew --version\n ```\n\n The command displays output similar to the following:\n\n
\n brew --version\n Homebrew 4.3.15\n
\n\n#### Support for Apple Silicon\n\nProtobuf must be installed before the build process can begin. To install it, run the following command:\n\n```bash\nbrew install protobuf\n```"} -{"page_id": "parachains-install-polkadot-sdk", "page_title": "Install Polkadot SDK Dependencies", "index": 2, "depth": 3, "title": "Install Required Packages and Rust", "anchor": "install-required-packages-and-rust", "start_char": 1915, "end_char": 3306, "estimated_token_count": 291, "token_estimator": "heuristic-v1", "text": "### Install Required Packages and Rust\n\nBecause the blockchain requires standard cryptography to support the generation of public/private key pairs and the validation of transaction signatures, you must also have a package that provides cryptography, such as `openssl`.\n\nTo install `openssl` and the Rust toolchain on macOS:\n\n1. Open the Terminal application.\n2. Ensure you have an updated version of Homebrew by running the following command:\n\n ```bash\n brew update\n ```\n\n3. Install the `openssl` package by running the following command:\n\n ```bash\n brew install openssl\n ```\n\n4. Download the `rustup` installation program and use it to install Rust by running the following command:\n\n ```bash\n curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh\n ```\n\n5. Follow the prompts displayed to proceed with a default installation.\n6. Update your current shell to include Cargo by running the following command:\n\n ```bash\n source ~/.cargo/env\n ```\n\n7. Configure the Rust toolchain to default to the latest stable version by running the following commands:\n\n ```bash\n rustup default stable\n rustup update\n rustup target add wasm32-unknown-unknown\n rustup component add rust-src\n ```\n\n8. [Verify your installation](#verifying-installation).\n9. Install `cmake` using the following command:\n\n ```bash\n brew install cmake\n ```"} -{"page_id": "parachains-install-polkadot-sdk", "page_title": "Install Polkadot SDK Dependencies", "index": 3, "depth": 2, "title": "Linux", "anchor": "linux", "start_char": 3306, "end_char": 3679, "estimated_token_count": 66, "token_estimator": "heuristic-v1", "text": "## Linux\n\nRust supports most Linux distributions. Depending on the specific distribution and version of the operating system you use, you might need to add some software dependencies to your environment. In general, your development environment should include a linker or C-compatible compiler, such as `clang` and an appropriate integrated development environment (IDE)."} -{"page_id": "parachains-install-polkadot-sdk", "page_title": "Install Polkadot SDK Dependencies", "index": 4, "depth": 3, "title": "Before You Begin {: #before-you-begin-linux }", "anchor": "before-you-begin-before-you-begin-linux", "start_char": 3679, "end_char": 4431, "estimated_token_count": 159, "token_estimator": "heuristic-v1", "text": "### Before You Begin {: #before-you-begin-linux }\n\nCheck the documentation for your operating system for information about the installed packages and how to download and install any additional packages you might need. For example, if you use Ubuntu, you can use the Ubuntu Advanced Packaging Tool (`apt`) to install the `build-essential` package:\n\n```bash\nsudo apt install build-essential\n```\n\nAt a minimum, you need the following packages before you install Rust:\n\n```text\nclang curl git make\n```\n\nBecause the blockchain requires standard cryptography to support the generation of public/private key pairs and the validation of transaction signatures, you must also have a package that provides cryptography, such as `libssl-dev` or `openssl-devel`."} -{"page_id": "parachains-install-polkadot-sdk", "page_title": "Install Polkadot SDK Dependencies", "index": 5, "depth": 3, "title": "Install Required Packages and Rust {: #install-required-packages-and-rust-linux }", "anchor": "install-required-packages-and-rust-install-required-packages-and-rust-linux", "start_char": 4431, "end_char": 6826, "estimated_token_count": 487, "token_estimator": "heuristic-v1", "text": "### Install Required Packages and Rust {: #install-required-packages-and-rust-linux }\n\nTo install the Rust toolchain on Linux:\n\n1. Open a terminal shell.\n2. Check the packages you have installed on the local computer by running an appropriate package management command for your Linux distribution.\n3. Add any package dependencies you are missing to your local development environment by running the appropriate package management command for your Linux distribution:\n\n === \"Ubuntu\"\n\n ```bash\n sudo apt install --assume-yes git clang curl libssl-dev protobuf-compiler\n ```\n\n === \"Debian\"\n\n ```sh\n sudo apt install --assume-yes git clang curl libssl-dev llvm libudev-dev make protobuf-compiler\n ```\n\n === \"Arch\"\n\n ```sh\n pacman -Syu --needed --noconfirm curl git clang make protobuf\n ```\n\n === \"Fedora\"\n\n ```sh\n sudo dnf update\n sudo dnf install clang curl git openssl-devel make protobuf-compiler\n ```\n\n === \"OpenSUSE\"\n\n ```sh\n sudo zypper install clang curl git openssl-devel llvm-devel libudev-devel make protobuf\n ```\n\n Remember that different distributions might use different package managers and bundle packages in different ways. For example, depending on your installation selections, Ubuntu Desktop and Ubuntu Server might have different packages and different requirements. However, the packages listed in the command-line examples are applicable for many common Linux distributions, including Debian, Linux Mint, MX Linux, and Elementary OS.\n\n4. Download the `rustup` installation program and use it to install Rust by running the following command:\n\n ```bash\n curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh\n ```\n\n5. Follow the prompts displayed to proceed with a default installation.\n6. Update your current shell to include Cargo by running the following command:\n\n ```bash\n source $HOME/.cargo/env\n ```\n\n7. Verify your installation by running the following command:\n\n ```bash\n rustc --version\n ```\n\n8. Configure the Rust toolchain to default to the latest stable version by running the following commands:\n\n ```bash\n rustup default stable\n rustup update\n rustup target add wasm32-unknown-unknown\n rustup component add rust-src\n ```\n\n9. [Verify your installation](#verifying-installation)."} -{"page_id": "parachains-install-polkadot-sdk", "page_title": "Install Polkadot SDK Dependencies", "index": 6, "depth": 2, "title": "Windows (WSL)", "anchor": "windows-wsl", "start_char": 6826, "end_char": 7397, "estimated_token_count": 103, "token_estimator": "heuristic-v1", "text": "## Windows (WSL)\n\nIn general, UNIX-based operating systems—like macOS or Linux—provide a better development environment for building Substrate-based blockchains.\n\nHowever, suppose your local computer uses Microsoft Windows instead of a UNIX-based operating system. In that case, you can configure it with additional software to make it a suitable development environment for building Substrate-based blockchains. To prepare a development environment on a Microsoft Windows computer, you can use Windows Subsystem for Linux (WSL) to emulate a UNIX operating environment."} -{"page_id": "parachains-install-polkadot-sdk", "page_title": "Install Polkadot SDK Dependencies", "index": 7, "depth": 3, "title": "Before You Begin {: #before-you-begin-windows }", "anchor": "before-you-begin-before-you-begin-windows", "start_char": 7397, "end_char": 7974, "estimated_token_count": 119, "token_estimator": "heuristic-v1", "text": "### Before You Begin {: #before-you-begin-windows }\n\nBefore installing on Microsoft Windows, verify the following basic requirements:\n\n- You have a computer running a supported Microsoft Windows operating system:\n - **For Windows desktop**: You must be running Microsoft Windows 10, version 2004 or later, or Microsoft Windows 11 to install WSL.\n - **For Windows server**: You must be running Microsoft Windows Server 2019, or later, to install WSL on a server operating system.\n- You have good internet connection and access to a shell terminal on your local computer."} -{"page_id": "parachains-install-polkadot-sdk", "page_title": "Install Polkadot SDK Dependencies", "index": 8, "depth": 3, "title": "Set Up Windows Subsystem for Linux", "anchor": "set-up-windows-subsystem-for-linux", "start_char": 7974, "end_char": 10255, "estimated_token_count": 496, "token_estimator": "heuristic-v1", "text": "### Set Up Windows Subsystem for Linux\n\nWSL enables you to emulate a Linux environment on a computer that uses the Windows operating system. The primary advantage of this approach for Substrate development is that you can use all of the code and command-line examples as described in the Substrate documentation. For example, you can run common commands—such as `ls` and `ps`—unmodified. By using WSL, you can avoid configuring a virtual machine image or a dual-boot operating system.\n\nTo prepare a development environment using WSL:\n\n1. Check your Windows version and build number to see if WSL is enabled by default.\n\n If you have Microsoft Windows 10, version 2004 (Build 19041 and higher), or Microsoft Windows 11, WSL is available by default and you can continue to the next step.\n\n If you have an older version of Microsoft Windows installed, see the [WSL manual installation steps for older versions](https://learn.microsoft.com/en-us/windows/wsl/install-manual){target=\\_blank}. If you are installing on an older version of Microsoft Windows, you can download and install WLS 2 if your computer has Windows 10, version 1903 or higher.\n\n2. Select **Windows PowerShell** or **Command Prompt** from the **Start** menu, right-click, then **Run as administrator**.\n\n3. In the PowerShell or Command Prompt terminal, run the following command:\n\n ```bash\n wsl --install\n ```\n\n This command enables the required WSL 2 components that are part of the Windows operating system, downloads the latest Linux kernel, and installs the Ubuntu Linux distribution by default.\n\n If you want to review the other Linux distributions available, run the following command:\n\n ```bash\n wsl --list --online\n ```\n\n4. After the distribution is downloaded, close the terminal.\n\n5. Click the **Start** menu, select **Shut down or sign out**, then click **Restart** to restart the computer.\n\n Restarting the computer is required to start the installation of the Linux distribution. It can take a few minutes for the installation to complete after you restart.\n\n For more information about setting up WSL as a development environment, see the [Set up a WSL development environment](https://learn.microsoft.com/en-us/windows/wsl/setup/environment){target=\\_blank} docs."} -{"page_id": "parachains-install-polkadot-sdk", "page_title": "Install Polkadot SDK Dependencies", "index": 9, "depth": 3, "title": "Install Required Packages and Rust {: #install-required-packages-and-rust-windows }", "anchor": "install-required-packages-and-rust-install-required-packages-and-rust-windows", "start_char": 10255, "end_char": 11817, "estimated_token_count": 346, "token_estimator": "heuristic-v1", "text": "### Install Required Packages and Rust {: #install-required-packages-and-rust-windows }\n\nTo install the Rust toolchain on WSL:\n\n1. Click the **Start** menu, then select **Ubuntu**.\n2. Type a UNIX user name to create user account.\n3. Type a password for your UNIX user, then retype the password to confirm it.\n4. Download the latest updates for the Ubuntu distribution using the Ubuntu Advanced Packaging Tool (`apt`) by running the following command:\n\n ```bash\n sudo apt update\n ```\n\n5. Add the required packages for the Ubuntu distribution by running the following command:\n\n ```bash\n sudo apt install --assume-yes git clang curl libssl-dev llvm libudev-dev make protobuf-compiler\n ```\n\n6. Download the `rustup` installation program and use it to install Rust for the Ubuntu distribution by running the following command:\n\n ```bash\n curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh\n ```\n\n7. Follow the prompts displayed to proceed with a default installation.\n\n8. Update your current shell to include Cargo by running the following command:\n\n ```bash\n source ~/.cargo/env\n ```\n\n9. Verify your installation by running the following command:\n\n ```bash\n rustc --version\n ```\n\n10. Configure the Rust toolchain to use the latest stable version as the default toolchain by running the following commands:\n\n ```bash\n rustup default stable\n rustup update\n rustup target add wasm32-unknown-unknown\n rustup component add rust-src\n ```\n\n11. [Verify your installation](#verifying-installation)."} -{"page_id": "parachains-install-polkadot-sdk", "page_title": "Install Polkadot SDK Dependencies", "index": 10, "depth": 2, "title": "Verifying Installation", "anchor": "verifying-installation", "start_char": 11817, "end_char": 12507, "estimated_token_count": 216, "token_estimator": "heuristic-v1", "text": "## Verifying Installation\n\nVerify the configuration of your development environment by running the following command:\n\n```bash\nrustup show\n```\n\nThe command displays output similar to the following:\n\n
\n rustup show\n ...\n
\n active toolchain\n ----------------\n name: stable-aarch64-apple-darwin\n active because: it's the default toolchain\n installed targets:\n aarch64-apple-darwin\n wasm32-unknown-unknown\n
"} -{"page_id": "parachains-install-polkadot-sdk", "page_title": "Install Polkadot SDK Dependencies", "index": 11, "depth": 2, "title": "Where to Go Next", "anchor": "where-to-go-next", "start_char": 12507, "end_char": 12756, "estimated_token_count": 67, "token_estimator": "heuristic-v1", "text": "## Where to Go Next\n\n- **[Parachain Zero to Hero Tutorials](/tutorials/polkadot-sdk/parachains/zero-to-hero/){target=\\_blank}**: A series of step-by-step guides to building, testing, and deploying custom pallets and runtimes using the Polkadot SDK."} +{"page_id": "parachains-install-polkadot-sdk", "page_title": "Install Polkadot SDK", "index": 0, "depth": 2, "title": "Part 1: Install Dependencies", "anchor": "part-1-install-dependencies", "start_char": 497, "end_char": 530, "estimated_token_count": 7, "token_estimator": "heuristic-v1", "text": "## Part 1: Install Dependencies"} +{"page_id": "parachains-install-polkadot-sdk", "page_title": "Install Polkadot SDK", "index": 1, "depth": 3, "title": "macOS", "anchor": "macos", "start_char": 530, "end_char": 3540, "estimated_token_count": 667, "token_estimator": "heuristic-v1", "text": "### macOS\n\nYou can install Rust and set up a Substrate development environment on Apple macOS computers with Intel or Apple M1 processors.\n\n#### Before You Begin\n\nBefore you install Rust and set up your development environment on macOS, verify that your computer meets the following basic requirements:\n\n- Operating system version is 10.7 Lion or later.\n- Processor speed of at least 2 GHz. Note that 3 GHz is recommended.\n- Memory of at least 8 GB RAM. Note that 16 GB is recommended.\n- Storage of at least 10 GB of available space.\n- Broadband Internet connection.\n\n#### Install Homebrew\n\nIn most cases, you should use Homebrew to install and manage packages on macOS computers. If you don't already have Homebrew installed on your local computer, you should download and install it before continuing.\n\nTo install Homebrew:\n\n1. Open the Terminal application.\n2. Download and install Homebrew by running the following command:\n\n ```bash\n /bin/bash -c \"$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)\"\n ```\n\n3. Verify Homebrew has been successfully installed by running the following command:\n\n ```bash\n brew --version\n ```\n\n The command displays output similar to the following:\n\n
\n brew --version\n Homebrew 4.3.15\n
\n\n#### Support for Apple Silicon\n\nProtobuf must be installed before the build process can begin. To install it, run the following command:\n\n```bash\nbrew install protobuf\n```\n\n#### Install Required Packages and Rust\n\nBecause the blockchain requires standard cryptography to support the generation of public/private key pairs and the validation of transaction signatures, you must also have a package that provides cryptography, such as `openssl`.\n\nTo install `openssl` and the Rust toolchain on macOS:\n\n1. Open the Terminal application.\n2. Ensure you have an updated version of Homebrew by running the following command:\n\n ```bash\n brew update\n ```\n\n3. Install the `openssl` package by running the following command:\n\n ```bash\n brew install openssl\n ```\n\n4. Download the `rustup` installation program and use it to install Rust by running the following command:\n\n ```bash\n curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh\n ```\n\n5. Follow the prompts displayed to proceed with a default installation.\n6. Update your current shell to include Cargo by running the following command:\n\n ```bash\n source ~/.cargo/env\n ```\n\n7. Configure the Rust toolchain to default to the latest stable version by running the following commands:\n\n ```bash\n rustup default stable\n rustup update\n rustup target add wasm32-unknown-unknown\n rustup component add rust-src\n ```\n\n8. Install `cmake` using the following command:\n\n ```bash\n brew install cmake\n ```\n\n9. Proceed to [Part 2: Build the Polkadot SDK](#part-2-build-the-polkadot-sdk)."} +{"page_id": "parachains-install-polkadot-sdk", "page_title": "Install Polkadot SDK", "index": 2, "depth": 3, "title": "Linux", "anchor": "linux", "start_char": 3540, "end_char": 7011, "estimated_token_count": 703, "token_estimator": "heuristic-v1", "text": "### Linux\n\nRust supports most Linux distributions. Depending on the specific distribution and version of the operating system you use, you might need to add some software dependencies to your environment. In general, your development environment should include a linker or C-compatible compiler, such as `clang` and an appropriate integrated development environment (IDE).\n\n#### Before You Begin\n\nCheck the documentation for your operating system for information about the installed packages and how to download and install any additional packages you might need. For example, if you use Ubuntu, you can use the Ubuntu Advanced Packaging Tool (`apt`) to install the `build-essential` package:\n\n```bash\nsudo apt install build-essential\n```\n\nAt a minimum, you need the following packages before you install Rust:\n\n```text\nclang curl git make\n```\n\nBecause the blockchain requires standard cryptography to support the generation of public/private key pairs and the validation of transaction signatures, you must also have a package that provides cryptography, such as `libssl-dev` or `openssl-devel`.\n\n#### Install Required Packages and Rust\n\nTo install the Rust toolchain on Linux:\n\n1. Open a terminal shell.\n2. Check the packages you have installed on the local computer by running an appropriate package management command for your Linux distribution.\n3. Add any package dependencies you are missing to your local development environment by running the appropriate package management command for your Linux distribution:\n\n === \"Ubuntu\"\n\n ```bash\n sudo apt install --assume-yes git clang curl libssl-dev protobuf-compiler\n ```\n\n === \"Debian\"\n\n ```sh\n sudo apt install --assume-yes git clang curl libssl-dev llvm libudev-dev make protobuf-compiler\n ```\n\n === \"Arch\"\n\n ```sh\n pacman -Syu --needed --noconfirm curl git clang make protobuf\n ```\n\n === \"Fedora\"\n\n ```sh\n sudo dnf update\n sudo dnf install clang curl git openssl-devel make protobuf-compiler\n ```\n\n === \"OpenSUSE\"\n\n ```sh\n sudo zypper install clang curl git openssl-devel llvm-devel libudev-devel make protobuf\n ```\n\n Remember that different distributions might use different package managers and bundle packages in different ways. For example, depending on your installation selections, Ubuntu Desktop and Ubuntu Server might have different packages and different requirements. However, the packages listed in the command-line examples are applicable for many common Linux distributions, including Debian, Linux Mint, MX Linux, and Elementary OS.\n\n4. Download the `rustup` installation program and use it to install Rust by running the following command:\n\n ```bash\n curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh\n ```\n\n5. Follow the prompts displayed to proceed with a default installation.\n6. Update your current shell to include Cargo by running the following command:\n\n ```bash\n source $HOME/.cargo/env\n ```\n\n7. Verify your installation by running the following command:\n\n ```bash\n rustc --version\n ```\n\n8. Configure the Rust toolchain to default to the latest stable version by running the following commands:\n\n ```bash\n rustup default stable\n rustup update\n rustup target add wasm32-unknown-unknown\n rustup component add rust-src\n ```\n\n9. Proceed to [Part 2: Build the Polkadot SDK](#part-2-build-the-polkadot-sdk)."} +{"page_id": "parachains-install-polkadot-sdk", "page_title": "Install Polkadot SDK", "index": 3, "depth": 3, "title": "Windows (WSL)", "anchor": "windows-wsl", "start_char": 7011, "end_char": 11950, "estimated_token_count": 1056, "token_estimator": "heuristic-v1", "text": "### Windows (WSL)\n\nIn general, UNIX-based operating systems—like macOS or Linux—provide a better development environment for building Substrate-based blockchains.\n\nHowever, suppose your local computer uses Microsoft Windows instead of a UNIX-based operating system. In that case, you can configure it with additional software to make it a suitable development environment for building Substrate-based blockchains. To prepare a development environment on a Microsoft Windows computer, you can use Windows Subsystem for Linux (WSL) to emulate a UNIX operating environment.\n\n#### Before You Begin\n\nBefore installing on Microsoft Windows, verify the following basic requirements:\n\n- You have a computer running a supported Microsoft Windows operating system:\n - **For Windows desktop**: You must be running Microsoft Windows 10, version 2004 or later, or Microsoft Windows 11 to install WSL.\n - **For Windows server**: You must be running Microsoft Windows Server 2019, or later, to install WSL on a server operating system.\n- You have good internet connection and access to a shell terminal on your local computer.\n\n#### Set Up Windows Subsystem for Linux\n\nWSL enables you to emulate a Linux environment on a computer that uses the Windows operating system. The primary advantage of this approach for Substrate development is that you can use all of the code and command-line examples as described in the Substrate documentation. For example, you can run common commands—such as `ls` and `ps`—unmodified. By using WSL, you can avoid configuring a virtual machine image or a dual-boot operating system.\n\nTo prepare a development environment using WSL:\n\n1. Check your Windows version and build number to see if WSL is enabled by default.\n\n If you have Microsoft Windows 10, version 2004 (Build 19041 and higher), or Microsoft Windows 11, WSL is available by default and you can continue to the next step.\n\n If you have an older version of Microsoft Windows installed, see the [WSL manual installation steps for older versions](https://learn.microsoft.com/en-us/windows/wsl/install-manual){target=\\_blank}. If you are installing on an older version of Microsoft Windows, you can download and install WLS 2 if your computer has Windows 10, version 1903 or higher.\n\n2. Select **Windows PowerShell** or **Command Prompt** from the **Start** menu, right-click, then **Run as administrator**.\n\n3. In the PowerShell or Command Prompt terminal, run the following command:\n\n ```bash\n wsl --install\n ```\n\n This command enables the required WSL 2 components that are part of the Windows operating system, downloads the latest Linux kernel, and installs the Ubuntu Linux distribution by default.\n\n If you want to review the other Linux distributions available, run the following command:\n\n ```bash\n wsl --list --online\n ```\n\n4. After the distribution is downloaded, close the terminal.\n\n5. Click the **Start** menu, select **Shut down or sign out**, then click **Restart** to restart the computer.\n\n Restarting the computer is required to start the installation of the Linux distribution. It can take a few minutes for the installation to complete after you restart.\n\n For more information about setting up WSL as a development environment, see the [Set up a WSL development environment](https://learn.microsoft.com/en-us/windows/wsl/setup/environment){target=\\_blank} docs.\n\n#### Install Required Packages and Rust\n\nTo install the Rust toolchain on WSL:\n\n1. Click the **Start** menu, then select **Ubuntu**.\n2. Type a UNIX user name to create user account.\n3. Type a password for your UNIX user, then retype the password to confirm it.\n4. Download the latest updates for the Ubuntu distribution using the Ubuntu Advanced Packaging Tool (`apt`) by running the following command:\n\n ```bash\n sudo apt update\n ```\n\n5. Add the required packages for the Ubuntu distribution by running the following command:\n\n ```bash\n sudo apt install --assume-yes git clang curl libssl-dev llvm libudev-dev make protobuf-compiler\n ```\n\n6. Download the `rustup` installation program and use it to install Rust for the Ubuntu distribution by running the following command:\n\n ```bash\n curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh\n ```\n\n7. Follow the prompts displayed to proceed with a default installation.\n\n8. Update your current shell to include Cargo by running the following command:\n\n ```bash\n source ~/.cargo/env\n ```\n\n9. Verify your installation by running the following command:\n\n ```bash\n rustc --version\n ```\n\n10. Configure the Rust toolchain to use the latest stable version as the default toolchain by running the following commands:\n\n ```bash\n rustup default stable\n rustup update\n rustup target add wasm32-unknown-unknown\n rustup component add rust-src\n ```\n\n11. Proceed to [Part 2: Build the Polkadot SDK](#part-2-build-the-polkadot-sdk)."} +{"page_id": "parachains-install-polkadot-sdk", "page_title": "Install Polkadot SDK", "index": 4, "depth": 2, "title": "Part 2: Build the Polkadot SDK", "anchor": "part-2-build-the-polkadot-sdk", "start_char": 11950, "end_char": 12101, "estimated_token_count": 29, "token_estimator": "heuristic-v1", "text": "## Part 2: Build the Polkadot SDK\n\nAfter installing all dependencies, you can now clone and compile the Polkadot SDK repository to verify your setup."} +{"page_id": "parachains-install-polkadot-sdk", "page_title": "Install Polkadot SDK", "index": 5, "depth": 3, "title": "Clone the Polkadot SDK", "anchor": "clone-the-polkadot-sdk", "start_char": 12101, "end_char": 12332, "estimated_token_count": 58, "token_estimator": "heuristic-v1", "text": "### Clone the Polkadot SDK\n\n1. Clone the Polkadot SDK repository:\n\n ```bash\n git clone https://github.com/paritytech/polkadot-sdk.git\n ```\n\n2. Navigate into the project directory:\n\n ```bash\n cd polkadot-sdk\n ```"} +{"page_id": "parachains-install-polkadot-sdk", "page_title": "Install Polkadot SDK", "index": 6, "depth": 3, "title": "Compile the Polkadot SDK", "anchor": "compile-the-polkadot-sdk", "start_char": 12332, "end_char": 12787, "estimated_token_count": 89, "token_estimator": "heuristic-v1", "text": "### Compile the Polkadot SDK\n\nCompile the entire Polkadot SDK repository to ensure your environment is properly configured:\n\n```bash\ncargo build --release --locked\n```\n\n!!!warning\n This initial compilation will take significant time (30-60 minutes or more) depending on your machine specifications. The `--release` flag optimizes for performance. This step compiles all components of the Polkadot SDK to verify your toolchain is correctly configured."} +{"page_id": "parachains-install-polkadot-sdk", "page_title": "Install Polkadot SDK", "index": 7, "depth": 3, "title": "Verify the Build", "anchor": "verify-the-build", "start_char": 12787, "end_char": 13561, "estimated_token_count": 163, "token_estimator": "heuristic-v1", "text": "### Verify the Build\n\nOnce the build completes successfully, verify the installation by checking the compiled binaries:\n\n```bash\nls target/release\n```\n\nYou should see several binaries including:\n\n- `polkadot` - The Polkadot relay chain node\n- `polkadot-parachain` - The parachain collator node\n- `polkadot-omni-node` - The omni node for running parachains\n- `substrate-node` - The kitchensink node with many pre-configured pallets\n\nVerify the Polkadot binary works by checking its version:\n\n```bash\n./target/release/polkadot --version\n```\n\nThis should display version information similar to:\n\n```bash\npolkadot 1.16.0-1234abcd567\n```\n\nIf you see the version output without errors, your development environment is correctly configured and ready for Polkadot SDK development!"} +{"page_id": "parachains-install-polkadot-sdk", "page_title": "Install Polkadot SDK", "index": 8, "depth": 2, "title": "Optional: Run the Kitchensink Node", "anchor": "optional-run-the-kitchensink-node", "start_char": 13561, "end_char": 14089, "estimated_token_count": 105, "token_estimator": "heuristic-v1", "text": "## Optional: Run the Kitchensink Node\n\nThe Polkadot SDK includes a feature-rich node called \"kitchensink\" located at `substrate/bin/node`. This node comes pre-configured with many pallets and features from the Polkadot SDK, making it an excellent reference for exploring capabilities and understanding how different components work together.\n\n!!!note\n If you've already compiled the Polkadot SDK in the previous step, the `substrate-node` binary is already built and ready to use. You can skip directly to running the node."} +{"page_id": "parachains-install-polkadot-sdk", "page_title": "Install Polkadot SDK", "index": 9, "depth": 3, "title": "Run the Kitchensink Node in Development Mode", "anchor": "run-the-kitchensink-node-in-development-mode", "start_char": 14089, "end_char": 14674, "estimated_token_count": 125, "token_estimator": "heuristic-v1", "text": "### Run the Kitchensink Node in Development Mode\n\nFrom the `polkadot-sdk` root directory, start the kitchensink node in development mode:\n\n```bash\n./target/release/substrate-node --dev\n```\n\nThe `--dev` flag enables development mode, which:\n\n- Runs a single-node development chain\n- Produces and finalizes blocks automatically\n- Uses pre-configured development accounts (Alice, Bob, etc.)\n- Deletes all data when stopped, ensuring a clean state on restart\n\nYou should see log output indicating the node is running and producing blocks, with increasing block numbers after `finalized`."} +{"page_id": "parachains-install-polkadot-sdk", "page_title": "Install Polkadot SDK", "index": 10, "depth": 3, "title": "Interact with the Kitchensink Node", "anchor": "interact-with-the-kitchensink-node", "start_char": 14674, "end_char": 15319, "estimated_token_count": 157, "token_estimator": "heuristic-v1", "text": "### Interact with the Kitchensink Node\n\nThe kitchensink node is accessible at `ws://localhost:9944`. To explore its features using the Polkadot.js Apps interface:\n\n1. Open [Polkadot.js Apps](https://polkadot.js.org/apps/#/explorer){target=\\_blank} in your web browser\n2. Click the network icon in the top left corner\n3. Scroll to **Development** and select **Local Node**\n4. Click **Switch** to connect to your local node\n\nYou can now explore the various pallets and features included in the kitchensink node, making it a valuable reference as you develop your own blockchain applications.\n\nTo stop the node, press `Control-C` in the terminal."} +{"page_id": "parachains-install-polkadot-sdk", "page_title": "Install Polkadot SDK", "index": 11, "depth": 2, "title": "Where to Go Next", "anchor": "where-to-go-next", "start_char": 15319, "end_char": 15587, "estimated_token_count": 57, "token_estimator": "heuristic-v1", "text": "## Where to Go Next\n\n- **[Get Started with Parachain Development](/parachains/get-started/){target=\\_blank}**: Practical examples and tutorials for building and deploying Polkadot parachains, covering everything from launch to customization and cross-chain messaging."} {"page_id": "parachains-integrations-indexers", "page_title": "Indexers", "index": 0, "depth": 2, "title": "The Challenge of Blockchain Data Access", "anchor": "the-challenge-of-blockchain-data-access", "start_char": 12, "end_char": 649, "estimated_token_count": 103, "token_estimator": "heuristic-v1", "text": "## The Challenge of Blockchain Data Access\n\nBlockchain data is inherently sequential and distributed, with information stored chronologically across numerous blocks. While retrieving data from a single block through JSON-RPC API calls is straightforward, more complex queries that span multiple blocks present significant challenges:\n\n- Data is scattered and unorganized across the blockchain.\n- Retrieving large datasets can take days or weeks to sync.\n- Complex operations (like aggregations, averages, or cross-chain queries) require additional processing.\n- Direct blockchain queries can impact dApp performance and responsiveness."} {"page_id": "parachains-integrations-indexers", "page_title": "Indexers", "index": 1, "depth": 2, "title": "What is a Blockchain Indexer?", "anchor": "what-is-a-blockchain-indexer", "start_char": 649, "end_char": 1211, "estimated_token_count": 108, "token_estimator": "heuristic-v1", "text": "## What is a Blockchain Indexer?\n\nA blockchain indexer is a specialized infrastructure tool that processes, organizes, and stores blockchain data in an optimized format for efficient querying. Think of it as a search engine for blockchain data that:\n\n- Continuously monitors the blockchain for new blocks and transactions.\n- Processes and categorizes this data according to predefined schemas.\n- Stores the processed data in an easily queryable database.\n- Provides efficient APIs (typically [GraphQL](https://graphql.org/){target=\\_blank}) for data retrieval."} {"page_id": "parachains-integrations-indexers", "page_title": "Indexers", "index": 2, "depth": 2, "title": "Indexer Implementations", "anchor": "indexer-implementations", "start_char": 1211, "end_char": 2230, "estimated_token_count": 217, "token_estimator": "heuristic-v1", "text": "## Indexer Implementations\n\n
\n\n- __Subsquid__\n\n ---\n\n Subsquid is a data network that allows rapid and cost-efficient retrieval of blockchain data from 100+ chains using Subsquid's decentralized data lake and open-source SDK. In simple terms, Subsquid can be considered an ETL (extract, transform, and load) tool with a GraphQL server included. It enables comprehensive filtering, pagination, and even full-text search capabilities. Subsquid has native and full support for EVM and Substrate data, even within the same project.\n\n [:octicons-arrow-right-24: Reference](https://www.sqd.ai/){target=\\_blank}\n\n- __Subquery__\n\n ---\n\n SubQuery is a fast, flexible, and reliable open-source data decentralised infrastructure network that provides both RPC and indexed data to consumers worldwide.\n It provides custom APIs for your web3 project across multiple supported chains.\n\n [:octicons-arrow-right-24: Reference](https://subquery.network/){target=\\_blank}\n\n
"} diff --git a/llms.txt b/llms.txt index 3ba08e18f..afaa1986b 100644 --- a/llms.txt +++ b/llms.txt @@ -21,7 +21,7 @@ Docs: Basics - [Add Pallets to the Runtime](https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/master/.ai/pages/parachains-customize-runtime-pallet-development-add-pallet-to-runtime.md): Add pallets to your runtime for custom functionality. Learn to configure and integrate pallets in Polkadot SDK-based blockchains. - [Overview of FRAME](https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/master/.ai/pages/parachains-customize-runtime.md): Learn how Polkadot SDK’s FRAME framework simplifies blockchain development with modular pallets and support libraries for efficient runtime design. - [Get Started with Parachain Development](https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/master/.ai/pages/parachains-get-started.md): Practical examples and tutorials for building and deploying Polkadot parachains, covering everything from launch to customization and cross-chain messaging. -- [Install Polkadot SDK Dependencies](https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/master/.ai/pages/parachains-install-polkadot-sdk.md): Install everything you need to begin working with Substrated-based blockchains and the Polkadot SDK, the framework for building blockchains. +- [Install Polkadot SDK](https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/master/.ai/pages/parachains-install-polkadot-sdk.md): Install everything you need to begin working with the Polkadot SDK, the framework for building blockchains. - [Introduction to XCM](https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/master/.ai/pages/parachains-interoperability-get-started.md): Unlock blockchain interoperability with XCM — Polkadot's Cross-Consensus Messaging format for cross-chain interactions. - [Set Up the Polkadot SDK Parachain Template](https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/master/.ai/pages/parachains-launch-a-parachain-set-up-the-parachain-template.md): Learn how to set up and run the Polkadot SDK Parachain Template locally, creating a ready-to-customize foundation for your parachain. - [Overview](https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/master/.ai/pages/polkadot-protocol-architecture-parachains-overview.md): Learn about the role, functionality, and implementation of parachains as a developer in the wider Polkadot architecture. @@ -222,7 +222,7 @@ Docs: Infrastructure Docs: Tooling - [Quickstart Parachain Development with Pop CLI](https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/master/.ai/pages/develop-toolkit-parachains-quickstart-pop-cli.md): Quickly bootstrap parachain projects, scaffold templates, deploy local networks, and streamline development workflows using Pop CLI. - [Write Tests](https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/master/.ai/pages/develop-toolkit-parachains-spawn-chains-zombienet-write-tests.md): Write and execute tests for blockchain networks with Zombienet's DSL. Learn to evaluate metrics, logs, events, and more for robust validation. -- [Install Polkadot SDK Dependencies](https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/master/.ai/pages/parachains-install-polkadot-sdk.md): Install everything you need to begin working with Substrated-based blockchains and the Polkadot SDK, the framework for building blockchains. +- [Install Polkadot SDK](https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/master/.ai/pages/parachains-install-polkadot-sdk.md): Install everything you need to begin working with the Polkadot SDK, the framework for building blockchains. - [Indexers](https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/master/.ai/pages/parachains-integrations-indexers.md): Discover blockchain indexers. Enhance data access, enable fast and complex queries, and optimize blockchain data for seamless app performance. - [Oracles](https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/master/.ai/pages/parachains-integrations-oracles.md): Learn about blockchain oracles, the essential bridges connecting blockchains with real-world data for decentralized applications in the Polkadot ecosystem. - [Wallets](https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/master/.ai/pages/parachains-integrations-wallets.md): Explore blockchain wallets. Securely manage digital assets with hot wallets for online access or cold wallets for offline, enhanced security. diff --git a/parachains/install-polkadot-sdk.md b/parachains/install-polkadot-sdk.md index b97c1d913..27a852c9e 100644 --- a/parachains/install-polkadot-sdk.md +++ b/parachains/install-polkadot-sdk.md @@ -1,18 +1,23 @@ --- -title: Install Polkadot SDK Dependencies -description: Install everything you need to begin working with Substrated-based blockchains and the Polkadot SDK, the framework for building blockchains. +title: Install Polkadot SDK +description: Install all required Polkadot SDK dependencies, set up the SDK itself, and verify that it runs correctly on your machine. categories: Basics, Tooling --- -# Install Polkadot SDK Dependencies +# Install Polkadot SDK -This guide provides step-by-step instructions for installing the dependencies you need to work with the Polkadot SDK-based chains on macOS, Linux, and Windows. Follow the appropriate section for your operating system to ensure all necessary tools are installed and configured properly. +This guide provides step-by-step instructions for installing the Polkadot SDK on macOS, Linux, and Windows. The installation process consists of two main parts: -## macOS +- **Installing dependencies**: Setting up Rust, required system packages, and development tools. +- **Building the Polkadot SDK**: Cloning and compiling the Polkadot SDK repository. + +Follow the appropriate section for your operating system to ensure all necessary tools are installed and configured properly. + +## Install Dependencies: macOS You can install Rust and set up a Substrate development environment on Apple macOS computers with Intel or Apple M1 processors. -### Before You Begin +### Before You Begin {: #before-you-begin-mac-os } Before you install Rust and set up your development environment on macOS, verify that your computer meets the following basic requirements: @@ -22,7 +27,7 @@ Before you install Rust and set up your development environment on macOS, verify - Storage of at least 10 GB of available space. - Broadband Internet connection. -#### Install Homebrew +### Install Homebrew In most cases, you should use Homebrew to install and manage packages on macOS computers. If you don't already have Homebrew installed on your local computer, you should download and install it before continuing. @@ -45,7 +50,7 @@ To install Homebrew: --8<-- 'code/parachains/install-polkadot-sdk/termynal-1.html' -#### Support for Apple Silicon +### Support for Apple Silicon Protobuf must be installed before the build process can begin. To install it, run the following command: @@ -53,7 +58,7 @@ Protobuf must be installed before the build process can begin. To install it, ru brew install protobuf ``` -### Install Required Packages and Rust +### Install Required Packages and Rust {: #install-required-packages-and-rust-mac-os } Because the blockchain requires standard cryptography to support the generation of public/private key pairs and the validation of transaction signatures, you must also have a package that provides cryptography, such as `openssl`. @@ -94,16 +99,17 @@ To install `openssl` and the Rust toolchain on macOS: rustup component add rust-src ``` -8. [Verify your installation](#verifying-installation). -9. Install `cmake` using the following command: +8. Install `cmake` using the following command: ```bash brew install cmake ``` -## Linux +9. Proceed to [Build the Polkadot SDK](#build-the-polkadot-sdk). -Rust supports most Linux distributions. Depending on the specific distribution and version of the operating system you use, you might need to add some software dependencies to your environment. In general, your development environment should include a linker or C-compatible compiler, such as `clang` and an appropriate integrated development environment (IDE). +## Install Dependencies: Linux + +Rust supports most Linux distributions. Depending on the specific distribution and version of the operating system you use, you might need to add some software dependencies to your environment. In general, your development environment should include a linker or a C-compatible compiler, such as `clang`, and an appropriate integrated development environment (IDE). ### Before You Begin {: #before-you-begin-linux } @@ -126,7 +132,7 @@ Because the blockchain requires standard cryptography to support the generation To install the Rust toolchain on Linux: 1. Open a terminal shell. -2. Check the packages you have installed on the local computer by running an appropriate package management command for your Linux distribution. +2. Check the packages installed on the local computer by running the appropriate package management command for your Linux distribution. 3. Add any package dependencies you are missing to your local development environment by running the appropriate package management command for your Linux distribution: === "Ubuntu" @@ -160,7 +166,7 @@ To install the Rust toolchain on Linux: sudo zypper install clang curl git openssl-devel llvm-devel libudev-devel make protobuf ``` - Remember that different distributions might use different package managers and bundle packages in different ways. For example, depending on your installation selections, Ubuntu Desktop and Ubuntu Server might have different packages and different requirements. However, the packages listed in the command-line examples are applicable for many common Linux distributions, including Debian, Linux Mint, MX Linux, and Elementary OS. + Remember that different distributions might use different package managers and bundle packages in different ways. For example, depending on your installation selections, Ubuntu Desktop and Ubuntu Server might have different packages and different requirements. However, the packages listed in the command-line examples are applicable to many common Linux distributions, including Debian, Linux Mint, MX Linux, and Elementary OS. 4. Download the `rustup` installation program and use it to install Rust by running the following command: @@ -190,22 +196,22 @@ To install the Rust toolchain on Linux: rustup component add rust-src ``` -9. [Verify your installation](#verifying-installation). +9. Proceed to [Build the Polkadot SDK](#build-the-polkadot-sdk). -## Windows (WSL) +## Install Dependencies: Windows (WSL) In general, UNIX-based operating systems—like macOS or Linux—provide a better development environment for building Substrate-based blockchains. However, suppose your local computer uses Microsoft Windows instead of a UNIX-based operating system. In that case, you can configure it with additional software to make it a suitable development environment for building Substrate-based blockchains. To prepare a development environment on a Microsoft Windows computer, you can use Windows Subsystem for Linux (WSL) to emulate a UNIX operating environment. -### Before You Begin {: #before-you-begin-windows } +### Before You Begin {: #before-you-begin-windows-wls } Before installing on Microsoft Windows, verify the following basic requirements: - You have a computer running a supported Microsoft Windows operating system: - **For Windows desktop**: You must be running Microsoft Windows 10, version 2004 or later, or Microsoft Windows 11 to install WSL. - **For Windows server**: You must be running Microsoft Windows Server 2019, or later, to install WSL on a server operating system. -- You have good internet connection and access to a shell terminal on your local computer. +- You have a good internet connection and access to a shell terminal on your local computer. ### Set Up Windows Subsystem for Linux @@ -243,12 +249,12 @@ To prepare a development environment using WSL: For more information about setting up WSL as a development environment, see the [Set up a WSL development environment](https://learn.microsoft.com/en-us/windows/wsl/setup/environment){target=\_blank} docs. -### Install Required Packages and Rust {: #install-required-packages-and-rust-windows } +### Install Required Packages and Rust {: #install-required-packages-and-rust-windows-wls } To install the Rust toolchain on WSL: 1. Click the **Start** menu, then select **Ubuntu**. -2. Type a UNIX user name to create user account. +2. Type a UNIX user name to create a user account. 3. Type a password for your UNIX user, then retype the password to confirm it. 4. Download the latest updates for the Ubuntu distribution using the Ubuntu Advanced Packaging Tool (`apt`) by running the following command: @@ -291,20 +297,120 @@ To install the Rust toolchain on WSL: rustup component add rust-src ``` -11. [Verify your installation](#verifying-installation). +11. Proceed to [Build the Polkadot SDK](#build-the-polkadot-sdk). + +## Build the Polkadot SDK + +After installing all dependencies, you can now clone and compile the Polkadot SDK repository to verify your setup. + +### Clone the Polkadot SDK + +1. Clone the Polkadot SDK repository: + + ```bash + git clone https://github.com/paritytech/polkadot-sdk.git + ``` + +2. Navigate into the project directory: + + ```bash + cd polkadot-sdk + ``` -## Verifying Installation +### Compile the Polkadot SDK -Verify the configuration of your development environment by running the following command: +Compile the entire Polkadot SDK repository to ensure your environment is properly configured: ```bash -rustup show +cargo build --release --locked ``` -The command displays output similar to the following: +!!!note + This initial compilation will take significant time, depending on your machine specifications. It compiles all components of the Polkadot SDK to verify your toolchain is correctly configured. + +### Verify the Build + +Once the build completes successfully, verify the installation by checking the compiled binaries: + +```bash +ls target/release +``` + +You should see several binaries, including: + +- `polkadot`: The Polkadot relay chain node. +- `polkadot-parachain`: The parachain collator node. +- `polkadot-omni-node`:The omni node for running parachains. +- `substrate-node`: The kitchensink node with many pre-configured pallets. + +Verify the Polkadot binary works by checking its version: + +```bash +./target/release/polkadot --version +``` + +This should display version information similar to: + +```bash +polkadot 1.16.0-1234abcd567 +``` + +If you see the version output without errors, your development environment is correctly configured and ready for Polkadot SDK development! + +## Optional: Run the Kitchensink Node + +The Polkadot SDK includes a feature-rich node called "kitchensink" located at `substrate/bin/node`. This node comes pre-configured with many pallets and features from the Polkadot SDK, making it an excellent reference for exploring capabilities and understanding how different components work together. + +!!!note + If you've already compiled the Polkadot SDK in the previous step, the `substrate-node` binary is already built and ready to use. You can skip directly to running the node. + +### Run the Kitchensink Node in Development Mode + +From the `polkadot-sdk` root directory, start the kitchensink node in development mode: + +```bash +./target/release/substrate-node --dev +``` + +The `--dev` flag enables development mode, which: + +- Runs a single-node development chain. +- Produces and finalizes blocks automatically. +- Uses pre-configured development accounts (Alice, Bob, etc.). +- Deletes all data when stopped, ensuring a clean state on restart. --8<-- 'code/parachains/install-polkadot-sdk/termynal-2.html' +You should see log output indicating the node is running and producing blocks, with increasing block numbers after `finalized`. + +### Interact with the Kitchensink Node + +The kitchensink node is accessible at `ws://localhost:9944`. Open [Polkadot.js Apps](https://polkadot.js.org/apps/#/explorer){target=\_blank} in your browser to explore its features and connect to the local node. + +1. Click the network icon in the top left corner. +2. Scroll to **Development** and select **Local Node**. +3. Click **Switch** to connect to your local node. + +![](/images/parachains/install-polkadot-sdk/install-polkadot-sdk-1.webp) + +Once connected, the interface updates its color scheme to indicate a successful connection to the local node. + +![](/images/parachains/install-polkadot-sdk/install-polkadot-sdk-2.webp) + +You can now explore the various pallets and features included in the kitchensink node, making it a valuable reference as you develop your own blockchain applications. + +To stop the node, press `Control-C` in the terminal. + ## Where to Go Next -- **[Parachain Zero to Hero Tutorials](/tutorials/polkadot-sdk/parachains/zero-to-hero/){target=\_blank}**: A series of step-by-step guides to building, testing, and deploying custom pallets and runtimes using the Polkadot SDK. +
+ +- __Get Started with Parachain Development__ + + --- + + Practical examples and tutorials for building and deploying Polkadot parachains, covering everything from launch to customization and cross-chain messaging. + + [:octicons-arrow-right-24: Get Started](/parachains/get-started/) + +
\ No newline at end of file diff --git a/parachains/launch-a-parachain/set-up-the-parachain-template.md b/parachains/launch-a-parachain/set-up-the-parachain-template.md index b14c3e953..33acf860f 100644 --- a/parachains/launch-a-parachain/set-up-the-parachain-template.md +++ b/parachains/launch-a-parachain/set-up-the-parachain-template.md @@ -26,7 +26,7 @@ By the end of this guide, you'll have a working template ready to customize and Before getting started, ensure you have done the following: -- Completed the [Install Polkadot SDK Dependencies](/reference/tools/polkadot-sdk/install/){target=\_blank} guide and successfully installed [Rust](https://www.rust-lang.org/){target=\_blank} and the required packages to set up your development environment +- Completed the [Install Polkadot SDK](/parachains/install-polkadot-sdk/){target=\_blank} guide and successfully installed [Rust](https://www.rust-lang.org/){target=\_blank} and the required packages to set up your development environment. For this tutorial series, you need to use Rust `1.86`. Newer versions of the compiler may not work with this parachain template version.