AccessControlClient

stellar_access::access_control

Struct AccessControlClient 

Source 
pub struct AccessControlClient<'a> {
    pub env: Env,
    pub address: Address,
    /* private fields */
}
Expand description

AccessControlClient is a client for calling the contract defined in “AccessControl”.

Fields§

§env: Env§address: Address

Implementations§

Source§

impl<'a> AccessControlClient<'a>

Source

pub fn new(env: &Env, address: &Address) -> Self

Source§

impl<'a> AccessControlClient<'a>

Source

pub fn has_role(&self, account: &Address, role: &Symbol) -> Option<u32>

Returns Some(index) if the account has the specified role, where index is the position of the account for that role, and can be used to query AccessControl::get_role_member(). Returns None if the account does not have the specified role.

§Arguments
  • e - Access to Soroban environment.
  • account - The account to check.
  • role - The role to check for.
Source

pub fn try_has_role( &self, account: &Address, role: &Symbol, ) -> Result<Result<Option<u32>, <Option<u32> as TryFromVal<Env, Val>>::Error>, Result<Error, InvokeError>>

Returns Some(index) if the account has the specified role, where index is the position of the account for that role, and can be used to query AccessControl::get_role_member(). Returns None if the account does not have the specified role.

§Arguments
  • e - Access to Soroban environment.
  • account - The account to check.
  • role - The role to check for.
Source

pub fn get_existing_roles(&self) -> Vec<Symbol>

Returns a vector containing all existing roles. Defaults to empty vector if no roles exist.

§Arguments
  • e - Access to Soroban environment.
§Notes

This function returns all roles that currently have at least one member. The maximum number of roles is limited by MAX_ROLES.

Source

pub fn try_get_existing_roles( &self, ) -> Result<Result<Vec<Symbol>, <Vec<Symbol> as TryFromVal<Env, Val>>::Error>, Result<Error, InvokeError>>

Returns a vector containing all existing roles. Defaults to empty vector if no roles exist.

§Arguments
  • e - Access to Soroban environment.
§Notes

This function returns all roles that currently have at least one member. The maximum number of roles is limited by MAX_ROLES.

Source

pub fn get_role_member_count(&self, role: &Symbol) -> u32

Returns the total number of accounts that have the specified role. If the role does not exist, returns 0.

§Arguments
  • e - Access to Soroban environment.
  • role - The role to get the count for.
Source

pub fn try_get_role_member_count( &self, role: &Symbol, ) -> Result<Result<u32, <u32 as TryFromVal<Env, Val>>::Error>, Result<Error, InvokeError>>

Returns the total number of accounts that have the specified role. If the role does not exist, returns 0.

§Arguments
  • e - Access to Soroban environment.
  • role - The role to get the count for.
Source

pub fn get_role_member(&self, role: &Symbol, index: &u32) -> Address

Returns the account at the specified index for a given role.

We do not provide a function to get all the members of a role, since that would be unbounded. If you need to enumerate all the members of a role, you can use AccessControl::get_role_member_count() to get the total number of members and then use AccessControl::get_role_member() to get each member one by one.

§Arguments
  • e - Access to Soroban environment.
  • role - The role to query.
  • index - The index of the account to retrieve.
§Errors
Source

pub fn try_get_role_member( &self, role: &Symbol, index: &u32, ) -> Result<Result<Address, <Address as TryFromVal<Env, Val>>::Error>, Result<Error, InvokeError>>

Returns the account at the specified index for a given role.

We do not provide a function to get all the members of a role, since that would be unbounded. If you need to enumerate all the members of a role, you can use AccessControl::get_role_member_count() to get the total number of members and then use AccessControl::get_role_member() to get each member one by one.

§Arguments
  • e - Access to Soroban environment.
  • role - The role to query.
  • index - The index of the account to retrieve.
§Errors
Source

pub fn get_role_admin(&self, role: &Symbol) -> Option<Symbol>

Returns the admin role for a specific role. If no admin role is explicitly set, returns None.

§Arguments
  • e - Access to Soroban environment.
  • role - The role to query the admin role for.
Source

