https://github.com/k4m4/bitcoincash-regex

Regular expression for matching Bitcoin Cash (BCH) Legacy and CashAddr addresses.
https://github.com/k4m4/bitcoincash-regex

bch bitcoin-cash cryptocurrency-regex matcher regex regex-match

Last synced: 3 months ago
JSON representation

Regular expression for matching Bitcoin Cash (BCH) Legacy and CashAddr addresses.

• Host: GitHub
• URL: https://github.com/k4m4/bitcoincash-regex
• Owner: k4m4
• License: mit
• Created: 2018-02-23T11:45:36.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2023-01-05T16:13:40.000Z (about 2 years ago)
• Last Synced: 2024-10-12T23:26:44.653Z (4 months ago)
• Topics: bch, bitcoin-cash, cryptocurrency-regex, matcher, regex, regex-match
• Language: JavaScript
• Homepage:
• Size: 540 KB
• Stars: 8
• Watchers: 3
• Forks: 2
• Open Issues: 7
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

README

        
# bitcoincash-regex [![Build Status](https://travis-ci.org/k4m4/bitcoincash-regex.svg?branch=master)](https://travis-ci.org/k4m4/bitcoincash-regex) [![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/xojs/xo)

> Regular expression for matching Bitcoin Cash (BCH) Legacy and CashAddr addresses.

## Install

```

~ ❯❯❯ npm install bitcoincash-regex

```

## Usage

```js

const bchRegex = require('bitcoincash-regex')

bchRegex().test('nodejsrocks 19hZx234vNtLazfx5J2bxHsiWEmeYE8a7k')

//=> true

bchRegex({exact: true}).test('nodejsrocks 19hZx234vNtLazfx5J2bxHsiWEmeYE8a7k foo')

//=> false

bchRegex({exact: true}).test('19hZx234vNtLazfx5J2bxHsiWEmeYE8a7k')

//=> true

bchRegex.format('cashaddr', {exact: true}).test('bitcoincash:qpm2qsznhks23z7629mms6s4cwef74vcwvy22gdx6a')

//=> true

bchRegex.format('cashaddr', {exact: true}).test('19hZx234vNtLazfx5J2bxHsiWEmeYE8a7k')

//=> false

'nodejsrocks 19hZx234vNtLazfx5J2bxHsiWEmeYE8a7k unicorn bitcoincash:qpm2qsznhks23z7629mms6s4cwef74vcwvy22gdx6a rainbow'.match(bchRegex());

//=> ['19hZx234vNtLazfx5J2bxHsiWEmeYE8a7k', 'bitcoincash:qpm2qsznhks23z7629mms6s4cwef74vcwvy22gdx6a']

```

## API

### bchRegex([options])

Returns a regex for matching BCH addresses.

#### options.exact

Type: `boolean`


Default: `false` *(Matches any BCH address in a string)*

Only match an exact string. Useful with `RegExp#test()` to check if a string is an BCH address.

### bchRegex.format([format], [options])

Returns a regex for matching specific BCH format addresses.

#### format

Type: `string`


Supported Formats: `legacy`, `cashaddr`

Match a specific BCH address format.

#### options.exact

Type: `boolean`


Default: `false` *(Matches any BCH address in a string)*

Only match an exact string. Useful with `RegExp#test()` to check if a string is an BCH address.

## Related

- [ethereum-regex](https://github.com/k4m4/ethereum-regex) - Regular expression for matching Ethereum (ETH) addresses.

- [litecoin-regex](https://github.com/k4m4/litecoin-regex) - Regular expression for matching Litecoin (LTC) addresses.

- [monero-regex](https://github.com/k4m4/monero-regex) - Regular expression for matching Monero (XMR) addresses.

- [dash-regex](https://github.com/k4m4/dash-regex) - Regular expression for matching Dash addresses.

- [ripple-regex](https://github.com/k4m4/ripple-regex) - Regular expression for matching Ripple (XRP) addresses.

- [neo-regex](https://github.com/k4m4/neo-regex) - Regular expression for matching NEO addresses.

- [dogecoin-regex](https://github.com/k4m4/dogecoin-regex) - Regular expression for matching Dogecoin (DOGE) addresses.

## License

MIT © [Nikolaos Kamarinakis](https://nikolaskama.me)