lowercase chainstate

Author: andkom

README.md

@@ -43,10 +43,10 @@ foreach ($blockchainReader->getChainState()->read() as $utxo) {
 $block = $blockchainReader->getBlockByHash('binary hash in little endian'); 
 
 // get block by height
-$block = $blockchainReader->getBlockByHash(12345);
+$block = $blockchainReader->getBlockByHeight(12345);
 
 // get best block hash
-$hash = $blockchainReader->getChainState()->getBestBlock();
+$hash = $blockchainReader->getChainstate()->getBestBlock();
 ```
 
 See more examples in the examples dir.

examples/read_chainstate.php

@@ -3,9 +3,9 @@
 include '../vendor/autoload.php';
 
 $dataDir = getenv('HOME') . '/Library/Application Support/Bitcoin';
-$chainStateDir = "$dataDir/chainstate";
+$chainstateDir = "$dataDir/chainstate";
 
-$reader = new \AndKom\PhpBitcoinBlockchain\ChainStateReader($chainStateDir);
+$reader = new \AndKom\PhpBitcoinBlockchain\ChainstateReader($chainstateDir);
 
 foreach ($reader->read() as $unspentOutput) {
     echo "TX:       " . \AndKom\PhpBitcoinBlockchain\Utils::hashToHex($unspentOutput->hash) . "\n";

src/BlockchainReader.php

@@ -28,7 +28,7 @@ class BlockchainReader
     /**
      * @var string
      */
-    protected $chainStateDir;
+    protected $chainstateDir;
 
     /**
      * @var Index
@@ -44,7 +44,7 @@ public function __construct(string $dataDir)
         $this->dataDir = $dataDir;
         $this->blocksDir = implode(DIRECTORY_SEPARATOR, [$dataDir, 'blocks']);
         $this->blockIndexDir = implode(DIRECTORY_SEPARATOR, [$dataDir, 'blocks', 'index']);
-        $this->chainStateDir = implode(DIRECTORY_SEPARATOR, [$dataDir, 'chainstate']);
+        $this->chainstateDir = implode(DIRECTORY_SEPARATOR, [$dataDir, 'chainstate']);
     }
 
     /**
@@ -63,11 +63,11 @@ public function getIndex(): Index
     }
 
     /**
-     * @return ChainStateReader
+     * @return ChainstateReader
      */
-    public function getChainState(): ChainStateReader
+    public function getChainstate(): ChainstateReader
     {
-        return new ChainStateReader($this->chainStateDir);
+        return new ChainstateReader($this->chainstateDir);
     }
 
     /**

src/ChainStateReader.php src/ChainstateReader.phpsrc/ChainStateReader.php renamed to src/ChainstateReader.php

@@ -7,10 +7,10 @@
 use AndKom\BCDataStream\Reader;
 
 /**
- * Class ChainStateReader
+ * Class ChainstateReader
  * @package AndKom\PhpBitcoinBlockchain
  */
-class ChainStateReader
+class ChainstateReader
 {
     const PREFIX_COIN = 'C';
     const KEY_BEST_BLOCK = 'B';
@@ -19,7 +19,7 @@ class ChainStateReader
     /**
      * @var string
      */
-    protected $chainStateDir;
+    protected $chainstateDir;
 
     /**
      * @var \LevelDB
@@ -32,12 +32,12 @@ class ChainStateReader
     protected $obfuscateKey;
 
     /**
-     * ChainStateReader constructor.
-     * @param string $chainStateDir
+     * ChainstateReader constructor.
+     * @param string $chainstateDir
      */
-    public function __construct(string $chainStateDir = '')
+    public function __construct(string $chainstateDir = '')
     {
-        $this->chainStateDir = $chainStateDir;
+        $this->chainstateDir = $chainstateDir;
     }
 
     /**
@@ -49,11 +49,11 @@ protected function openDb(): \LevelDB
             return $this->db;
         }
 
-        return $this->db = new \LevelDB($this->chainStateDir);
+        return $this->db = new \LevelDB($this->chainstateDir);
     }
 
     /**
-     * @return ChainStateReader
+     * @return ChainstateReader
      */
     protected function closeDb(): self
     {
@@ -145,7 +145,7 @@ public function read(): \Generator
             throw new Exception('Extension leveldb is not installed.');
         }
 
-        $db = new \LevelDB($this->chainStateDir);
+        $db = new \LevelDB($this->chainstateDir);
 
         foreach ($db->getIterator() as $key => $value) {
             $key = new Reader($key);