pub fn try_get_role_admin( &self, role: &Symbol, ) -> Result<Result<Option<Symbol>, <Option<Symbol> as TryFromVal<Env, Val>>::Error>, Result<Error, InvokeError>>

Returns the admin role for a specific role. If no admin role is explicitly set, returns None.

§Arguments
  • e - Access to Soroban environment.
  • role - The role to query the admin role for.
Source

pub fn get_admin(&self) -> Option<Address>

Returns the admin account.

§Arguments
  • e - Access to Soroban environment.
Source

pub fn try_get_admin( &self, ) -> Result<Result<Option<Address>, <Option<Address> as TryFromVal<Env, Val>>::Error>, Result<Error, InvokeError>>

Returns the admin account.

§Arguments
  • e - Access to Soroban environment.
Source

pub fn grant_role(&self, account: &Address, role: &Symbol, caller: &Address)

Grants a role to an account.

§Arguments
  • e - Access to Soroban environment.
  • account - The account to grant the role to.
  • role - The role to grant.
  • caller - The address of the caller, must be the admin or have the RoleAdmin for the role.
§Errors
§Events
  • topics - ["role_granted", role: Symbol, account: Address]
  • data - [caller: Address]
Source

pub fn try_grant_role( &self, account: &Address, role: &Symbol, caller: &Address, ) -> Result<Result<(), <() as TryFromVal<Env, Val>>::Error>, Result<Error, InvokeError>>

Grants a role to an account.

§Arguments
  • e - Access to Soroban environment.
  • account - The account to grant the role to.
  • role - The role to grant.
  • caller - The address of the caller, must be the admin or have the RoleAdmin for the role.
§Errors
§Events
  • topics - ["role_granted", role: Symbol, account: Address]
  • data - [caller: Address]
Source

pub fn revoke_role(&self, account: &Address, role: &Symbol, caller: &Address)

Revokes a role from an account. To revoke your own role, please use AccessControl::renounce_role() instead.

§Arguments
  • e - Access to Soroban environment.
  • account - The account to revoke the role from.
  • role - The role to revoke.
  • caller - The address of the caller, must be the admin or has the RoleAdmin for the role.
§Errors
§Events
  • topics - ["role_revoked", role: Symbol, account: Address]
  • data - [caller: Address]
Source

pub fn try_revoke_role( &self, account: &Address, role: &Symbol, caller: &Address, ) -> Result<Result<(), <() as TryFromVal<Env, Val>>::Error>, Result<Error, InvokeError>>

Revokes a role from an account. To revoke your own role, please use AccessControl::renounce_role() instead.

§Arguments
  • e - Access to Soroban environment.
  • account - The account to revoke the role from.
  • role - The role to revoke.
  • caller - The address of the caller, must be the admin or has the RoleAdmin for the role.
§Errors
§Events
  • topics - ["role_revoked", role: Symbol, account: Address]
  • data - [caller: Address]
Source

pub fn renounce_role(&self, role: &Symbol, caller: &Address)

Allows an account to renounce a role assigned to itself. Users can only renounce roles for their own account.

§Arguments
  • e - Access to Soroban environment.
  • role - The role to renounce.
  • caller - The address of the caller, must be the account that has the role.
§Errors
§Events
  • topics - ["role_revoked", role: Symbol, account: Address]
  • data - [caller: Address]
Source

pub fn try_renounce_role( &self, role: &Symbol, caller: &Address, ) -> Result<Result<(), <() as TryFromVal<Env, Val>>::Error>, Result<Error, InvokeError>>

Allows an account to renounce a role assigned to itself. Users can only renounce roles for their own account.

§Arguments
  • e - Access to Soroban environment.
  • role - The role to renounce.
  • caller - The address of the caller, must be the account that has the role.
§Errors
§Events
  • topics - ["role_revoked", role: Symbol, account: Address]
  • data - [caller: Address]
Source

pub fn accept_admin_transfer(&self)

Initiates the admin role transfer. Admin privileges for the current admin are not revoked until the recipient accepts the transfer. Overrides the previous pending transfer if there is one.

