BlkReader
class BlkReader extends Reader (View source)
BLK File reader class.
Properties
| protected mixed | $currentItem | The current item in use by the iterator. |
from Reader |
| protected int | $currentPosition | The current position of the iterator. |
from Reader |
| protected array | $items | The items from which the reader can read. |
from Reader |
| 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
Reader
loadData()
Loads the available blk files.
in
Reader at line 78
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 89
int
count()
Get the number of items in this reader.
in
Reader at line 99
Reader
current()
Get the current element.
int
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.
bool
offsetExists(mixed $key)
Check if an offset($key) exists.
mixed
offsetGet(mixed $key)
Get the item at offset($key).
void
offsetSet(mixed $key, mixed $value)
Set/Add an item.
void
offsetUnset(mixed $key)
Unset an item from the list.
__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.
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
fileName()
Gets the file name of the file that we are currently reading from.