mohamedahmed01/simple-merkele

package to generate and verify hashs using merkle tree

v1.0.0beta1 2021-03-20 21:27 UTC

Requires

• php: ^7.1

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.18
• phpunit/phpunit: ^7.0

MIT

• Mohamed Ahmed

• mohamedahmed01
• simple-merkele

README

This is a very simple implemenation of merkle tree in which you can use multiple hashes to create a merkele tree and compress it to a single hash .

Installation

You can install the package via composer:

composer require mohamedahmed01/simple-merkele

Usage

    //include SimpleMereke
    //prepare your array of hashes
    $hashsArray=[
            hash('sha256', 'hello'),
            hash('sha256', 'goodbye'),
            hash('sha256', 'topofthemorning'),
            hash('sha256', 'sionara'),
            hash('sha256', 'areviditche'),
            hash('sha256', 'arregato'),
        ];
    //create new instance of simpleMerkele
    $merkele = new SimpleMerkele();
    //add your hashes to the inventory
    foreach ($hashsArray as $hash) {
        $merkele->addHash($hash);
    }
    //create the top hash
    $merkele->calculateTree(); //9b8dd5dd1f56d5fa17a67c10b8891c57e51f5fd36fe3a2d7e290d605840332d8
    $merkele->resetTree();
        

Methods :

Method	Description
SimpleMerkele($mode,$algo)	Creates new instance with the specified configuration
addHash($hash)	add hash to the internal inventory not that once added cannot be removed
calculateTree()	create the tree and the top node i.e hash
resetTree()	reset the internal memories to be able to add new hashes and create new tree

Configuration :

Flag/Param	Description
SimpleMerkele::ALLOW_ODD_ARRAYS	Allow odd length trees but adjusting the pairing internally
SimpleMerkele::DIS_ALLOW_ODD_ARRAYS	throws an exceptions on odd length tree
$algo	accept standard algo type i.e "md5","sha256" refer to HashValidation class for full list

Testing

composer test

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

License

The MIT License (MIT). Please see License File for more information.