Aurora Engine Command-Line Interface (CLI)
Latest version:
Prerequisites
- Node.js (v14+)
Installation
npm install -g @auroraisnear/cliUsage
See https://github.com/aurora-is-near/aurora-engine#usage for usage examples.
Key Management
The CLI will load the following local keys by default, if found:
-
$HOME/.near-credentials/*/*.json: credentials stored by the NEAR CLI -
$HOME/.near/validator_key.json: the localnearcorevalidator key (for thetest.nearmaster account)
Reference
aurora helpaurora installaurora initaurora get-versionaurora get-owneraurora get-bridge-proveraurora get-chain-idaurora get-upgrade-indexaurora get-aurora-erc20aurora stage-upgradeaurora deploy-upgradeaurora deploy-codeaurora callaurora meta-callaurora viewaurora get-codeaurora get-balanceaurora get-nonceaurora get-storage-ataurora begin-chainaurora begin-blockaurora dump-storageaurora encode-addressaurora encode-hash
aurora help
$ aurora help
Usage: aurora [options] [command]
Options:
-d, --debug enable debug output
-v, --verbose enable verbose output
--network <network> specify NEAR network ID (default: "local")
--endpoint <url> specify NEAR RPC endpoint URL
--engine <account> specify Aurora Engine account ID
--signer <account> specify signer account ID (default: "test.near")
-h, --help display help for command
Commands:
install|upgrade [options] <contract>
initialize|init [options]
get-version
get-owner
get-bridge-prover
get-chain-id|get-chain
get-upgrade-index
stage-upgrade
deploy-upgrade
deploy-code|deploy <bytecode>
call <address> <input>
meta-call
view [options] <address> <input>
get-code <address>
get-balance <address>
get-nonce <address>
get-storage-at|get-storage <address> <key>
begin-chain <id>
begin-block <hash>
dump-storage
encode-address <account>
encode-hash <base58>
help [command] display help for commandaurora install
$ aurora install -h
Usage: aurora install|upgrade [options] <contract>
Options:
--chain <id> specify EVM chain ID (default: "0")
--owner <account> specify owner account ID (default: "")
--bridge-prover <account> specify bridge prover account ID (default: "")
--upgrade-delay <blocks> specify upgrade delay block count (default: "0")
-h, --help display help for commandaurora init
$ aurora init -h
Usage: aurora initialize|init [options]
Options:
--chain <id> specify EVM chain ID (default: "0")
--owner <account> specify owner account ID (default: "")
--bridge-prover <account> specify bridge prover account ID (default: "")
--upgrade-delay <blocks> specify upgrade delay block count (default: "0")
-h, --help display help for commandaurora get-version
$ aurora get-version -h
Usage: aurora get-version|get_version [options]
Options:
-h, --help display help for commandaurora get-owner
$ aurora get-owner -h
Usage: aurora get-owner|get_owner [options]
Options:
-h, --help display help for commandaurora get-bridge-prover
$ aurora get-bridge-prover -h
Usage: aurora get-bridge-prover|get_bridge_prover [options]
Options:
-h, --help display help for commandaurora get-chain-id
$ aurora get-chain-id -h
Usage: aurora get-chain-id|get_chain_id [options]
Options:
-h, --help display help for commandaurora get-upgrade-index
$ aurora get-upgrade-index -h
Usage: aurora get-upgrade-index|get_upgrade_index [options]
Options:
-h, --help display help for commandaurora stage-upgrade
$ aurora stage-upgrade -h
Usage: aurora stage-upgrade|stage_upgrade [options]
Options:
-h, --help display help for commandaurora get-aurora-erc20
$ aurora get-aurora-erc20 -h
Usage: aurora get-aurora-erc20 [options] <tokenAddress>
Options:
-h, --help display help for commandaurora deploy-upgrade
$ aurora deploy-upgrade -h
Usage: aurora deploy-upgrade|deploy_upgrade [options]
Options:
-h, --help display help for commandaurora deploy-code
$ aurora deploy-code -h
Usage: aurora deploy-code|deploy [options] <bytecode>
Options:
-h, --help display help for commandaurora call
$ aurora call -h
Usage: aurora call [options] <address> <input>
Options:
-h, --help display help for commandaurora meta-call
$ aurora meta-call -h
Usage: aurora meta-call|meta_call [options]
Options:
-h, --help display help for commandaurora view
$ aurora view -h
Usage: aurora view [options] <address> <input>
Options:
--sender <address> specify the sender address (default:
"0x0000000000000000000000000000000000000000")
--amount <value> attach an ETH amount (default: "0")
-h, --help display help for commandaurora get-code
$ aurora get-code -h
Usage: aurora get-code|get_code [options] <address>
Options:
-h, --help display help for commandaurora get-balance
$ aurora get-balance -h
Usage: aurora get-balance|get_balance [options] <address>
Options:
-h, --help display help for commandaurora get-nonce
$ aurora get-nonce -h
Usage: aurora get-nonce|get_nonce [options] <address>
Options:
-h, --help display help for commandaurora get-storage-at
$ aurora get-storage-at -h
Usage: aurora get-storage-at|get_storage_at [options] <address> <key>
Options:
-h, --help display help for commandaurora begin-chain
$ aurora begin-chain -h
Usage: aurora begin-chain|begin_chain [options] <id>
Options:
-h, --help display help for commandaurora begin-block
$ aurora begin-block -h
Usage: aurora begin-block|begin_block [options] <hash>
Options:
-h, --help display help for commandaurora dump-storage
$ aurora dump-storage -h
Usage: aurora dump-storage|dump_storage [options]
Options:
-h, --help display help for commandaurora encode-address
$ aurora encode-address -h
Usage: aurora encode-address [options] <account>
Options:
-h, --help display help for commandaurora encode-hash
$ aurora encode-hash -h
Usage: aurora encode-hash [options] <base58>
Options:
-h, --help display help for commandDevelopment
Local development
alias aurora='node lib/aurora.js'
export NEAR_URL=http://localhost:3030Release new version
- Bump version in
package.json - Create release in Releases