Struct soroban_sdk::token::StellarAssetClient
source · pub struct StellarAssetClient<'a> {
pub env: Env,
pub address: Address,
/* private fields */
}
Expand description
StellarAssetClient is a client for calling the contract defined in “StellarAssetInterface”.
Fields§
§env: Env
§address: Address
Implementations§
source§impl<'a> StellarAssetClient<'a>
impl<'a> StellarAssetClient<'a>
pub fn new(env: &Env, address: &Address) -> Self
sourcepub fn set_auths(&self, auths: &'a [SorobanAuthorizationEntry]) -> 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.
sourcepub fn mock_auths(&self, mock_auths: &'a [MockAuth<'a>]) -> Self
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.
sourcepub fn mock_all_auths(&self) -> Self
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.
sourcepub fn mock_all_auths_allowing_non_root_auth(&self) -> Self
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.
source§impl<'a> StellarAssetClient<'a>
impl<'a> StellarAssetClient<'a>
sourcepub fn try_set_admin(
&self,
new_admin: &Address
) -> Result<Result<(), <() as TryFromVal<Env, Val>>::Error>, Result<Error, InvokeError>>
pub fn try_set_admin( &self, new_admin: &Address ) -> Result<Result<(), <() as TryFromVal<Env, Val>>::Error>, Result<Error, InvokeError>>
sourcepub fn try_admin(
&self
) -> Result<Result<Address, <Address as TryFromVal<Env, Val>>::Error>, Result<Error, InvokeError>>
pub fn try_admin( &self ) -> Result<Result<Address, <Address 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 notid
can use its balance.
Events
Emits an event with topics ["set_authorized", id: Address], data = [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 notid
can use its balance.
Events
Emits an event with topics ["set_authorized", id: Address], data = [authorize: bool]
Returns true if id
is authorized to use its balance.
Arguments
id
- The address for which token authorization is being checked.
Returns true if id
is authorized to use its balance.
Arguments
id
- The address for which token authorization is being checked.
sourcepub fn try_mint(
&self,
to: &Address,
amount: &i128
) -> Result<Result<(), <() as TryFromVal<Env, Val>>::Error>, Result<Error, InvokeError>>
pub fn try_mint( &self, to: &Address, amount: &i128 ) -> Result<Result<(), <() as TryFromVal<Env, Val>>::Error>, Result<Error, InvokeError>>
sourcepub fn clawback(&self, from: &Address, 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]
sourcepub fn try_clawback(
&self,
from: &Address,
amount: &i128
) -> Result<Result<(), <() as TryFromVal<Env, Val>>::Error>, Result<Error, InvokeError>>
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]
Auto Trait Implementations§
impl<'a> !RefUnwindSafe for StellarAssetClient<'a>
impl<'a> !Send for StellarAssetClient<'a>
impl<'a> !Sync for StellarAssetClient<'a>
impl<'a> Unpin for StellarAssetClient<'a>
impl<'a> !UnwindSafe for StellarAssetClient<'a>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T, U, V, E, C> Compare<(T, U, V)> for Cwhere
C: Compare<T, Error = E, Error = E, Error = E> + Compare<U> + Compare<V>,
impl<T, U, V, E, C> Compare<(T, U, V)> for Cwhere
C: Compare<T, Error = E, Error = E, Error = E> + Compare<U> + Compare<V>,
§impl<T, U, V, W, E, C> Compare<(T, U, V, W)> for Cwhere
C: Compare<T, Error = E, Error = E, Error = E, Error = E> + Compare<U> + Compare<V> + Compare<W>,
impl<T, U, V, W, E, C> Compare<(T, U, V, W)> for Cwhere
C: Compare<T, Error = E, Error = E, Error = E, Error = E> + Compare<U> + Compare<V> + Compare<W>,
type Error = E
fn compare( &self, a: &(T, U, V, W), b: &(T, U, V, W) ) -> Result<Ordering, <C as Compare<(T, U, V, W)>>::Error>
§impl<T, U, V, W, X, E, C> Compare<(T, U, V, W, X)> for Cwhere
C: Compare<T, Error = E, Error = E, Error = E, Error = E, Error = E> + Compare<U> + Compare<V> + Compare<W> + Compare<X>,
impl<T, U, V, W, X, E, C> Compare<(T, U, V, W, X)> for Cwhere
C: Compare<T, Error = E, Error = E, Error = E, Error = E, Error = E> + Compare<U> + Compare<V> + Compare<W> + Compare<X>,
type Error = E
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>
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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
.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.