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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
// Copyright 2021-2022 Semantic Network Ltd.
// This file is part of Tidechain.

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

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

use sc_client_api::{Backend as BackendT, BlockchainEvents, KeysIter, PairsIter};
pub use sc_executor::NativeElseWasmExecutor;
use sp_api::{CallApiAt, NumberFor, ProvideRuntimeApi};
use sp_blockchain::HeaderBackend;
use sp_runtime::{
  generic::SignedBlock,
  traits::{BlakeTwo256, Block as BlockT},
  Justifications,
};
use sp_storage::{ChildInfo, StorageData, StorageKey};
use std::sync::Arc;
use tidefi_primitives::{AccountId, Balance, Block, BlockNumber, Hash, Header};

#[cfg(not(any(feature = "tidechain", feature = "lagoon",)))]
compile_error!("at least one runtime feature must be enabled");

#[cfg(feature = "tidechain")]
pub struct TidechainExecutorDispatch;

#[cfg(feature = "tidechain")]
impl sc_executor::NativeExecutionDispatch for TidechainExecutorDispatch {
  type ExtendHostFunctions = frame_benchmarking::benchmarking::HostFunctions;

  fn dispatch(method: &str, data: &[u8]) -> Option<Vec<u8>> {
    tidechain_runtime::dispatch(method, data)
  }

  fn native_version() -> sc_executor::NativeVersion {
    tidechain_runtime::native_version()
  }
}

#[cfg(feature = "lagoon")]
pub struct LagoonExecutorDispatch;

#[cfg(feature = "lagoon")]
impl sc_executor::NativeExecutionDispatch for LagoonExecutorDispatch {
  type ExtendHostFunctions = frame_benchmarking::benchmarking::HostFunctions;

  fn dispatch(method: &str, data: &[u8]) -> Option<Vec<u8>> {
    lagoon_runtime::dispatch(method, data)
  }

  fn native_version() -> sc_executor::NativeVersion {
    lagoon_runtime::native_version()
  }
}

pub type FullBackend = sc_service::TFullBackend<Block>;
pub type FullClient<RuntimeApi, ExecutorDispatch> =
  sc_service::TFullClient<Block, RuntimeApi, NativeElseWasmExecutor<ExecutorDispatch>>;

/// A set of APIs that Tidechain-like runtimes must implement.
pub trait RuntimeApiCollection:
  sp_transaction_pool::runtime_api::TaggedTransactionQueue<Block>
  + sp_api::ApiExt<Block>
  + sp_consensus_babe::BabeApi<Block>
  + sp_consensus_grandpa::GrandpaApi<Block>
  + sp_block_builder::BlockBuilder<Block>
  + frame_system_rpc_runtime_api::AccountNonceApi<Block, AccountId, u32>
  + pallet_transaction_payment_rpc_runtime_api::TransactionPaymentApi<Block, Balance>
  + sp_api::Metadata<Block>
  + sp_offchain::OffchainWorkerApi<Block>
  + sp_session::SessionKeys<Block>
  + sp_authority_discovery::AuthorityDiscoveryApi<Block>
  + pallet_tidefi_rpc::TidefiRuntimeApi<Block, AccountId>
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>
    + sp_api::ApiExt<Block>
    + sp_consensus_babe::BabeApi<Block>
    + sp_consensus_grandpa::GrandpaApi<Block>
    + sp_block_builder::BlockBuilder<Block>
    + frame_system_rpc_runtime_api::AccountNonceApi<Block, AccountId, u32>
    + pallet_transaction_payment_rpc_runtime_api::TransactionPaymentApi<Block, Balance>
    + sp_api::Metadata<Block>
    + sp_offchain::OffchainWorkerApi<Block>
    + sp_session::SessionKeys<Block>
    + sp_authority_discovery::AuthorityDiscoveryApi<Block>
    + pallet_tidefi_rpc::TidefiRuntimeApi<Block, AccountId>,
  <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>:
  BlockchainEvents<Block>
  + Sized
  + Send
  + Sync
  + ProvideRuntimeApi<Block>
  + HeaderBackend<Block>
  + CallApiAt<Block, StateBackend = Backend::State>
