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

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

cryptocurrency-regex eth ethereum matcher regex regex-match

Last synced: 4 days ago
JSON representation

Ξ Regular expression for matching Ethereum (ETH) addresses.

• Host: GitHub
• URL: https://github.com/k4m4/ethereum-regex
• Owner: k4m4
• License: mit
• Created: 2018-02-22T21:32:02.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-05T16:14:11.000Z (almost 2 years ago)
• Last Synced: 2024-08-09T03:27:02.414Z (3 months ago)
• Topics: cryptocurrency-regex, eth, ethereum, matcher, regex, regex-match
• Language: JavaScript
• Homepage:
• Size: 490 KB
• Stars: 19
• Watchers: 3
• Forks: 2
• Open Issues: 7
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

README

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

> Regular expression for matching Ethereum (ETH) addresses

## Install

```

~ ❯❯❯ npm install ethereum-regex

```

## Usage

```js

const ethereumRegex = require('ethereum-regex')

ethereumRegex().test('nodejsrocks 0x281055afc982d96fab65b3a49cac8b878184cb16')

//=> true

ethereumRegex({exact: true}).test('nodejsrocks 0x281055afc982d96fab65b3a49cac8b878184cb16 foo')

//=> false

ethereumRegex({exact: true}).test('0x281055afc982d96fab65b3a49cac8b878184cb16')

//=> true

'nodejsrocks 0x6f46cf5569aefa1acc1009290c8e043747172d89 unicorn 0x90e63c3d53e0ea496845b7a03ec7548b70014a91 rainbow'.match(ethereumRegex())

//=> ['0x6f46cf5569aefa1acc1009290c8e043747172d89', '0x90e63c3d53e0ea496845b7a03ec7548b70014a91']

```

## API

### ethereumRegex([options])

Returns a regex for matching Ethereum (ETH) addresses.

#### options.exact

Type: `boolean`


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

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

## Related

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

- [bitcoincash-regex](https://github.com/k4m4/bitcoincash-regex) - Regular expression for matching Bitcoin Cash (BCH) 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)