// Copyright 2019 Parity Technologies (UK) Ltd.
// This file is part of Substrate.
// Substrate 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.
// Substrate 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 Substrate. If not, see .
//! Simple transaction factory which distributes tokens from a master
//! account to a specified number of newly created accounts.
//!
//! The factory currently only works on an empty database!
use std::collections::HashMap;
use std::sync::Arc;
use std::cmp::PartialOrd;
use std::fmt::Display;
use log::info;
use client::Client;
use block_builder_api::BlockBuilder;
use sr_api::ConstructRuntimeApi;
use consensus_common::{
BlockOrigin, BlockImportParams, InherentData, ForkChoiceStrategy,
SelectChain
};
use consensus_common::block_import::BlockImport;
use codec::{Decode, Encode};
use primitives::{Blake2Hasher, Hasher};
use sr_primitives::generic::BlockId;
use sr_primitives::traits::{
Block as BlockT, Header as HeaderT, ProvideRuntimeApi, SimpleArithmetic,
One, Zero,
};
pub use crate::modes::Mode;
pub mod modes;
mod complex_mode;
mod simple_modes;
pub trait RuntimeAdapter {
type AccountId: Display;
type Balance: Display + SimpleArithmetic + From;
type Block: BlockT;
type Index: Copy;
type Number: Display + PartialOrd + SimpleArithmetic + Zero + One;
type Phase: Copy;
type Secret;
fn new(mode: Mode, rounds: u64, start_number: u64) -> Self;
fn block_no(&self) -> Self::Number;
fn block_in_round(&self) -> Self::Number;
fn mode(&self) -> &Mode;
fn num(&self) -> Self::Number;
fn rounds(&self) -> Self::Number;
fn round(&self) -> Self::Number;
fn start_number(&self) -> Self::Number;
fn set_block_in_round(&mut self, val: Self::Number);
fn set_block_no(&mut self, val: Self::Number);
fn set_round(&mut self, val: Self::Number);
fn transfer_extrinsic(
&self,
sender: &Self::AccountId,
key: &Self::Secret,
destination: &Self::AccountId,
amount: &Self::Balance,
version: u32,
genesis_hash: &::Hash,
prior_block_hash: &::Hash,
) -> ::Extrinsic;
fn inherent_extrinsics(&self) -> InherentData;
fn minimum_balance() -> Self::Balance;
fn master_account_id() -> Self::AccountId;
fn master_account_secret() -> Self::Secret;
fn extract_index(&self, account_id: &Self::AccountId, block_hash: &::Hash) -> Self::Index;
fn extract_phase(&self, block_hash: ::Hash) -> Self::Phase;
fn gen_random_account_id(seed: &Self::Number) -> Self::AccountId;
fn gen_random_account_secret(seed: &Self::Number) -> Self::Secret;
}
/// Manufactures transactions. The exact amount depends on
/// `mode`, `num` and `rounds`.
pub fn factory(
mut factory_state: RA,
client: &Arc>,
select_chain: &Sc,
) -> cli::error::Result<()>
where
Block: BlockT::Out>,
Exec: client::CallExecutor + Send + Sync + Clone,
Backend: client_api::backend::Backend + Send,
Client: ProvideRuntimeApi,
as ProvideRuntimeApi>::Api:
BlockBuilder,
RtApi: ConstructRuntimeApi> + Send + Sync,
Sc: SelectChain,
RA: RuntimeAdapter,
<::Block as BlockT>::Hash: From,
{
if *factory_state.mode() != Mode::MasterToNToM && factory_state.rounds() > RA::Number::one() {
let msg = "The factory can only be used with rounds set to 1 in this mode.".into();
return Err(cli::error::Error::Input(msg));
}
let best_header: Result<::Header, cli::error::Error> =
select_chain.best_chain().map_err(|e| format!("{:?}", e).into());
let mut best_hash = best_header?.hash();
let mut best_block_id = BlockId::::hash(best_hash);
let version = client.runtime_version_at(&best_block_id)?.spec_version;
let genesis_hash = client.block_hash(Zero::zero())?
.expect("Genesis block always exists; qed").into();
while let Some(block) = match factory_state.mode() {
Mode::MasterToNToM => complex_mode::next::(
&mut factory_state,
&client,
version,
genesis_hash,
best_hash.into(),
best_block_id,
),
_ => simple_modes::next::(
&mut factory_state,
&client,
version,
genesis_hash,
best_hash.into(),
best_block_id,
),
} {
best_hash = block.header().hash();
best_block_id = BlockId::::hash(best_hash);
import_block(&client, block);
info!("Imported block at {}", factory_state.block_no());
}
Ok(())
}
/// Create a baked block from a transfer extrinsic and timestamp inherent.
pub fn create_block(
client: &Arc>,
transfer: ::Extrinsic,
inherent_extrinsics: Vec<::Extrinsic>,
) -> Block
where
Block: BlockT::Out>,
Exec: client::CallExecutor + Send + Sync + Clone,
Backend: client_api::backend::Backend + Send,
Client: ProvideRuntimeApi,
RtApi: ConstructRuntimeApi> + Send + Sync,
as ProvideRuntimeApi>::Api:
BlockBuilder,
RA: RuntimeAdapter,
{
let mut block = client.new_block(Default::default()).expect("Failed to create new block");
block.push(
Decode::decode(&mut &transfer.encode()[..])
.expect("Failed to decode transfer extrinsic")
).expect("Failed to push transfer extrinsic into block");
for inherent in inherent_extrinsics {
block.push(inherent).expect("Failed ...");
}
block.bake().expect("Failed to bake block")
}
fn import_block(
client: &Arc>,
block: Block
) -> () where
Block: BlockT::Out>,
Exec: client::CallExecutor + Send + Sync + Clone,
Backend: client_api::backend::Backend + Send,
{
let import = BlockImportParams {
origin: BlockOrigin::File,
header: block.header().clone(),
post_digests: Vec::new(),
body: Some(block.extrinsics().to_vec()),
finalized: false,
justification: None,
auxiliary: Vec::new(),
fork_choice: ForkChoiceStrategy::LongestChain,
allow_missing_state: false,
};
(&**client).import_block(import, HashMap::new()).expect("Failed to import block");
}