lib.rs 12.9 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
// Copyright 2017-2020 Parity Technologies (UK) Ltd.
// This file is part of Polkadot.

// Polkadot 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.

// Polkadot 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 Polkadot.  If not, see <http://www.gnu.org/licenses/>.

17
18
19
20
//! Polkadot Client
//!
//! Provides the [`AbstractClient`] trait that is a super trait that combines all the traits the client implements.
//! There is also the [`Client`] enum that combines all the different clients into one common structure.
21

22
23
use std::sync::Arc;
use sp_api::{ProvideRuntimeApi, CallApiAt, NumberFor};
24
use sp_blockchain::HeaderBackend;
25
use sp_runtime::{
26
	Justifications, generic::{BlockId, SignedBlock}, traits::{Block as BlockT, BlakeTwo256},
27
};
28
use sc_client_api::{Backend as BackendT, BlockchainEvents, KeyIterator, AuxStore, UsageProvider};
29
use sp_storage::{StorageData, StorageKey, ChildInfo, PrefixedStorageKey};
30
use polkadot_primitives::v1::{Block, ParachainHost, AccountId, Nonce, Balance, Header, BlockNumber, Hash};
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
66
67
use sp_consensus::BlockStatus;
use sc_executor::native_executor_instance;

pub type FullBackend = sc_service::TFullBackend<Block>;

pub type FullClient<RuntimeApi, Executor> = sc_service::TFullClient<Block, RuntimeApi, Executor>;

native_executor_instance!(
	pub PolkadotExecutor,
	polkadot_runtime::api::dispatch,
	polkadot_runtime::native_version,
	frame_benchmarking::benchmarking::HostFunctions,
);

#[cfg(feature = "kusama")]
native_executor_instance!(
	pub KusamaExecutor,
	kusama_runtime::api::dispatch,
	kusama_runtime::native_version,
	frame_benchmarking::benchmarking::HostFunctions,
);

#[cfg(feature = "westend")]
native_executor_instance!(
	pub WestendExecutor,
	westend_runtime::api::dispatch,
	westend_runtime::native_version,
	frame_benchmarking::benchmarking::HostFunctions,
);

#[cfg(feature = "rococo")]
native_executor_instance!(
	pub RococoExecutor,
	rococo_runtime::api::dispatch,
	rococo_runtime::native_version,
	frame_benchmarking::benchmarking::HostFunctions,
);
68

69
70
71
/// A set of APIs that polkadot-like runtimes must implement.
pub trait RuntimeApiCollection:
	sp_transaction_pool::runtime_api::TaggedTransactionQueue<Block>
72
	+ sp_api::ApiExt<Block>
73
	+ sp_consensus_babe::BabeApi<Block>
74
	+ sp_finality_grandpa::GrandpaApi<Block>
75
76
77
	+ ParachainHost<Block>
	+ sp_block_builder::BlockBuilder<Block>
	+ frame_system_rpc_runtime_api::AccountNonceApi<Block, AccountId, Nonce>
78
	+ pallet_mmr_primitives::MmrApi<Block, <Block as BlockT>::Hash>
79
80
81
82
	+ pallet_transaction_payment_rpc_runtime_api::TransactionPaymentApi<Block, Balance>
	+ sp_api::Metadata<Block>
	+ sp_offchain::OffchainWorkerApi<Block>
	+ sp_session::SessionKeys<Block>
83
	+ sp_authority_discovery::AuthorityDiscoveryApi<Block>
Andreas Doerr's avatar
Andreas Doerr committed
84
	+ beefy_primitives::BeefyApi<Block>
85
86
87
88
89
90
91
where
	<Self as sp_api::ApiExt<Block>>::StateBackend: sp_api::StateBackend<BlakeTwo256>,
{}

impl<Api> RuntimeApiCollection for Api
where
	Api: sp_transaction_pool::runtime_api::TaggedTransactionQueue<Block>
92
		+ sp_api::ApiExt<Block>
93
		+ sp_consensus_babe::BabeApi<Block>
94
		+ sp_finality_grandpa::GrandpaApi<Block>
95
96
97
		+ ParachainHost<Block>
		+ sp_block_builder::BlockBuilder<Block>
		+ frame_system_rpc_runtime_api::AccountNonceApi<Block, AccountId, Nonce>
98
		+ pallet_mmr_primitives::MmrApi<Block, <Block as BlockT>::Hash>
