fuel-vm 0.35.4

FuelVM interpreter.
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
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
use crate::{
    interpreter::memory::Memory,
    storage::MemoryStorage,
};
use std::iter;

use super::*;
use crate::interpreter::PanicContext;
use fuel_storage::StorageAsMut;
use fuel_types::Salt;
use test_case::test_case;

#[test_case(false, 0, None, 0, [0; 32] => Ok(()); "Burn nothing")]
#[test_case(false, 0, 0, 0, [0; 32] => Ok(()); "Burn is idempotent")]
#[test_case(false, 0, 100, 100, [0; 32] => Ok(()); "Burn all")]
#[test_case(false, 0, 100, 100, [15; 32] => Ok(()); "Burn all for another sub id")]
#[test_case(false, 0, 100, 10, [0; 32] => Ok(()); "Burn some")]
#[test_case(true, 0, 100, 10, [0; 32] => Err(RuntimeError::Recoverable(PanicReason::ExpectedInternalContext)); "Can't burn from external context")]
#[test_case(false, 1, 100, 10, [0; 32] => Err(RuntimeError::Recoverable(PanicReason::NotEnoughBalance)); "Can't burn when contract id not in memory")]
#[test_case(false, 0, 100, 101, [0; 32] => Err(RuntimeError::Recoverable(PanicReason::NotEnoughBalance)); "Can't burn too much")]
#[test_case(false, 0, None, 1, [0; 32] => Err(RuntimeError::Recoverable(PanicReason::NotEnoughBalance)); "Can't burn when no balance")]
fn test_burn(
    external: bool,
    fp: Word,
    initialize: impl Into<Option<Word>>,
    amount: Word,
    sub_id: [u8; 32],
) -> Result<(), RuntimeError> {
    let mut storage = MemoryStorage::new(Default::default(), Default::default());
    let mut memory: Memory<MEM_SIZE> = vec![1u8; MEM_SIZE].try_into().unwrap();
    let contract_id = ContractId::from([3u8; 32]);
    memory[0..ContractId::LEN].copy_from_slice(contract_id.as_slice());
    memory[ContractId::LEN..ContractId::LEN + Bytes32::LEN]
        .copy_from_slice(sub_id.as_slice());
    let sub_id = Bytes32::from(sub_id);
    let asset_id = contract_id.asset_id(&sub_id);
    let initialize = initialize.into();
    if let Some(initialize) = initialize {
        storage
            .merkle_contract_asset_id_balance_insert(&contract_id, &asset_id, initialize)
            .unwrap();
    }
    let context = if external {
        Context::Script {
            block_height: Default::default(),
        }
    } else {
        Context::Call {
            block_height: Default::default(),
        }
    };
    let mut receipts = Default::default();
    let mut script = Some(fuel_tx::Script::default());

    let is = 0;
    const ORIGINAL_PC: Word = 4;
    let mut pc = ORIGINAL_PC;
    BurnCtx {
        storage: &mut storage,
        context: &context,
        append: AppendReceipt {
            receipts: &mut receipts,
            script: script.as_mut(),
            tx_offset: 0,
            memory: &mut memory,
        },
        fp: Reg::new(&fp),
        pc: RegMut::new(&mut pc),
        is: Reg::new(&is),
    }
    .burn(amount, ContractId::LEN as Word)?;
    assert_eq!(pc, 8);
    let result = storage
        .merkle_contract_asset_id_balance(&contract_id, &asset_id)
        .unwrap()
        .unwrap();
    assert_eq!(result, initialize.unwrap_or(0) - amount);
    assert_eq!(receipts.len(), 1);
    assert_eq!(
        receipts[0],
        Receipt::Burn {
            sub_id,
            contract_id,
            val: amount,
            pc: ORIGINAL_PC,
            is
        }
    );
    Ok(())
}

