Index | Bitcoin BLK block file parser/reader API

A

BaseCollection::all() — Method in class BaseCollection
BaseCollection::add() — Method in class BaseCollection: Add an item.
Money::add() — Method in class Money: Add $value to the current.

B

BaseCollection — Class in namespace Cjpg\Bitcoin\Blk
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.
BlkReader — Class in namespace Cjpg\Bitcoin\Blk\Readers: BLK File reader class.
$ BlkReader#blkFolder — Property in class BlkReader: The full path to the folder that contains the bitcoin blk files.
BlkReader::blocks() — Method in class BlkReader: Gets the blocks from the current blk file.

C

BaseCollection::count() — Method in class BaseCollection: Count the number of items.
BaseCollection::current() — Method in class BaseCollection: Get the current element.
Stream::close() — Method in class Stream: Closes the stream.

D

BlockParser::difficulty() — Method in class BlockParser: Get the block difficulty.
LockTime::date() — Method in class LockTime: Get the locked until date.
Money::div() — Method in class Money: Divide the current value with $num.
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

Input::fromArray() — Method in class Input: Create an instance of Input class from a simple array
Money::format() — Method in class Money: Format the value in {@param $unit}
Output::fromArray() — Method in class Output: Create an instance of Output class from a simple array
BlkReader::fileName() — Method in class BlkReader: Gets the file name of the file that we are currently reading from.
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::fromHex() — Method in class TxParser: Reads the transaction data from a hexadecimal string
TxParser::fromStream() — Method in class TxParser: Reads the transaction data from the stream.

G

BaseCollection::get() — Method in class BaseCollection: Get an item by {@param $key}.
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.
LockTime::height() — Method in class LockTime: Get the locked until height.
$ 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

$ BaseCollection#items — Property in class BaseCollection
BaseCollection::isEmpty() — Method in class BaseCollection: Check if the collection is empty.
Input — Class in namespace Cjpg\Bitcoin\Blk: A input in a transaction
Input::isCoinbase() — Method in class Input: Check if this is a coinbase input.
Inputs — Class in namespace Cjpg\Bitcoin\Blk: The Inputs collection class.
LockTime::isHeightLock() — Method in class LockTime: Check if the lock time depends on block height.
LockTime::isTimeLock() — Method in class LockTime: Check if the lock time depends on timestamp.
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.

J

BaseCollection::jsonSerialize() — Method in class BaseCollection
Input::jsonSerialize() — Method in class Input: JsonSerializable implementation.
Inputs::jsonSerialize() — Method in class Inputs
LockTime::jsonSerialize() — Method in class LockTime: JsonSerializable implementation.
Money::jsonSerialize() — Method in class Money: JsonSerializable implementation.
Output::jsonSerialize() — Method in class Output: JsonSerializable implementation.
Outputs::jsonSerialize() — Method in class Outputs
Reader::jsonSerialize() — Method in class Reader

K

$ BaseCollection#keys — Property in class BaseCollection: The keys in this collection.
BaseCollection::key() — Method in class BaseCollection: Get the key of the current element.

L

LockTime — Class in namespace Cjpg\Bitcoin\Blk: Transaction LockTime.
BlkReader::loadData() — Method in class BlkReader: Loads the available blk files.
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.
Money — Class in namespace Cjpg\Bitcoin\Blk: class Money
Money::mul() — Method in class Money: Multiply the current value with $num.
$ BlkReader#magicBytes — Property in class BlkReader: The magic bytes that indicate a block start.
Reader::moveTo() — Method in class Reader: Move to {@param $offset}.

N

BaseCollection::next() — Method in class BaseCollection: Move forward to next element.
BlockParser::nonce() — Method in class BlockParser: Get the block nonce.
$ Output#n — Property in class Output: The output index.

O

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

P

$ BaseCollection#position — Property in class BaseCollection: The current position of the iterator.
BlockParser::previousBlock() — Method in class BlockParser: Gets the previous block hash.

R

BaseCollection::rewind() — Method in class BaseCollection: Rewind the iterator to the first element.
Reader — Class in namespace Cjpg\Bitcoin\Blk\Readers: Base of the reader classes.
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.
$ Input#scriptSig — Property in class Input: The input script signature.
$ Input#sequence — Property in class Input: The input sequence.
Money::sub() — Method in class Money: Subtract $value from the current.
$ Output#scriptPubKey — Property in class Output: The script pub key.
BlkReader::setMagicBytes() — Method in class BlkReader: Set the magic bytes that indicates a block start.
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.
$ Input#type — Property in class Input: The input type Coinbase or Script.
$ Input#txid — Property in class Input: The transactions id of the spending transaction.
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

BaseCollection::valid() — Method in class BaseCollection: Checks if current iterator position is valid.
BlockParser::version() — Method in class BlockParser: Gets the block version.
BlockParser::versionHex() — Method in class BlockParser: Gets the block version as hexadecimal.
$ Input#vout — Property in class Input: The output index of the spending transaction.
$ LockTime#value — Property in class LockTime: The lock time value
$ Output#value — Property in class Output: The monetary value of this output.
$ 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.
Utilities::varIntEncode() — Method in class Utilities: Encode an int to a hexadecimal variable int.

W

BlockParser::weight() — Method in class BlockParser: The block weight.
BlockParser::writeToFile() — Method in class BlockParser: Write the binary block to a file.
$ Input#witness — Property in class Input: The input witnesses if any.
Stream::write() — Method in class Stream: Write data to the stream.
$ TxParser#weight — Property in class TxParser: The transaction weight

_

BaseCollection::__construct() — Method in class BaseCollection
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.
Input::__construct() — Method in class Input
Inputs::__construct() — Method in class Inputs
LockTime::__construct() — Method in class LockTime: Creates a new LockTime object.
LockTime::__toString() — Method in class LockTime
Money::__construct() — Method in class Money: Creates e new Money object from {@param $value} and {@param $unit}
Money::__toString() — Method in class Money: Gets the value as a string.
Output::__construct() — Method in class Output: Creates the new output class object.
Outputs::__construct() — Method in class Outputs
BlkReader::__construct() — Method in class BlkReader: Initialize a new instance of the bitcoin blk reader class.
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