ScriptCreator::getScript() - Code Metrics - Inspection of "add supporters section" - Bit-Wasp/bitcoin-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 3be9f6...d78503 )

by thomas

created 2019-01-12 22:54 UTC

ScriptCreator::getScript() A

↳ Parent: ScriptCreator

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\Script\Factory;

use BitWasp\Bitcoin\Math\Math;
use BitWasp\Bitcoin\Script\Interpreter\Number;
use BitWasp\Bitcoin\Script\Opcodes;
use BitWasp\Bitcoin\Script\Script;
use BitWasp\Bitcoin\Script\ScriptInterface;
use BitWasp\Buffertools\Buffer;
use BitWasp\Buffertools\BufferInterface;

class ScriptCreator
{
    /**
     * @var string
     */
    private $script = '';

    /**
     * @var Opcodes
     */
    private $opcodes;

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

    /**
     * @param Math $math
     * @param Opcodes $opcodes
     * @param BufferInterface|null $buffer
     */
    public function __construct(Math $math, Opcodes $opcodes, BufferInterface $buffer = null)
    {
        if ($buffer !== null) {
            $this->script = $buffer->getBinary();
        }

        $this->math = $math;
        $this->opcodes = $opcodes;
    }

    /**
     * Add a data-push instruction to the script,
     * pushing x bytes of $data from $data, with
     * the appropriate marker for the different
     * PUSHDATA opcodes.
     *
     * @param BufferInterface $data
     * @return $this
     */
    public function push(BufferInterface $data)
    {
        $length = $data->getSize();

        if ($length < Opcodes::OP_PUSHDATA1) {
            $this->script .= pack('C', $length) . $data->getBinary();
        } else {
            if ($length <= 0xff) {
                $lengthSize = 1;
                $code = 'C';
            } elseif ($length <= 0xffff) {
                $lengthSize = 2;
                $code = 'S';
            } else {
                $lengthSize = 4;
                $code = 'V';
            }

            $opCode = constant("BitWasp\\Bitcoin\\Script\\Opcodes::OP_PUSHDATA" . $lengthSize);
            $this->script .= pack('C', $opCode) . pack($code, $length) . $data->getBinary();
        }

        return $this;
    }

    /**
     * Concatenate $script onto $this.
     * @param ScriptInterface $script
     * @return $this
     */
    public function concat(ScriptInterface $script)
    {
        $this->script .= $script->getBinary();
        return $this;
    }

    /**
     * This function accepts an array of elements, builds
     * an intermediate script composed of the items in $sequence,
     * and concatenates it in one step.
     *
     * The allowed types are:
     *  - opcode (integer form)
     *  - script number (Number class)
     *  - data (BufferInterface)
     *  - script (ScriptInterface)
     *
     * @param int[]|\BitWasp\Bitcoin\Script\Interpreter\Number[]|BufferInterface[] $sequence
     * @return $this
     */
    public function sequence(array $sequence)
    {
        $new = new self($this->math, $this->opcodes, null);
        foreach ($sequence as $operation) {
            if (is_int($operation)) {
                if (!$this->opcodes->offsetExists($operation)) {
                    throw new \RuntimeException('Unknown opcode');
                }

                $new->script .= chr($operation);
            } elseif ($operation instanceof Number) {
                $new->push($operation->getBuffer());
            } elseif ($operation instanceof BufferInterface) {
                $new->push($operation);
            } elseif ($operation instanceof ScriptInterface) {
                $new->concat($operation);
            } else {
                throw new \RuntimeException('Value must be an opcode/BufferInterface/Number');
            }
        }

        $this->concat($new->getScript());
        return $this;
    }

