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
// Copyright 2019 Conflux Foundation. All rights reserved.
// Conflux is free software and distributed under GNU General Public License.
// See http://www.gnu.org/licenses/

use crate::{
    executive_observer::AddressPocket,
    internal_bail,
    state::State,
    substate::{cleanup_mode, Substate},
};
use cfx_types::{Address, AddressSpaceUtil, U256};
use cfx_vm_types::{self as vm, ActionParams, Spec};

use super::super::components::InternalRefContext;

/// Implementation of `set_sponsor_for_gas(address,uint256)`.
pub fn set_sponsor_for_gas(
    contract_address: Address, upper_bound: U256, params: &ActionParams,
    context: &mut InternalRefContext,
) -> vm::Result<()> {
    let sponsor = &params.sender;

    if !context
        .state
        .exists(&contract_address.with_native_space())?
    {
        internal_bail!("contract address not exist");
    }

    if !context.is_contract_address(&contract_address)? {
        internal_bail!("not allowed to sponsor non-contract account");
    }

    let (spec, state, substate): (&Spec, &mut State, &mut Substate) =
        (context.spec, context.state, context.substate);

    let sponsor_balance = state.balance(&params.address.with_native_space())?;

    if sponsor_balance / U256::from(1000) < upper_bound {
        internal_bail!("sponsor should at least sponsor upper_bound * 1000");
    }

    let prev_sponsor = state.sponsor_for_gas(&contract_address)?;
    let prev_sponsor_balance =
        state.sponsor_balance_for_gas(&contract_address)?;
    let prev_upper_bound = state.sponsor_gas_bound(&contract_address)?;
    // If previous sponsor is not the same as current sponsor, we should try
    // to replace the sponsor. Otherwise, we should try to charge
    // `sponsor_balance`.
    if prev_sponsor.as_ref().map_or_else(
        || !sponsor.is_zero(),
        |prev_sponsor| prev_sponsor != sponsor,
    ) {
        // `sponsor_balance` should exceed previous sponsor's
        // `sponsor_balance`.
        if sponsor_balance <= prev_sponsor_balance {
            internal_bail!("sponsor_balance is not exceed previous sponsor");
        }
        // `upper_bound` should exceed previous sponsor's `upper_bound`,
        // unless previous sponsor's `sponsor_balance` is not able to cover
        // the upper bound.
        if prev_sponsor_balance >= prev_upper_bound
            && upper_bound < prev_upper_bound
        {
            internal_bail!("upper_bound is not exceed previous sponsor");
        }
        // refund to previous sponsor
        if prev_sponsor.is_some() {
            context.tracer.trace_internal_transfer(
                AddressPocket::SponsorBalanceForGas(contract_address),
                AddressPocket::Balance(
                    prev_sponsor.unwrap().with_native_space(),
                ),
                prev_sponsor_balance,
            );
            state.add_balance(
                &prev_sponsor.as_ref().unwrap().with_native_space(),
                &prev_sponsor_balance,
                cleanup_mode(substate, &spec),
            )?;
        }
        context.tracer.trace_internal_transfer(
            AddressPocket::Balance(params.address.with_space(params.space)),
            AddressPocket::SponsorBalanceForGas(contract_address),
            sponsor_balance,
        );
        state.sub_balance(
            &params.address.with_native_space(),
            &sponsor_balance,
            &mut cleanup_mode(substate, &spec),
        )?;
        state.set_sponsor_for_gas(
            &contract_address,
            sponsor,
            &sponsor_balance,
            &upper_bound,
        )?;
    } else {
        // if previous sponsor's `sponsor_balance` is not able to cover
        // the `upper_bound`, we can adjust the `upper_bound` to a smaller
        // one.
        if prev_sponsor_balance >= prev_upper_bound
            && upper_bound < prev_upper_bound
        {
            internal_bail!("cannot change upper_bound to a smaller one");
        }

        context.tracer.trace_internal_transfer(
            AddressPocket::Balance(params.address.with_space(params.space)),
            AddressPocket::SponsorBalanceForGas(contract_address),
            sponsor_balance,
        );
        state.sub_balance(
            &params.address.with_native_space(),
            &sponsor_balance,
            &mut cleanup_mode(substate, &spec),
        )?;
        state.set_sponsor_for_gas(
            &contract_address,
            sponsor,
            &(sponsor_balance + prev_sponsor_balance),
            &upper_bound,
        )?;
    }

    Ok(())
}

