Trait dharitri_wasm_module_users::UsersModule

pub trait UsersModule: ContractBase + Sized {
    // Required methods
    fn get_user_id(&self, address: &ManagedAddress<Self::Api>) -> usize;
    fn set_user_id(&self, address: &ManagedAddress<Self::Api>, user_id: usize);
    fn get_user_address(&self, user_id: usize) -> ManagedAddress<Self::Api>;
    fn set_user_address(
        &self,
        user_id: usize,
        address: &ManagedAddress<Self::Api>
    );
    fn get_num_users(&self) -> usize;
    fn set_num_users(&self, num_users: usize);

    // Provided methods
    fn get_or_create_user(&self, address: &ManagedAddress<Self::Api>) -> usize { ... }
    fn update_user_address(
        &self,
        addresses: VarArgs<ManagedAddress<Self::Api>>
    ) -> SCResult<()> { ... }
}

The module deals with temporarily pausing contract operations. It provides a flag that contracts can use to check if owner decided to users the entire contract. Use the features module for more granular on/off switches.

Required Methods

fn get_user_id(&self, address: &ManagedAddress<Self::Api>) -> usize

Each user gets a user id. This is in order to be able to iterate over their data. This is a mapping from user address to user id. The key is the bytes “user_id” concatenated with their public key. The value is the user id.

fn set_user_id(&self, address: &ManagedAddress<Self::Api>, user_id: usize)

fn get_user_address(&self, user_id: usize) -> ManagedAddress<Self::Api>

fn set_user_address(&self, user_id: usize, address: &ManagedAddress<Self::Api>)

fn get_num_users(&self) -> usize

Retrieves the number of delegtors, including the owner, even if they no longer have anything in the contract.

fn set_num_users(&self, num_users: usize)

Yields how accounts are registered in the contract. Note that not all of them must have stakes greater than zero.

Provided Methods

fn get_or_create_user(&self, address: &ManagedAddress<Self::Api>) -> usize

fn update_user_address( &self, addresses: VarArgs<ManagedAddress<Self::Api>> ) -> SCResult<()>

Object Safety

This trait is not object safe.

Implementors

impl<C> UsersModule for C

where C: AutoImpl,