2019-03-05 14:05:34 -07:00
|
|
|
// Copyright (c) 2016-2019, The Monero Project
|
2017-09-05 10:20:27 -06:00
|
|
|
//
|
|
|
|
// All rights reserved.
|
|
|
|
//
|
|
|
|
// Redistribution and use in source and binary forms, with or without modification, are
|
|
|
|
// permitted provided that the following conditions are met:
|
|
|
|
//
|
|
|
|
// 1. Redistributions of source code must retain the above copyright notice, this list of
|
|
|
|
// conditions and the following disclaimer.
|
|
|
|
//
|
|
|
|
// 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.
|
|
|
|
//
|
|
|
|
// 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.
|
|
|
|
//
|
|
|
|
// 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
|
|
|
|
|
|
|
|
#include "crypto/hash.h"
|
|
|
|
#include "cryptonote_basic/cryptonote_basic.h"
|
2019-01-31 03:44:08 -07:00
|
|
|
#include "cryptonote_basic/difficulty.h"
|
2017-09-05 10:20:27 -06:00
|
|
|
#include "ringct/rctSigs.h"
|
2018-10-19 20:06:03 -06:00
|
|
|
#include "rpc/rpc_handler.h"
|
2017-09-05 10:20:27 -06:00
|
|
|
|
|
|
|
#include <unordered_map>
|
|
|
|
#include <vector>
|
|
|
|
|
|
|
|
namespace cryptonote
|
|
|
|
{
|
|
|
|
|
|
|
|
namespace rpc
|
|
|
|
{
|
|
|
|
|
|
|
|
struct block_with_transactions
|
|
|
|
{
|
|
|
|
cryptonote::block block;
|
2018-08-01 20:10:09 -06:00
|
|
|
std::vector<cryptonote::transaction> transactions;
|
2017-09-05 10:20:27 -06:00
|
|
|
};
|
|
|
|
|
|
|
|
typedef std::vector<uint64_t> tx_output_indices;
|
|
|
|
|
|
|
|
typedef std::vector<tx_output_indices> block_output_indices;
|
|
|
|
|
|
|
|
struct transaction_info
|
|
|
|
{
|
|
|
|
cryptonote::transaction transaction;
|
|
|
|
bool in_pool;
|
|
|
|
uint64_t height;
|
|
|
|
};
|
|
|
|
|
|
|
|
struct output_key_and_amount_index
|
|
|
|
{
|
|
|
|
uint64_t amount_index;
|
|
|
|
crypto::public_key key;
|
|
|
|
};
|
|
|
|
|
|
|
|
typedef std::vector<output_key_and_amount_index> outputs_for_amount;
|
|
|
|
|
|
|
|
struct amount_with_random_outputs
|
|
|
|
{
|
|
|
|
uint64_t amount;
|
|
|
|
outputs_for_amount outputs;
|
|
|
|
};
|
|
|
|
|
|
|
|
struct peer
|
|
|
|
{
|
|
|
|
uint64_t id;
|
|
|
|
uint32_t ip;
|
|
|
|
uint16_t port;
|
2019-02-24 01:47:49 -07:00
|
|
|
uint16_t rpc_port;
|
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 08:15:56 -07:00
|
|
|
uint32_t rpc_credits_per_hash;
|
2017-09-05 10:20:27 -06:00
|
|
|
uint64_t last_seen;
|
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 16:30:51 -06:00
|
|
|
uint32_t pruning_seed;
|
2017-09-05 10:20:27 -06:00
|
|
|
};
|
|
|
|
|
|
|
|
struct tx_in_pool
|
|
|
|
{
|
|
|
|
cryptonote::transaction tx;
|
|
|
|
crypto::hash tx_hash;
|
|
|
|
uint64_t blob_size;
|
2018-07-18 15:24:53 -06:00
|
|
|
uint64_t weight;
|
2017-09-05 10:20:27 -06:00
|
|
|
uint64_t fee;
|
|
|
|
crypto::hash max_used_block_hash;
|
|
|
|
uint64_t max_used_block_height;
|
|
|
|
bool kept_by_block;
|
|
|
|
crypto::hash last_failed_block_hash;
|
|
|
|
uint64_t last_failed_block_height;
|
|
|
|
uint64_t receive_time;
|
|
|
|
uint64_t last_relayed_time;
|
|
|
|
bool relayed;
|
|
|
|
bool do_not_relay;
|
2017-09-22 06:57:20 -06:00
|
|
|
bool double_spend_seen;
|
2017-09-05 10:20:27 -06:00
|
|
|
};
|
|
|
|
|
|
|
|
typedef std::unordered_map<crypto::key_image, std::vector<crypto::hash> > key_images_with_tx_hashes;
|
|
|
|
|
|
|
|
struct output_amount_count
|
|
|
|
{
|
|
|
|
uint64_t amount;
|
|
|
|
uint64_t total_count;
|
|
|
|
uint64_t unlocked_count;
|
|
|
|
uint64_t recent_count;
|
|
|
|
};
|
|
|
|
|
|
|
|
struct output_amount_and_index
|
|
|
|
{
|
|
|
|
uint64_t amount;
|
|
|
|
uint64_t index;
|
|
|
|
};
|
|
|
|
|
|
|
|
struct output_key_mask_unlocked
|
|
|
|
{
|
|
|
|
crypto::public_key key;
|
|
|
|
rct::key mask;
|
|
|
|
bool unlocked;
|
|
|
|
};
|
|
|
|
|
|
|
|
struct hard_fork_info
|
|
|
|
{
|
|
|
|
uint8_t version;
|
|
|
|
bool enabled;
|
|
|
|
uint32_t window;
|
|
|
|
uint32_t votes;
|
|
|
|
uint32_t threshold;
|
|
|
|
uint8_t voting;
|
|
|
|
uint32_t state;
|
|
|
|
uint64_t earliest_height;
|
|
|
|
};
|
|
|
|
|
|
|
|
//required by JSON-RPC 2.0 spec
|
|
|
|
struct error
|
|
|
|
{
|
|
|
|
// not really using code, maybe later.
|
|
|
|
error() : use(false), code(1) { }
|
|
|
|
|
|
|
|
bool use; // do not serialize
|
|
|
|
|
|
|
|
int32_t code;
|
|
|
|
|
|
|
|
// not required by spec, but int error codes aren't perfect
|
|
|
|
std::string error_str;
|
|
|
|
|
|
|
|
std::string message;
|
|
|
|
|
|
|
|
//TODO: data member? not required, may want later.
|
|
|
|
};
|
|
|
|
|
|
|
|
struct BlockHeaderResponse
|
|
|
|
{
|
|
|
|
uint64_t major_version;
|
|
|
|
uint64_t minor_version;
|
|
|
|
uint64_t timestamp;
|
|
|
|
crypto::hash prev_id;
|
|
|
|
uint32_t nonce;
|
|
|
|
uint64_t height;
|
|
|
|
uint64_t depth;
|
|
|
|
crypto::hash hash;
|
2019-01-31 03:44:08 -07:00
|
|
|
cryptonote::difficulty_type wide_difficulty;
|
2017-09-05 10:20:27 -06:00
|
|
|
uint64_t difficulty;
|
|
|
|
uint64_t reward;
|
|
|
|
};
|
|
|
|
|
2017-09-05 10:20:40 -06:00
|
|
|
struct DaemonInfo
|
|
|
|
{
|
|
|
|
uint64_t height;
|
|
|
|
uint64_t target_height;
|
2019-01-31 03:44:08 -07:00
|
|
|
cryptonote::difficulty_type wide_difficulty;
|
2017-09-05 10:20:40 -06:00
|
|
|
uint64_t difficulty;
|
|
|
|
uint64_t target;
|
|
|
|
uint64_t tx_count;
|
|
|
|
uint64_t tx_pool_size;
|
|
|
|
uint64_t alt_blocks_count;
|
|
|
|
uint64_t outgoing_connections_count;
|
|
|
|
uint64_t incoming_connections_count;
|
|
|
|
uint64_t white_peerlist_size;
|
|
|
|
uint64_t grey_peerlist_size;
|
2018-02-16 04:04:04 -07:00
|
|
|
bool mainnet;
|
2017-09-05 10:20:40 -06:00
|
|
|
bool testnet;
|
2018-02-16 04:04:04 -07:00
|
|
|
bool stagenet;
|
2018-06-13 14:38:26 -06:00
|
|
|
std::string nettype;
|
2017-09-05 10:20:40 -06:00
|
|
|
crypto::hash top_block_hash;
|
2019-01-31 03:44:08 -07:00
|
|
|
cryptonote::difficulty_type wide_cumulative_difficulty;
|
2017-09-05 10:20:40 -06:00
|
|
|
uint64_t cumulative_difficulty;
|
|
|
|
uint64_t block_size_limit;
|
2018-07-18 15:24:53 -06:00
|
|
|
uint64_t block_weight_limit;
|
|
|
|
uint64_t block_size_median;
|
|
|
|
uint64_t block_weight_median;
|
2017-09-05 10:20:40 -06:00
|
|
|
uint64_t start_time;
|
2018-11-20 11:18:08 -07:00
|
|
|
std::string version;
|
2017-09-05 10:20:40 -06:00
|
|
|
};
|
|
|
|
|
2018-10-19 20:06:03 -06:00
|
|
|
struct output_distribution
|
|
|
|
{
|
|
|
|
output_distribution_data data;
|
|
|
|
uint64_t amount;
|
|
|
|
bool cumulative;
|
|
|
|
};
|
2017-09-05 10:20:27 -06:00
|
|
|
} // namespace rpc
|
|
|
|
|
|
|
|
} // namespace cryptonote
|