How To Run Pirate Using CLI

2021 Update

Ahoy mateys,

First Mate Kaks has put together some instructions on how to run Pirate using CLI. We hope that you find them useful.

CLI commands

 

Daemon

To run the daemon for PirateChain (use also the next command if running for the first time):
Copy to clipboard

Bootstrap

If you are running the pirate daemon for the first time, to sync faster it is recommended to download the “blockchain files” by using the following command:
Copy to clipboard

getinfo

The getinfo method returns an object containing various information about the wallet and blockchain info.
Copy to clipboard

getwalletinfo

The getwalletinfo method returns an object containing various information about the wallet info.
Copy to clipboard

Mining

Get mining information
Copy to clipboard

z_listaddresses

The z_listaddresses method returns the list of z addresses belonging to the wallet.
Copy to clipboard

z_exportkey

The z_exportkey method reveals the private z_key corresponding to z_address.
Copy to clipboard

z_exportviewingkey

The z_exportviewingkey method reveals the viewing key corresponding to z_address.
Copy to clipboard

z_exportwallet

The z_exportwallet method exports all wallet keys in a human-readable format. Overwriting an existing file is not permitted.
Copy to clipboard

z_getbalance

The z_getbalance method returns the balance belonging to the node’s wallet.
Copy to clipboard

z_getnewaddress

The z_getnewaddress method returns a new z_address for receiving payments.
Copy to clipboard

z_getoperationresult

The z_getoperationresult method retrieves the result and status of an operation which has finished, and then removes the operation from memory.
Copy to clipboard

z_getoperationstatus

The z_getoperationstatus message queries the operation status and any associated result or error data of any operationid stored in local memory. The operation will remain in memory (unlike z_getoperationresult, which removes the data from the local memory).
Copy to clipboard

z_gettotalbalance

The z_gettotalbalance method returns the total value of funds stored in the node’s wallet.
Copy to clipboard

z_importkey

The z_importkey method imports the privatekey to your wallet.
Copy to clipboard

z_importviewingkey

The z_importviewingkey adds a viewing key to your wallet. This method allows you to view the balance in a z address that otherwise does not belong to your wallet.
Copy to clipboard

z_importwallet

The z_importwallet method imports z address keys from a wallet export file.
Copy to clipboard

z_listoperationids

The z_listoperationids method returns the list of operation ids currently known to the wallet.
Copy to clipboard

z_listreceivedbyaddress

The z_listreceivedbyaddress method returns a list of amounts received by a z address belonging to the node’s wallet.
Copy to clipboard

z_listunspent

The z_listunspent method returns an array of unspent shielded notes.
Copy to clipboard

z_validateaddress

The z_validateaddress method returns information about the given z address.
Copy to clipboard

z_sendmany

The z_sendmany method sends one or more transactions at once. It is the principle method for dealing with shielded z transactions.
./pirate-cli z_sendmany “zs1zdg8uye2f6mzn872nm7ugqkpcuevt7g8wszme5pyv0nfc9c5xhuqezak4q53zmecezgawau7s6w” ‘[{“address”:”zs13x6lvn7ah2c28ukzrfaqyd077qszd65uzel47l94yu7hsuktdf986g86mge2vz3rvpx466lpesd”,”amount”:0.01}]’