Blocktrail\SDK\Bitcoin\BIP32Path

Complexity

Total Complexity

37

Size/Duplication

Total Lines	290
Duplicated Lines	17.24 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

25 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	3
A	depth()	0	3	1
A	insert()	0	7	1
A	next()	0	20	3
A	parent()	0	11	2
A	child()	0	7	1
A	last()	0	8	1
A	hardened()	15	15	2
A	unhardenedLast()	11	11	1
A	unhardenedPath()	0	9	2
A	publicPath()	11	11	2
A	privatePath()	11	11	2
A	getPath()	0	3	1
A	getLast()	0	3	1
A	isHardened()	0	7	1
A	isPublicPath()	0	5	1
A	isParentOf()	0	5	2
A	path()	0	7	2
A	getKeyIndex()	0	3	1
A	count()	0	3	1
A	offsetExists()	0	3	1
A	offsetGet()	0	3	2
A	offsetSet()	0	3	1
A	offsetUnset()	0	3	1
A	__toString()	0	3	1

<?php

namespace Blocktrail\SDK\Bitcoin;

/**
 * Class BIP32Path
 *
 * BIP32 path, does not mutate itself but returns new instance everytime
 *
 * @package Blocktrail\SDK
 */
class BIP32Path implements \ArrayAccess {
    protected $path;

    public function __construct($path) {
        $this->path = is_array($path) ? $path : explode("/", $path);

        if (strtolower($this->path[0]) != "m") {
            throw new \InvalidArgumentException("BIP32Path can only be used for absolute paths");
        }
    }

    /**
     * @return int
     */
    public function depth() {
        return count($this->path);
    }

    public function insert($insert, $offset) {
        $path = $this->path;

        array_splice($path, $offset+1, 0, [$insert]);

        return new static($path);
    }

    /**
     * increase the last level of the path by 1 and return the new path
     *
     * @return BIP32Path
     */
    public function next() {
        $path = $this->path;

        $last = array_pop($path);

        if ($hardened = (strpos($last, "'") !== false)) {
            $last = str_replace("'", "", $last);
        }

        $last = (int)$last;
        $last += 1;

        if ($hardened) {
            $last .= "'";
        }

        $path[] = $last;

        return new static($path);
    }

    /**
     * pop off one level of the path and return the new path
     *
     * @return BIP32Path
     */
    public function parent() {
        $path = $this->path;

        array_pop($path);

        if (empty($path)) {
            throw new \RuntimeException("Can't get parent of root path");
        }

        return new static($path);
    }

    /**
     * get child $child of the current path and return the new path
     *
     * @param $child
     * @return BIP32Path
     */
    public function child($child) {
        $path = $this->path;

        $path[] = $child;

        return new static($path);
    }

    /**
     * pop off one level of the path and add $last and return the new path
     *
     * @param $last
     * @return BIP32Path
     */
    public function last($last) {
        $path = $this->path;

        array_pop($path);
        $path[] = $last;

        return new static($path);
    }

    /**
     * harden the last level of the path and return the new path
     *
     * @return BIP32Path
     */
    public function hardened() {

This method seems to be duplicated in your project.

        $path = $this->path;

        $last = array_pop($path);

        if (strpos($last, "'") !== false) {
            return $this;
        }

        $last .= "'";

        $path[] = $last;

        return new static($path);
    }

    /**
     * unharden the last level of the path and return the new path
     *
     * @return BIP32Path
     */
    public function unhardenedLast() {

This method seems to be duplicated in your project.

        $path = $this->path;

        $last = array_pop($path);

        $last = str_replace("'", "", $last);

        $path[] = $last;

        return new static($path);
    }

    /**
     * unharden all levels of the path and return the new path
     *
     * @return BIP32Path
     */
    public function unhardenedPath() {
        $path = $this->path;

        foreach ($path as $i => $level) {
            $path[$i] = str_replace("'", "", $level);
        }

        return new static($path);
    }

    /**
     * change the path to be for the public key (starting with M/) and return the new path
     *
     * @return BIP32Path
     */
    public function publicPath() {

This method seems to be duplicated in your project.

        $path = $this->path;

        if ($path[0] === "M") {
            return new static($path);
        } else {
            $path[0] = "M";

            return new static($path);
        }
    }

    /**
     * change the path to be for the private key (starting with m/) and return the new path
     *
     * @return BIP32Path
     */
    public function privatePath() {

This method seems to be duplicated in your project.

        $path = $this->path;

        if ($path[0] === "m") {
            return new static($path);
        } else {
            $path[0] = "m";

            return new static($path);
        }
    }

    /**
     * get the string representation of the path
     *
     * @return string
     */
    public function getPath() {
        return implode("/", $this->path);
    }

    /**
     * get the last part of the path
     *
     * @return string
     */
    public function getLast() {
        return $this->path[count($this->path)-1];
    }

    /**
     * check if the last level of the path is hardened
     *
     * @return bool
     */
    public function isHardened() {
        $path = $this->path;

        $last = array_pop($path);

        return strpos($last, "'") !== false;
    }

    /**
     * check if the last level of the path is hardened
     *
     * @return bool
     */
    public function isPublicPath() {
        $path = $this->path;

        return $path[0] == "M";
    }

    /**
     * check if this path is parent path of the provided path
     *
     * @param string|BIP32Path $path
     * @return bool
     */
    public function isParentOf($path) {
        $path = BIP32Path::path($path);

        return strlen((string)$path) > strlen((string)$this) && strpos((string)$path, (string)$this) === 0;
    }

    /**
     * static method to initialize class
     *
     * @param $path
     * @return BIP32Path
     */
    public static function path($path) {
        if ($path instanceof static) {
            return $path;
        }

        return new static($path);
    }

    public function getKeyIndex() {
        return str_replace("'", "", $this->path[1]);
    }

    /**
     * count the levels in the path (including master)
     *
     * @return int
     */
    public function count() {
        return count($this->path);
    }


    public function offsetExists($offset) {
        return isset($this->path[$offset]);
    }

    public function offsetGet($offset) {
        return isset($this->path[$offset]) ? $this->path[$offset] : null;
    }

    public function offsetSet($offset, $value) {
        throw new \Exception("Not implemented");
    }

    public function offsetUnset($offset) {
        throw new \Exception("Not implemented");
    }

    /**
     * @return string
     */
    public function __toString() {
        return $this->getPath();
    }
}