Struct soroban_sdk::token::Client

source ·

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

Expand description

Client is a client for calling the contract defined in “Interface”.

Fields§

§env: Env§address: Address

Implementations§

source §

impl<'a> Client<'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 sigantures, 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::set_auths for more details and examples.

source §

impl<'a> Client<'a>

source

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

Returns the allowance for spender to transfer from from.

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, <Error as TryFrom<Error>>::Error>>

Returns the allowance for spender to transfer from from.

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.

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 availabe 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, <Error as TryFrom<Error>>::Error>>

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

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 availabe 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, <Error as TryFrom<Error>>::Error>>

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 spendable_balance(&self, id: &Address) -> i128

Returns the spendable balance of id.

Arguments

id - The address for which a spendable balance is being queried. This will return the same value as balance() unless this is called on the Stellar Asset Contract, in which case this can be less due to reserves/liabilities.

source

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

Returns the spendable balance of id.

Arguments

id - The address for which a spendable balance is being queried. This will return the same value as balance() unless this is called on the Stellar Asset Contract, in which case this can be less due to reserves/liabilities.

source

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.

source

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

Returns true if id is authorized to use its balance.

Arguments

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

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, <Error as TryFrom<Error>>::Error>>

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 of spender. Authorized by spender (spender.require_auth()).

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, <Error as TryFrom<Error>>::Error>>

Transfer amount from from to to, consuming the allowance of spender. Authorized by spender (spender.require_auth()).

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.

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, <Error as TryFrom<Error>>::Error>>

Burn amount from from.

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.

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, <Error as TryFrom<Error>>::Error>>

Burn amount from from, consuming the allowance of spender.

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