├── .gitignore
├── LICENSE
├── README.md
├── composer.json
├── phpunit.xml
├── src
    └── AddressValidator.php
└── tests
    └── AddressValidatorTest.php


/.gitignore:
--------------------------------------------------------------------------------
1 | composer.phar
2 | vendor/
3 | 
4 | # Commit your application's lock file http://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file
5 | # You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file
6 | # composer.lock


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


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # php-bitcoin-address-validator
 2 | 
 3 | A simple, easy to use PHP Bitcoin address validator
 4 | 
 5 | ## Usage
 6 | 
 7 | Quick start:
 8 | 
 9 | ```php
10 | use \LinusU\Bitcoin\AddressValidator;
11 | 
12 | // This will return false, indicating invalid address.
13 | AddressValidator::isValid('blah');
14 | 
15 | // This is a valid address and will thus return true.
16 | AddressValidator::isValid('1AGNa15ZQXAZUgFiqJ2i7Z2DPU2J6hW62i');
17 | 
18 | // This is a Testnet address, it's valid and the function will return true.
19 | AddressValidator::isValid('mo9ncXisMeAoXwqcV5EWuyncbmCcQN4rVs', AddressValidator::TESTNET);
20 | ```
21 | 
22 | ## API
23 | 
24 | ### `isValid($addr, $version)`
25 | 
26 | - `$addr`: A bitcoin address
27 | - `$version`: The version to test against, defaults to `MAINNET`
28 | 
29 | Returns a boolean indicating if the address is valid or not.
30 | 
31 | ### `typeOf($addr)`
32 | 
33 | - `$addr`: A bitcoin address
34 | 
35 | Returns the type of the address.
36 | 
37 | ## Constants
38 | 
39 | The library exposes the following constants.
40 | 
41 | - `MAINNET`: Indicates any mainnet address type
42 | - `TESTNET`: Indicates any testnet address type
43 | - `MAINNET_PUBKEY`: Indicates a mainnet pay to pubkey hash address
44 | - `MAINNET_SCRIPT`: Indicates a mainnet pay to script hash address
45 | - `TESTNET_PUBKEY`: Indicates a testnet pay to pubkey hash address
46 | - `TESTNET_SCRIPT`: Indicates a testnet pay to script hash address
47 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "linusu/bitcoin-address-validator",
 3 |   "type": "library",
 4 |   "description": "A simple, easy to use PHP Bitcoin address validator",
 5 |   "keywords": ["bitcoin", "address", "validation", "validator"],
 6 |   "homepage": "http://github.com/LinusU/bitcoin-address-validator",
 7 |   "license": "MIT",
 8 |   "authors": [
 9 |     {
10 |       "name": "Linus Unnebäck",
11 |       "email": "linus@folkdatorn.se",
12 |       "homepage": "http://linusu.se/",
13 |       "role": "Developer"
14 |     }
15 |   ],
16 |   "require": {
17 |     "php": ">=5.3.0"
18 |   },
19 |   "autoload": {
20 |     "psr-4": {
21 |       "LinusU\\Bitcoin\\": "src/"
22 |     }
23 |   }
24 | }
25 | 


--------------------------------------------------------------------------------
/phpunit.xml:
--------------------------------------------------------------------------------
1 | <?xml version="1.0" encoding="UTF-8"?>
2 | <phpunit colors="true">
3 |   <testsuites>
4 |     <testsuite name="Bitcoin Address Validator Test Suite">
5 |       <directory suffix="Test.php">./tests/</directory>
6 |     </testsuite>
7 |   </testsuites>
8 | </phpunit>
9 | 


