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
use {
crate::{
bpf_loader_upgradeable,
message::{legacy::is_builtin_key_or_sysvar, v0, AccountKeys},
pubkey::Pubkey,
},
std::{borrow::Cow, collections::HashSet},
};
#[derive(Debug, Clone)]
pub struct LoadedMessage<'a> {
pub message: Cow<'a, v0::Message>,
pub loaded_addresses: Cow<'a, LoadedAddresses>,
pub is_writable_account_cache: Vec<bool>,
}
#[derive(Clone, Default, Debug, PartialEq, Eq, Serialize, Deserialize)]
pub struct LoadedAddresses {
pub writable: Vec<Pubkey>,
pub readonly: Vec<Pubkey>,
}
impl FromIterator<LoadedAddresses> for LoadedAddresses {
fn from_iter<T: IntoIterator<Item = LoadedAddresses>>(iter: T) -> Self {
let (writable, readonly): (Vec<Vec<Pubkey>>, Vec<Vec<Pubkey>>) = iter
.into_iter()
.map(|addresses| (addresses.writable, addresses.readonly))
.unzip();
LoadedAddresses {
writable: writable.into_iter().flatten().collect(),
readonly: readonly.into_iter().flatten().collect(),
}
}
}
impl LoadedAddresses {
pub fn is_empty(&self) -> bool {
self.len() == 0
}
pub fn len(&self) -> usize {
self.writable.len().saturating_add(self.readonly.len())
}
}
impl<'a> LoadedMessage<'a> {
pub fn new(message: v0::Message, loaded_addresses: LoadedAddresses) -> Self {
let mut loaded_message = Self {
message: Cow::Owned(message),
loaded_addresses: Cow::Owned(loaded_addresses),
is_writable_account_cache: Vec::default(),
};
loaded_message.set_is_writable_account_cache();
loaded_message
}
pub fn new_borrowed(message: &'a v0::Message, loaded_addresses: &'a LoadedAddresses) -> Self {
let mut loaded_message = Self {
message: Cow::Borrowed(message),
loaded_addresses: Cow::Borrowed(loaded_addresses),
is_writable_account_cache: Vec::default(),
};
loaded_message.set_is_writable_account_cache();
loaded_message
}
fn set_is_writable_account_cache(&mut self) {
let is_writable_account_cache = self
.account_keys()
.iter()
.enumerate()
.map(|(i, _key)| self.is_writable_internal(i))
.collect::<Vec<_>>();
let _ = std::mem::replace(
&mut self.is_writable_account_cache,
is_writable_account_cache,
);
}
pub fn account_keys(&self) -> AccountKeys {
AccountKeys::new(&self.message.account_keys, Some(&self.loaded_addresses))
}
pub fn static_account_keys(&self) -> &[Pubkey] {
&self.message.account_keys
}
pub fn has_duplicates(&self) -> bool {
let mut uniq = HashSet::new();
self.account_keys().iter().any(|x| !uniq.insert(x))
}
fn is_writable_index(&self, key_index: usize) -> bool {
let header = &self.message.header;
let num_account_keys = self.message.account_keys.len();
let num_signed_accounts = usize::from(header.num_required_signatures);
if key_index >= num_account_keys {
let loaded_addresses_index = key_index.saturating_sub(num_account_keys);
loaded_addresses_index < self.loaded_addresses.writable.len()
} else if key_index >= num_signed_accounts {
let num_unsigned_accounts = num_account_keys.saturating_sub(num_signed_accounts);
let num_writable_unsigned_accounts = num_unsigned_accounts
.saturating_sub(usize::from(header.num_readonly_unsigned_accounts));
let unsigned_account_index = key_index.saturating_sub(num_signed_accounts);
unsigned_account_index < num_writable_unsigned_accounts
} else {
let num_writable_signed_accounts = num_signed_accounts
.saturating_sub(usize::from(header.num_readonly_signed_accounts));
key_index < num_writable_signed_accounts
}
}
fn is_writable_internal(&self, key_index: usize) -> bool {
if self.is_writable_index(key_index) {
if let Some(key) = self.account_keys().get(key_index) {
return !(is_builtin_key_or_sysvar(key) || self.demote_program_id(key_index));
}
}
false
}
pub fn is_writable(&self, key_index: usize) -> bool {
*self
.is_writable_account_cache
.get(key_index)
.unwrap_or(&false)
}
pub fn is_signer(&self, i: usize) -> bool {
i < self.message.header.num_required_signatures as usize
}
pub fn demote_program_id(&self, i: usize) -> bool {
self.is_key_called_as_program(i) && !self.is_upgradeable_loader_present()
}
pub fn is_key_called_as_program(&self, key_index: usize) -> bool {
if let Ok(key_index) = u8::try_from(key_index) {
self.message
.instructions
.iter()
.any(|ix| ix.program_id_index == key_index)
} else {
false
}
}
pub fn is_upgradeable_loader_present(&self) -> bool {
self.account_keys()
.iter()
.any(|&key| key == bpf_loader_upgradeable::id())
}
}
#[cfg(test)]
mod tests {
use {
super::*,
crate::{instruction::CompiledInstruction, message::MessageHeader, system_program, sysvar},
itertools::Itertools,
};
fn check_test_loaded_message() -> (LoadedMessage<'static>, [Pubkey; 6]) {
let key0 = Pubkey::new_unique();
let key1 = Pubkey::new_unique();
let key2 = Pubkey::new_unique();
let key3 = Pubkey::new_unique();
let key4 = Pubkey::new_unique();
let key5 = Pubkey::new_unique();
let message = LoadedMessage::new(
v0::Message {
header: MessageHeader {
num_required_signatures: 2,
num_readonly_signed_accounts: 1,
num_readonly_unsigned_accounts: 1,
},
account_keys: vec![key0, key1, key2, key3],
..v0::Message::default()
},
LoadedAddresses {
writable: vec![key4],
readonly: vec![key5],
},
);
(message, [key0, key1, key2, key3, key4, key5])
}
#[test]
fn test_has_duplicates() {
let message = check_test_loaded_message().0;
assert!(!message.has_duplicates());
}
#[test]
fn test_has_duplicates_with_dupe_keys() {
let create_message_with_dupe_keys = |mut keys: Vec<Pubkey>| {
LoadedMessage::new(
v0::Message {
account_keys: keys.split_off(2),
..v0::Message::default()
},
LoadedAddresses {
writable: keys.split_off(2),
readonly: keys,
},
)
};
let key0 = Pubkey::new_unique();
let key1 = Pubkey::new_unique();
let key2 = Pubkey::new_unique();
let key3 = Pubkey::new_unique();
let dupe_key = Pubkey::new_unique();
let keys = vec![key0, key1, key2, key3, dupe_key, dupe_key];
let keys_len = keys.len();
for keys in keys.into_iter().permutations(keys_len).unique() {
let message = create_message_with_dupe_keys(keys);
assert!(message.has_duplicates());
}
}
#[test]
fn test_is_writable_index() {
let message = check_test_loaded_message().0;
assert!(message.is_writable_index(0));
assert!(!message.is_writable_index(1));
assert!(message.is_writable_index(2));
assert!(!message.is_writable_index(3));
assert!(message.is_writable_index(4));
assert!(!message.is_writable_index(5));
}
#[test]
fn test_is_writable() {
solana_logger::setup();
let create_message_with_keys = |keys: Vec<Pubkey>| {
LoadedMessage::new(
v0::Message {
header: MessageHeader {
num_required_signatures: 1,
num_readonly_signed_accounts: 0,
num_readonly_unsigned_accounts: 1,
},
account_keys: keys[..2].to_vec(),
..v0::Message::default()
},
LoadedAddresses {
writable: keys[2..=2].to_vec(),
readonly: keys[3..].to_vec(),
},
)
};
let key0 = Pubkey::new_unique();
let key1 = Pubkey::new_unique();
let key2 = Pubkey::new_unique();
{
let message = create_message_with_keys(vec![sysvar::clock::id(), key0, key1, key2]);
assert!(message.is_writable_index(0));
assert!(!message.is_writable(0));
}
{
let message = create_message_with_keys(vec![system_program::id(), key0, key1, key2]);
assert!(message.is_writable_index(0));
assert!(!message.is_writable(0));
}
{
let message = create_message_with_keys(vec![key0, key1, system_program::id(), key2]);
assert!(message.is_writable_index(2));
assert!(!message.is_writable(2));
}
}
#[test]
fn test_demote_writable_program() {
let key0 = Pubkey::new_unique();
let key1 = Pubkey::new_unique();
let key2 = Pubkey::new_unique();
let message = LoadedMessage::new(
v0::Message {
header: MessageHeader {
num_required_signatures: 1,
num_readonly_signed_accounts: 0,
num_readonly_unsigned_accounts: 0,
},
account_keys: vec![key0],
instructions: vec![CompiledInstruction {
program_id_index: 2,
accounts: vec![1],
data: vec![],
}],
..v0::Message::default()
},
LoadedAddresses {
writable: vec![key1, key2],
readonly: vec![],
},
);
assert!(message.is_writable_index(2));
assert!(!message.is_writable(2));
}
}