Struct CallValueWrapper

pub struct CallValueWrapper<A>
where
    A: CallValueApi + ErrorApi + ManagedTypeApi,
{ /* private fields */ }

Implementations

impl<A> CallValueWrapper<A>

where A: CallValueApi + ErrorApi + ManagedTypeApi,

pub fn new() -> Self

pub fn egld_direct_non_strict(&self) -> ManagedRef<'static, A, BigUint<A>>

Retrieves the EGLD call value from the VM.

Will return 0 in case of an ESDT transfer, even though EGLD and ESDT transfers are now posible.

pub fn egld(&self) -> ManagedRef<'static, A, BigUint<A>>

Retrieves the EGLD call value and crashes if anything else was transferred.

Accepts both EGLD sent directly, as well as EGLD sent alone in a multi-transfer.

Does not accept a multi-transfer with 2 or more transfers, not even 2 or more EGLD transfers.

pub fn egld_value(&self) -> ManagedRef<'static, A, BigUint<A>>

👎Deprecated since 0.55.0: Does not cover multi-transfer scenarios properly, but left for backwards compatibility. Please use .egld() instead!

Retrieves the EGLD call value from the VM.

Will return 0 in case of an ESDT transfer, even though EGLD and ESDT transfers are now posible.

Important!

Does not cover multi-transfer scenarios properly, but left for backwards compatibility.

Please use .egld() instead!

For raw handling, .egld_direct_non_strict() is also acceptable.

pub fn egld_decimal(&self) -> ManagedDecimal<A, ConstDecimals<18>>

Returns the EGLD call value from the VM as ManagedDecimal

pub fn all_esdt_transfers( &self, ) -> ManagedRef<'static, A, ManagedVec<A, EsdtTokenPayment<A>>>

Returns all ESDT transfers that accompany this SC call. Will return 0 results if nothing was transfered, or just EGLD.

Will crash for EGLD + ESDT multi transfers.

pub fn all_transfers( &self, ) -> ManagedRef<'static, A, ManagedVec<A, EgldOrEsdtTokenPayment<A>>>

Will return all transfers in the form of a list of EgldOrEsdtTokenPayment.

Both EGLD and ESDT can be returned.

In case of a single EGLD transfer, only one item will be returned, the EGLD payment represented as an ESDT transfer (EGLD-000000).

pub fn multi_esdt<const N: usize>( &self, ) -> [ManagedVecRef<'static, EsdtTokenPayment<A>>; N]

Verify and casts the received multi ESDT transfer in to an array.

Can be used to extract all payments in one line like this:

let [payment_a, payment_b, payment_c] = self.call_value().multi_esdt();.

Rejects EGLD transfers. Switch to multi_egld_or_esdt to accept mixed transfers.

pub fn multi_egld_or_esdt<const N: usize>( &self, ) -> [ManagedVecRef<'static, EgldOrEsdtTokenPayment<A>>; N]

Verify and casts the received multi ESDT transfer in to an array.

Can be used to extract all payments in one line like this:

let [payment_a, payment_b, payment_c] = self.call_value().multi_egld_or_esdt();.

pub fn single_esdt(&self) -> ManagedVecRef<'static, EsdtTokenPayment<A>>

Expects precisely one ESDT token transfer, fungible or not.

Will return the received ESDT payment.

The amount cannot be 0, since that would not qualify as an ESDT transfer.

pub fn single_fungible_esdt( &self, ) -> (ManagedRef<'static, A, TokenIdentifier<A>>, ManagedRef<'static, A, BigUint<A>>)

Expects precisely one fungible ESDT token transfer.

Returns the token ID and the amount for fungible ESDT transfers.

The amount cannot be 0, since that would not qualify as an ESDT transfer.

pub fn egld_or_single_esdt(&self) -> EgldOrEsdtTokenPayment<A>

Accepts and returns either an EGLD payment, or a single ESDT token.

Will halt execution if more than one ESDT transfer was received.

In case no transfer of value happen, it will return a payment of 0 EGLD.

pub fn egld_or_single_fungible_esdt( &self, ) -> (EgldOrEsdtTokenIdentifier<A>, BigUint<A>)

Accepts and returns either an EGLD payment, or a single fungible ESDT token.

Will halt execution if more than one ESDT transfer was received, or if the received ESDT is non- or semi-fungible.

Works similar to egld_or_single_esdt, but checks the nonce to be 0 and returns a tuple of just token identifier and amount, for convenience.

In case no transfer of value happen, it will return a payment of 0 EGLD.

pub fn any_payment(&self) -> EgldOrMultiEsdtPayment<A>

Accepts any sort of patyment, which is either:

• EGLD (can be zero in case of no payment whatsoever);
• Multi-ESDT (one or more ESDT transfers).

Trait Implementations

impl<A> Default for CallValueWrapper<A>

where A: CallValueApi + ErrorApi + ManagedTypeApi + Default,

fn default() -> CallValueWrapper<A>

Returns the “default value” for a type.