Struct EsdtTokenPayment

pub struct EsdtTokenPayment<M: ManagedTypeApi> {
    pub token_identifier: TokenIdentifier<M>,
    pub token_nonce: u64,
    pub amount: BigUint<M>,
}

Fields

token_identifier: TokenIdentifier<M>

token_nonce: u64

amount: BigUint<M>

Implementations

impl<M: ManagedTypeApi> EsdtTokenPayment<M>

pub fn new( token_identifier: TokenIdentifier<M>, token_nonce: u64, amount: BigUint<M>, ) -> Self

pub fn token_type(&self) -> EsdtTokenType

pub fn into_tuple(self) -> (TokenIdentifier<M>, u64, BigUint<M>)

pub fn as_egld_or_esdt_payment(&self) -> &EgldOrEsdtTokenPayment<M>

Zero-cost conversion that loosens the EGLD restriction.

It is always safe to do, since the 2 types are guaranteed to have the same layout.

pub fn into_multi_egld_or_esdt_payment(self) -> EgldOrEsdtTokenPayment<M>

Conversion that loosens the EGLD restriction.

impl<M: ManagedTypeApi> EsdtTokenPayment<M>

pub fn backwards_compatible_dep_decode_or_handle_err<I, H>( input: &mut I, h: H, ) -> Result<Self, H::HandledErr>

where I: NestedDecodeInput, H: DecodeErrorHandler,

Deserializer version that accepts bytes encoded with an older version of the code. It uses some assumptions about the possible values of the token identifier to figure it out.

More specifically:

• The old encoding added an extra first byte, indicating the token type.
• Token identifiers cannot be empty and cannot be very long …
• … therefore if the bytes are shifted by 1, we should get an invalid token identifier length.

Even more specifically:

• having the first byte > 0 can only be explained by an older encoding
• having the las byte zero can only mean 2 things:
  • the token identifier is empty - but this is invalid
  • we are reading an older encoding and the las token identifier length byte is the 5th instead of the 4th.

Please do not call directly in contracts, use it via the esdt-token-payment-legacy-decode feature flag instead.

It is only publicly exposed for testing.

impl<M: ManagedTypeApi> EsdtTokenPayment<M>

pub fn as_refs(&self) -> EsdtTokenPaymentRefs<'_, M>

Trait Implementations

impl<M: Clone + ManagedTypeApi> Clone for EsdtTokenPayment<M>

fn clone(&self) -> EsdtTokenPayment<M>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<M: Debug + ManagedTypeApi> Debug for EsdtTokenPayment<M>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<M: ManagedTypeApi> ExternallyMergeable<M> for EsdtTokenPayment<M>

fn can_be_merged_externally_with(&self, other: &Self) -> bool

fn error_if_not_externally_mergeable(&self, other: &Self)

impl<M: ManagedTypeApi> From<(TokenIdentifier<M>, u64, BigUint<M>)> for EsdtTokenPayment<M>

fn from(value: (TokenIdentifier<M>, u64, BigUint<M>)) -> Self

Converts to this type from the input type.

impl<M: ManagedTypeApi> From<EsdtTokenPayment<M>> for EgldOrEsdtTokenPayment<M>

fn from(esdt_payment: EsdtTokenPayment<M>) -> Self

Converts to this type from the input type.

impl<M: ManagedTypeApi> From<EsdtTokenPayment<M>> for EsdtTokenPaymentMultiValue<M>

fn from(obj: EsdtTokenPayment<M>) -> Self

Converts to this type from the input type.

impl<M: ManagedTypeApi> From<EsdtTokenPayment<M>> for MultiEsdtPayment<M>

fn from(value: EsdtTokenPayment<M>) -> Self

Converts to this type from the input type.

impl<'a, Api> From<TestEsdtTransfer<'a>> for EsdtTokenPayment<Api>

where Api: ManagedTypeApi,

