Struct polymesh_api::polymesh::api::balances::BalancesCallApi

pub struct BalancesCallApi<'api> { /* private fields */ }

Implementations

impl<'api> BalancesCallApi<'api>

pub fn transfer( &self, dest: MultiAddress<AccountId, u32>, value: u128 ) -> Result<WrappedCall<'api>>

Transfer some liquid free balance to another account.

transfer will set the FreeBalance of the sender and receiver. It will decrease the total issuance of the system by the TransferFee.

The dispatch origin for this call must be Signed by the transactor.

• Dependent on arguments but not critical, given proper implementations for input config types. See related functions below.
• It contains a limited number of reads and writes internally and no complex computation.

Related functions:

• ensure_can_withdraw is always called internally but has a bounded complexity.
• Transferring balances to accounts that did not exist before will cause T::OnNewAccount::on_new_account to be called.

---

• Base Weight: 73.64 µs, worst case scenario (account created, account removed)
• DB Weight: 1 Read and 1 Write to destination account.
• Origin account is already in memory, so no DB operations for them.

pub fn transfer_with_memo( &self, dest: MultiAddress<AccountId, u32>, value: u128, memo: Option<Memo> ) -> Result<WrappedCall<'api>>

Transfer the native currency with the help of identifier string this functionality can help to differentiate the transfers.

• Base Weight: 73.64 µs, worst case scenario (account created, account removed)
• DB Weight: 1 Read and 1 Write to destination account.
• Origin account is already in memory, so no DB operations for them.

pub fn deposit_block_reward_reserve_balance( &self, value: u128 ) -> Result<WrappedCall<'api>>

Move some POLYX from balance of self to balance of BRR.

pub fn set_balance( &self, who: MultiAddress<AccountId, u32>, new_free: u128, new_reserved: u128 ) -> Result<WrappedCall<'api>>

Set the balances of a given account.

This will alter FreeBalance and ReservedBalance in storage. it will also decrease the total issuance of the system (TotalIssuance).

The dispatch origin for this call is root.

pub fn force_transfer( &self, source: MultiAddress<AccountId, u32>, dest: MultiAddress<AccountId, u32>, value: u128 ) -> Result<WrappedCall<'api>>

Exactly as transfer, except the origin must be root and the source account may be specified.

• Same as transfer, but additional read and write because the source account is not assumed to be in the overlay.

pub fn burn_account_balance(&self, amount: u128) -> Result<WrappedCall<'api>>

Burns the given amount of tokens from the caller’s free, unlocked balance.

Trait Implementations

impl<'api> Clone for BalancesCallApi<'api>

fn clone(&self) -> BalancesCallApi<'api>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'api> From<&'api Api> for BalancesCallApi<'api>

fn from(api: &'api Api) -> Self

Converts to this type from the input type.