pezkuwichain/pezkuwi-subxt
1
0
Fork 0
mirror of https://github.com/pezkuwichain/pezkuwi-subxt.git synced 2026-05-30 18:41:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

Runtime Documentation (#1282)

Browse Source 
* add docs to parachain runtimes

* update and add top readme

* clarify docs

* review plus licenses

* Update parachains/README.md

* Update parachains/runtimes/assets/README.md

Co-authored-by: Bernhard Schuster <bernhard@ahoi.io>

* Update parachains/runtimes/assets/README.md

Co-authored-by: Bernhard Schuster <bernhard@ahoi.io>

Co-authored-by: Bernhard Schuster <bernhard@ahoi.io>
This commit is contained in:
joe petrowski
2022-05-24 12:58:39 +02:00
committed by GitHub
parent 86e777d646
commit 97a97965b6
9 changed files with 108 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
cumulus/parachains/runtimes/assets/README.md
+25
View File
@@ -0,0 +1,25 @@
# Assets Parachain
Implementation of _Statemint_, a blockchain to support generic assets in the Polkadot and Kusama
networks.
Statemint allows users to:
- Deploy promise-backed assets, both fungible and non-fungible, with a DOT/KSM deposit.
- Set admin roles to manage assets and asset classes.
- Register assets as "self-sufficient" if the Relay Chain agrees, i.e. gain the ability for an
asset to justify the existance of accounts sans DOT/KSM.
- Pay transaction fees using sufficient assets.
- Transfer (and approve transfer) assets.
- Interact with the chain via its transactional API or XCM.
Statemint must stay fully aligned with the Relay Chain it is connected to. As such, it will accept
the Relay Chain's governance origins as its own.
See
[the article on Statemint as common good parachain](https://www.parity.io/blog/statemint-generic-assets-chain-proposing-a-common-good-parachain-to-polkadot-governance/)
for a higher level description.
Wallets, custodians, etc. should see
[the Polkadot Wiki's Integration Guide](https://wiki.polkadot.network/docs/build-integrate-assets)
for details about support.
cumulus/parachains/runtimes/assets/statemine/src/lib.rs
+4 -2
View File
@@ -1,4 +1,4 @@
// Copyright (C) 2021 Parity Technologies (UK) Ltd.
// Copyright (C) 2021-2022 Parity Technologies (UK) Ltd.
// SPDX-License-Identifier: Apache-2.0
// Licensed under the Apache License, Version 2.0 (the "License");
@@ -13,7 +13,9 @@
// See the License for the specific language governing permissions and
// limitations under the License.
//! Statemine runtime.
//! # Statemine Runtime
//!
//! Statemine is the canary network for its Polkadot cousin, Statemint.
#![cfg_attr(not(feature = "std"), no_std)]
#![recursion_limit = "256"]
cumulus/parachains/runtimes/assets/statemint/src/lib.rs
+33 -2
View File
@@ -1,4 +1,4 @@
// Copyright (C) 2021 Parity Technologies (UK) Ltd.
// Copyright (C) 2021-2022 Parity Technologies (UK) Ltd.
// SPDX-License-Identifier: Apache-2.0
// Licensed under the Apache License, Version 2.0 (the "License");
@@ -13,7 +13,38 @@
// See the License for the specific language governing permissions and
// limitations under the License.
//! Statemint runtime.
//! # Statemint Runtime
//!
//! Statemint is a parachain that provides an interface to create, manage, and use assets. Assets
//! may be fungible or non-fungible.
//!
//! ## Assets
//!
//! - Fungibles: Configuration of `pallet-assets`.
//! - Non-Fungibles (NFTs): Configuration of `pallet-uniques`.
//!
//! ## Other Functionality
//!
//! ### Native Balances
//!
//! Statemint uses its parent DOT token as its native asset.
//!
//! ### Governance
//!
//! As a common good parachain, Statemint defers its governance (namely, its `Root` origin), to its
//! Relay Chain parent, Polkadot.
//!
//! ### Collator Selection
//!
//! Statemint uses `pallet-collator-selection`, a simple first-come-first-served registration
//! system where collators can reserve a small bond to join the block producer set. There is no
//! slashing.
//!
//! ### XCM
//!
//! Because Statemint is fully under the control of the Relay Chain, it is meant to be a
//! `TrustedTeleporter`. It can also serve as a reserve location to other parachains for DOT as well
//! as other local assets.
#![cfg_attr(not(feature = "std"), no_std)]
#![recursion_limit = "256"]
cumulus/parachains/runtimes/assets/westmint/src/lib.rs
+4 -2
View File
@@ -1,4 +1,4 @@
// Copyright (C) 2021 Parity Technologies (UK) Ltd.
// Copyright (C) 2021-2022 Parity Technologies (UK) Ltd.
// SPDX-License-Identifier: Apache-2.0
// Licensed under the Apache License, Version 2.0 (the "License");
@@ -13,7 +13,9 @@
// See the License for the specific language governing permissions and
// limitations under the License.
//! Westmint runtime.
//! # Westmint Runtime
//!
//! Westmint is the testnet for Statemint.
#![cfg_attr(not(feature = "std"), no_std)]
#![recursion_limit = "256"]