diff --git a/examples/examples/benchmark_bulk_xt.rs b/examples/examples/benchmark_bulk_xt.rs index a48c3ec65..b42156566 100644 --- a/examples/examples/benchmark_bulk_xt.rs +++ b/examples/examples/benchmark_bulk_xt.rs @@ -15,9 +15,6 @@ //! This example floods the node with a series of transactions. -// run this against test node with -// > substrate-test-node --dev --execution native --ws-port 9979 -ltxpool=debug - use kitchensink_runtime::{AccountId, BalancesCall, RuntimeCall}; use sp_keyring::AccountKeyring; use substrate_api_client::{ @@ -26,8 +23,10 @@ use substrate_api_client::{ Api, SubmitExtrinsic, }; -// To test this example in CI, we run it against the Substrate kitchensink node. Therefore, we use the AssetRuntimeConfig -// ! Careful: Most runtimes uses plain as tips, they need a polkadot config. +// To test this example with CI we run it against the Substrate kitchensink node, which uses the asset pallet. +// Therefore, we need to use the `AssetRuntimeConfig` in this example. +// ! However, most Substrate runtimes do not use the asset pallet at all. So if you run an example against your own node +// you most likely should use `DefaultRuntimeConfig` instead. // Define an extrinsic signer type which sets the generic types of the `GenericExtrinsicSigner`. // This way, the types don't have to be reassigned with every usage of this type and makes diff --git a/examples/examples/check_extrinsic_events.rs b/examples/examples/check_extrinsic_events.rs index 3742fdee0..4c32a4dc9 100644 --- a/examples/examples/check_extrinsic_events.rs +++ b/examples/examples/check_extrinsic_events.rs @@ -22,8 +22,10 @@ use substrate_api_client::{ Api, GetAccountInformation, SubmitAndWatch, TransactionStatus, XtStatus, }; -// To test this example in CI, we run it against the Substrate kitchensink node. Therefore, we use the AssetRuntimeConfig -// ! Careful: Most runtimes uses plain as tips, they need a polkadot config. +// To test this example with CI we run it against the Substrate kitchensink node, which uses the asset pallet. +// Therefore, we need to use the `AssetRuntimeConfig` in this example. +// ! However, most Substrate runtimes do not use the asset pallet at all. So if you run an example against your own node +// you most likely should use `DefaultRuntimeConfig` instead. type Hash = ::Hash; diff --git a/examples/examples/compose_extrinsic_offline.rs b/examples/examples/compose_extrinsic_offline.rs index ea9a7b047..a69f3e795 100644 --- a/examples/examples/compose_extrinsic_offline.rs +++ b/examples/examples/compose_extrinsic_offline.rs @@ -14,7 +14,7 @@ */ //! This example shows how to use the compose_extrinsic_offline macro which generates an extrinsic -//! without asking the node for nonce and does not need to know the metadata +//! without asking the node for nonce and does not need to know the metadata. use kitchensink_runtime::{BalancesCall, RuntimeCall}; use sp_keyring::AccountKeyring; @@ -25,8 +25,10 @@ use substrate_api_client::{ Api, GetChainInfo, SubmitAndWatch, XtStatus, }; -// To test this example in CI, we run it against the Substrate kitchensink node. Therefore, we use the AssetRuntimeConfig -// ! Careful: Most runtimes uses plain as tips, they need a polkadot config. +// To test this example with CI we run it against the Substrate kitchensink node, which uses the asset pallet. +// Therefore, we need to use the `AssetRuntimeConfig` in this example. +// ! However, most Substrate runtimes do not use the asset pallet at all. So if you run an example against your own node +// you most likely should use `DefaultRuntimeConfig` instead. #[tokio::main] async fn main() { diff --git a/examples/examples/contract_instantiate_with_code.rs b/examples/examples/contract_instantiate_with_code.rs index ad631e058..9c31a950e 100644 --- a/examples/examples/contract_instantiate_with_code.rs +++ b/examples/examples/contract_instantiate_with_code.rs @@ -24,8 +24,10 @@ use substrate_api_client::{ SubmitAndWatch, XtStatus, }; -// To test this example in CI, we run it against the Substrate kitchensink node. Therefore, we use the AssetRuntimeConfig -// ! Careful: Most runtimes uses plain as tips, they need a polkadot config. +// To test this example with CI we run it against the Substrate kitchensink node, which uses the asset pallet. +// Therefore, we need to use the `AssetRuntimeConfig` in this example. +// ! However, most Substrate runtimes do not use the asset pallet at all. So if you run an example against your own node +// you most likely should use `DefaultRuntimeConfig` instead. #[allow(unused)] #[derive(Decode)] diff --git a/examples/examples/get_account_identity.rs b/examples/examples/get_account_identity.rs index aada0d62d..0e6f9ca77 100644 --- a/examples/examples/get_account_identity.rs +++ b/examples/examples/get_account_identity.rs @@ -33,8 +33,10 @@ type BalanceOf = <::Currency as Currency< type MaxRegistrarsOf = ::MaxRegistrars; type MaxAdditionalFieldsOf = ::MaxAdditionalFields; -// To test this example in CI, we run it against the Substrate kitchensink node. Therefore, we use the AssetRuntimeConfig -// ! Careful: Most runtimes uses plain as tips, they need a polkadot config. +// To test this example with CI we run it against the Substrate kitchensink node, which uses the asset pallet. +// Therefore, we need to use the `AssetRuntimeConfig` in this example. +// ! However, most Substrate runtimes do not use the asset pallet at all. So if you run an example against your own node +// you most likely should use `DefaultRuntimeConfig` instead. #[tokio::main] async fn main() { diff --git a/examples/examples/get_blocks_async.rs b/examples/examples/get_blocks_async.rs index a2ab63d09..5ab46485c 100644 --- a/examples/examples/get_blocks_async.rs +++ b/examples/examples/get_blocks_async.rs @@ -30,8 +30,10 @@ async fn main() { println!("Please compile this example with `--no-default-features` for it to run properly.") } -// To test this example in CI, we run it against the Substrate kitchensink node. Therefore, we use the AssetRuntimeConfig -// ! Careful: Most runtimes uses plain as tips, they need a polkadot config. +// To test this example with CI we run it against the Substrate kitchensink node, which uses the asset pallet. +// Therefore, we need to use the `AssetRuntimeConfig` in this example. +// ! However, most Substrate runtimes do not use the asset pallet at all. So if you run an example against your own node +// you most likely should use `DefaultRuntimeConfig` instead. #[cfg(not(feature = "sync-examples"))] #[tokio::main] diff --git a/examples/examples/get_storage.rs b/examples/examples/get_storage.rs index 1a3b19890..0cb715f0a 100644 --- a/examples/examples/get_storage.rs +++ b/examples/examples/get_storage.rs @@ -25,8 +25,10 @@ use substrate_api_client::{ Api, GetAccountInformation, GetStorage, }; -// To test this example in CI, we run it against the Substrate kitchensink node. Therefore, we use the AssetRuntimeConfig -// ! Careful: Most runtimes uses plain as tips, they need a polkadot config. +// To test this example with CI we run it against the Substrate kitchensink node, which uses the asset pallet. +// Therefore, we need to use the `AssetRuntimeConfig` in this example. +// ! However, most Substrate runtimes do not use the asset pallet at all. So if you run an example against your own node +// you most likely should use `DefaultRuntimeConfig` instead. type AccountInfo = GenericAccountInfo< ::Index, diff --git a/examples/examples/print_metadata.rs b/examples/examples/print_metadata.rs index 4c61b32f7..5362e7f0a 100644 --- a/examples/examples/print_metadata.rs +++ b/examples/examples/print_metadata.rs @@ -18,8 +18,10 @@ use substrate_api_client::{ac_primitives::AssetRuntimeConfig, rpc::JsonrpseeClient, Api}; -// To test this example in CI, we run it against the Substrate kitchensink node. Therefore, we use the AssetRuntimeConfig -// ! Careful: Most runtimes uses plain as tips, they need a polkadot config. +// To test this example with CI we run it against the Substrate kitchensink node, which uses the asset pallet. +// Therefore, we need to use the `AssetRuntimeConfig` in this example. +// ! However, most Substrate runtimes do not use the asset pallet at all. So if you run an example against your own node +// you most likely should use `DefaultRuntimeConfig` instead. #[tokio::main] async fn main() { diff --git a/examples/examples/staking_batch_payout.rs b/examples/examples/staking_batch_payout.rs index 995843855..e66c2787f 100644 --- a/examples/examples/staking_batch_payout.rs +++ b/examples/examples/staking_batch_payout.rs @@ -24,8 +24,10 @@ use substrate_api_client::{ const MAX_BATCHED_TRANSACTION: u32 = 9; -// To test this example in CI, we run it against the Substrate kitchensink node. Therefore, we use the AssetRuntimeConfig -// ! Careful: Most runtimes uses plain as tips, they need a polkadot config. +// To test this example with CI we run it against the Substrate kitchensink node, which uses the asset pallet. +// Therefore, we need to use the `AssetRuntimeConfig` in this example. +// ! However, most Substrate runtimes do not use the asset pallet at all. So if you run an example against your own node +// you most likely should use `DefaultRuntimeConfig` instead. pub type EraIndex = u32; diff --git a/examples/examples/subscribe_events.rs b/examples/examples/subscribe_events.rs index dc1bc5b74..c068fd635 100644 --- a/examples/examples/subscribe_events.rs +++ b/examples/examples/subscribe_events.rs @@ -26,8 +26,10 @@ use substrate_api_client::{ // Replace this crate by your own if you run a custom substrate node to get your custom events. use kitchensink_runtime::RuntimeEvent; -// To test this example in CI, we run it against the Substrate kitchensink node. Therefore, we use the AssetRuntimeConfig -// ! Careful: Most runtimes uses plain as tips, they need a polkadot config. +// To test this example with CI we run it against the Substrate kitchensink node, which uses the asset pallet. +// Therefore, we need to use the `AssetRuntimeConfig` in this example. +// ! However, most Substrate runtimes do not use the asset pallet at all. So if you run an example against your own node +// you most likely should use `DefaultRuntimeConfig` instead. #[tokio::main] async fn main() { diff --git a/examples/examples/sudo.rs b/examples/examples/sudo.rs index e99983122..e0cb1cdbd 100644 --- a/examples/examples/sudo.rs +++ b/examples/examples/sudo.rs @@ -29,8 +29,10 @@ use substrate_api_client::{ Api, GetAccountInformation, SubmitAndWatch, XtStatus, }; -// To test this example in CI, we run it against the Substrate kitchensink node. Therefore, we use the AssetRuntimeConfig -// ! Careful: Most runtimes uses plain as tips, they need a polkadot config. +// To test this example with CI we run it against the Substrate kitchensink node, which uses the asset pallet. +// Therefore, we need to use the `AssetRuntimeConfig` in this example. +// ! However, most Substrate runtimes do not use the asset pallet at all. So if you run an example against your own node +// you most likely should use `DefaultRuntimeConfig` instead. // Define an extrinsic signer type which sets the generic types of the `GenericExtrinsicSigner`. // This way, the types don't have to be reassigned with every usage of this type and makes diff --git a/examples/examples/transfer_with_tungstenite_client.rs b/examples/examples/transfer_with_tungstenite_client.rs index f50a3ea1b..e60695190 100755 --- a/examples/examples/transfer_with_tungstenite_client.rs +++ b/examples/examples/transfer_with_tungstenite_client.rs @@ -27,8 +27,10 @@ use substrate_api_client::{ Api, GetAccountInformation, SubmitAndWatch, XtStatus, }; -// To test this example in CI, we run it against the Substrate kitchensink node. Therefore, we use the AssetRuntimeConfig -// ! Careful: Most runtimes uses plain as tips, they need a polkadot config. +// To test this example with CI we run it against the Substrate kitchensink node, which uses the asset pallet. +// Therefore, we need to use the `AssetRuntimeConfig` in this example. +// ! However, most Substrate runtimes do not use the asset pallet at all. So if you run an example against your own node +// you most likely should use `DefaultRuntimeConfig` instead. fn main() { env_logger::init(); diff --git a/examples/examples/transfer_with_ws_client.rs b/examples/examples/transfer_with_ws_client.rs index d418e87e0..14581bd07 100755 --- a/examples/examples/transfer_with_ws_client.rs +++ b/examples/examples/transfer_with_ws_client.rs @@ -27,8 +27,10 @@ use substrate_api_client::{ Api, GetAccountInformation, SubmitAndWatch, XtStatus, }; -// To test this example in CI, we run it against the Substrate kitchensink node. Therefore, we use the AssetRuntimeConfig -// ! Careful: Most runtimes uses plain as tips, they need a polkadot config. +// To test this example with CI we run it against the Substrate kitchensink node, which uses the asset pallet. +// Therefore, we need to use the `AssetRuntimeConfig` in this example. +// ! However, most Substrate runtimes do not use the asset pallet at all. So if you run an example against your own node +// you most likely should use `DefaultRuntimeConfig` instead. fn main() { env_logger::init();