client/
state_dump.rs

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
use crate::common::initialize_not_light_node_modules;
use cfx_config::Configuration;
use cfx_rpc_eth_types::{AccountState, StateDump, EOA_STORAGE_ROOT_H256};
use cfx_rpc_primitives::Bytes;
use cfx_statedb::{StateDbExt, StateDbGeneric};
use cfx_storage::state_manager::StateManagerTrait;
use cfx_types::{Address, Space, H256, U256};
use cfxcore::NodeType;
use chrono::Utc;
use keccak_hash::{keccak, KECCAK_EMPTY};
use parking_lot::{Condvar, Mutex};
use primitives::{
    Account, SkipInputCheck, StorageKey, StorageKeyWithSpace, StorageValue,
};
use rlp::Rlp;
use std::{
    collections::{BTreeMap, HashMap},
    fs,
    ops::Deref,
    path::Path,
    sync::Arc,
    thread,
    time::Duration,
};

pub struct StateDumpConfig {
    pub start_address: Address,
    pub limit: u64,
    pub block: Option<u64>,
    pub no_code: bool,
    pub no_storage: bool,
    pub out_put_path: String,
}

// This method will read all data (k, v) from the Conflux state tree (including
// core space and espace accounts, code, storage, deposit, vote_list) into
// memory at once, then parse and assemble them and assemble all account states
// into a StateDump struct and return it
pub fn dump_whole_state(
    conf: &mut Configuration, exit_cond_var: Arc<(Mutex<bool>, Condvar)>,
    config: &StateDumpConfig,
) -> Result<StateDump, String> {
    let (mut state_db, state_root) =
        prepare_state_db(conf, exit_cond_var, config)?;

    let accounts =
        export_space_accounts(&mut state_db, Space::Ethereum, config)
            .map_err(|e| e.to_string())?;

    let state_dump = StateDump {
        root: state_root,
        accounts,
        next: None,
    };

    Ok(state_dump)
}

// This method will iterate through the entire state tree, storing each found
// account in a temporary map After iterating through all accounts, it will
// retrieve the code and storage for each account, then call the callback method
// Pass the AccountState as a parameter to the callback method, which will
// handle the AccountState
pub fn iterate_dump_whole_state<F: Fn(AccountState)>(
    conf: &mut Configuration, exit_cond_var: Arc<(Mutex<bool>, Condvar)>,
    config: &StateDumpConfig, callback: F,
) -> Result<H256, String> {
    let (mut state_db, state_root) =
        prepare_state_db(conf, exit_cond_var, config)?;

    export_space_accounts_with_callback(
        &mut state_db,
        Space::Ethereum,
        config,
        callback,
    )
    .map_err(|e| e.to_string())?;

    Ok(state_root)
}

fn prepare_state_db(
    conf: &mut Configuration, exit_cond_var: Arc<(Mutex<bool>, Condvar)>,
    config: &StateDumpConfig,
) -> Result<(StateDbGeneric, H256), String> {
    println("Preparing state...");
    let (
        data_man,
        _,
        _,
        consensus,
        sync_service,
        _,
        _,
        _,
        _,
        _,
        _,
        _,
        _,
        _,
        _,
        _,
    ) = initialize_not_light_node_modules(
        conf,
        exit_cond_var,
        NodeType::Archive,
    )?;

    while sync_service.catch_up_mode() {
        thread::sleep(Duration::from_secs(1));
    }

    /*
    1. Get the state at the target epoch, or the latest state if target_epoch is None
    2. Iterate through the state, and dump the account state
    */

    let state_manager = data_man.storage_manager.clone();
    let target_height = match config.block {
        Some(epoch) => epoch,
        None => consensus.latest_confirmed_epoch_number(),
    };

    let epoch_hash = consensus
        .get_hash_from_epoch_number(target_height.into())
        .map_err(|e| e.to_string())?;

    let block = consensus
        .get_phantom_block_by_hash(&epoch_hash, false)?
        .expect("Failed to get block");

    let state_root = block.pivot_header.deferred_state_root();

    let state_index = data_man
        .get_state_readonly_index(&epoch_hash)
        .ok_or("Failed to get state index")?;

    let state = state_manager
        .get_state_no_commit(state_index, true, Some(Space::Ethereum))
        .map_err(|e| e.to_string())?
        .ok_or("Failed to get state")?;

    let state_db = StateDbGeneric::new(state);

    Ok((state_db, state_root.clone()))
}

