Difference between revisions of "PoP Miner CommandLine"
(→clear) |
|||
| Line 13: | Line 13: | ||
Clears the console screen | Clears the console screen | ||
| − | === exit === | + | === 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 === | === exportbitcoinkeys === | ||
| − | Dumps the private keys used to a text file in Bitcoin WIF format. | + | <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. | This is useful for consolidating many wallets. | ||
| Line 24: | Line 29: | ||
=== 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 === | === 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. | 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: | 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 | ||
=== 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 81: | Line 87: | ||
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 === | ||
Revision as of 20:04, 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 mine
- 2.11 resetwallet
- 2.12 resubmit
- 2.13 setconfig
- 2.14 showbitcoinaddress
- 2.15 showbitcoinbalance
- 2.16 showmineraddress
- 2.17 viewrecentrewards
- 2.18 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
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
Displays the current address for receiving Bitcoin
showbitcoinbalance
showmineraddress
Returns the NodeCore VeriBlock miner address. This is the address that will receive a reward once the PoP transaction is finalized in 250 blocks.
viewrecentrewards
Rewards are awarded at a known block. Prior to that block, this will try to guess the amount:
{endorsed_block: 89612, projected_reward: 0.03168883, paid_in_block: 90112}
After that block it can tell the exact reward:
{endorsed_block: 89612, reward: 0.03168976, paid_in_block: 90112}
withdrawbitcointoaddress
withdrawbitcointoaddress <address> <amount>
Sends a Bitcoin amount to a given address. Withdraws bitcoin from the PoP BTC wallet.
