fuel-vm 0.66.3

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

use super::*;
use crate::error::PanicOrBug;
use test_case::test_case;

struct GasChargeInput {
    cgas: u64,
    ggas: u64,
    dependent_factor: u64,
}
#[derive(Debug, PartialEq, Eq)]
struct GasChargeOutput {
    cgas: u64,
    ggas: u64,
}
#[test_case(GasChargeInput{cgas: 0, ggas: 0, dependent_factor: 0} => Ok(GasChargeOutput{ cgas: 0, ggas: 0}); "zero")]
#[test_case(GasChargeInput{cgas: 0, ggas: 0, dependent_factor: 1} => Err(PanicOrBug::Panic(PanicReason::OutOfGas)); "no gas")]
#[test_case(GasChargeInput{cgas: 0, ggas: 2, dependent_factor: 1} => Err(PanicOrBug::Panic(PanicReason::OutOfGas)); "no call gas")]
#[test_case(GasChargeInput{cgas: 1, ggas: 1, dependent_factor: 1} => Ok(GasChargeOutput{ cgas: 0, ggas: 0}); "just enough")]
#[test_case(GasChargeInput{cgas: 10, ggas: 15, dependent_factor: 1} => Ok(GasChargeOutput{ cgas: 9, ggas: 14}); "heaps")]
fn test_gas_charge(input: GasChargeInput) -> SimpleResult<GasChargeOutput> {
    let GasChargeInput {
        mut cgas,
        mut ggas,
        dependent_factor,
    } = input;
    let mut cgas = RegMut::new(&mut cgas);
    let mut ggas = RegMut::new(&mut ggas);
    gas_charge(cgas.as_mut(), ggas.as_mut(), dependent_factor).map(|_| GasChargeOutput {
        cgas: *cgas,
        ggas: *ggas,
    })
}

#[test]
fn test_gas_charges_ggas_on_out_of_gas() {
    let mut cgas = 10;
    let mut ggas = 15;
    let gas = 20;
    let mut cgas = RegMut::new(&mut cgas);
    let mut ggas = RegMut::new(&mut ggas);
    let _ = gas_charge(cgas.as_mut(), ggas.as_mut(), gas)
        .expect_err("Gas charge should fail");
    assert_eq!(*ggas, 5);
    assert_eq!(*cgas, 0);
}

struct DepGasChargeInput {
    input: GasChargeInput,
    gas_cost: DependentCost,
}

#[test_case(
    DepGasChargeInput{
        input: GasChargeInput{cgas: 0, ggas: 0, dependent_factor: 0},
        gas_cost: DependentCost::from_units_per_gas(0, 1)
    } => Ok(GasChargeOutput{ cgas: 0, ggas: 0}); "zero"
)]
#[test_case(
    DepGasChargeInput{
        input: GasChargeInput{cgas: 1, ggas: 1, dependent_factor: 0},
        gas_cost: DependentCost::from_units_per_gas(1, 1)
    } => Ok(GasChargeOutput{ cgas: 0, ggas: 0}); "just base"
)]
#[test_case(
    DepGasChargeInput{
        input: GasChargeInput{cgas: 1, ggas: 1, dependent_factor: 1},
        gas_cost: DependentCost::from_units_per_gas(1, 2)
    } => Ok(GasChargeOutput{ cgas: 0, ggas: 0}); "just base with gas"
)]
#[test_case(
    DepGasChargeInput{
        input: GasChargeInput{cgas: 3, ggas: 3, dependent_factor: 8},
        gas_cost: DependentCost::from_units_per_gas(1, 4)
    } => Ok(GasChargeOutput{ cgas: 0, ggas: 0}); "base with gas and a unit"
)]
#[test_case(
    DepGasChargeInput{
        input: GasChargeInput{cgas: 3, ggas: 3, dependent_factor: 5},
        gas_cost: DependentCost::from_units_per_gas(0, 4)
    } => Ok(GasChargeOutput{ cgas: 2, ggas: 2}); "base with gas and a unit and left over"
)]
#[test_case(
    DepGasChargeInput{
        input: GasChargeInput{cgas: 0, ggas: 1, dependent_factor: 0},
        gas_cost: DependentCost::from_units_per_gas(1, 1)
    } => Err(PanicOrBug::Panic(PanicReason::OutOfGas)); "just base with no cgas"
)]
#[test_case(
    DepGasChargeInput{
        input: GasChargeInput{cgas: 5, ggas: 10, dependent_factor: 25},
        gas_cost: DependentCost::from_units_per_gas(1, 5)
    } => Err(PanicOrBug::Panic(PanicReason::OutOfGas)); "unit with not enough cgas"
)]
fn test_dependent_gas_charge(input: DepGasChargeInput) -> SimpleResult<GasChargeOutput> {
    let DepGasChargeInput { input, gas_cost } = input;
    let GasChargeInput {
        mut cgas,
        mut ggas,
        dependent_factor,
    } = input;
    let mut cgas = RegMut::new(&mut cgas);
    let mut ggas = RegMut::new(&mut ggas);

    dependent_gas_charge(cgas.as_mut(), ggas.as_mut(), gas_cost, dependent_factor).map(
        |_| GasChargeOutput {
            cgas: *cgas,
            ggas: *ggas,
        },
    )
}