where
  Block: BlockT,
  Backend: BackendT<Block>,
  Backend::State: sp_api::StateBackend<BlakeTwo256>,
  Self::Api: RuntimeApiCollection<StateBackend = Backend::State>,
{
}

impl<Block, Backend, Client> AbstractClient<Block, Backend> for Client
where
  Block: BlockT,
  Backend: BackendT<Block>,
  Backend::State: sp_api::StateBackend<BlakeTwo256>,
  Client: BlockchainEvents<Block>
    + ProvideRuntimeApi<Block>
    + HeaderBackend<Block>
    + Sized
    + Send
    + Sync
    + CallApiAt<Block, StateBackend = Backend::State>,
  Client::Api: RuntimeApiCollection<StateBackend = Backend::State>,
{
}

/// 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>,
    Backend: sc_client_api::Backend<Block> + 'static,
    Backend::State: sp_api::StateBackend<BlakeTwo256>,
    Api: RuntimeApiCollection<StateBackend = Backend::State>,
    Client: AbstractClient<Block, Backend, Api = Api> + 'static;
}

/// A handle to a Tidechain client instance.
///
/// The Tidechain service supports multiple different runtimes (Lagoon, Tidechain 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;
}

/// A client instance of Tidechain.
///
/// See [`ExecuteWithClient`] for more information.
#[derive(Clone)]
pub enum Client {
  #[cfg(feature = "tidechain")]
  Tidechain(Arc<FullClient<tidechain_runtime::RuntimeApi, TidechainExecutorDispatch>>),
  #[cfg(feature = "lagoon")]
  Lagoon(Arc<FullClient<lagoon_runtime::RuntimeApi, LagoonExecutorDispatch>>),
}

macro_rules! with_client {
	{
		$self:ident,
		$client:ident,
		{
			$( $code:tt )*
		}
	} => {
		match $self {
			#[cfg(feature = "tidechain")]
			Self::Tidechain($client) => { $( $code )* },
			#[cfg(feature = "lagoon")]
			Self::Lagoon($client) => { $( $code )* },
		}
	}
}

impl ClientHandle for Client {
  fn execute_with<T: ExecuteWithClient>(&self, t: T) -> T::Output {
    with_client! {
      self,
      client,
      {
        T::execute_with_client::<_, _, FullBackend>(t, client.clone())
      }
    }
  }
}

impl sc_client_api::UsageProvider<Block> for Client {
  fn usage_info(&self) -> sc_client_api::ClientInfo<Block> {
    with_client! {
      self,
      client,
      {
        client.usage_info()
      }
    }
  }
}

impl sc_client_api::BlockBackend<Block> for Client {
  fn block_body(
    &self,
    id: Hash,
  ) -> sp_blockchain::Result<Option<Vec<<Block as BlockT>::Extrinsic>>> {
    with_client! {
      self,
      client,
      {
        client.block_body(id)
      }
    }
  }

  fn block(&self, id: Hash) -> sp_blockchain::Result<Option<SignedBlock<Block>>> {
    with_client! {
      self,
      client,
      {
        client.block(id)
      }
    }
  }

  fn block_status(&self, id: Hash) -> sp_blockchain::Result<sp_consensus::BlockStatus> {
    with_client! {
      self,
      client,
      {
        client.block_status(id)
      }
    }
  }

  fn justifications(&self, id: Hash) -> sp_blockchain::Result<Option<Justifications>> {
    with_client! {
      self,
      client,
      {
        client.justifications(id)
      }
    }
  }

  fn block_hash(
    &self,
    number: NumberFor<Block>,
  ) -> sp_blockchain::Result<Option<<Block as BlockT>::Hash>> {
    with_client! {
      self,
      client,
      {
        client.block_hash(number)
      }
    }
  }

  fn indexed_transaction(&self, id: Hash) -> sp_blockchain::Result<Option<Vec<u8>>> {
    with_client! {
      self,
      client,
      {
        client.indexed_transaction(id)
      }
    }
  }

