Skip to main content

subfrost-cli Reference

This page provides a complete reference for all commands, subcommands, and flags available in the subfrost-cli command-line interface. The subfrost-cli is the primary tool for interacting with the SUBFROST network.

Global Options​

These options can be used with any command.

  • --keystore <PATH>: Specifies a path to a custom keystore file.
  • --passphrase <PASSPHRASE>: Specifies the passphrase for the keystore.
  • --circuit <URL>: Specifies the URL of the subrelay to use for circuit relaying.
  • --help: Displays help information.
  • --version: Displays version information.

Main Commands​

frost​

Commands for managing your FROST keystore and participating in signing ceremonies.

Usage:

subfrost-cli frost <SUBCOMMAND>

Subcommands:

  • create: Creates a new FROST keystore.
  • info: Inspects the contents of a FROST keystore.
  • dkg: Starts a Distributed Key Generation (DKG) ceremony.
  • sign: Initiates a signing ceremony.

rail​

Commands for interacting with JSON-RPC services running on the subp2p network.

Usage:

subfrost-cli rail <service-uri> <method> [params...]

proxy​

Commands for running a subproxy server.

Usage:

subfrost-cli proxy <SUBCOMMAND>

Subcommands:

  • --bind-proxy <ADDRESS>: Runs a SOCKS5 proxy server.
  • --reverse-proxy <ADDRESS>: Runs a reverse proxy server.

tun​

Commands for creating a peer-to-peer VPN using subtun.

Usage:

subfrost-cli tun <SUBCOMMAND>

Subcommands:

  • --gateway: Runs a subtun gateway.
  • --connect <ADDRESS>: Connects to a subtun gateway.

wrap​

Commands for wrapping and unwrapping frBTC.

Usage:

subfrost-cli wrap <SUBCOMMAND>

Subcommands:

  • --amount <AMOUNT>: Wraps BTC and mints frBTC.
  • --unwrap: Unwraps frBTC and redeems BTC.

mint-dx-btc​

Commands for minting and burning dxBTC.

Usage:

subfrost-cli mint-dx-btc <SUBCOMMAND>

Subcommands:

  • --amount <AMOUNT>: Mints dxBTC by locking up frBTC.
  • --burn: Burns dxBTC and redeems frBTC.

stake​

Commands for staking dxFROST tokens.

Usage:

subfrost-cli stake <SUBCOMMAND>

Subcommands:

  • --amount <AMOUNT>: Stakes dxFROST tokens.
  • --unstake: Unstakes dxFROST tokens.

governance​

Commands for participating in governance.

Usage:

subfrost-cli governance <SUBCOMMAND>

Subcommands:

  • vote: Votes on a governance proposal.