Skip to content

send.md

Latest commit

 

History

History
116 lines (85 loc) · 5.96 KB

send.md

File metadata and controls

116 lines (85 loc) · 5.96 KB
Raw

wallet-cli contract send

State-changing contract call (triggerSmartContract).

Synopsis

wallet-cli contract send --contract <address> --method <sig> [--params <json>]
                         [--call-value-sun <n>] [--fee-limit <sun>]
                         [--dry-run | (--sign-only | --build-only) [--expiration <ms>] | --wait [--wait-timeout <ms>]] [--permission-id <n>] [options]

Description

Builds, signs, and broadcasts a state-changing contract call from the active account (or --account). Parameters follow the same {type,value} JSON-array convention as contract call; --call-value-sun attaches native TRX to the call.

Two early exits: --dry-run previews the energy cost (estimateEnergy) without signing or broadcasting; --sign-only signs and prints the transaction for a later tx broadcast.

By default the command returns at submission (stage: "submitted") — add --wait to block until confirmed/failed. With --wait, an on-chain execution failure (revert / OUT_OF_ENERGY) comes back as stage: "failed" with the result reason.

Requires an account. The master password (via --password-stdin) is needed only by the modes that sign — --dry-run and --build-only do not unlock the wallet and run without it. Watch-only accounts fail with watch_only_no_signer in a signing mode.

Options

Option Description
--contract <string> Required. Contract address
--method <string> Required. Function signature, e.g. transfer(address,uint256)
--params <string> JSON array of ABI parameters as {type,value}
--call-value-sun <number> Native TRX attached to the call, in SUN (default 0)
--fee-limit <number> Max energy fee to burn, in SUN (default 100000000)
--dry-run Estimate energy only, no signature/broadcast; excludes --sign-only / --build-only
--sign-only Sign without broadcasting, output the signed hex; excludes --dry-run / --build-only; pairs with --expiration
--build-only Build only, output the unsigned hex; excludes --dry-run / --sign-only; pairs with --expiration
--expiration <ms> Transaction expiration in ms, up to 86400000 (24h); only with --sign-only or --build-only; omitted = node default (~60s)
--permission-id <n> Permission group to sign with (0=owner, 1=witness, 2–9=active); default 0
--wait / --wait-timeout <ms> Poll after broadcast until confirmed/failed (cap default: config waitTimeoutMs, built-in 60000)
--password-stdin Master password from stdin

Plus the global options.

Examples

In the examples, $PW is your master password (from an environment variable, password manager, etc.), fed on stdin via --password-stdin.

Default — broadcasts and returns the submitted receipt:

echo "$PW" | wallet-cli contract send --contract TXYZopYRdj2D9XRtbG411XZZ3kM5VkAeBf --method "transfer(address,uint256)" --params '[{"type":"address","value":"TSx72ViULFepRGCS4PM5dP4FqD1d8qggCc"},{"type":"uint256","value":"1000000"}]' --network tron:nile --password-stdin
⏳ Called transfer
  TxID    c8d...
  Status  pending — not yet on-chain
! Track it: wallet-cli tx info --network tron:nile --txid c8d...
echo "$PW" | wallet-cli contract send --contract TXYZopYRdj2D9XRtbG411XZZ3kM5VkAeBf --method "transfer(address,uint256)" --params '[...]' --network tron:nile --password-stdin -o json
{"schema":"wallet-cli.result.v1","success":true,"command":"contract.send","data":{"kind":"contract-send","stage":"submitted","txId":"c8d...","method":"transfer(address,uint256)","contract":"TXYZopYRdj2D9XRtbG411XZZ3kM5VkAeBf"},"meta":{"durationMs":15,"warnings":[]},"chain":{"family":"tron","network":"tron:nile","chainId":"nile"}}

With --wait, blocks until confirmed — on success:

echo "$PW" | wallet-cli contract send --contract TXYZopYRdj2D9XRtbG411XZZ3kM5VkAeBf --method "transfer(address,uint256)" --params '[...]' --network tron:nile --wait --password-stdin
✅ Called transfer
  Contract  TXYZopYRdj2D9XRtbG411XZZ3kM5VkAeBf
  TxID      0adc5737b724d35c486a05a169b64a01ad311ed27f79d308f245b00c69b3bc42
  Block     #69,095,391
  Energy    14,584
  Fee       0.345 TRX
  Status    success

An on-chain failure (e.g. out of energy) returns stage: "failed":

echo "$PW" | wallet-cli contract send --contract TXYZopYRdj2D9XRtbG411XZZ3kM5VkAeBf --method "transfer(address,uint256)" --params '[...]' --network tron:nile --wait --password-stdin
❌ Called transfer
  TxID    c8d...
  Block   #66,000,123
  Energy  31,200
  Status  failed
  Reason  OUT_OF_ENERGY

Output

data varies by stage:

Mode Fields
default (submit) kind: "contract-send", stage: "submitted", txId, method, contract
--wait (confirmed/failed) above, but stage: "confirmed" or "failed", plus confirmed, blockNumber, feeSun, energyUsed, result (SUCCESS / OUT_OF_ENERGY, etc.), failed
--dry-run kind, mode: "dry-run", fee (feeModel, estimated energy, availableEnergy), unsigned tx
--sign-only kind, mode: "sign-only", hex (signed transaction hex), signed (the same transaction as a TRON tx object incl. signature[]), address (signer), txId, fee, method, contract
--build-only kind, mode: "build-only", hex (unsigned transaction hex), unsigned tx (TRON tx object), fee, method, contract

Exit status

0 submitted (or built/signed in early-exit modes) · 1 execution failure (watch_only_no_signer, auth_failed, rpc_error, timeout — on timeout the tx may still be in flight; check tx status) · 2 usage error (invalid_value, conflicting modes).

See also

contract call · contract deploy · tx broadcast · Energy & bandwidth