PSBT::getUnknowns() - Code Metrics - Inspection of "[WIP] PSBT format" - Bit-Wasp/bitcoin-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#759)

by thomas

created 2018-12-16 21:25 UTC

PSBT::getUnknowns() A

↳ Parent: PSBT

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
ccs	2
cts	2
cp	1
crap	1
rs	10
c	0
b	0
f	0

<?php

declare(strict_types=1);

namespace BitWasp\Bitcoin\Transaction\PSBT;

use BitWasp\Bitcoin\Exceptions\InvalidPSBTException;
use BitWasp\Bitcoin\Serializer\Types;
use BitWasp\Bitcoin\Transaction\TransactionFactory;
use BitWasp\Bitcoin\Transaction\TransactionInterface;
use BitWasp\Buffertools\Buffer;
use BitWasp\Buffertools\BufferInterface;
use BitWasp\Buffertools\Parser;

class PSBT
{
    const PSBT_GLOBAL_UNSIGNED_TX = 0;

    /**
     * @var TransactionInterface
     */
    private $tx;

    /**
     * Remaining PSBTGlobals key/value pairs we
     * didn't know how to parse. map[string]BufferInterface
     * @var BufferInterface[]
     */
    private $unknown = [];

    /**
     * @var PSBTInput[]
     */
    private $inputs;

    /**
     * @var PSBTOutput[]
     */
    private $outputs;

    /**
     * PSBT constructor.
     * @param TransactionInterface $tx
     * @param BufferInterface[] $unknowns
     * @param PSBTInput[] $inputs
     * @param PSBTOutput[] $outputs
     * @throws InvalidPSBTException
     */
    public function __construct(TransactionInterface $tx, array $unknowns, array $inputs, array $outputs)
    {
        if (count($tx->getInputs()) !== count($inputs)) {
            throw new InvalidPSBTException("Invalid number of inputs");
        }
        if (count($tx->getOutputs()) !== count($outputs)) {
            throw new InvalidPSBTException("Invalid number of outputs");
        }
        $numInputs = count($tx->getInputs());
        $witnesses = $tx->getWitnesses();
        for ($i = 0; $i < $numInputs; $i++) {
            $input = $tx->getInput($i);
            if ($input->getScript()->getBuffer()->getSize() > 0 || (array_key_exists($i, $witnesses) && count($witnesses[$i]) > 0)) {
                throw new InvalidPSBTException("Unsigned tx does not have empty script sig or witness");
            }
        }
        foreach ($unknowns as $key => $unknown) {
            if (!is_string($key) || !($unknown instanceof BufferInterface)) {
                throw new \InvalidArgumentException("Unknowns must be a map of string keys to Buffer values");
            }
        }
        $this->tx = $tx;
        $this->unknown = $unknowns;
        $this->inputs = $inputs;
        $this->outputs = $outputs;
    }

