/usr/include/bitcoin/blockchain/blockchain.hpp is in libbitcoin-dev 2.0-2.4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 | /*
* Copyright (c) 2011-2013 libbitcoin developers (see AUTHORS)
*
* This file is part of libbitcoin.
*
* libbitcoin is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License with
* additional permissions to the one published by the Free Software
* Foundation, either version 3 of the License, or (at your option)
* any later version. For more information see LICENSE.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef LIBBITCOIN_BLOCKCHAIN_BLOCKCHAIN_HPP
#define LIBBITCOIN_BLOCKCHAIN_BLOCKCHAIN_HPP
/**
* Represents an interface to a blockchain backend.
*/
#include <boost/utility.hpp>
#include <functional>
#include <bitcoin/block.hpp>
#include <bitcoin/error.hpp>
#include <bitcoin/primitives.hpp>
#include <bitcoin/address.hpp>
#include <bitcoin/transaction.hpp>
namespace libbitcoin {
class blockchain
{
public:
typedef std::function<void (const std::error_code&, block_info)>
store_block_handler;
typedef std::function<void (const std::error_code&)> import_block_handler;
template <typename Message>
using fetch_handler = std::function<
void (const std::error_code&, const Message&)>;
typedef fetch_handler<block_header_type> fetch_handler_block_header;
typedef fetch_handler<hash_digest_list>
fetch_handler_block_transaction_hashes;
typedef fetch_handler<size_t> fetch_handler_block_height;
typedef fetch_handler<size_t> fetch_handler_last_height;
typedef fetch_handler<block_locator_type>
fetch_handler_block_locator;
typedef fetch_handler<transaction_type> fetch_handler_transaction;
typedef std::function<
void (const std::error_code&, size_t, size_t)>
fetch_handler_transaction_index;
typedef fetch_handler<input_point> fetch_handler_spend;
struct history_row
{
output_point output;
size_t output_height;
uint64_t value;
input_point spend;
size_t spend_height;
};
typedef std::vector<history_row> history_list;
typedef std::function<void (const std::error_code&, const history_list&)>
fetch_handler_history;
typedef std::vector<std::shared_ptr<block_type>> block_list;
typedef std::function<
void (const std::error_code&, size_t,
const block_list&, const block_list&)> reorganize_handler;
virtual ~blockchain() {};
/**
* Store a new block.
*
* Subscriber is notified exactly once of changes to the blockchain
* and needs to re-subscribe to continue being notified.
*
* @param[in] block Block to store
* @param[in] handle_store Completion handler for store operation.
* @code
* void handle_store(
* const std::error_code& ec, // Status of operation
* block_info info // Status and height of block
* );
* @endcode
*/
virtual void store(const block_type& block,
store_block_handler handle_store) = 0;
/**
* Store a new block directly without validating it.
* No checks are done. Importing an already stored block
* is undefined.
*
* @param[in] import_block Block to store
* @param[in] height Height of block
* @param[in] handle_import Completion handler for import operation.
* @code
* void handle_import(
* const std::error_code& ec // Status of operation
* );
* @encode
*/
virtual void import(const block_type& import_block, size_t height,
import_block_handler handle_import) = 0;
/**
* Fetches the block header by height.
*
* @param[in] height Height of block to fetch
* @param[in] handle_fetch Completion handler for fetch operation.
* @code
* void handle_fetch(
* const std::error_code& ec, // Status of operation
* const block_header_type& blk // Block header
* );
* @endcode
*/
virtual void fetch_block_header(size_t height,
fetch_handler_block_header handle_fetch) = 0;
/**
* Fetches the block header by hash.
*
* @param[in] block_hash Hash of block
* @param[in] handle_fetch Completion handler for fetch operation.
* @code
* void handle_fetch(
* const std::error_code& ec, // Status of operation
* const block_header_type& blk // Block header
* );
* @endcode
*/
virtual void fetch_block_header(const hash_digest& block_hash,
fetch_handler_block_header handle_fetch) = 0;
/**
* Fetches list of transaction hashes in a block by height.
*
* @param[in] height Height of block containing transactions.
* @param[in] handle_fetch Completion handler for fetch operation.
* @code
* void handle_fetch(
* const std::error_code& ec, // Status of operation
* const hash_digest_list& hashes // List of hashes
* );
* @endcode
*/
virtual void fetch_block_transaction_hashes(size_t height,
fetch_handler_block_transaction_hashes handle_fetch) = 0;
/**
* Fetches list of transaction hashes in a block by block hash.
*
* @param[in] block_hash Hash of block
* @param[in] handle_fetch Completion handler for fetch operation.
* @code
* void handle_fetch(
* const std::error_code& ec, // Status of operation
* const hash_digest_list& hashes // List of hashes
* );
* @endcode
*/
virtual void fetch_block_transaction_hashes(const hash_digest& block_hash,
fetch_handler_block_transaction_hashes handle_fetch) = 0;
/**
* Fetches the height of a block given its hash.
*
* @param[in] block_hash Hash of block
* @param[in] handle_fetch Completion handler for fetch operation.
* @code
* void handle_fetch(
* const std::error_code& ec, // Status of operation
* size_t block_height // Height of block
* );
* @endcode
*/
virtual void fetch_block_height(const hash_digest& block_hash,
fetch_handler_block_height handle_fetch) = 0;
/**
* Fetches the height of the last block in our blockchain.
*
* @param[in] handle_fetch Completion handler for fetch operation.
* @code
* void handle_fetch(
* const std::error_code& ec, // Status of operation
* size_t block_height // Height of last block
* );
* @endcode
*/
virtual void fetch_last_height(fetch_handler_last_height handle_fetch) = 0;
/**
* Fetches a transaction by hash.
*
* @param[in] transaction_hash Transaction's hash
* @param[in] handle_fetch Completion handler for fetch operation.
* @code
* void handle_fetch(
* const std::error_code& ec, // Status of operation
* const transaction_type& tx // Transaction
* );
* @endcode
*/
virtual void fetch_transaction(const hash_digest& transaction_hash,
fetch_handler_transaction handle_fetch) = 0;
/**
* Fetch the block height that contains a transaction and its index
* within a block.
*
* @param[in] transaction_hash Transaction's hash
* @param[in] handle_fetch Completion handler for fetch operation.
* @code
* void handle_fetch(
* const std::error_code& ec, // Status of operation
* size_t block_height, // Height of block containing
* // the transaction.
* size_t index // Index of transaction within
* // the block.
* );
* @endcode
*/
virtual void fetch_transaction_index(
const hash_digest& transaction_hash,
fetch_handler_transaction_index handle_fetch) = 0;
// fetch of inputs and outputs is a future possibility
// for now use fetch_transaction and lookup input/output
/**
* Fetches a corresponding spend of an output.
*
* @param[in] outpoint Representation of an output.
* @param[in] handle_fetch Completion handler for fetch operation.
* @code
* void handle_fetch(
* const std::error_code& ec, // Status of operation
* const input_point& inpoint // Spend of output
* );
* @endcode
*/
virtual void fetch_spend(const output_point& outpoint,
fetch_handler_spend handle_fetch) = 0;
/**
* Fetches the output points, output values, corresponding input point
* spends and the block heights associated with a Bitcoin address.
* The returned history is a list of rows with the following fields:
*
* @code
* struct history_row
* {
* output_point output;
* size_t output_height;
* uint64_t value;
* input_point spend;
* size_t spend_height;
* };
* @endcode
*
* If an output is unspent then the input spend hash will be equivalent
* to null_hash.
*
* @code
* if (history.spend.hash == null_hash)
* // The history.output point is unspent.
* @endcode
*
* Summing the list of values for unspent outpoints gives the balance
* for an address.
*
* @param[in] address Bitcoin address
* @param[in] handle_fetch Completion handler for fetch operation.
* @param[in] from_height Starting block height for history.
* Useful to filter entries or to fetch
* the history in chunks.
* @code
* void handle_fetch(
* const std::error_code& ec, // Status of operation
* const blockchain::history_list& history // History
* );
* @endcode
*/
virtual void fetch_history(const payment_address& address,
fetch_handler_history handle_fetch, size_t from_height=0) = 0;
/**
* Be notified of the next blockchain change.
*
* Subscriber is notified exactly once of changes to the blockchain
* and needs to re-subscribe to continue being notified.
*
* @param[in] handle_reorganize Notification handler for changes
* @code
* void handle_reorganize(
* const std::error_code& ec, // Status of operation
* size_t fork_point, // Index where blockchain forks
* const block_list& added, // New blocks added to blockchain
* const block_list& removed // Blocks removed (empty if none)
* );
* @endcode
*/
virtual void subscribe_reorganize(
reorganize_handler handle_reorganize) = 0;
};
typedef std::function<void (const std::error_code&, const block_type&)>
blockchain_fetch_handler_block;
/**
* Fetch a block by height.
*
* If the blockchain reorganises, operation may fail halfway.
*
* @param[in] chain Blockchain service
* @param[in] height Height of block to fetch.
* @param[in] handle_fetch Completion handler for fetch operation.
* @code
* void handle_fetch(
* const std::error_code& ec, // Status of operation
* const block_type& blk // Block header
* );
* @endcode
*/
void fetch_block(blockchain& chain, size_t height,
blockchain_fetch_handler_block handle_fetch);
/**
* Fetch a block by hash.
*
* If the blockchain reorganises, operation may fail halfway.
*
* @param[in] chain Blockchain service
* @param[in] block_hash Hash of block to fetch.
* @param[in] handle_fetch Completion handler for fetch operation.
* @code
* void handle_fetch(
* const std::error_code& ec, // Status of operation
* const block_type& blk // Block header
* );
* @endcode
*/
void fetch_block(blockchain& chain, const hash_digest& block_hash,
blockchain_fetch_handler_block handle_fetch);
typedef std::function<
void (const std::error_code&, const block_locator_type&)>
blockchain_fetch_handler_block_locator;
/**
* Creates a block_locator object used to download the blockchain.
*
* @param[in] handle_fetch Completion handler for fetch operation.
* @code
* void handle_fetch(
* const std::error_code& ec, // Status of operation
* const block_locator_type& loc // Block locator object
* );
* @endcode
*/
void fetch_block_locator(blockchain& chain,
blockchain_fetch_handler_block_locator handle_fetch);
typedef std::function<void (const std::error_code&,
const output_point_list&, const input_point_list&)>
blockchain_fetch_handler_history;
} // namespace libbitcoin
#endif
|