Skip to content

Latest commit

 

History

History
159 lines (112 loc) · 3.87 KB

README.md

File metadata and controls

159 lines (112 loc) · 3.87 KB

ethrex L2 CLI

Table of Contents

How to install

Running the command below will install the ethrex_l2 binary in your system.

cargo install --path .

Commands

Usage: ethrex_l2 <COMMAND>

Commands:
  stack         Stack related commands.
  wallet        Wallet interaction commands. The configured wallet could operate both with the L1 and L2 networks. [aliases: w]
  config        CLI config commands.
  autocomplete  Generate shell completion scripts.
  help          Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version

Important

Most of the CLI interaction needs a configuration to be set. You can set a configuration with the config command.

config

CLI config commands.

Usage: ethrex_l2 config <COMMAND>

Commands:
  edit     Edit an existing config.
  create   Create a new config.
  set      Set the config to use.
  display  Display a config.
  list     List all configs.
  delete   Delete a config.
  help     Print this message or the help of the given subcommand(s)

Options:
  -h, --help  Print help

stack

Stack related commands.

Usage: ethrex_l2 stack <COMMAND>

Commands:
  init      Initializes the L2 network in the provided L1. [aliases: i]
  shutdown  Shutdown the stack.
  start     Starts the stack.
  purge     Cleans up the stack. Prompts for confirmation.
  restart   Re-initializes the stack. Prompts for confirmation.
  help      Print this message or the help of the given subcommand(s)

Options:
  -h, --help  Print help

wallet

Note

This command is a work in progress. It requires basic L2 functionality to be implemented.

Wallet interaction commands. The configured wallet could operate both with the L1 and L2 networks.

Usage: ethrex_l2 wallet <COMMAND>

Commands:
  balance            Get the balance of the wallet.
  deposit            Deposit funds into some wallet.
  finalize-withdraw  Finalize a pending withdrawal.
  transfer           Transfer funds to another wallet.
  withdraw           Withdraw funds from the wallet.
  address            Get the wallet address.
  private-key        Get the wallet private key.
  help               Print this message or the help of the given subcommand(s)

Options:
  -h, --help  Print help

autocomplete

Generate shell completion scripts.

Usage: ethrex_l2 autocomplete <COMMAND>

Commands:
  generate  Generate autocomplete shell script.
  install   Generate and install autocomplete shell script.
  help      Print this message or the help of the given subcommand(s)

Options:
  -h, --help  Print help

Examples

config

Adding a configuration

Editing exiting configuration interactively

Deleting existing configuration interactively

Setting a configuration interactively

stack

Initializing the stack

Restarting the stack