--------------------------------------------------------------------------------
/src/AddressValidator.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace LinusU\Bitcoin;
  4 | 
  5 | class AddressValidator {
  6 | 
  7 |     CONST MAINNET = "MAINNET";
  8 |     CONST TESTNET = "TESTNET";
  9 | 
 10 |     CONST MAINNET_PUBKEY = "00";
 11 |     CONST MAINNET_SCRIPT = "05";
 12 | 
 13 |     CONST TESTNET_PUBKEY = "6F";
 14 |     CONST TESTNET_SCRIPT = "C4";
 15 | 
 16 |     static public function typeOf($addr) {
 17 | 
 18 |         if (preg_match('/[^1-9A-HJ-NP-Za-km-z]/', $addr)) {
 19 |             return false;
 20 |         }
 21 | 
 22 |         $decoded = self::decodeAddress($addr);
 23 | 
 24 |         if (strlen($decoded) != 50) {
 25 |             return false;
 26 |         }
 27 | 
 28 |         $version = substr($decoded, 0, 2);
 29 | 
 30 |         $check = substr($decoded, 0, strlen($decoded) - 8);
 31 |         $check = pack("H*", $check);
 32 |         $check = hash("sha256", $check, true);
 33 |         $check = hash("sha256", $check);
 34 |         $check = strtoupper($check);
 35 |         $check = substr($check, 0, 8);
 36 | 
 37 |         $isValid = ($check == substr($decoded, strlen($decoded) - 8));
 38 | 
 39 |         return ($isValid ? $version : false);
 40 |     }
 41 | 
 42 |     static public function isValid($addr, $version = null) {
 43 | 
 44 |         $type = self::typeOf($addr);
 45 | 
 46 |         if ($type === false) {
 47 |             return false;
 48 |         }
 49 | 
 50 |         if (is_null($version)) {
 51 |             $version = self::MAINNET;
 52 |         }
 53 | 
 54 |         switch ($version) {
 55 |             case self::MAINNET:
 56 |               $valids = [self::MAINNET_PUBKEY, self::MAINNET_SCRIPT];
 57 |               break;
 58 |             case self::TESTNET:
 59 |               $valids = [self::TESTNET_PUBKEY, self::TESTNET_SCRIPT];
 60 |               break;
 61 |             case self::MAINNET_PUBKEY:
 62 |             case self::MAINNET_SCRIPT:
 63 |             case self::TESTNET_PUBKEY:
 64 |             case self::TESTNET_SCRIPT:
 65 |               $valids = [$version];
 66 |               break;
 67 |             default:
 68 |               throw new Exception('Unknown version constant');
 69 |         }
 70 | 
 71 |         return in_array($type, $valids);
 72 |     }
 73 | 
 74 |     static protected function decodeAddress($data) {
 75 | 
 76 |         $charsetHex = '0123456789ABCDEF';
 77 |         $charsetB58 = '123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz';
 78 | 
 79 |         $raw = "0";
 80 |         for ($i = 0; $i < strlen($data); $i++) {
 81 |             $current = (string) strpos($charsetB58, $data[$i]);
 82 |             $raw = (string) bcmul($raw, "58", 0);
 83 |             $raw = (string) bcadd($raw, $current, 0);
 84 |         }
 85 | 
 86 |         $hex = "";
 87 |         while (bccomp($raw, 0) == 1) {
 88 |             $dv = (string) bcdiv($raw, "16", 0);
 89 |             $rem = (integer) bcmod($raw, "16");
 90 |             $raw = $dv;
 91 |             $hex = $hex . $charsetHex[$rem];
 92 |         }
 93 | 
 94 |         $withPadding = strrev($hex);
 95 |         for ($i = 0; $i < strlen($data) && $data[$i] == "1"; $i++) {
 96 |             $withPadding = "00" . $withPadding;
 97 |         }
 98 | 
 99 |         if (strlen($withPadding) % 2 != 0) {
100 |             $withPadding = "0" . $withPadding;
101 |         }
102 | 
103 |         return $withPadding;
104 |     }
105 | 
106 | }
107 | 


