Contract bf9358ac2e188d74a695cd6009929735f90e8c891f922a9de5fcdc7037af255e

← Back to Index 📥 Download WASM

Meta

cliver 25.1.0#a048a57a75762458b487052e0021ea704a926bee
rssdkver 25.1.1#94c2a3b3a5ded6b9cf9cef0c207bf8804f3eb294
rsver 1.90.0

Instances

  • CBW5GSR5AZTCIUEVVF6H2DPTY4XNGYRIPESPUEJVEW6D4NQWJNY2JUEG

Interface

Grants a role to an account. Caller must be owner or have the role's admin role.

Arguments

  • account - The account to grant the role to.
  • role - The role to grant.
  • caller - The account that is granting the role. Must be owner or have the role's admin role.
fn grant_role(
    env: soroban_sdk::Env,
    account: soroban_sdk::Address,
    role: soroban_sdk::Symbol,
    caller: soroban_sdk::Address,
)

Revokes a role from an account. Caller must be owner or have the role's admin role.

Arguments

  • account - The account to revoke the role from.
  • role - The role to revoke.
  • caller - The account that is revoking the role. Must be owner or have the role's admin role.
fn revoke_role(
    env: soroban_sdk::Env,
    account: soroban_sdk::Address,
    role: soroban_sdk::Symbol,
    caller: soroban_sdk::Address,
)

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

Arguments

  • role - The role to renounce.
  • caller - The account that is renouncing the role. Must be the account itself.
fn renounce_role(
    env: soroban_sdk::Env,
    role: soroban_sdk::Symbol,
    caller: soroban_sdk::Address,
)

Sets admin_role as the admin role of role. Caller must be the authorizer.

Arguments

  • role - The role to set the admin for.
  • admin_role - The admin role to set for the role.

Notes

The admin role can be any Symbol, including one with no members. If the admin role has no members, only the authorizer can grant/revoke the role.

fn set_role_admin(
    env: soroban_sdk::Env,
    role: soroban_sdk::Symbol,
    admin_role: soroban_sdk::Symbol,
)

Removes the admin role for a specified role. Caller must be the authorizer.

Arguments

  • role - The role to remove the admin for.

Errors

  • RbacError::AdminRoleNotFound - If no admin role is set for the role.
fn remove_role_admin(env: soroban_sdk::Env, role: soroban_sdk::Symbol)

Returns Some(index) if the account has the specified role, where index is the index of the account in the role. Returns None if not.

Arguments

  • account - The account to check the role for.
  • role - The role to check the account for.
fn has_role(
    env: soroban_sdk::Env,
    account: soroban_sdk::Address,
    role: soroban_sdk::Symbol,
) -> Option

Returns the admin role for a specific role, or None if not set.

Arguments

  • role - The role to get the admin for.
fn get_role_admin(
    env: soroban_sdk::Env,
    role: soroban_sdk::Symbol,
) -> Option

Returns the number of accounts that have the specified role.

Arguments

  • role - The role to get the member count for.
fn get_role_member_count(env: soroban_sdk::Env, role: soroban_sdk::Symbol) -> u32

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

Arguments

  • role - The role to get the member for.
  • index - The index of the member to get.

Errors

  • RbacError::IndexOutOfBounds if the index is out of bounds.
fn get_role_member(
    env: soroban_sdk::Env,
    role: soroban_sdk::Symbol,
    index: u32,
) -> soroban_sdk::Address

Returns all roles that currently have at least one member. Defaults to empty vector if no roles exist.

Notes

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

fn get_existing_roles(env: soroban_sdk::Env) -> soroban_sdk::Vec
fn set_admin(
    env: soroban_sdk::Env,
    new_admin: soroban_sdk::Address,
    operator: soroban_sdk::Address,
)
fn set_authorized(
    env: soroban_sdk::Env,
    id: soroban_sdk::Address,
    authorize: bool,
    operator: soroban_sdk::Address,
)
fn clawback(
    env: soroban_sdk::Env,
    from: soroban_sdk::Address,
    amount: i128,
    operator: soroban_sdk::Address,
)
fn mint(
    env: soroban_sdk::Env,
    to: soroban_sdk::Address,
    amount: i128,
    operator: soroban_sdk::Address,
)