fn export_space_accounts(
    state: &mut StateDbGeneric, space: Space, config: &StateDumpConfig,
) -> Result<BTreeMap<Address, AccountState>, Box<dyn std::error::Error>> {
    println("Start to iterate state...");
    let empty_key = StorageKey::EmptyKey.with_space(space);
    let kv_pairs = state.read_all(empty_key, None)?;

    let mut accounts_map = BTreeMap::new();
    let mut codes_map = HashMap::new();
    let mut storage_map = HashMap::new();

    for (key, value) in kv_pairs {
        let storage_key_with_space =
            StorageKeyWithSpace::from_key_bytes::<SkipInputCheck>(&key);
        if storage_key_with_space.space != space {
            continue;
        }
        match storage_key_with_space.key {
            StorageKey::AccountKey(address_bytes) => {
                let address = Address::from_slice(address_bytes);
                println(&format!("Find account: {:?}", address));
                let account =
                    Account::new_from_rlp(address, &Rlp::new(&value))?;
                accounts_map.insert(address, account);
            }
            StorageKey::CodeKey {
                address_bytes,
                code_hash_bytes: _,
            } => {
                if config.no_code {
                    continue;
                }

                let address = Address::from_slice(address_bytes);
                let code = Bytes(value.to_vec());
                codes_map.insert(address, code);
            }
            StorageKey::StorageKey {
                address_bytes,
                storage_key,
            } => {
                if config.no_storage {
                    continue;
                }

                let address = Address::from_slice(address_bytes);
                let h256_storage_key = H256::from_slice(storage_key);
                let storage_value_with_owner: StorageValue =
                    rlp::decode(&value)?;
                let account_storage_map =
                    storage_map.entry(address).or_insert(BTreeMap::new());
                account_storage_map
                    .insert(h256_storage_key, storage_value_with_owner.value);
            }
            _ => {
                continue;
            }
        }
    }

    let mut accounts = BTreeMap::new();

    for (address, account) in accounts_map {
        let is_contract = account.code_hash != KECCAK_EMPTY;
        // conflux state tree don't have storage root, so we use a fixed value
        let root = EOA_STORAGE_ROOT_H256;
        let address_hash = keccak(address);

        let code = if is_contract {
            codes_map.get(&address).cloned()
        } else {
            if let Some(code) = codes_map.get(&address) {
                println(&format!("no-contract account have code: {:?}", code));
            }
            None
        };

        let storage = if is_contract {
            storage_map.get(&address).cloned()
        } else {
            if let Some(_storage) = storage_map.get(&address) {
                println(&format!("no-contract account have storage"));
            }
            None
        };

        let account_state = AccountState {
            balance: account.balance,
            nonce: account.nonce.as_u64(),
            root,
            code_hash: account.code_hash,
            code,
            storage,
            address: Some(address),
            address_hash: Some(address_hash),
        };

        accounts.insert(address, account_state);

        if config.limit > 0 && accounts.len() >= config.limit as usize {
            break;
        }
    }

    Ok(accounts)
}

