Loading...
Loading...
Handle payments in MultiversX smart contracts. Use when receiving, validating, or routing EGLD/ESDT payments via self.call_value(), Payment types, or payable endpoints. Covers single, multi, optional, and mixed payment patterns.
npx skill4agent add multiversx/mx-ai-skills multiversx-payment-handlingself.call_value()Payment<M> ← v0.64+ preferred, uses NonZeroBigUint (amount guaranteed > 0)
├── token_identifier: TokenId<M> (unified: EGLD + ESDT)
├── token_nonce: u64
└── amount: NonZeroBigUint<M>
EsdtTokenPayment<M> ← ESDT-only (no EGLD), BigUint amount (can be 0 in theory)
├── token_identifier: EsdtTokenIdentifier<M>
├── token_nonce: u64
└── amount: BigUint<M>
EgldOrEsdtTokenPayment<M> ← Legacy mixed type
├── token_identifier: EgldOrEsdtTokenIdentifier<M>
├── token_nonce: u64
└── amount: BigUint<M>
PaymentVec<M> = ManagedVec<M, Payment<M>> ← List of payments
FungiblePayment<M> ← Payment with nonce == 0 guaranteed// Payment<M>
payment.is_fungible() -> bool
payment.fungible_or_panic() -> FungiblePayment<M>
payment.into_tuple() -> (TokenId<M>, u64, NonZeroBigUint<M>)
payment.as_egld_or_esdt_payment() -> &EgldOrEsdtTokenPayment<M>
payment.map_egld_or_esdt(ctx, for_egld, for_esdt) -> U
// NonZeroBigUint<M>
NonZeroBigUint::new(bu: BigUint<M>) -> Option<Self> // None if zero
NonZeroBigUint::new_or_panic(bu: BigUint<M>) -> Self // panics if zero
nzbu.into_big_uint() -> BigUint<M>
nzbu.as_big_uint() -> &BigUint<M>self.call_value()| Method | Returns | Behavior |
|---|---|---|
| | Accepts EGLD only, panics if ESDT sent. Handles both direct and multi-transfer EGLD. |
| | EGLD as 18-decimal |
| | Raw EGLD from VM. Returns 0 even if ESDT was sent. Low-level, rarely needed. |
| Method | Returns | Behavior |
|---|---|---|
| | Exactly 1 transfer (EGLD or ESDT). Panics if 0 or 2+. Preferred for v0.64+. |
| | 0 or 1 transfer. Panics if 2+. |
| | Exactly 1 ESDT. Panics if EGLD or count != 1. |
| | Exactly 1 fungible ESDT (nonce == 0). |
| | 0 or 1 transfer. Returns EGLD(0) if nothing sent. |
| | Like above but panics if non-fungible. |
| Method | Returns | Behavior |
|---|---|---|
| | Recommended. All transfers as |
| | All transfers as legacy type. |
| | ESDT only. Panics if EGLD present in multi-transfer. |
| Method | Returns | Behavior |
|---|---|---|
| | Exactly N transfers (any type). Panics if count != N. |
| | Exactly N ESDT transfers. Rejects EGLD. |
| | Exactly N transfers (legacy type). |
| Deprecated | Replacement | Since |
|---|---|---|
| | v0.55 — doesn't handle multi-transfer EGLD properly |
| | v0.64 — legacy EGLD-or-multi split no longer meaningful |
#[payable]
#[endpoint(deposit)]
fn deposit(&self) {
let payment = self.call_value().single();
// payment.token_identifier, payment.token_nonce, payment.amount (NonZeroBigUint)
self.deposits(&self.blockchain().get_caller())
.update(|total| *total += payment.amount.as_big_uint());
}#[payable("EGLD")]
#[endpoint(delegate)]
fn delegate(&self) {
let payment = self.call_value().egld().clone_value();
require!(payment >= MIN_EGLD, "Below minimum");
}#[payable]
#[endpoint(repay)]
fn repay(&self) {
let payments = self.call_value().all();
for payment in payments.iter() {
require!(
self.is_accepted_token(&payment.token_identifier),
"Token not accepted"
);
self.process_repayment(&payment);
}
}#[payable]
#[endpoint(addLiquidity)]
fn add_liquidity(&self) {
let [token_a, token_b] = self.call_value().array::<2>();
require!(token_a.token_identifier != token_b.token_identifier, "Same token");
}#[payable]
#[endpoint(interact)]
fn interact(&self) {
match self.call_value().single_optional() {
Some(payment) => self.handle_deposit(&payment),
None => self.handle_claim(),
}
}#[payable]
#[endpoint(addRewards)]
fn add_reward(&self) {
let payment = self.call_value().egld_or_single_esdt();
let pool = self.pool_for_token(&payment.token_identifier);
self.tx().to(&pool)
.typed(PoolProxy)
.deposit()
.payment(payment)
.returns(ReturnsResult)
.sync_call();
}// Transfer single Payment to caller
let caller = self.blockchain().get_caller();
self.tx().to(&caller).payment(payment.clone()).transfer();
// Transfer EGLD
self.tx().to(&caller).egld(&amount).transfer();// BAD: using deprecated egld_value — misses EGLD in multi-transfer
let value = self.call_value().egld_value(); // ← DEPRECATED since v0.55
// GOOD: use egld() which handles both direct and multi-transfer
let value = self.call_value().egld();
// BAD: using any_payment — legacy split
let payment = self.call_value().any_payment(); // ← DEPRECATED since v0.64
// GOOD: use all() for uniform handling
let payments = self.call_value().all();
// BAD: not validating token before processing
let payment = self.call_value().single();
self.do_something(&payment); // What if wrong token?
// GOOD: validate token identity
let payment = self.call_value().single();
require!(
payment.token_identifier == self.accepted_token().get(),
"Wrong token"
);