essential-vm 0.13.0

The Essential VM
Documentation 
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

use essential_types::Word;
use essential_vm::{
    asm::{self, Op},
    types::{convert::word_4_from_u8_32, ContentAddress},
    GasLimit, Vm,
};
use util::*;

mod util;

#[test]
fn state_read_3_42s() {
    let access = test_access();
    let state = State::new(vec![(
        access.this_solution().predicate_to_solve.contract.clone(),
        vec![
            (vec![0, 0, 0, 0], vec![42]),
            (vec![0, 0, 0, 1], vec![42]),
            (vec![0, 0, 0, 2], vec![42]),
        ],
    )]);
    let mut vm = Vm::default();
    let num_keys = 3;
    let num_words = 3;
    let mem_len = num_keys * 2 + num_words;
    let ops = &[
        asm::Stack::Push(mem_len).into(),
        asm::Memory::Alloc.into(),
        asm::Stack::Push(0).into(), // Key0
        asm::Stack::Push(0).into(), // Key1
        asm::Stack::Push(0).into(), // Key2
        asm::Stack::Push(0).into(), // Key3
        asm::Stack::Push(4).into(), // key length
        asm::Stack::Push(num_keys).into(),
        asm::Stack::Push(0).into(), // mem addr
        asm::Op::StateRead(asm::StateRead::KeyRange),
        asm::TotalControlFlow::Halt.into(),
    ];
    vm.exec_ops(
        ops,
        access.clone(),
        &state,
        &|_: &Op| 1,
        GasLimit::UNLIMITED,
    )
    .unwrap();
    assert_eq!(vm.memory[..].len(), mem_len as usize);
    assert_eq!(&vm.memory[..], &[6, 1, 7, 1, 8, 1, 42, 42, 42]);
}

#[test]
fn state_read_some_none_some() {
    let access = test_access();
    let state = State::new(vec![(
        access.this_solution().predicate_to_solve.contract.clone(),
        vec![(vec![0, 0, 0, 0], vec![42]), (vec![0, 0, 0, 2], vec![42])],
    )]);
    let mut vm = Vm::default();
    let num_keys = 3;
    let num_words = 2;
    let mem_len = num_keys * 2 + num_words;
    let ops = &[
        asm::Stack::Push(mem_len).into(),
        asm::Memory::Alloc.into(),
        asm::Stack::Push(0).into(), // Key0
        asm::Stack::Push(0).into(), // Key1
        asm::Stack::Push(0).into(), // Key2
        asm::Stack::Push(0).into(), // Key3
        asm::Stack::Push(4).into(), // key length
        asm::Stack::Push(num_keys).into(),
        asm::Stack::Push(0).into(), // mem addr
        asm::Op::StateRead(asm::StateRead::KeyRange),
        asm::TotalControlFlow::Halt.into(),
    ];
    vm.exec_ops(
        ops,
        access.clone(),
        &state,
        &|_: &Op| 1,
        GasLimit::UNLIMITED,
    )
    .unwrap();
    assert_eq!(vm.memory[..].len(), mem_len as usize);
    assert_eq!(&vm.memory[..], &[6, 1, 7, 0, 7, 1, 42, 42]);
}

#[test]
fn state_read_ext() {
    let ext_contract_addr = ContentAddress([0x12; 32]);
    let state = State::new(vec![(
        ext_contract_addr.clone(),
        vec![
            (vec![1, 2, 3, 4], vec![40]),
            (vec![1, 2, 3, 5], vec![41]),
            (vec![1, 2, 3, 6], vec![42]),
        ],
    )]);
    let mut vm = Vm::default();
    let num_keys = 3;
    let num_words = 3;
    let mem_len = num_keys * 2 + num_words;
    let [addr0, addr1, addr2, addr3] = word_4_from_u8_32(ext_contract_addr.0);
    let ops = &[
        asm::Stack::Push(mem_len).into(),
        asm::Memory::Alloc.into(),
        asm::Stack::Push(addr0).into(),
        asm::Stack::Push(addr1).into(),
        asm::Stack::Push(addr2).into(),
        asm::Stack::Push(addr3).into(),
        asm::Stack::Push(1).into(), // Key0
        asm::Stack::Push(2).into(), // Key1
        asm::Stack::Push(3).into(), // Key2
        asm::Stack::Push(4).into(), // Key3
        asm::Stack::Push(4).into(), // key length
        asm::Stack::Push(num_keys).into(),
        asm::Stack::Push(0).into(), // mem addr
        asm::Op::StateRead(asm::StateRead::KeyRangeExtern),
        asm::TotalControlFlow::Halt.into(),
    ];
    vm.exec_ops(
        ops,
        test_access().clone(),
        &state,
        &|_: &Op| 1,
        GasLimit::UNLIMITED,
    )
    .unwrap();
    assert_eq!(vm.memory[..].len(), mem_len as usize);
    assert_eq!(&vm.memory[..], &[6, 1, 7, 1, 8, 1, 40, 41, 42]);
}

