Skip to content

Mintlayer Wallet Command Line

Jump to bottom
Enrico Rubboli edited this page Aug 18, 2023 · 6 revisions

Mintlayer Wallet Command Line Documentation

Table of Contents

Wallet Management

  • createwallet: Create a new wallet
  • openwallet: Open an existing wallet
  • closewallet: Close the wallet file
  • encryptprivatekeys: Encrypts the private keys with a new password (wallet must be unlocked)
  • removeprivatekeysencryption: Remove any existing encryption (wallet must be unlocked)
  • unlockprivatekeys: Unlock private keys
  • lockprivatekeys: Lock private keys

Blockchain Information

  • chainstateinfo: Returns the node chainstate
  • bestblock: Returns the current best block hash
  • bestblockheight: Returns the current best block height
  • blockid: Get a block ID at a given height
  • getblock: Retrieve a block by its hash
  • generateblock: Generate a block with specified transactions. If transactions are not provided, it uses available transactions from the mempool
  • generateblocks: Multiple block generation

Accounts and Addresses

  • createnewaccount: Creates a new account. Returns an error if the last created account lacks transaction history
  • selectaccount: Select a wallet account for usage
  • getbalance: Check balance
  • listutxo: List unspent transaction outputs
  • newaddress: Generate a new unused address
  • newpublickey: Generate a new unused public key
  • getvrfpublickey: Retrieve VRF public key

Token Management

  • issuenewtoken: Issue a new token
  • issuenewnft: Issue a new non-fungible token
  • sendtoaddress: Send to a specific address
  • sendtokenstoaddress: Send tokens to a specific address

Staking and Pools

  • startstaking: Start staking
  • stopstaking: Stop staking
  • stakepoolbalance: Check stake pool balance
  • listpoolids: List available pool IDs
  • listdelegationids: List available delegation IDs and their balances
  • createdelegation: Create a new delegation
  • delegatestaking: Delegate for staking
  • sendfromdelegationtoaddress: Send from delegation to a specific address
  • createstakepool: Create a stake pool
  • decommissionstakepool: Decommission a stake pool

Transaction Management

  • submitblock: Submit a block for inclusion in the chain
  • submittransaction: Submit a transaction to the mempool and, if valid, broadcast to the network
  • abandontransaction: Abandon an unconfirmed transaction and free up its inputs for reuse
  • listpendingtransactions: List pending transactions that can be abandoned

Network

  • nodeversion: Retrieve node version
  • nodeshutdown: Shut down the node
  • connect: Connect to a remote peer
  • disconnect: Disconnect a remote peer
  • listbanned: List banned addresses
  • ban: Ban an address
  • unban: Unban an address
  • peercount: Get the count of connected peers
  • connectedpeers: Retrieve a list of connected peers
  • addreservedpeer: Add a reserved peer
  • removereservedpeer: Remove a reserved peer

REPL and Miscellaneous

  • exit: Exit the REPL
  • history: Display command history
  • clear: Clear the screen
  • clearhistory: Clear command history
  • help: Display help message or help for specific subcommands

Clone this wiki locally