From a8b64a8cc258d4634212b1ae6ac58b937f907bee Mon Sep 17 00:00:00 2001 From: Daanvdplas Date: Thu, 14 Nov 2024 17:56:32 +0700 Subject: [PATCH 1/3] docs: add readme --- extension/README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 extension/README.md diff --git a/extension/README.md b/extension/README.md new file mode 100644 index 000000000..a9901b5a9 --- /dev/null +++ b/extension/README.md @@ -0,0 +1,18 @@ +## Pop Chain Extension +_A Chain Extension for Polkadot SDK Runtimes_ + +The pop-chain-extension crate provides a chain extension designed to be integrated with any Polkadot SDK runtime. Instead of being limited to a single pallet, the extension offers a flexible solution that can cater to any feature exposed by the runtime. It provides functionality to dispatch runtime calls or query runtime state from smart contracts. + +### Key Features +**Precise Weight Charging**: Handles accurate weight charging ensuring secure execution. + +**I/O handling**: +- **Error Handling**: Supports flexible error processing returned by the runtime and send back to the smart contracts. + +- **Input Handling**: Supports flexible input processing for interacting with the runtime. + +_Motivation: versioning, enabling contracts to interact with different versions of the runtime, providing backward compatibility._ + +**Rich Logging for Debugging**: Provides detailed logging capabilities with customizable log targets, aiding developers in debugging and monitoring contract interactions with the runtime. + +### Learn more From 376ac0dfcd100a430ffb1d1c40276b865eb7246d Mon Sep 17 00:00:00 2001 From: Daanvdplas Date: Wed, 27 Nov 2024 09:27:19 +0100 Subject: [PATCH 2/3] docs: refactor --- extension/README.md | 9 ++++++--- pop-api/README.md | 8 +------- 2 files changed, 7 insertions(+), 10 deletions(-) diff --git a/extension/README.md b/extension/README.md index a9901b5a9..02a6c55c6 100644 --- a/extension/README.md +++ b/extension/README.md @@ -1,18 +1,21 @@ ## Pop Chain Extension _A Chain Extension for Polkadot SDK Runtimes_ -The pop-chain-extension crate provides a chain extension designed to be integrated with any Polkadot SDK runtime. Instead of being limited to a single pallet, the extension offers a flexible solution that can cater to any feature exposed by the runtime. It provides functionality to dispatch runtime calls or query runtime state from smart contracts. +The pop-chain-extension crate introduces a versatile chain extension for seamless integration with any Polkadot SDK runtime. Unlike being confined to a single pallet, it offers a flexible, runtime-agnostic solution that adapts to any feature exposed by the runtime. Optimized for smart contracts, it enables backward-compatible dispatch of runtime calls and state queries, ensuring robust and future-proof functionality. ### Key Features **Precise Weight Charging**: Handles accurate weight charging ensuring secure execution. **I/O handling**: + +_Motivation: versioning, enabling contracts to interact with different versions of the runtime, providing backward compatibility._ - **Error Handling**: Supports flexible error processing returned by the runtime and send back to the smart contracts. - **Input Handling**: Supports flexible input processing for interacting with the runtime. -_Motivation: versioning, enabling contracts to interact with different versions of the runtime, providing backward compatibility._ - **Rich Logging for Debugging**: Provides detailed logging capabilities with customizable log targets, aiding developers in debugging and monitoring contract interactions with the runtime. ### Learn more +The Pop Chain Extension is integrated into Pop's runtime, serving as the foundation for the [Pop API ink! library](https://github.com/r0gue-io/pop-node/tree/main/pop-api). + +Check out how the extension is [configured in the Testnet runtime](https://github.com/r0gue-io/pop-node/tree/main/runtime/devnet/src/config/api) and find out how the api modules come into play as well! diff --git a/pop-api/README.md b/pop-api/README.md index 2fe56428f..1461bada4 100644 --- a/pop-api/README.md +++ b/pop-api/README.md @@ -46,13 +46,7 @@ Check out the ink! smart contract [examples](./example) using the API. ### Learn more The true strength of the API lies in the Pop runtime, where a single, unified chain extension provides flexible and -efficient access to all runtime features, while specialized API modules deliver stable, intuitive interfaces for -developers. Together, these elements make the API a powerful tool for creating decentralized applications on Polkadot. - -Want to explore how it all works? Check out: - -- [Chain Extension Implementation](../extension) -- [API Modules](../pallets/api) +efficient access to all runtime features. Go check out the [extension](../extension) if you want to learn more! ### Support From 102e48ff15d2f521b828a32800e62810184b3ad0 Mon Sep 17 00:00:00 2001 From: Daanvdplas Date: Wed, 27 Nov 2024 09:30:37 +0100 Subject: [PATCH 3/3] style: links --- extension/README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/extension/README.md b/extension/README.md index 02a6c55c6..39e96c86e 100644 --- a/extension/README.md +++ b/extension/README.md @@ -1,14 +1,17 @@ ## Pop Chain Extension + _A Chain Extension for Polkadot SDK Runtimes_ The pop-chain-extension crate introduces a versatile chain extension for seamless integration with any Polkadot SDK runtime. Unlike being confined to a single pallet, it offers a flexible, runtime-agnostic solution that adapts to any feature exposed by the runtime. Optimized for smart contracts, it enables backward-compatible dispatch of runtime calls and state queries, ensuring robust and future-proof functionality. ### Key Features + **Precise Weight Charging**: Handles accurate weight charging ensuring secure execution. **I/O handling**: _Motivation: versioning, enabling contracts to interact with different versions of the runtime, providing backward compatibility._ + - **Error Handling**: Supports flexible error processing returned by the runtime and send back to the smart contracts. - **Input Handling**: Supports flexible input processing for interacting with the runtime. @@ -16,6 +19,16 @@ _Motivation: versioning, enabling contracts to interact with different versions **Rich Logging for Debugging**: Provides detailed logging capabilities with customizable log targets, aiding developers in debugging and monitoring contract interactions with the runtime. ### Learn more -The Pop Chain Extension is integrated into Pop's runtime, serving as the foundation for the [Pop API ink! library](https://github.com/r0gue-io/pop-node/tree/main/pop-api). -Check out how the extension is [configured in the Testnet runtime](https://github.com/r0gue-io/pop-node/tree/main/runtime/devnet/src/config/api) and find out how the api modules come into play as well! +The Pop Chain Extension is integrated into Pop's runtime, serving as the foundation for the [Pop API ink! library](../pop-api). + +Check out how the extension is [configured in the Testnet runtime](../runtime/devnet/src/config/api) and find out how the api modules come into play as well! + +### Support + +Be part of our passionate community of Web3 builders. [Join our Telegram](https://t.me/onpopio)! + +Feel free to raise issues if anything is unclear, if you have ideas or want to contribute to Pop! + +For any questions related to ink! you can also go to [Polkadot Stack Exchange](https://polkadot.stackexchange.com/) or +ask the [ink! community](https://t.me/inkathon/).