Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions contracts/admin/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,39 @@ pub fn grant_role(env: &Env, role: Role, address: &Address) {
events::emit_role_granted(env, &admin, role, address);
}

/// Revokes a previously granted role from an address.
///
/// # Authorization
///
/// The caller **must** be the contract admin (set via [`set_admin`]).
/// Soroban enforces this via `require_auth()`, so the transaction will fail
/// if the admin has not signed it.
///
/// # Arguments
///
/// * `env` – Soroban environment handle.
/// * `role` – The [`Role`] variant to revoke (e.g. `Role::Minter`).
/// * `address` – The address whose role is being revoked. Must **not** be the
/// zero address (Stellar `GAAAAAAAAAA…` sentinel); passing it panics.
///
/// # Errors
///
/// Returns [`AdminError::RoleNotGranted`] if the address does not currently
/// hold the specified role. This is a *recoverable* error (the contract does
/// **not** panic).
///
/// # Events
///
/// On success a `role_rvk` event is emitted with data
/// `(admin, role, address)`.
///
/// # Examples
///
/// ```ignore
/// // Admin revokes the Minter role from `user`.
/// revoke_role(&env, Role::Minter, &user)?;
/// assert!(!has_role(&env, Role::Minter, &user));
/// ```
pub fn revoke_role(env: &Env, role: Role, address: &Address) -> Result<(), AdminError> {
require_non_zero_address(env, address);
let admin = get_admin(env);
Expand Down
Loading