Skip to content

commands.md

Latest commit

 

History

History
41 lines (21 loc) · 1.6 KB

commands.md

File metadata and controls

41 lines (21 loc) · 1.6 KB
Raw

NCTL Commands

Overview

Upon successful setup, NCTL commands are made available via aliases for execution from within a terminal session. All such commands are prefixed by nctl- and allow you to perform various tasks:

Node Control Commands

  • For setting up a network see here.

  • For controlling a network see here.

View Commands

  • For viewing account information see here.

  • For viewing chain information see here.

  • For viewing node information see here.

Deploy Dispatch Commands

  • For dispatching simple transfer deploys see here.

  • For dispatching auction deploys see here.

  • For dispatching ERC-20 deploys see here.

Staging Commands

  • For setting up a network from a stage see here.

Notes

  • NOTE 1: all ordinal identifiers are 1 based.

  • NOTE 2: all command parameters have default values to simplify the general case of testing a single local network.

  • NOTE 3: when executing either the nctl-interactive or nctl-start commands, the node logging level output can be assigned by passing in the loglevel parameter. If you do not pass in this variable then NCTL defaults either to the current value of RUST_LOG or debug.

  • NOTE 4: many commands will accept a node parameter to determine to which node a query or deploy will be dispatched. If node=random then a dispatch node is determined JIT. If node=0 then a single node is chosen for dispatch.