Index | Bitcoin BLK block file parser/reader API

B

BlockParser — Class in namespace Cjpg\Bitcoin\Blk: BlockParser reads the raw block data extracted from blk files.
$ BlockParser#block — Property in class BlockParser: The block bytes we read from.
BlockParser::blockHash() — Method in class BlockParser: Gets the block hash
BlockParser::bits() — Method in class BlockParser: Get the block bits.
BlockParser::bitsHex() — Method in class BlockParser: Get the block bits as hexadecimal.
BlockParser::block() — Method in class BlockParser: Gets the raw block.

C

$ Reader#currentItem — Property in class Reader: The current item in use by the iterator.
$ Reader#currentPosition — Property in class Reader: The current position of the iterator.
Reader::count() — Method in class Reader: Get the number of items in this reader.
Reader::current() — Method in class Reader: Get the current element.
Stream::close() — Method in class Stream: Closes the stream.

D

BlockParser::difficulty() — Method in class BlockParser: Get the block difficulty.
Stream::detach() — Method in class Stream: Get the current stream and separates it from the current instance.

E

BlockParser::end() — Method in class BlockParser: Ends the reader and releases the underlying memory stream.
Stream::eof() — Method in class Stream: Returns true if the stream is at the end of the stream.

F

Stream::fromString() — Method in class Stream: Create a new stream from a string.
Stream::fromFile() — Method in class Stream: Create a stream from an existing file.
TxParser::fromStream() — Method in class TxParser: Reads the transaction data from the stream.

G

Stream::getSize() — Method in class Stream: Get the size of the stream.
Stream::getContents() — Method in class Stream: Returns the remaining contents in a string
Stream::getMetadata() — Method in class Stream: Get stream metadata as an associative array or retrieve a specific key.

H

BlockParser::hasSegwit() — Method in class BlockParser: Check if the block contains any segregated witness transactions.
$ TxParser#hash — Property in class TxParser: The transaction hash (differs from txid for witness transactions).
$ TxParser#hex — Property in class TxParser: The full transaction as a hexadecimal value.
Utilities::hash256() — Method in class Utilities: Run sha256 hash on $data twice

I

$ Reader#items — Property in class Reader: The items from which the reader can read.
Stream::isSeekable() — Method in class Stream: Returns whether or not the stream is seekable.
Stream::isWritable() — Method in class Stream: Returns whether or not the stream is writable.
Stream::isReadable() — Method in class Stream: Returns whether or not the stream is readable.
$ TxParser#inputCount — Property in class TxParser: The number of inputs contained in this transaction.
$ TxParser#inputs — Property in class TxParser: The transaction inputs.

K

Reader::key() — Method in class Reader: Get the key of the current element.

L

Reader::loadData() — Method in class Reader: Loads the data into the reader.
$ TxParser#locktime — Property in class TxParser: The block height or timestamp of when the transaction can be spend.

M

$ BlockParser#magicBytes — Property in class BlockParser: The magic bytes that indicates the block start and type.
BlockParser::merkleRoot() — Method in class BlockParser: Gets the merkle root of the block.
BlockParser::magicBytes() — Method in class BlockParser: Gets the magic bytes.

N

BlockParser::nonce() — Method in class BlockParser: Get the block nonce.
Reader::next() — Method in class Reader: Move forward to next element.

O

$ Reader#offsetGetFormatter — Property in class Reader: A custom function to format the items in the list.
Reader::offsetExists() — Method in class Reader: Check if an offset($key) exists.
Reader::offsetGet() — Method in class Reader: Get the item at offset($key).
Reader::offsetSet() — Method in class Reader: Set/Add an item.
Reader::offsetUnset() — Method in class Reader: Unset an item from the list.
$ TxParser#outputCount — Property in class TxParser: The number of outputs contained in this transaction.
$ TxParser#outputs — Property in class TxParser: The transaction outputs.

P

BlockParser::previousBlock() — Method in class BlockParser: Gets the previous block hash.

R

Reader — Class in namespace Cjpg\Bitcoin\Blk\Readers: Base of the reader classes.
Reader::rewind() — Method in class Reader: Rewind the iterator to the first element.
Stream::rewind() — Method in class Stream: Seek to the beginning of the stream.
Stream::readVarInt() — Method in class Stream: Read a variable int.
Stream::read() — Method in class Stream: Read data from the stream.
TxParser::readWitnessesFromStream() — Method in class TxParser: Reads the witness data from the stream.
TxParser::readOutputsFromStream() — Method in class TxParser: Reads the outputs of the transaction from the stream.
TxParser::readInputsFromStream() — Method in class TxParser: Reads the inputs of the transaction from the stream.

S

$ BlockParser#size — Property in class BlockParser: The block size.
BlockParser::strippedSize() — Method in class BlockParser: Get the stripped size of the block, that is the size of the block without witness data.
BlockParser::size() — Method in class BlockParser: Gets the size of the block in bytes.
Reader::setOffsetGetFormatter() — Method in class Reader: Set the item output formatter.
Stream — Class in namespace Cjpg\Bitcoin\Blk\Readers: An internal stream class for reading the blk files.
$ Stream#stream — Property in class Stream: The underlying stream resource
Stream::seek() — Method in class Stream: Seek to a position in the stream.
$ TxParser#size — Property in class TxParser: The transaction size
$ TxParser#segwit — Property in class TxParser: Flag indicating the presence of witness data
Utilities::sha256() — Method in class Utilities: Run sha256 hash on $data
Utilities::swapEndian() — Method in class Utilities: Swap endianness of an hexadecimal string.

T

BlockParser::transactions() — Method in class BlockParser: Get the transactions.
BlockParser::transactionCount() — Method in class BlockParser: Get the transaction count.
BlockParser::timestamp() — Method in class BlockParser: Gets the block timestamp.
Stream::tell() — Method in class Stream: Returns the current position of the file read/write pointer
TxParser — Class in namespace Cjpg\Bitcoin\Blk: TxParser reads the transaction from an input of bytes (binary string) or a hexadecimal string.
$ TxParser#txid — Property in class TxParser: The transaction id.

U

Utilities — Class in namespace Cjpg\Bitcoin\Blk: Helper Utilities

V

BlockParser::version() — Method in class BlockParser: Gets the block version.
BlockParser::versionHex() — Method in class BlockParser: Gets the block version as hexadecimal.
Reader::valid() — Method in class Reader: Checks if current iterator position is valid.
$ TxParser#vsize — Property in class TxParser: The virtual transaction size (differs from size for witness transactions)
$ TxParser#version — Property in class TxParser: The version of this transaction.

W

BlockParser::weight() — Method in class BlockParser: The block weight.
Stream::write() — Method in class Stream: Write data to the stream.
$ TxParser#weight — Property in class TxParser: The transaction weight

_

BlockParser::__construct() — Method in class BlockParser: Initialize a new instance of the bitcoin block parser class.
BlockParser::__destruct() — Method in class BlockParser: Closes the stream.
Stream::__construct() — Method in class Stream: Initialize a new stream from a resource or {IStream}
Stream::__toString() — Method in class Stream: Gets the stream into a string
Stream::__destruct() — Method in class Stream: Closes the stream.
TxParser::__construct() — Method in class TxParser