Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kielabokkie/bitcoin-address-validator

PHP package to validate legacy, segwit, native segwit (bech32) and taproot Bitcoin addresses
https://github.com/kielabokkie/bitcoin-address-validator

address bitcoin bitcoin-addresses bitcoin-validator php php-library php-package segwit taproot

Last synced: 3 months ago
JSON representation

PHP package to validate legacy, segwit, native segwit (bech32) and taproot Bitcoin addresses

Host: GitHub
URL: https://github.com/kielabokkie/bitcoin-address-validator
Owner: kielabokkie
License: mit
Created: 2020-03-16T11:14:10.000Z (almost 5 years ago)
Default Branch: master
Last Pushed: 2023-09-28T08:29:21.000Z (over 1 year ago)
Last Synced: 2024-10-13T11:24:39.821Z (3 months ago)
Topics: address, bitcoin, bitcoin-addresses, bitcoin-validator, php, php-library, php-package, segwit, taproot
Language: PHP
Homepage:
Size: 56.6 KB
Stars: 38
Watchers: 2
Forks: 8
Open Issues: 2
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md

Awesome Lists containing this project

README

        # Bitcoin Address Validator

[![Author](http://img.shields.io/badge/[email protected]?logo=twitter&style=flat-square)](https://twitter.com/kielabokkie)

[![Build](https://img.shields.io/github/workflow/status/kielabokkie/bitcoin-address-validator/tests/master?style=flat-square)](https://github.com/kielabokkie/bitcoin-address-validator/actions)

[![Packagist Version](https://img.shields.io/packagist/v/kielabokkie/bitcoin-address-validator.svg?style=flat-square)](https://packagist.org/packages/kielabokkie/bitcoin-address-validator)

[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)

[![Total Downloads](https://img.shields.io/packagist/dt/kielabokkie/bitcoin-address-validator.svg?style=flat-square)](https://packagist.org/packages/kielabokkie/bitcoin-address-validator)

Validate legacy, segwit, native segwit (bech32), and taproot Bitcoin addresses.

## Requirements

* PHP >= 7.3

| PHP  | Package Version |

| ---- |-----------------|

| 7.x | v1.0            |

| 8.x | v2.0+           |

Please note that taproot addresses are supported from v2.1 of this package.

## Installation

Install the package via composer:

```

composer require kielabokkie/bitcoin-address-validator

```

## Usage

First you instantiate the validator class:

```php

$addressValidator = new \Kielabokkie\Bitcoin\AddressValidator;

```

Validate any kind of address (legacy, segwit, native segwit and taproot):

```php

$addressValidator->isValid('1AGNa15ZQXAZUgFiqJ2i7Z2DPU2J6hW62i');

```

Legacy (P2PKH) address:

```php

$addressValidator->isPayToPublicKeyHash('1AGNa15ZQXAZUgFiqJ2i7Z2DPU2J6hW62i');

```

Segwit (P2SH) address:

```php

$addressValidator->isPayToScriptHash('3ALJH9Y951VCGcVZYAdpA3KchoP9McEj1G');

```

Native segwit (bech32) address:

```php

$addressValidator->isBech32('bc1qw508d6qejxtdg4y5r3zarvary0c5xw7kv8f3t4');

```

Taproot (P2TR) address:

```php

$addressValidator->isPayToTaproot('bc1pveaamy78cq5hvl74zmfw52fxyjun3lh7lgt44j03ygx02zyk8lesgk06f6');

```

### Testnet

By default, the validator only passes mainnet addresses as valid. If you would like to validate both mainnet and testnet addresses you can use method chaining:

```php

// Both valid

$addressValidator->includeTestnet()->isBech32('bc1qw508d6qejxtdg4y5r3zarvary0c5xw7kv8f3t4');

$addressValidator->includeTestnet()->isBech32('tb1qw508d6qejxtdg4y5r3zarvary0c5xw7kxpjzsx');

```

If you want to validate only testnet addresses you can do that as follows:

```php

// Invalid

$addressValidator->onlyTestnet()->isBech32('bc1qw508d6qejxtdg4y5r3zarvary0c5xw7kv8f3t4');

// Valid

$addressValidator->onlyTestnet()->isBech32('tb1qw508d6qejxtdg4y5r3zarvary0c5xw7kxpjzsx');

```

## Testing

This package is tested against the test data of the official [bitcoin/bitcoin](https://github.com/bitcoin/bitcoin/tree/master/src/test/data) repo. If you come across an address that is not validated correctly please [open an issue](https://github.com/kielabokkie/bitcoin-address-validator/issues) for it.

Run the tests with:

```bash

composer test

```

## Credits

This package is based on the following packages and uses a lot of their code:

* [bitwasp/bech32](https://github.com/Bit-Wasp/bech32) by [@afk11](https://github.com/afk11)

* [brooksyang/bech32m](https://github.com/BrooksYang/bech32m) by [BrooksYang](https://github.com/BrooksYang)

* [linusu/bitcoin-address-validator](https://github.com/LinusU/php-bitcoin-address-validator) by [@LinusU](https://github.com/LinusU)

All credit goes to the original authors.

## Donate

Did this package made you lots of money, save you some time or just sparked joy?

A donation would be much appreciated: `32vtWJSomccxQ6y1tgSwSHXN5PChpdYy27`