Rename OffchainWorker internal method. (#4267)

* Rename generate_extrinsics to offchain_worker

* Some doc improvements.
This commit is contained in:
Tomasz Drwięga
2019-12-03 18:03:27 +01:00
committed by Gavin Wood
parent 2de6f82b8a
commit 3b21f7fdc3
3 changed files with 13 additions and 9 deletions
+1 -1
View File
@@ -311,7 +311,7 @@ where
/// Start an offchain worker and generate extrinsics.
pub fn offchain_worker(n: System::BlockNumber) {
<AllModules as OffchainWorker<System::BlockNumber>>::generate_extrinsics(n)
<AllModules as OffchainWorker<System::BlockNumber>>::offchain_worker(n)
}
}
+2 -2
View File
@@ -1001,7 +1001,7 @@ macro_rules! decl_module {
$crate::sp_runtime::traits::OffchainWorker<$trait_instance::BlockNumber>
for $module<$trait_instance$(, $instance)?> where $( $other_where_bounds )*
{
fn generate_extrinsics(_block_number_not_used: $trait_instance::BlockNumber) { $( $impl )* }
fn offchain_worker(_block_number_not_used: $trait_instance::BlockNumber) { $( $impl )* }
}
};
@@ -1014,7 +1014,7 @@ macro_rules! decl_module {
$crate::sp_runtime::traits::OffchainWorker<$trait_instance::BlockNumber>
for $module<$trait_instance$(, $instance)?> where $( $other_where_bounds )*
{
fn generate_extrinsics($param: $param_ty) { $( $impl )* }
fn offchain_worker($param: $param_ty) { $( $impl )* }
}
};
@@ -346,18 +346,22 @@ pub trait OnInitialize<BlockNumber> {
/// Off-chain computation trait.
///
/// Implementing this trait on a module allows you to perform long-running tasks
/// that make validators generate extrinsics (either transactions or inherents)
/// with the results of those long-running computations.
/// that make (by default) validators generate transactions that feed results
/// of those long-running computations back on chain.
///
/// NOTE: This function runs off-chain, so it can access the block state,
/// but cannot preform any alterations.
/// but cannot preform any alterations. More specifically alterations are
/// not forbidden, but they are not persisted in any way after the worker
/// has finished.
#[impl_for_tuples(30)]
pub trait OffchainWorker<BlockNumber> {
/// This function is being called on every block.
/// This function is being called after every block import (when fully synced).
///
/// Implement this and use special `extern`s to generate transactions or inherents.
/// Implement this and use any of the `Offchain` `sp_io` set of APIs
/// to perform offchain computations, calls and submit transactions
/// with results to trigger any on-chain changes.
/// Any state alterations are lost and are not persisted.
fn generate_extrinsics(_n: BlockNumber) {}
fn offchain_worker(_n: BlockNumber) {}
}
/// Abstraction around hashing