99
100
101
102
		+ pallet_transaction_payment_rpc_runtime_api::TransactionPaymentApi<Block, Balance>
		+ sp_api::Metadata<Block>
		+ sp_offchain::OffchainWorkerApi<Block>
		+ sp_session::SessionKeys<Block>
103
		+ sp_authority_discovery::AuthorityDiscoveryApi<Block>
Andreas Doerr's avatar
Andreas Doerr committed
104
		+ beefy_primitives::BeefyApi<Block>,
105
106
107
108
109
110
111
	<Self as sp_api::ApiExt<Block>>::StateBackend: sp_api::StateBackend<BlakeTwo256>,
{}

/// Trait that abstracts over all available client implementations.
///
/// For a concrete type there exists [`Client`].
pub trait AbstractClient<Block, Backend>:
112
	BlockchainEvents<Block> + Sized + Send + Sync
113
	+ ProvideRuntimeApi<Block>
114
115
116
	+ HeaderBackend<Block>
	+ CallApiAt<
		Block,
117
		StateBackend = Backend::State
118
	>
119
	+ AuxStore
120
	+ UsageProvider<Block>
121
122
123
	where
		Block: BlockT,
		Backend: BackendT<Block>,
124
125
		Backend::State: sp_api::StateBackend<BlakeTwo256>,
		Self::Api: RuntimeApiCollection<StateBackend = Backend::State>,
126
127
{}

128
impl<Block, Backend, Client> AbstractClient<Block, Backend> for Client
129
130
131
	where
		Block: BlockT,
		Backend: BackendT<Block>,
132
		Backend::State: sp_api::StateBackend<BlakeTwo256>,
133
134
135
136
		Client: BlockchainEvents<Block>
			+ ProvideRuntimeApi<Block>
			+ HeaderBackend<Block>
			+ AuxStore
137
			+ UsageProvider<Block>
138
139
140
			+ Sized
			+ Send
			+ Sync
141
142
			+ CallApiAt<
				Block,
143
144
145
				StateBackend = Backend::State
			>,
		Client::Api: RuntimeApiCollection<StateBackend = Backend::State>,
146
{}
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166

/// Execute something with the client instance.
///
/// As there exist multiple chains inside Polkadot, like Polkadot itself, Kusama, Westend etc,
/// there can exist different kinds of client types. As these client types differ in the generics
/// that are being used, we can not easily return them from a function. For returning them from a
/// function there exists [`Client`]. However, the problem on how to use this client instance still
/// exists. This trait "solves" it in a dirty way. It requires a type to implement this trait and
/// than the [`execute_with_client`](ExecuteWithClient::execute_with_client) function can be called
/// with any possible client instance.
///
/// In a perfect world, we could make a closure work in this way.
pub trait ExecuteWithClient {
	/// The return type when calling this instance.
	type Output;

	/// Execute whatever should be executed with the given client instance.
	fn execute_with_client<Client, Api, Backend>(self, client: Arc<Client>) -> Self::Output
		where
			<Api as sp_api::ApiExt<Block>>::StateBackend: sp_api::StateBackend<BlakeTwo256>,
167
			Backend: sc_client_api::Backend<Block> + 'static,
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
			Backend::State: sp_api::StateBackend<BlakeTwo256>,
			Api: crate::RuntimeApiCollection<StateBackend = Backend::State>,
			Client: AbstractClient<Block, Backend, Api = Api> + 'static;
}

/// A handle to a Polkadot client instance.
///
/// The Polkadot service supports multiple different runtimes (Westend, Polkadot itself, etc). As each runtime has a
/// specialized client, we need to hide them behind a trait. This is this trait.
///
/// When wanting to work with the inner client, you need to use `execute_with`.
///
/// See [`ExecuteWithClient`](trait.ExecuteWithClient.html) for more information.
pub trait ClientHandle {
	/// Execute the given something with the client.
	fn execute_with<T: ExecuteWithClient>(&self, t: T) -> T::Output;
}

186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
macro_rules! with_client {
	{
		$self:ident,
		$client:ident,
		{
			$( $code:tt )*
		}
	} => {
		match $self {
			Self::Polkadot($client) => { $( $code )* },
			#[cfg(feature = "westend")]
			Self::Westend($client) => { $( $code )* },
			#[cfg(feature = "kusama")]
			Self::Kusama($client) => { $( $code )* },
			#[cfg(feature = "rococo")]
			Self::Rococo($client) => { $( $code )* },
		}
	}
}

