BTG

.github/workflows/tests.yml

@@ -0,0 +1,37 @@
+name: Unit Tests
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: shivammathur/setup-php@master
+        with:
+          php-version: '8.2'
+
+      - name: Cache Composer packages
+        id: composer-cache
+        uses: actions/cache@v3
+        with:
+          path: vendor
+          key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-php-
+
+      - name: Install dependencies
+        run: composer install --prefer-dist --no-progress
+
+      - name: Run test suite
+        run: composer test

.gitignore

@@ -1,3 +1,4 @@
 composer.lock
 vendor
-.idea
+.idea
+.phpunit.result.cache

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Merkeleon
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -3,13 +3,19 @@
 Easy to use PHP Bitcoin and Litecoin address validator.
 One day I will add other crypto currencies. Or how about you? :)
 
-## Usage
+## Installation
 
+=======
+```
+composer require merkeleon/php-cryptocurrency-address-validation
+```
+
+## Usage
 
 ```php
-use Murich\PhpCryptocurrencyAddressValidation\Validation\BTC as BTCValidator;
+use Merkeleon\PhpCryptocurrencyAddressValidation\Enums\CurrencyEnum;use Merkeleon\PhpCryptocurrencyAddressValidation\Validator;
 
-$validator = new BTCValidator('1QLbGuc3WGKKKpLs4pBp9H6jiQ2MgPkXRp');
-var_dump($validator->validate());
+$validator = Validator::make(CurrencyEnum::BITCOIN);
+var_dump($validator->isValid('1QLbGuc3WGKKKpLs4pBp9H6jiQ2MgPkXRp'));
 
 ```

composer.json

@@ -1,19 +1,33 @@
 {
-    "name": "murich/php-cryptocurrency-address-validation",
+    "name": "merkeleon/php-cryptocurrency-address-validation",
     "description": "Cryptocurrency address validation. Currently supports litecoin and bitcoin.",
     "authors": [
         {
             "name": "Andrey Murashkin",
             "email": "andrey@phpteam.pro"
         }
     ],
-    "require": {},
+    "require": {
+        "php": "^8.2",
+        "ext-gmp": "*",
+        "ext-bcmath": "*",
+        "laravel/framework": ">=v7.0.0|>=v10.0.0",
+        "spomky-labs/cbor-php": "^3.0"
+    },
+    "scripts": {
+        "test": "@php vendor/bin/phpunit"
+    },
     "require-dev": {
-        "phpunit/phpunit": "4.0.*"
+        "phpunit/phpunit": "~8.0"
     },
     "autoload": {
         "psr-4": {
-            "Murich\\PhpCryptocurrencyAddressValidation\\": "src"
+            "Merkeleon\\PhpCryptocurrencyAddressValidation\\": "src"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Tests\\": "tests/"
         }
     }
 }

config/address_validation.php

@@ -0,0 +1,108 @@
+<?php
+
+declare(strict_types=1);
+
+use Merkeleon\PhpCryptocurrencyAddressValidation\DriverConfig;
+use Merkeleon\PhpCryptocurrencyAddressValidation\Drivers;
+use Merkeleon\PhpCryptocurrencyAddressValidation\Enums\CurrencyEnum;
+
+return [
+    CurrencyEnum::BEACON->value => [
+        new DriverConfig(
+            Drivers\Bech32Driver::class,
+            ['bnb' => null],
+            ['tbnb' => null]
+        ),
+    ],
+    CurrencyEnum::BITCOIN_CASH->value => [
+        new DriverConfig(
+            Drivers\Base32Driver::class,
+            ['bitcoincash:' => null],
+            ['bchtest:' => null, 'bchreg:' => null,]
+        ),
+        new DriverConfig(
+            Drivers\DefaultBase58Driver::class,
+            ['1' => '00', '3' => '05'],
+            ['2' => 'C4', 'm' => '6F']
+        ),
+    ],
+    CurrencyEnum::BITCOIN->value => [
+        new DriverConfig(
+            Drivers\DefaultBase58Driver::class,
+            ['1' => '00', '3' => '05'],
+            ['2' => 'C4', 'm' => '6F']
+        ),
+        new DriverConfig(
+            Drivers\Bech32Driver::class,
+            ['bc' => null],
+            ['tb' => null, 'bcrt' => null]
+        ),
+    ],
+    CurrencyEnum::CARDANO->value => [
+        new DriverConfig(
+            Drivers\CardanoDriver::class,
+            ['addr' => null],
+            ['addr_test' => null],
+        ),
+        new DriverConfig(
+            Drivers\CborDriver::class,
+            ['A' => 33, 'D' => 66],
+            ['2' => 40, '3' => 73],
+        )
+    ],
+    CurrencyEnum::DASHCOIN->value => [
+        new DriverConfig(
+            Drivers\DefaultBase58Driver::class,
+            ['X' => '4C', '7' => '10'],
+            ['y' => '8C', '8' => '13']
+        ),
+    ],
+    CurrencyEnum::DOGECOIN->value => [
+        new DriverConfig(
+            Drivers\DefaultBase58Driver::class,
+            ['D' => '1E', '9' => '16', 'A' => '16'],
+            ['n' => '71', 'm' => '6F', '2' => 'C4',],
+        ),
+    ],
+    CurrencyEnum::EOS->value => [
+        new DriverConfig(Drivers\EosDriver::class),
+    ],
+    CurrencyEnum::ETHEREUM->value => [
+        new DriverConfig(Drivers\KeccakStrictDriver::class),
+    ],
+    CurrencyEnum::LITECOIN->value => [
+        new DriverConfig(
+            Drivers\DefaultBase58Driver::class,
+            ['L' => '30', 'M' => '32', '3' => '05'],
+            ['m' => '6F', 'n' => '6F', '2' => 'C4', 'Q' => '3A']
+        ),
+        new DriverConfig(
+            Drivers\Bech32Driver::class,
+            ['ltc' => null],
+            ['tltc' => null, 'rltc' => null]
+        )
+    ],
+    CurrencyEnum::RIPPLE->value => [
+        new DriverConfig(
+            Drivers\XrpBase58Driver::class,
+            ['r' => '00']
+        ),
+        new DriverConfig(
+            Drivers\XrpXAddressDriver::class,
+            ['X' => null],
+            ['T' => null],
+        ),
+    ],
+    CurrencyEnum::TRON->value => [
+        new DriverConfig(
+            Drivers\DefaultBase58Driver::class,
+            ['T' => '41'],
+        ),
+    ],
+    CurrencyEnum::ZCASH->value => [
+        new DriverConfig(
+            Drivers\DefaultBase58Driver::class,
+            ['t' => '1C'],
+        ),
+    ],
+];