§Arguments
  • e - Access to Soroban environment.
  • new_admin - The account to transfer the admin privileges to.
  • live_until_ledger - The ledger number at which the pending transfer expires. If live_until_ledger is 0, the pending transfer is cancelled. live_until_ledger argument is implicitly bounded by the maximum allowed TTL extension for a temporary storage entry and specifying a higher value will cause the code to panic.
§Errors
§Events
  • topics - ["admin_transfer_initiated", current_admin: Address]
  • data - [new_admin: Address, live_until_ledger: u32]
§Notes
  • Authorization for the current admin is required.
Source

pub fn try_accept_admin_transfer( &self, ) -> Result<Result<(), <() as TryFromVal<Env, Val>>::Error>, Result<Error, InvokeError>>

Initiates the admin role transfer. Admin privileges for the current admin are not revoked until the recipient accepts the transfer. Overrides the previous pending transfer if there is one.

§Arguments
  • e - Access to Soroban environment.
  • new_admin - The account to transfer the admin privileges to.
  • live_until_ledger - The ledger number at which the pending transfer expires. If live_until_ledger is 0, the pending transfer is cancelled. live_until_ledger argument is implicitly bounded by the maximum allowed TTL extension for a temporary storage entry and specifying a higher value will cause the code to panic.
§Errors
§Events
  • topics - ["admin_transfer_initiated", current_admin: Address]
  • data - [new_admin: Address, live_until_ledger: u32]
§Notes
  • Authorization for the current admin is required.
Source

pub fn transfer_admin_role(&self, new_admin: &Address, live_until_ledger: &u32)

Completes the 2-step admin transfer.

§Arguments
  • e - Access to Soroban environment.
§Events
  • topics - ["admin_transfer_completed", new_admin: Address]
  • data - [previous_admin: Address]
§Errors
Source

pub fn try_transfer_admin_role( &self, new_admin: &Address, live_until_ledger: &u32, ) -> Result<Result<(), <() as TryFromVal<Env, Val>>::Error>, Result<Error, InvokeError>>

Completes the 2-step admin transfer.

§Arguments
  • e - Access to Soroban environment.
§Events
  • topics - ["admin_transfer_completed", new_admin: Address]
  • data - [previous_admin: Address]
§Errors
Source

pub fn set_role_admin(&self, role: &Symbol, admin_role: &Symbol)

Sets admin_role as the admin role of role.

§Arguments
  • e - Access to Soroban environment.
  • role - The role to set the admin for.
  • admin_role - The new admin role.
§Events
  • topics - ["role_admin_changed", role: Symbol]
  • data - [previous_admin_role: Symbol, new_admin_role: Symbol]
§Errors
§Notes
  • Authorization for the current admin is required.
Source

pub fn try_set_role_admin( &self, role: &Symbol, admin_role: &Symbol, ) -> Result<Result<(), <() as TryFromVal<Env, Val>>::Error>, Result<Error, InvokeError>>

Sets admin_role as the admin role of role.

§Arguments
  • e - Access to Soroban environment.
  • role - The role to set the admin for.
  • admin_role - The new admin role.
§Events
  • topics - ["role_admin_changed", role: Symbol]
  • data - [previous_admin_role: Symbol, new_admin_role: Symbol]
§Errors
§Notes
  • Authorization for the current admin is required.
Source

pub fn renounce_admin(&self)

Allows the current admin to renounce their role, making the contract permanently admin-less. This is useful for decentralization purposes or when the admin role is no longer needed. Once the admin is renounced, it cannot be reinstated.

§Arguments
  • e - Access to Soroban environment.
§Errors
§Events
  • topics - ["admin_renounced", admin: Address]
  • data - []
§Notes
  • Authorization for the current admin is required.
Source

pub fn try_renounce_admin( &self, ) -> Result<Result<(), <() as TryFromVal<Env, Val>>::Error>, Result<Error, InvokeError>>

Allows the current admin to renounce their role, making the contract permanently admin-less. This is useful for decentralization purposes or when the admin role is no longer needed. Once the admin is renounced, it cannot be reinstated.

§Arguments
  • e - Access to Soroban environment.
