2019-03-05 21:05:34 +00:00
// Copyright (c) 2014-2019, The Monero Project
2014-07-23 13:03:52 +00: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.
//
// Parts of this file are originally copyright (c) 2012-2013 The Cryptonote developers
2014-03-03 22:07:58 +00:00
# pragma once
# include <list>
# include "serialization/keyvalue_serialization.h"
2017-01-26 15:07:23 +00:00
# include "cryptonote_basic/cryptonote_basic.h"
2017-11-25 22:25:05 +00:00
# include "cryptonote_basic/blobdatatype.h"
2019-01-31 10:44:08 +00:00
2014-03-03 22:07:58 +00:00
namespace cryptonote
{
# define BC_COMMANDS_POOL_BASE 2000
2014-07-18 23:33:03 +00:00
/************************************************************************/
/* P2P connection info, serializable to json */
/************************************************************************/
struct connection_info
{
bool incoming ;
2015-04-01 17:00:45 +00:00
bool localhost ;
bool local_ip ;
epee: add SSL support
RPC connections now have optional tranparent SSL.
An optional private key and certificate file can be passed,
using the --{rpc,daemon}-ssl-private-key and
--{rpc,daemon}-ssl-certificate options. Those have as
argument a path to a PEM format private private key and
certificate, respectively.
If not given, a temporary self signed certificate will be used.
SSL can be enabled or disabled using --{rpc}-ssl, which
accepts autodetect (default), disabled or enabled.
Access can be restricted to particular certificates using the
--rpc-ssl-allowed-certificates, which takes a list of
paths to PEM encoded certificates. This can allow a wallet to
connect to only the daemon they think they're connected to,
by forcing SSL and listing the paths to the known good
certificates.
To generate long term certificates:
openssl genrsa -out /tmp/KEY 4096
openssl req -new -key /tmp/KEY -out /tmp/REQ
openssl x509 -req -days 999999 -sha256 -in /tmp/REQ -signkey /tmp/KEY -out /tmp/CERT
/tmp/KEY is the private key, and /tmp/CERT is the certificate,
both in PEM format. /tmp/REQ can be removed. Adjust the last
command to set expiration date, etc, as needed. It doesn't
make a whole lot of sense for monero anyway, since most servers
will run with one time temporary self signed certificates anyway.
SSL support is transparent, so all communication is done on the
existing ports, with SSL autodetection. This means you can start
using an SSL daemon now, but you should not enforce SSL yet or
nothing will talk to you.
2018-06-14 22:44:48 +00:00
bool ssl ;
2014-07-18 23:33:03 +00:00
2017-05-27 10:35:54 +00:00
std : : string address ;
std : : string host ;
2014-07-18 23:33:03 +00:00
std : : string ip ;
std : : string port ;
2019-02-24 08:47:49 +00:00
uint16_t rpc_port ;
2014-07-18 23:33:03 +00:00
std : : string peer_id ;
uint64_t recv_count ;
2014-07-23 09:59:31 +00:00
uint64_t recv_idle_time ;
2014-07-18 23:33:03 +00:00
uint64_t send_count ;
2014-07-23 09:59:31 +00:00
uint64_t send_idle_time ;
2014-07-18 23:33:03 +00:00
std : : string state ;
2014-07-23 09:59:31 +00:00
uint64_t live_time ;
2014-07-18 23:33:03 +00:00
2015-04-01 17:00:45 +00:00
uint64_t avg_download ;
uint64_t current_download ;
uint64_t avg_upload ;
uint64_t current_upload ;
2016-10-26 19:00:08 +00:00
uint32_t support_flags ;
2015-04-01 17:00:45 +00:00
2017-11-17 23:52:50 +00:00
std : : string connection_id ;
2017-07-02 21:41:15 +00:00
2017-08-12 09:59:54 +00:00
uint64_t height ;
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
uint32_t pruning_seed ;
2019-05-31 09:09:24 +00:00
uint8_t address_type ;
2014-07-18 23:33:03 +00:00
BEGIN_KV_SERIALIZE_MAP ( )
KV_SERIALIZE ( incoming )
2015-04-01 17:00:45 +00:00
KV_SERIALIZE ( localhost )
KV_SERIALIZE ( local_ip )
2017-05-27 10:35:54 +00:00
KV_SERIALIZE ( address )
KV_SERIALIZE ( host )
2014-07-18 23:33:03 +00:00
KV_SERIALIZE ( ip )
KV_SERIALIZE ( port )
2019-02-24 08:47:49 +00:00
KV_SERIALIZE ( rpc_port )
2014-07-18 23:33:03 +00:00
KV_SERIALIZE ( peer_id )
KV_SERIALIZE ( recv_count )
KV_SERIALIZE ( recv_idle_time )
KV_SERIALIZE ( send_count )
KV_SERIALIZE ( send_idle_time )
KV_SERIALIZE ( state )
KV_SERIALIZE ( live_time )
2015-04-01 17:00:45 +00:00
KV_SERIALIZE ( avg_download )
KV_SERIALIZE ( current_download )
KV_SERIALIZE ( avg_upload )
KV_SERIALIZE ( current_upload )
2016-10-26 19:00:08 +00:00
KV_SERIALIZE ( support_flags )
2017-11-17 23:52:50 +00:00
KV_SERIALIZE ( connection_id )
2017-08-12 09:59:54 +00:00
KV_SERIALIZE ( height )
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
KV_SERIALIZE ( pruning_seed )
2019-05-31 09:09:24 +00:00
KV_SERIALIZE ( address_type )
2014-07-18 23:33:03 +00:00
END_KV_SERIALIZE_MAP ( )
} ;
2014-03-03 22:07:58 +00:00
/************************************************************************/
/* */
/************************************************************************/
struct block_complete_entry
{
blobdata block ;
2018-04-15 23:16:02 +00:00
std : : vector < blobdata > txs ;
2014-03-03 22:07:58 +00:00
BEGIN_KV_SERIALIZE_MAP ( )
KV_SERIALIZE ( block )
KV_SERIALIZE ( txs )
END_KV_SERIALIZE_MAP ( )
} ;
/************************************************************************/
/* */
/************************************************************************/
struct NOTIFY_NEW_BLOCK
{
const static int ID = BC_COMMANDS_POOL_BASE + 1 ;
2019-01-18 01:05:58 +00:00
struct request_t
2014-03-03 22:07:58 +00:00
{
block_complete_entry b ;
uint64_t current_blockchain_height ;
BEGIN_KV_SERIALIZE_MAP ( )
KV_SERIALIZE ( b )
KV_SERIALIZE ( current_blockchain_height )
END_KV_SERIALIZE_MAP ( )
} ;
2019-01-18 01:05:58 +00:00
typedef epee : : misc_utils : : struct_init < request_t > request ;
2014-03-03 22:07:58 +00:00
} ;
/************************************************************************/
/* */
/************************************************************************/
struct NOTIFY_NEW_TRANSACTIONS
{
const static int ID = BC_COMMANDS_POOL_BASE + 2 ;
2019-01-18 01:05:58 +00:00
struct request_t
2014-03-03 22:07:58 +00:00
{
2018-04-15 23:16:02 +00:00
std : : vector < blobdata > txs ;
2018-11-02 22:27:25 +00:00
std : : string _ ; // padding
2014-03-03 22:07:58 +00:00
BEGIN_KV_SERIALIZE_MAP ( )
KV_SERIALIZE ( txs )
2018-11-02 22:27:25 +00:00
KV_SERIALIZE ( _ )
2014-03-03 22:07:58 +00:00
END_KV_SERIALIZE_MAP ( )
} ;
2019-01-18 01:05:58 +00:00
typedef epee : : misc_utils : : struct_init < request_t > request ;
2014-03-03 22:07:58 +00:00
} ;
/************************************************************************/
/* */
/************************************************************************/
struct NOTIFY_REQUEST_GET_OBJECTS
{
const static int ID = BC_COMMANDS_POOL_BASE + 3 ;
2019-01-18 01:05:58 +00:00
struct request_t
2014-03-03 22:07:58 +00:00
{
2019-05-31 00:59:19 +00:00
std : : vector < crypto : : hash > blocks ;
2014-03-03 22:07:58 +00:00
BEGIN_KV_SERIALIZE_MAP ( )
KV_SERIALIZE_CONTAINER_POD_AS_BLOB ( blocks )
END_KV_SERIALIZE_MAP ( )
} ;
2019-01-18 01:05:58 +00:00
typedef epee : : misc_utils : : struct_init < request_t > request ;
2014-03-03 22:07:58 +00:00
} ;
struct NOTIFY_RESPONSE_GET_OBJECTS
{
const static int ID = BC_COMMANDS_POOL_BASE + 4 ;
2019-01-18 01:05:58 +00:00
struct request_t
2014-03-03 22:07:58 +00:00
{
2018-04-15 23:16:02 +00:00
std : : vector < block_complete_entry > blocks ;
std : : vector < crypto : : hash > missed_ids ;
2014-03-03 22:07:58 +00:00
uint64_t current_blockchain_height ;
BEGIN_KV_SERIALIZE_MAP ( )
KV_SERIALIZE ( blocks )
KV_SERIALIZE_CONTAINER_POD_AS_BLOB ( missed_ids )
KV_SERIALIZE ( current_blockchain_height )
END_KV_SERIALIZE_MAP ( )
} ;
2019-01-18 01:05:58 +00:00
typedef epee : : misc_utils : : struct_init < request_t > request ;
2014-03-03 22:07:58 +00:00
} ;
struct CORE_SYNC_DATA
{
uint64_t current_height ;
2017-08-12 14:24:39 +00:00
uint64_t cumulative_difficulty ;
2019-01-31 10:44:08 +00:00
uint64_t cumulative_difficulty_top64 ;
2014-03-03 22:07:58 +00:00
crypto : : hash top_id ;
2017-08-09 08:31:00 +00:00
uint8_t top_version ;
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
uint32_t pruning_seed ;
2014-03-03 22:07:58 +00:00
BEGIN_KV_SERIALIZE_MAP ( )
KV_SERIALIZE ( current_height )
2017-08-12 14:24:39 +00:00
KV_SERIALIZE ( cumulative_difficulty )
2019-01-31 10:44:08 +00:00
KV_SERIALIZE ( cumulative_difficulty_top64 )
2014-03-03 22:07:58 +00:00
KV_SERIALIZE_VAL_POD_AS_BLOB ( top_id )
2017-08-09 08:31:00 +00:00
KV_SERIALIZE_OPT ( top_version , ( uint8_t ) 0 )
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
KV_SERIALIZE_OPT ( pruning_seed , ( uint32_t ) 0 )
2014-03-03 22:07:58 +00:00
END_KV_SERIALIZE_MAP ( )
} ;
struct NOTIFY_REQUEST_CHAIN
{
const static int ID = BC_COMMANDS_POOL_BASE + 6 ;
2019-01-18 01:05:58 +00:00
struct request_t
2014-03-03 22:07:58 +00:00
{
std : : list < crypto : : hash > block_ids ; /*IDs of the first 10 blocks are sequential, next goes with pow(2,n) offset, like 2, 4, 8, 16, 32, 64 and so on, and the last one is always genesis block */
BEGIN_KV_SERIALIZE_MAP ( )
KV_SERIALIZE_CONTAINER_POD_AS_BLOB ( block_ids )
END_KV_SERIALIZE_MAP ( )
} ;
2019-01-18 01:05:58 +00:00
typedef epee : : misc_utils : : struct_init < request_t > request ;
2014-03-03 22:07:58 +00:00
} ;
struct NOTIFY_RESPONSE_CHAIN_ENTRY
{
const static int ID = BC_COMMANDS_POOL_BASE + 7 ;
2019-01-18 01:05:58 +00:00
struct request_t
2014-03-03 22:07:58 +00:00
{
uint64_t start_height ;
uint64_t total_height ;
2017-08-12 14:24:39 +00:00
uint64_t cumulative_difficulty ;
2019-01-31 10:44:08 +00:00
uint64_t cumulative_difficulty_top64 ;
2018-04-15 23:16:02 +00:00
std : : vector < crypto : : hash > m_block_ids ;
2014-03-03 22:07:58 +00:00
BEGIN_KV_SERIALIZE_MAP ( )
KV_SERIALIZE ( start_height )
KV_SERIALIZE ( total_height )
2017-08-12 14:24:39 +00:00
KV_SERIALIZE ( cumulative_difficulty )
2019-01-31 10:44:08 +00:00
KV_SERIALIZE ( cumulative_difficulty_top64 )
2014-03-03 22:07:58 +00:00
KV_SERIALIZE_CONTAINER_POD_AS_BLOB ( m_block_ids )
END_KV_SERIALIZE_MAP ( )
} ;
2019-01-18 01:05:58 +00:00
typedef epee : : misc_utils : : struct_init < request_t > request ;
2014-03-03 22:07:58 +00:00
} ;
2016-10-26 19:00:08 +00:00
/************************************************************************/
/* */
/************************************************************************/
struct NOTIFY_NEW_FLUFFY_BLOCK
{
const static int ID = BC_COMMANDS_POOL_BASE + 8 ;
2019-01-18 01:05:58 +00:00
struct request_t
2016-10-26 19:00:08 +00:00
{
block_complete_entry b ;
uint64_t current_blockchain_height ;
BEGIN_KV_SERIALIZE_MAP ( )
KV_SERIALIZE ( b )
KV_SERIALIZE ( current_blockchain_height )
END_KV_SERIALIZE_MAP ( )
} ;
2019-01-18 01:05:58 +00:00
typedef epee : : misc_utils : : struct_init < request_t > request ;
2016-10-26 19:00:08 +00:00
} ;
/************************************************************************/
/* */
/************************************************************************/
struct NOTIFY_REQUEST_FLUFFY_MISSING_TX
{
const static int ID = BC_COMMANDS_POOL_BASE + 9 ;
2014-03-03 22:07:58 +00:00
2019-01-18 01:05:58 +00:00
struct request_t
2016-10-26 19:00:08 +00:00
{
2017-02-11 19:38:18 +00:00
crypto : : hash block_hash ;
2016-10-26 19:00:08 +00:00
uint64_t current_blockchain_height ;
2018-01-11 17:31:47 +00:00
std : : vector < uint64_t > missing_tx_indices ;
2016-10-26 19:00:08 +00:00
BEGIN_KV_SERIALIZE_MAP ( )
2017-02-11 19:38:18 +00:00
KV_SERIALIZE_VAL_POD_AS_BLOB ( block_hash )
KV_SERIALIZE ( current_blockchain_height )
KV_SERIALIZE_CONTAINER_POD_AS_BLOB ( missing_tx_indices )
2016-10-26 19:00:08 +00:00
END_KV_SERIALIZE_MAP ( )
} ;
2019-01-18 01:05:58 +00:00
typedef epee : : misc_utils : : struct_init < request_t > request ;
2016-10-26 19:00:08 +00:00
} ;
2014-03-03 22:07:58 +00:00
}