#[test]
fn state_read_ext_nones() {
    let ext_contract_addr = ContentAddress([0x12; 32]);
    let state = State::new(vec![(ext_contract_addr.clone(), vec![])]);
    let mut vm = Vm::default();
    let num_keys = 3;
    let num_words = 0;
    let mem_len = num_keys * 2 + num_words;
    let [addr0, addr1, addr2, addr3] = word_4_from_u8_32(ext_contract_addr.0);
    let ops = &[
        asm::Stack::Push(mem_len).into(),
        asm::Memory::Alloc.into(),
        asm::Stack::Push(addr0).into(),
        asm::Stack::Push(addr1).into(),
        asm::Stack::Push(addr2).into(),
        asm::Stack::Push(addr3).into(),
        asm::Stack::Push(1).into(), // Key0
        asm::Stack::Push(2).into(), // Key1
        asm::Stack::Push(3).into(), // Key2
        asm::Stack::Push(4).into(), // Key3
        asm::Stack::Push(4).into(), // key length
        asm::Stack::Push(num_keys).into(),
        asm::Stack::Push(0).into(), // mem addr
        asm::Op::StateRead(asm::StateRead::KeyRangeExtern),
        asm::TotalControlFlow::Halt.into(),
    ];
    vm.exec_ops(
        ops,
        test_access().clone(),
        &state,
        &|_: &Op| 1,
        GasLimit::UNLIMITED,
    )
    .unwrap();
    assert_eq!(vm.memory[..].len(), mem_len as usize);
    assert_eq!(&vm.memory[..], &[6, 0, 6, 0, 6, 0]);
}

#[test]
fn state_read_various_size_values() {
    let access = test_access();
    let state = State::new(vec![(
        access.this_solution().predicate_to_solve.contract.clone(),
        vec![
            (vec![0, 0, 0, 0], vec![0; 2]),
            (vec![0, 0, 0, 1], vec![1; 22]),
            (vec![0, 0, 0, 2], vec![2; 14]),
            (vec![0, 0, 0, 4], vec![4; 12]),
        ],
    )]);
    let mut vm = Vm::default();
    let num_keys = 5;
    let num_words = 2 + 22 + 14 + 12;
    let mem_len = num_keys * 2 + num_words;
    let ops = &[
        asm::Stack::Push(mem_len).into(),
        asm::Memory::Alloc.into(),
        asm::Stack::Push(0).into(), // Key0
        asm::Stack::Push(0).into(), // Key1
        asm::Stack::Push(0).into(), // Key2
        asm::Stack::Push(0).into(), // Key3
        asm::Stack::Push(4).into(), // key length
        asm::Stack::Push(num_keys).into(),
        asm::Stack::Push(0).into(), // mem addr
        asm::Op::StateRead(asm::StateRead::KeyRange),
        asm::TotalControlFlow::Halt.into(),
    ];
    vm.exec_ops(
        ops,
        access.clone(),
        &state,
        &|_: &Op| 1,
        GasLimit::UNLIMITED,
    )
    .unwrap();
    assert_eq!(vm.memory[..].len(), mem_len as usize);
    let mut expected = vec![10, 2, 12, 22, 34, 14, 48, 0, 48, 12]; // [index, len]s
    expected.append(&mut vec![0; 2]);
    expected.append(&mut vec![1; 22]);
    expected.append(&mut vec![2; 14]);
    expected.append(&mut vec![4; 12]);
    assert_eq!(Vec::from(vm.memory), expected);
}

#[test]
fn state_read_various_key_sizes() {
    let access = test_access();
    let kv_pairs = vec![
        (vec![0], vec![0; 2]),
        (vec![0, 1], vec![7; 6]),
        (vec![1], vec![1; 22]),
        (vec![0, 0, 0, 0, 0, 2], vec![2; 14]),
        (vec![4; 1000], vec![4; 12]),
    ];
    let state = State::new(vec![(
        access.this_solution().predicate_to_solve.contract.clone(),
        kv_pairs.clone(),
    )]);
    let mut vm = Vm::default();

    // Total memory length is all the index+len pairs for 5 keys, plus the lengths of the 3 values
    // that actually get read from state.
    let mem_len =
        ((5 * 2) + kv_pairs[0].1.len() + kv_pairs[2].1.len() + kv_pairs[3].1.len()) as Word;

    // The second KeyRange memory address is equal to the length of the first KeyRange read, which
    // is three keys from `[0]` and their values.
    let krng2_mem_addr = ((3 * 2) + kv_pairs[0].1.len() + kv_pairs[2].1.len()) as Word;

    let ops = &[
        asm::Stack::Push(mem_len).into(),
        asm::Memory::Alloc.into(),
        asm::Stack::Push(0).into(), // Key0
        asm::Stack::Push(1).into(), // key length
        asm::Stack::Push(3).into(), // num keys
        asm::Stack::Push(0).into(), // mem addr
        asm::Op::StateRead(asm::StateRead::KeyRange),
        asm::Stack::Push(0).into(),
        asm::Stack::Push(0).into(),
        asm::Stack::Push(0).into(),
        asm::Stack::Push(0).into(),
        asm::Stack::Push(0).into(),
        asm::Stack::Push(2).into(),
        asm::Stack::Push(6).into(),              // key length
        asm::Stack::Push(2).into(),              // num keys
        asm::Stack::Push(krng2_mem_addr).into(), // mem addr
        asm::StateRead::KeyRange.into(),
        asm::TotalControlFlow::Halt.into(),
    ];
    vm.exec_ops(
        ops,
        access.clone(),
        &state,
        &|_: &Op| 1,
        GasLimit::UNLIMITED,
    )
    .unwrap();
    // First `KeyRange` result.
    let mut expected = vec![6, 2, 8, 22, 30, 0];
    expected.append(&mut vec![0; 2]);
    expected.append(&mut vec![1; 22]);
    // Second `KeyRange` result.
    let addr = expected.len() as Word + 2 * 2;
    expected.append(&mut vec![addr, 14, addr + 14, 0]);
    expected.append(&mut vec![2; 14]);
    assert_eq!(&vm.memory[..], &expected[..]);
}