§Errors
§Events
  • topics - ["admin_renounced", admin: Address]
  • data - []
§Notes
  • Authorization for the current admin is required.

Auto Trait Implementations§

§

impl<'a> Freeze for AccessControlClient<'a>

§

impl<'a> !RefUnwindSafe for AccessControlClient<'a>

§

impl<'a> !Send for AccessControlClient<'a>

§

impl<'a> !Sync for AccessControlClient<'a>

§

impl<'a> Unpin for AccessControlClient<'a>

§

impl<'a> !UnwindSafe for AccessControlClient<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T, C> Compare<&T> for C
where C: Compare<T>,

Source§

type Error = <C as Compare<T>>::Error

Source§

fn compare(&self, a: &&T, b: &&T) -> Result<Ordering, <C as Compare<&T>>::Error>

Source§

impl<T, U, E, C> Compare<(T, U)> for C
where C: Compare<T, Error = E, Error = E> + Compare<U>,

Source§

type Error = E

Source§

fn compare( &self, a: &(T, U), b: &(T, U), ) -> Result<Ordering, <C as Compare<(T, U)>>::Error>

Source§

impl<T, U, V, E, C> Compare<(T, U, V)> for C
where C: Compare<T, Error = E, Error = E, Error = E> + Compare<U> + Compare<V>,

Source§

type Error = E

Source§

fn compare( &self, a: &(T, U, V), b: &(T, U, V), ) -> Result<Ordering, <C as Compare<(T, U, V)>>::Error>

Source§

impl<T, U, V, W, E, C> Compare<(T, U, V, W)> for C
where C: Compare<T, Error = E, Error = E, Error = E, Error = E> + Compare<U> + Compare<V> + Compare<W>,

Source§

type Error = E

Source§

fn compare( &self, a: &(T, U, V, W), b: &(T, U, V, W), ) -> Result<Ordering, <C as Compare<(T, U, V, W)>>::Error>

Source§

impl<T, U, V, W, X, E, C> Compare<(T, U, V, W, X)> for C
where C: Compare<T, Error = E, Error = E, Error = E, Error = E, Error = E> + Compare<U> + Compare<V> + Compare<W> + Compare<X>,

Source§

type Error = E

Source§

fn compare( &self, a: &(T, U, V, W, X), b: &(T, U, V, W, X), ) -> Result<Ordering, <C as Compare<(T, U, V, W, X)>>::Error>

Source§

impl<T, C> Compare<Box<T>> for C
where C: Compare<T>,

Source§

type Error = <C as Compare<T>>::Error

Source§

fn compare( &self, a: &Box<T>, b: &Box<T>, ) -> Result<Ordering, <C as Compare<Box<T>>>::Error>

Source§

impl<T, C> Compare<Option<T>> for C
where C: Compare<T>,

Source§

type Error = <C as Compare<T>>::Error

Source§

fn compare( &self, a: &Option<T>, b: &Option<T>, ) -> Result<Ordering, <C as Compare<Option<T>>>::Error>

Source§

impl<T, C> Compare<Rc<T>> for C
where C: Compare<T>,

Source§

type Error = <C as Compare<T>>::Error

Source§

fn compare( &self, a: &Rc<T>, b: &Rc<T>, ) -> Result<Ordering, <C as Compare<Rc<T>>>::Error>

Source§

impl<T, C> Compare<Vec<T>> for C
where C: Compare<T>,

Source§

type Error = <C as Compare<T>>::Error

Source§

fn compare( &self, a: &Vec<T>, b: &Vec<T>, ) -> Result<Ordering, <C as Compare<Vec<T>>>::Error>

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<E, T, U> IntoVal<E, T> for U
where E: Env, T: FromVal<E, U>,

Source§

fn into_val(&self, e: &E) -> T

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<E, T, U> TryIntoVal<E, T> for U
where E: Env, T: TryFromVal<E, U>,

Source§

type Error = <T as TryFromVal<E, U>>::Error

Source§

fn try_into_val(&self, env: &E) -> Result<T, <U as TryIntoVal<E, T>>::Error>

Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V