BlkReader
class BlkReader extends Reader (View source)
BLK File reader class.
Properties
| protected | $items | from BaseCollection | |
| protected TKey> | $keys | The keys in this collection. |
from BaseCollection |
| protected int | $position | The current position of the iterator. |
from BaseCollection |
| protected callable|null | $offsetGetFormatter | A custom function to format the items in the list. |
from Reader |
| protected string | $blkFolder | The full path to the folder that contains the bitcoin blk files. |
|
| protected string | $magicBytes | The magic bytes that indicate a block start. |
Methods
Initialize a new instance of the bitcoin blk reader class.
Set the magic bytes that indicates a block start.
Gets the file name of the file that we are currently reading from.
Details
__construct(string $blkFolder, bool $loadFiles = false)
Initialize a new instance of the bitcoin blk reader class.
If the intention is to read all or most of the blk files set $loadFiles to true.
in
Reader at line 91
mixed
jsonSerialize()
No description
all()
No description
BaseCollection
add(TValue $item, TKey $key = null)
Add an item.
TValue|null
get(TKey $key)
Get an item by {@param $key}.
bool
isEmpty()
Check if the collection is empty.
int
count()
Count the number of items.
bool
offsetExists(TKey $key)
Check if an offset($key) exists.
in
Reader at line 69
mixed
offsetGet(TKey $key)
Get the item at offset($key).
void
offsetSet(TKey|null $key, TValue $value)
Set/Add an item.
void
offsetUnset(TKey $key)
Unset an item from the list.
TValue
current()
Get the current element.
TKey
key()
Get the key of the current element.
void
next()
Move forward to next element.
void
rewind()
Rewind the iterator to the first element.
bool
valid()
Checks if current iterator position is valid.
Reader
loadData()
Loads the available blk files.
in
Reader at line 57
Reader
setOffsetGetFormatter(callable $callable)
Set the item output formatter.
$filesPath = "/home/nisse/storeage";
$readerObj = new CustomReader();
$readerObj->setOffsetGetFormatter(function($item) use ($filesPath){
return $filesPath.DIRECTORY_SEPARATOR.$item;
});
$readerObj->offsetSet(0, 'file0.txt');
$file0 = $readerObj->current();
// echo $file0; // == /home/nisse/storeage/file0.txt
in
Reader at line 85
Reader
moveTo(int $offset)
Move to {@param $offset}.
Generator
blocks()
Gets the blocks from the current blk file.
use Cjpg\Bitcoin\Blk\Readers\BlkReader;
$blkReader = new BlkReader('/raid10/bitcoin/blocks', true);
foreach($blkReader as $reader) {
// $reader instance of BlkReader
foreach($blkFile->blocks() as $idx => $block) {
// $idx is the block number in the blk file.
// INDEX STARTS FROM 0!
// The first blk file 00000.dat contains 119995 blocks.
// $block is an instance of \Cjpg\Bitcoin\Blk\BlockParser
$block;
}
}
void
setMagicBytes(string $magicBytes)
Set the magic bytes that indicates a block start.
Note that this must be bytes not a hexadecimal string!
eg. for main net (default) "\xf9\xbe\xb4\xd9".
Known magic values:
| Network | Magic value | setMagicBytes(...) |
|---|---|---|
| main | 0xD9B4BEF9 | "\xf9\xbe\xb4\xd9" |
| testnet/regtest | 0xDAB5BFFA | "\xFA\xBF\xB5\xDA" |
| testnet3 | 0x0709110B | "\x0B\x11\x09\x07" |
| signet | 0x40CF030A | "\x0A\x03\xCF\x40" |
string|null
fileName()
Gets the file name of the file that we are currently reading from.