numbat_wasm_module_users/
lib.rs

1#![no_std]
2
3numbat_wasm::imports!();
4
5/// The module deals with temporarily pausing contract operations.
6/// It provides a flag that contracts can use to check if owner decided to users the entire contract.
7/// Use the features module for more granular on/off switches.
8#[numbat_wasm::module]
9pub trait UsersModule {
10    /// Each user gets a user id. This is in order to be able to iterate over their data.
11    /// This is a mapping from user address to user id.
12    /// The key is the bytes "user_id" concatenated with their public key.
13    /// The value is the user id.
14    #[view(getUserId)]
15    #[storage_get("user_id")]
16    fn get_user_id(&self, address: &ManagedAddress) -> usize;
17
18    #[storage_set("user_id")]
19    fn set_user_id(&self, address: &ManagedAddress, user_id: usize);
20
21    #[view(getUserAddress)]
22    #[storage_get("user_address")]
23    fn get_user_address(&self, user_id: usize) -> ManagedAddress;
24
25    #[storage_set("user_address")]
26    fn set_user_address(&self, user_id: usize, address: &ManagedAddress);
27
28    /// Retrieves the number of delegtors, including the owner,
29    /// even if they no longer have anything in the contract.
30    #[view(getNumUsers)]
31    #[storage_get("num_users")]
32    fn get_num_users(&self) -> usize;
33
34    /// Yields how accounts are registered in the contract.
35    /// Note that not all of them must have stakes greater than zero.
36    #[storage_set("num_users")]
37    fn set_num_users(&self, num_users: usize);
38
39    fn get_or_create_user(&self, address: &ManagedAddress) -> usize {
40        let mut user_id = self.get_user_id(address);
41        if user_id == 0 {
42            let mut num_users = self.get_num_users();
43            num_users += 1;
44            self.set_num_users(num_users);
45            user_id = num_users;
46            self.set_user_id(address, user_id);
47            self.set_user_address(user_id, address);
48        }
49        user_id
50    }
51
52    #[endpoint(updateUserAddress)]
53    fn update_user_address(&self, #[var_args] addresses: VarArgs<ManagedAddress>) -> SCResult<()> {
54        for address in addresses.into_vec() {
55            let user_id = self.get_user_id(&address);
56            require!(user_id > 0, "unknown address");
57            self.set_user_address(user_id, &address);
58        }
59        Ok(())
60    }
61}