Bit-Wasp / bitcoin-php

src/Mnemonic/Electrum/ElectrumMnemonic.php

<?php

declare(strict_types=1);

namespace BitWasp\Bitcoin\Mnemonic\Electrum;

use BitWasp\Bitcoin\Crypto\EcAdapter\Adapter\EcAdapterInterface;
use BitWasp\Bitcoin\Mnemonic\MnemonicInterface;
use BitWasp\Buffertools\Buffer;
use BitWasp\Buffertools\BufferInterface;

class ElectrumMnemonic implements MnemonicInterface
{
    /**
     * @var EcAdapterInterface
     */
    private $ecAdapter;

    /**
     * @var ElectrumWordListInterface
     */
    private $wordList;

    /**
     * @param EcAdapterInterface $ecAdapter
     * @param ElectrumWordListInterface $wordList
     */
    public function __construct(EcAdapterInterface $ecAdapter, ElectrumWordListInterface $wordList)
    {
        $this->ecAdapter = $ecAdapter;
        $this->wordList = $wordList;
    }

    /**
     * @param BufferInterface $entropy
     * @return string[]
     * @throws \Exception
     */
    public function entropyToWords(BufferInterface $entropy): array
    {
        $math = $this->ecAdapter->getMath();
        $n = gmp_init(count($this->wordList), 10);
        $wordArray = [];

        $chunks = $entropy->getSize() / 4;
        for ($i = 0; $i < $chunks; $i++) {
            $x = $entropy->slice(4*$i, 4)->getGmp();
            $index1 = $math->mod($x, $n);

It seems like $n can also be of type resource; however, parameter $modulus of Mdanter\Ecc\Math\GmpMath::mod() does only seem to accept GMP, maybe add an additional type check?

            $index2 = $math->mod($math->add($math->div($x, $n), $index1), $n);

It seems like $n can also be of type resource; however, parameter $divisor of Mdanter\Ecc\Math\GmpMath::div() does only seem to accept GMP, maybe add an additional type check?

            $index3 = $math->mod($math->add($math->div($math->div($x, $n), $n), $index2), $n);

            $wordArray[] = $this->wordList->getWord((int) gmp_strval($index1, 10));
            $wordArray[] = $this->wordList->getWord((int) gmp_strval($index2, 10));
            $wordArray[] = $this->wordList->getWord((int) gmp_strval($index3, 10));
        }

        return $wordArray;
    }

    /**
     * @param BufferInterface $entropy
     * @return string
     */
    public function entropyToMnemonic(BufferInterface $entropy): string
    {
        return implode(' ', $this->entropyToWords($entropy));
    }

    /**
     * @param string $mnemonic
     * @return BufferInterface
     */
    public function mnemonicToEntropy(string $mnemonic): BufferInterface
    {
        $math = $this->ecAdapter->getMath();
        $wordList = $this->wordList;
        $words = explode(' ', $mnemonic);
        $n = gmp_init(count($wordList), 10);
        $thirdWordCount = count($words) / 3;
        $out = '';

        for ($i = 0; $i < $thirdWordCount; $i++) {
            list ($index1, $index2, $index3) = array_map(function ($v) use ($wordList) {
                return gmp_init($wordList->getIndex($v), 10);
            }, array_slice($words, 3 * $i, 3));

            $x = $math->add(
                $index1,
                $math->add(
                    $math->mul(
                        $n,

It seems like $n can also be of type resource; however, parameter $multiplier of Mdanter\Ecc\Math\GmpMath::mul() does only seem to accept GMP, maybe add an additional type check?

                        $math->mod($math->sub($index2, $index1), $n)

It seems like $n can also be of type resource; however, parameter $modulus of Mdanter\Ecc\Math\GmpMath::mod() does only seem to accept GMP, maybe add an additional type check?

                    ),
                    $math->mul(
                        $n,
                        $math->mul(
                            $n,
                            $math->mod($math->sub($index3, $index2), $n)
                        )
                    )
                )
            );
            
            $out .= str_pad(gmp_strval($x, 16), 8, '0', STR_PAD_LEFT);
        }

        return Buffer::hex($out);
    }
}