Struct UserState 

pub struct UserState {
    pub owner: Principal,
    pub wallet_canister: Principal,
    pub config: UserStateConfig,
    pub users: BTreeMap<Principal, UserData>,
}

Represents the state of the canister, including users, and wallet canister.

Fields

owner: Principal

wallet_canister: Principal

config: UserStateConfig

users: BTreeMap<Principal, UserData>

Implementations

impl UserState

pub fn default() -> Self

Returns the default state.

pub fn init(&mut self, wallet_canister: Principal)

Initializes the state with the wallet canister. This function should only be called once, when the canister is first installed.

pub fn validate_caller_owner(&self) -> Result<(), UserStateError>

Validates if the caller is the owner.

pub fn validate_caller_wallet_canister(&self) -> Result<(), UserStateError>

Validates if the caller is the wallet canister.

pub fn validate_caller_wallet_canister_or_user( &self, user: &Principal, ) -> Result<(), UserStateError>

Validates if the caller is the wallet canister, or the user.

pub fn change_owner( &mut self, new_owner: Principal, ) -> Result<Principal, UserStateError>

Changes the owner of the canister.
This function should only be called by the owner.

pub fn change_wallet_canister( &mut self, new_wallet_canister: Principal, ) -> Result<Principal, UserStateError>

Changes the wallet canister. This function should only be called by the owner.

pub fn create_user( &mut self, user: Principal, user_args: UserDataArgs, account_args: UserAccountArgs, ) -> Result<UserData, UserStateError>

This function returns a reference to the user data. Adds new user data for a given user Principal.

pub fn get_user_mut( &mut self, user: &Principal, ) -> Result<&mut UserData, UserStateError>

This function returns a mutable reference to the user data. Retrieves user data for a given user Principal.

pub fn get_user(&self, user: &Principal) -> Result<&UserData, UserStateError>

This function returns a reference to the user data. Retrieves user data for a given user Principal.

pub fn get_user_derivation_path( &self, user: &Principal, key: u8, ) -> Result<Vec<u8>, UserStateError>

This function returns a Derivation Path for a given user Principal.

Trait Implementations

impl CandidType for UserState

fn _ty() -> Type

fn id() -> TypeId

fn idl_serialize<__S>(&self, __serializer: __S) -> Result<(), __S::Error>

where __S: Serializer,

fn ty() -> Type

impl Debug for UserState

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UserState

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.