    /**
     * This function accepts an integer, and adds the appropriate
     * data-push instruction to the script, minimally encoding it
     * where possible.
     *
     * @param int $n
     * @return $this
     */
    public function int(int $n)
    {
        if ($n === 0) {
            $this->script .= chr(Opcodes::OP_0);
        } else if ($n === -1 || ($n >= 1 && $n <= 16)) {
            $this->script .= chr(\BitWasp\Bitcoin\Script\encodeOpN($n));
        } else {
            $this->push(Number::int($n)->getBuffer());
        }

        return $this;
    }

    /**
     * Takes a list of opcodes (the name as a string)
     * and adds the opcodes to the script.
     *
     * @param string... $opNames

     * @return $this
     */
    public function op(string... $opNames)
    {
        $opCodes = [];
        foreach ($opNames as $opName) {
            $opCodes[] = $this->opcodes->getOpByName($opName);
        }

        return $this->sequence($opCodes);
    }

    /**
     * Takes a list of opcodes (in integer form) and
     * adds them to the script.
     *
     * @param int ...$opcodes
     * @return $this
     */
    public function opcode(int ...$opcodes)
    {
        $this->sequence($opcodes);
        return $this;
    }

    /**
     * Takes a list of data elements and adds the
     * push-data instructions to the script.
     *
     * @param BufferInterface ...$dataList
     * @return $this
     */
    public function data(BufferInterface ...$dataList)
    {
        $this->sequence($dataList);
        return $this;
    }