  fn block_indexed_body(&self, id: Hash) -> sp_blockchain::Result<Option<Vec<Vec<u8>>>> {
    with_client! {
      self,
      client,
      {
        client.block_indexed_body(id)
      }
    }
  }

  fn requires_full_sync(&self) -> bool {
    with_client! {
      self,
      client,
      {
        client.requires_full_sync()
      }
    }
  }
}

impl sc_client_api::StorageProvider<Block, FullBackend> for Client {
  fn storage(&self, id: Hash, key: &StorageKey) -> sp_blockchain::Result<Option<StorageData>> {
    with_client! {
      self,
      client,
      {
        client.storage(id, key)
      }
    }
  }

  fn storage_keys(
    &self,
    id: Hash,
    key_prefix: Option<&StorageKey>,
    start_key: Option<&StorageKey>,
  ) -> sp_blockchain::Result<KeysIter<<FullBackend as sc_client_api::Backend<Block>>::State, Block>>
  {
    with_client! {
      self,
      client,
      {
        client.storage_keys(id, key_prefix, start_key)
      }
    }
  }

  fn storage_hash(
    &self,
    id: Hash,
    key: &StorageKey,
  ) -> sp_blockchain::Result<Option<<Block as BlockT>::Hash>> {
    with_client! {
      self,
      client,
      {
         client.storage_hash(id, key)
      }
    }
  }

  fn storage_pairs(
    &self,
    hash: <Block as BlockT>::Hash,
    key_prefix: Option<&StorageKey>,
    start_key: Option<&StorageKey>,
  ) -> sp_blockchain::Result<PairsIter<<FullBackend as sc_client_api::Backend<Block>>::State, Block>>
  {
    with_client! {
      self,
      client,
      {
        client.storage_pairs(hash, key_prefix, start_key)
      }
    }
  }

  fn child_storage(
    &self,
    id: Hash,
    child_info: &ChildInfo,
    key: &StorageKey,
  ) -> sp_blockchain::Result<Option<StorageData>> {
    with_client! {
      self,
      client,
      {
        client.child_storage(id, child_info, key)
      }
    }
  }

  fn child_storage_keys(
    &self,
    hash: <Block as BlockT>::Hash,
    child_info: ChildInfo,
    prefix: Option<&StorageKey>,
    start_key: Option<&StorageKey>,
  ) -> sp_blockchain::Result<KeysIter<<FullBackend as sc_client_api::Backend<Block>>::State, Block>>
  {
    with_client! {
      self,
      client,
      {
        client.child_storage_keys(hash, child_info, prefix, start_key)
      }
    }
  }

  fn child_storage_hash(
    &self,
    id: Hash,
    child_info: &ChildInfo,
    key: &StorageKey,
  ) -> sp_blockchain::Result<Option<<Block as BlockT>::Hash>> {
    with_client! {
      self,
      client,
      {
        client.child_storage_hash(id, child_info, key)
      }
    }
  }
}

impl sp_blockchain::HeaderBackend<Block> for Client {
  fn header(&self, id: Hash) -> sp_blockchain::Result<Option<Header>> {
    with_client! {
      self,
      client,
      {
        client.header(id)
      }
    }
  }

  fn info(&self) -> sp_blockchain::Info<Block> {
    with_client! {
      self,
      client,
      {
        client.info()
      }
    }
  }

  fn status(&self, id: Hash) -> sp_blockchain::Result<sp_blockchain::BlockStatus> {
    with_client! {
      self,
      client,
      {
        client.status(id)
      }
    }
  }

  fn number(&self, hash: Hash) -> sp_blockchain::Result<Option<BlockNumber>> {
    with_client! {
      self,
      client,
      {
        client.number(hash)
      }
    }
  }

  fn hash(&self, number: BlockNumber) -> sp_blockchain::Result<Option<Hash>> {
    with_client! {
      self,
      client,
      {
        client.hash(number)
      }
    }
  }
}