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

use super::{BigUintApi, ErrorApi, StorageReadApi};
use crate::storage;
use crate::types::{Address, BoxedBytes, EsdtLocalRole, EsdtTokenData, Vec, H256};
use alloc::boxed::Box;

/// Interface to be used by the actual smart contract code.
///
/// Note: contracts and the api are not mutable.
/// They simply pass on/retrieve data to/from the protocol.
/// When mocking the blockchain state, we use the Rc/RefCell pattern
/// to isolate mock state mutability from the contract interface.
pub trait BlockchainApi: StorageReadApi + ErrorApi + Clone + Sized + 'static {
	/// The type of the token balances.
	/// Not named `BigUint` to avoid name collisions in types that implement multiple API traits.
	type BalanceType: BigUintApi + 'static;

	fn get_sc_address(&self) -> Address;

	fn get_owner_address(&self) -> Address;

	fn get_shard_of_address(&self, address: &Address) -> u32;

	fn is_smart_contract(&self, address: &Address) -> bool;

	fn get_caller(&self) -> Address;

	fn get_balance(&self, address: &Address) -> Self::BalanceType;

	fn get_sc_balance(&self) -> Self::BalanceType {
		self.get_balance(&self.get_sc_address())
	}

	fn get_tx_hash(&self) -> H256;

	fn get_gas_left(&self) -> u64;

	fn get_block_timestamp(&self) -> u64;

	fn get_block_nonce(&self) -> u64;

	fn get_block_round(&self) -> u64;

	fn get_block_epoch(&self) -> u64;

	fn get_block_random_seed(&self) -> Box<[u8; 48]>;

	fn get_prev_block_timestamp(&self) -> u64;

	fn get_prev_block_nonce(&self) -> u64;

	fn get_prev_block_round(&self) -> u64;

	fn get_prev_block_epoch(&self) -> u64;

	fn get_prev_block_random_seed(&self) -> Box<[u8; 48]>;

	fn get_current_esdt_nft_nonce(&self, address: &Address, token: &[u8]) -> u64;

	fn get_esdt_balance(&self, address: &Address, token: &[u8], nonce: u64) -> Self::BalanceType;

	fn get_esdt_token_data(
		&self,
		address: &Address,
		token: &[u8],
		nonce: u64,
	) -> EsdtTokenData<Self::BalanceType>;

	/// Retrieves validator rewards, as set by the protocol.
	/// TODO: move to the storage API, once BigUint gets refactored
	#[inline]
	fn get_cumulated_validator_rewards(&self) -> Self::BalanceType {
		storage::storage_get(self.clone(), storage::protected_keys::ELROND_REWARD_KEY)
	}

	/// Retrieves local roles for the token, by reading protected storage.
	#[inline]
	fn get_esdt_local_roles(&self, token_id: &[u8]) -> Vec<EsdtLocalRole> {
		let mut roles = Vec::new();

		let key = [
			storage::protected_keys::ELROND_ESDT_LOCAL_ROLES_KEY,
			token_id,
		]
		.concat();
		let raw_storage = storage::storage_get::<Self, BoxedBytes>(self.clone(), &key);
		let raw_storage_bytes = raw_storage.as_slice();
		let mut current_index = 0;

		while current_index < raw_storage_bytes.len() {
			// first character before each role is a \n, so we skip it
			current_index += 1;

			// next is the length of the role as string
			let role_len = raw_storage_bytes[current_index];
			current_index += 1;

			// next is role's ASCII string representation
			let end_index = current_index + role_len as usize;
			let role_name = &raw_storage_bytes[current_index..end_index];
			current_index = end_index;

			let esdt_local_role = EsdtLocalRole::from(role_name);
			roles.push(esdt_local_role);
		}

		roles
	}
}