Grcov report - command.rs

1

// Copyright (C) Moondance Labs Ltd.

2

// This file is part of Tanssi.

3

4

// Tanssi is free software: you can redistribute it and/or modify

5

// it under the terms of the GNU General Public License as published by

6

// the Free Software Foundation, either version 3 of the License, or

7

// (at your option) any later version.

8

9

// Tanssi is distributed in the hope that it will be useful,

10

// but WITHOUT ANY WARRANTY; without even the implied warranty of

11

// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

12

// GNU General Public License for more details.

13

14

// You should have received a copy of the GNU General Public License

15

// along with Tanssi.  If not, see <http://www.gnu.org/licenses/>.

16

17

use {

18

    crate::{

19

        chain_spec,

20

        cli::{BaseSubcommand, Cli, Subcommand},

21

        service::{self, NodeConfig},

22

},

23

    clap::Parser,

24

    container_chain_template_simple_runtime::Block,

25

    cumulus_client_service::storage_proof_size::HostFunctions as ReclaimHostFunctions,

26

    cumulus_primitives_core::ParaId,

27

    frame_benchmarking_cli::{BenchmarkCmd, SUBSTRATE_REFERENCE_HARDWARE},

28

    log::{info, warn},

29

    node_common::{

30

        chain_spec as node_common_chain_spec, cli::ContainerNodeRelayChainCli,

31

        command::generate_genesis_block, service::node_builder::NodeBuilderConfig as _,

32

},

33

    parity_scale_codec::Encode,

34

    polkadot_service::IdentifyVariant as _,

35

    sc_cli::{ChainSpec, Result, SubstrateCli},

36

    sp_core::hexdisplay::HexDisplay,

37

    sp_runtime::traits::{AccountIdConversion, Block as BlockT, Get},

38

    std::marker::PhantomData,

39

    tc_service_container_chain_rpc_provider::{RpcProviderCmd, RpcProviderMode},

40

    tc_service_container_chain_spawner::cli::ContainerChainCli,

41

};

42

43

pub struct NodeName;

44

45

impl Get<&'static str> for NodeName {

46

    fn get() -> &'static str {

47

        "Simple"

48

49

50

51

78

