sp_offchain/lib.rs
1// This file is part of Substrate.
2
3// Copyright (C) Parity Technologies (UK) Ltd.
4// SPDX-License-Identifier: Apache-2.0
5
6// Licensed under the Apache License, Version 2.0 (the "License");
7// you may not use this file except in compliance with the License.
8// You may obtain a copy of the License at
9//
10// http://www.apache.org/licenses/LICENSE-2.0
11//
12// Unless required by applicable law or agreed to in writing, software
13// distributed under the License is distributed on an "AS IS" BASIS,
14// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15// See the License for the specific language governing permissions and
16// limitations under the License.
17
18//! The Offchain Worker runtime api primitives.
19
20#![cfg_attr(not(feature = "std"), no_std)]
21#![warn(missing_docs)]
22
23/// Re-export of parent module scope storage prefix.
24pub use sp_core::offchain::STORAGE_PREFIX;
25
26sp_api::decl_runtime_apis! {
27 /// The offchain worker api.
28 #[api_version(2)]
29 pub trait OffchainWorkerApi {
30 /// Starts the off-chain task for given block number.
31 #[changed_in(2)]
32 fn offchain_worker(number: sp_runtime::traits::NumberFor<Block>);
33
34 /// Starts the off-chain task for given block header.
35 fn offchain_worker(header: &Block::Header);
36 }
37}