Sync fork with upstream Merkeleon/php-cryptocurrency-address-validation

.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

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 Merkeleon\PhpCryptocurrencyAddressValidation\Validation;
+use Merkeleon\PhpCryptocurrencyAddressValidation\Enums\CurrencyEnum;use Merkeleon\PhpCryptocurrencyAddressValidation\Validator;
 
-$validator = Validation::make('BTC');
-var_dump($validator->validate('1QLbGuc3WGKKKpLs4pBp9H6jiQ2MgPkXRp'));
+$validator = Validator::make(CurrencyEnum::BITCOIN);
+var_dump($validator->isValid('1QLbGuc3WGKKKpLs4pBp9H6jiQ2MgPkXRp'));
 
 ```

composer.json

@@ -8,8 +8,14 @@
         }
     ],
     "require": {
-        "php": "^8.1",
-        "spomky-labs/cbor-php": "^2.0"
+        "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": "~8.0"
@@ -25,4 +31,3 @@
         }
     }
 }
-

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'],
+        ),
+    ],
+];

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'),
+        ]);
+    }
+}