apyx apyUSD redeem
Burn apyUSD shares from --owner and deliver the corresponding apxUSD to --receiver.
Synopsis
apyx apyUSD redeem --shares <bigint> --receiver <address> --owner <address>
Arguments
| Flag | Type | Required | Description |
|---|---|---|---|
--shares | bigint | yes | Apyusd shares to burn (18-decimal raw). |
--receiver | address | yes | Address to receive the unwrapped apxUSD. |
--owner | address | yes | Address whose shares are burned. Must equal the signer or a pre-approved address. |
Example
$ apyx apyUSD redeem \
--shares 1e18 \
--receiver 0x7E5F4552091A69125d5DfCb7b8C2659029395Bdf \
--owner 0x7E5F4552091A69125d5DfCb7b8C2659029395Bdf
hash: 0x…
waiting for receipt…
status: success
block: 19884120
gas: 158400
SDK equivalent
apyx.apyUSD.redeem({ shares, receiver, owner })
Reference: apyUSD module.
Flags
Inherits all session-start flags: --profile, --rpc-url, --chain, --key-path, --address-apxusd, --address-apyusd, --address-rate-view.
Write-specific flags
| Flag | Default | Effect |
|---|---|---|
--wait / --no-wait | --wait | Wait for the transaction receipt before exiting. --no-wait exits after broadcast (returns the hash). |
Exit codes
| Code | Meaning |
|---|---|
| 0 | transaction broadcast (with --no-wait) or receipt landed with status: success |
| 1 | read error, transaction reverted, or receipt wait failed |
| 2 | usage error (unknown flag, missing required arg, malformed value) |