Update docs (#261)

* typos and broken links

* evm runtime docs

* name change in code

* generic runtime description updated, and typos

* smart contract with zombienet

* quick start exported into another document and further formatting
This commit is contained in:
Özgün Özerk
2024-07-26 16:33:59 +03:00
committed by Gustavo Gonzalez
parent 1b67c98311
commit 9b9845920c
41 changed files with 1032 additions and 492 deletions
+5 -5
View File
@@ -1,8 +1,8 @@
[package]
name = "parachain-template-node"
name = "generic-template-node"
authors = { workspace = true }
build = "build.rs"
description = "Node compatible with parachain runtime template."
description = "Node compatible with generic runtime template."
edition = { workspace = true }
license = { workspace = true }
publish = false
@@ -19,7 +19,7 @@ serde = { workspace = true, features = [ "derive" ] }
serde_json = { workspace = true }
# Local
parachain-template-runtime = { path = "../runtime" }
generic-runtime-template = { path = "../runtime" }
# Substrate
frame-benchmarking = { workspace = true }
@@ -80,14 +80,14 @@ experimental = []
runtime-benchmarks = [
"frame-benchmarking-cli/runtime-benchmarks",
"frame-benchmarking/runtime-benchmarks",
"parachain-template-runtime/runtime-benchmarks",
"generic-runtime-template/runtime-benchmarks",
"polkadot-cli/runtime-benchmarks",
"polkadot-primitives/runtime-benchmarks",
"sc-service/runtime-benchmarks",
"sp-runtime/runtime-benchmarks",
]
try-runtime = [
"parachain-template-runtime/try-runtime",
"generic-runtime-template/try-runtime",
"polkadot-cli/try-runtime",
"sp-runtime/try-runtime",
]
+6 -8
View File
@@ -1,5 +1,5 @@
use cumulus_primitives_core::ParaId;
use parachain_template_runtime::{
use generic_runtime_template::{
constants::currency::EXISTENTIAL_DEPOSIT, AccountId, AuraId, Signature,
};
use sc_chain_spec::{ChainSpecExtension, ChainSpecGroup};
@@ -10,7 +10,7 @@ use sp_runtime::traits::{IdentifyAccount, Verify};
/// Specialized `ChainSpec` for the normal parachain runtime.
pub type ChainSpec =
sc_service::GenericChainSpec<parachain_template_runtime::RuntimeGenesisConfig, Extensions>;
sc_service::GenericChainSpec<generic_runtime_template::RuntimeGenesisConfig, Extensions>;
/// The default XCM version to set in genesis config.
const SAFE_XCM_VERSION: u32 = xcm::prelude::XCM_VERSION;
@@ -61,8 +61,8 @@ where
///
/// The input must be a tuple of individual keys (a single arg for now since we
/// have just one key).
pub fn template_session_keys(keys: AuraId) -> parachain_template_runtime::SessionKeys {
parachain_template_runtime::SessionKeys { aura: keys }
pub fn template_session_keys(keys: AuraId) -> generic_runtime_template::SessionKeys {
generic_runtime_template::SessionKeys { aura: keys }
}
pub fn development_config() -> ChainSpec {
@@ -75,8 +75,7 @@ pub fn development_config() -> ChainSpec {
properties.insert("basedOn".into(), "OpenZeppelin Generic Template".into());
ChainSpec::builder(
parachain_template_runtime::WASM_BINARY
.expect("WASM binary was not built, please build it!"),
generic_runtime_template::WASM_BINARY.expect("WASM binary was not built, please build it!"),
Extensions {
relay_chain: "rococo-local".into(),
// You MUST set this to the correct network!
@@ -127,8 +126,7 @@ pub fn local_testnet_config() -> ChainSpec {
#[allow(deprecated)]
ChainSpec::builder(
parachain_template_runtime::WASM_BINARY
.expect("WASM binary was not built, please build it!"),
generic_runtime_template::WASM_BINARY.expect("WASM binary was not built, please build it!"),
Extensions {
relay_chain: "rococo-local".into(),
// You MUST set this to the correct network!
+1 -1
View File
@@ -3,8 +3,8 @@ use std::net::SocketAddr;
use cumulus_client_service::storage_proof_size::HostFunctions as ReclaimHostFunctions;
use cumulus_primitives_core::ParaId;
use frame_benchmarking_cli::{BenchmarkCmd, SUBSTRATE_REFERENCE_HARDWARE};
use generic_runtime_template::Block;
use log::info;
use parachain_template_runtime::Block;
use sc_cli::{
ChainSpec, CliConfiguration, DefaultConfigurationValues, ImportParams, KeystoreParams,
NetworkParams, Result, SharedParams, SubstrateCli,
+1 -1
View File
@@ -7,7 +7,7 @@
use std::sync::Arc;
use parachain_template_runtime::{opaque::Block, AccountId, Balance, Nonce};
use generic_runtime_template::{opaque::Block, AccountId, Balance, Nonce};
use sc_client_api::AuxStore;
pub use sc_rpc::DenyUnsafe;
use sc_transaction_pool_api::TransactionPool;
+1 -1
View File
@@ -20,7 +20,7 @@ use cumulus_relay_chain_interface::{OverseerHandle, RelayChainInterface};
// Substrate Imports
use frame_benchmarking_cli::SUBSTRATE_REFERENCE_HARDWARE;
// Local Runtime Types
use parachain_template_runtime::{
use generic_runtime_template::{
apis::RuntimeApi,
opaque::{Block, Hash},
};