Difference between revisions of "PoP Miner CommandLine"
| (4 intermediate revisions by 2 users not shown) | |||
| Line 9: | Line 9: | ||
=== clear === | === clear === | ||
| + | <nowiki>clear</nowiki> | ||
| − | === exit === | + | 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 === | ||
| − | < | + | <nowiki>getoperation <id></nowiki> |
| − | getoperation <id> | + | |
| − | </ | + | Displays the state of an operation by looking up the specified id. |
=== getpopendorsementinfo === | === getpopendorsementinfo === | ||
| − | + | <nowiki>getpopendorsementinfo</nowiki> | |
| + | |||
| + | Displays information regarding PoP endorsements for the miner's address. | ||
=== help === | === help === | ||
| + | |||
| + | <nowiki>help [command]</nowiki> | ||
| + | |||
| + | Lists the available commands. If a specific command is passed as an argument, displays more detailed information about that command. | ||
| + | |||
| + | === importwallet === | ||
| + | |||
| + | <nowiki>importwallet <seedWords> [creationTime]</nowiki> | ||
| + | |||
| + | 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 | ||
=== listoperations === | === 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 === | === 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 === | === resetwallet === | ||
| − | + | <nowiki>resetwallet</nowiki> | |
Resets the Bitcoin wallet, marking it for resync. | Resets the Bitcoin wallet, marking it for resync. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
=== resubmit === | === resubmit === | ||
| − | < | + | <nowiki>resubmit <id></nowiki> |
| − | resubmit <id> | ||
| − | </ | ||
Resubmits an operation | Resubmits an operation | ||
| Line 63: | Line 93: | ||
If you get an error like so, then try the resubmit command: | If you get an error like so, then try the resubmit command: | ||
| − | < | + | <nowiki>Mining operation action took longer than expected. Operation can be resubmitted.</nowiki> |
| − | Mining operation action took longer than expected. Operation can be resubmitted. | ||
| − | </ | ||
=== setconfig === | === setconfig === | ||
| − | < | + | <nowiki>setconfig <key> <value></nowiki> |
| − | setconfig <key> <value> | + | |
| − | </ | + | 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 | ||
=== showbitcoinbalance === | === showbitcoinbalance === | ||
| + | |||
| + | <nowiki>showbitcoinbalance</nowiki> | ||
| + | |||
| + | Displays the current available, spendable balance in the embedded Bitcoin wallet. | ||
=== showmineraddress === | === 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. | ||
| + | |||
| + | === unlockwallet === | ||
| + | |||
| + | <nowiki>unlockwallet <passphrase></nowiki> | ||
| + | |||
| + | "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 === | ||
| − | + | <nowiki>viewrecentrewards</nowiki> | |
| − | |||
| − | < | ||
| − | |||
| − | </ | ||
| − | + | Predicts the miner's expected rewards for endorsements of the last 750 VeriBlock blocks. | |
| − | < | + | <nowiki>{endorsed_block: 89612, projected_reward: 0.03168883, paid_in_block: 90112}</nowiki> |
| − | {endorsed_block: 89612, | ||
| − | </ | ||
=== withdrawbitcointoaddress === | === withdrawbitcointoaddress === | ||
| − | < | + | <nowiki>withdrawbitcointoaddress <address> <amount></nowiki> |
| − | 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. | |
Latest revision as of 20:27, 24 January 2019
See: Main_Page, HowTo_run_PoP_Miner#Status_Codes
Contents
- 1 Overview
- 2 Commands
- 2.1 clear
- 2.2 exit | quit
- 2.3 exportbitcoinkeys
- 2.4 getoperation
- 2.5 getpopendorsementinfo
- 2.6 help
- 2.7 importwallet
- 2.8 listconfig
- 2.9 listoperations
- 2.10 lockwallet
- 2.11 mine
- 2.12 resetwallet
- 2.13 resubmit
- 2.14 setconfig
- 2.15 showbitcoinaddress
- 2.16 showbitcoinbalance
- 2.17 showmineraddress
- 2.18 showrecentbitcoinfees
- 2.19 unlockwallet
- 2.20 viewrecentrewards
- 2.21 withdrawbitcointoaddress
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.