#[test_case(false, 0, None, 0, [0; 32] => Ok(()); "Mint nothing")]
#[test_case(false, 0, 0, 0, [0; 32] => Ok(()); "Mint is idempotent")]
#[test_case(false, 0, 100, 0, [0; 32] => Ok(()); "Mint is idempotent any")]
#[test_case(false, 0, 100, 100, [0; 32] => Ok(()); "Mint Double")]
#[test_case(false, 0, 100, 100, [15; 32] => Ok(()); "Mint Double for another sub id")]
#[test_case(false, 0, 100, 10, [0; 32] => Ok(()); "Mint some")]
#[test_case(false, 0, None, 10, [0; 32] => Ok(()); "Mint some from nothing")]
#[test_case(false, 0, 0, 10, [0; 32] => Ok(()); "Mint some from zero")]
#[test_case(false, 0, None, Word::MAX, [0; 32] => Ok(()); "Mint max from nothing")]
#[test_case(false, 0, 0, Word::MAX, [0; 32] => Ok(()); "Mint max from zero")]
#[test_case(true, 0, 100, 10, [0; 32] => Err(RuntimeError::Recoverable(PanicReason::ExpectedInternalContext)); "Can't mint from external context")]
#[test_case(false, 0, 1, Word::MAX, [0; 32] => Err(RuntimeError::Recoverable(PanicReason::ArithmeticOverflow)); "Can't mint too much")]
fn test_mint(
    external: bool,
    fp: Word,
    initialize: impl Into<Option<Word>>,
    amount: Word,
    sub_id: [u8; 32],
) -> Result<(), RuntimeError> {
    let mut storage = MemoryStorage::new(Default::default(), Default::default());
    let mut memory: Memory<MEM_SIZE> = vec![1u8; MEM_SIZE].try_into().unwrap();
    let contract_id = ContractId::from([3u8; 32]);
    memory[0..ContractId::LEN].copy_from_slice(contract_id.as_slice());
    memory[ContractId::LEN..ContractId::LEN + Bytes32::LEN]
        .copy_from_slice(sub_id.as_slice());
    let sub_id = Bytes32::from(sub_id);
    let asset_id = contract_id.asset_id(&sub_id);
    let initialize = initialize.into();
    if let Some(initialize) = initialize {
        storage
            .merkle_contract_asset_id_balance_insert(&contract_id, &asset_id, initialize)
            .unwrap();
    }
    let context = if external {
        Context::Script {
            block_height: Default::default(),
        }
    } else {
        Context::Call {
            block_height: Default::default(),
        }
    };

    let mut receipts = Default::default();
    let mut script = Some(fuel_tx::Script::default());

    let is = 0;
    const ORIGINAL_PC: Word = 4;
    let mut pc = ORIGINAL_PC;
    MintCtx {
        storage: &mut storage,
        context: &context,
        append: AppendReceipt {
            receipts: &mut receipts,
            script: script.as_mut(),
            tx_offset: 0,
            memory: &mut memory,
        },
        fp: Reg::new(&fp),
        pc: RegMut::new(&mut pc),
        is: Reg::new(&is),
    }
    .mint(amount, ContractId::LEN as Word)?;
    assert_eq!(pc, 8);
    let result = storage
        .merkle_contract_asset_id_balance(&contract_id, &asset_id)
        .unwrap()
        .unwrap();
    assert_eq!(result, initialize.unwrap_or(0) + amount);
    assert_eq!(receipts.len(), 1);
    assert_eq!(
        receipts[0],
        Receipt::Mint {
            sub_id,
            contract_id,
            val: amount,
            pc: ORIGINAL_PC,
            is
        }
    );
    Ok(())
}

#[test]
fn test_block_hash() {
    let storage = MemoryStorage::new(Default::default(), Default::default());
    let mut memory: Memory<MEM_SIZE> = vec![1u8; MEM_SIZE].try_into().unwrap();
    let owner = OwnershipRegisters {
        sp: 1000,
        ssp: 1,
        hp: 2000,
        prev_hp: 3000,
        context: Context::Script {
            block_height: Default::default(),
        },
    };
    let mut pc = 4;
    block_hash(&storage, &mut memory, owner, RegMut::new(&mut pc), 20, 40).unwrap();
    assert_eq!(pc, 8);
    assert_ne!(memory[20..20 + 32], [1u8; 32]);
}

#[test]
fn test_block_height() {
    let context = Context::Script {
        block_height: 20.into(),
    };
    let mut pc = 4;
    let mut result = 0;
    block_height(&context, RegMut::new(&mut pc), &mut result).unwrap();
    assert_eq!(pc, 8);
    assert_eq!(result, 20);
}

#[test]
fn test_coinbase() {
    let storage = MemoryStorage::new(Default::default(), Default::default());
    let mut memory: Memory<MEM_SIZE> = vec![1u8; MEM_SIZE].try_into().unwrap();
    let owner = OwnershipRegisters {
        sp: 1000,
        ssp: 1,
        hp: 2000,
        prev_hp: 3000,
        context: Context::Script {
            block_height: Default::default(),
        },
    };
    let mut pc = 4;
    coinbase(&storage, &mut memory, owner, RegMut::new(&mut pc), 20).unwrap();
    assert_eq!(pc, 8);
    assert_eq!(memory[20..20 + 32], [0u8; 32]);
}

