multicoin-address-validator README

The project's README from github.com/Nonco-Organization/multicoin-address-validator. As one markdown file: README.md.

wallet-address-validator

Simple wallet address validator for validating Bitcoin and other altcoins addresses in Node.js and browser.

Build Status

Forked from ryanralph/altcoin-address.

File size is ~17 kB (minifed and gzipped).

Installation

NPM

npm install multicoin-address-validator

Browser

<script src="wallet-address-validator.min.js"></script>

API

validate (address [, currency = 'bitcoin'[, networkType = 'prod']])
Parameters

Returns true if the address (string) is a valid wallet address for the crypto currency specified, see below for supported currencies.

Supported crypto currencies

Usage example

Node

var WAValidator = require('multicoin-address-validator');

var valid = WAValidator.validate('1KFzzGtDdnq5hrwxXGjwVnKzRbvf8WVxck', 'BTC');
if(valid)
	console.log('This is a valid address');
else
	console.log('Address INVALID');

// This will log 'This is a valid address' to the console.

var WAValidator = require('multicoin-address-validator');

var valid = WAValidator.validate('1KFzzGtDdnq5hrwxXGjwVnKzRbvf8WVxck', 'litecoin', 'testnet');
if(valid)
      console.log('This is a valid address');
else
      console.log('Address INVALID');

// As this is a invalid litecoin address 'Address INVALID' will be logged to console.

var WAValidator = require('multicoin-address-validator');

var currency = WAValidator.findCurrency('xrp');
if(currency)
      console.log('This currency exists');
else
      console.log('Currency INVALID');

// As this is a valid currency symbol 'This currency exists' will be logged to console.

var WAValidator = require('multicoin-address-validator');

var currency = WAValidator.findCurrency('random');
if(currency)
      console.log('This currency exists');
else
      console.log('Currency INVALID');

// As this is not a valid currency symbol 'Currency INVALID' will be logged to console.

Browser

<script src="wallet-address-validator.min.js"></script>

// WAValidator is exposed as a global (window.WAValidator)
var valid = WAValidator.validate('1KFzzGtDdnq5hrwxXGjwVnKzRbvf8WVxck', 'bitcoin');
if(valid)
    alert('This is a valid address');
else
    alert('Address INVALID');

// This should show a pop up with text 'This is a valid address'.

multicoin-address-validator (Nonco-Organization/multicoin-address-validator)

Searching Database…

230 ·GitHub
Multicoin-address-validator
Что это?Библиотека на JavaScript, которая проверяет адреса кошельков Bitcoin, Litecoin, Ethereum и более 100 других криптовалют.
Это фреймворк или библиотека?Это лёгкая библиотека, которую вы импортируете в свой код; она предоставляет единственную функцию validate, а не отдельное приложение.
Как добавить её в проект?Установите через NPM или подключите браузерную сборку прямо на веб-странице.
Нужны ли API-ключи или доступ к сети?Нет, это чистая библиотека валидации: она локально проверяет формат адреса и контрольные суммы, не обращаясь ни к какому блокчейну или внешнему сервису.
Проверяется только формат или то, что адрес реально существует в блокчейне?Проверяется только формат и контрольная сумма адреса для указанной валюты; то, используется ли адрес на самом деле или пополнен в блокчейне, не проверяется.
Это только для монет типа Bitcoin или работает и с адресами в стиле Ethereum?Поддерживаются и монеты в стиле Bitcoin с UTXO, и адреса аккаунтов в стиле Ethereum, плюс множество токенов ERC-20, использующих формат адреса Ethereum.
Как работает функция validate?Вызовите validate(address, currency, networkType), где currency по умолчанию 'bitcoin', а networkType может быть 'prod', 'testnet' или 'both'; функция вернёт true, если адрес валиден для этой монеты.
Можно ли проверять адреса testnet?Да, передача 'testnet' в параметре networkType включает правила адресов testnet вместо адресов основной сети (mainnet).
Откуда взялся этот проект?Это форк ryanralph/altcoin-address, расширенный для поддержки куда большего числа криптовалют.
Сколько криптовалют поддерживается?В README перечислено более 100 поддерживаемых монет и токенов, которые задаются полным именем или тикером (например, 'bitcoin' или 'btc').
What are similar projects?metamask-extension, rh-swap, awesome-blockchain-cn, bitcoin, ccxt, XChange, TradingView-API, web3.js
Which topics is it in?validator, bitcoin, wallet, crypto, validation, ethereum, cryptocurrency, blockchain, sdk, npm, tool, nodejs
Creator
Nonco-Organization
Size
1.6 MB
Stars
230
Updated
CommitApr 29
Age
10d
Commits · 90 Days