--------------------------------------------------------------------------------
/tests/AddressValidatorTest.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | require_once 'src/AddressValidator.php';
  4 | 
  5 | use \LinusU\Bitcoin\AddressValidator;
  6 | 
  7 | class AddressValidatorTest extends PHPUnit_Framework_TestCase {
  8 | 
  9 |     /*
 10 | 
 11 |     Data from the official bitcoin client:
 12 |     https://github.com/bitcoin/bitcoin/tree/master/src/test/data
 13 | 
 14 |     */
 15 | 
 16 |     protected $invalidAddrs = [
 17 |         '',
 18 |         'x',
 19 |         '37qgekLpCCHrQuSjvX3fs496FWTGsHFHizjJAs6NPcR47aefnnCWECAhHV6E3g4YN7u7Yuwod5Y',
 20 |         'dzb7VV1Ui55BARxv7ATxAtCUeJsANKovDGWFVgpTbhq9gvPqP3yv',
 21 |         'MuNu7ZAEDFiHthiunm7dPjwKqrVNCM3mAz6rP9zFveQu14YA8CxExSJTHcVP9DErn6u84E6Ej7S',
 22 |         'rPpQpYknyNQ5AEHuY6H8ijJJrYc2nDKKk9jjmKEXsWzyAQcFGpDLU2Zvsmoi8JLR7hAwoy3RQWf',
 23 |         '4Uc3FmN6NQ6zLBK5QQBXRBUREaaHwCZYsGCueHauuDmJpZKn6jkEskMB2Zi2CNgtb5r6epWEFfUJq',
 24 |         '7aQgR5DFQ25vyXmqZAWmnVCjL3PkBcdVkBUpjrjMTcghHx3E8wb',
 25 |         '17QpPprjeg69fW1DV8DcYYCKvWjYhXvWkov6MJ1iTTvMFj6weAqW7wybZeH57WTNxXVCRH4veVs',
 26 |         'KxuACDviz8Xvpn1xAh9MfopySZNuyajYMZWz16Dv2mHHryznWUp3',
 27 |         '7nK3GSmqdXJQtdohvGfJ7KsSmn3TmGqExug49583bDAL91pVSGq5xS9SHoAYL3Wv3ijKTit65th',
 28 |         'cTivdBmq7bay3RFGEBBuNfMh2P1pDCgRYN2Wbxmgwr4ki3jNUL2va',
 29 |         'gjMV4vjNjyMrna4fsAr8bWxAbwtmMUBXJS3zL4NJt5qjozpbQLmAfK1uA3CquSqsZQMpoD1g2nk',
 30 |         'emXm1naBMoVzPjbk7xpeTVMFy4oDEe25UmoyGgKEB1gGWsK8kRGs',
 31 |         '7VThQnNRj1o3Zyvc7XHPRrjDf8j2oivPTeDXnRPYWeYGE4pXeRJDZgf28ppti5hsHWXS2GSobdqyo',
 32 |         '1G9u6oCVCPh2o8m3t55ACiYvG1y5BHewUkDSdiQarDcYXXhFHYdzMdYfUAhfxn5vNZBwpgUNpso',
 33 |         '31QQ7ZMLkScDiB4VyZjuptr7AEc9j1SjstF7pRoLhHTGkW4Q2y9XELobQmhhWxeRvqcukGd1XCq',
 34 |         'DHqKSnpxa8ZdQyH8keAhvLTrfkyBMQxqngcQA5N8LQ9KVt25kmGN',
 35 |         '2LUHcJPbwLCy9GLH1qXmfmAwvadWw4bp4PCpDfduLqV17s6iDcy1imUwhQJhAoNoN1XNmweiJP4i',
 36 |         '7USRzBXAnmck8fX9HmW7RAb4qt92VFX6soCnts9s74wxm4gguVhtG5of8fZGbNPJA83irHVY6bCos',
 37 |         '1DGezo7BfVebZxAbNT3XGujdeHyNNBF3vnficYoTSp4PfK2QaML9bHzAMxke3wdKdHYWmsMTJVu',
 38 |         '2D12DqDZKwCxxkzs1ZATJWvgJGhQ4cFi3WrizQ5zLAyhN5HxuAJ1yMYaJp8GuYsTLLxTAz6otCfb',
 39 |         '8AFJzuTujXjw1Z6M3fWhQ1ujDW7zsV4ePeVjVo7D1egERqSW9nZ',
 40 |         '163Q17qLbTCue8YY3AvjpUhotuaodLm2uqMhpYirsKjVqnxJRWTEoywMVY3NbBAHuhAJ2cF9GAZ',
 41 |         '2MnmgiRH4eGLyLc9eAqStzk7dFgBjFtUCtu',
 42 |         '461QQ2sYWxU7H2PV4oBwJGNch8XVTYYbZxU',
 43 |         '2UCtv53VttmQYkVU4VMtXB31REvQg4ABzs41AEKZ8UcB7DAfVzdkV9JDErwGwyj5AUHLkmgZeobs',
 44 |         'cSNjAsnhgtiFMi6MtfvgscMB2Cbhn2v1FUYfviJ1CdjfidvmeW6mn',
 45 |         'gmsow2Y6EWAFDFE1CE4Hd3Tpu2BvfmBfG1SXsuRARbnt1WjkZnFh1qGTiptWWbjsq2Q6qvpgJVj',
 46 |         'nksUKSkzS76v8EsSgozXGMoQFiCoCHzCVajFKAXqzK5on9ZJYVHMD5CKwgmX3S3c7M1U3xabUny',
 47 |         'L3favK1UzFGgdzYBF2oBT5tbayCo4vtVBLJhg2iYuMeePxWG8SQc',
 48 |         '7VxLxGGtYT6N99GdEfi6xz56xdQ8nP2dG1CavuXx7Rf2PrvNMTBNevjkfgs9JmkcGm6EXpj8ipyPZ',
 49 |         '2mbZwFXF6cxShaCo2czTRB62WTx9LxhTtpP',
 50 |         'dB7cwYdcPSgiyAwKWL3JwCVwSk6epU2txw',
 51 |         'HPhFUhUAh8ZQQisH8QQWafAxtQYju3SFTX',
 52 |         '4ctAH6AkHzq5ioiM1m9T3E2hiYEev5mTsB',
 53 |         'Hn1uFi4dNexWrqARpjMqgT6cX1UsNPuV3cHdGg9ExyXw8HTKadbktRDtdeVmY3M1BxJStiL4vjJ',
 54 |         'Sq3fDbvutABmnAHHExJDgPLQn44KnNC7UsXuT7KZecpaYDMU9Txs',
 55 |         '6TqWyrqdgUEYDQU1aChMuFMMEimHX44qHFzCUgGfqxGgZNMUVWJ',
 56 |         'giqJo7oWqFxNKWyrgcBxAVHXnjJ1t6cGoEffce5Y1y7u649Noj5wJ4mmiUAKEVVrYAGg2KPB3Y4',
 57 |         'cNzHY5e8vcmM3QVJUcjCyiKMYfeYvyueq5qCMV3kqcySoLyGLYUK',
 58 |         '37uTe568EYc9WLoHEd9jXEvUiWbq5LFLscNyqvAzLU5vBArUJA6eydkLmnMwJDjkL5kXc2VK7ig',
 59 |         'EsYbG4tWWWY45G31nox838qNdzksbPySWc',
 60 |         'nbuzhfwMoNzA3PaFnyLcRxE9bTJPDkjZ6Rf6Y6o2ckXZfzZzXBT',
 61 |         'cQN9PoxZeCWK1x56xnz6QYAsvR11XAce3Ehp3gMUdfSQ53Y2mPzx',
 62 |         '1Gm3N3rkef6iMbx4voBzaxtXcmmiMTqZPhcuAepRzYUJQW4qRpEnHvMojzof42hjFRf8PE2jPde',
 63 |         '2TAq2tuN6x6m233bpT7yqdYQPELdTDJn1eU',
 64 |         'ntEtnnGhqPii4joABvBtSEJG6BxjT2tUZqE8PcVYgk3RHpgxgHDCQxNbLJf7ardf1dDk2oCQ7Cf',
 65 |         'Ky1YjoZNgQ196HJV3HpdkecfhRBmRZdMJk89Hi5KGfpfPwS2bUbfd',
 66 |         '2A1q1YsMZowabbvta7kTy2Fd6qN4r5ZCeG3qLpvZBMzCixMUdkN2Y4dHB1wPsZAeVXUGD83MfRED'
 67 |     ];
 68 | 
 69 |     protected $validAddrs = [
 70 |         '1AGNa15ZQXAZUgFiqJ2i7Z2DPU2J6hW62i',
 71 |         '1Ax4gZtb7gAit2TivwejZHYtNNLT18PUXJ',
 72 |         '1C5bSj1iEGUgSTbziymG7Cn18ENQuT36vv',
 73 |         '1Gqk4Tv79P91Cc1STQtU3s1W6277M2CVWu',
 74 |         '1JwMWBVLtiqtscbaRHai4pqHokhFCbtoB4',
 75 |         '19dcawoKcZdQz365WpXWMhX6QCUpR9SY4r',
 76 |         '13p1ijLwsnrcuyqcTvJXkq2ASdXqcnEBLE'
 77 |     ];
 78 | 
 79 |     protected $validTestnet = [
 80 |         'mo9ncXisMeAoXwqcV5EWuyncbmCcQN4rVs',
 81 |         'n3ZddxzLvAY9o7184TB4c6FJasAybsw4HZ',
 82 |         'n3LnJXCqbPjghuVs8ph9CYsAe4Sh4j97wk',
 83 |         'mhaMcBxNh5cqXm4aTQ6EcVbKtfL6LGyK2H',
 84 |         'mizXiucXRCsEriQCHUkCqef9ph9qtPbZZ6',
 85 |         'myoqcgYiehufrsnnkqdqbp69dddVDMopJu'
 86 |     ];
 87 | 
 88 |     protected $scriptAddrs = [
 89 |         '3CMNFxN1oHBc4R1EpboAL5yzHGgE611Xou',
 90 |         '3QjYXhTkvuj8qPaXHTTWb5wjXhdsLAAWVy',
 91 |         '3AnNxabYGoTxYiTEZwFEnerUoeFXK2Zoks',
 92 |         '33vt8ViH5jsr115AGkW6cEmEz9MpvJSwDk',
 93 |         '3QCzvfL4ZRvmJFiWWBVwxfdaNBT8EtxB5y',
 94 |         '37Sp6Rv3y4kVd1nQ1JV5pfqXccHNyZm1x3',
 95 |         '3ALJH9Y951VCGcVZYAdpA3KchoP9McEj1G'
 96 |     ];
 97 | 
 98 |     protected $scriptTestnet = [
 99 |         '2N2JD6wb56AfK4tfmM6PwdVmoYk2dCKf4Br',
100 |         '2NBFNJTktNa7GZusGbDbGKRZTxdK9VVez3n',
101 |         '2NB72XtkjpnATMggui83aEtPawyyKvnbX2o',
102 |         '2MxgPqX1iThW3oZVk9KoFcE5M4JpiETssVN',
103 |         '2NEWDzHWwY5ZZp8CQWbB7ouNMLqCia6YRda',
104 |         '2N7FuwuUuoTBrDFdrAZ9KxBmtqMLxce9i1C'
105 |     ];
106 | 
107 |     function testInvalidAddrsMainnet() {
108 |         foreach ($this->invalidAddrs as $addr) {
109 |             $this->assertEquals(false, AddressValidator::isValid($addr), 'Should be invalid: ' . $addr);
110 |         }
111 |     }
112 | 
113 |     function testValidAddrsMainnet() {
114 |         foreach ($this->validAddrs as $addr) {
115 |             $this->assertEquals(true, AddressValidator::isValid($addr), 'Should be valid: ' . $addr);
116 |         }
117 |     }
118 | 
119 |     function testInvalidAddrsTestnet() {
120 |         foreach ($this->invalidAddrs as $addr) {
121 |             $this->assertEquals(false, AddressValidator::isValid($addr, AddressValidator::TESTNET), 'Should be invalid: ' . $addr);
122 |         }
123 |     }
124 | 
125 |     function testValidAddrsTestnet() {
126 |         foreach ($this->validTestnet as $addr) {
127 |             $this->assertEquals(true, AddressValidator::isValid($addr, AddressValidator::TESTNET), 'Should be valid: ' . $addr);
128 |         }
129 |     }
130 | 
131 |     function testScriptAddrsMainnet() {
132 |         foreach ($this->scriptAddrs as $addr) {
133 |             $this->assertEquals(AddressValidator::typeOf($addr), AddressValidator::MAINNET_SCRIPT, 'Should be script: ' . $addr);
134 |         }
135 |     }
136 | 
137 |     function testScriptAddrsTestnet() {
138 |         foreach ($this->scriptTestnet as $addr) {
139 |             $this->assertEquals(AddressValidator::typeOf($addr), AddressValidator::TESTNET_SCRIPT, 'Should be script: ' . $addr);
140 |         }
141 |     }
142 | 
143 | }
144 | 


--------------------------------------------------------------------------------