Skip to content
Taoshi Documentation

Vanta CLI Guide

Vanta CLI is a command-line tool that extends the bittensor-cli tool for Vanta Network operations. It provides enhanced registration functionality with collateral management and extends standard Bittensor wallet, subnet, and stake operations.

Description

Vanta CLI sits on top of the bittensor-cli tool and extends it by customizing and hooking into commands. As a subnet on the Bittensor network, Vanta Network operates on subnet 8 (netuid: 8) on the mainnet/finney network and subnet 116 (netuid: 116) on the testnet. Vanta Network requires additional collateral setup during registration, which this tool automates alongside the standard subnet registration process.

High Level Process Flow

TAO Balance to Miner Setup Flow


TAO Balance to Miner Setup Flow

Detailed Steps

  1. TAO Balance: Ensure sufficient TAO in your wallet for registration, staking, and collateral
  2. Register Miner: Use btcli subnet register to register your miner hotkey on subnet 8/116
  3. Stake TAO: Use vanta stake add to stake TAO to your miner hotkey
  4. Add Collateral: Use vanta collateral deposit to add required collateral
  5. Miner Ready: Your miner is now configured and ready to operate

Network Targeting

  • Mainnet/Finney: Targets subnet 8 (netuid: 8)
  • Testnet: Targets subnet 116 (netuid: 116)
  • Commands automatically select the correct subnet based on the network parameter

Installation

From Source

Terminal window
git clone https://github.com/taoshidev/vanta-cli.git
cd vanta-cli
pip install .

Homebrew (macOS/Linux)

Coming soon

Pip

Coming soon

Commands

All commands are prefixed with vanta. For example: vanta wallet list

Wallet Operations

List Wallets

Terminal window
vanta wallet list [OPTIONS]

Lists all available wallets with registration information.

Options:

  • --wallet-path, --path - Path to wallets directory (default: ~/.bittensor/wallets)

Wallet Overview

Terminal window
vanta wallet overview [OPTIONS]

Shows detailed wallet information including balance and registration status.

Options:

  • --wallet-name, --name - Name of the wallet
  • --wallet-path, --path - Path to wallets directory (default: ~/.bittensor/wallets)
  • --network - Network to connect to (default: finney)
  • --netuid - Netuid for connection (116 for test, 8 for mainnet/finney)
  • --json - Output result as JSON

Create New Coldkey

Terminal window
vanta wallet new_coldkey [OPTIONS]

Creates a new coldkey for the wallet.

Create New Hotkey

Terminal window
vanta wallet new_hotkey [OPTIONS]

Creates a new hotkey for the wallet.

Subnet Operations

Register to Subnet 8

Terminal window
vanta subnets register [OPTIONS]

Registers a neuron to the Vanta Network with automatic collateral setup. Automatically targets:

  • Subnet 8 (netuid: 8) on mainnet/finney
  • Subnet 116 (netuid: 116) on testnet

Options:

  • --wallet-name, --name - Name of the wallet to use for registration
  • --wallet-hotkey, --hotkey - Name of the hotkey to use
  • --wallet-path - Path to wallet directory (default: ~/.bittensor/wallets)
  • --network - Network to connect to (default: test)
  • --era - Era to register for
  • --json - Output result as JSON
  • --prompt/--no-prompt - Whether to prompt for confirmation

Stake Operations

Add Stake

Terminal window
vanta stake add [OPTIONS]

Add stake to hotkeys on the Vanta Network. Automatically targets:

  • Subnet 8 (netuid: 8) on mainnet/finney
  • Subnet 116 (netuid: 116) on testnet

Options:

  • --wallet-name, --name - Name of the wallet to use (required)
  • --wallet-path, --path - Path to wallets directory (default: ~/.bittensor/wallets)
  • --hotkey - Hotkey name to use for staking
  • --network - Network to connect to (default: finney)
  • --amount - Amount of TAO to stake

List Stakes

Terminal window
vanta stake list [OPTIONS]

Lists stakes for a wallet with detailed information.

Options:

  • --wallet-name, --name - Name of the wallet to list stakes for
  • --wallet-path - Path to wallet directory (default: ~/.bittensor/wallets)
  • --network - Network to connect to (default: test)
  • --coldkey_ss58 - Coldkey SS58 address to list stakes for
  • --live - Enable live monitoring of stakes
  • --verbose - Enable verbose output
  • --json - Output result as JSON
  • --prompt/--no-prompt - Whether to prompt for confirmation

Collateral Operations

Add Collateral

Terminal window
vanta collateral deposit [OPTIONS]

Deposit collateral to the Vanta Network.

Options:

  • --wallet-name, --name - Name of the wallet to use for collateral (required)
  • --wallet-path - Path to the wallet directory (default: ~/.bittensor/wallets)
  • --network - Network to connect to (default: test)
  • --amount - Amount of Theta to use for collateral (default: 1)

List Collateral Balance

Terminal window
vanta collateral list [OPTIONS]

Check collateral balance for a miner address.

Options:

  • --miner-address, --miner_address - Miner SS58 address to check collateral balance for (required)
  • --wallet-name, --name - Name of the wallet (for display purposes)
  • --json - Output result as JSON

Withdraw Collateral

Terminal window
vanta collateral withdraw [OPTIONS]

Withdraw collateral from the Vanta Network.

Options:

  • --amount - Amount to withdraw from collateral (required)
  • --miner-address, --miner_address - Miner SS58 address to withdraw collateral for (required)
  • --wallet-name, --name - Name of the wallet (for display purposes)
  • --wallet-path - Path to wallet directory (default: ~/.bittensor/wallets)
  • --prompt/--no-prompt - Whether to prompt for confirmation

Miner Operations

Asset Class Selection

Terminal window
vanta asset select [OPTIONS]

Select an asset class for your miner.

Options:

  • --wallet-name, --name - Name of the miner wallet for signing
  • --hotkey - Miner hotkey name to make asset class selction for
  • --network - Network to connect to (default: test)

Examples

Register to Vanta Network with collateral

Terminal window
# Register on testnet (targets subnet 116)
vanta subnets register --wallet-name my_wallet --hotkey my_hotkey --network test


# Register on mainnet (targets subnet 8)
vanta subnets register --wallet-name my_wallet --hotkey my_hotkey --network finney

List wallet stakes with live monitoring

Terminal window
# List stakes on mainnet
vanta stake list --wallet-name my_wallet --live --network finney


# List stakes on testnet
vanta stake list --wallet-name my_wallet --live --network test

Add stake to all hotkeys

Terminal window
# Add stake on mainnet (subnet 8)
vanta stake add --wallet-name my_wallet --all-hotkeys --amount 10.0 --network finney


# Add stake on testnet (subnet 116)
vanta stake add --wallet-name my_wallet --all-hotkeys --amount 10.0 --network test

View wallet overview

Terminal window
vanta wallet overview --wallet-name my_wallet --network finney

Add collateral

Terminal window
# Add collateral on testnet
vanta collateral deposit --wallet-name my_wallet --amount 1.0 --network test


# Add collateral on mainnet
vanta collateral deposit --wallet-name my_wallet --amount 1.0 --network finney

Check collateral balance

Terminal window
vanta collateral list --miner-address 5HE... --wallet-name my_wallet

Withdraw collateral

Terminal window
vanta collateral withdraw --amount 5.0 --miner-address 5HE... --wallet-name my_wallet

Select asset class

Terminal window
vanta asset select --wallet-name my_wallet --hotkey my_hotkey

Requirements

  • Python 3.10
  • bittensor-cli >= 9.7.1
  • Access to Bittensor network

License

MIT License