Commands¶

Profile¶

Create¶

Create a new profile.

Options

-p, --privatekey <privatekey> - Private key
-n, --network <network>       - Network Type: MAIN_NET, TEST_NET, MIJIN, MIJIN_TEST
-u, --url <url>               - NEM2 Node URL. Example: http://localhost:3000
--profile <profile>           - (Optional) profile name, if not private key will be stored as default

Command

$> nem2-cli profile create -p 206CE7E4B16B48430FD2C216E4BB105564B21E21DEE196267B4B33C54F1023FC -n MIJIN_TEST -u http://localhost:3000

List¶

Get the list of stored accounts.

Command

$> nem2-cli profile list

Note

By default, NEM2-CLI will always use the default profile to connect to a node and set default options such as: address, public key and sign transactions with private key. To use a named profile, add the –profile option to any command.

Account¶

Generate new account¶

Generate a new account in a network. This command generates a private key, public key and address.

As seen in the configuration section, generated account can be stored as named profiles by adding a node url.

Options

-s, --save              - (Optional) Save profile
-u, --url <url>         - (Optional) When saving profile, provide a NEM2 Node URL
--profile <profile>     - (Optional) When saving profile you can add profile name, if not will be stored as default
-n, --network <network> - Network Type: MAIN_NET, TEST_NET, MIJIN, MIJIN_TEST

Command

$> nem2-cli account generate --network MIJIN_TEST

Get account info¶

Get information of an account such as public key, importance and mosaics balance.

Options

-a, --address <address> - Address

Command

$> nem2-cli account info --address SDAUTVFWMVXVWWKTTEFTLGUO6HP6MR4GLEK6POJ4

Get confirmed transactions¶

Get an array of confirmed transaction for which an account is signer or recipient.

Options

-p, --publickey <publickey>             - Account public key
-n, --numtransactions <numtransactions> - (optional) Number of transactions
-i, --id <id>                           - (optional) Identifier of the transaction after which we want the transactions to be returned

Command

$> nem2-cli account transactions --publickey C811AC654B77522D5283640CDA7A222AED49B08FF74445F3CD1FD27CD4FB75E3

$> nem2-cli account transactions --publickey C811AC654B77522D5283640CDA7A222AED49B08FF74445F3CD1FD27CD4FB75E3 --numtransactions 40 --id 5A69C893FD331300012A001C

Get incoming transactions¶

Get an array of transactions for which an account is the recipient. A transaction is said to be incoming regarding an account if the account is the recipient of a transaction.

Options

-p, --publickey <publickey>             - Account public key
-n, --numtransactions <numtransactions> - (optional) Number of transactions
-i, --id <id>                           - (optional) Identifier of the transaction after which we want the transactions to be returned

Command

$> nem2-cli account incoming --publickey C811AC654B77522D5283640CDA7A222AED49B08FF74445F3CD1FD27CD4FB75E3

Get outgoing transactions¶

Get an array of transactions for which an account is the sender. A transaction is said to be outgoing regarding an account if the account is the sender of a transaction.

Options