phpunit.xml

@@ -7,11 +7,10 @@
          convertNoticesToExceptions="true"
          convertWarningsToExceptions="true"
          processIsolation="false"
-         stopOnFailure="false"
-         syntaxCheck="false">
+         stopOnFailure="false">
     <testsuites>
-        <testsuite name="Nacho Test Suite">
-            <directory suffix=".php">./tests/</directory>
+        <testsuite name="Application Test Suite">
+            <directory>./tests/</directory>
         </testsuite>
     </testsuites>
 </phpunit>

src/AddressValidationServiceProvider.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Merkeleon\PhpCryptocurrencyAddressValidation;
+
+use Illuminate\Support\ServiceProvider;
+
+class AddressValidationServiceProvider extends ServiceProvider
+{
+    public function boot(): void
+    {
+        $this->publishes([
+            __DIR__.'/../config/address_validation.php' => config_path('address_validation.php'),
+        ]);
+    }
+}

src/Contracts/Driver.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Merkeleon\PhpCryptocurrencyAddressValidation\Contracts;
+
+interface Driver
+{
+    public function match(string $address): bool;
+    public function check(string $address): bool;
+}

src/Contracts/Validator.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Merkeleon\PhpCryptocurrencyAddressValidation\Contracts;
+
+interface Validator
+{
+    public function isValid(?string $address): bool;
+
+    /**
+     * @param string|null $address
+     *
+     * @return void
+     *
+     * @throws AddressValidationException
+     */
+    public function validate(?string $address): void;
+}

src/DriverConfig.php

@@ -0,0 +1,57 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Merkeleon\PhpCryptocurrencyAddressValidation;
+
+use Merkeleon\PhpCryptocurrencyAddressValidation\Drivers\AbstractDriver;
+use function class_exists;
+
+/**
+ * @template T
+ */
+readonly class DriverConfig
+{
+    /**
+     * @param class-string<T> $driver
+     * @param array $mainnet
+     * @param array $testnet
+     */
+    public function __construct(
+        private string $driver,
+        private array $mainnet = [],
+        private array $testnet = []
+    )
+    {
+    }
+
+    public function makeDriver(bool $isMainNet): ?AbstractDriver
+    {
+        if (!class_exists($this->driver)) {
+            return null;
+        }
+
+        return new $this->driver($this->getDriverOptions($isMainNet));
+
+    }
+
+    private function getDriverOptions(bool $isMainNet): array
+    {
+        if ($isMainNet) {
+            return $this->mainnet;
+        }
+
+        return $this->testnet
+            ?: $this->mainnet
+                ?: [];
+    }
+
+    public static function __set_state(array $state): DriverConfig
+    {
+        return new self(
+            $state['driver'],
+            $state['mainnet'],
+            $state['testnet']
+        );
+    }
+}

src/Drivers/AbstractDriver.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Merkeleon\PhpCryptocurrencyAddressValidation\Drivers;
+
+use Merkeleon\PhpCryptocurrencyAddressValidation\Contracts\Driver;
+
+abstract class AbstractDriver implements Driver
+{
+    public function __construct(protected readonly array $options)
+    {
+    }
+}