Difference between revisions of "PoP Miner CommandLine"

From Veriblock Wiki
Jump to: navigation, search
(Created page with "See: HowTo_run_PoP_Miner_v2#Status_Codes __TOC__ == Overview == == Operation Commands == === getoperation === getoperation <id> Gets the details of the supplied ope...")
 
 
(8 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
See: [[HowTo_run_PoP_Miner_v2#Status_Codes]]
+
See: [[Main_Page]], [[HowTo_run_PoP_Miner#Status_Codes]]
  
 
__TOC__
 
__TOC__
Line 6: Line 6:
  
  
−
== Operation Commands ==
+
== Commands ==
 +
 
 +
=== clear ===
 +
<nowiki>clear</nowiki>
 +
 
 +
Clears the console screen
 +
 
 +
=== exit | quit ===
 +
<nowiki>exit</nowiki>
 +
<nowiki>quit</nowiki>
 +
 
 +
Both commands may be used interchangeably and gracefully shut down the application. Exiting the application with these two commands is the best way to ensure spvchain and wallet files do not become corrupted.
 +
 
 +
=== exportbitcoinkeys ===
 +
 
 +
<nowiki>exportbitcoinkeys</nowiki>
 +
 
 +
Dumps the Bitcoin private keys used by the wallet to a text file in Bitcoin WIF format.
 +
 
 +
This is useful for consolidating many wallets.
  
 
=== getoperation ===
 
=== getoperation ===
  
−
getoperation <id>
+
<nowiki>getoperation <id></nowiki>
  
−
Gets the details of the supplied operation
+
Displays the state of an operation by looking up the specified id.
  
−
=== listoperations===
+
=== getpopendorsementinfo ===
  
−
Lists the current running operations
+
<nowiki>getpopendorsementinfo</nowiki>
  
−
=== mine ===
+
Displays information regarding PoP endorsements for the miner's address.
  
−
Begins a proof of proof mining operation
+
=== help ===
  
−
This requires a NodeCore instance running and Bitcoin in the PoP Wallet address.
+
<nowiki>help [command]</nowiki>
  
−
=== resubmit ===
+
Lists the available commands. If a specific command is passed as an argument, displays more detailed information about that command.
  
−
resubmit <id>
+
=== importwallet ===
  
−
Resubmits an operation
+
<nowiki>importwallet <seedWords> [creationTime]</nowiki>
  
−
== Config Commands ==
+
Imports a Bitcoin wallet using a BIP39 seed phrase. Seed words are 12 words, separated by commas, with no spaces. The creation time is an optional parameter but is useful for speeding up the time it takes to download the necessary blocks for the wallet.
 +
Example:
 +
<nowiki>importwallet identify,weapon,advice,siege,parrot,aisle,together,flavor,stand,final,clerk,tuna 1539613463</nowiki>
  
 
=== listconfig ===
 
=== listconfig ===
 +
 +
<nowiki>listconfig</nowiki>
  
 
Lists the current configuration properties and values
 
Lists the current configuration properties and values
  
−
=== setconfig ===
+
=== listoperations ===
 +
 
 +
<nowiki>listoperations</nowiki>
 +
 
 +
List the current running operations
 +
 
 +
=== lockwallet ===
 +
 
 +
<nowiki>lockwallet</nowiki>
 +
 
 +
"Locks" the NodeCore wallet. If the NodeCore wallet has been encrypted, this will return the wallet to a locked state. '''While the NodeCore wallet is locked, you will be unable to create PoP transactions!'''
 +
 
 +
=== mine ===
 +
 
 +
<nowiki>mine [blockNumber]</nowiki>
 +
 
 +
Starts a proof of proof mining operation. '''blockNumber''' is an optional integer indicating a specific block height for which to fetch publication data from NodeCore.
 +
 
 +
This requires a NodeCore instance to be running and the embedded Bitcoin wallet to be sufficiently funded.
 +
 
 +
=== resetwallet ===
 +
 
 +
<nowiki>resetwallet</nowiki>
 +
 
 +
Resets the Bitcoin wallet, marking it for resync.
 +
 
 +
=== resubmit ===
  
−
setconfig <key> <value>
+
<nowiki>resubmit <id></nowiki>
  
−
Sets a new value for a config property
+
Resubmits an operation
  
−
== Bitcoin Wallet Commands ==
+
If you get an error like so, then try the resubmit command:
  
−
The PoP Miner has its own Bitcoin wallet for which it uses for PoP Transactions.
+
<nowiki>Mining operation action took longer than expected. Operation can be resubmitted.</nowiki>
  
−
=== withdrawbitcointoaddress ===
+
=== setconfig ===
  
−
withdrawbitcointoaddress <address> <amount>
+
<nowiki>setconfig <key> <value></nowiki>
  
−
Sends a Bitcoin amount to a given address. Withdraws bitcoin from the PoP BTC wallet.
+
Sets the configuration property specified by the '''key''' argument to the '''value'''.
  
 
=== showbitcoinaddress ===
 
=== showbitcoinaddress ===
 +
 +
<nowiki>showbitcoinaddress</nowiki>
  
 
Displays the current address for receiving Bitcoin
 
Displays the current address for receiving Bitcoin
Line 58: Line 109:
 
=== showbitcoinbalance ===
 
=== showbitcoinbalance ===
  
−
Displays the current balance for the Bitcoin wallet
+
<nowiki>showbitcoinbalance</nowiki>
  
−
== Shell Commands ==
+
Displays the current available, spendable balance in the embedded Bitcoin wallet.
  
−
=== clear ===
+
=== showmineraddress ===
 +
 
 +
<nowiki>showmineraddress</nowiki>
 +
 
 +
Displays the default address from the connected NodeCore instance. This is the miner address that will receive a reward.
 +
 
 +
=== showrecentbitcoinfees ===
 +
 
 +
<nowiki>showrecentbitcoinfees</nowiki>
 +
 
 +
Displays the average transaction fee per byte for the most recent Bitcoin block.
  
−
Clears the terminal screen
+
=== unlockwallet ===
  
−
=== help ===
+
<nowiki>unlockwallet <passphrase></nowiki>
  
−
Shows the various commands.
+
"Unlocks" the NodeCore wallet using the supplied '''passphrase'''. If the NodeCore wallet has been encrypted, this will unlock the wallet allowing the use of the wallet's private keys for actions like creating PoP transactions. '''While the NodeCore wallet is locked, you will be unable to create PoP transactions!'''
  
−
=== quit ===
+
=== viewrecentrewards ===
  
−
Quit the application
+
<nowiki>viewrecentrewards</nowiki>
  
−
== Reward Commands ==
+
Predicts the miner's expected rewards for endorsements of the last 750 VeriBlock blocks.
  
−
=== getpopendorsementinfo ===
+
<nowiki>{endorsed_block: 89612, projected_reward: 0.03168883, paid_in_block: 90112}</nowiki>
  
−
Returns information regarding PoP endorsements for a given address
+
=== withdrawbitcointoaddress ===
  
−
=== showmineraddress ===
+
<nowiki>withdrawbitcointoaddress <address> <amount></nowiki>
  
−
Returns the NodeCore VeriBlock miner address. This is the address that will receive a reward once the PoP transaction is finalized in 250 blocks.
+
Withdraws '''amount''' of Bitcoin from the PoP BTC wallet and sends it to '''address'''. '''amount''' is expressed as a decimal, e.g ''0.01'' representing 0.01 BTC. The same transaction fee per kb as used by mining transactions will be used for this transaction as well.

Latest revision as of 20:27, 24 January 2019

See: Main_Page, HowTo_run_PoP_Miner#Status_Codes

Overview

Commands

clear

clear

Clears the console screen

exit | quit

exit
quit

Both commands may be used interchangeably and gracefully shut down the application. Exiting the application with these two commands is the best way to ensure spvchain and wallet files do not become corrupted.

exportbitcoinkeys

exportbitcoinkeys

Dumps the Bitcoin private keys used by the wallet to a text file in Bitcoin WIF format.

This is useful for consolidating many wallets.

getoperation

getoperation <id>

Displays the state of an operation by looking up the specified id.

getpopendorsementinfo

getpopendorsementinfo

Displays information regarding PoP endorsements for the miner's address.

help

help [command]

Lists the available commands. If a specific command is passed as an argument, displays more detailed information about that command.

importwallet

importwallet <seedWords> [creationTime]

Imports a Bitcoin wallet using a BIP39 seed phrase. Seed words are 12 words, separated by commas, with no spaces. The creation time is an optional parameter but is useful for speeding up the time it takes to download the necessary blocks for the wallet. Example: 

importwallet identify,weapon,advice,siege,parrot,aisle,together,flavor,stand,final,clerk,tuna 1539613463

listconfig

listconfig

Lists the current configuration properties and values

listoperations

listoperations

List the current running operations

lockwallet

lockwallet

"Locks" the NodeCore wallet. If the NodeCore wallet has been encrypted, this will return the wallet to a locked state. While the NodeCore wallet is locked, you will be unable to create PoP transactions!

mine

mine [blockNumber]

Starts a proof of proof mining operation. blockNumber is an optional integer indicating a specific block height for which to fetch publication data from NodeCore.

This requires a NodeCore instance to be running and the embedded Bitcoin wallet to be sufficiently funded.

resetwallet

resetwallet

Resets the Bitcoin wallet, marking it for resync.

resubmit

resubmit <id>

Resubmits an operation

If you get an error like so, then try the resubmit command: 

Mining operation action took longer than expected. Operation can be resubmitted.

setconfig

setconfig <key> <value>

Sets the configuration property specified by the key argument to the value.

showbitcoinaddress

showbitcoinaddress

Displays the current address for receiving Bitcoin

showbitcoinbalance

showbitcoinbalance

Displays the current available, spendable balance in the embedded Bitcoin wallet.

showmineraddress

showmineraddress

Displays the default address from the connected NodeCore instance. This is the miner address that will receive a reward.

showrecentbitcoinfees

showrecentbitcoinfees

Displays the average transaction fee per byte for the most recent Bitcoin block.

unlockwallet

unlockwallet <passphrase>

"Unlocks" the NodeCore wallet using the supplied passphrase. If the NodeCore wallet has been encrypted, this will unlock the wallet allowing the use of the wallet's private keys for actions like creating PoP transactions. While the NodeCore wallet is locked, you will be unable to create PoP transactions!

viewrecentrewards

viewrecentrewards

Predicts the miner's expected rewards for endorsements of the last 750 VeriBlock blocks. 

{endorsed_block: 89612, projected_reward: 0.03168883, paid_in_block: 90112}

withdrawbitcointoaddress

withdrawbitcointoaddress <address> <amount>

Withdraws amount of Bitcoin from the PoP BTC wallet and sends it to address. amount is expressed as a decimal, e.g 0.01 representing 0.01 BTC. The same transaction fee per kb as used by mining transactions will be used for this transaction as well.

Retrieved from "http://wiki.veriblock.org/index.php?title=PoP_Miner_CommandLine&oldid=1387"