Struct TokenClient

Source

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

Expand description

TokenClient is a client for calling the contract defined in “TokenInterface”.

Fields§

§env: Env§address: Address

Implementations§

Source §

impl<'a> TokenClient<'a>

Source

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

Source

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.

Source

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.

Source

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.

Source

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> TokenClient<'a>

Source

pub fn allowance(&self, from: &Address, spender: &Address) -> i128

Returns the allowance for spender to transfer from from.

The amount returned is the amount that spender is allowed to transfer out of from’s balance. When the spender transfers amounts, the allowance will be reduced by the amount transferred.

§Arguments

from - The address holding the balance of tokens to be drawn from.
spender - The address spending the tokens held by from.

Source

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

Returns the allowance for spender to transfer from from.

The amount returned is the amount that spender is allowed to transfer out of from’s balance. When the spender transfers amounts, the allowance will be reduced by the amount transferred.

§Arguments

from - The address holding the balance of tokens to be drawn from.
spender - The address spending the tokens held by from.

Source

pub fn approve( &self, from: &Address, spender: &Address, amount: &i128, expiration_ledger: &u32, )

Set the allowance by amount for spender to transfer/burn from from.

The amount set is the amount that spender is approved to transfer out of from’s balance. The spender will be allowed to transfer amounts, and when an amount is transferred the allowance will be reduced by the amount transferred.

§Arguments

from - The address holding the balance of tokens to be drawn from.
spender - The address being authorized to spend the tokens held by from.
amount - The tokens to be made available to spender.
expiration_ledger - The ledger number where this allowance expires. Cannot be less than the current ledger number unless the amount is being set to 0. An expired entry (where expiration_ledger < the current ledger number) should be treated as a 0 amount allowance.

§Events

Emits an event with topics ["approve", from: Address, spender: Address], data = [amount: i128, expiration_ledger: u32]

Source

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

Set the allowance by amount for spender to transfer/burn from from.

The amount set is the amount that spender is approved to transfer out of from’s balance. The spender will be allowed to transfer amounts, and when an amount is transferred the allowance will be reduced by the amount transferred.

§Arguments

from - The address holding the balance of tokens to be drawn from.
spender - The address being authorized to spend the tokens held by from.
amount - The tokens to be made available to spender.
expiration_ledger - The ledger number where this allowance expires. Cannot be less than the current ledger number unless the amount is being set to 0. An expired entry (where expiration_ledger < the current ledger number) should be treated as a 0 amount allowance.

§Events

Emits an event with topics ["approve", from: Address, spender: Address], data = [amount: i128, expiration_ledger: u32]

Source

pub fn balance(&self, id: &Address) -> i128

Returns the balance of id.

§Arguments

id - The address for which a balance is being queried. If the address has no existing balance, returns 0.

Source

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

Returns the balance of id.

§Arguments

id - The address for which a balance is being queried. If the address has no existing balance, returns 0.

Source

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

Transfer amount from from to to.

§Arguments

from - The address holding the balance of tokens which will be withdrawn from.
to - The address which will receive the transferred tokens.
amount - The amount of tokens to be transferred.

§Events

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

Source

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

Transfer amount from from to to.

§Arguments

from - The address holding the balance of tokens which will be withdrawn from.
to - The address which will receive the transferred tokens.
amount - The amount of tokens to be transferred.

§Events

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

Source

pub fn transfer_from( &self, spender: &Address, from: &Address, to: &Address, amount: &i128, )

Transfer amount from from to to, consuming the allowance that spender has on from’s balance. Authorized by spender (spender.require_auth()).

The spender will be allowed to transfer the amount from from’s balance if the amount is less than or equal to the allowance that the spender has on the from’s balance. The spender’s allowance on from’s balance will be reduced by the amount.

§Arguments

spender - The address authorizing the transfer, and having its allowance consumed during the transfer.
from - The address holding the balance of tokens which will be withdrawn from.
to - The address which will receive the transferred tokens.
amount - The amount of tokens to be transferred.

§Events

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

Source

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

Transfer amount from from to to, consuming the allowance that spender has on from’s balance. Authorized by spender (spender.require_auth()).

The spender will be allowed to transfer the amount from from’s balance if the amount is less than or equal to the allowance that the spender has on the from’s balance. The spender’s allowance on from’s balance will be reduced by the amount.

§Arguments

spender - The address authorizing the transfer, and having its allowance consumed during the transfer.
from - The address holding the balance of tokens which will be withdrawn from.
to - The address which will receive the transferred tokens.
amount - The amount of tokens to be transferred.

§Events

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

Source

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

Burn amount from from.

Reduces from’s balance by the amount, without transferring the balance to another holder’s balance.

§Arguments

from - The address holding the balance of tokens which will be burned from.
amount - The amount of tokens to be burned.

§Events

Emits an event with topics ["burn", from: Address], data = amount: i128

Source

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

Burn amount from from.

Reduces from’s balance by the amount, without transferring the balance to another holder’s balance.

§Arguments

from - The address holding the balance of tokens which will be burned from.
amount - The amount of tokens to be burned.

§Events

Emits an event with topics ["burn", from: Address], data = amount: i128

Source

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

Burn amount from from, consuming the allowance of spender.

Reduces from’s balance by the amount, without transferring the balance to another holder’s balance.

The spender will be allowed to burn the amount from from’s balance, if the amount is less than or equal to the allowance that the spender has on the from’s balance. The spender’s allowance on from’s balance will be reduced by the amount.

§Arguments

spender - The address authorizing the burn, and having its allowance consumed during the burn.
from - The address holding the balance of tokens which will be burned from.
amount - The amount of tokens to be burned.

§Events

Emits an event with topics ["burn", from: Address], data = amount: i128

Source

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

Burn amount from from, consuming the allowance of spender.

Reduces from’s balance by the amount, without transferring the balance to another holder’s balance.

The spender will be allowed to burn the amount from from’s balance, if the amount is less than or equal to the allowance that the spender has on the from’s balance. The spender’s allowance on from’s balance will be reduced by the amount.

§Arguments

spender - The address authorizing the burn, and having its allowance consumed during the burn.
from - The address holding the balance of tokens which will be burned from.
amount - The amount of tokens to be burned.

§Events

Emits an event with topics ["burn", from: Address], data = amount: i128

Source