You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
228 lines
9.0 KiB
228 lines
9.0 KiB
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>JSDoc: Source: bcoin/abstractblock.js</title>
|
|
|
|
<script src="scripts/prettify/prettify.js"> </script>
|
|
<script src="scripts/prettify/lang-css.js"> </script>
|
|
<!--[if lt IE 9]>
|
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
<![endif]-->
|
|
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
|
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<div id="main">
|
|
|
|
<h1 class="page-title">Source: bcoin/abstractblock.js</h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<article>
|
|
<pre class="prettyprint source linenums"><code>/*!
|
|
* abstractblock.js - abstract block object for bcoin
|
|
* Copyright (c) 2014-2015, Fedor Indutny (MIT License)
|
|
* Copyright (c) 2014-2016, Christopher Jeffrey (MIT License).
|
|
* https://github.com/indutny/bcoin
|
|
*/
|
|
|
|
var bcoin = require('./env');
|
|
var constants = bcoin.protocol.constants;
|
|
var utils = bcoin.utils;
|
|
var assert = utils.assert;
|
|
|
|
/**
|
|
* The class which all block-like objects inherit from.
|
|
* @exports AbstractBlock
|
|
* @constructor
|
|
* @abstract
|
|
* @param {NakedBlock} data
|
|
* @property {Number} version - Block version. Note
|
|
* that BCoin reads versions as unsigned despite
|
|
* them being signed on the protocol level. This
|
|
* number will never be negative.
|
|
* @property {Hash} prevBlock - Previous block hash.
|
|
* @property {Hash} merkleRoot - Merkle root hash.
|
|
* @property {Number} ts - Timestamp.
|
|
* @property {Number} bits
|
|
* @property {Number} nonce
|
|
* @property {Number} totalTX - Transaction count.
|
|
* @property {Number} height - Block height (-1 if not present).
|
|
* @property {TX[]} txs - Transaction vector.
|
|
* @property {ReversedHash} rhash - Reversed block hash (uint256le).
|
|
*/
|
|
|
|
function AbstractBlock(data) {
|
|
if (!(this instanceof AbstractBlock))
|
|
return new AbstractBlock(data);
|
|
|
|
assert(data, 'Block data is required.');
|
|
assert(typeof data.version === 'number');
|
|
assert(typeof data.prevBlock === 'string');
|
|
assert(typeof data.merkleRoot === 'string');
|
|
assert(typeof data.ts === 'number');
|
|
assert(typeof data.bits === 'number');
|
|
assert(typeof data.nonce === 'number');
|
|
|
|
this.version = data.version;
|
|
this.prevBlock = data.prevBlock;
|
|
this.merkleRoot = data.merkleRoot;
|
|
this.ts = data.ts;
|
|
this.bits = data.bits;
|
|
this.nonce = data.nonce;
|
|
this.totalTX = data.totalTX || 0;
|
|
this.height = data.height != null ? data.height : -1;
|
|
|
|
this.txs = null;
|
|
this.mutable = !!data.mutable;
|
|
|
|
this._valid = null;
|
|
this._hash = null;
|
|
this._size = null;
|
|
this._witnessSize = null;
|
|
}
|
|
|
|
/**
|
|
* Hash the block headers.
|
|
* @param {String?} enc - Can be `'hex'` or `null`.
|
|
* @returns {Hash|Buffer} hash
|
|
*/
|
|
|
|
AbstractBlock.prototype.hash = function hash(enc) {
|
|
var hash = this._hash;
|
|
|
|
if (!hash) {
|
|
hash = utils.dsha256(this.abbr());
|
|
if (!this.mutable)
|
|
this._hash = hash;
|
|
}
|
|
|
|
return enc === 'hex' ? hash.toString('hex') : hash;
|
|
};
|
|
|
|
/**
|
|
* Serialize the block headers.
|
|
* @returns {Buffer}
|
|
*/
|
|
|
|
AbstractBlock.prototype.abbr = function abbr() {
|
|
return bcoin.protocol.framer.blockHeaders(this);
|
|
};
|
|
|
|
/**
|
|
* Verify the block.
|
|
* @param {Object?} ret - Return object, may be
|
|
* set with properties `reason` and `score`.
|
|
* @returns {Boolean}
|
|
*/
|
|
|
|
AbstractBlock.prototype.verify = function verify(ret) {
|
|
var valid = this._valid;
|
|
|
|
if (valid == null) {
|
|
valid = this._verify(ret);
|
|
if (!this.mutable)
|
|
this._valid = valid;
|
|
}
|
|
|
|
return valid;
|
|
};
|
|
|
|
/**
|
|
* Verify the block headers (called by `verify()` in
|
|
* all objects which inherit from AbstractBlock).
|
|
* @param {Object?} ret - Return object, may be
|
|
* set with properties `reason` and `score`.
|
|
* @returns {Boolean}
|
|
*/
|
|
|
|
AbstractBlock.prototype.verifyHeaders = function verifyHeaders(ret) {
|
|
if (!ret)
|
|
ret = {};
|
|
|
|
// Check proof of work
|
|
if (!utils.testTarget(this.hash(), this.bits)) {
|
|
ret.reason = 'high-hash';
|
|
ret.score = 50;
|
|
return false;
|
|
}
|
|
|
|
// Check timestamp against now + 2 hours
|
|
if (this.ts > bcoin.now() + 2 * 60 * 60) {
|
|
ret.reason = 'time-too-new';
|
|
ret.score = 0;
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
};
|
|
|
|
/**
|
|
* Set the `height` property and the `height`
|
|
* property of all transactions within the block.
|
|
* @param {Number} height
|
|
*/
|
|
|
|
AbstractBlock.prototype.setHeight = function setHeight(height) {
|
|
var i;
|
|
|
|
this.height = height;
|
|
|
|
if (!this.txs)
|
|
return;
|
|
|
|
for (i = 0; i < this.txs.length; i++)
|
|
this.txs[i].height = height;
|
|
};
|
|
|
|
AbstractBlock.prototype.__defineGetter__('rhash', function() {
|
|
return utils.revHex(this.hash('hex'));
|
|
});
|
|
|
|
/**
|
|
* Convert the block to an inv item.
|
|
* @returns {InvItem}
|
|
*/
|
|
|
|
AbstractBlock.prototype.toInv = function toInv() {
|
|
return {
|
|
type: constants.inv.BLOCK,
|
|
hash: this.hash('hex')
|
|
};
|
|
};
|
|
|
|
/*
|
|
* Expose
|
|
*/
|
|
|
|
module.exports = AbstractBlock;
|
|
</code></pre>
|
|
</article>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<nav>
|
|
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-bcoin.html">bcoin</a></li><li><a href="module-constants.html">constants</a></li><li><a href="module-ec.html">ec</a></li><li><a href="module-ldb.html">ldb</a></li><li><a href="module-network.html">network</a></li><li><a href="module-profiler.html">profiler</a></li><li><a href="module-request.html">request</a></li><li><a href="module-uri.html">uri</a></li><li><a href="module-utils.html">utils</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBlock.html">AbstractBlock</a></li><li><a href="Account.html">Account</a></li><li><a href="Address.html">Address</a></li><li><a href="AES.html">AES</a></li><li><a href="Block.html">Block</a></li><li><a href="Bloom.html">Bloom</a></li><li><a href="BroadcastItem.html">BroadcastItem</a></li><li><a href="BST.html">BST</a></li><li><a href="BufferReader.html">BufferReader</a></li><li><a href="BufferWriter.html">BufferWriter</a></li><li><a href="Chain.html">Chain</a></li><li><a href="ChainDB.html">ChainDB</a></li><li><a href="ChainEntry.html">ChainEntry</a></li><li><a href="Coin.html">Coin</a></li><li><a href="Coins.html">Coins</a></li><li><a href="CoinView.html">CoinView</a></li><li><a href="CompactBlock.html">CompactBlock</a></li><li><a href="Environment.html">Environment</a></li><li><a href="Framer.html">Framer</a></li><li><a href="Fullnode.html">Fullnode</a></li><li><a href="HD.html">HD</a></li><li><a href="HDPrivateKey.html">HDPrivateKey</a></li><li><a href="HDPublicKey.html">HDPublicKey</a></li><li><a href="Headers.html">Headers</a></li><li><a href="HTTPBase.html">HTTPBase</a></li><li><a href="HTTPClient.html">HTTPClient</a></li><li><a href="HTTPServer.html">HTTPServer</a></li><li><a href="HTTPWallet.html">HTTPWallet</a></li><li><a href="Input.html">Input</a></li><li><a href="KeyPair.html">KeyPair</a></li><li><a href="KeyRing.html">KeyRing</a></li><li><a href="LoadRequest.html">LoadRequest</a></li><li><a href="Locker.html">Locker</a></li><li><a href="LowlevelUp.html">LowlevelUp</a></li><li><a href="LRU.html">LRU</a></li><li><a href="Master.html">Master</a></li><li><a href="Mempool.html">Mempool</a></li><li><a href="MempoolEntry.html">MempoolEntry</a></li><li><a href="MerkleBlock.html">MerkleBlock</a></li><li><a href="Miner.html">Miner</a></li><li><a href="MinerBlock.html">MinerBlock</a></li><li><a href="Mnemonic.html">Mnemonic</a></li><li><a href="MTX.html">MTX</a></li><li><a href="Network.html">Network</a></li><li><a href="NetworkAddress.html">NetworkAddress</a></li><li><a href="Node.html">Node</a></li><li><a href="NullCache.html">NullCache</a></li><li><a href="Output.html">Output</a></li><li><a href="Parser.html">Parser</a></li><li><a href="Peer.html">Peer</a></li><li><a href="Pool.html">Pool</a></li><li><a href="Profile.html">Profile</a></li><li><a href="RollingFilter.html">RollingFilter</a></li><li><a href="Script.html">Script</a></li><li><a href="ScriptError.html">ScriptError</a></li><li><a href="Snapshot.html">Snapshot</a></li><li><a href="SPVNode.html">SPVNode</a></li><li><a href="Stack.html">Stack</a></li><li><a href="TimeData.html">TimeData</a></li><li><a href="TX.html">TX</a></li><li><a href="TXDB.html">TXDB</a></li><li><a href="VerifyError.html">VerifyError</a></li><li><a href="Wallet.html">Wallet</a></li><li><a href="WalletDB.html">WalletDB</a></li><li><a href="Witness.html">Witness</a></li><li><a href="Worker.html">Worker</a></li><li><a href="Workers.html">Workers</a></li></ul><h3>Global</h3><ul><li><a href="global.html#hostname">hostname</a></li><li><a href="global.html#isMapped">isMapped</a></li><li><a href="global.html#mkdirp">mkdirp</a></li><li><a href="global.html#normalize">normalize</a></li><li><a href="global.html#parseHost">parseHost</a></li><li><a href="global.html#scrypt">scrypt</a></li><li><a href="global.html#toBuffer">toBuffer</a></li><li><a href="global.html#toString">toString</a></li><li><a href="global.html#version">version</a></li></ul>
|
|
</nav>
|
|
|
|
<br class="clear">
|
|
|
|
<footer>
|
|
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Sun Jun 05 2016 20:46:56 GMT-0700 (PDT)
|
|
</footer>
|
|
|
|
<script> prettyPrint(); </script>
|
|
<script src="scripts/linenumber.js"> </script>
|
|
</body>
|
|
</html>
|
|
|