206
207
208
209
210
/// A client instance of Polkadot.
///
/// See [`ExecuteWithClient`] for more information.
#[derive(Clone)]
pub enum Client {
211
212
213
214
215
216
217
	Polkadot(Arc<FullClient<polkadot_runtime::RuntimeApi, PolkadotExecutor>>),
	#[cfg(feature = "westend")]
	Westend(Arc<FullClient<westend_runtime::RuntimeApi, WestendExecutor>>),
	#[cfg(feature = "kusama")]
	Kusama(Arc<FullClient<kusama_runtime::RuntimeApi, KusamaExecutor>>),
	#[cfg(feature = "rococo")]
	Rococo(Arc<FullClient<rococo_runtime::RuntimeApi, RococoExecutor>>),
218
219
220
221
}

impl ClientHandle for Client {
	fn execute_with<T: ExecuteWithClient>(&self, t: T) -> T::Output {
222
223
224
225
226
		with_client! {
			self,
			client,
			{
				T::execute_with_client::<_, _, FullBackend>(t, client.clone())
227
			}
228
229
230
231
		}
	}
}

232
impl UsageProvider<Block> for Client {
233
	fn usage_info(&self) -> sc_client_api::ClientInfo<Block> {
234
235
236
237
238
239
		with_client! {
			self,
			client,
			{
				client.usage_info()
			}
240
241
242
243
244
245
246
247
248
		}
	}
}

impl sc_client_api::BlockBackend<Block> for Client {
	fn block_body(
		&self,
		id: &BlockId<Block>
	) -> sp_blockchain::Result<Option<Vec<<Block as BlockT>::Extrinsic>>> {
249
250
251
252
253
254
		with_client! {
			self,
			client,
			{
				client.block_body(id)
			}
255
256
257
258
		}
	}

	fn block(&self, id: &BlockId<Block>) -> sp_blockchain::Result<Option<SignedBlock<Block>>> {
259
260
261
262
263
264
		with_client! {
			self,
			client,
			{
				client.block(id)
			}
265
266
267
268
		}
	}

	fn block_status(&self, id: &BlockId<Block>) -> sp_blockchain::Result<BlockStatus> {
269
270
271
272
273
274
		with_client! {
			self,
			client,
			{
				client.block_status(id)
			}
275
276
277
		}
	}

278
	fn justifications(
279
280
		&self,
		id: &BlockId<Block>
281
	) -> sp_blockchain::Result<Option<Justifications>> {
282
283
284
285
286
287
		with_client! {
			self,
			client,
			{
				client.justifications(id)
			}
288
289
290
291
292
293
294
		}
	}

	fn block_hash(
		&self,
		number: NumberFor<Block>
	) -> sp_blockchain::Result<Option<<Block as BlockT>::Hash>> {
295
296
297
298
299
300
		with_client! {
			self,
			client,
			{
				client.block_hash(number)
			}
301
302
		}
	}
303

304
	fn indexed_transaction(
305
306
		&self,
		id: &<Block as BlockT>::Hash
307
	) -> sp_blockchain::Result<Option<Vec<u8>>> {
308
309
310
311
312
313
		with_client! {
			self,
			client,
			{
				client.indexed_transaction(id)
			}
314
315
316
		}
	}

317
318
319
320
	fn block_indexed_body(
		&self,
		id: &BlockId<Block>
	) -> sp_blockchain::Result<Option<Vec<Vec<u8>>>> {
321
322
323
324
325
326
		with_client! {
			self,
			client,
			{
				client.block_indexed_body(id)
			}
327
328
		}
	}
329
330
331
332
333
334
335
336
}

impl sc_client_api::StorageProvider<Block, crate::FullBackend> for Client {
	fn storage(
		&self,
		id: &BlockId<Block>,
		key: &StorageKey,
	) -> sp_blockchain::Result<Option<StorageData>> {
337
338
339
340
341
342
		with_client! {
			self,
			client,
			{
				client.storage(id, key)
			}
343
344
345
346
347
348
349
350
		}
	}

	fn storage_keys(
		&self,
		id: &BlockId<Block>,
		key_prefix: &StorageKey,
	) -> sp_blockchain::Result<Vec<StorageKey>> {
351
352
353
354
355
356
		with_client! {
			self,
			client,
			{
				client.storage_keys(id, key_prefix)
			}
357
358
359
360
361
362
363
364
		}
	}

