Struct soroban_sdk::token::StellarAssetClient

pub struct StellarAssetClient<'a> {
    pub env: Env,
    pub address: Address,
    /* private fields */
}

StellarAssetClient is a client for calling the contract defined in “StellarAssetInterface”.

Fields

env: Env

address: Address

Implementations

impl<'a> StellarAssetClient<'a>

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

pub fn set_auths(&self, auths: &'a [SorobanAuthorizationEntry]) -> Self

Set authorizations in the environment which will be consumed by contracts when they invoke Address::require_auth or Address::require_auth_for_args functions.

Requires valid signatures for the authorization to be successful. To mock auth without requiring valid signatures, use mock_auths.

See soroban_sdk::Env::set_auths for more details and examples.

pub fn mock_auths(&self, mock_auths: &'a [MockAuth<'a>]) -> Self

Mock authorizations in the environment which will cause matching invokes of Address::require_auth and Address::require_auth_for_args to pass.

See soroban_sdk::Env::set_auths for more details and examples.

pub fn mock_all_auths(&self) -> Self

Mock all calls to the Address::require_auth and Address::require_auth_for_args functions in invoked contracts, having them succeed as if authorization was provided.

See soroban_sdk::Env::mock_all_auths for more details and examples.

pub fn mock_all_auths_allowing_non_root_auth(&self) -> Self

A version of mock_all_auths that allows authorizations that are not present in the root invocation.

Refer to mock_all_auths documentation for details and prefer using mock_all_auths unless non-root authorization is required.

See soroban_sdk::Env::mock_all_auths_allowing_non_root_auth for more details and examples.

impl<'a> StellarAssetClient<'a>

pub fn set_admin(&self, new_admin: &Address)

Sets the administrator to the specified address new_admin.

Arguments

• new_admin - The address which will henceforth be the administrator of this token contract.

Events

Emits an event with topics ["set_admin", admin: Address], data = [new_admin: Address]

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

Sets the administrator to the specified address new_admin.

Arguments

• new_admin - The address which will henceforth be the administrator of this token contract.

Events

Emits an event with topics ["set_admin", admin: Address], data = [new_admin: Address]

pub fn admin(&self) -> Address

Returns the admin of the contract.

Panics

If the admin is not set.

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

Returns the admin of the contract.

Panics

If the admin is not set.

pub fn set_authorized(&self, id: &Address, authorize: &bool)

Sets whether the account is authorized to use its balance. If authorized is true, id should be able to use its balance.

Arguments

• id - The address being (de-)authorized.
• authorize - Whether or not id can use its balance.

Events

Emits an event with topics ["set_authorized", id: Address], data = [authorize: bool]

pub fn try_set_authorized( &self, id: &Address, authorize: &bool ) -> Result<Result<(), <() as TryFromVal<Env, Val>>::Error>, Result<Error, InvokeError>>

Sets whether the account is authorized to use its balance. If authorized is true, id should be able to use its balance.

Arguments

• id - The address being (de-)authorized.
• authorize - Whether or not id can use its balance.

Events

Emits an event with topics ["set_authorized", id: Address], data = [authorize: bool]

pub fn authorized(&self, id: &Address) -> bool

Returns true if id is authorized to use its balance.

Arguments

• id - The address for which token authorization is being checked.

pub fn try_authorized( &self, id: &Address ) -> Result<Result<bool, <bool as TryFromVal<Env, Val>>::Error>, Result<Error, InvokeError>>

Returns true if id is authorized to use its balance.

Arguments

• id - The address for which token authorization is being checked.

pub fn mint(&self, to: &Address, amount: &i128)

Mints amount to to.

Arguments

• to - The address which will receive the minted tokens.
• amount - The amount of tokens to be minted.

Events

Emits an event with topics ["mint", admin: Address, to: Address], data = [amount: i128]

pub fn try_mint( &self, to: &Address, amount: &i128 ) -> Result<Result<(), <() as TryFromVal<Env, Val>>::Error>, Result<Error, InvokeError>>

Mints amount to to.

Arguments

• to - The address which will receive the minted tokens.
• amount - The amount of tokens to be minted.

Events

Emits an event with topics ["mint", admin: Address, to: Address], data = [amount: i128]

pub fn clawback(&self, from: &Address, amount: &i128)

Clawback amount from from account. amount is burned in the clawback process.

Arguments

• from - The address holding the balance from which the clawback will take tokens.
• amount - The amount of tokens to be clawed back.

Events

Emits an event with topics ["clawback", admin: Address, to: Address], data = [amount: i128]

pub fn try_clawback( &self, from: &Address, amount: &i128 ) -> Result<Result<(), <() as TryFromVal<Env, Val>>::Error>, Result<Error, InvokeError>>

Clawback amount from from account. amount is burned in the clawback process.

Arguments

• from - The address holding the balance from which the clawback will take tokens.
• amount - The amount of tokens to be clawed back.

Events

Emits an event with topics ["clawback", admin: Address, to: Address], data = [amount: i128]