2015-01-29 22:10:53 +00:00
|
|
|
/**
|
|
|
|
|
@file
|
|
|
|
|
@details
|
|
|
|
|
|
|
|
|
|
@image html images/other/runtime-commands.png
|
|
|
|
|
|
|
|
|
|
*/
|
|
|
|
|
|
2019-03-05 21:05:34 +00:00
|
|
|
// Copyright (c) 2014-2019, The Monero Project
|
2016-10-10 20:41:24 +00:00
|
|
|
//
|
2015-01-29 22:10:53 +00:00
|
|
|
// All rights reserved.
|
2016-10-10 20:41:24 +00:00
|
|
|
//
|
2015-01-29 22:10:53 +00:00
|
|
|
// Redistribution and use in source and binary forms, with or without modification, are
|
|
|
|
|
// permitted provided that the following conditions are met:
|
2016-10-10 20:41:24 +00:00
|
|
|
//
|
2015-01-29 22:10:53 +00:00
|
|
|
// 1. Redistributions of source code must retain the above copyright notice, this list of
|
|
|
|
|
// conditions and the following disclaimer.
|
2016-10-10 20:41:24 +00:00
|
|
|
//
|
2015-01-29 22:10:53 +00:00
|
|
|
// 2. Redistributions in binary form must reproduce the above copyright notice, this list
|
|
|
|
|
// of conditions and the following disclaimer in the documentation and/or other
|
|
|
|
|
// materials provided with the distribution.
|
2016-10-10 20:41:24 +00:00
|
|
|
//
|
2015-01-29 22:10:53 +00:00
|
|
|
// 3. Neither the name of the copyright holder nor the names of its contributors may be
|
|
|
|
|
// used to endorse or promote products derived from this software without specific
|
|
|
|
|
// prior written permission.
|
2016-10-10 20:41:24 +00:00
|
|
|
//
|
2015-01-29 22:10:53 +00:00
|
|
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
|
|
|
|
|
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
|
|
|
|
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
|
|
|
|
|
// THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
|
|
|
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
|
|
|
|
|
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
|
|
|
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
|
|
|
|
|
// STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
|
|
|
|
|
// THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
|
|
|
|
|
|
#pragma once
|
|
|
|
|
|
2017-09-18 10:24:49 +00:00
|
|
|
#include <boost/optional/optional.hpp>
|
2017-02-05 22:48:03 +00:00
|
|
|
|
2015-01-29 22:10:53 +00:00
|
|
|
#include "daemon/rpc_command_executor.h"
|
2017-02-05 22:48:03 +00:00
|
|
|
#include "common/common_fwd.h"
|
2019-05-22 04:09:11 +00:00
|
|
|
#include "net/net_fwd.h"
|
2015-03-27 12:01:30 +00:00
|
|
|
#include "rpc/core_rpc_server.h"
|
2015-01-29 22:10:53 +00:00
|
|
|
|
|
|
|
|
namespace daemonize {
|
|
|
|
|
|
|
|
|
|
class t_command_parser_executor final
|
|
|
|
|
{
|
|
|
|
|
private:
|
|
|
|
|
t_rpc_command_executor m_executor;
|
|
|
|
|
public:
|
|
|
|
|
t_command_parser_executor(
|
|
|
|
|
uint32_t ip
|
|
|
|
|
, uint16_t port
|
2017-02-05 22:48:03 +00:00
|
|
|
, const boost::optional<tools::login>& login
|
2019-05-22 04:09:11 +00:00
|
|
|
, const epee::net_utils::ssl_options_t& ssl_options
|
2015-03-27 12:01:30 +00:00
|
|
|
, bool is_rpc
|
|
|
|
|
, cryptonote::core_rpc_server* rpc_server = NULL
|
2015-01-29 22:10:53 +00:00
|
|
|
);
|
|
|
|
|
|
|
|
|
|
bool print_peer_list(const std::vector<std::string>& args);
|
|
|
|
|
|
2017-02-23 17:20:17 +00:00
|
|
|
bool print_peer_list_stats(const std::vector<std::string>& args);
|
|
|
|
|
|
2015-01-29 22:10:53 +00:00
|
|
|
bool save_blockchain(const std::vector<std::string>& args);
|
|
|
|
|
|
|
|
|
|
bool show_hash_rate(const std::vector<std::string>& args);
|
|
|
|
|
|
|
|
|
|
bool hide_hash_rate(const std::vector<std::string>& args);
|
|
|
|
|
|
|
|
|
|
bool show_difficulty(const std::vector<std::string>& args);
|
|
|
|
|
|
2015-10-25 21:18:03 +00:00
|
|
|
bool show_status(const std::vector<std::string>& args);
|
|
|
|
|
|
2015-01-29 22:10:53 +00:00
|
|
|
bool print_connections(const std::vector<std::string>& args);
|
|
|
|
|
|
|
|
|
|
bool print_blockchain_info(const std::vector<std::string>& args);
|
|
|
|
|
|
|
|
|
|
bool set_log_level(const std::vector<std::string>& args);
|
|
|
|
|
|
Change logging to easylogging++
This replaces the epee and data_loggers logging systems with
a single one, and also adds filename:line and explicit severity
levels. Categories may be defined, and logging severity set
by category (or set of categories). epee style 0-4 log level
maps to a sensible severity configuration. Log files now also
rotate when reaching 100 MB.
To select which logs to output, use the MONERO_LOGS environment
variable, with a comma separated list of categories (globs are
supported), with their requested severity level after a colon.
If a log matches more than one such setting, the last one in
the configuration string applies. A few examples:
This one is (mostly) silent, only outputting fatal errors:
MONERO_LOGS=*:FATAL
This one is very verbose:
MONERO_LOGS=*:TRACE
This one is totally silent (logwise):
MONERO_LOGS=""
This one outputs all errors and warnings, except for the
"verify" category, which prints just fatal errors (the verify
category is used for logs about incoming transactions and
blocks, and it is expected that some/many will fail to verify,
hence we don't want the spam):
MONERO_LOGS=*:WARNING,verify:FATAL
Log levels are, in decreasing order of priority:
FATAL, ERROR, WARNING, INFO, DEBUG, TRACE
Subcategories may be added using prefixes and globs. This
example will output net.p2p logs at the TRACE level, but all
other net* logs only at INFO:
MONERO_LOGS=*:ERROR,net*:INFO,net.p2p:TRACE
Logs which are intended for the user (which Monero was using
a lot through epee, but really isn't a nice way to go things)
should use the "global" category. There are a few helper macros
for using this category, eg: MGINFO("this shows up by default")
or MGINFO_RED("this is red"), to try to keep a similar look
and feel for now.
Existing epee log macros still exist, and map to the new log
levels, but since they're used as a "user facing" UI element
as much as a logging system, they often don't map well to log
severities (ie, a log level 0 log may be an error, or may be
something we want the user to see, such as an important info).
In those cases, I tried to use the new macros. In other cases,
I left the existing macros in. When modifying logs, it is
probably best to switch to the new macros with explicit levels.
The --log-level options and set_log commands now also accept
category settings, in addition to the epee style log levels.
2017-01-01 16:34:23 +00:00
|
|
|
bool set_log_categories(const std::vector<std::string>& args);
|
|
|
|
|
|
2015-01-29 22:10:53 +00:00
|
|
|
bool print_height(const std::vector<std::string>& args);
|
|
|
|
|
|
|
|
|
|
bool print_block(const std::vector<std::string>& args);
|
|
|
|
|
|
|
|
|
|
bool print_transaction(const std::vector<std::string>& args);
|
|
|
|
|
|
2015-08-11 09:49:15 +00:00
|
|
|
bool is_key_image_spent(const std::vector<std::string>& args);
|
|
|
|
|
|
2015-01-29 22:10:53 +00:00
|
|
|
bool print_transaction_pool_long(const std::vector<std::string>& args);
|
|
|
|
|
|
|
|
|
|
bool print_transaction_pool_short(const std::vector<std::string>& args);
|
|
|
|
|
|
2016-10-23 11:11:07 +00:00
|
|
|
bool print_transaction_pool_stats(const std::vector<std::string>& args);
|
|
|
|
|
|
2015-01-29 22:10:53 +00:00
|
|
|
bool start_mining(const std::vector<std::string>& args);
|
|
|
|
|
|
|
|
|
|
bool stop_mining(const std::vector<std::string>& args);
|
|
|
|
|
|
2019-02-22 20:17:45 +00:00
|
|
|
bool mining_status(const std::vector<std::string>& args);
|
|
|
|
|
|
2015-01-29 22:10:53 +00:00
|
|
|
bool stop_daemon(const std::vector<std::string>& args);
|
|
|
|
|
|
|
|
|
|
bool print_status(const std::vector<std::string>& args);
|
|
|
|
|
|
|
|
|
|
bool set_limit(const std::vector<std::string>& args);
|
|
|
|
|
|
|
|
|
|
bool set_limit_up(const std::vector<std::string>& args);
|
|
|
|
|
|
|
|
|
|
bool set_limit_down(const std::vector<std::string>& args);
|
|
|
|
|
|
2015-04-01 17:00:45 +00:00
|
|
|
bool out_peers(const std::vector<std::string>& args);
|
2018-01-20 21:44:23 +00:00
|
|
|
|
|
|
|
|
bool in_peers(const std::vector<std::string>& args);
|
|
|
|
|
|
2015-09-19 15:34:29 +00:00
|
|
|
bool hard_fork_info(const std::vector<std::string>& args);
|
2015-11-26 00:04:22 +00:00
|
|
|
|
|
|
|
|
bool show_bans(const std::vector<std::string>& args);
|
|
|
|
|
|
|
|
|
|
bool ban(const std::vector<std::string>& args);
|
|
|
|
|
|
|
|
|
|
bool unban(const std::vector<std::string>& args);
|
2016-01-30 13:28:26 +00:00
|
|
|
|
2019-03-29 10:47:53 +00:00
|
|
|
bool banned(const std::vector<std::string>& args);
|
|
|
|
|
|
2016-01-30 13:28:26 +00:00
|
|
|
bool flush_txpool(const std::vector<std::string>& args);
|
2016-03-26 14:30:23 +00:00
|
|
|
|
|
|
|
|
bool output_histogram(const std::vector<std::string>& args);
|
2016-10-10 19:45:51 +00:00
|
|
|
|
|
|
|
|
bool print_coinbase_tx_sum(const std::vector<std::string>& args);
|
2016-12-17 11:25:15 +00:00
|
|
|
|
|
|
|
|
bool alt_chain_info(const std::vector<std::string>& args);
|
2017-01-08 11:14:11 +00:00
|
|
|
|
|
|
|
|
bool print_blockchain_dynamic_stats(const std::vector<std::string>& args);
|
2017-02-24 23:16:13 +00:00
|
|
|
|
|
|
|
|
bool update(const std::vector<std::string>& args);
|
2017-04-02 11:17:35 +00:00
|
|
|
|
|
|
|
|
bool relay_tx(const std::vector<std::string>& args);
|
2017-07-02 21:41:15 +00:00
|
|
|
|
|
|
|
|
bool sync_info(const std::vector<std::string>& args);
|
2018-04-13 17:12:17 +00:00
|
|
|
|
2018-11-25 21:08:07 +00:00
|
|
|
bool pop_blocks(const std::vector<std::string>& args);
|
|
|
|
|
|
daemon, wallet: new pay for RPC use system
Daemons intended for public use can be set up to require payment
in the form of hashes in exchange for RPC service. This enables
public daemons to receive payment for their work over a large
number of calls. This system behaves similarly to a pool, so
payment takes the form of valid blocks every so often, yielding
a large one off payment, rather than constant micropayments.
This system can also be used by third parties as a "paywall"
layer, where users of a service can pay for use by mining Monero
to the service provider's address. An example of this for web
site access is Primo, a Monero mining based website "paywall":
https://github.com/selene-kovri/primo
This has some advantages:
- incentive to run a node providing RPC services, thereby promoting the availability of third party nodes for those who can't run their own
- incentive to run your own node instead of using a third party's, thereby promoting decentralization
- decentralized: payment is done between a client and server, with no third party needed
- private: since the system is "pay as you go", you don't need to identify yourself to claim a long lived balance
- no payment occurs on the blockchain, so there is no extra transactional load
- one may mine with a beefy server, and use those credits from a phone, by reusing the client ID (at the cost of some privacy)
- no barrier to entry: anyone may run a RPC node, and your expected revenue depends on how much work you do
- Sybil resistant: if you run 1000 idle RPC nodes, you don't magically get more revenue
- no large credit balance maintained on servers, so they have no incentive to exit scam
- you can use any/many node(s), since there's little cost in switching servers
- market based prices: competition between servers to lower costs
- incentive for a distributed third party node system: if some public nodes are overused/slow, traffic can move to others
- increases network security
- helps counteract mining pools' share of the network hash rate
- zero incentive for a payer to "double spend" since a reorg does not give any money back to the miner
And some disadvantages:
- low power clients will have difficulty mining (but one can optionally mine in advance and/or with a faster machine)
- payment is "random", so a server might go a long time without a block before getting one
- a public node's overall expected payment may be small
Public nodes are expected to compete to find a suitable level for
cost of service.
The daemon can be set up this way to require payment for RPC services:
monerod --rpc-payment-address 4xxxxxx \
--rpc-payment-credits 250 --rpc-payment-difficulty 1000
These values are an example only.
The --rpc-payment-difficulty switch selects how hard each "share" should
be, similar to a mining pool. The higher the difficulty, the fewer
shares a client will find.
The --rpc-payment-credits switch selects how many credits are awarded
for each share a client finds.
Considering both options, clients will be awarded credits/difficulty
credits for every hash they calculate. For example, in the command line
above, 0.25 credits per hash. A client mining at 100 H/s will therefore
get an average of 25 credits per second.
For reference, in the current implementation, a credit is enough to
sync 20 blocks, so a 100 H/s client that's just starting to use Monero
and uses this daemon will be able to sync 500 blocks per second.
The wallet can be set to automatically mine if connected to a daemon
which requires payment for RPC usage. It will try to keep a balance
of 50000 credits, stopping mining when it's at this level, and starting
again as credits are spent. With the example above, a new client will
mine this much credits in about half an hour, and this target is enough
to sync 500000 blocks (currently about a third of the monero blockchain).
There are three new settings in the wallet:
- credits-target: this is the amount of credits a wallet will try to
reach before stopping mining. The default of 0 means 50000 credits.
- auto-mine-for-rpc-payment-threshold: this controls the minimum
credit rate which the wallet considers worth mining for. If the
daemon credits less than this ratio, the wallet will consider mining
to be not worth it. In the example above, the rate is 0.25
- persistent-rpc-client-id: if set, this allows the wallet to reuse
a client id across runs. This means a public node can tell a wallet
that's connecting is the same as one that connected previously, but
allows a wallet to keep their credit balance from one run to the
other. Since the wallet only mines to keep a small credit balance,
this is not normally worth doing. However, someone may want to mine
on a fast server, and use that credit balance on a low power device
such as a phone. If left unset, a new client ID is generated at
each wallet start, for privacy reasons.
To mine and use a credit balance on two different devices, you can
use the --rpc-client-secret-key switch. A wallet's client secret key
can be found using the new rpc_payments command in the wallet.
Note: anyone knowing your RPC client secret key is able to use your
credit balance.
The wallet has a few new commands too:
- start_mining_for_rpc: start mining to acquire more credits,
regardless of the auto mining settings
- stop_mining_for_rpc: stop mining to acquire more credits
- rpc_payments: display information about current credits with
the currently selected daemon
The node has an extra command:
- rpc_payments: display information about clients and their
balances
The node will forget about any balance for clients which have
been inactive for 6 months. Balances carry over on node restart.
2018-02-11 15:15:56 +00:00
|
|
|
bool rpc_payments(const std::vector<std::string>& args);
|
|
|
|
|
|
2018-04-13 17:12:17 +00:00
|
|
|
bool version(const std::vector<std::string>& args);
|
Pruning
The blockchain prunes seven eighths of prunable tx data.
This saves about two thirds of the blockchain size, while
keeping the node useful as a sync source for an eighth
of the blockchain.
No other data is currently pruned.
There are three ways to prune a blockchain:
- run monerod with --prune-blockchain
- run "prune_blockchain" in the monerod console
- run the monero-blockchain-prune utility
The first two will prune in place. Due to how LMDB works, this
will not reduce the blockchain size on disk. Instead, it will
mark parts of the file as free, so that future data will use
that free space, causing the file to not grow until free space
grows scarce.
The third way will create a second database, a pruned copy of
the original one. Since this is a new file, this one will be
smaller than the original one.
Once the database is pruned, it will stay pruned as it syncs.
That is, there is no need to use --prune-blockchain again, etc.
2018-04-29 22:30:51 +00:00
|
|
|
|
|
|
|
|
bool prune_blockchain(const std::vector<std::string>& args);
|
|
|
|
|
|
|
|
|
|
bool check_blockchain_pruning(const std::vector<std::string>& args);
|
2019-03-21 10:03:24 +00:00
|
|
|
|
|
|
|
|
bool print_net_stats(const std::vector<std::string>& args);
|
2019-08-21 13:04:20 +00:00
|
|
|
|
|
|
|
|
bool set_bootstrap_daemon(const std::vector<std::string>& args);
|
2019-10-22 15:28:08 +00:00
|
|
|
|
|
|
|
|
bool flush_cache(const std::vector<std::string>& args);
|
2015-01-29 22:10:53 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
} // namespace daemonize
|
