BitWasp\Bitcoin\Serializer\Key\HierarchicalKey\ExtendedKeySerializer

Complexity

Total Complexity

11

Size/Duplication

Total Lines	142
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	17

Test Coverage

Coverage

98.25%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	10	1
A	serialize()	0	36	4
A	parse()	0	4	1
A	fromParser()	0	35	5

<?php

declare(strict_types=1);

namespace BitWasp\Bitcoin\Serializer\Key\HierarchicalKey;

use BitWasp\Bitcoin\Crypto\EcAdapter\Adapter\EcAdapterInterface;
use BitWasp\Bitcoin\Key\Deterministic\HdPrefix\GlobalPrefixConfig;
use BitWasp\Bitcoin\Key\Deterministic\HierarchicalKey;
use BitWasp\Bitcoin\Key\KeyToScript\Factory\P2pkhScriptDataFactory;
use BitWasp\Bitcoin\Crypto\EcAdapter\EcSerializer;
use BitWasp\Bitcoin\Crypto\EcAdapter\Serializer\Key\PrivateKeySerializerInterface;
use BitWasp\Bitcoin\Crypto\EcAdapter\Serializer\Key\PublicKeySerializerInterface;
use BitWasp\Bitcoin\Network\NetworkInterface;
use BitWasp\Buffertools\Buffer;
use BitWasp\Buffertools\BufferInterface;
use BitWasp\Buffertools\Exceptions\ParserOutOfRange;
use BitWasp\Buffertools\Parser;

class ExtendedKeySerializer
{
    /**
     * @var EcAdapterInterface
     */
    private $ecAdapter;

    /**
     * @var RawExtendedKeySerializer
     */
    private $rawSerializer;

    /**
     * @var P2pkhScriptDataFactory
     */
    private $defaultScriptFactory;

    /**
     * @var GlobalPrefixConfig
     */
    private $prefixConfig;

    /**
     * @var PrivateKeySerializerInterface
     */
    private $privateKeySerializer;

    /**
     * @var PublicKeySerializerInterface
     */
    private $publicKeySerializer;

    /**
     * @param EcAdapterInterface $ecAdapter
     * @param GlobalPrefixConfig|null $config
     */
    public function __construct(EcAdapterInterface $ecAdapter, GlobalPrefixConfig $config = null)
    {
        $this->privateKeySerializer = EcSerializer::getSerializer(PrivateKeySerializerInterface::class, true, $ecAdapter);
        $this->publicKeySerializer = EcSerializer::getSerializer(PublicKeySerializerInterface::class, true, $ecAdapter);

        $this->ecAdapter = $ecAdapter;
        $this->rawSerializer = new RawExtendedKeySerializer($ecAdapter);
        $this->defaultScriptFactory = new P2pkhScriptDataFactory();
        $this->prefixConfig = $config;
    }

    /**
     * @param NetworkInterface $network
     * @param HierarchicalKey $key
     * @return BufferInterface
     */
    public function serialize(NetworkInterface $network, HierarchicalKey $key): BufferInterface
    {
        if (null === $this->prefixConfig) {
            if ($key->getScriptDataFactory()->getScriptType() !== $this->defaultScriptFactory->getScriptType()) {
                throw new \InvalidArgumentException("Cannot serialize non-P2PKH HierarchicalKeys without a GlobalPrefixConfig");
            }
            $privatePrefix = $network->getHDPrivByte();
            $publicPrefix = $network->getHDPubByte();
        } else {
            $scriptConfig = $this->prefixConfig
                ->getNetworkConfig($network)
                ->getConfigForScriptType($key->getScriptDataFactory()->getScriptType())
            ;
            $privatePrefix = $scriptConfig->getPrivatePrefix();
            $publicPrefix = $scriptConfig->getPublicPrefix();
        }

        if ($key->isPrivate()) {
            $prefix = $privatePrefix;
            $keyData = new Buffer("\x00{$key->getPrivateKey()->getBinary()}");
        } else {
            $prefix = $publicPrefix;
            $keyData = $key->getPublicKey()->getBuffer();
        }

        return $this->rawSerializer->serialize(
            new RawKeyParams(
                $prefix,
                $key->getDepth(),
                $key->getFingerprint(),
                $key->getSequence(),
                $key->getChainCode(),
                $keyData
            )
        );
    }

    /**
     * @param NetworkInterface $network
     * @param Parser $parser
     * @return HierarchicalKey
     * @throws ParserOutOfRange
     */
    public function fromParser(NetworkInterface $network, Parser $parser): HierarchicalKey
    {
        $params = $this->rawSerializer->fromParser($parser);

        if (null === $this->prefixConfig) {
            if (!($params->getPrefix() === $network->getHDPubByte() || $params->getPrefix() === $network->getHDPrivByte())) {
                throw new \InvalidArgumentException('HD key magic bytes do not match network magic bytes');
            }
            $privatePrefix = $network->getHDPrivByte();
            $scriptFactory = $this->defaultScriptFactory;
        } else {
            $scriptConfig = $this->prefixConfig
                ->getNetworkConfig($network)
                ->getConfigForPrefix($params->getPrefix())
            ;
            $privatePrefix = $scriptConfig->getPrivatePrefix();
            $scriptFactory = $scriptConfig->getScriptDataFactory();
        }

        if ($params->getPrefix() === $privatePrefix) {
            $key = $this->privateKeySerializer->parse($params->getKeyData()->slice(1), true);
        } else {
            $key = $this->publicKeySerializer->parse($params->getKeyData());
        }

        return new HierarchicalKey(
            $this->ecAdapter,
            $scriptFactory,
            $params->getDepth(),
            $params->getParentFingerprint(),
            $params->getSequence(),
            $params->getChainCode(),
            $key
        );
    }

    /**
     * @param NetworkInterface $network
     * @param BufferInterface $buffer
     * @return HierarchicalKey
     * @throws ParserOutOfRange
     */
    public function parse(NetworkInterface $network, BufferInterface $buffer): HierarchicalKey
    {
        return $this->fromParser($network, new Parser($buffer));
    }
}