currency

Documentation

Overview

Package currency - types and functions for converting currencies to/from enumeration values

Index

• Constants
• func UnpackMap(buffer []byte, testnet bool) (Map, Set, error)
• type Currency
  • func FromUint64(n uint64) (Currency, error)
  • func (currency Currency) ChainParam(chainName string) *chaincfg.Params
  • func (currency Currency) GetFee() (uint64, error)
  • func (currency Currency) GoString() string
  • func (currency Currency) Index() int
  • func (currency Currency) IsValid() bool
  • func (currency Currency) MarshalText() ([]byte, error)
  • func (currency *Currency) Scan(state fmt.ScanState, verb rune) error
  • func (currency Currency) String() string
  • func (currency Currency) Uint64() uint64
  • func (currency *Currency) UnmarshalText(s []byte) error
  • func (currency Currency) ValidateAddress(address string, testnet bool) error
• type Map
  • func (m Map) Pack(testnet bool) ([]byte, error)
• type Set
  • func MakeSet(currencies ...Currency) Set
  • func (set *Set) Add(c Currency) bool
  • func (set *Set) Count() int

Constants

const (
	Nothing  Currency = iota // this must be the first value
	Bitcoin  Currency = iota
	Litecoin Currency = iota

	First Currency = Nothing + 1
	Last  Currency = maximumValue - 1
	Count int      = int(Last) // count of currencies
)

possible currency values

Functions

func UnpackMap

func UnpackMap(buffer []byte, testnet bool) (Map, Set, error)

UnpackMap - unpack and validate a currency address mapping

Types

type Currency

type Currency uint64

Currency - currency enumeration

func FromUint64

func FromUint64(n uint64) (Currency, error)

FromUint64 - convert a number to a currency

func (Currency) ChainParam

func (currency Currency) ChainParam(chainName string) *chaincfg.Params

func (Currency) GetFee

func (currency Currency) GetFee() (uint64, error)

GetFee - returns the fee for a specific currency

func (Currency) GoString

func (currency Currency) GoString() string

GoString - convert abot enum value and symbol, for debugging

func (Currency) Index

func (currency Currency) Index() int

Index - convert a valid currency to a zero based array index

func (Currency) IsValid

func (currency Currency) IsValid() bool

IsValid - valid currency if in range of First to Last None is not considered as valid

func (Currency) MarshalText

func (currency Currency) MarshalText() ([]byte, error)

MarshalText - convert a currency into JSON

func (*Currency) Scan

func (currency *Currency) Scan(state fmt.ScanState, verb rune) error

Scan - convert a currency string

func (Currency) String

func (currency Currency) String() string

String - convert a currency to its string symbol

func (Currency) Uint64

func (currency Currency) Uint64() uint64

Uint64 - convert the currency to a number

func (*Currency) UnmarshalText

func (currency *Currency) UnmarshalText(s []byte) error

UnmarshalText - convert currency string to a currency enumeration value from JSON

func (Currency) ValidateAddress

func (currency Currency) ValidateAddress(address string, testnet bool) error

ValidateAddress - generic validate function

type Map

type Map map[Currency]string

Map - currency mapping to address strings

func (Map) Pack

func (m Map) Pack(testnet bool) ([]byte, error)

Pack - validate and pack a currency → address mapping create packed data as: (N = Address length)

Currency N Address   {first item}
…                    {more items}
Currency N Address   {final item}

type Set

type Set struct {
	// contains filtered or unexported fields
}

Set - currency set

func MakeSet

func MakeSet(currencies ...Currency) Set

MakeSet - create a set of currencies

func (*Set) Add

func (set *Set) Add(c Currency) bool

Add - returns true if already present

func (*Set) Count

func (set *Set) Count() int

Count - returns number of currencies in the set