Skip to content

Latest commit

 

History

History
127 lines (73 loc) · 3.03 KB

block.md

File metadata and controls

127 lines (73 loc) · 3.03 KB
Raw

Index

BTC::Block

BTC::Block represents a collection of transactions within the block chain. It consists of block header and an array of transactions.

Class Methods

genesis_mainnet

Returns a genesis block for mainnet. See also BTC::Network#genesis_block.

genesis_testnet

Returns a genesis block for testnet. See also BTC::Network#genesis_block.

Initializers

new(data: String)

Returns a new block initialized with a binary string in wire format. Raises ArgumentError if block is incomplete or incorrectly encoded.

new(stream: IO)

Returns a new block initialized with data in wire format read from a given stream. Raises ArgumentError if block is incomplete or incorrectly encoded.

new(attributes)

Returns a new block with named attributes. All attributes are optional and have appropriate default values.

Block.new(
  version: 2,
  previous_block_id: "000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f",
  merkle_root: "...",
  transactions: [...])

Attributes

version

Block version (1 or 2).

previous_block_hash

Binary hash of the previous block.

previous_block_id

Hex big-endian hash of the previous block. See Hash↔ID Conversion.

merkle_root

Binary root hash of the transactions’ merkle tree.

timestamp

32-bit unsigned UNIX timestamp.

time

Time object derived from timestamp

bits

Proof-of-work target in a compact form (uint32). See Proof-of-Work Conversion Routines.

nonce

Proof-of-work nonce (uint32 value iterated during mining).

transactions

List of BTC::Transaction instances contained within the block.

height

Optional height in the block chain (genesis block has height 0). Not stored within block's binary representation. Third party APIs may set this value for user’s convenience.

confirmations

Optional number of the confirmations for transactions in this block. If this block is the latest one, confirmations equals 1. Not stored within block's binary representation. Third party APIs may set this value for user’s convenience.

Instance Methods

block_hash

Binary hash of the block. Equals SHA256(SHA256(header_data)).

block_id

Hex big-endian hash of the block. See Hash↔ID Conversion.

block_header

Returns a BTC::BlockHeader instance containing all attributes of this block except transactions.

header_data

Returns block’s header data in wire format.

data

Returns block’s entire data in wire format.

dup

Returns a copy of the block.

==

Returns true if binary representation of both blocks is equal (external attributes height, confirmations are ignored).