Constructs the SAC manager contract.

Arguments

  • sac_token - The underlying Stellar Asset Contract address
  • owner - The initial owner address (for TTL management, role grants)
fn __constructor(
    env: soroban_sdk::Env,
    sac_token: soroban_sdk::Address,
    owner: soroban_sdk::Address,
)

Returns the underlying SAC (Stellar Asset Contract) address.

fn underlying_sac(env: soroban_sdk::Env) -> soroban_sdk::Address
fn authorizer(env: soroban_sdk::Env) -> Option

Returns the current owner address, or None if no owner is set.

fn owner(env: soroban_sdk::Env) -> Option

Returns the pending owner address for 2-step transfer, or None if no transfer is pending.

fn pending_owner(env: soroban_sdk::Env) -> Option

Transfers ownership immediately to a new address.

Use with caution - if you transfer to a wrong address, ownership is lost forever. Consider using begin_ownership_transfer instead.

Panics

  • OwnerNotSet if no owner is currently set
  • TransferInProgress if a 2-step transfer is in progress
fn transfer_ownership(env: soroban_sdk::Env, new_owner: soroban_sdk::Address)

Begins an ownership transfer to a new address.

The new owner must call accept_ownership() within ttl ledgers to complete the transfer. The pending transfer will automatically expire after.

Arguments

  • new_owner - The proposed new owner
  • ttl - Number of ledgers the new owner has to accept. Use 0 to cancel a pending transfer (new_owner must match pending).

Panics

  • OwnerNotSet if no owner is currently set
  • NoPendingTransfer when cancelling and no pending transfer exists
  • InvalidTtl if ttl exceeds max TTL
  • InvalidPendingOwner when cancelling with wrong new_owner address
fn begin_ownership_transfer(
    env: soroban_sdk::Env,
    new_owner: soroban_sdk::Address,
    ttl: u32,
)

Accepts a pending 2-step ownership transfer.

Must be called by the pending owner before the TTL expires.

Panics

  • NoPendingTransfer if there is no pending transfer (or it expired)
fn accept_ownership(env: soroban_sdk::Env)

Permanently renounces ownership.

Panics

  • OwnerNotSet if no owner is currently set
  • TransferInProgress if a 2-step transfer is in progress (cancel it first)
fn renounce_ownership(env: soroban_sdk::Env)

Extends the instance TTL.

Arguments

  • threshold - The threshold to extend the TTL (if current TTL is below this, extend).
  • extend_to - The TTL to extend to.
fn extend_instance_ttl(env: soroban_sdk::Env, threshold: u32, extend_to: u32)

Sets TTL configs for instance and persistent storage.

  • None values remove the corresponding config (disables auto-extension for that type)
  • Validates that threshold <= extend_to <= MAX_TTL

Arguments

  • instance - TTL config for instance storage
  • persistent - TTL config for persistent storage

Panics

  • TtlConfigFrozen if configs are frozen
  • InvalidTtlConfig if validation fails
fn set_ttl_configs(
    env: soroban_sdk::Env,
    instance: Option,
    persistent: Option,
)

Returns the current TTL configs as (instance_config, persistent_config).

fn ttl_configs(env: soroban_sdk::Env) -> (Option, Option)

Permanently freezes TTL configs, preventing any future modifications.

This is irreversible and provides immutability guarantees to users. Emits TtlConfigsFrozen event.

Panics

  • TtlConfigAlreadyFrozen if already frozen
fn freeze_ttl_configs(env: soroban_sdk::Env)

Returns whether TTL configs are frozen.

fn is_ttl_configs_frozen(env: soroban_sdk::Env) -> bool

Imports

WebAssembly Text (WAT) ▶