Merge pull request #9 from arifszn/feat/rule-EthereumAddress

feat: rule ethereum address

Author: arifszn

README.md

@@ -50,6 +50,7 @@ public function rules()
 - [`Credit Card`](#creditcard)
 - [`Data URI`](#datauri)
 - [`Divisible By`](#divisibleby)
+- [`Ethereum Address`](#ethereumaddress)
 - [`Float Number`](#floatnumber)
 - [`Image URL`](#imageurl)
 - [`Phone`](#phone)
@@ -176,6 +177,20 @@ public function rules()
 }
 ```
 
+### `EthereumAddress`
+The field under validation must be an [Ethereum](https://ethereum.org/en/) address. Does not validate address checksums.
+
+```php
+use Arifszn\AdvancedValidation\Rules\EthereumAddress;
+
+public function rules()
+{
+    return [
+        'foo' => [new EthereumAddress()],
+    ];
+}
+```
+
 ### `FloatNumber`
 
 The field under validation must be a float number.
@@ -281,6 +296,11 @@ composer test
 Any contributors who want to make this project better can make contributions, which will be greatly appreciated. To contribute, clone this repo locally and commit your code to a new branch. Feel free to create an issue or make a pull request.
 
 
+## Credits
+
+- [validator.js](https://github.com/validatorjs/validator.js)
+
+
 ## Support
 
 If you are using this package and happy with it or just want to encourage me to continue creating stuff, you can do it by just starring and sharing the project.

resources/lang/en/validation.php

@@ -10,6 +10,7 @@
     'credit_card' => 'The :attribute must be a valid credit card number.',
     'data_uri' => 'The :attribute must have data uri format.',
     'divisible_by' => 'The :attribute must be divisible by :number.',
+    'ethereum_address' => 'The :attribute must be an Ethereum address.',
     'float_number' => 'The :attribute must be a float number',
     'image_url' => 'The :attribute must be a valid image URL.',
     'phone' => 'The :attribute must be a valid phone number.',

src/Rules/EthereumAddress.php

@@ -0,0 +1,51 @@
+<?php
+
+namespace Arifszn\AdvancedValidation\Rules;
+
+use Illuminate\Contracts\Validation\Rule;
+
+/**
+ * The field under validation must be an Ethereum address. Does not validate address checksums.
+ *
+ * @package Arifszn\AdvancedValidation\Rules
+ */
+class EthereumAddress implements Rule
+{
+    /**
+     * @var string
+     */
+    private $errorMessage;
+
+    /**
+     * Create a new rule instance.
+     *
+     * @param string|null $errorMessage   Custom error message.
+     * @return void
+     */
+    public function __construct(string $errorMessage = null)
+    {
+        $this->errorMessage = $errorMessage;
+    }
+
+    /**
+     * Determine if the validation rule passes.
+     *
+     * @param string $attribute
+     * @param mixed $value
+     * @return bool
+     */
+    public function passes($attribute, $value)
+    {
+        return preg_match('/^(0x)[0-9a-f]{40}$/i', $value);
+    }
+
+    /**
+     * Get the validation error message.
+     *
+     * @return string
+     */
+    public function message()
+    {
+        return $this->errorMessage ? $this->errorMessage : trans('advancedValidation::validation.ethereum_address');
+    }
+}

tests/Rules/EthereumAddressTest.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace Arifszn\AdvancedValidation\Tests\Rules;
+
+use Arifszn\AdvancedValidation\Rules\EthereumAddress;
+use Arifszn\AdvancedValidation\Tests\TestCase;
+
+class EthereumAddressTest extends TestCase
+{
+    /**
+     * @dataProvider provider
+     */
+    public function testValidation($result, $value)
+    {
+        $this->assertEquals($result, (new EthereumAddress())->passes('foo', $value));
+    }
+
+    public function provider()
+    {
+        return [
+            [true, '0x0000000000000000000000000000000000000001'],
+            [true, '0x683E07492fBDfDA84457C16546ac3f433BFaa128'],
+            [true, '0x88dA6B6a8D3590e88E0FcadD5CEC56A7C9478319'],
+            [true, '0x8a718a84ee7B1621E63E680371e0C03C417cCaF6'],
+            [true, '0xFCb5AFB808b5679b4911230Aa41FfCD0cd335b42'],
+
+            [false, '0xGHIJK05pwm37asdf5555QWERZCXV2345AoEuIdHt'],
+            [false, '0xFCb5AFB808b5679b4911230Aa41FfCD0cd335b422222'],
+            [false, '0xFCb5AFB808b5679b4911230Aa41FfCD0cd33'],
+            [false, '0b0110100001100101011011000110110001101111'],
+            [false, '683E07492fBDfDA84457C16546ac3f433BFaa128'],
+            [false, '1C6o5CDkLxjsVpnLSuqRs1UBFozXLEwYvU'],
+        ];
+    }
+}