Difference between revisions of "PoP Miner CommandLine"

From Veriblock Wiki
Jump to: navigation, search
(2 intermediate revisions by 2 users not shown)
Line 6: Line 6:
  
  
== Operation Commands ==
+
== Commands ==
 +
 
 +
=== clear ===
 +
 
 +
=== exit ===
 +
 
 +
 
 +
=== exportbitcoinkeys ===
 +
 
 +
Dumps the private keys used to a text file in Bitcoin WIF format.
 +
 
 +
This is useful for consolidating many wallets.
  
 
=== getoperation ===
 
=== getoperation ===
  
 +
<pre>
 
getoperation <id>
 
getoperation <id>
 +
</pre>
  
Gets the details of the supplied operation
+
=== getpopendorsementinfo ===
  
=== listoperations===
+
Returns information regarding PoP endorsements for a given address
  
Lists the current running operations
+
=== help ===
 +
 
 +
=== importwallet ===
 +
 
 +
<pre>importwallet <seedWords> [creationTime]</pre>
 +
 
 +
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:
 +
<pre>importwallet identify,weapon,advice,siege,parrot,aisle,together,flavor,stand,final,clerk,tuna 1539613463</pre>
 +
 
 +
=== listconfig ===
 +
 
 +
Lists the current configuration properties and values
 +
 
 +
=== listoperations ===
  
 
=== mine ===
 
=== mine ===
Line 23: Line 50:
  
 
This requires a NodeCore instance running and Bitcoin in the PoP Wallet address.
 
This requires a NodeCore instance running and Bitcoin in the PoP Wallet address.
 +
 +
<pre>
 +
mine [blockNumber]
 +
</pre>
 +
 +
=== quit ===
 +
 +
=== resetwallet ===
 +
 +
NOT IMPLEMENTED YET, will be added in the future
 +
 +
Resets the Bitcoin wallet, marking it for resync.
 +
 +
<pre>
 +
  INFO: (2018-08-31 07:58:27) [V200] Success
 +
        Wallet reset. Delete *.spvchain and restart.
 +
</pre>
  
 
=== resubmit ===
 
=== resubmit ===
  
 +
<pre>
 
resubmit <id>
 
resubmit <id>
 +
</pre>
  
 
Resubmits an operation
 
Resubmits an operation
Line 35: Line 81:
 
Mining operation action took longer than expected. Operation can be resubmitted.
 
Mining operation action took longer than expected. Operation can be resubmitted.
 
</pre>
 
</pre>
 
== Config Commands ==
 
 
=== listconfig ===
 
 
Lists the current configuration properties and values
 
  
 
=== setconfig ===
 
=== setconfig ===
  
 +
<pre>
 
setconfig <key> <value>
 
setconfig <key> <value>
 
+
</pre>
Sets a new value for a config property
 
 
 
== Bitcoin Wallet Commands ==
 
 
 
The PoP Miner has its own Bitcoin wallet for which it uses for PoP Transactions.
 
 
 
=== withdrawbitcointoaddress ===
 
 
 
withdrawbitcointoaddress <address> <amount>
 
 
 
Sends a Bitcoin amount to a given address. Withdraws bitcoin from the PoP BTC wallet.
 
  
 
=== showbitcoinaddress ===
 
=== showbitcoinaddress ===
Line 64: Line 94:
 
=== showbitcoinbalance ===
 
=== showbitcoinbalance ===
  
Displays the current balance for the Bitcoin wallet
+
=== showmineraddress ===
  
== Shell Commands ==
+
Returns the NodeCore VeriBlock miner address. This is the address that will receive a reward once the PoP transaction is finalized in 250 blocks.
  
=== clear ===
+
=== viewrecentrewards ===
  
Clears the terminal screen
+
Rewards are awarded at a known block. Prior to that block, this will try to guess the amount:
  
=== help ===
+
<pre>
 +
{endorsed_block: 89612, projected_reward: 0.03168883, paid_in_block: 90112}
 +
</pre>
  
Shows the various commands.
+
After that block it can tell the exact reward:
  
=== quit ===
+
<pre>
 +
{endorsed_block: 89612, reward: 0.03168976, paid_in_block: 90112}
 +
</pre>
  
Quit the application
+
=== withdrawbitcointoaddress ===
  
== Reward Commands ==
+
<pre>
 +
withdrawbitcointoaddress <address> <amount>
 +
</pre>
  
=== getpopendorsementinfo ===
+
Sends a Bitcoin amount to a given address. Withdraws bitcoin from the PoP BTC wallet.
 
 
Returns information regarding PoP endorsements for a given address
 
 
 
=== 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.
 

Revision as of 06:39, 16 January 2019

See: Main_Page, HowTo_run_PoP_Miner#Status_Codes

Overview

Commands

clear

exit

exportbitcoinkeys

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

This is useful for consolidating many wallets.

getoperation

getoperation <id>

getpopendorsementinfo

Returns information regarding PoP endorsements for a given address

help

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

Lists the current configuration properties and values

listoperations

mine

Begins a proof of proof mining operation

This requires a NodeCore instance running and Bitcoin in the PoP Wallet address.

mine [blockNumber]

quit

resetwallet

NOT IMPLEMENTED YET, will be added in the future

Resets the Bitcoin wallet, marking it for resync.

   INFO: (2018-08-31 07:58:27) [V200] Success
         Wallet reset. Delete *.spvchain and restart.

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>

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.