-p, --publickey <publickey>             - Account public key`
-n, --numtransactions <numtransactions> - (optional) Number of transactions
-i, --id <id>                           - (optional) Identifier of the transaction after which we want the transactions to be returned

Command

$> nem2-cli account outgoing --publickey C811AC654B77522D5283640CDA7A222AED49B08FF74445F3CD1FD27CD4FB75E3

Get unconfirmed transactions¶

Get the array of transactions for which an account is the sender or receiver and have not been included in a block yet.

Options

-p, --publickey <publickey>             - Account public key
-n, --numtransactions <numtransactions> - (optional) Number of transactions
-i, --id <id>                           - (optional) Identifier of the transaction after which we want the transactions to be returned

Command

$> nem2-cli account unconfirmedtransactions --publickey C811AC654B77522D5283640CDA7A222AED49B08FF74445F3CD1FD27CD4FB75E3

Get Aggregate bonded transactions¶

Get an array of aggregate bonded transactions for which an account is the sender or has signed the transaction. A transaction is said to be aggregate bonded regarding an account if it is announced, but there still are missing signatures.

Options

-p, --publickey <publickey>             - Account public key
-n, --numtransactions <numtransactions> - (optional) Number of transactions
-i, --id <id>                           - (optional) Identifier of the transaction after which we want the transactions to be returned

Command

$> nem2-cli account aggregatebonded --publickey C811AC654B77522D5283640CDA7A222AED49B08FF74445F3CD1FD27CD4FB75E3

Blockchain¶

Blockchain height¶

Get the current blockchain height.

Command

$> nem2-cli blockchain height

Blockchain score¶

Get the blockchain score.

Command

$> nem2-cli blockchain score

Transaction¶

Transactions are signed with the profiles configured with nem2-cli profile create.

Cosign aggregate bonded transaction¶

Cosign and announce an aggregate bonded transaction.

Options

-h, --hash <hash>       - Aggregate bonded transaction hash to be signed

Command

$> nem2-cli transaction cosign --hash AF92D0A1DC40F786DF455A54F3754E6ACBCEC1B590646404B5ACC85403A92690

Transaction info¶

Get a transaction by its ID.

Options

-h, --hash <hash>       - Transaction hash

Command

$> nem2-cli transaction info --hash AF92D0A1DC40F786DF455A54F3754E6ACBCEC1B590646404B5ACC85403A92690

Send transfer transaction¶

Send a transfer transaction to an account exchanging value and/or data. For this transaction provide recipient, message and mosaics.

You can send multiple mosaics splitting them with a comma, e.g: nem:xem::10,nps:msc::10. The mosaic amount after :: is in absolute value so 1 XEM is 1000000.

Options

-r, --recipient <recipient> - Recipient
-m, --message <message>     - Transaction message
-t, --mosaics <mosaics>     - Mosaic in the format namespaceName:mosaicName::absoluteAmount, add multiple mosaics splitting them with a comma

Command

$> nem2-cli transaction transfer --recipient SDBDG4-IT43MP-CW2W4C-BBCSJJ-T42AYA-LQN7A4-VVWL --message "payout of 10 xem" --mosaics nem:xem::10000000

Send pull transaction¶

Request mosaic funds from an account.

Options

-r, --recipient <recipient>   - Recipient public key
-m, --message <message>       - Message to the funds holder
-x, --mosaic <mosaic>         - Mosaic you want to get in the format namespaceName:mosaicName::absoluteAmount

Command

$> nem2-cli transaction pullfunds --recipient SDBDG4-IT43MP-CW2W4C-BBCSJJ-T42AYA-LQN7A4-VVWL --message "invoice 10 xem" --mosaic nem:xem::10000000

Register root namespace¶

Options

-n, --name <name>             - Namespace name
-r, --rootnamespace           - Root namespace
-d, --duration <duration>     - Duration (use it with --rootnamespace)
-p, --parentname <parentname> - Parent namespace name (use it with --subnamespace)

Command

$> nem2-cli transaction namespace --rootnamespace --duration 100000 --name new-namespace

Register subnamespace¶

Options

-n, --name <name>             - Namespace name
-s, --subnamespace            - Sub namespace
-p, --parentname <parentname> - Parent namespace name (use it with --subnamespace)

Command

$> nem2-cli transaction namespace --subnamespace --parentname new-namespace --name new-subnamespace

Create a mosaic¶

Create a new mosaic.

Options

-m, --mosaicname <mosaicname>       - Mosaic name
-n, --namespacename <namespacename> - Parent namespace name
-a, --amount <amount>               - Amount of tokens
-t, --transferable                  - Mosaic transferable
-s, --supplymutable                 - Mosaic supply mutable
-l, --levymutable                   - Mosaic levy mutable
-d, --divisibility <divisibility>   - Mosaic divisibility, from 0 to 6
-u, --duration <duration>           - Mosaic duration in amount of blocks

Command

$> nem2-cli transaction mosaic --mosaicname token --namespacename new-namespace --amount 1000000 --transferable --supplymutable --divisibility 0 --duration  100000

Namespace¶

Info¶

Get information from a namesapce. Use this command providing the namespace name or the mosaic uint ID in the form of [3646934825,3576016193].

Options

-n, --name <name>   - Namespace Id in string format
-u, --uint <uint>   - Namespace id in uint64 format. [number, number]

Command

$> nem2-cli namespace info --uint [929036875,2226345261]

Mosaic¶

Info¶

Get information from a mosaic. Use this command providing the mosaic identifier name in the form of namespaceName:mosaicName (ex: nem:xem) or the mosaic uint ID in the form of [3646934825,3576016193].

Options

-n, --name <name>   - Mosaic Id in string format
-u, --uint <uint>   - Mosaic id in uint64 format. [number, number]

Command

$> nem2-cli mosaic info --name nem:xem

Monitoring¶

The NEM2 command line interface has a set of monitoring commands to track events in the NEM blockchain.

Block¶

Monitor new confirmed blocks harvested in the blockchain.

Command

$> nem2-cli monitor block

Confirmed transactions¶

Monitor new confirmed transactions signed or received by an account.

Options

-a, --address <address> - Address

Command

$> nem2-cli monitor confirmed --address SCEKUG-H2IJBF-7JZRNK-ECMW52-E66SZ6-ODLB4W-NI7K

Unconfirmed transactions¶

Monitor new unconfirmed transactions signed or received by an account.

Options

-a, --address <address> - Address

Command

$> nem2-cli monitor unconfirmed --address SCEKUG-H2IJBF-7JZRNK-ECMW52-E66SZ6-ODLB4W-NI7K

Aggregate bonded transactions¶

Monitor new aggregate transactions with missing signatures added to an account.

Options

-a, --address <address> - Address

Command

$> nem2-cli monitor aggregatebonded --address SCEKUG-H2IJBF-7JZRNK-ECMW52-E66SZ6-ODLB4W-NI7K

Transaction status¶

Monitor account validation errors.

Options

-a, --address <address> - Address

Command

$> nem2-cli monitor status --address SCEKUG-H2IJBF-7JZRNK-ECMW52-E66SZ6-ODLB4W-NI7K