    /**
     * Generates a script based on the current state.
     * @return ScriptInterface
     */
    public function getScript(): ScriptInterface
    {
        return new Script(new Buffer($this->script), $this->opcodes);
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace BitWasp\Bitcoin\Script\Factory;
6
7		use BitWasp\Bitcoin\Math\Math;
8		use BitWasp\Bitcoin\Script\Interpreter\Number;
9		use BitWasp\Bitcoin\Script\Opcodes;
10		use BitWasp\Bitcoin\Script\Script;
11		use BitWasp\Bitcoin\Script\ScriptInterface;
12		use BitWasp\Buffertools\Buffer;
13		use BitWasp\Buffertools\BufferInterface;
14
15		class ScriptCreator
16		{
17		/**
18		* @var string
19		*/
20		private $script = '';
21
22		/**
23		* @var Opcodes
24		*/
25		private $opcodes;
26
27		/**
28		* @var Math
29		*/
30		private $math;
31
32		/**
33		* @param Math $math
34		* @param Opcodes $opcodes
35		* @param BufferInterface\|null $buffer
36		*/
37	5382	public function __construct(Math $math, Opcodes $opcodes, BufferInterface $buffer = null)
38		{
39	5382	if ($buffer !== null) {
40	23	$this->script = $buffer->getBinary();
41		}
42
43	5382	$this->math = $math;
44	5382	$this->opcodes = $opcodes;
45	5382	}
46
47		/**
48		* Add a data-push instruction to the script,
49		* pushing x bytes of $data from $data, with
50		* the appropriate marker for the different
51		* PUSHDATA opcodes.
52		*
53		* @param BufferInterface $data
54		* @return $this
55		*/
56	398	public function push(BufferInterface $data)
57		{
58	398	$length = $data->getSize();
59
60	398	if ($length < Opcodes::OP_PUSHDATA1) {
61	395	$this->script .= pack('C', $length) . $data->getBinary();
62		} else {
63	11	if ($length <= 0xff) {
64	9	$lengthSize = 1;
65	9	$code = 'C';
66	2	} elseif ($length <= 0xffff) {
67	1	$lengthSize = 2;
68	1	$code = 'S';
69		} else {
70	1	$lengthSize = 4;
71	1	$code = 'V';
72		}
73
74	11	$opCode = constant("BitWasp\\Bitcoin\\Script\\Opcodes::OP_PUSHDATA" . $lengthSize);
75	11	$this->script .= pack('C', $opCode) . pack($code, $length) . $data->getBinary();
76		}
77
78	398	return $this;
79		}
80
81		/**
82		* Concatenate $script onto $this.
83		* @param ScriptInterface $script
84		* @return $this
85		*/
86	5365	public function concat(ScriptInterface $script)
87		{
88	5365	$this->script .= $script->getBinary();
89	5365	return $this;
90		}
91
92		/**
93		* This function accepts an array of elements, builds
94		* an intermediate script composed of the items in $sequence,
95		* and concatenates it in one step.
96		*
97		* The allowed types are:
98		* - opcode (integer form)
99		* - script number (Number class)
100		* - data (BufferInterface)
101		* - script (ScriptInterface)
102		*
103		* @param int[]\|\BitWasp\Bitcoin\Script\Interpreter\Number[]\|BufferInterface[] $sequence
104		* @return $this
105		*/
106	5365	public function sequence(array $sequence)
107		{
108	5365	$new = new self($this->math, $this->opcodes, null);
109	5365	foreach ($sequence as $operation) {
110	5364	if (is_int($operation)) {
111	5342	if (!$this->opcodes->offsetExists($operation)) {
112		throw new \RuntimeException('Unknown opcode');
113		}
114
115	5342	$new->script .= chr($operation);
116	377	} elseif ($operation instanceof Number) {
117		$new->push($operation->getBuffer());
118	377	} elseif ($operation instanceof BufferInterface) {
119	377	$new->push($operation);
120		} elseif ($operation instanceof ScriptInterface) {
121		$new->concat($operation);
122		} else {
123		throw new \RuntimeException('Value must be an opcode/BufferInterface/Number');
124		}
125		}
126
127	5365	$this->concat($new->getScript());
128	5365	return $this;
129		}
130
131		/**
132		* This function accepts an integer, and adds the appropriate
133		* data-push instruction to the script, minimally encoding it
134		* where possible.
135		*
136		* @param int $n
137		* @return $this
138		*/
139	42	public function int(int $n)
140		{
141	42	if ($n === 0) {
142		$this->script .= chr(Opcodes::OP_0);
143	42	} else if ($n === -1 \|\| ($n >= 1 && $n <= 16)) {
144	42	$this->script .= chr(\BitWasp\Bitcoin\Script\encodeOpN($n));
145		} else {
146		$this->push(Number::int($n)->getBuffer());
147		}
148
149	42	return $this;
150		}
151
152		/**
153		* Takes a list of opcodes (the name as a string)
154		* and adds the opcodes to the script.
155		*
156		* @param string... $opNames
		0 ignored issues – show Documentation Bug introduced 2018-11-30 23:28 UTC by Report Bug Copy Issue Report The doc comment `string...` at position `0` could not be parsed: Unknown type name 'string...' at position 0 in string.... Loading history...
157		* @return $this
158		*/
159	2	public function op(string... $opNames)
160		{
161	2	$opCodes = [];
162	2	foreach ($opNames as $opName) {
163	2	$opCodes[] = $this->opcodes->getOpByName($opName);
164		}
165
166	1	return $this->sequence($opCodes);
167		}
168
169		/**
170		* Takes a list of opcodes (in integer form) and
171		* adds them to the script.
172		*
173		* @param int ...$opcodes
174		* @return $this
175		*/
176	54	public function opcode(int ...$opcodes)
177		{
178	54	$this->sequence($opcodes);
179	54	return $this;
180		}
181
182		/**
183		* Takes a list of data elements and adds the
184		* push-data instructions to the script.
185		*
186		* @param BufferInterface ...$dataList
187		* @return $this
188		*/
189	3	public function data(BufferInterface ...$dataList)
190		{
191	3	$this->sequence($dataList);
192	3	return $this;
193		}
194
195		/**
196		* Generates a script based on the current state.
197		* @return ScriptInterface
198		*/
199	5381	public function getScript(): ScriptInterface
200		{
201	5381	return new Script(new Buffer($this->script), $this->opcodes);
202		}
203		}
204

Bit-Wasp / bitcoin-php

Push — master ( 3be9f6...d78503 )

ScriptCreator::getScript() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like