pub fn export_space_accounts_with_callback<F: Fn(AccountState)>(
    state: &mut StateDbGeneric, space: Space, config: &StateDumpConfig,
    callback: F,
) -> Result<(), Box<dyn std::error::Error>> {
    println("Start to iterate state...");
    let mut found_accounts = 0;
    let mut core_space_key_count: u64 = 0;
    let mut total_key_count: u64 = 0;

    for i in 0..=255 {
        let prefix = [i];
        let start_key = StorageKey::AddressPrefixKey(&prefix).with_space(space);

        let mut account_states = BTreeMap::new();

        let mut inner_callback = |(key, value): (Vec<u8>, Box<[u8]>)| {
            total_key_count += 1;

            if total_key_count % 10000 == 0 {
                println(&format!(
                    "total_key_count: {}, core_space_key_count: {}",
                    total_key_count, core_space_key_count
                ));
            }

            let storage_key_with_space =
                StorageKeyWithSpace::from_key_bytes::<SkipInputCheck>(&key);
            if storage_key_with_space.space != space {
                core_space_key_count += 1;
                return;
            }

            if let StorageKey::AccountKey(address_bytes) =
                storage_key_with_space.key
            {
                let address = Address::from_slice(address_bytes);
                println(&format!("Find account: {:?}", address));
                let account = Account::new_from_rlp(address, &Rlp::new(&value))
                    .expect("Failed to decode account");

                account_states.insert(address, account);
            }
        };

        state.read_all_with_callback(start_key, &mut inner_callback, true)?;

        if account_states.len() > 0 {
            println("Start to read account code and storage data...");
        }

        for (_address, account) in account_states {
            let account_state =
                get_account_state(state, &account, config, space)?;
            callback(account_state);
            found_accounts += 1;
            if config.limit > 0 && found_accounts >= config.limit as usize {
                break;
            }
        }
    }

    Ok(())
}

#[allow(unused)]
fn get_account_state(
    state: &mut StateDbGeneric, account: &Account, config: &StateDumpConfig,
    space: Space,
) -> Result<AccountState, Box<dyn std::error::Error>> {
    let address = account.address();

    let is_contract = account.code_hash != KECCAK_EMPTY;
    // get code
    let code = if is_contract && !config.no_code {
        state
            .get_code(address, &account.code_hash)?
            .map(|code_info| Bytes(code_info.code.deref().to_vec()))
    } else {
        None
    };

    let storage = if is_contract && !config.no_storage {
        let storage =
            get_contract_storage(state, &address.address, space, config)?;
        Some(storage)
    } else {
        None
    };

    // conflux state tree don't have storage root, so we use a fixed value
    let root = EOA_STORAGE_ROOT_H256;

    let address_hash = keccak(address.address);

    Ok(AccountState {
        balance: account.balance,
        nonce: account.nonce.as_u64(),
        root,
        code_hash: account.code_hash,
        code,
        storage,
        address: Some(address.address),
        address_hash: Some(address_hash),
    })
}

fn get_contract_storage(
    state: &mut StateDbGeneric, address: &Address, space: Space,
    config: &StateDumpConfig,
) -> Result<BTreeMap<H256, U256>, Box<dyn std::error::Error>> {
    let mut storage: BTreeMap<H256, U256> = Default::default();
    let mut chunk_count = 0;

    let mut inner_callback = |(key, value): (Vec<u8>, Box<[u8]>)| {
        let storage_key_with_space =
            StorageKeyWithSpace::from_key_bytes::<SkipInputCheck>(&key);
        if storage_key_with_space.space != space {
            return;
        }

        if let StorageKey::StorageKey {
            address_bytes: _,
            storage_key,
        } = storage_key_with_space.key
        {
            let h256_storage_key = H256::from_slice(storage_key);
            let storage_value_with_owner: StorageValue =
                rlp::decode(&value).expect("Failed to decode storage value");
            storage.insert(h256_storage_key, storage_value_with_owner.value);

            if storage.len() == 5000_000 {
                chunk_count += 1;
                let name = format!("{:?}-chunk{}.json", address, chunk_count);
                let file_path = Path::new(&config.out_put_path).join(&name);
                let json_content = serde_json::to_string_pretty(&storage)
                    .expect("Failed to serialize storage");
                fs::write(&file_path, json_content)
                    .expect("Failed to write storage file");
                storage.clear();
            }
        };
    };

    let start_key = StorageKey::new_storage_root_key(address).with_space(space);
    state.read_all_with_callback(start_key, &mut inner_callback, false)?;

    Ok(storage)
}

fn println(message: &str) {
    println!("[{}] {}", Utc::now().format("%Y-%m-%d %H:%M:%S"), message);
}