tcoulter/ethereumjs-block

Provides helper functions for Blocks

SYNOPSIS

Implements schema and functions related to Etheruem's block.

INSTALL

npm install ethereumjs-block

BOWSER

This module work with browserify

CONTACT

or #ethereumjs on freenode

API

• Block

  • new Block([data])
  • Block Properties
  • Block Methods
    • block.genTxTrie(cb)
    • block.hash()
    • block.serialize()
    • block.validate(blockchain, cb)
    • block.validateUncles(blockchain, cb)
    • block.validateTransactions()
    • block.validateTransactionsTrie()
    • block.isGenesis()
    • block.setGenesisParams()
    • block.toJSON([label=false])

• Blockheader

  • Blockheader Properties
  • Blockheader Methods
    • blockheader.validate(blockchain, [height], cb)
    • blockheader.validateDifficulty()
    • blockheader.validateGasLimit()
    • blockheader.canonicalGasLimit(parentBlock)
    • blockheader.canonicalDifficulty(parentBlock)
    • blockheader.hash()

Block

new Block([data])

Creates a new block object

• data - the serialized block (usually from the network) in a array of buffers as described in the wire protocol

Block Properties

• header - the block's header
• transactionReceipt - an array of TransactionReceipt in the block
• uncleList - an array of uncle headers
• raw - an array of buffers containing the raw blocks.

Block Methods

block.genTxTrie(cb)

Generates the transaction trie. This must be done before doing validation

• cb - the callback

block.hash()

Returns the sha3-256 hash of the RLP encoding of the serialized block

block.serialize()

Returns the RLP serialization of the block.

block.validate(blockchain, cb)

Validates the entire block. Returns a string to the callback if block is invalid

• blockchain - an instance of the Blockchain
• cb - the callback

block.validateUncles(blockchain, cb)

Validates the uncles that are in the block if any. Returns a string to the callback if uncles are invalid

• blockchain - an instance of the Blockchain
• cb - the callback

block.validateTransactions()

Validates all of the transactions in the block. Returns a Boolean

block.validateTransactionsTrie()

Validates the transaction trie. Returns a Boolean

block.isGenesis()

Returns a Boolean determining if the block is a genesis block

block.setGenesisParams()

Sets the parameters of the block to the genesis block.

block.toJSON([label=false])

Returns the block as a JSON object.

• label - A Boolean. If true returns an JSON object with properties corresponding to the block properties if false it just returns a JSON array.

Blockheader

A object that repersents the block header.

Blockheader Properties

• parentHash - the blocks' parnet's hash
• uncleHash - sha3(rlp_encode(uncle_list))
• coinbase - the miner address
• stateRoot - The root of a Merkle Patricia tree
• transactionTrie - the root of a Trie containing the transactions
• receiptTrie - the root of a Trie containing the transaction Reciept
• bloom
• difficulty
• number - the height
• gasLimit
• gasUsed
• timestamp
• extraData
• raw - an Array of Buffers forming the raw header

Blockheader Methods

blockheader.validate(blockchain, [height], cb)

Validates the entire block headers

• blockchain - blockChain the blockchain that this block is validating against
• height if this is an uncle header, this is the height of the block that is including it
• cb the callback function

blockheader.validateDifficulty()

Validates the difficutly returning a Boolean

blockheader.validateGasLimit()

Validates the gasLimit, returning a Boolean

blockheader.canonicalGasLimit(parentBlock)

Returns the canonical gas limit of the block

• parentBlock - the parentBlock of the header

blockheader.canonicalDifficulty(parentBlock)

Returns the canoncical difficulty of the block

• parentBlock - the parent Block of the header

blockheader.hash()

Returns the sha3 hash of the blockheader

LICENSE

MPL-2.0