Contract Commands
Every SDK contract method is also a standalone non-interactive
subcommand on the apyx CLI. Each has its own page below with a
synopsis, argument table, example transcript, SDK equivalent, exit
codes, and related recipes.
Quick reference
apxUSD (ERC-20 + permit)
| Command | Kind | SDK |
|---|---|---|
apyx apxUSD balance-of | read | apyx.apxUSD.balanceOf(owner) |
apyx apxUSD allowance | read | apyx.apxUSD.allowance(owner, spender) |
apyx apxUSD total-supply | read | apyx.apxUSD.totalSupply() |
apyx apxUSD approve | write | apyx.apxUSD.approve({ spender, amount }) |
apyx apxUSD transfer | write | apyx.apxUSD.transfer({ to, amount }) |
apyx apxUSD permit | write | apyx.apxUSD.permit({ owner, spender, value, deadline, v, r, s }) |
apyUSD (ERC-4626 vault)
| Command | Kind | SDK |
|---|---|---|
apyx apyUSD exchange-rate | read | apyx.apyUSD.exchangeRate() |
apyx apyUSD total-assets | read | apyx.apyUSD.totalAssets() |
apyx apyUSD convert-to-assets | read | apyx.apyUSD.convertToAssets(shares) |
apyx apyUSD convert-to-shares | read | apyx.apyUSD.convertToShares(assets) |
apyx apyUSD preview-deposit | read | apyx.apyUSD.previewDeposit(assets) |
apyx apyUSD preview-redeem | read | apyx.apyUSD.previewRedeem(shares) |
apyx apyUSD balance-of | read | apyx.apyUSD.balanceOf(owner) |
apyx apyUSD deposit | write | apyx.apyUSD.deposit({ assets, receiver }) |
apyx apyUSD redeem | write | apyx.apyUSD.redeem({ shares, receiver, owner }) |
apyUSDRateView (Ethereum-only)
| Command | Kind | SDK |
|---|---|---|
apyx apyUSDRateView apy | read | apyx.apyUSDRateView?.apy() |
apyx apyUSDRateView annualized-yield | read | apyx.apyUSDRateView?.annualizedYield() |
apyx apyUSDRateView vault | read | apyx.apyUSDRateView?.vault() |
Common conventions
- Flags are kebab-case and map to camelCase SDK arg names.
--receiver↔receiver.--key-path↔keyPath. - All session-start flags (
--profile,--rpc-url,--chain,--key-path,--address-apxusd,--address-apyusd,--address-rate-view) work on every subcommand. - Writes default to wait-for-receipt. Pass
--no-waitto exit after broadcast (returns the hash). - Bigint flags accept plain digits, underscores (
1_234), scientific (1e18), and hex (0xff). Floats are rejected. - Exit codes:
0success,1runtime error (read failure / revert / receipt error),2usage error.
The full source-of-truth for the registry and parsing rules is
src/cli/commands/contract-registry.ts.