testnumbat_wasm/api/
blockchain_api.rs

1use super::{ErrorApi, ManagedTypeApi};
2use crate::types::{
3    Address, BigUint, DcdtTokenData, ManagedAddress, ManagedByteArray, TokenIdentifier, H256,
4};
5use alloc::boxed::Box;
6
7/// Interface to be used by the actual smart contract code.
8///
9/// Note: contracts and the api are not mutable.
10/// They simply pass on/retrieve data to/from the protocol.
11/// When mocking the blockchain state, we use the Rc/RefCell pattern
12/// to isolate mock state mutability from the contract interface.
13pub trait BlockchainApi: ErrorApi + ManagedTypeApi + Clone + Sized + 'static {
14    fn get_caller_legacy(&self) -> Address;
15
16    fn get_caller(&self) -> ManagedAddress<Self> {
17        ManagedAddress::from_address(self.clone(), &self.get_caller_legacy())
18    }
19
20    fn get_sc_address_legacy(&self) -> Address;
21
22    fn get_sc_address(&self) -> ManagedAddress<Self> {
23        ManagedAddress::from_address(self.clone(), &self.get_sc_address_legacy())
24    }
25
26    fn get_owner_address_legacy(&self) -> Address;
27
28    fn get_owner_address(&self) -> ManagedAddress<Self> {
29        ManagedAddress::from_address(self.clone(), &self.get_owner_address_legacy())
30    }
31
32    fn get_shard_of_address_legacy(&self, address: &Address) -> u32;
33
34    fn get_shard_of_address(&self, address: &ManagedAddress<Self>) -> u32 {
35        self.get_shard_of_address_legacy(&address.to_address())
36    }
37
38    fn is_smart_contract_legacy(&self, address: &Address) -> bool;
39
40    fn is_smart_contract(&self, address: &ManagedAddress<Self>) -> bool {
41        self.is_smart_contract_legacy(&address.to_address())
42    }
43
44    fn get_balance_legacy(&self, address: &Address) -> BigUint<Self>;
45
46    fn get_balance(&self, address: &ManagedAddress<Self>) -> BigUint<Self> {
47        self.get_balance_legacy(&address.to_address())
48    }
49
50    fn get_state_root_hash_legacy(&self) -> H256;
51
52    #[inline]
53    fn get_state_root_hash(&self) -> ManagedByteArray<Self, 32> {
54        ManagedByteArray::new_from_bytes(self.clone(), self.get_state_root_hash_legacy().as_array())
55    }
56
57    fn get_tx_hash_legacy(&self) -> H256;
58
59    fn get_tx_hash(&self) -> ManagedByteArray<Self, 32> {
60        ManagedByteArray::new_from_bytes(self.clone(), self.get_tx_hash_legacy().as_array())
61    }
62
63    fn get_gas_left(&self) -> u64;
64
65    fn get_block_timestamp(&self) -> u64;
66
67    fn get_block_nonce(&self) -> u64;
68
69    fn get_block_round(&self) -> u64;
70
71    fn get_block_epoch(&self) -> u64;
72
73    fn get_block_random_seed_legacy(&self) -> Box<[u8; 48]>;
74
75    fn get_block_random_seed(&self) -> ManagedByteArray<Self, 48> {
76        ManagedByteArray::new_from_bytes(self.clone(), &*self.get_block_random_seed_legacy())
77    }
78
79    fn get_prev_block_timestamp(&self) -> u64;
80
81    fn get_prev_block_nonce(&self) -> u64;
82
83    fn get_prev_block_round(&self) -> u64;
84
85    fn get_prev_block_epoch(&self) -> u64;
86
87    fn get_prev_block_random_seed_legacy(&self) -> Box<[u8; 48]>;
88
89    fn get_prev_block_random_seed(&self) -> ManagedByteArray<Self, 48> {
90        ManagedByteArray::new_from_bytes(self.clone(), &*self.get_prev_block_random_seed_legacy())
91    }
92
93    fn get_current_dcdt_nft_nonce(
94        &self,
95        address: &Address,
96        token_id: &TokenIdentifier<Self>,
97    ) -> u64;
98
99    fn get_dcdt_balance(
100        &self,
101        address: &ManagedAddress<Self>,
102        token_id: &TokenIdentifier<Self>,
103        nonce: u64,
104    ) -> BigUint<Self>;
105
106    fn get_dcdt_token_data(
107        &self,
108        address: &ManagedAddress<Self>,
109        token_id: &TokenIdentifier<Self>,
110        nonce: u64,
111    ) -> DcdtTokenData<Self>;
112}