1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

// This file is part of Substrate.

// Copyright (C) Parity Technologies (UK) Ltd.
// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0

// This program 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.

// This program 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 this program. If not, see <https://www.gnu.org/licenses/>.

//! Offchain worker related configuration parameters.
//!
//! A subset of configuration parameters which are relevant to
//! the inner working of offchain workers. The usage is solely
//! targeted at handling input parameter parsing providing
//! a reasonable abstraction.

use clap::{ArgAction, Args};
use sc_network::config::Role;
use sc_service::config::OffchainWorkerConfig;

use crate::{error, OffchainWorkerEnabled};

/// Offchain worker related parameters.
#[derive(Debug, Clone, Args)]
pub struct OffchainWorkerParams {
	/// Should execute offchain workers on every block.
	/// By default it's only enabled for nodes that are authoring new blocks.
	#[arg(
		long = "offchain-worker",
		value_name = "ENABLED",
		value_enum,
		ignore_case = true,
		default_value_t = OffchainWorkerEnabled::WhenAuthority
	)]
	pub enabled: OffchainWorkerEnabled,

	/// Enable Offchain Indexing API, which allows block import to write to Offchain DB.
	/// Enables a runtime to write directly to a offchain workers DB during block import.
	#[arg(long = "enable-offchain-indexing", value_name = "ENABLE_OFFCHAIN_INDEXING", default_value_t = false, action = ArgAction::Set)]
	pub indexing_enabled: bool,
}

impl OffchainWorkerParams {
	/// Load spec to `Configuration` from `OffchainWorkerParams` and spec factory.
	pub fn offchain_worker(&self, role: &Role) -> error::Result<OffchainWorkerConfig> {
		let enabled = match (&self.enabled, role) {
			(OffchainWorkerEnabled::WhenAuthority, Role::Authority { .. }) => true,
			(OffchainWorkerEnabled::Always, _) => true,
			(OffchainWorkerEnabled::Never, _) => false,
			(OffchainWorkerEnabled::WhenAuthority, _) => false,
		};

		let indexing_enabled = self.indexing_enabled;
		Ok(OffchainWorkerConfig { enabled, indexing_enabled })
	}
}