fn from(value: TestEsdtTransfer<'a>) -> Self

Converts to this type from the input type.

impl<M: ManagedTypeApi> IntoMultiValue for EsdtTokenPayment<M>

type MultiValue = EsdtTokenPaymentMultiValue<M>

fn into_multi_value(self) -> Self::MultiValue

impl<M: ManagedTypeApi> ManagedVecItem for EsdtTokenPayment<M>

const SKIPS_RESERIALIZATION: bool = false

If true, then the encoding of the item is identical to the payload, and no further conversion is necessary (the underlying buffer can be used as-is during serialization). False for all managed types, but true for basic types (like u32).

type PAYLOAD = ManagedVecItemPayloadBuffer<16>

Type managing the underlying binary representation in a ManagedVec..

type Ref<'a> = ManagedVecRef<'a, EsdtTokenPayment<M>>

Reference representation of the ManagedVec item.

fn read_from_payload(payload: &Self::PAYLOAD) -> Self

Parses given bytes as a an owned object.

unsafe fn borrow_from_payload<'a>(payload: &Self::PAYLOAD) -> Self::Ref<'a>

Parses given bytes as a representation of the object, either owned, or a reference.

fn save_to_payload(self, payload: &mut Self::PAYLOAD)

Converts the object into bytes.

fn payload_size() -> usize

impl<M: ManagedTypeApi> Mergeable<M> for EsdtTokenPayment<M>

fn can_merge_with(&self, other: &Self) -> bool

fn merge_with(&mut self, other: Self)

fn error_if_not_mergeable(&self, other: &Self)

fn merge_with_multiple(&mut self, others: ManagedVec<M, Self>)

where Self: Sized + ManagedVecItem,

impl<M: ManagedTypeApi> NestedDecode for EsdtTokenPayment<M>

fn dep_decode_or_handle_err<I, H>( input: &mut I, h: H, ) -> Result<Self, H::HandledErr>

where I: NestedDecodeInput, H: DecodeErrorHandler,

Version of dep_decode that can handle errors as soon as they occur. For instance in can exit immediately and make sure that if it returns, it is a success. By not deferring error handling, this can lead to somewhat smaller bytecode.

fn dep_decode<I>(input: &mut I) -> Result<Self, DecodeError>

where I: NestedDecodeInput,

Attempt to deserialise the value from input, using the format of an object nested inside another structure. In case of success returns the deserialized value and the number of bytes consumed during the operation.

impl<M: ManagedTypeApi> NestedEncode for EsdtTokenPayment<M>

fn dep_encode_or_handle_err<O, H>( &self, __dest__: &mut O, __h__: H, ) -> Result<(), H::HandledErr>

where O: NestedEncodeOutput, H: EncodeErrorHandler,

Version of dep_encode that can handle errors as soon as they occur. For instance in can exit immediately and make sure that if it returns, it is a success. By not deferring error handling, this can lead to somewhat smaller bytecode.

fn dep_encode<O>(&self, dest: &mut O) -> Result<(), EncodeError>

where O: NestedEncodeOutput,

NestedEncode to output, using the format of an object nested inside another structure. Does not provide compact version.

impl<M: PartialEq + ManagedTypeApi> PartialEq for EsdtTokenPayment<M>

fn eq(&self, other: &EsdtTokenPayment<M>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<M: ManagedTypeApi> TopDecode for EsdtTokenPayment<M>

fn top_decode_or_handle_err<I, H>( top_input: I, h: H, ) -> Result<Self, H::HandledErr>

where I: TopDecodeInput, H: DecodeErrorHandler,

Version of top_decode that can handle errors as soon as they occur. For instance it can exit immediately and make sure that if it returns, it is a success. By not deferring error handling, this can lead to somewhat smaller bytecode.

fn top_decode<I>(input: I) -> Result<Self, DecodeError>

where I: TopDecodeInput,

Attempt to deserialize the value from input.

impl<M: ManagedTypeApi> TopEncode for EsdtTokenPayment<M>

fn top_encode_or_handle_err<O, H>( &self, output: O, __h__: H, ) -> Result<(), H::HandledErr>

where O: TopEncodeOutput, H: EncodeErrorHandler,

Version of top_encode that can handle errors as soon as they occur. For instance in can exit immediately and make sure that if it returns, it is a success. By not deferring error handling, this can lead to somewhat smaller bytecode.

fn top_encode<O>(&self, output: O) -> Result<(), EncodeError>

where O: TopEncodeOutput,

Attempt to serialize the value to ouput.

impl<Env> TxPayment<Env> for &EsdtTokenPayment<Env::Api>

where Env: TxEnv,

fn is_no_payment(&self, _env: &Env) -> bool

Returns true if payment indicates transfer of either non-zero EGLD or ESDT amounts.

fn perform_transfer_execute( self, env: &Env, to: &ManagedAddress<Env::Api>, gas_limit: u64, fc: FunctionCall<Env::Api>, )

Transfer-execute calls have different APIs for different payments types. This method selects between them.

fn with_normalized<From, To, F, R>( self, env: &Env, from: &From, to: To, fc: FunctionCall<Env::Api>, f: F, ) -> R

where From: TxFrom<Env>, To: TxToSpecified<Env>, F: FnOnce(&ManagedAddress<Env::Api>, &BigUint<Env::Api>, FunctionCall<Env::Api>) -> R,

Converts an ESDT call to a built-in function call, if necessary.

fn into_full_payment_data(self, _env: &Env) -> FullPaymentData<Env::Api>

Payment data to be used by the testing framework. Will be refactored.

impl<Env> TxPayment<Env> for EsdtTokenPayment<Env::Api>

where Env: TxEnv,

fn is_no_payment(&self, _env: &Env) -> bool

Returns true if payment indicates transfer of either non-zero EGLD or ESDT amounts.

fn perform_transfer_execute( self, env: &Env, to: &ManagedAddress<Env::Api>, gas_limit: u64, fc: FunctionCall<Env::Api>, )

Transfer-execute calls have different APIs for different payments types. This method selects between them.

fn with_normalized<From, To, F, R>( self, env: &Env, from: &From, to: To, fc: FunctionCall<Env::Api>, f: F, ) -> R

where From: TxFrom<Env>, To: TxToSpecified<Env>, F: FnOnce(&ManagedAddress<Env::Api>, &BigUint<Env::Api>, FunctionCall<Env::Api>) -> R,

Converts an ESDT call to a built-in function call, if necessary.

fn into_full_payment_data(self, _env: &Env) -> FullPaymentData<Env::Api>

Payment data to be used by the testing framework. Will be refactored.

impl<M: ManagedTypeApi> TypeAbi for EsdtTokenPayment<M>

type Unmanaged = EsdtTokenPayment<M>

fn type_name() -> TypeName

fn provide_type_descriptions<TDC: TypeDescriptionContainer>( accumulator: &mut TDC, )

A type can provide more than its own name. For instance, a struct can also provide the descriptions of the type of its fields. TypeAbi doesn’t care for the exact accumulator type, which is abstracted by the TypeDescriptionContainer trait.

fn type_names() -> TypeNames

fn type_name_rust() -> TypeName

impl<M: Eq + ManagedTypeApi> Eq for EsdtTokenPayment<M>

impl<M: ManagedTypeApi> StructuralPartialEq for EsdtTokenPayment<M>

impl<M: ManagedTypeApi> TypeAbiFrom<&EsdtTokenPayment<M>> for EsdtTokenPayment<M>

impl<M: ManagedTypeApi> TypeAbiFrom<EsdtTokenPayment<M>> for EsdtTokenPayment<M>