EthereumStatic.php

Go to the documentation of this file.

<?php

namespace Ethereum;

use kornrunner\Keccak;

abstract class EthereumStatic
{
    public static function getMethodSignature($input)
    {

        if (self::isValidFunction($input)) {
            // The signature is 4bytes of the methods keccac hash. E.g: "0x00000000".
            return self::ensureHexPrefix(substr(self::sha3($input), 0, 10));
        }
        else {
            throw new \InvalidArgumentException("No valid (solidity) signature string provided.");
        }
    }

    public static function phpKeccak256($string)
    {
        return self::ensureHexPrefix(Keccak::hash($string, 256));
    }

    public static function sha3($string)
    {
        return self::phpKeccak256($string);
    }

    public static function isValidFunction($input)
    {
        // Check for function and Params.
        // See: https://regex101.com/r/437FZz/4
        $regex = '/^[a-zA-Z]+[a-zA-Z0-9]*[\(]{1}(([\w\d\[\]*){1}(\,[\w\d\[\]]*[\w\d\[\]]*)*)[\)]{1}$/';
        if (is_string($input) && preg_match($regex, $input) === 1) {
            return true;
        }

        return false;
    }

    public static function getDefinition()
    {
        $schema_path = __DIR__ . '/../resources/ethjs-schema.json';
        return json_decode(file_get_contents($schema_path), true);
    }

    public static function isValidHexQuantity($str)
    {

        // Always ensure 0x prefix.
        if (!EthereumStatic::hasHexPrefix($str)) {
            return false;
        }

        // Should always have at least one digit - zero is "0x0".
        if (strlen($str) < 3) {
            return false;
        }

        return ctype_xdigit(self::removeHexPrefix($str));
    }

    public static function isValidHexData($str)
    {

        // Always ensure 0x prefix.
        if (!EthereumStatic::hasHexPrefix($str)) {
            return false;
        }
        // Should always have at least one digit - zero is "0x0".
        if (strlen($str) <= 3) {
            return false;
        }

        // Ensure two hex digits per byte.
        if ((strlen($str) % 2 != 0)) {
            return false;
        }

        return ctype_xdigit(self::removeHexPrefix($str));
    }

    public static function isValidAddress($address, $throw = false)
    {

        if (!self::hasHexPrefix($address)) {
            return false;
        }
        // Address should be 20bytes=40 HEX-chars + prefix.
        if (strlen($address) !== 42) {
            return false;
        }
        $return = ctype_xdigit(self::removeHexPrefix($address));
        return $return;
    }

    public static function hasHexPrefix($str)
    {
        return substr($str, 0, 2) === '0x';
    }

    public static function removeHexPrefix($str)
    {
        if (!self::hasHexPrefix($str)) {
            return $str;
        }

        return substr($str, 2);
    }

    public static function ensureHexPrefix($str)
    {
        if (self::hasHexPrefix($str)) {
            return $str;
        }
        return '0x' . $str;
    }

    public static function convertCurrency(float $amount, string $from = 'wei', string $to = 'ether') {

        // relative to Ether
        $convertTabe = [
            'wei' => 1000000000000000000,
            // Kwei, Ada, Femtoether
            'kwei' => 1000000000000000,
            // Mwei, Babbage, Picoether
            'mwei' => 1000000000000,
            // Gwei, Shannon, Nanoether, Nano
            'gwei' => 1000000000,
            // Szabo, Microether,Micro
            'gwei' => 1000000,
            // Finney, Milliether,Milli
            'methere' => 1000,
            'ether' => 1,
            // Kether, Grand,Einstein
            'kether' => 0.001,
            // Kether, Grand,Einstein
            'mether' => 0.000001,
            'gether' => 0.000000001,
            'thether' => 0.000000000001,
        ];
        if (!isset($convertTabe[$from])) {
            throw new \Exception('Inknown currency to convert from "' . $from . '"');
        }
        if (!isset($convertTabe[$to])) {
            throw new \Exception('Inknown currency to convert to "' . $to . '"');
        }
        return $convertTabe[$to] * $amount / $convertTabe[$from];
    }
}