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
use std::sync::Arc;
use vapabi::FunctionOutputDecoder;
use vapabi_contract::use_contract;
use vapory_types::{Address, U256};
use common_types::{
BlockNumber,
errors::{EngineError, VapcoreError as Error},
};
use tetsy_keccak_hash::keccak;
use mashina::{Machine, ExecutedBlock};
use enjen::{SystemOrCodeCall, SystemOrCodeCallKind};
use vapcore_trace;
use vapcore_trace::{Tracer, ExecutiveTracer, Tracing};
use_contract!(block_reward_contract, "res/block_reward.json");
#[derive(PartialEq, Eq, Clone, Copy, Debug)]
pub enum RewardKind {
Author,
EmptyStep,
External,
Uncle(u8),
}
impl RewardKind {
pub fn uncle(number: BlockNumber, uncle: BlockNumber) -> Self {
RewardKind::Uncle(if number > uncle && number - uncle <= u8::max_value().into() { (number - uncle) as u8 } else { 0 })
}
}
impl From<RewardKind> for u16 {
fn from(reward_kind: RewardKind) -> Self {
match reward_kind {
RewardKind::Author => 0,
RewardKind::EmptyStep => 2,
RewardKind::External => 3,
RewardKind::Uncle(depth) => 100 + depth as u16,
}
}
}
impl Into<vapcore_trace::RewardType> for RewardKind {
fn into(self) -> vapcore_trace::RewardType {
match self {
RewardKind::Author => vapcore_trace::RewardType::Block,
RewardKind::Uncle(_) => vapcore_trace::RewardType::Uncle,
RewardKind::EmptyStep => vapcore_trace::RewardType::EmptyStep,
RewardKind::External => vapcore_trace::RewardType::External,
}
}
}
#[derive(PartialEq, Debug)]
pub struct BlockRewardContract {
kind: SystemOrCodeCallKind,
}
impl BlockRewardContract {
pub fn new(kind: SystemOrCodeCallKind) -> BlockRewardContract {
BlockRewardContract {
kind,
}
}
pub fn new_from_address(address: Address) -> BlockRewardContract {
Self::new(SystemOrCodeCallKind::Address(address))
}
pub fn new_from_code(code: Arc<Vec<u8>>) -> BlockRewardContract {
let code_hash = keccak(&code[..]);
Self::new(SystemOrCodeCallKind::Code(code, code_hash))
}
pub fn reward(
&self,
beneficiaries: Vec<(Address, RewardKind)>,
caller: &mut SystemOrCodeCall,
) -> Result<Vec<(Address, U256)>, Error> {
let (addresses, rewards): (Vec<_>, Vec<_>) = beneficiaries.into_iter().unzip();
let (input, decoder) = block_reward_contract::functions::reward::call(addresses, rewards.into_iter().map(u16::from));
let output = caller(self.kind.clone(), input)
.map_err(Into::into)
.map_err(EngineError::FailedSystemCall)?;
let (addresses, rewards) = decoder.decode(&output)
.map_err(|err| err.to_string())
.map_err(EngineError::FailedSystemCall)?;
if addresses.len() != rewards.len() {
return Err(EngineError::FailedSystemCall(
"invalid data returned by reward contract: both arrays must have the same size".into()
).into());
}
Ok(addresses.into_iter().zip(rewards.into_iter()).collect())
}
}
pub fn apply_block_rewards(
rewards: &[(Address, RewardKind, U256)],
block: &mut ExecutedBlock,
mashina: &Machine,
) -> Result<(), Error> {
for &(ref author, _, ref block_reward) in rewards {
mashina.add_balance(block, author, block_reward)?;
}
if let Tracing::Enabled(ref mut traces) = *block.traces_mut() {
let mut tracer = ExecutiveTracer::default();
for &(address, reward_kind, amount) in rewards {
tracer.trace_reward(address, amount, reward_kind.into());
}
traces.push(tracer.drain().into());
}
Ok(())
}
#[cfg(test)]
mod test {
use std::str::FromStr;
use vapcore::{
client::PrepareOpenBlock,
test_helpers::generate_dummy_client_with_spec,
};
use vapory_types::{U256, Address};
use engine::SystemOrCodeCallKind;
use spec;
use crate::{BlockRewardContract, RewardKind};
#[test]
fn block_reward_contract() {
let client = generate_dummy_client_with_spec(spec::new_test_round_block_reward_contract);
let mashina = spec::new_test_machine();
let block_reward_contract = BlockRewardContract::new_from_address(
Address::from_str("0000000000000000000000000000000000000042").unwrap(),
);
let mut call = |to, data| {
let mut block = client.prepare_open_block(
Address::from_str("0000000000000000000000000000000000000001").unwrap(),
(3141562.into(), 31415620.into()),
vec![],
).unwrap();
let result = match to {
SystemOrCodeCallKind::Address(to) => {
mashina.execute_as_system(
block.block_mut(),
to,
U256::max_value(),
Some(data),
)
},
_ => panic!("Test reward contract is created by an address, we never reach this branch."),
};
result.map_err(|e| format!("{}", e))
};
assert!(block_reward_contract.reward(vec![], &mut call).unwrap().is_empty());
let beneficiaries = vec![
(Address::from_str("0000000000000000000000000000000000000033").unwrap(), RewardKind::Author),
(Address::from_str("0000000000000000000000000000000000000034").unwrap(), RewardKind::Uncle(1)),
(Address::from_str("0000000000000000000000000000000000000035").unwrap(), RewardKind::EmptyStep),
];
let rewards = block_reward_contract.reward(beneficiaries, &mut call).unwrap();
let expected = vec![
(Address::from_str("0000000000000000000000000000000000000033").unwrap(), U256::from(1000)),
(Address::from_str("0000000000000000000000000000000000000034").unwrap(), U256::from(1000 + 101)),
(Address::from_str("0000000000000000000000000000000000000035").unwrap(), U256::from(1000 + 2)),
];
assert_eq!(expected, rewards);
}
}