Archway Developer CLI

Develop WASM smart contracts with the Archway Network's Developer CLI.

Dependencies

Make sure you've installed and configured all dependencies. For the full installation and setup instructions, visit the docs.

• npm
• cargo
• cargo-generate
• docker

If you are on a Linux machine with a distribution different from Ubuntu, you may need to install the GNOME Keyring, or any other keyring compatible with the Secret service API.

CLI Installation

Install the latest published version

npm i -g @archwayhq/cli

or

yarn global add @archwayhq/cli

Install the pre-release version

npm i -g @archwayhq/cli@pre

or

yarn global add @archwayhq/cli@pre

Install the development version

npm i -g 'github:archway-network/archway-cli'

or

yarn global add 'github:archway-network/archway-cli'

Usage

archway [command] [options]

Commands

$ archway help

new                                Initializes a new project repository

accounts new [options]             Adds a new wallet to the keyring
accounts get [options]             Displays details about an account
accounts list [options]            Lists all accounts in the keyring
accounts remove [options]          Removes an account from the keyring
accounts balances get [options]    Query the balance of an address or account
accounts balances send [options]   Send tokens from an address or account to another
accounts balances [options]        Manage the token balance of an account

config init [options]              Initializes a config file for the current project
config show [options]              Displays the config values for the current project
config deployments [options]       Displays the list of deployments, allows filtering by chain, action and contract
config chains use [options]        Switches the current chain in use and updates the config file appropriately
config chains import [options]     Import a chain registry file and save it to the global configuration
config chain-id [options]          Query or update the 'chain-id' in the config file (local or global)
config contracts-path [options]    Query or update the 'contracts-path' in the config file (local or global)
config default-account [options]   Query or update the 'default-account' in the config file (local or global)
config keyring-backend [options]   Query or update the 'keyring-backend' in the config file (local or global)
config keyring-path [options]      Query or update the 'keyring-path' in the config file (local or global)

contracts new [options]            Scaffolds a new Wasm smart contract from a template
contracts build [options]          Builds the smart contracts optimized Wasm file along with its schemas
contracts store [options]          Stores a Wasm file on-chain
contracts instantiate [options]    Instantiates code stored on-chain with the given arguments
contracts metadata [options]       Sets a smart contracts rewards metadata
contracts premium [options]        Sets the smart contract premium flat fee
contracts execute [options]        Executes a transaction in a smart contract
contracts migrate [options]        Runs a smart contract migration
contracts query balance [options]  Access the bank module to query the balance of smart contracts
contracts query smart [options]    Queries a single smart contract

rewards query [options]            Queries the outstanding rewards for a specific account or address
rewards withdraw [options]         Withdraws rewards for a specific account