#[test]
fn test_code_root() {
    let contract_id = ContractId::new([3u8; ContractId::LEN]);
    let mut storage = MemoryStorage::new(Default::default(), Default::default());
    let mut memory: Memory<MEM_SIZE> = vec![1u8; MEM_SIZE].try_into().unwrap();
    memory[0..ContractId::LEN].copy_from_slice(contract_id.as_slice());
    let owner = OwnershipRegisters {
        sp: 1000,
        ssp: 1,
        hp: 2000,
        prev_hp: 3000,
        context: Context::Script {
            block_height: Default::default(),
        },
    };
    let mut pc = 4;
    let input_contracts = vec![contract_id];
    let mut panic_context = PanicContext::None;
    CodeRootCtx {
        memory: &mut memory,
        input_contracts: InputContracts::new(input_contracts.iter(), &mut panic_context),
        storage: &storage,
        owner,
        pc: RegMut::new(&mut pc),
    }
    .code_root(20, 0)
    .expect_err("Contract is not found");
    assert_eq!(pc, 4);

    storage
        .storage_contract_root_insert(
            &ContractId::from([3u8; 32]),
            &Salt::from([5u8; 32]),
            &Bytes32::from([6u8; 32]),
        )
        .unwrap();
    let owner = OwnershipRegisters {
        sp: 1000,
        ssp: 1,
        hp: 2000,
        prev_hp: 3000,
        context: Context::Script {
            block_height: Default::default(),
        },
    };
    CodeRootCtx {
        memory: &mut memory,
        input_contracts: InputContracts::new(input_contracts.iter(), &mut panic_context),
        storage: &storage,
        owner,
        pc: RegMut::new(&mut pc),
    }
    .code_root(20, 0)
    .unwrap();
    assert_eq!(pc, 8);
    assert_eq!(memory[20..20 + 32], [6u8; 32]);

    let owner = OwnershipRegisters {
        sp: 1000,
        ssp: 1,
        hp: 2000,
        prev_hp: 3000,
        context: Context::Script {
            block_height: Default::default(),
        },
    };
    CodeRootCtx {
        memory: &mut memory,
        input_contracts: InputContracts::new(iter::empty(), &mut panic_context),
        storage: &storage,
        owner,
        pc: RegMut::new(&mut pc),
    }
    .code_root(20, 0)
    .expect_err("Contract is not in inputs");
}

#[test]
fn test_code_size() {
    let contract_id = ContractId::new([3u8; ContractId::LEN]);
    let mut storage = MemoryStorage::new(Default::default(), Default::default());
    let mut memory: Memory<MEM_SIZE> = vec![1u8; MEM_SIZE].try_into().unwrap();
    memory[0..ContractId::LEN].copy_from_slice(contract_id.as_slice());
    StorageAsMut::storage::<ContractsRawCode>(&mut storage)
        .write(&ContractId::from([3u8; 32]), vec![1u8; 100])
        .unwrap();
    let mut pc = 4;
    let is = 0;
    let mut cgas = 0;
    let mut ggas = 0;
    let input_contract = vec![contract_id];
    let mut panic_context = PanicContext::None;
    let input = CodeSizeCtx {
        storage: &mut storage,
        memory: &mut memory,
        gas_cost: DependentCost {
            base: 0,
            dep_per_unit: 0,
        },
        profiler: &mut Profiler::default(),
        input_contracts: InputContracts::new(input_contract.iter(), &mut panic_context),
        current_contract: None,
        cgas: RegMut::new(&mut cgas),
        ggas: RegMut::new(&mut ggas),
        pc: RegMut::new(&mut pc),
        is: Reg::new(&is),
    };
    let mut result = 0;
    input
        .code_size(&mut result, 1)
        .expect_err("Contract is not found");
    assert_eq!(pc, 4);

    let input = CodeSizeCtx {
        storage: &mut storage,
        memory: &mut memory,
        gas_cost: DependentCost {
            base: 0,
            dep_per_unit: 0,
        },
        input_contracts: InputContracts::new(input_contract.iter(), &mut panic_context),
        profiler: &mut Profiler::default(),
        current_contract: None,
        cgas: RegMut::new(&mut cgas),
        ggas: RegMut::new(&mut ggas),
        pc: RegMut::new(&mut pc),
        is: Reg::new(&is),
    };
    let mut result = 0;
    input.code_size(&mut result, 0).unwrap();
    assert_eq!(pc, 8);
    assert_eq!(result, 100);

    let input = CodeSizeCtx {
        storage: &mut storage,
        memory: &mut memory,
        gas_cost: DependentCost {
            base: 0,
            dep_per_unit: 0,
        },
        input_contracts: InputContracts::new(iter::empty(), &mut panic_context),
        profiler: &mut Profiler::default(),
        current_contract: None,
        cgas: RegMut::new(&mut cgas),
        ggas: RegMut::new(&mut ggas),
        pc: RegMut::new(&mut pc),
        is: Reg::new(&is),
    };
    let mut result = 0;
    input
        .code_size(&mut result, 0)
        .expect_err("The contract is not in the input");
}

#[test]
fn test_timestamp() {
    let storage = MemoryStorage::new(Default::default(), Default::default());
    let mut pc = 4;
    let mut result = 0;
    timestamp(
        &storage,
        Default::default(),
        RegMut::new(&mut pc),
        &mut result,
        1,
    )
    .expect_err("Height is greater then current block height");
    timestamp(
        &storage,
        u32::MAX.into(),
        RegMut::new(&mut pc),
        &mut result,
        u32::MAX as Word + 1,
    )
    .expect_err("Height doesn't fit into a u32");
    assert_eq!(pc, 4);

    timestamp(
        &storage,
        Default::default(),
        RegMut::new(&mut pc),
        &mut result,
        0,
    )
    .unwrap();
    assert_eq!(pc, 8);

    timestamp(&storage, 20.into(), RegMut::new(&mut pc), &mut result, 19).unwrap();
    assert_eq!(pc, 12);
}