From 12156da29cadc16ef58b0baa1972a79af1a13e18 Mon Sep 17 00:00:00 2001 From: Erin Shaben Date: Mon, 25 May 2026 16:54:20 -0400 Subject: [PATCH 1/3] make updates to frontmatter and indexes to support index tables --- chain-interactions/accounts/create-account.md | 1 + chain-interactions/accounts/query-accounts.md | 1 + chain-interactions/index.md | 77 +++++++++--------- chain-interactions/query-data/query-rest.md | 1 + chain-interactions/query-data/query-sdks.md | 1 + .../query-data/runtime-api-calls.md | 1 + .../calculate-transaction-fees.md | 1 + .../debug-and-preview-xcms.md | 1 + .../interoperability/estimate-xcm-fees.md | 1 + .../transfer-assets-into-polkadot.md | 1 + .../transfer-assets-parachains.md | 1 + .../pay-fees-with-different-tokens.md | 1 + .../send-transactions/with-sdks.md | 1 + .../token-operations/convert-assets.md | 1 + .../register-foreign-asset.md | 1 + .../token-operations/register-local-asset.md | 1 + .../customize-runtime/add-existing-pallets.md | 1 + .../customize-runtime/add-pallet-instances.md | 1 + .../add-smart-contract-functionality.md | 1 + .../pallet-development/benchmark-pallet.md | 1 + .../pallet-development/create-a-pallet.md | 1 + .../pallet-development/mock-runtime.md | 1 + .../pallet-development/pallet-testing.md | 1 + parachains/get-started.md | 76 ++++++++++-------- parachains/integrations/indexers.md | 1 + parachains/integrations/oracles.md | 1 + parachains/integrations/wallets.md | 1 + .../channels-between-parachains.md | 1 + .../channels-with-system-parachains.md | 1 + .../launch-a-parachain/deploy-to-polkadot.md | 1 + .../launch-a-parachain/obtain-coretime.md | 1 + .../set-up-the-parachain-template.md | 1 + .../runtime-maintenance/coretime-renewal.md | 1 + .../runtime-maintenance/runtime-upgrades.md | 1 + .../runtime-maintenance/storage-migrations.md | 1 + .../runtime-maintenance/unlock-parachains.md | 1 + parachains/testing/fork-a-parachain.md | 1 + parachains/testing/run-a-parachain-network.md | 1 + .../cookbook/dapps/zero-to-hero.md | 5 +- .../eth-dapps/uniswap-v2/core-v2-pvm.md | 1 + .../cookbook/eth-dapps/uniswap-v2/core-v2.md | 1 + .../eth-dapps/uniswap-v2/periphery-v2.md | 1 + smart-contracts/cookbook/index.md | 46 +++++------ .../deploy-basic/basic-hardhat.md | 1 + .../deploy-basic/basic-remix.md | 1 + .../deploy-erc20/erc20-hardhat.md | 1 + .../deploy-erc20/erc20-remix.md | 1 + .../smart-contracts/deploy-nft/nft-hardhat.md | 1 + .../smart-contracts/deploy-nft/nft-remix.md | 1 + smart-contracts/dev-environments/foundry.md | 2 + .../dev-environments/hardhat-polkadot.md | 3 +- smart-contracts/dev-environments/hardhat.md | 4 +- .../dev-environments/local-dev-node.md | 2 + smart-contracts/dev-environments/remix.md | 2 + smart-contracts/for-eth-devs/accounts.md | 1 + .../for-eth-devs/blocks-transactions-fees.md | 1 + .../for-eth-devs/contract-deployment.md | 1 + smart-contracts/for-eth-devs/dual-vm-stack.md | 1 + smart-contracts/for-eth-devs/evm-vs-pvm.md | 1 + smart-contracts/for-eth-devs/gas-model.md | 1 + smart-contracts/for-eth-devs/json-rpc-apis.md | 1 + smart-contracts/get-started.md | 79 +++++++++++-------- smart-contracts/integrations/wallets.md | 1 + smart-contracts/libraries/ethers-js.md | 1 + smart-contracts/libraries/viem.md | 1 + smart-contracts/libraries/wagmi.md | 1 + smart-contracts/libraries/web3-js.md | 1 + smart-contracts/libraries/web3-py.md | 1 + smart-contracts/precompiles/erc20.md | 1 + smart-contracts/precompiles/eth-native.md | 1 + smart-contracts/precompiles/storage.md | 1 + smart-contracts/precompiles/system.md | 1 + smart-contracts/precompiles/xcm.md | 1 + 73 files changed, 226 insertions(+), 133 deletions(-) diff --git a/chain-interactions/accounts/create-account.md b/chain-interactions/accounts/create-account.md index bae3f742e..dc3d4d546 100644 --- a/chain-interactions/accounts/create-account.md +++ b/chain-interactions/accounts/create-account.md @@ -1,6 +1,7 @@ --- title: Create an Account description: Step-by-step guide to creating Polkadot accounts using different programming languages and libraries, including JavaScript, Python, and Rust examples. +short_description: Generate accounts using various SDKs in Rust, Python, and JavaScript. categories: Basics, Chain Interactions page_badges: test_workflow: polkadot-docs-create-account diff --git a/chain-interactions/accounts/query-accounts.md b/chain-interactions/accounts/query-accounts.md index e86427d87..e87a879b4 100644 --- a/chain-interactions/accounts/query-accounts.md +++ b/chain-interactions/accounts/query-accounts.md @@ -1,6 +1,7 @@ --- title: Query Account Information with SDKs description: Learn how to query account information using five popular SDKs—Polkadot API (PAPI), Polkadot.js API, Dedot, Python Substrate Interface, and Subxt. +short_description: Retrieve account information including balances, nonces, and metadata. categories: Chain Interactions, Tooling page_badges: test_workflow: polkadot-docs-query-accounts diff --git a/chain-interactions/index.md b/chain-interactions/index.md index daebf3181..3fa629350 100644 --- a/chain-interactions/index.md +++ b/chain-interactions/index.md @@ -26,69 +26,68 @@ Whether you're building a frontend application, a backend service, or integratin Accessing blockchain state is fundamental to building responsive applications. Polkadot offers several methods to query on-chain data, each suited for different use cases. -- **[SDK integration](/chain-interactions/query-data/query-sdks/)**: Programmatically read blockchain state using: - - - [Polkadot API (PAPI)](/reference/tools/papi/) - - [Polkadot.js](/reference/tools/polkadot-js-api/) - - [Dedot](/reference/tools/dedot/) - - [Python Substrate Interface](/reference/tools/py-substrate-interface/) - - [Subxt](/reference/tools/subxt/) - -- **[REST API access](/chain-interactions/query-data/query-rest/)**: Query chain data through standardized REST endpoints for simpler integration. -- **[Runtime API calls](/chain-interactions/query-data/runtime-api-calls/)**: Execute runtime APIs directly for specialized queries and operations. + + ### Send Transactions Transactions are the primary mechanism for modifying blockchain state. Understanding transaction construction, signing, and submission is crucial for building interactive applications. -- **[Transaction construction](/chain-interactions/send-transactions/with-sdks/)**: Build transactions using various SDKs with proper encoding and formatting. -- **[Fee estimation](/chain-interactions/send-transactions/calculate-transaction-fees/)**: Calculate transaction fees to ensure sufficient balance and optimize costs. -- **[Multi-token fees](/chain-interactions/send-transactions/pay-fees-with-different-tokens/)**: Learn how to pay transaction fees with different tokens on supported chains. + + ### Send Cross-Chain Transactions Polkadot enables native cross-chain capabilities through Cross-Consensus Messaging (XCM), allowing chains to securely communicate and transfer assets across the ecosystem. -- **[Transfer assets between parachains](/chain-interactions/send-transactions/interoperability/transfer-assets-parachains/)**: Understand how to construct and send XCM messages using [ParaSpell XCM SDK](/reference/tools/paraspell/) and [Polkadot API (PAPI)](/reference/tools/papi/). -- **[Transfer assets into Polkadot](/chain-interactions/send-transactions/interoperability/transfer-assets-into-polkadot/)**: A step-by-step guide to bridging assets from Ethereum to Polkadot using the [ParaSpell XCM SDK](/reference/tools/paraspell/) and [Snowbridge](https://wiki.polkadot.com/learn/learn-snowbridge/){target=\_blank}. + + ### Manage Tokens Polkadot Hub provides a unified platform for managing assets across the ecosystem. Understanding token operations is essential for DeFi applications and multi-chain asset management. -- **[Local asset registration](/chain-interactions/token-operations/register-local-asset/)**: Learn how assets created in Asset Hub are registered on the network. -- **[Foregin asset registration](/chain-interactions/token-operations/register-foreign-asset/)**: Learn how assets created outside of Asset Hub are registered on the network. -- **[Convert assets](/chain-interactions/token-operations/convert-assets/)**: Convert, swap, and manage assets on-chain using the Asset Conversion pallet. -- **Asset Hub integration**: Interact with Polkadot's central asset management hub using [Polkadot.js Apps](https://polkadot.js.org/apps/){target=\_blank}. + + ### Manage Accounts Account management forms the basis of user identity and authentication in blockchain applications. Learn how to create, manage, and query accounts programmatically. -- **[Account creation](/chain-interactions/accounts/create-account/)**: Generate accounts using various SDKs in Rust, Python, and JavaScript. -- **[Account queries](/chain-interactions/accounts/query-accounts/)**: Retrieve account information including balances, nonces, and metadata. + + ## Development Tools and SDKs The Polkadot ecosystem offers a rich set of tools and libraries to facilitate chain interactions: -- **[Polkadot API (PAPI)](/reference/tools/papi/)**: Modern, type-safe TypeScript library with full metadata support. -- **[Polkadot.js](/reference/tools/polkadot-js-api/)**: Comprehensive JavaScript library with extensive ecosystem support. -- **[Dedot](/reference/tools/dedot/)**: Lightweight TypeScript library optimized for performance. -- **[Python Substrate Interface](/reference/tools/py-substrate-interface/)**: Polkadot Substrate Interface for streamlined development. -- **[Subxt](/reference/tools/subxt/)**: Rust library for building robust substrate-based applications. -- **[Polkadot.js Apps](https://polkadot.js.org/apps/)**: Web-based interface for exploring and interacting with chains. +| Tool | Description | +|------|-------------| +| [Polkadot API (PAPI)](/reference/tools/papi/) | Modern, type-safe TypeScript library with full metadata support. | +| [Polkadot.js](/reference/tools/polkadot-js-api/) | Comprehensive JavaScript library with extensive ecosystem support. | +| [Dedot](/reference/tools/dedot/) | Lightweight TypeScript library optimized for performance. | +| [Python Substrate Interface](/reference/tools/py-substrate-interface/) | Polkadot Substrate Interface for streamlined development. | +| [Subxt](/reference/tools/subxt/) | Rust library for building robust substrate-based applications. | +| [Polkadot.js Apps](https://polkadot.js.org/apps/) | Web-based interface for exploring and interacting with chains. | Each tool has its strengths, and choosing the right one depends on your project requirements, programming language preference, and specific use cases. - -## Next Steps - -Explore the sections below to dive deeper into specific chain interaction patterns: - -- **[Query On-Chain Data](/chain-interactions/query-data/query-sdks/)**: Learn to read blockchain state efficiently. -- **[Send Transactions](/chain-interactions/send-transactions/with-sdks/)**: Master transaction construction and submission. -- **[Send Cross-Chain Transactions](/chain-interactions/send-transactions/interoperability/transfer-assets-parachains/)**: Enable cross-chain communication with XCM. -- **[Manage Tokens](/chain-interactions/token-operations/register-local-asset/)**: Manage assets across the Polkadot ecosystem. -- **[Manage Accounts](/chain-interactions/accounts/create-account/)**: Create and query accounts programmatically. - -Each section provides practical examples, code snippets, and comprehensive guides to help you build production-ready applications on Polkadot. \ No newline at end of file diff --git a/chain-interactions/query-data/query-rest.md b/chain-interactions/query-data/query-rest.md index 9b895d433..c2952563f 100644 --- a/chain-interactions/query-data/query-rest.md +++ b/chain-interactions/query-data/query-rest.md @@ -1,6 +1,7 @@ --- title: Query On-Chain State with Sidecar REST API description: Learn how to query on-chain state on Polkadot using the Sidecar REST API with curl, including account balances, asset data, and block information. +short_description: Query chain data through standardized REST endpoints for simpler integration. categories: Chain Interactions, Tooling --- diff --git a/chain-interactions/query-data/query-sdks.md b/chain-interactions/query-data/query-sdks.md index 8bbdf3640..19b7fc3af 100644 --- a/chain-interactions/query-data/query-sdks.md +++ b/chain-interactions/query-data/query-sdks.md @@ -1,6 +1,7 @@ --- title: Query On-Chain State with SDKs description: Learn how to query on-chain storage data on Polkadot Hub using PAPI, Polkadot.js, Dedot, Python Substrate Interface, and Subxt. +short_description: Programmatically read blockchain state using PAPI, Polkadot.js, Dedot, Python Substrate Interface, and Subxt. categories: Chain Interactions, Tooling page_badges: test_workflow: polkadot-docs-query-sdks diff --git a/chain-interactions/query-data/runtime-api-calls.md b/chain-interactions/query-data/runtime-api-calls.md index 0ec774e06..9d6655d11 100644 --- a/chain-interactions/query-data/runtime-api-calls.md +++ b/chain-interactions/query-data/runtime-api-calls.md @@ -1,6 +1,7 @@ --- title: Runtime API Calls description: Learn how to call Polkadot runtime APIs to access the Wasm runtime and retrieve computed results using PAPI, Polkadot.js, Dedot, Python, and Subxt. +short_description: Execute runtime APIs directly for specialized queries and operations. categories: Polkadot Protocol, Tooling --- diff --git a/chain-interactions/send-transactions/calculate-transaction-fees.md b/chain-interactions/send-transactions/calculate-transaction-fees.md index f4be289e9..7dc62e67d 100644 --- a/chain-interactions/send-transactions/calculate-transaction-fees.md +++ b/chain-interactions/send-transactions/calculate-transaction-fees.md @@ -1,6 +1,7 @@ --- title: Calculate Transaction Fees description: Learn how to calculate transaction fees on Polkadot using Polkadot-API, Polkadot.js API, and the Polkadot.js Apps UI to estimate transfer costs. +short_description: Calculate transaction fees to ensure sufficient balance and optimize costs. categories: Chain Interactions, Tooling page_badges: test_workflow: polkadot-docs-calculate-transaction-fees diff --git a/chain-interactions/send-transactions/interoperability/debug-and-preview-xcms.md b/chain-interactions/send-transactions/interoperability/debug-and-preview-xcms.md index 4cc5d3467..765007315 100644 --- a/chain-interactions/send-transactions/interoperability/debug-and-preview-xcms.md +++ b/chain-interactions/send-transactions/interoperability/debug-and-preview-xcms.md @@ -1,6 +1,7 @@ --- title: Replay and Dry Run XCMs description: Replay and dry-run XCMs using Chopsticks with full logging enabled. Diagnose issues, trace message flow, and debug complex cross-chain interactions. +short_description: Replay and dry-run XCMs using Chopsticks to diagnose issues and debug cross-chain interactions. categories: Interoperability, Tooling page_badges: test_workflow: polkadot-docs-debug-and-preview-xcms diff --git a/chain-interactions/send-transactions/interoperability/estimate-xcm-fees.md b/chain-interactions/send-transactions/interoperability/estimate-xcm-fees.md index ee7396b41..b8a828020 100644 --- a/chain-interactions/send-transactions/interoperability/estimate-xcm-fees.md +++ b/chain-interactions/send-transactions/interoperability/estimate-xcm-fees.md @@ -1,6 +1,7 @@ --- title: XCM Fee Estimation description: This tutorial demonstrates how to estimate the fees for teleporting assets from the Polkadot Hub TestNet to the Paseo People Chain. +short_description: Estimate fees for teleporting assets between chains on the Polkadot network. categories: Interoperability, Chain Interactions page_badges: test_workflow: polkadot-docs-estimate-xcm-fees diff --git a/chain-interactions/send-transactions/interoperability/transfer-assets-into-polkadot.md b/chain-interactions/send-transactions/interoperability/transfer-assets-into-polkadot.md index 192e2db82..6346bd5c6 100644 --- a/chain-interactions/send-transactions/interoperability/transfer-assets-into-polkadot.md +++ b/chain-interactions/send-transactions/interoperability/transfer-assets-into-polkadot.md @@ -1,6 +1,7 @@ --- title: Transfer Assets from Ethereum into Polkadot description: A step-by-step guide to bridging assets from Ethereum to Polkadot using the ParaSpell XCM SDK and Snowbridge. +short_description: Bridge assets from Ethereum to Polkadot using the ParaSpell XCM SDK and Snowbridge. categories: Interoperability --- diff --git a/chain-interactions/send-transactions/interoperability/transfer-assets-parachains.md b/chain-interactions/send-transactions/interoperability/transfer-assets-parachains.md index e79c70ad0..daec488f9 100644 --- a/chain-interactions/send-transactions/interoperability/transfer-assets-parachains.md +++ b/chain-interactions/send-transactions/interoperability/transfer-assets-parachains.md @@ -1,6 +1,7 @@ --- title: Transfer Assets Between Parachains description: A step-by-step guide to using the ParaSpell XCM SDK to build, verify, and execute a transfer from one Parachain to another. +short_description: Construct and send XCM messages using ParaSpell XCM SDK and Polkadot API (PAPI). categories: Interoperability, Parachains page_badges: test_workflow: polkadot-docs-transfer-assets-parachains diff --git a/chain-interactions/send-transactions/pay-fees-with-different-tokens.md b/chain-interactions/send-transactions/pay-fees-with-different-tokens.md index 5f359b38c..49ab6030b 100644 --- a/chain-interactions/send-transactions/pay-fees-with-different-tokens.md +++ b/chain-interactions/send-transactions/pay-fees-with-different-tokens.md @@ -1,6 +1,7 @@ --- title: Pay Transaction Fees with Different Tokens description: Learn how to send a DOT transfer transaction while paying the fees using a different token on Polkadot Hub using multiple SDKs. +short_description: Pay transaction fees with different tokens on supported chains. categories: Chain Interactions, Tooling page_badges: test_workflow: polkadot-docs-pay-fees-different-tokens diff --git a/chain-interactions/send-transactions/with-sdks.md b/chain-interactions/send-transactions/with-sdks.md index 14b9d8552..9e9ecbd58 100644 --- a/chain-interactions/send-transactions/with-sdks.md +++ b/chain-interactions/send-transactions/with-sdks.md @@ -1,6 +1,7 @@ --- title: Send Transactions with SDKs description: Learn how to construct, sign, and submit transactions using PAPI, Polkadot.js, Dedot, Python Substrate Interface, and Subxt. +short_description: Build transactions using various SDKs with proper encoding and formatting. categories: Chain Interactions, Tooling page_badges: test_workflow: polkadot-docs-send-transactions diff --git a/chain-interactions/token-operations/convert-assets.md b/chain-interactions/token-operations/convert-assets.md index 88a11d484..894d35272 100644 --- a/chain-interactions/token-operations/convert-assets.md +++ b/chain-interactions/token-operations/convert-assets.md @@ -1,6 +1,7 @@ --- title: Convert Assets on Asset Hub description: A guide detailing the step-by-step process of converting assets on Asset Hub, helping users efficiently navigate asset management on the platform. +short_description: Convert, swap, and manage assets on-chain using the Asset Conversion pallet. categories: Chain Interactions, Tooling page_badges: tutorial_badge: Intermediate diff --git a/chain-interactions/token-operations/register-foreign-asset.md b/chain-interactions/token-operations/register-foreign-asset.md index bd99e7615..09208ab9a 100644 --- a/chain-interactions/token-operations/register-foreign-asset.md +++ b/chain-interactions/token-operations/register-foreign-asset.md @@ -1,6 +1,7 @@ --- title: Register a Foreign Asset description: Learn step-by-step how to register a foreign asset on Polkadot Hub and the origin parachain to enable cross-chain token transfers. +short_description: Register assets created outside of Asset Hub on Polkadot Hub. categories: Interoperability, Parachains page_badges: tutorial_badge: Intermediate diff --git a/chain-interactions/token-operations/register-local-asset.md b/chain-interactions/token-operations/register-local-asset.md index 6686e7b7c..e4fb82bb2 100644 --- a/chain-interactions/token-operations/register-local-asset.md +++ b/chain-interactions/token-operations/register-local-asset.md @@ -1,6 +1,7 @@ --- title: Register a Local Asset description: Learn how to register a local asset on Polkadot Hub, including prerequisites, deposits, and step-by-step instructions using Polkadot.js Apps. +short_description: Register assets created in Asset Hub on Polkadot Hub. categories: Basics, Chain Interactions page_badges: tutorial_badge: Beginner diff --git a/parachains/customize-runtime/add-existing-pallets.md b/parachains/customize-runtime/add-existing-pallets.md index 600047f04..cb3796b24 100644 --- a/parachains/customize-runtime/add-existing-pallets.md +++ b/parachains/customize-runtime/add-existing-pallets.md @@ -1,6 +1,7 @@ --- title: Add an Existing Pallet to the Runtime description: Learn how to include and configure pallets in a Polkadot SDK-based runtime, from adding dependencies to implementing necessary traits. +short_description: Integrate pre-built pallets from the FRAME ecosystem. categories: Parachains page_badges: tutorial_badge: Intermediate diff --git a/parachains/customize-runtime/add-pallet-instances.md b/parachains/customize-runtime/add-pallet-instances.md index 6fbb86bd5..38c6ec21e 100644 --- a/parachains/customize-runtime/add-pallet-instances.md +++ b/parachains/customize-runtime/add-pallet-instances.md @@ -1,6 +1,7 @@ --- title: Add Multiple Pallet Instances description: Learn how to implement multiple instances of the same pallet in your Polkadot SDK-based runtime, from adding dependencies to configuring unique instances. +short_description: Configure and use multiple instances of the same pallet. categories: Parachains page_badges: tutorial_badge: Intermediate diff --git a/parachains/customize-runtime/add-smart-contract-functionality.md b/parachains/customize-runtime/add-smart-contract-functionality.md index dc91a7d77..844ca073e 100644 --- a/parachains/customize-runtime/add-smart-contract-functionality.md +++ b/parachains/customize-runtime/add-smart-contract-functionality.md @@ -1,6 +1,7 @@ --- title: Add Smart Contract Functionality description: Add smart contract capabilities to your Polkadot SDK-based blockchain. Explore PVM, EVM, and Wasm integration for enhanced chain functionality. +short_description: Enable smart contract capabilities using Contracts or EVM pallets. categories: Parachains --- diff --git a/parachains/customize-runtime/pallet-development/benchmark-pallet.md b/parachains/customize-runtime/pallet-development/benchmark-pallet.md index 9995c528f..64b4cfb38 100644 --- a/parachains/customize-runtime/pallet-development/benchmark-pallet.md +++ b/parachains/customize-runtime/pallet-development/benchmark-pallet.md @@ -1,6 +1,7 @@ --- title: Benchmark Your Pallet description: Learn how to benchmark extrinsics in your custom pallet to generate precise weight calculations suitable for production use. +short_description: Measure and optimize pallet performance with benchmarking. categories: Parachains page_badges: test_workflow: polkadot-docs-benchmark-pallet diff --git a/parachains/customize-runtime/pallet-development/create-a-pallet.md b/parachains/customize-runtime/pallet-development/create-a-pallet.md index b18b0292d..83f138c63 100644 --- a/parachains/customize-runtime/pallet-development/create-a-pallet.md +++ b/parachains/customize-runtime/pallet-development/create-a-pallet.md @@ -1,6 +1,7 @@ --- title: Create a Custom Pallet description: Learn how to create custom pallets using FRAME, allowing for flexible, modular, and scalable blockchain development. Follow the step-by-step guide. +short_description: Build a pallet from scratch with custom logic. categories: Parachains page_badges: test_workflow: polkadot-docs-create-a-pallet diff --git a/parachains/customize-runtime/pallet-development/mock-runtime.md b/parachains/customize-runtime/pallet-development/mock-runtime.md index 0f3ede0a8..9c48e4c71 100644 --- a/parachains/customize-runtime/pallet-development/mock-runtime.md +++ b/parachains/customize-runtime/pallet-development/mock-runtime.md @@ -1,6 +1,7 @@ --- title: Mock Your Runtime description: Learn how to create a mock runtime environment for testing your custom pallets in isolation, enabling comprehensive unit testing before runtime integration. +short_description: Set up a mock runtime environment for testing. categories: Parachains page_badges: test_workflow: polkadot-docs-mock-runtime diff --git a/parachains/customize-runtime/pallet-development/pallet-testing.md b/parachains/customize-runtime/pallet-development/pallet-testing.md index 57e08e8e0..eb02546d6 100644 --- a/parachains/customize-runtime/pallet-development/pallet-testing.md +++ b/parachains/customize-runtime/pallet-development/pallet-testing.md @@ -1,6 +1,7 @@ --- title: Unit Test Pallets description: Learn how to efficiently test pallets in the Polkadot SDK, ensuring the reliability and security of your pallets operations. +short_description: Write comprehensive tests for your pallet logic. categories: Parachains page_badges: test_workflow: polkadot-docs-pallet-testing diff --git a/parachains/get-started.md b/parachains/get-started.md index 63b1ead2a..d43823a3c 100644 --- a/parachains/get-started.md +++ b/parachains/get-started.md @@ -22,70 +22,78 @@ Quick start guides help developers set up and interact with the Polkadot paracha Learn the fundamentals of launching and deploying a parachain to the Polkadot network. -| Tutorial | Description | -|:----------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------:| -| [Set Up the Parachain Template](/parachains/launch-a-parachain/set-up-the-parachain-template/) | Polkadot SDK | -| [Deploy to Polkadot](/parachains/launch-a-parachain/deploy-to-polkadot/) | Step-by-step tutorial to deploying your parachain to Polkadot | -| [Obtain Coretime](/parachains/launch-a-parachain/obtain-coretime/) | Learn how to acquire blockspace using Polkadot's coretime model (RegionX) | + + ## Customize Your Runtime Build custom functionality for your parachain by composing and creating pallets. -| Tutorial | Description | -|:---------------------------------------------------------------------------------------------------:|:-----------------------------------------------------------------:| -| [Add Existing Pallets to the Runtime](/parachains/customize-runtime/add-existing-pallets/) | Integrate pre-built pallets from the FRAME ecosystem | -| [Add Multiple Instances of a Pallet](/parachains/customize-runtime/add-pallet-instances/) | Configure and use multiple instances of the same pallet | -| [Add Smart Contract Functionality](/parachains/customize-runtime/add-smart-contract-functionality/) | Enable smart contract capabilities using Contracts or EVM pallets | + + ### Pallet Development Deep dive into creating and managing custom pallets for your parachain. -| Tutorial | Description | -|:-------------------------------------------------------------------------------------------------:|:---------------------------------------------------------:| -| [Create a Custom Pallet](/parachains/customize-runtime/pallet-development/create-a-pallet/) | Build a pallet from scratch with custom logic | -| [Mock Your Runtime](/parachains/customize-runtime/pallet-development/mock-runtime/) | Set up a mock runtime environment for testing | -| [Pallet Unit Testing](/parachains/customize-runtime/pallet-development/pallet-testing/) | Write comprehensive tests for your pallet logic | -| [Benchmark the Custom Pallet](/parachains/customize-runtime/pallet-development/benchmark-pallet/) | Measure and optimize pallet performance with benchmarking | + + ## Testing Test your parachain in various environments before production deployment. -| Tutorial | Description | -|:-----------------------------------------------------------------------:|:-------------------------------------------------------:| -| [Fork a Parachain](/parachains/testing/fork-a-parachain/) | Use Chopsticks to create a local fork for testing | -| [Run a Parachain Network](/parachains/testing/run-a-parachain-network/) | Launch a complete parachain test network with Zombienet | + + ## Runtime Upgrades and Maintenance Manage your parachain's lifecycle with forkless upgrades and maintenance operations. -| Tutorial | Description | -|:-------------------------------------------------------------------------:|:----------------------------------------------------:| -| [Runtime Upgrades](/parachains/runtime-maintenance/runtime-upgrades/) | Perform forkless runtime upgrades via governance | -| [Storage Migrations](/parachains/runtime-maintenance/storage-migrations/) | Safely migrate storage when updating runtime logic | -| [Unlock Parachains](/parachains/runtime-maintenance/unlock-parachains/) | Understand parachain lifecycle and unlock mechanisms | + + ## Interoperability Configure your parachain for cross-chain communication using XCM (Cross-Consensus Messaging). -| Tutorial | Description | -|:----------------------------------------------------------------------------------------------------------:|:------------------------------------------------------:| -| [Open HRMP Channels Between Parachains](/parachains/interoperability/channels-between-parachains/) | Establish communication channels with other parachains | -| [Open HRMP Channels with System Parachains](/parachains/interoperability/channels-with-system-parachains/) | Connect with Asset Hub and other system parachains | + + ## Integrations Integrate your parachain with essential ecosystem tools and services. -| Tutorial | Description | -|:----------------------------------------------:|:------------------------------------------------------:| -| [Wallets](/parachains/integrations/wallets/) | Integrate wallet support for user interactions | -| [Indexers](/parachains/integrations/indexers/) | Set up indexing solutions for querying blockchain data | -| [Oracles](/parachains/integrations/oracles/) | Connect your parachain to off-chain data sources | + + ## Additional Resources diff --git a/parachains/integrations/indexers.md b/parachains/integrations/indexers.md index 4a9cb9f76..24756d271 100644 --- a/parachains/integrations/indexers.md +++ b/parachains/integrations/indexers.md @@ -1,6 +1,7 @@ --- title: Indexers description: Discover blockchain indexers. Enhance data access, enable fast and complex queries, and optimize blockchain data for seamless app performance. +short_description: Set up indexing solutions for querying blockchain data. categories: Tooling, Parachains --- diff --git a/parachains/integrations/oracles.md b/parachains/integrations/oracles.md index 112860959..4af2c2e87 100644 --- a/parachains/integrations/oracles.md +++ b/parachains/integrations/oracles.md @@ -1,6 +1,7 @@ --- title: Oracles description: Learn about blockchain oracles, the essential bridges connecting blockchains with real-world data for decentralized applications in the Polkadot ecosystem. +short_description: Connect your parachain to off-chain data sources. categories: Tooling, Parachains --- diff --git a/parachains/integrations/wallets.md b/parachains/integrations/wallets.md index fbc8377ce..da6e1aa1e 100644 --- a/parachains/integrations/wallets.md +++ b/parachains/integrations/wallets.md @@ -1,6 +1,7 @@ --- title: Wallets description: Explore blockchain wallets. Securely manage digital assets with hot wallets for online access or cold wallets for offline, enhanced security. +short_description: Integrate wallet support for user interactions. categories: Tooling, Parachains --- diff --git a/parachains/interoperability/channels-between-parachains.md b/parachains/interoperability/channels-between-parachains.md index f0c3a8b60..d6d9aeab7 100644 --- a/parachains/interoperability/channels-between-parachains.md +++ b/parachains/interoperability/channels-between-parachains.md @@ -1,6 +1,7 @@ --- title: Opening HRMP Channels Between Parachains description: Learn how to open HRMP channels between parachains on Polkadot. Discover the step-by-step process for establishing uni- and bidirectional communication. +short_description: Establish communication channels with other parachains. categories: Parachains, Interoperability page_badges: tutorial_badge: Advanced diff --git a/parachains/interoperability/channels-with-system-parachains.md b/parachains/interoperability/channels-with-system-parachains.md index dc5da6c7f..597452269 100644 --- a/parachains/interoperability/channels-with-system-parachains.md +++ b/parachains/interoperability/channels-with-system-parachains.md @@ -1,6 +1,7 @@ --- title: Opening HRMP Channels with System Parachains description: Learn how to open HRMP channels with Polkadot system parachains. Discover the process for establishing bi-directional communication using a single XCM message. +short_description: Connect with Asset Hub and other system parachains. categories: Parachains, Interoperability page_badges: tutorial_badge: Advanced diff --git a/parachains/launch-a-parachain/deploy-to-polkadot.md b/parachains/launch-a-parachain/deploy-to-polkadot.md index 464cdff43..a9f8af058 100644 --- a/parachains/launch-a-parachain/deploy-to-polkadot.md +++ b/parachains/launch-a-parachain/deploy-to-polkadot.md @@ -1,6 +1,7 @@ --- title: Deploy on Polkadot description: This guide walks you through the journey of deploying your Polkadot SDK parachain on the Polkadot TestNet, detailing each step to a successful deployment. +short_description: Deploy your parachain to Polkadot step-by-step. categories: Parachains page_badges: tutorial_badge: Advanced diff --git a/parachains/launch-a-parachain/obtain-coretime.md b/parachains/launch-a-parachain/obtain-coretime.md index f92ca8c19..31be4c11a 100644 --- a/parachains/launch-a-parachain/obtain-coretime.md +++ b/parachains/launch-a-parachain/obtain-coretime.md @@ -1,6 +1,7 @@ --- title: Obtain Coretime description: Learn how to obtain coretime for block production with this guide, covering both on-demand and bulk options for smooth operations. +short_description: Aquire blockspace using Polkadot's coretime model. categories: Parachains page_badges: tutorial_badge: Advanced 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 ed2768b4a..14b148f9d 100644 --- a/parachains/launch-a-parachain/set-up-the-parachain-template.md +++ b/parachains/launch-a-parachain/set-up-the-parachain-template.md @@ -1,6 +1,7 @@ --- title: Set Up the Polkadot SDK Parachain Template description: Learn how to set up and run the Polkadot SDK Parachain Template locally, creating a ready-to-customize foundation for your parachain. +short_description: Set up and run the Polkadot SDK Parachain Template locally. categories: Basics, Parachains page_badges: tutorial_badge: Beginner diff --git a/parachains/runtime-maintenance/coretime-renewal.md b/parachains/runtime-maintenance/coretime-renewal.md index a960f9005..e9ad2ba67 100644 --- a/parachains/runtime-maintenance/coretime-renewal.md +++ b/parachains/runtime-maintenance/coretime-renewal.md @@ -1,6 +1,7 @@ --- title: Coretime Renewal description: Learn how to renew coretime manually or automatically to ensure uninterrupted parachain operation with predictable pricing and minimal risk. +short_description: Renew coretime to ensure uninterrupted parachain operation. categories: Parachains --- diff --git a/parachains/runtime-maintenance/runtime-upgrades.md b/parachains/runtime-maintenance/runtime-upgrades.md index 10d283446..585958325 100644 --- a/parachains/runtime-maintenance/runtime-upgrades.md +++ b/parachains/runtime-maintenance/runtime-upgrades.md @@ -1,6 +1,7 @@ --- title: Runtime Upgrades description: Learn how to safely perform runtime upgrades for your Polkadot SDK-based blockchain, including step-by-step instructions. +short_description: Perform forkless runtime upgrades via governance. categories: Parachains page_badges: tutorial_badge: Intermediate diff --git a/parachains/runtime-maintenance/storage-migrations.md b/parachains/runtime-maintenance/storage-migrations.md index fb192efdf..fee2115c1 100644 --- a/parachains/runtime-maintenance/storage-migrations.md +++ b/parachains/runtime-maintenance/storage-migrations.md @@ -1,6 +1,7 @@ --- title: Storage Migrations description: Ensure smooth runtime upgrades with storage migrations, update data formats, and prevent errors. Learn when and how to implement migrations efficiently. +short_description: Safely migrate storage when updating runtime logic. categories: Parachains --- diff --git a/parachains/runtime-maintenance/unlock-parachains.md b/parachains/runtime-maintenance/unlock-parachains.md index bebb6f2f1..fe4470ed6 100644 --- a/parachains/runtime-maintenance/unlock-parachains.md +++ b/parachains/runtime-maintenance/unlock-parachains.md @@ -1,6 +1,7 @@ --- title: Unlock a Parachain description: Learn how to unlock your parachain. This step-by-step guide covers verifying lock status, preparing calls, and executing the unlock process. +short_description: Understand parachain lifecycle and unlock mechanisms. categories: Parachains --- diff --git a/parachains/testing/fork-a-parachain.md b/parachains/testing/fork-a-parachain.md index 890b631fc..d1e0edc2a 100644 --- a/parachains/testing/fork-a-parachain.md +++ b/parachains/testing/fork-a-parachain.md @@ -1,6 +1,7 @@ --- title: Fork a Parachain Using Chopsticks description: Simplify Polkadot SDK development with Chopsticks. Learn essential features, how to install Chopsticks, and how to configure local blockchain forks. +short_description: Create a local fork of a live parachain for testing. categories: Parachains, Tooling page_badges: test_workflow: polkadot-docs-fork-a-parachain diff --git a/parachains/testing/run-a-parachain-network.md b/parachains/testing/run-a-parachain-network.md index ca0a6ab4a..6958bc784 100644 --- a/parachains/testing/run-a-parachain-network.md +++ b/parachains/testing/run-a-parachain-network.md @@ -1,6 +1,7 @@ --- title: Run a Parachain Network description: Learn how to deploy a local parachain test network using Zombienet, including building a custom collator and verifying block production. +short_description: Launch a complete parachain test network with Zombienet. categories: Parachains, Tooling page_badges: test_workflow: polkadot-docs-run-a-parachain-network diff --git a/smart-contracts/cookbook/dapps/zero-to-hero.md b/smart-contracts/cookbook/dapps/zero-to-hero.md index 620528fcf..a57b8262a 100644 --- a/smart-contracts/cookbook/dapps/zero-to-hero.md +++ b/smart-contracts/cookbook/dapps/zero-to-hero.md @@ -2,6 +2,7 @@ title: Zero to Hero Smart Contract DApp description: Learn how to build a decentralized application on Polkadot Hub using Viem and Next.js by creating a simple dApp that interacts with a smart contract. categories: Smart Contracts, Tooling +tools: [Hardhat, viem, Next.js] page_badges: tutorial_badge: Intermediate test_workflow: polkadot-docs-zero-to-hero-dapp @@ -13,7 +14,7 @@ page_tests: Decentralized applications (dApps) are a key component of the Web3 ecosystem, enabling developers to build applications that communicate directly with blockchain networks. Polkadot Hub, a blockchain with smart contract support, serves as a robust platform for deploying and interacting with dApps. -This tutorial will guide you through building a fully functional dApp that interacts with a smart contract on Polkadot Hub. You'll create and deploy a smart contract with Hardhat, and then use [Viem](https://viem.sh/){target=\_blank} for blockchain interactions and [Next.js](https://nextjs.org/){target=\_blank} for the frontend. By the end, you'll have a dApp that lets users connect their wallets, retrieve on-chain data, and execute transactions. +This tutorial will guide you through building a fully functional dApp that interacts with a smart contract on Polkadot Hub. You'll create and deploy a smart contract with Hardhat, and then use [viem](https://viem.sh/){target=\_blank} for blockchain interactions and [Next.js](https://nextjs.org/){target=\_blank} for the frontend. By the end, you'll have a dApp that lets users connect their wallets, retrieve on-chain data, and execute transactions. ## Prerequisites @@ -918,7 +919,7 @@ cd zero-to-hero-dapp --- - Learn how to port an Ethereum project to Polkadot Hub using Hardhat and Viem. + Learn how to port an Ethereum project to Polkadot Hub using Hardhat and viem. [:octicons-arrow-right-24: Get Started](/smart-contracts/cookbook/eth-dapps/uniswap-v2/) diff --git a/smart-contracts/cookbook/eth-dapps/uniswap-v2/core-v2-pvm.md b/smart-contracts/cookbook/eth-dapps/uniswap-v2/core-v2-pvm.md index 408af955a..613f2c8f4 100644 --- a/smart-contracts/cookbook/eth-dapps/uniswap-v2/core-v2-pvm.md +++ b/smart-contracts/cookbook/eth-dapps/uniswap-v2/core-v2-pvm.md @@ -2,6 +2,7 @@ title: Deploying Uniswap V2 Core on Polkadot description: Learn how to deploy and test Uniswap V2 Core on Polkadot Hub using Hardhat, bringing AMM-based token swaps to the Polkadot ecosystem. categories: Smart Contracts, Tooling +tools: [Hardhat] page_badges: tutorial_badge: Intermediate toggle: diff --git a/smart-contracts/cookbook/eth-dapps/uniswap-v2/core-v2.md b/smart-contracts/cookbook/eth-dapps/uniswap-v2/core-v2.md index 54000cdf6..47fd42dcb 100644 --- a/smart-contracts/cookbook/eth-dapps/uniswap-v2/core-v2.md +++ b/smart-contracts/cookbook/eth-dapps/uniswap-v2/core-v2.md @@ -3,6 +3,7 @@ title: Uniswap V2 Core with EVM on Polkadot description: Deploy and test unmodified Uniswap V2 Core contracts on Polkadot Hub using standard Hardhat and TypeScript with the EVM execution path. tutorial_badge: Intermediate categories: Smart Contracts, Tooling +tools: [Hardhat] toggle: group: uniswap-v2-core canonical: true diff --git a/smart-contracts/cookbook/eth-dapps/uniswap-v2/periphery-v2.md b/smart-contracts/cookbook/eth-dapps/uniswap-v2/periphery-v2.md index 1b9c46dbc..432aea5f7 100644 --- a/smart-contracts/cookbook/eth-dapps/uniswap-v2/periphery-v2.md +++ b/smart-contracts/cookbook/eth-dapps/uniswap-v2/periphery-v2.md @@ -2,6 +2,7 @@ title: Uniswap V2 Periphery with EVM on Polkadot description: Deploy and test unmodified Uniswap V2 Periphery Router contracts on Polkadot Hub using standard Hardhat and TypeScript with the EVM execution path. categories: Smart Contracts, Tooling +tools: [Hardhat] page_badges: tutorial_badge: Intermediate test_workflow: polkadot-docs-uniswap-v2-periphery-hardhat diff --git a/smart-contracts/cookbook/index.md b/smart-contracts/cookbook/index.md index f0b6d65be..a1d8169eb 100644 --- a/smart-contracts/cookbook/index.md +++ b/smart-contracts/cookbook/index.md @@ -10,25 +10,27 @@ Welcome to the Polkadot smart contracts cookbook index. This page contains a list of all relevant tutorials and guides to help you get started coding smart contracts and dApps in Polkadot. - - -## Get Tokens from the Faucet - -| Title | Difficulty | Tools | Description | -|------------------------------------|:-----------:|-------|-----------------------------------------------------------------------------------------------------------------------| -| [Faucet](/smart-contracts/faucet/) | 🟢 Beginner | N/A | Learn how to obtain test tokens from Polkadot faucets for development and testing purposes across different networks. | - -## EVM Smart Contracts - -| Title | Difficulty | Tools | Description | -|---------------------------------------------------------------------------------------------------------|:-----------:|--------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------| -| [Deploy an ERC-20 to Polkadot Hub](/smart-contracts/cookbook/smart-contracts/deploy-erc20/erc20-remix/) | 🟢 Beginner | EVM Wallet, Polkadot Remix IDE | Deploy an ERC-20 token on Polkadot Hub. This guide covers contract creation, compilation, deployment, and interaction via Polkadot Remix IDE. | -| [Deploy an NFT to Polkadot Hub](/smart-contracts/cookbook/smart-contracts/deploy-nft/nft-remix/) | 🟢 Beginner | EVM Wallet, Polkadot Remix IDE | Deploy an NFT on Polkadot Hub with OpenZeppelin. Learn how to compile, deploy, and interact with your contract using Polkadot Remix IDE. | - -## Port Ethereum DApps - -| Title | Difficulty | Tools | Description | -|-------------------------------------------------------------------------------------|:---------------:|---------|----------------------------------------------------------------------------------------------------------------------------------| -| [Deploying Uniswap V2 on Polkadot](/smart-contracts/cookbook/eth-dapps/uniswap-v2/) | 🟡 Intermediate | Hardhat | Learn how to deploy and test Uniswap V2 on Polkadot Hub using Hardhat, bringing AMM-based token swaps to the Polkadot ecosystem. | - - + + + diff --git a/smart-contracts/cookbook/smart-contracts/deploy-basic/basic-hardhat.md b/smart-contracts/cookbook/smart-contracts/deploy-basic/basic-hardhat.md index 35f604266..81b7804bf 100644 --- a/smart-contracts/cookbook/smart-contracts/deploy-basic/basic-hardhat.md +++ b/smart-contracts/cookbook/smart-contracts/deploy-basic/basic-hardhat.md @@ -2,6 +2,7 @@ title: Deploy a Basic Contract with Hardhat description: Learn how to deploy a basic smart contract to Polkadot Hub using Hardhat, ideal for professional workflows that require comprehensive testing and debugging. categories: Smart Contracts +tools: [Hardhat] page_badges: test_workflow: polkadot-docs-basic-hardhat page_tests: diff --git a/smart-contracts/cookbook/smart-contracts/deploy-basic/basic-remix.md b/smart-contracts/cookbook/smart-contracts/deploy-basic/basic-remix.md index 0c82f363c..ce41180bd 100644 --- a/smart-contracts/cookbook/smart-contracts/deploy-basic/basic-remix.md +++ b/smart-contracts/cookbook/smart-contracts/deploy-basic/basic-remix.md @@ -2,6 +2,7 @@ title: Deploy a Basic Contract with Remix IDE description: Learn how to deploy a basic smart contract to Polkadot Hub using Remix IDE, ideal for rapid prototyping, learning, and visual development. categories: Smart Contracts +tools: [Remix] --- # Deploy a Basic Contract with Remix IDE diff --git a/smart-contracts/cookbook/smart-contracts/deploy-erc20/erc20-hardhat.md b/smart-contracts/cookbook/smart-contracts/deploy-erc20/erc20-hardhat.md index 0409b3269..f75d13230 100644 --- a/smart-contracts/cookbook/smart-contracts/deploy-erc20/erc20-hardhat.md +++ b/smart-contracts/cookbook/smart-contracts/deploy-erc20/erc20-hardhat.md @@ -2,6 +2,7 @@ title: Deploy an ERC-20 Using Hardhat description: Deploy an ERC-20 token on Polkadot Hub using PVM. This guide covers contract creation, compilation, deployment, and interaction via Hardhat. categories: Basics, Smart Contracts +tools: [Hardhat, OpenZeppelin] page_badges: tutorial_badge: Intermediate test_workflow: polkadot-docs-erc20-hardhat diff --git a/smart-contracts/cookbook/smart-contracts/deploy-erc20/erc20-remix.md b/smart-contracts/cookbook/smart-contracts/deploy-erc20/erc20-remix.md index a35d8a2c0..308647618 100644 --- a/smart-contracts/cookbook/smart-contracts/deploy-erc20/erc20-remix.md +++ b/smart-contracts/cookbook/smart-contracts/deploy-erc20/erc20-remix.md @@ -2,6 +2,7 @@ title: Deploy an ERC-20 Using Remix IDE description: Deploy an ERC-20 token contract on Polkadot Hub. This guide covers contract creation, compilation, deployment, and interaction via the Remix IDE. categories: Basics, Smart Contracts +tools: [Remix, OpenZeppelin] page_badges: tutorial_badge: Beginner --- diff --git a/smart-contracts/cookbook/smart-contracts/deploy-nft/nft-hardhat.md b/smart-contracts/cookbook/smart-contracts/deploy-nft/nft-hardhat.md index 231f2461c..5c97d781d 100644 --- a/smart-contracts/cookbook/smart-contracts/deploy-nft/nft-hardhat.md +++ b/smart-contracts/cookbook/smart-contracts/deploy-nft/nft-hardhat.md @@ -2,6 +2,7 @@ title: Deploy an ERC-721 Using Hardhat description: Learn how to deploy an ERC-721 NFT contract to Polkadot Hub using Hardhat, a comprehensive development environment with built-in deployment capabilities. categories: Basics, Smart Contracts +tools: [Hardhat, OpenZeppelin] page_badges: tutorial_badge: Beginner test_workflow: polkadot-docs-nft-hardhat diff --git a/smart-contracts/cookbook/smart-contracts/deploy-nft/nft-remix.md b/smart-contracts/cookbook/smart-contracts/deploy-nft/nft-remix.md index 1c93a346a..46f06be90 100644 --- a/smart-contracts/cookbook/smart-contracts/deploy-nft/nft-remix.md +++ b/smart-contracts/cookbook/smart-contracts/deploy-nft/nft-remix.md @@ -2,6 +2,7 @@ title: Deploy an ERC-721 NFT Using Remix description: Learn how to deploy an ERC-721 NFT contract to Polkadot Hub using Remix, a browser-based IDE for quick prototyping and learning. categories: Basics, Smart Contracts +tools: [Remix, OpenZeppelin] page_badges: tutorial_badge: Beginner --- diff --git a/smart-contracts/dev-environments/foundry.md b/smart-contracts/dev-environments/foundry.md index 2c0f341be..5d9da7a71 100644 --- a/smart-contracts/dev-environments/foundry.md +++ b/smart-contracts/dev-environments/foundry.md @@ -1,7 +1,9 @@ --- title: Use Foundry with Polkadot Hub description: Learn how to create, compile, test, deploy, and verify smart contracts on Polkadot Hub using Foundry, a fast and portable Ethereum toolkit. +short_description: Compile, test, deploy, and verify contracts with Foundry. categories: Smart Contracts, Tooling +tools: [Foundry] page_badges: tutorial_badge: Beginner test_workflow: polkadot-docs-foundry diff --git a/smart-contracts/dev-environments/hardhat-polkadot.md b/smart-contracts/dev-environments/hardhat-polkadot.md index 5f8cd8ec9..7cbb142f8 100644 --- a/smart-contracts/dev-environments/hardhat-polkadot.md +++ b/smart-contracts/dev-environments/hardhat-polkadot.md @@ -1,6 +1,7 @@ --- title: Use Hardhat with Polkadot Hub description: Learn how to set up, configure, and use Hardhat Polkadot to create, compile, test, and deploy Solidity smart contracts on Polkadot Hub using the PVM runtime. +short_description: Set up Hardhat Polkadot to deploy Solidity contracts using the PVM runtime. categories: Smart Contracts, Tooling toggle: group: hardhat @@ -10,7 +11,7 @@ page_badges: tutorial_badge: Beginner test_workflow: polkadot-docs-hardhat-pvm page_tests: - path: polkadot-docs/smart-contracts/dev-environments/hardhat-pvm/tests/docs.test.ts + path: polkadot-docs/smart-contracts/dev-environments/hardhat-pvm/tests/docs.test.ts --- # Hardhat Polkadot diff --git a/smart-contracts/dev-environments/hardhat.md b/smart-contracts/dev-environments/hardhat.md index 1cb20eff5..8897ac0e8 100644 --- a/smart-contracts/dev-environments/hardhat.md +++ b/smart-contracts/dev-environments/hardhat.md @@ -1,7 +1,9 @@ --- title: Use Hardhat with Polkadot Hub description: Learn how to create, compile, test, and deploy smart contracts on Polkadot Hub using Hardhat, a powerful development environment for blockchain developers. +short_description: Project scaffolding and configuration with Hardhat. categories: Smart Contracts, Tooling +tools: [Hardhat] toggle: group: hardhat canonical: true @@ -11,7 +13,7 @@ page_badges: tutorial_badge: Beginner test_workflow: polkadot-docs-hardhat-evm page_tests: - path: polkadot-docs/smart-contracts/dev-environments/hardhat-evm/tests/docs.test.ts + path: polkadot-docs/smart-contracts/dev-environments/hardhat-evm/tests/docs.test.ts --- # Hardhat diff --git a/smart-contracts/dev-environments/local-dev-node.md b/smart-contracts/dev-environments/local-dev-node.md index 8b5872803..555a5cc6f 100644 --- a/smart-contracts/dev-environments/local-dev-node.md +++ b/smart-contracts/dev-environments/local-dev-node.md @@ -1,7 +1,9 @@ --- title: Local Development Node description: Follow this step-by-step guide to install a Revive Dev node and ETH-RPC adapter for smart contract development in a local environment. +short_description: Spin up a local node for iterative development. categories: Smart Contracts +tools: [Polkadot SDK node] page_badges: test_workflow: polkadot-docs-local-dev-node page_tests: diff --git a/smart-contracts/dev-environments/remix.md b/smart-contracts/dev-environments/remix.md index 62b387c1d..3199d900f 100644 --- a/smart-contracts/dev-environments/remix.md +++ b/smart-contracts/dev-environments/remix.md @@ -1,7 +1,9 @@ --- title: Use the Remix IDE on Polkadot Hub description: Explore the smart contract development and deployment process on Polkadot Hub using Remix IDE, a visual IDE for blockchain developers. +short_description: Connect Remix to Polkadot Hub. categories: Smart Contracts, Tooling +tools: [Remix] page_badges: tutorial_badge: Beginner --- diff --git a/smart-contracts/for-eth-devs/accounts.md b/smart-contracts/for-eth-devs/accounts.md index d9adf61a5..2964fd557 100644 --- a/smart-contracts/for-eth-devs/accounts.md +++ b/smart-contracts/for-eth-devs/accounts.md @@ -1,6 +1,7 @@ --- title: Accounts in Polkadot Hub Smart Contracts description: Bridges Ethereum's 20-byte addresses with Polkadot's 32-byte accounts, enabling seamless interaction while maintaining compatibility with Ethereum tooling. +short_description: How 20-byte Ethereum addresses map to 32-byte Polkadot accounts. categories: Smart Contracts extra_javascript: - https://cdn.jsdelivr.net/npm/@polkadot/util@14.0.1/bundle-polkadot-util.js diff --git a/smart-contracts/for-eth-devs/blocks-transactions-fees.md b/smart-contracts/for-eth-devs/blocks-transactions-fees.md index 79f950b78..1fdd0f4b0 100644 --- a/smart-contracts/for-eth-devs/blocks-transactions-fees.md +++ b/smart-contracts/for-eth-devs/blocks-transactions-fees.md @@ -1,6 +1,7 @@ --- title: Transactions and Fees on Asset Hub description: Explore how Asset Hub smart contracts handle blocks, transactions, and fees with EVM compatibility, supporting various Ethereum transaction types. +short_description: Transaction types, fees, and multi-dimensional metering. categories: Smart Contracts, Polkadot Protocol --- diff --git a/smart-contracts/for-eth-devs/contract-deployment.md b/smart-contracts/for-eth-devs/contract-deployment.md index 93b6fce80..3b6ab977d 100644 --- a/smart-contracts/for-eth-devs/contract-deployment.md +++ b/smart-contracts/for-eth-devs/contract-deployment.md @@ -1,6 +1,7 @@ --- title: Contract Deployment description: Compare deployment flows for REVM and PVM-based smart contracts on the Polkadot Hub. Includes single-step REVM flows and PVM's two-step deployment model. +short_description: Deployment mechanics, gas estimation, and storage model. categories: Smart Contracts, Basics --- diff --git a/smart-contracts/for-eth-devs/dual-vm-stack.md b/smart-contracts/for-eth-devs/dual-vm-stack.md index cbfcd7fbb..0265ba4df 100644 --- a/smart-contracts/for-eth-devs/dual-vm-stack.md +++ b/smart-contracts/for-eth-devs/dual-vm-stack.md @@ -1,6 +1,7 @@ --- title: Dual Virtual Machine Stack description: Compare Polkadot’s dual smart contract VMs—REVM for EVM compatibility and PolkaVM for RISC-V performance, flexibility, and efficiency. +short_description: Overview of EVM and native execution on the Hub. categories: Smart Contracts, Polkadot Protocol --- diff --git a/smart-contracts/for-eth-devs/evm-vs-pvm.md b/smart-contracts/for-eth-devs/evm-vs-pvm.md index 55aa026d2..483a7ccac 100644 --- a/smart-contracts/for-eth-devs/evm-vs-pvm.md +++ b/smart-contracts/for-eth-devs/evm-vs-pvm.md @@ -1,6 +1,7 @@ --- title: EVM vs PVM description: Compares EVM and PVM, highlighting key architectural differences, gas models, memory management, and account handling while ensuring Solidity compatibility. +short_description: Compare EVM and PVM architectures, gas models, and key differences. categories: Smart Contracts, Polkadot Protocol --- diff --git a/smart-contracts/for-eth-devs/gas-model.md b/smart-contracts/for-eth-devs/gas-model.md index d055eb449..8e07517be 100644 --- a/smart-contracts/for-eth-devs/gas-model.md +++ b/smart-contracts/for-eth-devs/gas-model.md @@ -1,6 +1,7 @@ --- title: Gas Model on the Polkadot Hub description: Learn how gas estimation, pricing, and weight mapping work in the Polkadot Hub. +short_description: Gas vs. weight, proof size, and storage deposits. categories: Smart Contracts, Polkadot Protocol --- diff --git a/smart-contracts/for-eth-devs/json-rpc-apis.md b/smart-contracts/for-eth-devs/json-rpc-apis.md index e5c651b2a..e7a8bcb38 100644 --- a/smart-contracts/for-eth-devs/json-rpc-apis.md +++ b/smart-contracts/for-eth-devs/json-rpc-apis.md @@ -1,6 +1,7 @@ --- title: JSON-RPC APIs description: JSON-RPC APIs guide for Polkadot Hub, covering supported methods, parameters, and examples for interacting with the chain. +short_description: Supported Ethereum JSON-RPC methods and examples. categories: Reference --- diff --git a/smart-contracts/get-started.md b/smart-contracts/get-started.md index ffb01c08d..a5984667c 100644 --- a/smart-contracts/get-started.md +++ b/smart-contracts/get-started.md @@ -13,7 +13,7 @@ This resource provides quick-starts for building smart contracts on Polkadot Hub Use these curated links to get connected, get funded, and deploy your first contract. | Quick Start | Tools | Description | -|:---------------------------------------------------:|:---------------------:|:---------------------------------------------------------------:| +|-----------------------------------------------------|-----------------------|-----------------------------------------------------------------| | [Connect to Polkadot](/smart-contracts/connect/) | Polkadot.js, MetaMask | Add the network, configure RPC, verify activity in the explorer | | [Get Test Tokens](/smart-contracts/faucet/) | - | Request test funds to deploy and interact with contracts | | [Explore Transactions](/smart-contracts/explorers/) | BlockScout, Routescan, Subscan | Inspect transactions, logs, token transfers, and contract state | @@ -22,14 +22,25 @@ Use these curated links to get connected, get funded, and deploy your first cont Set up local environments and CI-friendly workflows to iterate quickly and validate changes before deploying. -| Build and Test Locally | Tools | Description | -|:-------------------------------------------------------------------------:|:-----------------:|:----------------------------------------------:| -| [Run a Local Dev Node](/smart-contracts/dev-environments/local-dev-node/) | Polkadot SDK node | Spin up a local node for iterative development | -| [Use Remix for Development](/smart-contracts/dev-environments/remix/) | Remix | Connect Remix to Polkadot Hub | -| [Use Hardhat for Development](/smart-contracts/dev-environments/hardhat/) | Hardhat | Project scaffolding and configuration | -| [Use Foundry for Development](/smart-contracts/dev-environments/foundry/) | Foundry | Compile, test, deploy, and verify contracts | -| [OpenZeppelin Contracts Wizard for Polkadot](https://wizard.openzeppelin.com/polkadot){target=\_blank} | OpenZeppelin | Generate secure ERC-20, ERC-721, and other OpenZeppelin-standard contracts for Polkadot Hub | -| [Rust for PVM](/smart-contracts/for-eth-devs/dual-vm-stack/#alternative-pvm-backend) | LLMs, coding agents | Write PVM contracts in Rust; use AI assistants while tooling matures | + + ## Ethereum Tool Differences on Polkadot EVM @@ -45,22 +56,19 @@ Tools like **Foundry** and **Hardhat** are built for standard Ethereum nodes. Po Bridge your Ethereum knowledge with Polkadot Hub specifics: account mapping, fees, JSON-RPC, and deployment. -| Ethereum Developer Guides | Description | -|:-----------------------------------------------------------------------------------------:|:---------------------------------------------------------------:| -| [Accounts](/smart-contracts/for-eth-devs/accounts/) | How 20‑byte Ethereum addresses map to 32‑byte Polkadot accounts | -| [Blocks, Transactions, and Fees](/smart-contracts/for-eth-devs/blocks-transactions-fees/) | Transaction types, fees, and multi‑dimensional metering | -| [Gas Model](/smart-contracts/for-eth-devs/gas-model/) | Gas vs. weight, proof size, and storage deposits | -| [Contract Deployment](/smart-contracts/for-eth-devs/contract-deployment/) | Deployment mechanics, gas estimation, and storage model | -| [JSON-RPC APIs](/smart-contracts/for-eth-devs/json-rpc-apis/) | Supported Ethereum JSON-RPC methods and examples | -| [Dual VM Stack](/smart-contracts/for-eth-devs/dual-vm-stack/) | Overview of EVM and native execution on the Hub | -| [Differences: Ethereum Tools vs Polkadot EVM](/smart-contracts/get-started/#ethereum-tool-differences-on-polkadot-evm) | Limitations and differences when using Foundry, Hardhat, and other tools against Polkadot nodes | + + ## Cookbook: Hands-on Tutorials Follow step-by-step guides that walk through common tasks and complete dApp examples. | Tutorial | Tools | Description | -|:----------------------------------------------------------------------------------------------:|:-------------------:|:-----------------------------------------:| +|------------------------------------------------------------------------------------------------|---------------------|-------------------------------------------| | [Deploy a Basic Contract](/smart-contracts/cookbook/smart-contracts/deploy-basic/basic-remix/) | Remix | Minimal deployment walkthrough | | [Deploy an ERC-20](/smart-contracts/cookbook/smart-contracts/deploy-erc20/erc20-remix/) | Remix, OpenZeppelin | Create, deploy, and mint a fungible token | | [Deploy an NFT (ERC-721)](/smart-contracts/cookbook/smart-contracts/deploy-nft/nft-remix/) | Remix, OpenZeppelin | Build and deploy an NFT collection | @@ -71,30 +79,33 @@ Follow step-by-step guides that walk through common tasks and complete dApp exam Choose the client libraries that fit your stack for connecting wallets and calling contracts. -| Library | Description | -|:--------------------------------------------------:|:-------------------------------------------------------:| -| [Ethers.js](/smart-contracts/libraries/ethers-js/) | Connect, sign, and interact with contracts using Ethers | -| [viem](/smart-contracts/libraries/viem/) | Type‑safe EVM interactions and utilities | -| [Wagmi](/smart-contracts/libraries/wagmi/) | React hooks for wallet connections and contract calls | -| [Web3.js](/smart-contracts/libraries/web3-js/) | Web3 provider and contract APIs | -| [Web3.py](/smart-contracts/libraries/web3-py/) | Python toolkit for on‑chain interactions and scripts | + + ## Integrations Integrate essential services like wallets, indexers, and oracles to round out your dApp. -| Integration | Description | -|:-------------------------------------------------:|:-----------------------------------------:| -| [Wallets](/smart-contracts/integrations/wallets/) | Supported wallets and configuration notes | + + ## Precompiles Discover precompiled system contracts available on the Hub and how to use them. -| Topic | Description | -|:--------------------------------------------------------:|:-------------------------------------------:| -| [Overview of Precompiles](/smart-contracts/precompiles/) | What precompiles are available on the Hub | -| [ETH Native](/smart-contracts/precompiles/eth-native/) | EVM precompiles and interfaces | -| [XCM](/smart-contracts/precompiles/xcm/) | Cross‑chain messaging helpers for contracts | + + From here, follow the quick starts to get connected, iterate locally with your preferred tools, and use the guides, libraries, integrations, and precompiles as you grow into production‑ready dApps. If you get stuck, [open an issue](https://github.com/polkadot-developers/polkadot-docs/issues/new?template=docs-issue.yml){target=\_blank} or reach out in the community channels. diff --git a/smart-contracts/integrations/wallets.md b/smart-contracts/integrations/wallets.md index be65a4c89..91e31c24f 100644 --- a/smart-contracts/integrations/wallets.md +++ b/smart-contracts/integrations/wallets.md @@ -1,6 +1,7 @@ --- title: Wallets for Polkadot Hub description: Comprehensive guide to connecting and managing wallets for Polkadot Hub, covering step-by-step instructions for interacting with the ecosystem. +short_description: Supported wallets and configuration notes. categories: Smart Contracts, Tooling --- diff --git a/smart-contracts/libraries/ethers-js.md b/smart-contracts/libraries/ethers-js.md index cfbc4a914..4d8d2a314 100644 --- a/smart-contracts/libraries/ethers-js.md +++ b/smart-contracts/libraries/ethers-js.md @@ -1,6 +1,7 @@ --- title: Deploy Contracts to Polkadot Hub with Ethers.js description: Learn how to interact with Polkadot Hub using Ethers.js, from compiling and deploying Solidity contracts to interacting with deployed smart contracts. +short_description: Connect, sign, and interact with contracts using Ethers.js. categories: Smart Contracts, Tooling --- diff --git a/smart-contracts/libraries/viem.md b/smart-contracts/libraries/viem.md index 9da4dfd0a..7380e2e02 100644 --- a/smart-contracts/libraries/viem.md +++ b/smart-contracts/libraries/viem.md @@ -1,6 +1,7 @@ --- title: viem for Polkadot Hub Smart Contracts description: This guide covers deploying and interacting with contracts on Polkadot Hub using viem, a TypeScript library for Ethereum-compatible chains. +short_description: Type-safe EVM interactions and utilities. categories: Smart Contracts, Tooling --- diff --git a/smart-contracts/libraries/wagmi.md b/smart-contracts/libraries/wagmi.md index c73cf8bfd..f99f11c13 100644 --- a/smart-contracts/libraries/wagmi.md +++ b/smart-contracts/libraries/wagmi.md @@ -1,6 +1,7 @@ --- title: Wagmi for Polkadot Hub Smart Contracts description: Learn how to use Wagmi React Hooks to fetch and interact with smart contracts on Polkadot Hub for seamless dApp integration. +short_description: React hooks for wallet connections and contract calls. categories: Smart Contracts, Tooling --- diff --git a/smart-contracts/libraries/web3-js.md b/smart-contracts/libraries/web3-js.md index 4843af984..d497abbe4 100644 --- a/smart-contracts/libraries/web3-js.md +++ b/smart-contracts/libraries/web3-js.md @@ -1,6 +1,7 @@ --- title: Deploy Contracts to Polkadot Hub with Web3.js description: Learn how to interact with Polkadot Hub using Web3.js, from compiling and deploying Solidity contracts to interacting with deployed smart contracts. +short_description: Web3 provider and contract APIs. categories: Smart Contracts, Tooling --- diff --git a/smart-contracts/libraries/web3-py.md b/smart-contracts/libraries/web3-py.md index 2c3cec50f..909cc3347 100644 --- a/smart-contracts/libraries/web3-py.md +++ b/smart-contracts/libraries/web3-py.md @@ -1,6 +1,7 @@ --- title: Web3.py description: Learn how to interact with Polkadot Hub using the Web3 python library, deploying Solidity contracts, and interacting with deployed smart contracts. +short_description: Python toolkit for on-chain interactions and scripts. categories: Smart Contracts, Tooling --- diff --git a/smart-contracts/precompiles/erc20.md b/smart-contracts/precompiles/erc20.md index 81f420052..32498ba10 100644 --- a/smart-contracts/precompiles/erc20.md +++ b/smart-contracts/precompiles/erc20.md @@ -1,6 +1,7 @@ --- title: Interact with the ERC20 Precompile description: Learn how to use the ERC20 precompile to interact with assets from the assets pallet using standard ERC20 token interfaces in your smart contracts. +short_description: Interact with assets pallet assets using standard ERC20 interfaces. categories: Smart Contracts extra_javascript: - https://cdn.jsdelivr.net/npm/@polkadot/util@14.0.1/bundle-polkadot-util.js diff --git a/smart-contracts/precompiles/eth-native.md b/smart-contracts/precompiles/eth-native.md index acfc89481..c8b86f735 100644 --- a/smart-contracts/precompiles/eth-native.md +++ b/smart-contracts/precompiles/eth-native.md @@ -1,6 +1,7 @@ --- title: Ethereum-Native Precompiles description: General overview of Ethereum-native precompiles in Polkadot Hub’s Revive pallet, including usage basics and details on standard precompiles for smart contracts. +short_description: EVM precompiles and interfaces. categories: Smart Contracts --- diff --git a/smart-contracts/precompiles/storage.md b/smart-contracts/precompiles/storage.md index 1dd0fdc1e..2d1134cec 100644 --- a/smart-contracts/precompiles/storage.md +++ b/smart-contracts/precompiles/storage.md @@ -1,6 +1,7 @@ --- title: Interact with the Storage Precompile description: Learn how to use the Storage precompile for low-level contract storage access, including reads, writes, partial reads, key inspection, and storage management. +short_description: Access low-level contract storage with reads, writes, and key inspection. categories: Smart Contracts --- diff --git a/smart-contracts/precompiles/system.md b/smart-contracts/precompiles/system.md index 110a8148e..e9b28f567 100644 --- a/smart-contracts/precompiles/system.md +++ b/smart-contracts/precompiles/system.md @@ -1,6 +1,7 @@ --- title: Interact with the System Precompile description: Learn how to use the System precompile to access core runtime functionality, cryptographic operations, and system utilities from your smart contracts. +short_description: Access core runtime functionality and cryptographic operations from smart contracts. categories: Smart Contracts --- diff --git a/smart-contracts/precompiles/xcm.md b/smart-contracts/precompiles/xcm.md index e364f8589..5559ccc75 100644 --- a/smart-contracts/precompiles/xcm.md +++ b/smart-contracts/precompiles/xcm.md @@ -1,6 +1,7 @@ --- title: Interact with the XCM Precompile description: Learn how to use the XCM precompile to send cross-chain messages, execute XCM instructions, and estimate costs from your smart contracts. +short_description: Cross-chain messaging helpers for contracts. categories: Smart Contracts --- From 983d473558ca4206286bf20ad4999daced495100 Mon Sep 17 00:00:00 2001 From: Erin Shaben Date: Wed, 27 May 2026 00:48:45 -0400 Subject: [PATCH 2/3] fix typo --- parachains/launch-a-parachain/obtain-coretime.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/parachains/launch-a-parachain/obtain-coretime.md b/parachains/launch-a-parachain/obtain-coretime.md index 31be4c11a..eb167e820 100644 --- a/parachains/launch-a-parachain/obtain-coretime.md +++ b/parachains/launch-a-parachain/obtain-coretime.md @@ -1,7 +1,7 @@ --- title: Obtain Coretime description: Learn how to obtain coretime for block production with this guide, covering both on-demand and bulk options for smooth operations. -short_description: Aquire blockspace using Polkadot's coretime model. +short_description: Acquire blockspace using Polkadot's coretime model. categories: Parachains page_badges: tutorial_badge: Advanced From 0db7da85fba0af00e5e7d9c1229cee3d1e6a8439 Mon Sep 17 00:00:00 2001 From: Erin Shaben Date: Wed, 27 May 2026 00:49:46 -0400 Subject: [PATCH 3/3] add capitalization for clarity --- smart-contracts/precompiles/erc20.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/smart-contracts/precompiles/erc20.md b/smart-contracts/precompiles/erc20.md index 32498ba10..2d5137b98 100644 --- a/smart-contracts/precompiles/erc20.md +++ b/smart-contracts/precompiles/erc20.md @@ -1,7 +1,7 @@ --- title: Interact with the ERC20 Precompile description: Learn how to use the ERC20 precompile to interact with assets from the assets pallet using standard ERC20 token interfaces in your smart contracts. -short_description: Interact with assets pallet assets using standard ERC20 interfaces. +short_description: Interact with Assets pallet assets using standard ERC20 interfaces. categories: Smart Contracts extra_javascript: - https://cdn.jsdelivr.net/npm/@polkadot/util@14.0.1/bundle-polkadot-util.js