fn load_spec(id: &str, para_id: ParaId) -> std::result::Result<Box<dyn ChainSpec>, String> {

52

78

    Ok(match id {

53

78

        "dev" => Box::new(chain_spec::development_config(para_id, vec![])),

54

76

        "template-rococo" => Box::new(chain_spec::local_testnet_config(para_id, vec![])),

55

76

        "" | "local" => Box::new(chain_spec::local_testnet_config(para_id, vec![])),

56

57

        // dummy container chain spec, it will not be used to actually spawn a chain

58

76

        "container-chain-unknown" => Box::new(

59

            sc_service::GenericChainSpec::<node_common_chain_spec::Extensions, ()>::builder(

60

                b"",

61

                node_common_chain_spec::Extensions {

62

                    relay_chain: "westend-local".into(),

63

                    para_id: 2000,

64

},

65

66

            .build(),

67

),

68

69

76

        path => Box::new(chain_spec::ChainSpec::from_json_file(

70

76

            std::path::PathBuf::from(path),

71

76

        )?),

72

})

73

78

74

75

impl SubstrateCli for Cli {

76

228

    fn impl_name() -> String {

77

228

        "Container Chain Simple Node".into()

78

228

79

80

385

    fn impl_version() -> String {

81

385

        env!("SUBSTRATE_CLI_IMPL_VERSION").into()

82

385

83

84

78

    fn description() -> String {

85

78

        format!(

86

78

            "Container Chain Simple Node\n\nThe command-line arguments provided first will be \

87

78

        passed to the parachain node, while the arguments provided after -- will be passed \

88

78

        to the relay chain node.\n\n\

89

78

        {} <parachain-args> -- <relay-chain-args>",

90

78

            Self::executable_name()

91

78

92

78

93

94

150

    fn author() -> String {

95

150

        env!("CARGO_PKG_AUTHORS").into()

96

150

97

98

78

    fn support_url() -> String {

99

78

        "https://github.com/paritytech/cumulus/issues/new".into()

100

78

101

102

72

    fn copyright_start_year() -> i32 {

103

72

104

72

105

106

78

    fn load_spec(&self, id: &str) -> std::result::Result<Box<dyn sc_service::ChainSpec>, String> {

107

78

        load_spec(id, self.para_id.unwrap_or(2000).into())

108

78

109

110

111

macro_rules! construct_async_run {

112

    (|$components:ident, $cli:ident, $cmd:ident, $config:ident| $( $code:tt )* ) => {{

113

        let runner = $cli.create_runner($cmd)?;

114

        runner.async_run(|$config| {

115

            let $components = NodeConfig::new_builder(&$config, None)?;

116

            let inner = { $( $code )* };

117

118

            let task_manager = $components.task_manager;

119

            inner.map(|v| (v, task_manager))

120

})

121

}}

122

123

124

/// Parse command line arguments into service configuration.

125

78

pub fn run() -> Result<()> {

126

78

    let cli = Cli::from_args();

127

128

    // Match rpc provider subcommand in wrapper

129

78

    let subcommand = match &cli.subcommand {

130

        Some(Subcommand::RpcProvider(cmd)) => {

131

            return rpc_provider_mode(&cli, cmd);

132

133

6

        Some(Subcommand::Base(cmd)) => Some(cmd),

134

72

        None => None,

135

};

136

137

6

    match subcommand {

138

4

        Some(BaseSubcommand::BuildSpec(cmd)) => {

139

4

            let runner = cli.create_runner(cmd)?;

140

4

            runner.sync_run(|config| {

141

4

                let chain_spec = if let Some(para_id) = cmd.extra.parachain_id {

142

                    if cmd.base.shared_params.dev {

143

                        Box::new(chain_spec::development_config(

144

                            para_id.into(),

145

                            cmd.extra.add_bootnode.clone(),

146

))

147

                    } else {

148

                        Box::new(chain_spec::local_testnet_config(

149

                            para_id.into(),

150

                            cmd.extra.add_bootnode.clone(),

151

))

152

153

                } else {

154

4

                    config.chain_spec

155

};

156

4

                cmd.base.run(chain_spec, config.network)

157

4

})

158

159

        Some(BaseSubcommand::CheckBlock(cmd)) => {

160

            construct_async_run!(|components, cli, cmd, config| {

161

                let (_, import_queue) = service::import_queue(&config, &components);

162

                Ok(cmd.run(components.client, import_queue))

163

})

164

165

        Some(BaseSubcommand::ExportBlocks(cmd)) => {

166

            construct_async_run!(|components, cli, cmd, config| {

167

                Ok(cmd.run(components.client, config.database))

168

})

169

170

        Some(BaseSubcommand::ExportState(cmd)) => {

171

            construct_async_run!(|components, cli, cmd, config| {

172

                Ok(cmd.run(components.client, config.chain_spec))

173

})

174

175

        Some(BaseSubcommand::ImportBlocks(cmd)) => {

176

            construct_async_run!(|components, cli, cmd, config| {

177

                let (_, import_queue) = service::import_queue(&config, &components);

178

                Ok(cmd.run(components.client, import_queue))

179

})

180

181

        Some(BaseSubcommand::Revert(cmd)) => {

182

            construct_async_run!(|components, cli, cmd, config| {

183

                Ok(cmd.run(components.client, components.backend, None))

184

})

185

186

        Some(BaseSubcommand::PurgeChain(cmd)) => {

187

            let runner = cli.create_runner(cmd)?;

188

189

            runner.sync_run(|config| {

190

                let polkadot_cli = ContainerNodeRelayChainCli::<NodeName>::new(

191

                    &config,

192

                    [ContainerNodeRelayChainCli::<NodeName>::executable_name()]

193

                        .iter()

194

                        .chain(cli.relay_chain_args.iter()),

195

);

196

197

                let polkadot_config = SubstrateCli::create_configuration(

198

                    &polkadot_cli,

199

                    &polkadot_cli,

200

                    config.tokio_handle.clone(),

201

202

                .map_err(|err| format!("Relay chain argument error: {}", err))?;

203

204

                cmd.run(config, polkadot_config)

205

})

206

207

        Some(BaseSubcommand::ExportGenesisHead(cmd)) => {

208

            let runner = cli.create_runner(cmd)?;

209

            runner.sync_run(|config| {

210

                let partials = NodeConfig::new_builder(&config, None)?;

211

                cmd.run(partials.client)

212

})

213

214

        Some(BaseSubcommand::ExportGenesisWasm(cmd)) => {

215

            let runner = cli.create_runner(cmd)?;

216

            runner.sync_run(|_config| {

217

                let spec = cli.load_spec(&cmd.shared_params.chain.clone().unwrap_or_default())?;

218

                cmd.run(&*spec)

219

})

220

221

        Some(BaseSubcommand::Benchmark(cmd)) => {

222

            let runner = cli.create_runner(cmd)?;

223

224

            // Switch on the concrete benchmark sub-command-

225

            match cmd {

226

                BenchmarkCmd::Pallet(cmd) => {

227

                    if cfg!(feature = "runtime-benchmarks") {

228

                        runner.sync_run(|config| {

229

                            cmd.run_with_spec::<sp_runtime::traits::HashingFor<Block>, ReclaimHostFunctions>(Some(

230

                                config.chain_spec,

231

))

232

})

233

                    } else {

234

                        Err("Benchmarking wasn't enabled when building the node. \

235

			  You can enable it with `--features runtime-benchmarks`."

236

                            .into())

237

238

239

                BenchmarkCmd::Block(cmd) => runner.sync_run(|config| {

240

                    let partials = NodeConfig::new_builder(&config, None)?;

241

                    cmd.run(partials.client)

242

}),

243

                #[cfg(not(feature = "runtime-benchmarks"))]

244

                BenchmarkCmd::Storage(_) => Err(sc_cli::Error::Input(

245

                    "Compile with --features=runtime-benchmarks \

246

                        to enable storage benchmarks."

247

                        .into(),

248

)),

249

                #[cfg(feature = "runtime-benchmarks")]

250

                BenchmarkCmd::Storage(cmd) => runner.sync_run(|config| {

251

                    let partials = NodeConfig::new_builder(&config, None)?;

252

                    let db = partials.backend.expose_db();

253

                    let storage = partials.backend.expose_storage();

254

                    cmd.run(config, partials.client.clone(), db, storage)

255

}),

256

                BenchmarkCmd::Machine(cmd) => {

257

                    runner.sync_run(|config| cmd.run(&config, SUBSTRATE_REFERENCE_HARDWARE.clone()))

258

259

                // NOTE: this allows the Client to leniently implement

260

                // new benchmark commands without requiring a companion MR.

261

                #[allow(unreachable_patterns)]

262

                _ => Err("Benchmarking sub-command unsupported".into()),

263

264

265

2

        Some(BaseSubcommand::PrecompileWasm(cmd)) => {

266

2

            let runner = cli.create_runner(cmd)?;

267

2

            runner.async_run(|config| {

268

2

                let partials = NodeConfig::new_builder(&config, None)?;

269

2

                Ok((

270

2

                    cmd.run(partials.backend, config.chain_spec),

271

2

                    partials.task_manager,

272

2

))

273

2

})

274

275

        None => {

276

72

            let runner = cli.create_runner(&cli.run.normalize())?;

277

72

            let collator_options = cli.run.collator_options();

278

72

279

72

            runner.run_node_until_exit(|config| async move {

280

72

                let hwbench = (!cli.no_hardware_benchmarks).then(||

281

                    config.database.path().map(|database_path| {

282

                        let _ = std::fs::create_dir_all(database_path);

283

                        sc_sysinfo::gather_hwbench(Some(database_path), &SUBSTRATE_REFERENCE_HARDWARE)

284

72

                    })).flatten();

285

286

72

                let para_id = node_common_chain_spec::Extensions::try_get(&*config.chain_spec)

287

72

                    .map(|e| e.para_id)

288

72

                    .ok_or("Could not find parachain ID in chain-spec.")?;

289

290

72

                let polkadot_cli = ContainerNodeRelayChainCli::<NodeName>::new(

291

72

                    &config,

292

72

                    [ContainerNodeRelayChainCli::<NodeName>::executable_name()].iter().chain(cli.relay_chain_args.iter()),

293

72

);

294

72

295

72

                let extension = node_common_chain_spec::Extensions::try_get(&*config.chain_spec);

296

72

                let relay_chain_id = extension.map(|e| e.relay_chain.clone());

297

298

72

                let dev_service =

299

72

                    config.chain_spec.is_dev() || relay_chain_id == Some("dev-service".to_string());

300

301

72

                let id = ParaId::from(para_id);

302

72

303

72

                if dev_service {

304

72

                    return crate::service::start_dev_node(config, cli.run.sealing, id, hwbench).await

305

72

                        .map_err(Into::into);

306

307

308

309

                let parachain_account =

310

                    AccountIdConversion::<polkadot_primitives::AccountId>::into_account_truncating(&id);

311

312

                // We log both genesis states for reference, as fetching it from runtime would take significant time

313

                let block_state_v0: Block = generate_genesis_block(&*config.chain_spec, sp_runtime::StateVersion::V0)

314

                    .map_err(|e| format!("{:?}", e))?;

315

                let block_state_v1: Block = generate_genesis_block(&*config.chain_spec, sp_runtime::StateVersion::V1)

316

                    .map_err(|e| format!("{:?}", e))?;

317

318

                let genesis_state_v0 = format!("0x{:?}", HexDisplay::from(&block_state_v0.header().encode()));

319

                let genesis_state_v1 = format!("0x{:?}", HexDisplay::from(&block_state_v1.header().encode()));

320

321

                let tokio_handle = config.tokio_handle.clone();

322

                let polkadot_config =

323

                    SubstrateCli::create_configuration(&polkadot_cli, &polkadot_cli, tokio_handle)

324

                        .map_err(|err| format!("Relay chain argument error: {}", err))?;

325

326

                info!("Parachain id: {:?}", id);

327

                info!("Parachain Account: {}", parachain_account);

328

                info!("Parachain genesis state V0: {}", genesis_state_v0);

329

                info!("Parachain genesis state V1: {}", genesis_state_v1);

330

                info!("Is collating: {}", if config.role.is_authority() { "yes" } else { "no" });

331

332

                if let cumulus_client_cli::RelayChainMode::ExternalRpc(rpc_target_urls) =

333

                    collator_options.clone().relay_chain_mode {

334

                    if !rpc_target_urls.is_empty() && !cli.relay_chain_args.is_empty() {

335

                        warn!("Detected relay chain node arguments together with --relay-chain-rpc-url. This command starts a minimal Polkadot node that only uses a network-related subset of all relay chain CLI options.");

336

337

338

339

                match config.network.network_backend.unwrap_or(sc_network::config::NetworkBackendType::Libp2p) {

340

                    sc_network::config::NetworkBackendType::Libp2p => {

341

                        crate::service::start_parachain_node::<sc_network::NetworkWorker<_, _>>(

342

                            config,

343

                            polkadot_config,

344

                            collator_options,

345

id,

346

                            hwbench,

347

348

                            .await

349

                            .map(|r| r.0)

350

                            .map_err(Into::into)

351

352

                    sc_network::config::NetworkBackendType::Litep2p => {

353

                        crate::service::start_parachain_node::<sc_network::Litep2pNetworkBackend>(

354

                            config,

355

                            polkadot_config,

356

                            collator_options,

357

id,

358

                            hwbench,

359

360

                            .await

361

                            .map(|r| r.0)

362

                            .map_err(Into::into)

363

364

365

366

367

144

})

368

369

370

78

371

372

fn rpc_provider_mode(cli: &Cli, cmd: &RpcProviderCmd) -> Result<()> {

373

    let runner = cli.create_runner(&cmd.container_run.normalize())?;

374

375

    runner.run_node_until_exit(|config| async move {

376

        log::info!("Starting in RPC provider mode!");

377

378

        let container_chain_cli = ContainerChainCli {

379

            base: cmd.container_run.clone(),

380

            preloaded_chain_spec: None,

381

};

382

383

        let polkadot_cli = ContainerNodeRelayChainCli::<NodeName>::new(

384

            &config,

385

            [ContainerNodeRelayChainCli::<NodeName>::executable_name()]

386

                .iter()

387

                .chain(cmd.relaychain_args().iter()),

388

);

389

390

        let mut orchestrator_cli = None;

391

        if !cmd.solochain {

392

            orchestrator_cli = Some(cumulus_client_cli::RunCmd::parse_from(

393

                [String::from("orchestrator")]

394

                    .iter()

395

                    .chain(cmd.orchestrator_chain_args().iter()),

396

));

397

398

399

        let generate_rpc_builder =

400

            tc_service_container_chain_spawner::rpc::GenerateSubstrateRpcBuilder::<

401

                container_chain_template_simple_runtime::RuntimeApi,

402

            >::new();

403

404

        RpcProviderMode {

405

            config,

406

            provider_profile_id: cmd.profile_id,

407

            orchestrator_endpoints: cmd.orchestrator_endpoints.clone(),

408

            collator_options: cmd.container_run.collator_options(),

409

            polkadot_cli,

410

            orchestrator_cli,

411

            container_chain_cli,

412

            generate_rpc_builder,

413

            phantom: PhantomData,

414

415

        .run()

416

        .await

417

})

418

419

420

#[cfg(test)]

421

mod tests {

422

    use super::*;

423

424

    #[test]

425

1

    fn same_impl_version() {

426

1

        // Impl version depends on version in Cargo.toml

427

1

        // This is to verify we didn't forget to change one of them

428

1

        let v1 = ContainerChainCli::impl_version();

429

1

        let v2 = Cli::impl_version();

430

1

        // Container chain nodes report the same version for relay chain side as the parachain side

431

1

        let v3 = ContainerNodeRelayChainCli::<NodeName>::impl_version();

432

1

433

1

        assert_eq!(v1, v2);

434

1

        assert_eq!(v1, v3);

435

1

436