Trait dharitri_wasm::api::BlockchainApi

pub trait BlockchainApi: StorageReadApi + ErrorApi + Clone + Sized + 'static {
    type BalanceType: BigUintApi + 'static;

    // Required methods
    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_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_dct_nft_nonce(
        &self,
        address: &Address,
        token_id: &TokenIdentifier
    ) -> u64;
    fn get_dct_balance(
        &self,
        address: &Address,
        token_id: &TokenIdentifier,
        nonce: u64
    ) -> Self::BalanceType;
    fn get_dct_token_data(
        &self,
        address: &Address,
        token_id: &TokenIdentifier,
        nonce: u64
    ) -> DctTokenData<Self::BalanceType>;

    // Provided methods
    fn check_caller_is_owner(&self) { ... }
    fn get_sc_balance(
        &self,
        token: &TokenIdentifier,
        nonce: u64
    ) -> Self::BalanceType { ... }
    fn get_cumulated_validator_rewards(&self) -> Self::BalanceType { ... }
    fn get_dct_local_roles(
        &self,
        token_id: &TokenIdentifier
    ) -> Vec<DctLocalRole> { ... }
}

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.

Required Associated Types

type BalanceType: BigUintApi + 'static

The type of the token balances. Not named BigUint to avoid name collisions in types that implement multiple API traits.

Required Methods

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_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_dct_nft_nonce( &self, address: &Address, token_id: &TokenIdentifier ) -> u64

fn get_dct_balance( &self, address: &Address, token_id: &TokenIdentifier, nonce: u64 ) -> Self::BalanceType

fn get_dct_token_data( &self, address: &Address, token_id: &TokenIdentifier, nonce: u64 ) -> DctTokenData<Self::BalanceType>

Provided Methods

fn check_caller_is_owner(&self)

fn get_sc_balance( &self, token: &TokenIdentifier, nonce: u64 ) -> Self::BalanceType

fn get_cumulated_validator_rewards(&self) -> Self::BalanceType

Retrieves validator rewards, as set by the protocol. TODO: move to the storage API, once BigUint gets refactored

fn get_dct_local_roles(&self, token_id: &TokenIdentifier) -> Vec<DctLocalRole>

Retrieves local roles for the token, by reading protected storage.

Object Safety

This trait is not object safe.

Implementors