Bit-Wasp / bitcoin-php

src/Block/MerkleRoot.php

<?php

declare(strict_types=1);

namespace BitWasp\Bitcoin\Block;

use BitWasp\Bitcoin\Exceptions\MerkleTreeEmpty;
use BitWasp\Bitcoin\Math\Math;
use BitWasp\Bitcoin\Transaction\TransactionInterface;
use BitWasp\Buffertools\Buffer;
use BitWasp\Buffertools\BufferInterface;
use Pleo\Merkle\FixedSizeTree;

class MerkleRoot
{
    /**
     * @var TransactionInterface[]
     */
    private $transactions;

    /**
     * @var Math
     */
    private $math;

    /**
     * @var BufferInterface
     */
    private $lastHash;

    /**
     * Instantiate the class when given a block
     *
     * @param Math $math
     * @param TransactionInterface[] $txCollection
     */
    public function __construct(Math $math, array $txCollection)
    {
        $this->math = $math;
        $this->transactions = $txCollection;
    }

    /**
     * @param callable|null $hashFunction
     * @return BufferInterface
     * @throws MerkleTreeEmpty
     */
    public function calculateHash(callable $hashFunction = null): BufferInterface
    {
        if ($this->lastHash instanceof BufferInterface) {

$this->lastHash is always a sub-type of BitWasp\Buffertools\BufferInterface.

            return $this->lastHash;
        }

        $hashFxn = $hashFunction ?: function ($value) {
            return hash('sha256', hash('sha256', $value, true), true);
        };

        $txCount = count($this->transactions);
        if ($txCount === 0) {
            // TODO: Probably necessary. Should always have a coinbase at least.
            throw new MerkleTreeEmpty('Cannot compute Merkle root of an empty tree');
        }

        if ($txCount === 1) {
            $binary = $hashFxn($this->transactions[0]->getBinary());
        } else {
            // Create a fixed size Merkle Tree
            $tree = new FixedSizeTree($txCount + ($txCount % 2), $hashFxn);

            // Compute hash of each transaction
            $last = '';
            foreach ($this->transactions as $i => $transaction) {
                $last = $transaction->getBinary();
                $tree->set($i, $last);
            }

            // Check if we need to repeat the last hash (odd number of transactions)
            if (!($txCount % 2 === 0)) {
                $tree->set($txCount, $last);
            }

            $binary = $tree->hash();
        }

        $this->lastHash = (new Buffer($binary))->flip();
        return $this->lastHash;
    }
}