/// Implementation of `set_sponsor_for_collateral(address)`.
pub fn set_sponsor_for_collateral(
    contract_address: Address, params: &ActionParams,
    context: &mut InternalRefContext,
) -> vm::Result<()> {
    let sponsor = &params.sender;

    if !context
        .state
        .exists(&contract_address.with_native_space())?
    {
        internal_bail!("contract address not exist");
    }

    if !context.is_contract_address(&contract_address)? {
        internal_bail!("not allowed to sponsor non-contract account");
    }

    let (spec, state, substate): (&Spec, &mut State, &mut Substate) =
        (context.spec, context.state, context.substate);

    let sponsor_balance = state.balance(&params.address.with_native_space())?;

    if sponsor_balance.is_zero() {
        internal_bail!("zero sponsor balance is not allowed");
    }

    let prev_sponsor = state.sponsor_for_collateral(&contract_address)?;
    let prev_sponsor_balance =
        state.sponsor_balance_for_collateral(&contract_address)?;
    let collateral_for_storage =
        state.token_collateral_for_storage(&contract_address)?;
    // If previous sponsor is not the same as current sponsor, we should try
    // to replace the sponsor. Otherwise, we should try to charge
    // `sponsor_balance`.
    let converted_storage_point = if prev_sponsor.as_ref().map_or_else(
        || !sponsor.is_zero(),
        |prev_sponsor| prev_sponsor != sponsor,
    ) {
        // `sponsor_balance` should exceed previous sponsor's
        // `sponsor_balance` + `collateral_for_storage`.
        if sponsor_balance <= prev_sponsor_balance + collateral_for_storage {
            internal_bail!("sponsor_balance is not enough to cover previous sponsor's sponsor_balance and collateral_for_storage");
        }
        // refund to previous sponsor
        if let Some(ref prev_sponsor) = prev_sponsor {
            context.tracer.trace_internal_transfer(
                AddressPocket::SponsorBalanceForStorage(contract_address),
                AddressPocket::Balance(prev_sponsor.with_native_space()),
                prev_sponsor_balance,
            );
            context.tracer.trace_internal_transfer(
                AddressPocket::Balance(params.address.with_space(params.space)),
                AddressPocket::Balance(prev_sponsor.with_native_space()),
                collateral_for_storage,
            );
            state.add_balance(
                &prev_sponsor.with_native_space(),
                &(prev_sponsor_balance + collateral_for_storage),
                cleanup_mode(substate, &spec),
            )?;
        } else {
            assert_eq!(collateral_for_storage, U256::zero());
        }
        context.tracer.trace_internal_transfer(
            AddressPocket::Balance(params.address.with_space(params.space)),
            AddressPocket::SponsorBalanceForStorage(contract_address),
            sponsor_balance - collateral_for_storage,
        );
        state.sub_balance(
            &params.address.with_native_space(),
            &sponsor_balance,
            &mut cleanup_mode(substate, &spec),
        )?;
        state.set_sponsor_for_collateral(
            &contract_address,
            sponsor,
            &(sponsor_balance - collateral_for_storage),
            spec.cip107,
        )?
    } else {
        context.tracer.trace_internal_transfer(
            AddressPocket::Balance(params.address.with_space(params.space)),
            AddressPocket::SponsorBalanceForStorage(contract_address),
            sponsor_balance,
        );
        state.sub_balance(
            &params.address.with_native_space(),
            &sponsor_balance,
            &mut cleanup_mode(substate, &spec),
        )?;
        state.set_sponsor_for_collateral(
            &contract_address,
            sponsor,
            &(sponsor_balance + prev_sponsor_balance),
            spec.cip107,
        )?
    };
    if !converted_storage_point.is_zero() {
        context.tracer.trace_internal_transfer(
            AddressPocket::SponsorBalanceForStorage(contract_address),
            AddressPocket::MintBurn,
            converted_storage_point,
        );
    }
    Ok(())
}

/// Implementation of `addPrivilege(address[])` and
/// `addPrivilegeByAdmin(address,address[])`.
pub fn add_privilege(
    contract: Address, addresses: Vec<Address>, params: &ActionParams,
    state: &mut State, substate: &mut Substate,
) -> vm::Result<()> {
    for user_addr in addresses {
        state.add_to_contract_whitelist(
            contract,
            params.storage_owner,
            user_addr,
            substate,
        )?;
    }

    Ok(())
}

/// Implementation of `removePrivilege(address[])` and
/// `removePrivilegeByAdmin(address,address[])`.
pub fn remove_privilege(
    contract: Address, addresses: Vec<Address>, params: &ActionParams,
    state: &mut State, substate: &mut Substate,
) -> vm::Result<()> {
    for user_addr in addresses {
        state.remove_from_contract_whitelist(
            contract,
            params.storage_owner,
            user_addr,
            substate,
        )?;
    }
    Ok(())
}