- Account
- Block
- Chain
- Converter
- Metadata
- Monitor
- Mosaic
- Namespace
- Node
- Profile
- Restriction
- Transaction
- accountaddressrestriction
- accountlink
- accountmetadata
- accountmosaicrestriction
- accountoperationrestriction
- addressalias
- cosign
- info
- mosaic
- mosaicaddressrestriction
- mosaicalias
- mosaicglobalrestriction
- mosaicmetadata
- mosaicsupplychange
- multisigmodification
- namespace
- namespacemetadata
- persistentharvestdelegation
- secretlock
- secretproof
- status
- transfer
Get account information
USAGE
symbol-cli account info [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-a, --address <address> - Account address. Generate new accounts
USAGE
symbol-cli account generate [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
--hd - (Optional) Create an HD wallet.
-u, --url <url> - (Optional) When saving profile, provide a Symbol Node URL. Example: http://localhost:3000
-n, --network <network> - (Optional) Network Type. (MAIN_NET, TEST_NET, MIJIN, MIJIN_TEST)
-p, --password <password> - (Optional) When saving profile, provide the password.
-d, --default - (Optional) Set the profile as default.
-g, --generation-hash <generationHash> - (Optional) Generation hash of the network. Necessary to create the profile offline.
-i, --namespace-id <namespaceId> - (Optional) Namespace Name of the network mosaic. (eg.: symbol.xym) Necessary to create the profile offline.
-v, --divisibility <divisibility> - (Optional) Divisiblity of the network mosaic. (eg.: 6) Necessary to create the profile offline.
-P, --private-key <privateKey> - Account private key.
-M, --mnemonic <mnemonic> - (Optional) Import a profile using a private key.
-N, --path-number <pathNumber> - (Optional) HD wallet path number.
-s, --save - (Optional) Saves the profile. Fetch transactions from account
USAGE
symbol-cli account transactions [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-a, --address <address> - Account address.
-n, --page-size <pageSize> - (Optional) Number of transactions per page. [10]
-i, --id <id> - (Optional) Identifier of the transaction after which we want the transactions to be returned.
-o, --order <order> - (Optional): Order of transactions. DESC. Newer to older. ASC. Older to newer. [DESC] Fetch unconfirmed transactions from account
USAGE
symbol-cli account unconfirmed [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-a, --address <address> - Account address.
-n, --page-size <pageSize> - (Optional) Number of transactions per page. [10]
-i, --id <id> - (Optional) Identifier of the transaction after which we want the transactions to be returned.
-o, --order <order> - (Optional): Order of transactions. DESC. Newer to older. ASC. Older to newer. [DESC] Fetch aggregate bonded transactions from account
USAGE
symbol-cli account aggregatebonded [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-a, --address <address> - Account address.
-n, --page-size <pageSize> - (Optional) Number of transactions per page. [10]
-i, --id <id> - (Optional) Identifier of the transaction after which we want the transactions to be returned.
-o, --order <order> - (Optional): Order of transactions. DESC. Newer to older. ASC. Older to newer. [DESC] Fetch incoming transactions from account
USAGE
symbol-cli account incoming [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-a, --address <address> - Account address.
-n, --page-size <pageSize> - (Optional) Number of transactions per page. [10]
-i, --id <id> - (Optional) Identifier of the transaction after which we want the transactions to be returned.
-o, --order <order> - (Optional): Order of transactions. DESC. Newer to older. ASC. Older to newer. [DESC] Fetch outgoing transactions from account
USAGE
symbol-cli account outgoing [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-a, --address <address> - Account address.
-n, --page-size <pageSize> - (Optional) Number of transactions per page. [10]
-i, --id <id> - (Optional) Identifier of the transaction after which we want the transactions to be returned.
-o, --order <order> - (Optional): Order of transactions. DESC. Newer to older. ASC. Older to newer. [DESC] Get block header by height
USAGE
symbol-cli block header [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-h, --height <height> - Block height. Get the receipts triggered for a given block height
USAGE
symbol-cli block receipts [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-h, --height <height> - Block height. Get transactions for a given block height
USAGE
symbol-cli block transactions [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-a, --address <address> - Account address.
-n, --page-size <pageSize> - (Optional) Number of transactions per page. [10]
-i, --id <id> - (Optional) Identifier of the transaction after which we want the transactions to be returned.
-o, --order <order> - (Optional): Order of transactions. DESC. Newer to older. ASC. Older to newer. [DESC]
-h, --height <height> - Block height. Get the current height of the chain
USAGE
symbol-cli chain height [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.Gets the current score of the chain
USAGE
symbol-cli chain score [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.Address Base 32 -> Address hex converter.
USAGE
symbol-cli converter base32ToHexAddress [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-a, --address <address> - Address. Address hex -> Address Base 32 converter.
USAGE
symbol-cli converter hexToBase32Address [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-a, --address <address> - Address. Namespace name -> NamespaceId converter.
USAGE
symbol-cli converter namespaceNameToId [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-n, --namespace-name <namespaceName> - Namespace name. Numeric string -> UInt64 converter.
USAGE
symbol-cli converter numericStringToUInt64 [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-a, --amount <amount> - Numeric string. Example: 12345678 Payload -> Transaction converter.
USAGE
symbol-cli converter payloadToTransaction [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-p, --payload <payload> - Transaction payload. Private key -> Public key converter.
USAGE
symbol-cli converter privateKeyToPublicKey [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-p, --private-key <privateKey> - Private Key.
-n, --network <network> - Network Type. (MAIN_NET, TEST_NET, MIJIN, MIJIN_TEST) Public key -> Address converter.
USAGE
symbol-cli converter publicKeyToAddress [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-p, --public-key <publicKey> - Public Key.
-n, --network <network> - Network Type. (MAIN_NET, TEST_NET, MIJIN, MIJIN_TEST) String -> UInt64 converter.
USAGE
symbol-cli converter stringToKey [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-v, --value <value> - String value. Fetch metadata entries from an account
USAGE
symbol-cli metadata account [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-a, --address <address> - Account address. Fetch metadata entries from an mosaic
USAGE
symbol-cli metadata mosaic [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-a, --address <address> - Account address.
-m, --mosaic-id <mosaicId> - Mosaic id in hexadecimal format. Fetch metadata entries from an namespace
USAGE
symbol-cli metadata namespace [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-a, --address <address> - Account address.
-n, --namespace-name <namespaceName> - Namespace name. Monitor new blocks
USAGE
symbol-cli monitor block [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.Monitor confirmed transactions added
USAGE
symbol-cli monitor confirmed [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-a, --address <address> - Account address. Monitor unconfirmed transactions added
USAGE
symbol-cli monitor unconfirmed [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-a, --address <address> - Account address. Monitor transaction status error
USAGE
symbol-cli monitor status [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-a, --address <address> - Account address. Monitor cosignatures added
USAGE
symbol-cli monitor cosignature [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-a, --address <address> - Account address. Monitor cosignatures added
USAGE
symbol-cli monitor cosignature [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-a, --address <address> - Account address. Monitors new blocks, confirmed, aggregate bonded added, and status errors related to an account.
USAGE
symbol-cli monitor all [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-a, --address <address> - Account address. Fetch mosaic info
USAGE
symbol-cli mosaic info [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-m, --mosaic-id <mosaicId> - Mosaic id in hexadecimal format. Fetch namespace info
USAGE
symbol-cli namespace info [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-n, --namespace-name <namespaceName> - Namespace name. Example: symbol.xym
-h, --namespace-id <namespaceId> - Namespace id in hexadecimal. Get mosaicId or address behind an namespace
USAGE
symbol-cli namespace alias [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-n, --namespace-name <namespaceName> - Namespace name. Get owned namespaces
USAGE
symbol-cli namespace owned [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-n, --namespace-name <namespaceName> - Namespace name. Example: symbol.xym
-h, --namespace-id <namespaceId> - Namespace id in hexadecimal.
-a, --address <address> - Account address. Get the REST server components versions
USAGE
symbol-cli node info [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.Get information about the connection and services status
USAGE
symbol-cli node health [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.Get information about the REST instance
USAGE
symbol-cli node serverinfo [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.Get diagnostic information about the node storage
USAGE
symbol-cli node storageinfo [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.Create a new profile
USAGE
symbol-cli profile create [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
--hd - (Optional) Create an HD wallet.
-u, --url <url> - (Optional) When saving profile, provide a Symbol Node URL. Example: http://localhost:3000
-n, --network <network> - (Optional) Network Type. (MAIN_NET, TEST_NET, MIJIN, MIJIN_TEST)
-p, --password <password> - (Optional) When saving profile, provide the password.
-d, --default - (Optional) Set the profile as default.
-g, --generation-hash <generationHash> - (Optional) Generation hash of the network. Necessary to create the profile offline.
-i, --namespace-id <namespaceId> - (Optional) Namespace Name of the network mosaic. (eg.: symbol.xym) Necessary to create the profile offline.
-v, --divisibility <divisibility> - (Optional) Divisiblity of the network mosaic. (eg.: 6) Necessary to create the profile offline.
-P, --private-key <privateKey> - Account private key.
-M, --mnemonic <mnemonic> - (Optional) Import a profile using a private key.
-N, --path-number <pathNumber> - (Optional) HD wallet path number. View profile credentials
USAGE
symbol-cli profile decrypt [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.Create a new profile with existing private key
USAGE
symbol-cli profile import [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
--hd - (Optional) Create an HD wallet.
-u, --url <url> - (Optional) When saving profile, provide a Symbol Node URL. Example: http://localhost:3000
-n, --network <network> - (Optional) Network Type. (MAIN_NET, TEST_NET, MIJIN, MIJIN_TEST)
-p, --password <password> - (Optional) When saving profile, provide the password.
-d, --default - (Optional) Set the profile as default.
-g, --generation-hash <generationHash> - (Optional) Generation hash of the network. Necessary to create the profile offline.
-i, --namespace-id <namespaceId> - (Optional) Namespace Name of the network mosaic. (eg.: symbol.xym) Necessary to create the profile offline.
-v, --divisibility <divisibility> - (Optional) Divisiblity of the network mosaic. (eg.: 6) Necessary to create the profile offline.
-P, --private-key <privateKey> - Account private key.
-M, --mnemonic <mnemonic> - (Optional) Import a profile using a private key.
-N, --path-number <pathNumber> - (Optional) HD wallet path number. Display the list of stored profiles
USAGE
symbol-cli profile list [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.Change the default profile
USAGE
symbol-cli profile setdefault [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.Fetch account restrictions assigned to an address
USAGE
symbol-cli restriction account [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-a, --address <address> - Account address. Fetch mosaic restrictions assigned to an address
USAGE
symbol-cli restriction mosaicaddress [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-a, --address <address> - Account address.
-m, --mosaic-id <mosaicId> - Mosaic id in hexadecimal format. Fetch global restrictions assigned to a mosaic
USAGE
symbol-cli restriction mosaicglobal [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-m, --mosaic-id <mosaicId> - Mosaic id in hexadecimal format. Allow or block incoming and outgoing transactions for a given a set of addresses
USAGE
symbol-cli transaction accountaddressrestriction [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-p, --password <password> - Profile password.
-f, --max-fee <maxFee> - Maximum fee (absolute amount).
--sync - (Optional) Wait until the server confirms or rejects the transaction.
--announce - (Optional) Announce the transaction without double confirmation.
-M, --mode <mode> - Transaction announcement mode (normal, multisig)
-S, --signer <signer> - (Multisig only) Transaction signer public key
-F, --max-fee-hash-lock <maxFeeHashLock> - (Multisig aggregate bonded only) Maximum fee (absolute amount) to announce the hash lock transaction.
-D, --lock-duration <lockDuration> - (Multisig aggregate bonded only) Hash lock duration expressed in blocks. [480]
-L, --lock-amount <lockAmount> - (Multisig aggregate bonded only) Relative amount of network mosaic to lock. [10]
-f, --flags <flags> - Restriction flags.(AllowOutgoingAddress, BlockOutgoingAddress, AllowIncomingAddress, BlockIncomingAddress)
-a, --action <action> - Modification action. (Add, Remove).
-v, --recipient-address <recipientAddress> - Address or @alias to allow/block. ERR Unknown subcommand "accountlink".
USAGE
symbol-cli transaction <subcommand>SUBCOMMANDS
accountaddressrestriction - Allow or block incoming and outgoing transactions for a given a set of addresses
accountkeylink - Delegate the account importance to a proxy account. Required for all accounts willing to activate delegated harvesting.
accountmetadata - Add custom data to an account (requires internet)
accountmosaicrestriction - Allow or block incoming transactions containing a given set of mosaics
accountoperationrestriction - Allow or block outgoing transactions by transaction type
addressalias - Set an alias to an address
cosign - Cosign an aggregate bonded transaction
info - Fetch transaction info
mosaic - Create a new mosaic
mosaicaddressrestriction - Set a mosaic restriction to an specific address (requires internet)
mosaicalias - Set an alias to a mosaic
mosaicglobalrestriction - Set a global restriction to a mosaic (requires internet)
mosaicmetadata - Add custom data to a mosaic (requires internet)
mosaicsupplychange - Change a mosaic supply
multisigmodification - Create or modify a multisig account
namespace - Register a namespace
namespacemetadata - Add custom data to a namespace (requires internet)
nodekeylink - Link an account with a public key used by TLS to create sessions. Required for node operators.
persistentharvestdelegation - Requests a node to add a remote account as a delegated harvester
secretlock - Announce a secret lock transaction
secretproof - Announce a secret proof transaction
status - Fetch transaction status
transfer - Send transfer transaction
uri - Announce transaction from URI
votingkeylink - Link an account with a BLS public key. Required for node operators willing to vote finalized blocks.
vrfkeylink - Link an account with a VRF public key. Required for all harvesting eligible accounts. Add custom data to an account (requires internet)
USAGE
symbol-cli transaction accountmetadata [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-p, --password <password> - Profile password.
-f, --max-fee <maxFee> - Maximum fee (absolute amount).
--sync - (Optional) Wait until the server confirms or rejects the transaction.
--announce - (Optional) Announce the transaction without double confirmation.
-M, --mode <mode> - Transaction announcement mode (normal, multisig)
-S, --signer <signer> - (Multisig only) Transaction signer public key
-F, --max-fee-hash-lock <maxFeeHashLock> - (Multisig aggregate bonded only) Maximum fee (absolute amount) to announce the hash lock transaction.
-D, --lock-duration <lockDuration> - (Multisig aggregate bonded only) Hash lock duration expressed in blocks. [480]
-L, --lock-amount <lockAmount> - (Multisig aggregate bonded only) Relative amount of network mosaic to lock. [10]
-t, --target-public-key <targetPublicKey> - Metadata target public key.
-k, --key <key> - Metadata key (UInt64) in hexadecimal format.
-v, --value <value> - Metadata value. Allow or block incoming transactions containing a given set of mosaics
USAGE
symbol-cli transaction accountmosaicrestriction [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-p, --password <password> - Profile password.
-f, --max-fee <maxFee> - Maximum fee (absolute amount).
--sync - (Optional) Wait until the server confirms or rejects the transaction.
--announce - (Optional) Announce the transaction without double confirmation.
-M, --mode <mode> - Transaction announcement mode (normal, multisig)
-S, --signer <signer> - (Multisig only) Transaction signer public key
-F, --max-fee-hash-lock <maxFeeHashLock> - (Multisig aggregate bonded only) Maximum fee (absolute amount) to announce the hash lock transaction.
-D, --lock-duration <lockDuration> - (Multisig aggregate bonded only) Hash lock duration expressed in blocks. [480]
-L, --lock-amount <lockAmount> - (Multisig aggregate bonded only) Relative amount of network mosaic to lock. [10]
-f, --flags <flags> - Restriction flags.(AllowMosaic,BlockMosaic)
-a, --action <action> - Modification action. (Add, Remove).
-v, --mosaic-id <mosaicId> - Mosaic or @alias to allow / block. Allow or block outgoing transactions by transaction type
USAGE
symbol-cli transaction accountoperationrestriction [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-p, --password <password> - Profile password.
-f, --max-fee <maxFee> - Maximum fee (absolute amount).
--sync - (Optional) Wait until the server confirms or rejects the transaction.
--announce - (Optional) Announce the transaction without double confirmation.
-M, --mode <mode> - Transaction announcement mode (normal, multisig)
-S, --signer <signer> - (Multisig only) Transaction signer public key
-F, --max-fee-hash-lock <maxFeeHashLock> - (Multisig aggregate bonded only) Maximum fee (absolute amount) to announce the hash lock transaction.
-D, --lock-duration <lockDuration> - (Multisig aggregate bonded only) Hash lock duration expressed in blocks. [480]
-L, --lock-amount <lockAmount> - (Multisig aggregate bonded only) Relative amount of network mosaic to lock. [10]
-f, --flags <flags> - Restriction flag. (AllowOutgoingTransactionType,BlockOutgoingTransactionType)
-a, --action <action> - Modification action. (Add, Remove).
-v, --transaction-type <transactionType> - Transaction type formatted as hex. Set an alias to an address
USAGE
symbol-cli transaction addressalias [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-p, --password <password> - Profile password.
-f, --max-fee <maxFee> - Maximum fee (absolute amount).
--sync - (Optional) Wait until the server confirms or rejects the transaction.
--announce - (Optional) Announce the transaction without double confirmation.
-M, --mode <mode> - Transaction announcement mode (normal, multisig)
-S, --signer <signer> - (Multisig only) Transaction signer public key
-F, --max-fee-hash-lock <maxFeeHashLock> - (Multisig aggregate bonded only) Maximum fee (absolute amount) to announce the hash lock transaction.
-D, --lock-duration <lockDuration> - (Multisig aggregate bonded only) Hash lock duration expressed in blocks. [480]
-L, --lock-amount <lockAmount> - (Multisig aggregate bonded only) Relative amount of network mosaic to lock. [10]
-a, --action <action> - Alias action (Link, Unlink).
-a, --address <address> - Account address.
-n, --namespace-name <namespaceName> - Namespace name. Cosign an aggregate bonded transaction
USAGE
symbol-cli transaction cosign [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-p, --password <password> - Profile password.
-f, --max-fee <maxFee> - Maximum fee (absolute amount).
--sync - (Optional) Wait until the server confirms or rejects the transaction.
--announce - (Optional) Announce the transaction without double confirmation.
-M, --mode <mode> - Transaction announcement mode (normal, multisig)
-S, --signer <signer> - (Multisig only) Transaction signer public key
-F, --max-fee-hash-lock <maxFeeHashLock> - (Multisig aggregate bonded only) Maximum fee (absolute amount) to announce the hash lock transaction.
-D, --lock-duration <lockDuration> - (Multisig aggregate bonded only) Hash lock duration expressed in blocks. [480]
-L, --lock-amount <lockAmount> - (Multisig aggregate bonded only) Relative amount of network mosaic to lock. [10]
-h, --hash <hash> - Aggregate bonded transaction hash to be signed. Fetch transaction info
USAGE
symbol-cli transaction info [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-h, --hash <hash> - Transaction hash. Create a new mosaic
USAGE
symbol-cli transaction mosaic [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-p, --password <password> - Profile password.
-f, --max-fee <maxFee> - Maximum fee (absolute amount).
--sync - (Optional) Wait until the server confirms or rejects the transaction.
--announce - (Optional) Announce the transaction without double confirmation.
-M, --mode <mode> - Transaction announcement mode (normal, multisig)
-S, --signer <signer> - (Multisig only) Transaction signer public key
-F, --max-fee-hash-lock <maxFeeHashLock> - (Multisig aggregate bonded only) Maximum fee (absolute amount) to announce the hash lock transaction.
-D, --lock-duration <lockDuration> - (Multisig aggregate bonded only) Hash lock duration expressed in blocks. [480]
-L, --lock-amount <lockAmount> - (Multisig aggregate bonded only) Relative amount of network mosaic to lock. [10]
-a, --amount <amount> - Initial supply of mosaics.
-t, --transferable - (Optional) Mosaic transferable.
-s, --supply-mutable - (Optional) Mosaic supply mutable.
-r, --restrictable - (Optional) Mosaic restrictable.
-d, --divisibility <divisibility> - Mosaic divisibility, from 0 to 6.
-u, --duration <duration> - Mosaic duration in amount of blocks.
-n, --non-expiring - (Optional) Mosaic non-expiring. Set a mosaic restriction to an specific address (requires internet)
USAGE
symbol-cli transaction mosaicaddressrestriction [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-p, --password <password> - Profile password.
-f, --max-fee <maxFee> - Maximum fee (absolute amount).
--sync - (Optional) Wait until the server confirms or rejects the transaction.
--announce - (Optional) Announce the transaction without double confirmation.
-M, --mode <mode> - Transaction announcement mode (normal, multisig)
-S, --signer <signer> - (Multisig only) Transaction signer public key
-F, --max-fee-hash-lock <maxFeeHashLock> - (Multisig aggregate bonded only) Maximum fee (absolute amount) to announce the hash lock transaction.
-D, --lock-duration <lockDuration> - (Multisig aggregate bonded only) Hash lock duration expressed in blocks. [480]
-L, --lock-amount <lockAmount> - (Multisig aggregate bonded only) Relative amount of network mosaic to lock. [10]
-m, --mosaic-id <mosaicId> - Mosaic identifier or @alias being restricted.
-a, --target-address <targetAddress> - Address or @alias being restricted.
-k, --restriction-key <restrictionKey> - Restriction key.
-V, --new-restriction-value <newRestrictionValue> - New restriction value. Set an alias to a mosaic
USAGE
symbol-cli transaction mosaicalias [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-p, --password <password> - Profile password.
-f, --max-fee <maxFee> - Maximum fee (absolute amount).
--sync - (Optional) Wait until the server confirms or rejects the transaction.
--announce - (Optional) Announce the transaction without double confirmation.
-M, --mode <mode> - Transaction announcement mode (normal, multisig)
-S, --signer <signer> - (Multisig only) Transaction signer public key
-F, --max-fee-hash-lock <maxFeeHashLock> - (Multisig aggregate bonded only) Maximum fee (absolute amount) to announce the hash lock transaction.
-D, --lock-duration <lockDuration> - (Multisig aggregate bonded only) Hash lock duration expressed in blocks. [480]
-L, --lock-amount <lockAmount> - (Multisig aggregate bonded only) Relative amount of network mosaic to lock. [10]
-a, --action <action> - Alias action (Link, Unlink).
-m, --mosaic-id <mosaicId> - Mosaic id in hexadecimal format.
-n, --namespace-name <namespaceName> - Namespace name. Set a global restriction to a mosaic (requires internet)
USAGE
symbol-cli transaction mosaicglobalrestriction [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-p, --password <password> - Profile password.
-f, --max-fee <maxFee> - Maximum fee (absolute amount).
--sync - (Optional) Wait until the server confirms or rejects the transaction.
--announce - (Optional) Announce the transaction without double confirmation.
-M, --mode <mode> - Transaction announcement mode (normal, multisig)
-S, --signer <signer> - (Multisig only) Transaction signer public key
-F, --max-fee-hash-lock <maxFeeHashLock> - (Multisig aggregate bonded only) Maximum fee (absolute amount) to announce the hash lock transaction.
-D, --lock-duration <lockDuration> - (Multisig aggregate bonded only) Hash lock duration expressed in blocks. [480]
-L, --lock-amount <lockAmount> - (Multisig aggregate bonded only) Relative amount of network mosaic to lock. [10]
-m, --mosaic-id <mosaicId> - Mosaic identifier or @alias being restricted.
-r, --reference-mosaic-id <referenceMosaicId> - (Optional) Identifier of the mosaic providing the restriction key. [0000000000000000]
-k, --restriction-key <restrictionKey> - Restriction key relative to the reference mosaic identifier.
-V, --new-restriction-value <newRestrictionValue> - New restriction value.
-T, --new-restriction-type <newRestrictionType> - New restriction type. (NONE, EQ, GE, GT, LE, LT, NE) Add custom data to a mosaic (requires internet)
USAGE
symbol-cli transaction mosaicmetadata [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-p, --password <password> - Profile password.
-f, --max-fee <maxFee> - Maximum fee (absolute amount).
--sync - (Optional) Wait until the server confirms or rejects the transaction.
--announce - (Optional) Announce the transaction without double confirmation.
-M, --mode <mode> - Transaction announcement mode (normal, multisig)
-S, --signer <signer> - (Multisig only) Transaction signer public key
-F, --max-fee-hash-lock <maxFeeHashLock> - (Multisig aggregate bonded only) Maximum fee (absolute amount) to announce the hash lock transaction.
-D, --lock-duration <lockDuration> - (Multisig aggregate bonded only) Hash lock duration expressed in blocks. [480]
-L, --lock-amount <lockAmount> - (Multisig aggregate bonded only) Relative amount of network mosaic to lock. [10]
-m, --mosaic-id <mosaicId> - Mosaic id be assigned metadata in hexadecimal format.
-t, --target-public-key <targetPublicKey> - Mosaic id owner account public key.
-k, --key <key> - Metadata key (UInt64) in hexadecimal format.
-v, --value <value> - Value of metadata key. Change a mosaic supply
USAGE
symbol-cli transaction mosaicsupplychange [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-p, --password <password> - Profile password.
-f, --max-fee <maxFee> - Maximum fee (absolute amount).
--sync - (Optional) Wait until the server confirms or rejects the transaction.
--announce - (Optional) Announce the transaction without double confirmation.
-M, --mode <mode> - Transaction announcement mode (normal, multisig)
-S, --signer <signer> - (Multisig only) Transaction signer public key
-F, --max-fee-hash-lock <maxFeeHashLock> - (Multisig aggregate bonded only) Maximum fee (absolute amount) to announce the hash lock transaction.
-D, --lock-duration <lockDuration> - (Multisig aggregate bonded only) Hash lock duration expressed in blocks. [480]
-L, --lock-amount <lockAmount> - (Multisig aggregate bonded only) Relative amount of network mosaic to lock. [10]
-a, --action <action> - Mosaic supply change action (Increase, Decrease).
-m, --mosaic-id <mosaicId> - Mosaic id in hexadecimal format.
-d, --amount <amount> - Atomic amount of supply change. Create or modify a multisig account
USAGE
symbol-cli transaction multisigmodification [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-p, --password <password> - Profile password.
-f, --max-fee <maxFee> - Maximum fee (absolute amount).
--sync - (Optional) Wait until the server confirms or rejects the transaction.
--announce - (Optional) Announce the transaction without double confirmation.
-M, --mode <mode> - Transaction announcement mode (normal, multisig)
-S, --signer <signer> - (Multisig only) Transaction signer public key
-F, --max-fee-hash-lock <maxFeeHashLock> - (Multisig aggregate bonded only) Maximum fee (absolute amount) to announce the hash lock transaction.
-D, --lock-duration <lockDuration> - (Multisig aggregate bonded only) Hash lock duration expressed in blocks. [480]
-L, --lock-amount <lockAmount> - (Multisig aggregate bonded only) Relative amount of network mosaic to lock. [10]
-R, --min-removal-delta <minRemovalDelta> - Number of signatures needed to remove a cosignatory. If the account already exists, enter the number of cosignatories to add or remove.
-A, --min-approval-delta <minApprovalDelta> - Number of signatures needed to approve a transaction. If the account already exists, enter the number of cosignatories to add or remove.
-a, --action <action> - Modification Action (Add, Remove).
-p, --cosignatory-public-key <cosignatoryPublicKey> - Cosignatory accounts public keys (separated by a comma).
-u, --multisig-account-public-key <multisigAccountPublicKey> - Multisig account public key. Register a namespace
USAGE
symbol-cli transaction namespace [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-p, --password <password> - Profile password.
-f, --max-fee <maxFee> - Maximum fee (absolute amount).
--sync - (Optional) Wait until the server confirms or rejects the transaction.
--announce - (Optional) Announce the transaction without double confirmation.
-M, --mode <mode> - Transaction announcement mode (normal, multisig)
-S, --signer <signer> - (Multisig only) Transaction signer public key
-F, --max-fee-hash-lock <maxFeeHashLock> - (Multisig aggregate bonded only) Maximum fee (absolute amount) to announce the hash lock transaction.
-D, --lock-duration <lockDuration> - (Multisig aggregate bonded only) Hash lock duration expressed in blocks. [480]
-L, --lock-amount <lockAmount> - (Multisig aggregate bonded only) Relative amount of network mosaic to lock. [10]
-n, --name <name> - Namespace name.
-r, --rootnamespace - Root namespace.
-s, --subnamespace - Sub namespace.
-d, --duration <duration> - Duration (use it with --rootnamespace).
-a, --parent-name <parentName> - Parent namespace name (use it with --subnamespace). Add custom data to a namespace (requires internet)
USAGE
symbol-cli transaction namespacemetadata [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-p, --password <password> - Profile password.
-f, --max-fee <maxFee> - Maximum fee (absolute amount).
--sync - (Optional) Wait until the server confirms or rejects the transaction.
--announce - (Optional) Announce the transaction without double confirmation.
-M, --mode <mode> - Transaction announcement mode (normal, multisig)
-S, --signer <signer> - (Multisig only) Transaction signer public key
-F, --max-fee-hash-lock <maxFeeHashLock> - (Multisig aggregate bonded only) Maximum fee (absolute amount) to announce the hash lock transaction.
-D, --lock-duration <lockDuration> - (Multisig aggregate bonded only) Hash lock duration expressed in blocks. [480]
-L, --lock-amount <lockAmount> - (Multisig aggregate bonded only) Relative amount of network mosaic to lock. [10]
-n, --namespace-id <namespaceId> - Mosaic id be assigned metadata in hexadecimal format.
-t, --target-public-key <targetPublicKey> - Namespace id owner account public key.
-k, --key <key> - Key of metadata.
-v, --value <value> - Metadata key (UInt64) in hexadecimal format. Requests a node to add a remote account as a delegated harvester
USAGE
symbol-cli transaction persistentharvestdelegation [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-p, --password <password> - Profile password.
-f, --max-fee <maxFee> - Maximum fee (absolute amount).
--sync - (Optional) Wait until the server confirms or rejects the transaction.
--announce - (Optional) Announce the transaction without double confirmation.
-M, --mode <mode> - Transaction announcement mode (normal, multisig)
-S, --signer <signer> - (Multisig only) Transaction signer public key
-F, --max-fee-hash-lock <maxFeeHashLock> - (Multisig aggregate bonded only) Maximum fee (absolute amount) to announce the hash lock transaction.
-D, --lock-duration <lockDuration> - (Multisig aggregate bonded only) Hash lock duration expressed in blocks. [480]
-L, --lock-amount <lockAmount> - (Multisig aggregate bonded only) Relative amount of network mosaic to lock. [10]
-r, --remote-private-key <remotePrivateKey> - Private key of the remote account.
-u, --recipient-public-key <recipientPublicKey> - Public key of the node to request persistent harvesting delegation. Announce a secret lock transaction
USAGE
symbol-cli transaction secretlock [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-p, --password <password> - Profile password.
-f, --max-fee <maxFee> - Maximum fee (absolute amount).
--sync - (Optional) Wait until the server confirms or rejects the transaction.
--announce - (Optional) Announce the transaction without double confirmation.
-M, --mode <mode> - Transaction announcement mode (normal, multisig)
-S, --signer <signer> - (Multisig only) Transaction signer public key
-F, --max-fee-hash-lock <maxFeeHashLock> - (Multisig aggregate bonded only) Maximum fee (absolute amount) to announce the hash lock transaction.
-D, --lock-duration <lockDuration> - (Multisig aggregate bonded only) Hash lock duration expressed in blocks. [480]
-L, --lock-amount <lockAmount> - (Multisig aggregate bonded only) Relative amount of network mosaic to lock. [10]
-m, --mosaic-id <mosaicId> - Locked mosaic identifier or @alias.
-a, --amount <amount> - Amount of mosaic units to lock.
-d, --duration <duration> - Number of blocks for which a lock should be valid. Duration is allowed to lie up to 30 days. If reached, the mosaics will be returned to the initiator.
-s, --secret <secret> - Proof hashed in hexadecimal format.
-H, --hash-algorithm <hashAlgorithm> - Algorithm used to hash the proof (Op_Sha3_256, Op_Hash_160, Op_Hash_256).
-r, --recipient-address <recipientAddress> - Address or @alias that receives the funds once unlocked. Announce a secret proof transaction
USAGE
symbol-cli transaction secretproof [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-p, --password <password> - Profile password.
-f, --max-fee <maxFee> - Maximum fee (absolute amount).
--sync - (Optional) Wait until the server confirms or rejects the transaction.
--announce - (Optional) Announce the transaction without double confirmation.
-M, --mode <mode> - Transaction announcement mode (normal, multisig)
-S, --signer <signer> - (Multisig only) Transaction signer public key
-F, --max-fee-hash-lock <maxFeeHashLock> - (Multisig aggregate bonded only) Maximum fee (absolute amount) to announce the hash lock transaction.
-D, --lock-duration <lockDuration> - (Multisig aggregate bonded only) Hash lock duration expressed in blocks. [480]
-L, --lock-amount <lockAmount> - (Multisig aggregate bonded only) Relative amount of network mosaic to lock. [10]
-s, --secret <secret> - Proof hashed in hexadecimal.
-p, --proof <proof> - Original random set of bytes in hexadecimal.
-H, --hash-algorithm <hashAlgorithm> - Algorithm used to hash the proof (Op_Sha3_256, Op_Hash_160, Op_Hash_256).
-r, --recipient-address <recipientAddress> - Address or @alias that receives the funds once unlocked. Fetch transaction status
USAGE
symbol-cli transaction status [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-h, --hash <hash> - Transaction hash. Send transfer transaction
USAGE
symbol-cli transaction transfer [...options]OPTIONS
--profile <profile> - (Optional) Select between your profiles, by providing a profile name.
-p, --password <password> - Profile password.
-f, --max-fee <maxFee> - Maximum fee (absolute amount).
--sync - (Optional) Wait until the server confirms or rejects the transaction.
--announce - (Optional) Announce the transaction without double confirmation.
-M, --mode <mode> - Transaction announcement mode (normal, multisig)
-S, --signer <signer> - (Multisig only) Transaction signer public key
-F, --max-fee-hash-lock <maxFeeHashLock> - (Multisig aggregate bonded only) Maximum fee (absolute amount) to announce the hash lock transaction.
-D, --lock-duration <lockDuration> - (Multisig aggregate bonded only) Hash lock duration expressed in blocks. [480]
-L, --lock-amount <lockAmount> - (Multisig aggregate bonded only) Relative amount of network mosaic to lock. [10]
-r, --recipient-address <recipientAddress> - Recipient address or @alias.
-m, --message <message> - Transaction message.
-e, --encrypted - (Optional) Send an encrypted message. If you set this value, you should set the value of 'recipientPublicKey' as well).
-c, --mosaics <mosaics> - Mosaic to transfer in the format (mosaicId(hex)|@aliasName)::absoluteAmount. Add multiple mosaics with commas.
-u, --recipient-public-key <recipientPublicKey> - (Optional) Recipient public key in an encrypted message.