    /**
     * @param BufferInterface $in
     * @return PSBT
     * @throws InvalidPSBTException
     */
    public static function fromBuffer(BufferInterface $in): PSBT
    {
        $byteString5 = Types::bytestring(5);
        $vs = Types::varstring();
        $parser = new Parser($in);

        try {
            $prefix = $byteString5->read($parser);
            if ($prefix->getBinary() !== "psbt\xff") {
                throw new InvalidPSBTException("Incorrect bytes");
            }
        } catch (\Exception $e) {
            throw new InvalidPSBTException("Invalid PSBT magic", 0, $e);
        }

        $tx = null;
        $unknown = [];
        try {
            do {
                $key = $vs->read($parser);
                if ($key->getSize() === 0) {
                    break;
                }
                $value = $vs->read($parser);
                $dataType = ord(substr($key->getBinary(), 0, 1));
                switch ($dataType) {
                    case self::PSBT_GLOBAL_UNSIGNED_TX:
                        if ($tx !== null) {
                            throw new \RuntimeException("Duplicate global tx");
                        } else if ($key->getSize() !== 1) {
                            throw new \RuntimeException("Invalid key length");
                        }
                        $tx = TransactionFactory::fromBuffer($value);
                        break;
                    default:
                        if (array_key_exists($key->getBinary(), $unknown)) {
                            throw new InvalidPSBTException("Duplicate unknown key");
                        }
                        $unknown[$key->getBinary()] = $value;
                        break;
                }
            } while ($parser->getPosition() < $parser->getSize());
        } catch (\Exception $e) {
            throw new InvalidPSBTException("Failed to parse global section", 0, $e);
        }

        if (!$tx) {
            throw new InvalidPSBTException("Missing global tx");
        }

        $numInputs = count($tx->getInputs());
        $inputs = [];
        for ($i = 0; $parser->getPosition() < $parser->getSize() && $i < $numInputs; $i++) {
            try {
                $input = PSBTInput::fromParser($parser, $vs);
                $inputs[] = $input;
            } catch (\Exception $e) {
                throw new InvalidPSBTException("Failed to parse inputs section", 0, $e);
            }
        }
        if ($numInputs !== count($inputs)) {
            throw new InvalidPSBTException("Missing inputs");
        }

        $numOutputs = count($tx->getOutputs());
        $outputs = [];
        for ($i = 0; $parser->getPosition() < $parser->getSize() && $i < $numOutputs; $i++) {
            try {
                $output = PSBTOutput::fromParser($parser, $vs);
                $outputs[] = $output;
            } catch (\Exception $e) {
                throw new InvalidPSBTException("Failed to parse outputs section", 0, $e);
            }
        }

        if ($numOutputs !== count($outputs)) {
            throw new InvalidPSBTException("Missing outputs");
        }

        return new PSBT($tx, $unknown, $inputs, $outputs);
    }

    /**
     * @return TransactionInterface
     */
    public function getTransaction(): TransactionInterface
    {
        return $this->tx;
    }
    /**
     * @return string[]
     */
    public function getUnknowns(): array
    {
        return $this->unknown;

    }

    /**
     * @return PSBTInput[]
     */
    public function getInputs(): array
    {
        return $this->inputs;
    }

    /**
     * @return PSBTOutput[]
     */
    public function getOutputs(): array
    {
        return $this->outputs;
    }

    public function updateInput(int $input, \Closure $modifyPsbtIn)
    {
        if (!array_key_exists($input, $this->inputs)) {
            throw new \RuntimeException("No input at this index");
        }

        $updatable = new UpdatableInput($this, $input, $this->inputs[$input]);
        $modifyPsbtIn($updatable);
        $this->inputs[$input] = $updatable->input();
    }

