-
Notifications
You must be signed in to change notification settings - Fork 619
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(state-viewer): list accounts with contracts (#8371)
A state viewer command to list all accounts with contracts deployed. So far it only shows the account names and the wasm size. The intention is to extend it for more sophisticated filtering. So far, the command finishes all four shards in 2 minutes on a mainnet archival RocksDB.
- Loading branch information
Showing
6 changed files
with
215 additions
and
0 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,163 @@ | ||
| //! State viewer functions to list and filter accounts that have contracts | ||
| //! deployed. | ||
|
|
||
| use near_primitives::hash::CryptoHash; | ||
| use near_primitives::trie_key::trie_key_parsers::parse_account_id_from_contract_code_key; | ||
| use near_primitives::trie_key::TrieKey; | ||
| use near_primitives::types::AccountId; | ||
| use near_store::{NibbleSlice, StorageError, Trie, TrieTraversalItem}; | ||
| use std::collections::VecDeque; | ||
| use std::sync::Arc; | ||
|
|
||
| /// Output type for contract account queries with all relevant data around a | ||
| /// single contract. | ||
| pub(crate) struct ContractAccount { | ||
| pub(crate) account_id: AccountId, | ||
| pub(crate) source_wasm: Arc<[u8]>, | ||
| } | ||
|
|
||
| #[derive(Debug, thiserror::Error)] | ||
| pub enum ContractAccountError { | ||
| #[error("could not parse key {1:?}")] | ||
| InvalidKey(#[source] std::io::Error, Vec<u8>), | ||
| #[error("failed loading contract code for account {1}")] | ||
| NoCode(#[source] StorageError, AccountId), | ||
| } | ||
|
|
||
| impl std::fmt::Display for ContractAccount { | ||
| fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { | ||
| write!(f, "{:<64} {:>9}", self.account_id, self.source_wasm.len()) | ||
| } | ||
| } | ||
|
|
||
| impl ContractAccount { | ||
| /// Iterate over all contracts stored in the given trie, in lexicographic | ||
| /// order of the account IDs. | ||
| pub(crate) fn in_trie(trie: &Trie) -> anyhow::Result<ContractAccountIterator> { | ||
| ContractAccountIterator::new(trie) | ||
| } | ||
|
|
||
| fn from_contract_trie_node( | ||
| trie_key: &[u8], | ||
| value_hash: CryptoHash, | ||
| trie: &Trie, | ||
| ) -> Result<Self, ContractAccountError> { | ||
| let account_id = parse_account_id_from_contract_code_key(trie_key) | ||
| .map_err(|err| ContractAccountError::InvalidKey(err, trie_key.to_vec()))?; | ||
| let source_wasm = trie | ||
| .storage | ||
| .retrieve_raw_bytes(&value_hash) | ||
| .map_err(|err| ContractAccountError::NoCode(err, account_id.clone()))?; | ||
| Ok(Self { account_id, source_wasm }) | ||
| } | ||
| } | ||
|
|
||
| pub(crate) struct ContractAccountIterator<'a> { | ||
| /// Trie nodes that point to the contracts. | ||
| contract_nodes: VecDeque<TrieTraversalItem>, | ||
| trie: &'a Trie, | ||
| } | ||
|
|
||
| impl<'a> ContractAccountIterator<'a> { | ||
| pub(crate) fn new(trie: &'a Trie) -> anyhow::Result<Self> { | ||
| let mut trie_iter = trie.iter()?; | ||
| // TODO(#8376): Consider changing the interface to TrieKey to make this easier. | ||
| // `TrieKey::ContractCode` requires a valid `AccountId`, we use "xx" | ||
| let key = TrieKey::ContractCode { account_id: "xx".parse()? }.to_vec(); | ||
| let (prefix, suffix) = key.split_at(key.len() - 2); | ||
| assert_eq!(suffix, "xx".as_bytes()); | ||
|
|
||
| // `visit_nodes_interval` wants nibbles stored in `Vec<u8>` as input | ||
| let nibbles_before: Vec<u8> = NibbleSlice::new(prefix).iter().collect(); | ||
| let nibbles_after = { | ||
| let mut tmp = nibbles_before.clone(); | ||
| *tmp.last_mut().unwrap() += 1; | ||
| tmp | ||
| }; | ||
|
|
||
| // finally, use trie iterator to find all contract nodes | ||
| let vec_of_nodes = trie_iter.visit_nodes_interval(&nibbles_before, &nibbles_after)?; | ||
| let contract_nodes = VecDeque::from(vec_of_nodes); | ||
| Ok(Self { contract_nodes, trie }) | ||
| } | ||
| } | ||
|
|
||
| impl Iterator for ContractAccountIterator<'_> { | ||
| type Item = Result<ContractAccount, ContractAccountError>; | ||
|
|
||
| fn next(&mut self) -> Option<Self::Item> { | ||
| while let Some(item) = self.contract_nodes.pop_front() { | ||
| // only look at nodes with a value, ignoring intermediate nodes | ||
| // without values | ||
| if let TrieTraversalItem { hash, key: Some(trie_key) } = item { | ||
| let contract = ContractAccount::from_contract_trie_node(&trie_key, hash, self.trie); | ||
| return Some(contract); | ||
| } | ||
| } | ||
| None | ||
| } | ||
| } | ||
|
|
||
| #[cfg(test)] | ||
| mod tests { | ||
| use super::ContractAccount; | ||
| use near_primitives::trie_key::TrieKey; | ||
| use near_store::test_utils::{create_tries, test_populate_trie}; | ||
| use near_store::{ShardUId, Trie}; | ||
|
|
||
| #[test] | ||
| fn test_three_contracts() { | ||
| let tries = create_tries(); | ||
| let initial = vec![ | ||
| contract_tuple("caroline.near", 3), | ||
| contract_tuple("alice.near", 1), | ||
| contract_tuple("alice.nearx", 2), | ||
| // data right before contracts in trie order | ||
| account_tuple("xeno.near", 1), | ||
| // data right after contracts in trie order | ||
| access_key_tuple("alan.near", 1), | ||
| ]; | ||
| let root = test_populate_trie(&tries, &Trie::EMPTY_ROOT, ShardUId::single_shard(), initial); | ||
| let trie = tries.get_trie_for_shard(ShardUId::single_shard(), root); | ||
|
|
||
| let contract_accounts: Vec<_> = | ||
| ContractAccount::in_trie(&trie).expect("failed creating iterator").collect(); | ||
| assert_eq!(3, contract_accounts.len(), "wrong number of contracts returned by iterator"); | ||
|
|
||
| // expect reordering toe lexicographic order | ||
| let contract1 = contract_accounts[0].as_ref().expect("returned error instead of contract"); | ||
| let contract2 = contract_accounts[1].as_ref().expect("returned error instead of contract"); | ||
| let contract3 = contract_accounts[2].as_ref().expect("returned error instead of contract"); | ||
| assert_eq!(contract1.account_id.as_str(), "alice.near"); | ||
| assert_eq!(contract2.account_id.as_str(), "alice.nearx"); | ||
| assert_eq!(contract3.account_id.as_str(), "caroline.near"); | ||
| assert_eq!(&*contract1.source_wasm, &[1u8, 1, 1]); | ||
| assert_eq!(&*contract2.source_wasm, &[2u8, 2, 2]); | ||
| assert_eq!(&*contract3.source_wasm, &[3u8, 3, 3]); | ||
| } | ||
|
|
||
| /// Create a test contract key-value pair to insert in the test trie. | ||
| fn contract_tuple(account: &str, num: u8) -> (Vec<u8>, Option<Vec<u8>>) { | ||
| ( | ||
| TrieKey::ContractCode { account_id: account.parse().unwrap() }.to_vec(), | ||
| Some(vec![num, num, num]), | ||
| ) | ||
| } | ||
|
|
||
| /// Create a test account key-value pair to insert in the test trie. | ||
| fn account_tuple(account: &str, num: u8) -> (Vec<u8>, Option<Vec<u8>>) { | ||
| (TrieKey::Account { account_id: account.parse().unwrap() }.to_vec(), Some(vec![num, num])) | ||
| } | ||
|
|
||
| /// Create a test access key key-value pair to insert in the test trie. | ||
| fn access_key_tuple(account: &str, num: u8) -> (Vec<u8>, Option<Vec<u8>>) { | ||
| ( | ||
| TrieKey::AccessKey { | ||
| account_id: account.parse().unwrap(), | ||
| public_key: near_crypto::PublicKey::empty(near_crypto::KeyType::ED25519), | ||
| } | ||
| .to_vec(), | ||
| Some(vec![num, num, num, num]), | ||
| ) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters