mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-05-07 14:18:03 +00:00
Alexandru Vasile
8bceda2b39
* Fix documentation examples Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * CI: Add `cargo test --doc` Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * Update .github/workflows/rust.yml Co-authored-by: Niklas Adolfsson <niklasadolfsson1@gmail.com> * Remove docs/subxt.md and move documentation to subxt/lib.rs Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * Hide polkadot interface for `events/mod.rs` Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * docs: Use `#` for headers Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> Co-authored-by: Niklas Adolfsson <niklasadolfsson1@gmail.com>
72 lines
2.2 KiB
Rust
72 lines
2.2 KiB
Rust
// Copyright 2019-2022 Parity Technologies (UK) Ltd.
|
|
// This file is part of subxt.
|
|
//
|
|
// subxt is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// subxt is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with subxt. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
//! Library to generate an API for a Substrate runtime from its metadata.
|
|
//!
|
|
//! ## Generated Structure
|
|
//!
|
|
//! The API generator logic:
|
|
//! - At the root there is the `item_mod` provided (ie `pub mod api {}`)
|
|
//! - Pallets are represented by a child module (ie `pub mod PalletName {}`) of the root
|
|
//! - Each pallet exposes as child modules (if applicable):
|
|
//! - Calls (`pub mod calls {}`)
|
|
//! - Events (`pub mod events {}`)
|
|
//! - Storage (`pub mod storage {}`)
|
|
//! - Constants (`pub mod constants {}`)
|
|
//!
|
|
//! ## Example
|
|
//!
|
|
//! ```no_run
|
|
//! use std::fs;
|
|
//! use codec::Decode;
|
|
//! use frame_metadata::RuntimeMetadataPrefixed;
|
|
//! use subxt_codegen::DerivesRegistry;
|
|
//!
|
|
//! let encoded = fs::read("../artifacts/polkadot_metadata.scale").unwrap();
|
|
//!
|
|
//! // Runtime metadata obtained from a node.
|
|
//! let metadata = <RuntimeMetadataPrefixed as Decode>::decode(&mut &*encoded).unwrap();
|
|
//! // Module under which the API is generated.
|
|
//! let item_mod = syn::parse_quote!(
|
|
//! pub mod api {}
|
|
//! );
|
|
//! // Default module derivatives.
|
|
//! let mut derives = DerivesRegistry::default();
|
|
//! // Generate the Runtime API.
|
|
//! let generator = subxt_codegen::RuntimeGenerator::new(metadata);
|
|
//! let runtime_api = generator.generate_runtime(item_mod, derives);
|
|
//! println!("{}", runtime_api);
|
|
//! ```
|
|
|
|
#![deny(unused_crate_dependencies)]
|
|
|
|
mod api;
|
|
mod ir;
|
|
mod types;
|
|
|
|
pub use self::{
|
|
api::{
|
|
generate_runtime_api,
|
|
RuntimeGenerator,
|
|
},
|
|
types::{
|
|
Derives,
|
|
DerivesRegistry,
|
|
Module,
|
|
TypeGenerator,
|
|
},
|
|
};
|