ava

README

ava

Cryptocurrency Addresses Validator

Installation

Install the package using

$ go get github.com/LanfordCai/ava

Usage

To use the package import it in your *.go code

import "github.com/LanfordCai/ava"

Example

Validate a Bitcoin address

package main

import (
	"fmt"

	"github.com/LanfordCai/ava"
)

func main() {
	a := ava.Address{
		ChainName: "Bitcoin",
		Address:   "3NJHZpnnk3bFxqVHVS2vUomUBznju6W8D9",
		IsTestnet: false,
	}

	if a.IsValid() {
		fmt.Printf("%s is a valid %s address!", a.Address, a.ChainName)
	} else {
		fmt.Printf("%s is an invalid %s address!", a.Address, a.ChainName)
	}
}

Notice

For EOS addresses(account name), ava only valid it's format. A valid result doesn't mean the account has been registered on the blockchain.

TODO

• Validate bech32 addresses for Bitcoin/BitcoinCash

License

The ava is an open-source software licensed under the MIT License.

Documentation

Index

• type Validator
  • func NewValidator(chainName string) (Validator, error)

Types

type Validator

type Validator interface {
	ValidateAddress(addr string, isTestnet bool) common.ValidationResult
}

Validator - Address validator

func NewValidator

func NewValidator(chainName string) (Validator, error)

NewValidator - Create address validator according to given chain name