@aeternity/aepp-cli

aepp-cli-js

Command Line Interface for the æternity blockchain.

Installation

You can install aecli using your preferred tool (yarn or npm). Here's an npm example

$ npm install --global @aeternity/aepp-cli

Quick start

Let's ensure that CLI installed correctly by running $ aecli. It will show the available commands as below.

$ aecli
Usage: aecli [options] [command]

Options:
  -V, --version                                 output the version number
  -h, --help                                    display help for command

Commands:
  account                                       handle wallet operations
  spend [options] <wallet> <receiver> <amount>  send coins to another account or contract
  name                                          manage AENS names
  contract                                      contract interactions
  oracle                                        interact with oracles
  chain                                         make a request to the node
  inspect [options] <identifier>                get details of a node entity
  tx                                            generate transactions to sign and submit manually
  config [options]                              print the current sdk configuration
  select-node [nodeUrl]                         specify node to use in other commands
  select-compiler [compilerUrl]                 specify compiler to use in other commands
  help [command]                                display help for command

To read documentation of other commands and sub-commands, you can append --help. For example, type aecli account --help to get a list of commands available in account module.

The next step is to create a wallet to use in other commands:

$ aecli account create ./wallet.json
Address  ak_21A27UVVt3hDkBE5J7rhhqnH5YNb4Y1dqo4PnSybrH85pnWo7E
Path     /path/to/wallet.json

You need to send some coins to the created wallet.

On testnet you can do that using faucet. Switch to testnet using $ aecli select-node.

Run $ aecli inspect <wallet address> to ensure that it got coins.

$ aecli inspect ak_21A27UVVt3hDkBE5J7rhhqnH5YNb4Y1dqo4PnSybrH85pnWo7E
Account ID       ak_21A27UVVt3hDkBE5J7rhhqnH5YNb4Y1dqo4PnSybrH85pnWo7E
Account balance  10000ae
Account nonce    0
No pending transactions

At the last step, we will send our coins to another account:

$ aecli spend ./wallet.json ak_AgV756Vfo99juwzNVgnjP1gXX1op1QN3NXTxvkPnHJPUDE8NT 42ae
Transaction mined
Transaction hash   th_2muLsbZeFaVJ3tePTnLqobPhxBzwFsm1zUv8sjgMX4LKuevX2T
Block hash         mh_dnoULQWpiRtcrntd5yJPUxcu7YrTu18xZ1e9EC2b8prKdShME
Block height       2 (about now)
Signatures         ["sg_SG5uW5KEGiy5iG1cCkKq4VEdpyvewcW4NjVf4vj2ZoCiap5iB7UQoknWpyWsD4FkziBuGPE88zwXemq3ZvPrdzNtXtKuD"]
Transaction type   SpendTx (ver. 1)
Sender address     ak_21A27UVVt3hDkBE5J7rhhqnH5YNb4Y1dqo4PnSybrH85pnWo7E
Recipient address  ak_AgV756Vfo99juwzNVgnjP1gXX1op1QN3NXTxvkPnHJPUDE8NT
Amount             42ae
Payload            ba_Xfbg4g==
Fee                0.00001684ae
Nonce              1
TTL                4 (about now)

Find out more in the user guide.

Resources

• User guide
• Changelog
• Contributor guide

Commands reference

• account
  • sign — sign a transaction using wallet
  • sign-message — sign a personal message using wallet
  • verify-message — check if message was signed by address
  • address — get wallet address and optionally secret key
  • create — create a wallet by a secret key or generate a new one
• spend — send coins to another account or contract
• name
  • full-claim — claim an AENS name in a single command
  • pre-claim — pre-claim an AENS name
  • claim — claim an AENS name (requires pre-claim)
  • bid — bid on name in auction
  • update — update a name pointer
  • extend — extend name TTL
  • revoke — revoke an AENS name
  • transfer — transfer a name to another account
• contract
  • compile — compile a contract to get bytecode
  • encode-calldata — encode calldata for contract call
  • decode-call-result — decode contract call result
  • call — execute a function of the contract
  • deploy — deploy a contract on the chain
• oracle
  • create — register current account as oracle
  • extend — extend oracle's time to leave
  • create-query — create an oracle query
  • respond-query — respond to an oracle query
• chain
  • top — query the top key/micro block of the chain
  • status — query node version, network id, and related details of the selected node
  • ttl — get relative TTL by absolute TTL
  • play — prints blocks from top until condition
  • broadcast — send signed transaction to the chain
• inspect — get details of a node entity
• tx
  • spend — build spend transaction
  • name-preclaim — build name preclaim transaction
  • name-claim — build name claim transaction
  • name-update — build name update transaction
  • name-transfer — build name transfer transaction
  • name-revoke — build name revoke transaction
  • contract-deploy — build contract deploy transaction
  • contract-call — build contract call transaction
  • oracle-register — build oracle register transaction
  • oracle-extend — build oracle extend transaction
  • oracle-post-query — build oracle post query transaction
  • oracle-respond — build oracle respond transaction
  • verify — verify transaction using node
• config — print the current sdk configuration
• select-node — specify node to use in other commands
• select-compiler — specify compiler to use in other commands

Changelog

7.0.0 (2025-01-30)

aecli migrates to a new secret key format. Use SDK's [tools] page to convert secret keys.

⚠ BREAKING CHANGES

• account: aecli account address accepts --secretKey instead --privateKey

• contract: uses v8 compiler by default

• contract: not compatible with v7 compiler

• aens: commitmentId removed from the JSON output of aecli name pre-claim
  Use tx.commitmentId instead.

• some fields in node responses returned as numbers instead of strings
  Namely:

  • abiVersion
  • vmVersion
  • callerNonce
  • senderNonce
  • oracleTtl.value
  • responseTtl.value
  • queryTtl.value
  • endsAt

• tabbed data aligned without underscores

• width of the first column in tabbed data depends on the content

Features

• narrow first column and remove _ in tables (b5dfdda)
• oracle: make oracleTtl optional (457e4c4)

Bug Fixes

• contract: print details of static call (5c119c5)
• name keystore as filename instead of full path (d8325f6)
• race condition while setting options (1f03275)

Commits with breaking changes

• account: consistently use secret key instead private key (476aec1)
• deps: update sdk to 14.0.0 (894083f)