	fn storage_hash(
		&self,
		id: &BlockId<Block>,
		key: &StorageKey,
	) -> sp_blockchain::Result<Option<<Block as BlockT>::Hash>> {
365
366
367
368
369
370
		with_client! {
			self,
			client,
			{
				client.storage_hash(id, key)
			}
371
372
373
374
375
376
377
378
		}
	}

	fn storage_pairs(
		&self,
		id: &BlockId<Block>,
		key_prefix: &StorageKey,
	) -> sp_blockchain::Result<Vec<(StorageKey, StorageData)>> {
379
380
381
382
383
384
		with_client! {
			self,
			client,
			{
				client.storage_pairs(id, key_prefix)
			}
385
386
387
388
389
390
391
392
393
		}
	}

	fn storage_keys_iter<'a>(
		&self,
		id: &BlockId<Block>,
		prefix: Option<&'a StorageKey>,
		start_key: Option<&StorageKey>,
	) -> sp_blockchain::Result<KeyIterator<'a, <crate::FullBackend as sc_client_api::Backend<Block>>::State, Block>> {
394
395
396
397
398
399
		with_client! {
			self,
			client,
			{
				client.storage_keys_iter(id, prefix, start_key)
			}
400
401
402
403
404
405
406
407
408
		}
	}

	fn child_storage(
		&self,
		id: &BlockId<Block>,
		child_info: &ChildInfo,
		key: &StorageKey,
	) -> sp_blockchain::Result<Option<StorageData>> {
409
410
411
412
413
414
		with_client! {
			self,
			client,
			{
				client.child_storage(id, child_info, key)
			}
415
416
417
418
419
420
421
422
423
		}
	}

	fn child_storage_keys(
		&self,
		id: &BlockId<Block>,
		child_info: &ChildInfo,
		key_prefix: &StorageKey,
	) -> sp_blockchain::Result<Vec<StorageKey>> {
424
425
426
427
428
429
		with_client! {
			self,
			client,
			{
				client.child_storage_keys(id, child_info, key_prefix)
			}
430
431
432
433
434
435
436
437
438
		}
	}

	fn child_storage_hash(
		&self,
		id: &BlockId<Block>,
		child_info: &ChildInfo,
		key: &StorageKey,
	) -> sp_blockchain::Result<Option<<Block as BlockT>::Hash>> {
439
440
441
442
443
444
		with_client! {
			self,
			client,
			{
				client.child_storage_hash(id, child_info, key)
			}
445
446
447
448
449
450
451
452
		}
	}

	fn max_key_changes_range(
		&self,
		first: NumberFor<Block>,
		last: BlockId<Block>,
	) -> sp_blockchain::Result<Option<(NumberFor<Block>, BlockId<Block>)>> {
453
454
455
456
457
458
		with_client! {
			self,
			client,
			{
				client.max_key_changes_range(first, last)
			}
459
460
461
462
463
464
465
466
467
468
		}
	}

	fn key_changes(
		&self,
		first: NumberFor<Block>,
		last: BlockId<Block>,
		storage_key: Option<&PrefixedStorageKey>,
		key: &StorageKey,
	) -> sp_blockchain::Result<Vec<(NumberFor<Block>, u32)>> {
469
470
471
472
473
474
		with_client! {
			self,
			client,
			{
				client.key_changes(first, last, storage_key, key)
			}
475
476
477
478
479
480
		}
	}
}

impl sp_blockchain::HeaderBackend<Block> for Client {
	fn header(&self, id: BlockId<Block>) -> sp_blockchain::Result<Option<Header>> {
481
482
483
484
485
486
		with_client! {
			self,
			client,
			{
				client.header(&id)
			}
487
488
489
490
		}
	}

	fn info(&self) -> sp_blockchain::Info<Block> {
491
492
493
494
495
496
		with_client! {
			self,
			client,
			{
				client.info()
			}
497
498
499
500
		}
	}

	fn status(&self, id: BlockId<Block>) -> sp_blockchain::Result<sp_blockchain::BlockStatus> {
501
502
503
504
505
506
		with_client! {
			self,
			client,
			{
				client.status(id)
			}
507
508
509
510
		}
	}

	fn number(&self, hash: Hash) -> sp_blockchain::Result<Option<BlockNumber>> {
511
512
513
514
515
516
		with_client! {
			self,
			client,
			{
				client.number(hash)
			}
517
518
519
520
		}
	}

	fn hash(&self, number: BlockNumber) -> sp_blockchain::Result<Option<Hash>> {
521
522
523
524
525
526
		with_client! {
			self,
			client,
			{
				client.hash(number)
			}
527
528
529
		}
	}
}