Class: Headers

Headers

new Headers(data)

Represents block headers obtained from the network via headers.

Parameters:

Name	Type	Description
`data`	NakedBlock

Properties:

Name	Type	Description
`version`	Number	Block version. Note that BCoin reads versions as unsigned despite them being signed on the protocol level. This number will never be negative.
`prevBlock`	Hash	Previous block hash.
`merkleRoot`	Hash	Merkle root hash.
`ts`	Number	Timestamp.
`bits`	Number
`nonce`	Number
`totalTX`	Number	Transaction count.
`height`	Number	Block height (-1 if not present).
`rhash`	ReversedHash	Reversed block hash (uint256le).

Source:

bcoin/headers.js, line 32

Extends

AbstractBlock

Methods

(static) _fromRaw(data, encnullable) → {NakedBlock}

Parse a serialized headers.

Parameters:

Name	Type	Attributes	Description
`data`	Buffer
`enc`	String	<nullable>	Encoding, can be `'hex'` or null.

Source:

bcoin/headers.js, line 129

Returns:

A "naked" headers object.

Type: NakedBlock

(static) fromRaw(data, encnullable) → {Headers}

Instantiate headers from a serialized Buffer.

Parameters:

Name	Type	Attributes	Description
`data`	Buffer
`enc`	String	<nullable>	Encoding, can be `'hex'` or null.

Source:

bcoin/headers.js, line 143

Returns:

Type: Headers

(static) isHeaders(obj) → {Boolean}

Test an object to see if it is a Headers object.

Parameters:

Name	Type	Description
`obj`	Object

Source:

bcoin/headers.js, line 153

Returns:

Type: Boolean

abbr() → {Buffer}

Serialize the block headers.

Inherited From:

AbstractBlock#abbr

Source:

bcoin/abstractblock.js, line 75

Returns:

Type: Buffer

getRaw() → {Buffer}

Get the raw headers serialization.

Source:

bcoin/headers.js, line 80

Returns:

Type: Buffer

getSize() → {Number}

Get size of the headers.

Overrides:

AbstractBlock#getSize

Source:

bcoin/headers.js, line 69

Returns:

Type: Number

hash(encnullable) → {Hash|Buffer}

Hash the block headers.

Parameters:

Name	Type	Attributes	Description
`enc`	String	<nullable>	Can be `'hex'` or `null`.

Inherited From:

AbstractBlock#hash

Source:

bcoin/abstractblock.js, line 63

Returns:

hash

Type: Hash | Buffer

inspect() → {Object}

Inspect the headers and return a more user-friendly representation of the data.

Source:

bcoin/headers.js, line 94

Returns:

Type: Object

isGenesis() → {Boolean}

Test against the genesis block.

Inherited From:

AbstractBlock#isGenesis

Source:

bcoin/abstractblock.js, line 138

Returns:

Type: Boolean

render() → {Buffer}

Serialize the header into a headers packet.

Source:

bcoin/headers.js, line 48

Returns:

Type: Buffer

setHeight(height)

Set the height property and the height property of all transactions within the block.

Parameters:

Name	Type	Description
`height`	Number

Inherited From:

AbstractBlock#setHeight

Source:

bcoin/abstractblock.js, line 148

toRaw(encnullable) → {Buffer|String}

Serialize the headers.

Parameters:

Name	Type	Attributes	Description
`enc`	String	<nullable>	Encoding, can be `'hex'` or null.

Source:

bcoin/headers.js, line 111

See:

{Headers#render}

Returns:

Type: Buffer | String

verify(retnullable) → {Boolean}

Verify the block.

Parameters:

Name	Type	Attributes	Description
`ret`	Object	<nullable>	Return object, may be set with properties `reason` and `score`.

Inherited From:

AbstractBlock#verify

Source:

bcoin/abstractblock.js, line 98

Returns:

Type: Boolean

verifyHeaders(retnullable) → {Boolean}

Verify the block headers (called by verify() in all objects which inherit from AbstractBlock).

Parameters:

Name	Type	Attributes	Description
`ret`	Object	<nullable>	Return object, may be set with properties `reason` and `score`.

Inherited From:

AbstractBlock#verifyHeaders

Source:

bcoin/abstractblock.js, line 112

Returns:

Type: Boolean