#[test_case(
    DepGasChargeInput{
        input: GasChargeInput{cgas: 0, ggas: 0, dependent_factor: 0},
        gas_cost: DependentCost::from_units_per_gas(0, 1)
    } => Ok(GasChargeOutput{ cgas: 0, ggas: 0}); "zero"
)]
#[test_case(
    DepGasChargeInput{
        input: GasChargeInput{cgas: 1, ggas: 1, dependent_factor: 0},
        gas_cost: DependentCost::from_units_per_gas(1, 1)
    } => Ok(GasChargeOutput{ cgas: 1, ggas: 1}); "even without base"
)]
#[test_case(
    DepGasChargeInput{
        input: GasChargeInput{cgas: 1, ggas: 1, dependent_factor: 1},
        gas_cost: DependentCost::from_units_per_gas(1, 2)
    } => Ok(GasChargeOutput{ cgas: 1, ggas: 1}); "just base with gas"
)]
#[test_case(
    DepGasChargeInput{
        input: GasChargeInput{cgas: 3, ggas: 3, dependent_factor: 8},
        gas_cost: DependentCost::from_units_per_gas(1, 4)
    } => Ok(GasChargeOutput{ cgas: 1, ggas: 1}); "base with gas and a unit"
)]
#[test_case(
    DepGasChargeInput{
        input: GasChargeInput{cgas: 3, ggas: 3, dependent_factor: 5},
        gas_cost: DependentCost::from_units_per_gas(0, 4)
    } => Ok(GasChargeOutput{ cgas: 2, ggas: 2}); "base with gas and a unit and left over"
)]
#[test_case(
    DepGasChargeInput{
        input: GasChargeInput{cgas: 0, ggas: 1, dependent_factor: 0},
        gas_cost: DependentCost::from_units_per_gas(1, 1)
    } => Ok(GasChargeOutput{ cgas: 0, ggas: 1}); "just base with no cgas"
)]
#[test_case(
    DepGasChargeInput{
        input: GasChargeInput{cgas: 5, ggas: 10, dependent_factor: 25},
        gas_cost: DependentCost::from_units_per_gas(1, 4)
    } => Err(PanicOrBug::Panic(PanicReason::OutOfGas)); "unit with not enough cgas"
)]
fn test_dependent_gas_charge_wihtout_base(
    input: DepGasChargeInput,
) -> SimpleResult<GasChargeOutput> {
    let DepGasChargeInput { input, gas_cost } = input;
    let GasChargeInput {
        mut cgas,
        mut ggas,
        dependent_factor,
    } = input;
    let mut cgas = RegMut::new(&mut cgas);
    let mut ggas = RegMut::new(&mut ggas);
    dependent_gas_charge_without_base(
        cgas.as_mut(),
        ggas.as_mut(),
        gas_cost,
        dependent_factor,
    )
    .map(|_| GasChargeOutput {
        cgas: *cgas,
        ggas: *ggas,
    })
}

#[test]
#[should_panic]
fn vm_panics_on_cgas_gt_ggas() {
    let dependent_factor = 25;
    let gas_cost = DependentCost::from_units_per_gas(1, 5);
    let mut cgas_val = 10;
    let mut ggas_val = 5;
    let mut cgas = RegMut::new(&mut cgas_val);
    let mut ggas = RegMut::new(&mut ggas_val);
    let _ =
        dependent_gas_charge(cgas.as_mut(), ggas.as_mut(), gas_cost, dependent_factor);
}