    /**
     * @return BufferInterface
     */
    public function getBuffer(): BufferInterface
    {
        $vs = Types::varstring();
        $parser = new Parser();
        $parser->appendBinary("psbt\xff");
        $parser->appendBinary($vs->write(new Buffer(chr(self::PSBT_GLOBAL_UNSIGNED_TX))));
        $parser->appendBinary($vs->write($this->tx->getBuffer()));
        foreach ($this->unknown as $key => $value) {
            $parser->appendBinary($vs->write(new Buffer($key)));
            $parser->appendBinary($vs->write($value));
        }
        $parser->appendBinary($vs->write(new Buffer()));

        $numInputs = count($this->tx->getInputs());
        for ($i = 0; $i < $numInputs; $i++) {
            $this->inputs[$i]->writeToParser($parser, $vs);
        }
        $numOutputs = count($this->tx->getOutputs());
        for ($i = 0; $i < $numOutputs; $i++) {
            $this->outputs[$i]->writeToParser($parser, $vs);
        }
        return $parser->getBuffer();
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace BitWasp\Bitcoin\Transaction\PSBT;
6
7		use BitWasp\Bitcoin\Exceptions\InvalidPSBTException;
8		use BitWasp\Bitcoin\Serializer\Types;
9		use BitWasp\Bitcoin\Transaction\TransactionFactory;
10		use BitWasp\Bitcoin\Transaction\TransactionInterface;
11		use BitWasp\Buffertools\Buffer;
12		use BitWasp\Buffertools\BufferInterface;
13		use BitWasp\Buffertools\Parser;
14
15		class PSBT
16		{
17		const PSBT_GLOBAL_UNSIGNED_TX = 0;
18
19		/**
20		* @var TransactionInterface
21		*/
22		private $tx;
23
24		/**
25		* Remaining PSBTGlobals key/value pairs we
26		* didn't know how to parse. map[string]BufferInterface
27		* @var BufferInterface[]
28		*/
29		private $unknown = [];
30
31		/**
32		* @var PSBTInput[]
33		*/
34		private $inputs;
35
36		/**
37		* @var PSBTOutput[]
38		*/
39		private $outputs;
40
41		/**
42		* PSBT constructor.
43		* @param TransactionInterface $tx
44		* @param BufferInterface[] $unknowns
45		* @param PSBTInput[] $inputs
46		* @param PSBTOutput[] $outputs
47		* @throws InvalidPSBTException
48		*/
49	26	public function __construct(TransactionInterface $tx, array $unknowns, array $inputs, array $outputs)
50		{
51	26	if (count($tx->getInputs()) !== count($inputs)) {
52	2	throw new InvalidPSBTException("Invalid number of inputs");
53		}
54	24	if (count($tx->getOutputs()) !== count($outputs)) {
55	2	throw new InvalidPSBTException("Invalid number of outputs");
56		}
57	22	$numInputs = count($tx->getInputs());
58	22	$witnesses = $tx->getWitnesses();
59	22	for ($i = 0; $i < $numInputs; $i++) {
60	22	$input = $tx->getInput($i);
61	22	if ($input->getScript()->getBuffer()->getSize() > 0 \|\| (array_key_exists($i, $witnesses) && count($witnesses[$i]) > 0)) {
62	1	throw new InvalidPSBTException("Unsigned tx does not have empty script sig or witness");
63		}
64		}
65	21	foreach ($unknowns as $key => $unknown) {
66	2	if (!is_string($key) \|\| !($unknown instanceof BufferInterface)) {
67	2	throw new \InvalidArgumentException("Unknowns must be a map of string keys to Buffer values");
68		}
69		}
70	20	$this->tx = $tx;
71	20	$this->unknown = $unknowns;
72	20	$this->inputs = $inputs;
73	20	$this->outputs = $outputs;
74	20	}
75
76		/**
77		* @param BufferInterface $in
78		* @return PSBT
79		* @throws InvalidPSBTException
80		*/
81	28	public static function fromBuffer(BufferInterface $in): PSBT
82		{
83	28	$byteString5 = Types::bytestring(5);
84	28	$vs = Types::varstring();
85	28	$parser = new Parser($in);
86
87		try {
88	28	$prefix = $byteString5->read($parser);
89	28	if ($prefix->getBinary() !== "psbt\xff") {
90	28	throw new InvalidPSBTException("Incorrect bytes");
91		}
92	1	} catch (\Exception $e) {
93	1	throw new InvalidPSBTException("Invalid PSBT magic", 0, $e);
94		}
95
96	27	$tx = null;
97	27	$unknown = [];
98		try {
99		do {
100	27	$key = $vs->read($parser);
101	27	if ($key->getSize() === 0) {
102	24	break;
103		}
104	26	$value = $vs->read($parser);
105	26	$dataType = ord(substr($key->getBinary(), 0, 1));
106		switch ($dataType) {
107	26	case self::PSBT_GLOBAL_UNSIGNED_TX:
108	25	if ($tx !== null) {
109	1	throw new \RuntimeException("Duplicate global tx");
110	25	} else if ($key->getSize() !== 1) {
111	1	throw new \RuntimeException("Invalid key length");
112		}
113	24	$tx = TransactionFactory::fromBuffer($value);
114	24	break;
115		default:
116	2	if (array_key_exists($key->getBinary(), $unknown)) {
117	1	throw new InvalidPSBTException("Duplicate unknown key");
118		}
119	2	$unknown[$key->getBinary()] = $value;
120	2	break;
121		}
122	26	} while ($parser->getPosition() < $parser->getSize());
123	3	} catch (\Exception $e) {
124	3	throw new InvalidPSBTException("Failed to parse global section", 0, $e);
125		}
126
127	24	if (!$tx) {
128	1	throw new InvalidPSBTException("Missing global tx");
129		}
130
131	23	$numInputs = count($tx->getInputs());
132	23	$inputs = [];
133	23	for ($i = 0; $parser->getPosition() < $parser->getSize() && $i < $numInputs; $i++) {
134		try {
135	23	$input = PSBTInput::fromParser($parser, $vs);
136	13	$inputs[] = $input;
137	11	} catch (\Exception $e) {
138	11	throw new InvalidPSBTException("Failed to parse inputs section", 0, $e);
139		}
140		}
141	12	if ($numInputs !== count($inputs)) {
142		throw new InvalidPSBTException("Missing inputs");
143		}
144
145	12	$numOutputs = count($tx->getOutputs());
146	12	$outputs = [];
147	12	for ($i = 0; $parser->getPosition() < $parser->getSize() && $i < $numOutputs; $i++) {
148		try {
149	11	$output = PSBTOutput::fromParser($parser, $vs);
150	8	$outputs[] = $output;
151	3	} catch (\Exception $e) {
152	3	throw new InvalidPSBTException("Failed to parse outputs section", 0, $e);
153		}
154		}
155
156	9	if ($numOutputs !== count($outputs)) {
157	1	throw new InvalidPSBTException("Missing outputs");
158		}
159
160	8	return new PSBT($tx, $unknown, $inputs, $outputs);
161		}
162
163		/**
164		* @return TransactionInterface
165		*/
166	5	public function getTransaction(): TransactionInterface
167		{
168	5	return $this->tx;
169		}
170		/**
171		* @return string[]
172		*/
173	1	public function getUnknowns(): array
174		{
175	1	return $this->unknown;
		0 ignored issues – show Bug Best Practice introduced 2018-12-16 14:44 UTC by Report Bug Copy Issue Report The expression `return $this->unknown` returns the type `BitWasp\Buffertools\BufferInterface[]` which is incompatible with the documented return type `string[]`. Loading history...
176		}
177
178		/**
179		* @return PSBTInput[]
180		*/
181	11	public function getInputs(): array
182		{
183	11	return $this->inputs;
184		}
185
186		/**
187		* @return PSBTOutput[]
188		*/
189	1	public function getOutputs(): array
190		{
191	1	return $this->outputs;
192		}
193
194	3	public function updateInput(int $input, \Closure $modifyPsbtIn)
195		{
196	3	if (!array_key_exists($input, $this->inputs)) {
197	1	throw new \RuntimeException("No input at this index");
198		}
199
200	2	$updatable = new UpdatableInput($this, $input, $this->inputs[$input]);
201	2	$modifyPsbtIn($updatable);
202	2	$this->inputs[$input] = $updatable->input();
203	2	}
204
205		/**
206		* @return BufferInterface
207		*/
208	9	public function getBuffer(): BufferInterface
209		{
210	9	$vs = Types::varstring();
211	9	$parser = new Parser();
212	9	$parser->appendBinary("psbt\xff");
213	9	$parser->appendBinary($vs->write(new Buffer(chr(self::PSBT_GLOBAL_UNSIGNED_TX))));
214	9	$parser->appendBinary($vs->write($this->tx->getBuffer()));
215	9	foreach ($this->unknown as $key => $value) {
216	1	$parser->appendBinary($vs->write(new Buffer($key)));
217	1	$parser->appendBinary($vs->write($value));
218		}
219	9	$parser->appendBinary($vs->write(new Buffer()));
220
221	9	$numInputs = count($this->tx->getInputs());
222	9	for ($i = 0; $i < $numInputs; $i++) {
223	9	$this->inputs[$i]->writeToParser($parser, $vs);
224		}
225	9	$numOutputs = count($this->tx->getOutputs());
226	9	for ($i = 0; $i < $numOutputs; $i++) {
227	9	$this->outputs[$i]->writeToParser($parser, $vs);
228		}
229	9	return $parser->getBuffer();
230		}
231		}
232

Bit-Wasp / bitcoin-php

Pull Request — master (#759)

PSBT::getUnknowns() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like