Icon LinkAdmin Library

The Admin library provides a way to block users without an "administrative status" from calling functions within a contract. The Admin Library differs from the Ownership Library as multiple users may have administrative status. The Admin Library is often used when needing administrative calls on a contract that involve multiple users or a whitelist.

This library extends the Ownership Library . The Ownership library must be imported and used to enable the Admin library. Only the contract's owner may add and remove administrative users.

For implementation details on the Admin Library please see the Sway Libs Docs Icon Link.

Icon LinkImporting the Admin Library

In order to use the Admin Library, the Admin and the Ownership Libraries must be added to your Forc.toml file and then imported into your Sway project.

To add the Admin and the Ownership Libraries as dependencies to your Forc.toml file in your project, use the forc add command.

forc add [email protected]
forc add [email protected]

Icon InfoCircle

NOTE: Be sure to set the version to the latest release.

To import the Admin Library, be sure to include both the Admin and Ownership Libraries in your import statements.

use {admin::*, ownership::*};

Icon LinkIntegrating the Admin Library into the Ownership Library

To use the Admin library, be sure to set a contract owner for your contract. The following demonstrates setting a contract owner using the Ownership Library .

use {admin::add_admin, ownership::initialize_ownership};
 
#[storage(read, write)]
fn my_constructor(new_owner: Identity) {
    initialize_ownership(new_owner);
}
 
#[storage(read, write)]
fn add_a_admin(new_admin: Identity) {
    // Can only be called by contract's owner set in the constructor above.
    add_admin(new_admin);
}

Icon LinkBasic Functionality

Icon LinkAdding an Admin

To add a new admin to a contract, call the add_admin() function.

#[storage(read, write)]
fn add_a_admin(new_admin: Identity) {
    // Can only be called by contract's owner.
    add_admin(new_admin);
}

Icon InfoCircle

NOTE Only the contract's owner may call this function. Please see the example above to set a contract owner.

Icon LinkRemoving an Admin

To remove an admin from a contract, call the revoke_admin() function.

#[storage(read, write)]
fn remove_an_admin(old_admin: Identity) {
    // Can only be called by contract's owner.
    revoke_admin(old_admin);
}

Icon InfoCircle

NOTE Only the contract's owner may call this function. Please see the example above to set a contract owner.

Icon LinkApplying Restrictions

To restrict a function to only an admin, call the only_admin() function.

#[storage(read)]
fn only_owner_may_call() {
    only_admin();
    // Only an admin may reach this line.
}

Icon InfoCircle

NOTE: Admins and the contract's owner are independent of one another. only_admin() will revert if called by the contract's owner.

To restrict a function to only an admin or the contract's owner, call the only_owner_or_admin() function.

#[storage(read)]
fn both_owner_or_admin_may_call() {
    only_owner_or_admin();
    // Only an admin may reach this line.
}

Icon LinkChecking Admin Status

To check the administrative privileges of a user, call the is_admin() function.

#[storage(read)]
fn check_if_admin(admin: Identity) {
    let status = is_admin(admin);
    assert(status);
}