Skip to main content
CommandDescription
agent [--settlement-only]
[--orders-only]
[--no-restore]
[--no-reject]		Long-running LP / market-maker agent that places orders,
handles RFQs, and settles trades.
onboard
--agent-name <NAME>
--email <EMAIL>
--invite-code <CODE>		Self-service onboarding. Also supports --rpc, --party,
--private-key, --env-file, and --poll-interval.
generate-private-keyGenerate a new Ed25519 private key, no config required.
info balanceShow token balances.
info partyShow party ID, public key, and node name.
info networkShow DSO party, rates, and mining rounds.
info list [--template <ID>]
[--count]		List active contracts, optionally filtered by template ID
or reduced to a count.
buy --market <ID>
--amount <N>
[--price-limit <N>]
[--min-settlement <N>]
[--max-settlement <N>]
[--interval <SECS>]		Buy via RFQ until the target amount is filled.
sell --market <ID>
--amount <N>
[--price-limit <N>]
[--min-settlement <N>]
[--max-settlement <N>]
[--interval <SECS>]		Sell via RFQ until the target amount is filled.
faucet get --token <TOKEN>
[--admin <P>]
[--ticket <TICKET>]
[--amount <N>]
[--dry-run]		Request faucet tokens. CC / Amulet default admin
to DSO. Other tokens use registry lookup or explicit
--admin.
transfer send-cc
--receiver <P>
--amount <N>
[--description <TEXT>]
[--memo-uuid]		Send Canton Coin to another party.
transfer send-cip56
--receiver <P>
--instrument-id <ID>
--instrument-admin <P>
--amount <N>
[--reference <REF>]		Send a CIP-56 token.
transfer accept-cip56
--contract-id <CID>		Accept an incoming CIP-56 transfer offer.
transfer split-cc
--output-amounts a,b,c
--amulet-cids x,y		Split CC into multiple amulets.
transfer batch-pay
[--receiver <P>
--amount <N>]...
[--file <CSV>]
[--description <TEXT>]
[--amulet-cids x,y]		Batch CC payments atomically via multicall, either from
CLI args or a CSV file.
preapproval request
--instrument-admin <P>		Create a CIP-56 TransferPreapproval.
preapproval fetchList existing preapprovals.
subscription request-prepaid
[--amount <USD>]
[--limit <USD>]
[--locked-amount <USD>]
[--lock-days <DAYS>]
[--description <TEXT>]
[--reference <REF>]		Request a prepaid recurring payment.
subscription request-payasyougo
[--app <P>]
[--amount <USD>]
[--description <TEXT>]
[--reference <REF>]		Request a pay-as-you-go subscription.
user-service request
[--reference-id <REF>]
[--party-name <NAME>]		Request a UserService contract for onboarding or setup.
lock holdings ...Lock holdings via LockService.LockHoldings.
Requires lock service contract details, amount,
instrument ID, and fee inputs.
lock vote ...Process voting lock / unlock requests on LockController.
Requires controller details, requests JSON, and fee inputs.
lock resize ...Resize a lock amount on LockController.
Requires controller details, new amount, instrument ID,
and fee inputs.
lock terminate ...Terminate a lock on LockController. Requires
controller details and fee inputs.
sign multihash --input <B64>
[--private-key <KEY>]		Sign a Canton 34-byte multihash.
sign message --input <TEXT>
[--private-key <KEY>]		Sign a UTF-8 text message.
sign binary --input <HEX>
[--private-key <KEY>]		Sign hex-encoded binary data.